plugins.go 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183
  1. package api
  2. import (
  3. "sort"
  4. "github.com/grafana/grafana/pkg/api/dtos"
  5. "github.com/grafana/grafana/pkg/bus"
  6. m "github.com/grafana/grafana/pkg/models"
  7. "github.com/grafana/grafana/pkg/plugins"
  8. "github.com/grafana/grafana/pkg/setting"
  9. )
  10. func GetPluginList(c *m.Context) Response {
  11. typeFilter := c.Query("type")
  12. enabledFilter := c.Query("enabled")
  13. embeddedFilter := c.Query("embedded")
  14. coreFilter := c.Query("core")
  15. pluginSettingsMap, err := plugins.GetPluginSettings(c.OrgId)
  16. if err != nil {
  17. return ApiError(500, "Failed to get list of plugins", err)
  18. }
  19. result := make(dtos.PluginList, 0)
  20. for _, pluginDef := range plugins.Plugins {
  21. // filter out app sub plugins
  22. if embeddedFilter == "0" && pluginDef.IncludedInAppId != "" {
  23. continue
  24. }
  25. // filter out core plugins
  26. if coreFilter == "0" && pluginDef.IsCorePlugin {
  27. continue
  28. }
  29. // filter on type
  30. if typeFilter != "" && typeFilter != pluginDef.Type {
  31. continue
  32. }
  33. listItem := dtos.PluginListItem{
  34. Id: pluginDef.Id,
  35. Name: pluginDef.Name,
  36. Type: pluginDef.Type,
  37. Info: &pluginDef.Info,
  38. LatestVersion: pluginDef.GrafanaNetVersion,
  39. HasUpdate: pluginDef.GrafanaNetHasUpdate,
  40. DefaultNavUrl: pluginDef.DefaultNavUrl,
  41. State: pluginDef.State,
  42. }
  43. if pluginSetting, exists := pluginSettingsMap[pluginDef.Id]; exists {
  44. listItem.Enabled = pluginSetting.Enabled
  45. listItem.Pinned = pluginSetting.Pinned
  46. }
  47. if listItem.DefaultNavUrl == "" || !listItem.Enabled {
  48. listItem.DefaultNavUrl = setting.AppSubUrl + "/plugins/" + listItem.Id + "/edit"
  49. }
  50. // filter out disabled
  51. if enabledFilter == "1" && !listItem.Enabled {
  52. continue
  53. }
  54. // filter out built in data sources
  55. if ds, exists := plugins.DataSources[pluginDef.Id]; exists {
  56. if ds.BuiltIn {
  57. continue
  58. }
  59. }
  60. result = append(result, listItem)
  61. }
  62. sort.Sort(result)
  63. return Json(200, result)
  64. }
  65. func GetPluginSettingById(c *m.Context) Response {
  66. pluginId := c.Params(":pluginId")
  67. if def, exists := plugins.Plugins[pluginId]; !exists {
  68. return ApiError(404, "Plugin not found, no installed plugin with that id", nil)
  69. } else {
  70. dto := &dtos.PluginSetting{
  71. Type: def.Type,
  72. Id: def.Id,
  73. Name: def.Name,
  74. Info: &def.Info,
  75. Dependencies: &def.Dependencies,
  76. Includes: def.Includes,
  77. BaseUrl: def.BaseUrl,
  78. Module: def.Module,
  79. DefaultNavUrl: def.DefaultNavUrl,
  80. LatestVersion: def.GrafanaNetVersion,
  81. HasUpdate: def.GrafanaNetHasUpdate,
  82. State: def.State,
  83. }
  84. query := m.GetPluginSettingByIdQuery{PluginId: pluginId, OrgId: c.OrgId}
  85. if err := bus.Dispatch(&query); err != nil {
  86. if err != m.ErrPluginSettingNotFound {
  87. return ApiError(500, "Failed to get login settings", nil)
  88. }
  89. } else {
  90. dto.Enabled = query.Result.Enabled
  91. dto.Pinned = query.Result.Pinned
  92. dto.JsonData = query.Result.JsonData
  93. }
  94. return Json(200, dto)
  95. }
  96. }
  97. func UpdatePluginSetting(c *m.Context, cmd m.UpdatePluginSettingCmd) Response {
  98. pluginId := c.Params(":pluginId")
  99. cmd.OrgId = c.OrgId
  100. cmd.PluginId = pluginId
  101. if _, ok := plugins.Apps[cmd.PluginId]; !ok {
  102. return ApiError(404, "Plugin not installed.", nil)
  103. }
  104. if err := bus.Dispatch(&cmd); err != nil {
  105. return ApiError(500, "Failed to update plugin setting", err)
  106. }
  107. return ApiSuccess("Plugin settings updated")
  108. }
  109. func GetPluginDashboards(c *m.Context) Response {
  110. pluginId := c.Params(":pluginId")
  111. if list, err := plugins.GetPluginDashboards(c.OrgId, pluginId); err != nil {
  112. if notfound, ok := err.(plugins.PluginNotFoundError); ok {
  113. return ApiError(404, notfound.Error(), nil)
  114. }
  115. return ApiError(500, "Failed to get plugin dashboards", err)
  116. } else {
  117. return Json(200, list)
  118. }
  119. }
  120. func GetPluginMarkdown(c *m.Context) Response {
  121. pluginId := c.Params(":pluginId")
  122. name := c.Params(":name")
  123. if content, err := plugins.GetPluginMarkdown(pluginId, name); err != nil {
  124. if notfound, ok := err.(plugins.PluginNotFoundError); ok {
  125. return ApiError(404, notfound.Error(), nil)
  126. }
  127. return ApiError(500, "Could not get markdown file", err)
  128. } else {
  129. resp := Respond(200, content)
  130. resp.Header("Content-Type", "text/plain; charset=utf-8")
  131. return resp
  132. }
  133. }
  134. func ImportDashboard(c *m.Context, apiCmd dtos.ImportDashboardCommand) Response {
  135. cmd := plugins.ImportDashboardCommand{
  136. OrgId: c.OrgId,
  137. User: c.SignedInUser,
  138. PluginId: apiCmd.PluginId,
  139. Path: apiCmd.Path,
  140. Inputs: apiCmd.Inputs,
  141. Overwrite: apiCmd.Overwrite,
  142. Dashboard: apiCmd.Dashboard,
  143. }
  144. if err := bus.Dispatch(&cmd); err != nil {
  145. return ApiError(500, "Failed to import dashboard", err)
  146. }
  147. return Json(200, cmd.Result)
  148. }