webhook.go 14 KB

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