dashboard.go 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413
  1. package sqlstore
  2. import (
  3. "time"
  4. "github.com/grafana/grafana/pkg/bus"
  5. "github.com/grafana/grafana/pkg/metrics"
  6. m "github.com/grafana/grafana/pkg/models"
  7. "github.com/grafana/grafana/pkg/services/search"
  8. )
  9. func init() {
  10. bus.AddHandler("sql", SaveDashboard)
  11. bus.AddHandler("sql", GetDashboard)
  12. bus.AddHandler("sql", GetDashboards)
  13. bus.AddHandler("sql", DeleteDashboard)
  14. bus.AddHandler("sql", SearchDashboards)
  15. bus.AddHandler("sql", GetDashboardTags)
  16. bus.AddHandler("sql", GetDashboardSlugById)
  17. bus.AddHandler("sql", GetDashboardsByPluginId)
  18. }
  19. func SaveDashboard(cmd *m.SaveDashboardCommand) error {
  20. return inTransaction(func(sess *DBSession) error {
  21. dash := cmd.GetDashboardModel()
  22. // try get existing dashboard
  23. var existing m.Dashboard
  24. if dash.Id > 0 {
  25. dashWithIdExists, err := sess.Where("id=? AND org_id=?", dash.Id, dash.OrgId).Get(&existing)
  26. if err != nil {
  27. return err
  28. }
  29. if !dashWithIdExists {
  30. return m.ErrDashboardNotFound
  31. }
  32. // check for is someone else has written in between
  33. if dash.Version != existing.Version {
  34. if cmd.Overwrite {
  35. dash.Version = existing.Version
  36. } else {
  37. return m.ErrDashboardVersionMismatch
  38. }
  39. }
  40. // do not allow plugin dashboard updates without overwrite flag
  41. if existing.PluginId != "" && cmd.Overwrite == false {
  42. return m.UpdatePluginDashboardError{PluginId: existing.PluginId}
  43. }
  44. }
  45. var sameUid m.Dashboard
  46. sameUidExists, err := sess.Where("org_id=? AND uid=?", dash.OrgId, dash.Uid).Get(&sameUid)
  47. if err != nil {
  48. return err
  49. }
  50. if sameUidExists {
  51. // another dashboard with same uid
  52. if dash.Id != sameUid.Id {
  53. if cmd.Overwrite {
  54. dash.Id = sameUid.Id
  55. dash.Version = sameUid.Version
  56. } else {
  57. return m.ErrDashboardWithSameUIDExists
  58. }
  59. }
  60. }
  61. err = guaranteeDashboardNameIsUniqueInFolder(sess, dash)
  62. if err != nil {
  63. return err
  64. }
  65. err = setHasAcl(sess, dash)
  66. if err != nil {
  67. return err
  68. }
  69. parentVersion := dash.Version
  70. affectedRows := int64(0)
  71. if dash.Id == 0 {
  72. dash.Version = 1
  73. metrics.M_Api_Dashboard_Insert.Inc()
  74. dash.Data.Set("version", dash.Version)
  75. affectedRows, err = sess.Insert(dash)
  76. } else {
  77. dash.Version++
  78. dash.Data.Set("version", dash.Version)
  79. if !cmd.UpdatedAt.IsZero() {
  80. dash.Updated = cmd.UpdatedAt
  81. }
  82. affectedRows, err = sess.MustCols("folder_id", "has_acl").ID(dash.Id).Update(dash)
  83. }
  84. if err != nil {
  85. return err
  86. }
  87. if affectedRows == 0 {
  88. return m.ErrDashboardNotFound
  89. }
  90. dashVersion := &m.DashboardVersion{
  91. DashboardId: dash.Id,
  92. ParentVersion: parentVersion,
  93. RestoredFrom: cmd.RestoredFrom,
  94. Version: dash.Version,
  95. Created: time.Now(),
  96. CreatedBy: dash.UpdatedBy,
  97. Message: cmd.Message,
  98. Data: dash.Data,
  99. }
  100. // insert version entry
  101. if affectedRows, err = sess.Insert(dashVersion); err != nil {
  102. return err
  103. } else if affectedRows == 0 {
  104. return m.ErrDashboardNotFound
  105. }
  106. // delete existing tags
  107. _, err = sess.Exec("DELETE FROM dashboard_tag WHERE dashboard_id=?", dash.Id)
  108. if err != nil {
  109. return err
  110. }
  111. // insert new tags
  112. tags := dash.GetTags()
  113. if len(tags) > 0 {
  114. for _, tag := range tags {
  115. if _, err := sess.Insert(&DashboardTag{DashboardId: dash.Id, Term: tag}); err != nil {
  116. return err
  117. }
  118. }
  119. }
  120. cmd.Result = dash
  121. return err
  122. })
  123. }
  124. func guaranteeDashboardNameIsUniqueInFolder(sess *DBSession, dash *m.Dashboard) error {
  125. var sameNameInFolder m.Dashboard
  126. sameNameInFolderExist, err := sess.Where("org_id=? AND title=? AND folder_id = ? AND uid <> ?",
  127. dash.OrgId, dash.Title, dash.FolderId, dash.Uid).
  128. Get(&sameNameInFolder)
  129. if err != nil {
  130. return err
  131. }
  132. if sameNameInFolderExist {
  133. return m.ErrDashboardWithSameNameInFolderExists
  134. }
  135. return nil
  136. }
  137. func setHasAcl(sess *DBSession, dash *m.Dashboard) error {
  138. // check if parent has acl
  139. if dash.FolderId > 0 {
  140. var parent m.Dashboard
  141. if hasParent, err := sess.Where("folder_id=?", dash.FolderId).Get(&parent); err != nil {
  142. return err
  143. } else if hasParent && parent.HasAcl {
  144. dash.HasAcl = true
  145. }
  146. }
  147. // check if dash has its own acl
  148. if dash.Id > 0 {
  149. if res, err := sess.Query("SELECT 1 from dashboard_acl WHERE dashboard_id =?", dash.Id); err != nil {
  150. return err
  151. } else {
  152. if len(res) > 0 {
  153. dash.HasAcl = true
  154. }
  155. }
  156. }
  157. return nil
  158. }
  159. func GetDashboard(query *m.GetDashboardQuery) error {
  160. dashboard := m.Dashboard{Slug: query.Slug, OrgId: query.OrgId, Id: query.Id, Uid: query.Uid}
  161. has, err := x.Get(&dashboard)
  162. if err != nil {
  163. return err
  164. } else if has == false {
  165. return m.ErrDashboardNotFound
  166. }
  167. dashboard.Data.Set("id", dashboard.Id)
  168. dashboard.Data.Set("uid", dashboard.Uid)
  169. query.Result = &dashboard
  170. return nil
  171. }
  172. type DashboardSearchProjection struct {
  173. Id int64
  174. Uid string
  175. Title string
  176. Slug string
  177. Term string
  178. IsFolder bool
  179. FolderId int64
  180. FolderSlug string
  181. FolderTitle string
  182. }
  183. func findDashboards(query *search.FindPersistedDashboardsQuery) ([]DashboardSearchProjection, error) {
  184. limit := query.Limit
  185. if limit == 0 {
  186. limit = 1000
  187. }
  188. sb := NewSearchBuilder(query.SignedInUser, limit).
  189. WithTags(query.Tags).
  190. WithDashboardIdsIn(query.DashboardIds)
  191. if query.IsStarred {
  192. sb.IsStarred()
  193. }
  194. if len(query.Title) > 0 {
  195. sb.WithTitle(query.Title)
  196. }
  197. if len(query.Type) > 0 {
  198. sb.WithType(query.Type)
  199. }
  200. if len(query.FolderIds) > 0 {
  201. sb.WithFolderIds(query.FolderIds)
  202. }
  203. var res []DashboardSearchProjection
  204. sql, params := sb.ToSql()
  205. err := x.Sql(sql, params...).Find(&res)
  206. if err != nil {
  207. return nil, err
  208. }
  209. return res, nil
  210. }
  211. func SearchDashboards(query *search.FindPersistedDashboardsQuery) error {
  212. res, err := findDashboards(query)
  213. if err != nil {
  214. return err
  215. }
  216. makeQueryResult(query, res)
  217. return nil
  218. }
  219. func getHitType(item DashboardSearchProjection) search.HitType {
  220. var hitType search.HitType
  221. if item.IsFolder {
  222. hitType = search.DashHitFolder
  223. } else {
  224. hitType = search.DashHitDB
  225. }
  226. return hitType
  227. }
  228. func makeQueryResult(query *search.FindPersistedDashboardsQuery, res []DashboardSearchProjection) {
  229. query.Result = make([]*search.Hit, 0)
  230. hits := make(map[int64]*search.Hit)
  231. for _, item := range res {
  232. hit, exists := hits[item.Id]
  233. if !exists {
  234. var url string
  235. if item.IsFolder {
  236. url = m.GetFolderUrl(item.Uid, item.Slug)
  237. } else {
  238. url = m.GetDashboardUrl(item.Uid, item.Slug)
  239. }
  240. hit = &search.Hit{
  241. Id: item.Id,
  242. Title: item.Title,
  243. Uri: "db/" + item.Slug,
  244. Url: url,
  245. Slug: item.Slug,
  246. Type: getHitType(item),
  247. FolderId: item.FolderId,
  248. FolderTitle: item.FolderTitle,
  249. FolderSlug: item.FolderSlug,
  250. Tags: []string{},
  251. }
  252. query.Result = append(query.Result, hit)
  253. hits[item.Id] = hit
  254. }
  255. if len(item.Term) > 0 {
  256. hit.Tags = append(hit.Tags, item.Term)
  257. }
  258. }
  259. }
  260. func GetDashboardTags(query *m.GetDashboardTagsQuery) error {
  261. sql := `SELECT
  262. COUNT(*) as count,
  263. term
  264. FROM dashboard
  265. INNER JOIN dashboard_tag on dashboard_tag.dashboard_id = dashboard.id
  266. WHERE dashboard.org_id=?
  267. GROUP BY term`
  268. query.Result = make([]*m.DashboardTagCloudItem, 0)
  269. sess := x.Sql(sql, query.OrgId)
  270. err := sess.Find(&query.Result)
  271. return err
  272. }
  273. func DeleteDashboard(cmd *m.DeleteDashboardCommand) error {
  274. return inTransaction(func(sess *DBSession) error {
  275. dashboard := m.Dashboard{Id: cmd.Id, OrgId: cmd.OrgId}
  276. has, err := sess.Get(&dashboard)
  277. if err != nil {
  278. return err
  279. } else if has == false {
  280. return m.ErrDashboardNotFound
  281. }
  282. deletes := []string{
  283. "DELETE FROM dashboard_tag WHERE dashboard_id = ? ",
  284. "DELETE FROM star WHERE dashboard_id = ? ",
  285. "DELETE FROM dashboard WHERE id = ?",
  286. "DELETE FROM playlist_item WHERE type = 'dashboard_by_id' AND value = ?",
  287. "DELETE FROM dashboard_version WHERE dashboard_id = ?",
  288. "DELETE FROM dashboard WHERE folder_id = ?",
  289. "DELETE FROM annotation WHERE dashboard_id = ?",
  290. }
  291. for _, sql := range deletes {
  292. _, err := sess.Exec(sql, dashboard.Id)
  293. if err != nil {
  294. return err
  295. }
  296. }
  297. if err := DeleteAlertDefinition(dashboard.Id, sess); err != nil {
  298. return nil
  299. }
  300. return nil
  301. })
  302. }
  303. func GetDashboards(query *m.GetDashboardsQuery) error {
  304. if len(query.DashboardIds) == 0 {
  305. return m.ErrCommandValidationFailed
  306. }
  307. var dashboards = make([]*m.Dashboard, 0)
  308. err := x.In("id", query.DashboardIds).Find(&dashboards)
  309. query.Result = dashboards
  310. if err != nil {
  311. return err
  312. }
  313. return nil
  314. }
  315. func GetDashboardsByPluginId(query *m.GetDashboardsByPluginIdQuery) error {
  316. var dashboards = make([]*m.Dashboard, 0)
  317. whereExpr := "org_id=? AND plugin_id=? AND is_folder=" + dialect.BooleanStr(false)
  318. err := x.Where(whereExpr, query.OrgId, query.PluginId).Find(&dashboards)
  319. query.Result = dashboards
  320. if err != nil {
  321. return err
  322. }
  323. return nil
  324. }
  325. type DashboardSlugDTO struct {
  326. Slug string
  327. }
  328. func GetDashboardSlugById(query *m.GetDashboardSlugByIdQuery) error {
  329. var rawSql = `SELECT slug from dashboard WHERE Id=?`
  330. var slug = DashboardSlugDTO{}
  331. exists, err := x.Sql(rawSql, query.Id).Get(&slug)
  332. if err != nil {
  333. return err
  334. } else if exists == false {
  335. return m.ErrDashboardNotFound
  336. }
  337. query.Result = slug.Slug
  338. return nil
  339. }