dashboard_snapshot.go 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170
  1. package api
  2. import (
  3. "time"
  4. "github.com/grafana/grafana/pkg/api/dtos"
  5. "github.com/grafana/grafana/pkg/bus"
  6. "github.com/grafana/grafana/pkg/metrics"
  7. "github.com/grafana/grafana/pkg/middleware"
  8. m "github.com/grafana/grafana/pkg/models"
  9. "github.com/grafana/grafana/pkg/services/guardian"
  10. "github.com/grafana/grafana/pkg/setting"
  11. "github.com/grafana/grafana/pkg/util"
  12. )
  13. func GetSharingOptions(c *middleware.Context) {
  14. c.JSON(200, util.DynMap{
  15. "externalSnapshotURL": setting.ExternalSnapshotUrl,
  16. "externalSnapshotName": setting.ExternalSnapshotName,
  17. "externalEnabled": setting.ExternalEnabled,
  18. })
  19. }
  20. func CreateDashboardSnapshot(c *middleware.Context, cmd m.CreateDashboardSnapshotCommand) {
  21. if cmd.Name == "" {
  22. cmd.Name = "Unnamed snapshot"
  23. }
  24. if cmd.External {
  25. // external snapshot ref requires key and delete key
  26. if cmd.Key == "" || cmd.DeleteKey == "" {
  27. c.JsonApiErr(400, "Missing key and delete key for external snapshot", nil)
  28. return
  29. }
  30. cmd.OrgId = -1
  31. cmd.UserId = -1
  32. metrics.M_Api_Dashboard_Snapshot_External.Inc()
  33. } else {
  34. cmd.Key = util.GetRandomString(32)
  35. cmd.DeleteKey = util.GetRandomString(32)
  36. cmd.OrgId = c.OrgId
  37. cmd.UserId = c.UserId
  38. metrics.M_Api_Dashboard_Snapshot_Create.Inc()
  39. }
  40. if err := bus.Dispatch(&cmd); err != nil {
  41. c.JsonApiErr(500, "Failed to create snaphost", err)
  42. return
  43. }
  44. c.JSON(200, util.DynMap{
  45. "key": cmd.Key,
  46. "deleteKey": cmd.DeleteKey,
  47. "url": setting.ToAbsUrl("dashboard/snapshot/" + cmd.Key),
  48. "deleteUrl": setting.ToAbsUrl("api/snapshots-delete/" + cmd.DeleteKey),
  49. })
  50. }
  51. // GET /api/snapshots/:key
  52. func GetDashboardSnapshot(c *middleware.Context) {
  53. key := c.Params(":key")
  54. query := &m.GetDashboardSnapshotQuery{Key: key}
  55. err := bus.Dispatch(query)
  56. if err != nil {
  57. c.JsonApiErr(500, "Failed to get dashboard snapshot", err)
  58. return
  59. }
  60. snapshot := query.Result
  61. // expired snapshots should also be removed from db
  62. if snapshot.Expires.Before(time.Now()) {
  63. c.JsonApiErr(404, "Dashboard snapshot not found", err)
  64. return
  65. }
  66. dto := dtos.DashboardFullWithMeta{
  67. Dashboard: snapshot.Dashboard,
  68. Meta: dtos.DashboardMeta{
  69. Type: m.DashTypeSnapshot,
  70. IsSnapshot: true,
  71. Created: snapshot.Created,
  72. Expires: snapshot.Expires,
  73. },
  74. }
  75. metrics.M_Api_Dashboard_Snapshot_Get.Inc()
  76. c.Resp.Header().Set("Cache-Control", "public, max-age=3600")
  77. c.JSON(200, dto)
  78. }
  79. // GET /api/snapshots-delete/:key
  80. func DeleteDashboardSnapshot(c *middleware.Context) Response {
  81. key := c.Params(":key")
  82. query := &m.GetDashboardSnapshotQuery{DeleteKey: key}
  83. err := bus.Dispatch(query)
  84. if err != nil {
  85. return ApiError(500, "Failed to get dashboard snapshot", err)
  86. }
  87. if query.Result == nil {
  88. return ApiError(404, "Failed to get dashboard snapshot", nil)
  89. }
  90. dashboard := query.Result.Dashboard
  91. dashboardId := dashboard.Get("id").MustInt64()
  92. guardian := guardian.New(dashboardId, c.OrgId, c.SignedInUser)
  93. canEdit, err := guardian.CanEdit()
  94. if err != nil {
  95. return ApiError(500, "Error while checking permissions for snapshot", err)
  96. }
  97. if !canEdit && query.Result.UserId != c.SignedInUser.UserId {
  98. return ApiError(403, "Access denied to this snapshot", nil)
  99. }
  100. cmd := &m.DeleteDashboardSnapshotCommand{DeleteKey: key}
  101. if err := bus.Dispatch(cmd); err != nil {
  102. return ApiError(500, "Failed to delete dashboard snapshot", err)
  103. }
  104. return Json(200, util.DynMap{"message": "Snapshot deleted. It might take an hour before it's cleared from a CDN cache."})
  105. }
  106. // GET /api/dashboard/snapshots
  107. func SearchDashboardSnapshots(c *middleware.Context) Response {
  108. query := c.Query("query")
  109. limit := c.QueryInt("limit")
  110. if limit == 0 {
  111. limit = 1000
  112. }
  113. searchQuery := m.GetDashboardSnapshotsQuery{
  114. Name: query,
  115. Limit: limit,
  116. OrgId: c.OrgId,
  117. SignedInUser: c.SignedInUser,
  118. }
  119. err := bus.Dispatch(&searchQuery)
  120. if err != nil {
  121. return ApiError(500, "Search failed", err)
  122. }
  123. dtos := make([]*m.DashboardSnapshotDTO, len(searchQuery.Result))
  124. for i, snapshot := range searchQuery.Result {
  125. dtos[i] = &m.DashboardSnapshotDTO{
  126. Id: snapshot.Id,
  127. Name: snapshot.Name,
  128. Key: snapshot.Key,
  129. DeleteKey: snapshot.DeleteKey,
  130. OrgId: snapshot.OrgId,
  131. UserId: snapshot.UserId,
  132. External: snapshot.External,
  133. ExternalUrl: snapshot.ExternalUrl,
  134. Expires: snapshot.Expires,
  135. Created: snapshot.Created,
  136. Updated: snapshot.Updated,
  137. }
  138. }
  139. return Json(200, dtos)
  140. }