webhook.go 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576
  1. // Copyright 2015 - Present, The Gogs Authors. All rights reserved.
  2. // Copyright 2018 - Present, Gitote. All rights reserved.
  3. //
  4. // This source code is licensed under the MIT license found in the
  5. // LICENSE file in the root directory of this source tree.
  6. package repo
  7. import (
  8. "fmt"
  9. "gitote/gitote/models"
  10. "gitote/gitote/models/errors"
  11. "gitote/gitote/pkg/context"
  12. "gitote/gitote/pkg/form"
  13. "gitote/gitote/pkg/setting"
  14. "strings"
  15. "github.com/json-iterator/go"
  16. "gitlab.com/gitote/com"
  17. git "gitlab.com/gitote/git-module"
  18. api "gitlab.com/gitote/go-gitote-client"
  19. )
  20. const (
  21. // WebhooksTPL page template
  22. WebhooksTPL = "repo/settings/webhook/base"
  23. // WebhookNewTPL page template
  24. WebhookNewTPL = "repo/settings/webhook/new"
  25. // OrgWebhookNewTPL page template
  26. OrgWebhookNewTPL = "org/settings/webhook_new"
  27. )
  28. // Webhooks render web hooks list page
  29. func Webhooks(c *context.Context) {
  30. c.Data["Title"] = c.Tr("repo.settings.hooks")
  31. c.Data["PageIsSettingsHooks"] = true
  32. c.Data["BaseLink"] = c.Repo.RepoLink
  33. c.Data["Description"] = c.Tr("repo.settings.hooks_desc", "https://gitlab.com/gitote/gitote-client/wiki/Repositories-Webhooks")
  34. c.Data["Types"] = setting.Webhook.Types
  35. ws, err := models.GetWebhooksByRepoID(c.Repo.Repository.ID)
  36. if err != nil {
  37. c.Handle(500, "GetWebhooksByRepoID", err)
  38. return
  39. }
  40. c.Data["Webhooks"] = ws
  41. c.HTML(200, WebhooksTPL)
  42. }
  43. // OrgRepoCtx contains the org repo information
  44. type OrgRepoCtx struct {
  45. OrgID int64
  46. RepoID int64
  47. Link string
  48. NewTemplate string
  49. }
  50. // getOrgRepoCtx determines whether this is a repo context or organization context.
  51. func getOrgRepoCtx(c *context.Context) (*OrgRepoCtx, error) {
  52. if len(c.Repo.RepoLink) > 0 {
  53. c.Data["PageIsRepositoryContext"] = true
  54. return &OrgRepoCtx{
  55. RepoID: c.Repo.Repository.ID,
  56. Link: c.Repo.RepoLink,
  57. NewTemplate: WebhookNewTPL,
  58. }, nil
  59. }
  60. if len(c.Org.OrgLink) > 0 {
  61. c.Data["PageIsOrganizationContext"] = true
  62. return &OrgRepoCtx{
  63. OrgID: c.Org.Organization.ID,
  64. Link: c.Org.OrgLink,
  65. NewTemplate: OrgWebhookNewTPL,
  66. }, nil
  67. }
  68. return nil, errors.New("Unable to set OrgRepo context")
  69. }
  70. func checkHookType(c *context.Context) string {
  71. hookType := strings.ToLower(c.Params(":type"))
  72. if !com.IsSliceContainsStr(setting.Webhook.Types, hookType) {
  73. c.Handle(404, "checkHookType", nil)
  74. return ""
  75. }
  76. return hookType
  77. }
  78. // WebhooksNew render creating webhook page
  79. func WebhooksNew(c *context.Context) {
  80. c.Data["Title"] = c.Tr("repo.settings.add_webhook")
  81. c.Data["PageIsSettingsHooks"] = true
  82. c.Data["PageIsSettingsHooksNew"] = true
  83. c.Data["Webhook"] = models.Webhook{HookEvent: &models.HookEvent{}}
  84. orCtx, err := getOrgRepoCtx(c)
  85. if err != nil {
  86. c.Handle(500, "getOrgRepoCtx", err)
  87. return
  88. }
  89. c.Data["HookType"] = checkHookType(c)
  90. if c.Written() {
  91. return
  92. }
  93. c.Data["BaseLink"] = orCtx.Link
  94. c.HTML(200, orCtx.NewTemplate)
  95. }
  96. // ParseHookEvent convert web form content to models.HookEvent
  97. func ParseHookEvent(f form.Webhook) *models.HookEvent {
  98. return &models.HookEvent{
  99. PushOnly: f.PushOnly(),
  100. SendEverything: f.SendEverything(),
  101. ChooseEvents: f.ChooseEvents(),
  102. HookEvents: models.HookEvents{
  103. Create: f.Create,
  104. Delete: f.Delete,
  105. Fork: f.Fork,
  106. Push: f.Push,
  107. Issues: f.Issues,
  108. IssueComment: f.IssueComment,
  109. PullRequest: f.PullRequest,
  110. Release: f.Release,
  111. },
  112. }
  113. }
  114. // WebHooksNewPost creates new webhooks
  115. func WebHooksNewPost(c *context.Context, f form.NewWebhook) {
  116. c.Data["Title"] = c.Tr("repo.settings.add_webhook")
  117. c.Data["PageIsSettingsHooks"] = true
  118. c.Data["PageIsSettingsHooksNew"] = true
  119. c.Data["Webhook"] = models.Webhook{HookEvent: &models.HookEvent{}}
  120. c.Data["HookType"] = "gitote"
  121. orCtx, err := getOrgRepoCtx(c)
  122. if err != nil {
  123. c.Handle(500, "getOrgRepoCtx", err)
  124. return
  125. }
  126. c.Data["BaseLink"] = orCtx.Link
  127. if c.HasError() {
  128. c.HTML(200, orCtx.NewTemplate)
  129. return
  130. }
  131. contentType := models.ContentTypeJSON
  132. if models.HookContentType(f.ContentType) == models.ContentTypeForm {
  133. contentType = models.ContentTypeForm
  134. }
  135. w := &models.Webhook{
  136. RepoID: orCtx.RepoID,
  137. URL: f.PayloadURL,
  138. ContentType: contentType,
  139. Secret: f.Secret,
  140. HookEvent: ParseHookEvent(f.Webhook),
  141. IsActive: f.Active,
  142. HookTaskType: models.GITOTE,
  143. OrgID: orCtx.OrgID,
  144. }
  145. if err := w.UpdateEvent(); err != nil {
  146. c.Handle(500, "UpdateEvent", err)
  147. return
  148. } else if err := models.CreateWebhook(w); err != nil {
  149. c.Handle(500, "CreateWebhook", err)
  150. return
  151. }
  152. c.Flash.Success(c.Tr("repo.settings.add_hook_success"))
  153. c.Redirect(orCtx.Link + "/settings/hooks")
  154. }
  155. // SlackHooksNewPost creates new slack hook
  156. func SlackHooksNewPost(c *context.Context, f form.NewSlackHook) {
  157. c.Data["Title"] = c.Tr("repo.settings")
  158. c.Data["PageIsSettingsHooks"] = true
  159. c.Data["PageIsSettingsHooksNew"] = true
  160. c.Data["Webhook"] = models.Webhook{HookEvent: &models.HookEvent{}}
  161. orCtx, err := getOrgRepoCtx(c)
  162. if err != nil {
  163. c.Handle(500, "getOrgRepoCtx", err)
  164. return
  165. }
  166. if c.HasError() {
  167. c.HTML(200, orCtx.NewTemplate)
  168. return
  169. }
  170. meta, err := jsoniter.Marshal(&models.SlackMeta{
  171. Channel: f.Channel,
  172. Username: f.Username,
  173. IconURL: f.IconURL,
  174. Color: f.Color,
  175. })
  176. if err != nil {
  177. c.Handle(500, "Marshal", err)
  178. return
  179. }
  180. w := &models.Webhook{
  181. RepoID: orCtx.RepoID,
  182. URL: f.PayloadURL,
  183. ContentType: models.ContentTypeJSON,
  184. HookEvent: ParseHookEvent(f.Webhook),
  185. IsActive: f.Active,
  186. HookTaskType: models.SLACK,
  187. Meta: string(meta),
  188. OrgID: orCtx.OrgID,
  189. }
  190. if err := w.UpdateEvent(); err != nil {
  191. c.Handle(500, "UpdateEvent", err)
  192. return
  193. } else if err := models.CreateWebhook(w); err != nil {
  194. c.Handle(500, "CreateWebhook", err)
  195. return
  196. }
  197. c.Flash.Success(c.Tr("repo.settings.add_hook_success"))
  198. c.Redirect(orCtx.Link + "/settings/hooks")
  199. }
  200. // DiscordHooksNewPost creates new discord hook
  201. func DiscordHooksNewPost(c *context.Context, f form.NewDiscordHook) {
  202. c.Data["Title"] = c.Tr("repo.settings")
  203. c.Data["PageIsSettingsHooks"] = true
  204. c.Data["PageIsSettingsHooksNew"] = true
  205. c.Data["Webhook"] = models.Webhook{HookEvent: &models.HookEvent{}}
  206. orCtx, err := getOrgRepoCtx(c)
  207. if err != nil {
  208. c.Handle(500, "getOrgRepoCtx", err)
  209. return
  210. }
  211. if c.HasError() {
  212. c.HTML(200, orCtx.NewTemplate)
  213. return
  214. }
  215. meta, err := jsoniter.Marshal(&models.SlackMeta{
  216. Username: f.Username,
  217. IconURL: f.IconURL,
  218. Color: f.Color,
  219. })
  220. if err != nil {
  221. c.Handle(500, "Marshal", err)
  222. return
  223. }
  224. w := &models.Webhook{
  225. RepoID: orCtx.RepoID,
  226. URL: f.PayloadURL,
  227. ContentType: models.ContentTypeJSON,
  228. HookEvent: ParseHookEvent(f.Webhook),
  229. IsActive: f.Active,
  230. HookTaskType: models.DISCORD,
  231. Meta: string(meta),
  232. OrgID: orCtx.OrgID,
  233. }
  234. if err := w.UpdateEvent(); err != nil {
  235. c.Handle(500, "UpdateEvent", err)
  236. return
  237. } else if err := models.CreateWebhook(w); err != nil {
  238. c.Handle(500, "CreateWebhook", err)
  239. return
  240. }
  241. c.Flash.Success(c.Tr("repo.settings.add_hook_success"))
  242. c.Redirect(orCtx.Link + "/settings/hooks")
  243. }
  244. func checkWebhook(c *context.Context) (*OrgRepoCtx, *models.Webhook) {
  245. c.Data["RequireHighlightJS"] = true
  246. orCtx, err := getOrgRepoCtx(c)
  247. if err != nil {
  248. c.Handle(500, "getOrgRepoCtx", err)
  249. return nil, nil
  250. }
  251. c.Data["BaseLink"] = orCtx.Link
  252. var w *models.Webhook
  253. if orCtx.RepoID > 0 {
  254. w, err = models.GetWebhookOfRepoByID(c.Repo.Repository.ID, c.ParamsInt64(":id"))
  255. } else {
  256. w, err = models.GetWebhookByOrgID(c.Org.Organization.ID, c.ParamsInt64(":id"))
  257. }
  258. if err != nil {
  259. c.NotFoundOrServerError("GetWebhookOfRepoByID/GetWebhookByOrgID", errors.IsWebhookNotExist, err)
  260. return nil, nil
  261. }
  262. switch w.HookTaskType {
  263. case models.SLACK:
  264. c.Data["SlackHook"] = w.GetSlackHook()
  265. c.Data["HookType"] = "slack"
  266. case models.DISCORD:
  267. c.Data["SlackHook"] = w.GetSlackHook()
  268. c.Data["HookType"] = "discord"
  269. default:
  270. c.Data["HookType"] = "gitote"
  271. }
  272. c.Data["History"], err = w.History(1)
  273. if err != nil {
  274. c.Handle(500, "History", err)
  275. }
  276. return orCtx, w
  277. }
  278. // WebHooksEdit render editing web hook page
  279. func WebHooksEdit(c *context.Context) {
  280. c.Data["Title"] = c.Tr("repo.settings.update_webhook")
  281. c.Data["PageIsSettingsHooks"] = true
  282. c.Data["PageIsSettingsHooksEdit"] = true
  283. orCtx, w := checkWebhook(c)
  284. if c.Written() {
  285. return
  286. }
  287. c.Data["Webhook"] = w
  288. c.HTML(200, orCtx.NewTemplate)
  289. }
  290. // WebHooksEditPost edits webhooks
  291. func WebHooksEditPost(c *context.Context, f form.NewWebhook) {
  292. c.Data["Title"] = c.Tr("repo.settings.update_webhook")
  293. c.Data["PageIsSettingsHooks"] = true
  294. c.Data["PageIsSettingsHooksEdit"] = true
  295. orCtx, w := checkWebhook(c)
  296. if c.Written() {
  297. return
  298. }
  299. c.Data["Webhook"] = w
  300. if c.HasError() {
  301. c.HTML(200, orCtx.NewTemplate)
  302. return
  303. }
  304. contentType := models.ContentTypeJSON
  305. if models.HookContentType(f.ContentType) == models.ContentTypeForm {
  306. contentType = models.ContentTypeForm
  307. }
  308. w.URL = f.PayloadURL
  309. w.ContentType = contentType
  310. w.Secret = f.Secret
  311. w.HookEvent = ParseHookEvent(f.Webhook)
  312. w.IsActive = f.Active
  313. if err := w.UpdateEvent(); err != nil {
  314. c.Handle(500, "UpdateEvent", err)
  315. return
  316. } else if err := models.UpdateWebhook(w); err != nil {
  317. c.Handle(500, "WebHooksEditPost", err)
  318. return
  319. }
  320. c.Flash.Success(c.Tr("repo.settings.update_hook_success"))
  321. c.Redirect(fmt.Sprintf("%s/settings/hooks/%d", orCtx.Link, w.ID))
  322. }
  323. // SlackHooksEditPost edits slack hooks
  324. func SlackHooksEditPost(c *context.Context, f form.NewSlackHook) {
  325. c.Data["Title"] = c.Tr("repo.settings")
  326. c.Data["PageIsSettingsHooks"] = true
  327. c.Data["PageIsSettingsHooksEdit"] = true
  328. orCtx, w := checkWebhook(c)
  329. if c.Written() {
  330. return
  331. }
  332. c.Data["Webhook"] = w
  333. if c.HasError() {
  334. c.HTML(200, orCtx.NewTemplate)
  335. return
  336. }
  337. meta, err := jsoniter.Marshal(&models.SlackMeta{
  338. Channel: f.Channel,
  339. Username: f.Username,
  340. IconURL: f.IconURL,
  341. Color: f.Color,
  342. })
  343. if err != nil {
  344. c.Handle(500, "Marshal", err)
  345. return
  346. }
  347. w.URL = f.PayloadURL
  348. w.Meta = string(meta)
  349. w.HookEvent = ParseHookEvent(f.Webhook)
  350. w.IsActive = f.Active
  351. if err := w.UpdateEvent(); err != nil {
  352. c.Handle(500, "UpdateEvent", err)
  353. return
  354. } else if err := models.UpdateWebhook(w); err != nil {
  355. c.Handle(500, "UpdateWebhook", err)
  356. return
  357. }
  358. c.Flash.Success(c.Tr("repo.settings.update_hook_success"))
  359. c.Redirect(fmt.Sprintf("%s/settings/hooks/%d", orCtx.Link, w.ID))
  360. }
  361. // DiscordHooksEditPost edits discord hooks
  362. func DiscordHooksEditPost(c *context.Context, f form.NewDiscordHook) {
  363. c.Data["Title"] = c.Tr("repo.settings")
  364. c.Data["PageIsSettingsHooks"] = true
  365. c.Data["PageIsSettingsHooksEdit"] = true
  366. orCtx, w := checkWebhook(c)
  367. if c.Written() {
  368. return
  369. }
  370. c.Data["Webhook"] = w
  371. if c.HasError() {
  372. c.HTML(200, orCtx.NewTemplate)
  373. return
  374. }
  375. meta, err := jsoniter.Marshal(&models.SlackMeta{
  376. Username: f.Username,
  377. IconURL: f.IconURL,
  378. Color: f.Color,
  379. })
  380. if err != nil {
  381. c.Handle(500, "Marshal", err)
  382. return
  383. }
  384. w.URL = f.PayloadURL
  385. w.Meta = string(meta)
  386. w.HookEvent = ParseHookEvent(f.Webhook)
  387. w.IsActive = f.Active
  388. if err := w.UpdateEvent(); err != nil {
  389. c.Handle(500, "UpdateEvent", err)
  390. return
  391. } else if err := models.UpdateWebhook(w); err != nil {
  392. c.Handle(500, "UpdateWebhook", err)
  393. return
  394. }
  395. c.Flash.Success(c.Tr("repo.settings.update_hook_success"))
  396. c.Redirect(fmt.Sprintf("%s/settings/hooks/%d", orCtx.Link, w.ID))
  397. }
  398. // TestWebhook test if web hook is work fine
  399. func TestWebhook(c *context.Context) {
  400. var authorUsername, committerUsername string
  401. // Grab latest commit or fake one if it's empty repository.
  402. commit := c.Repo.Commit
  403. if commit == nil {
  404. ghost := models.NewGhostUser()
  405. commit = &git.Commit{
  406. ID: git.MustIDFromString(git.EMPTY_SHA),
  407. Author: ghost.NewGitSig(),
  408. Committer: ghost.NewGitSig(),
  409. CommitMessage: "This is a fake commit",
  410. }
  411. authorUsername = ghost.Name
  412. committerUsername = ghost.Name
  413. } else {
  414. // Try to match email with a real user.
  415. author, err := models.GetUserByEmail(commit.Author.Email)
  416. if err == nil {
  417. authorUsername = author.Name
  418. } else if !errors.IsUserNotExist(err) {
  419. c.Handle(500, "GetUserByEmail.(author)", err)
  420. return
  421. }
  422. committer, err := models.GetUserByEmail(commit.Committer.Email)
  423. if err == nil {
  424. committerUsername = committer.Name
  425. } else if !errors.IsUserNotExist(err) {
  426. c.Handle(500, "GetUserByEmail.(committer)", err)
  427. return
  428. }
  429. }
  430. fileStatus, err := commit.FileStatus()
  431. if err != nil {
  432. c.Handle(500, "FileStatus", err)
  433. return
  434. }
  435. apiUser := c.User.APIFormat()
  436. p := &api.PushPayload{
  437. Ref: git.BRANCH_PREFIX + c.Repo.Repository.DefaultBranch,
  438. Before: commit.ID.String(),
  439. After: commit.ID.String(),
  440. Commits: []*api.PayloadCommit{
  441. {
  442. ID: commit.ID.String(),
  443. Message: commit.Message(),
  444. URL: c.Repo.Repository.HTMLURL() + "/commit/" + commit.ID.String(),
  445. Author: &api.PayloadUser{
  446. Name: commit.Author.Name,
  447. Email: commit.Author.Email,
  448. UserName: authorUsername,
  449. },
  450. Committer: &api.PayloadUser{
  451. Name: commit.Committer.Name,
  452. Email: commit.Committer.Email,
  453. UserName: committerUsername,
  454. },
  455. Added: fileStatus.Added,
  456. Removed: fileStatus.Removed,
  457. Modified: fileStatus.Modified,
  458. },
  459. },
  460. Repo: c.Repo.Repository.APIFormat(nil),
  461. Pusher: apiUser,
  462. Sender: apiUser,
  463. }
  464. if err := models.TestWebhook(c.Repo.Repository, models.HookEventPush, p, c.ParamsInt64("id")); err != nil {
  465. c.Handle(500, "TestWebhook", err)
  466. } else {
  467. c.Flash.Info(c.Tr("repo.settings.webhook.test_delivery_success"))
  468. c.Status(200)
  469. }
  470. }
  471. // RedeliveryWebhook re-deliver a webhook
  472. func RedeliveryWebhook(c *context.Context) {
  473. webhook, err := models.GetWebhookOfRepoByID(c.Repo.Repository.ID, c.ParamsInt64(":id"))
  474. if err != nil {
  475. c.NotFoundOrServerError("GetWebhookOfRepoByID/GetWebhookByOrgID", errors.IsWebhookNotExist, err)
  476. return
  477. }
  478. hookTask, err := models.GetHookTaskOfWebhookByUUID(webhook.ID, c.Query("uuid"))
  479. if err != nil {
  480. c.NotFoundOrServerError("GetHookTaskOfWebhookByUUID/GetWebhookByOrgID", errors.IsHookTaskNotExist, err)
  481. return
  482. }
  483. hookTask.IsDelivered = false
  484. if err = models.UpdateHookTask(hookTask); err != nil {
  485. c.Handle(500, "UpdateHookTask", err)
  486. } else {
  487. go models.HookQueue.Add(c.Repo.Repository.ID)
  488. c.Flash.Info(c.Tr("repo.settings.webhook.redelivery_success", hookTask.UUID))
  489. c.Status(200)
  490. }
  491. }
  492. // DeleteWebhook delete a webhook
  493. func DeleteWebhook(c *context.Context) {
  494. if err := models.DeleteWebhookOfRepoByID(c.Repo.Repository.ID, c.QueryInt64("id")); err != nil {
  495. c.Flash.Error("DeleteWebhookByRepoID: " + err.Error())
  496. } else {
  497. c.Flash.Success(c.Tr("repo.settings.webhook_deletion_success"))
  498. }
  499. c.JSON(200, map[string]interface{}{
  500. "redirect": c.Repo.RepoLink + "/settings/hooks",
  501. })
  502. }