plugins.go 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. package api
  2. import (
  3. "sort"
  4. "github.com/grafana/grafana/pkg/api/dtos"
  5. "github.com/grafana/grafana/pkg/bus"
  6. "github.com/grafana/grafana/pkg/middleware"
  7. m "github.com/grafana/grafana/pkg/models"
  8. "github.com/grafana/grafana/pkg/plugins"
  9. "github.com/grafana/grafana/pkg/setting"
  10. )
  11. func GetPluginList(c *middleware.Context) Response {
  12. typeFilter := c.Query("type")
  13. enabledFilter := c.Query("enabled")
  14. embeddedFilter := c.Query("embedded")
  15. coreFilter := c.Query("core")
  16. pluginSettingsMap, err := plugins.GetPluginSettings(c.OrgId)
  17. if err != nil {
  18. return ApiError(500, "Failed to get list of plugins", err)
  19. }
  20. result := make(dtos.PluginList, 0)
  21. for _, pluginDef := range plugins.Plugins {
  22. // filter out app sub plugins
  23. if embeddedFilter == "0" && pluginDef.IncludedInAppId != "" {
  24. continue
  25. }
  26. // filter out core plugins
  27. if coreFilter == "0" && pluginDef.IsCorePlugin {
  28. continue
  29. }
  30. // filter on type
  31. if typeFilter != "" && typeFilter != pluginDef.Type {
  32. continue
  33. }
  34. listItem := dtos.PluginListItem{
  35. Id: pluginDef.Id,
  36. Name: pluginDef.Name,
  37. Type: pluginDef.Type,
  38. Info: &pluginDef.Info,
  39. LatestVersion: pluginDef.GrafanaNetVersion,
  40. HasUpdate: pluginDef.GrafanaNetHasUpdate,
  41. DefaultNavUrl: pluginDef.DefaultNavUrl,
  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 *middleware.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. }
  83. query := m.GetPluginSettingByIdQuery{PluginId: pluginId, OrgId: c.OrgId}
  84. if err := bus.Dispatch(&query); err != nil {
  85. if err != m.ErrPluginSettingNotFound {
  86. return ApiError(500, "Failed to get login settings", nil)
  87. }
  88. } else {
  89. dto.Enabled = query.Result.Enabled
  90. dto.Pinned = query.Result.Pinned
  91. dto.JsonData = query.Result.JsonData
  92. }
  93. return Json(200, dto)
  94. }
  95. }
  96. func UpdatePluginSetting(c *middleware.Context, cmd m.UpdatePluginSettingCmd) Response {
  97. pluginId := c.Params(":pluginId")
  98. cmd.OrgId = c.OrgId
  99. cmd.PluginId = pluginId
  100. if _, ok := plugins.Apps[cmd.PluginId]; !ok {
  101. return ApiError(404, "Plugin not installed.", nil)
  102. }
  103. if err := bus.Dispatch(&cmd); err != nil {
  104. return ApiError(500, "Failed to update plugin setting", err)
  105. }
  106. return ApiSuccess("Plugin settings updated")
  107. }
  108. func GetPluginDashboards(c *middleware.Context) Response {
  109. pluginId := c.Params(":pluginId")
  110. if list, err := plugins.GetPluginDashboards(c.OrgId, pluginId); err != nil {
  111. if notfound, ok := err.(plugins.PluginNotFoundError); ok {
  112. return ApiError(404, notfound.Error(), nil)
  113. }
  114. return ApiError(500, "Failed to get plugin dashboards", err)
  115. } else {
  116. return Json(200, list)
  117. }
  118. }
  119. func GetPluginReadme(c *middleware.Context) Response {
  120. pluginId := c.Params(":pluginId")
  121. if content, err := plugins.GetPluginReadme(pluginId); err != nil {
  122. if notfound, ok := err.(plugins.PluginNotFoundError); ok {
  123. return ApiError(404, notfound.Error(), nil)
  124. }
  125. return ApiError(500, "Could not get readme", err)
  126. } else {
  127. return Respond(200, content)
  128. }
  129. }
  130. func ImportDashboard(c *middleware.Context, apiCmd dtos.ImportDashboardCommand) Response {
  131. cmd := plugins.ImportDashboardCommand{
  132. OrgId: c.OrgId,
  133. UserId: c.UserId,
  134. PluginId: apiCmd.PluginId,
  135. Path: apiCmd.Path,
  136. Inputs: apiCmd.Inputs,
  137. Overwrite: apiCmd.Overwrite,
  138. Dashboard: apiCmd.Dashboard,
  139. }
  140. if err := bus.Dispatch(&cmd); err != nil {
  141. return ApiError(500, "Failed to import dashboard", err)
  142. }
  143. return Json(200, cmd.Result)
  144. }