plugins.go 4.1 KB

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