dashboard_snapshot.go 4.3 KB

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