webhook.go 14 KB

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