webhook.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791
  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 models
  7. import (
  8. "crypto/hmac"
  9. "crypto/sha256"
  10. "crypto/tls"
  11. "encoding/hex"
  12. "fmt"
  13. "gitote/gitote/models/errors"
  14. "gitote/gitote/pkg/httplib"
  15. "gitote/gitote/pkg/setting"
  16. "gitote/gitote/pkg/sync"
  17. "io/ioutil"
  18. "strings"
  19. "time"
  20. raven "github.com/getsentry/raven-go"
  21. "github.com/go-xorm/xorm"
  22. "github.com/json-iterator/go"
  23. gouuid "github.com/satori/go.uuid"
  24. api "gitlab.com/gitote/go-gitote-client"
  25. log "gopkg.in/clog.v1"
  26. )
  27. // HookQueue is a global queue of web hooks
  28. var HookQueue = sync.NewUniqueQueue(setting.Webhook.QueueLength)
  29. // HookContentType is the content type of a web hook
  30. type HookContentType int
  31. const (
  32. // ContentTypeJSON is a JSON payload for web hooks
  33. ContentTypeJSON HookContentType = iota + 1
  34. // ContentTypeForm is an url-encoded form payload for web hook
  35. ContentTypeForm
  36. )
  37. var hookContentTypes = map[string]HookContentType{
  38. "json": ContentTypeJSON,
  39. "form": ContentTypeForm,
  40. }
  41. // ToHookContentType returns HookContentType by given name.
  42. func ToHookContentType(name string) HookContentType {
  43. return hookContentTypes[name]
  44. }
  45. // Name returns the name of a given web hook's content type
  46. func (t HookContentType) Name() string {
  47. switch t {
  48. case ContentTypeJSON:
  49. return "json"
  50. case ContentTypeForm:
  51. return "form"
  52. }
  53. return ""
  54. }
  55. // IsValidHookContentType returns true if given name is a valid hook content type.
  56. func IsValidHookContentType(name string) bool {
  57. _, ok := hookContentTypes[name]
  58. return ok
  59. }
  60. // HookEvents is a set of web hook events
  61. type HookEvents struct {
  62. Create bool `json:"create"`
  63. Delete bool `json:"delete"`
  64. Fork bool `json:"fork"`
  65. Push bool `json:"push"`
  66. Issues bool `json:"issues"`
  67. PullRequest bool `json:"pull_request"`
  68. IssueComment bool `json:"issue_comment"`
  69. Release bool `json:"release"`
  70. }
  71. // HookEvent represents events that will delivery hook.
  72. type HookEvent struct {
  73. PushOnly bool `json:"push_only"`
  74. SendEverything bool `json:"send_everything"`
  75. ChooseEvents bool `json:"choose_events"`
  76. HookEvents `json:"events"`
  77. }
  78. // HookStatus is the status of a web hook
  79. type HookStatus int
  80. // Possible statuses of a web hook
  81. const (
  82. HookStatusNone = iota
  83. HookStatusSucceed
  84. HookStatusFailed
  85. )
  86. // Webhook represents a web hook object.
  87. type Webhook struct {
  88. ID int64
  89. RepoID int64
  90. OrgID int64
  91. URL string `xorm:"url TEXT"`
  92. ContentType HookContentType
  93. Secret string `xorm:"TEXT"`
  94. Events string `xorm:"TEXT"`
  95. *HookEvent `xorm:"-"` // LEGACY [1.0]: Cannot ignore ContentTypeJSON here, it breaks old backup archive
  96. IsSSL bool `xorm:"is_ssl"`
  97. IsActive bool
  98. HookTaskType HookTaskType
  99. Meta string `xorm:"TEXT"` // store hook-specific attributes
  100. LastStatus HookStatus // Last delivery status
  101. Created time.Time `xorm:"-" json:"-"`
  102. CreatedUnix int64
  103. Updated time.Time `xorm:"-" json:"-"`
  104. UpdatedUnix int64
  105. }
  106. // BeforeInsert will be invoked by XORM before inserting a record
  107. func (w *Webhook) BeforeInsert() {
  108. w.CreatedUnix = time.Now().Unix()
  109. w.UpdatedUnix = w.CreatedUnix
  110. }
  111. // BeforeUpdate is invoked from XORM before updating this object.
  112. func (w *Webhook) BeforeUpdate() {
  113. w.UpdatedUnix = time.Now().Unix()
  114. }
  115. // AfterSet is invoked from XORM after setting the values of all fields of this object.
  116. func (w *Webhook) AfterSet(colName string, _ xorm.Cell) {
  117. var err error
  118. switch colName {
  119. case "events":
  120. w.HookEvent = &HookEvent{}
  121. if err = jsoniter.Unmarshal([]byte(w.Events), w.HookEvent); err != nil {
  122. raven.CaptureErrorAndWait(err, nil)
  123. log.Error(3, "Unmarshal [%d]: %v", w.ID, err)
  124. }
  125. case "created_unix":
  126. w.Created = time.Unix(w.CreatedUnix, 0).Local()
  127. case "updated_unix":
  128. w.Updated = time.Unix(w.UpdatedUnix, 0).Local()
  129. }
  130. }
  131. // GetSlackHook returns slack metadata
  132. func (w *Webhook) GetSlackHook() *SlackMeta {
  133. s := &SlackMeta{}
  134. if err := jsoniter.Unmarshal([]byte(w.Meta), s); err != nil {
  135. raven.CaptureErrorAndWait(err, nil)
  136. log.Error(2, "GetSlackHook [%d]: %v", w.ID, err)
  137. }
  138. return s
  139. }
  140. // History returns history of webhook by given conditions.
  141. func (w *Webhook) History(page int) ([]*HookTask, error) {
  142. return HookTasks(w.ID, page)
  143. }
  144. // UpdateEvent handles conversion from HookEvent to Events.
  145. func (w *Webhook) UpdateEvent() error {
  146. data, err := jsoniter.Marshal(w.HookEvent)
  147. w.Events = string(data)
  148. return err
  149. }
  150. // HasCreateEvent returns true if hook enabled create event.
  151. func (w *Webhook) HasCreateEvent() bool {
  152. return w.SendEverything ||
  153. (w.ChooseEvents && w.HookEvents.Create)
  154. }
  155. // HasDeleteEvent returns true if hook enabled delete event.
  156. func (w *Webhook) HasDeleteEvent() bool {
  157. return w.SendEverything ||
  158. (w.ChooseEvents && w.HookEvents.Delete)
  159. }
  160. // HasForkEvent returns true if hook enabled fork event.
  161. func (w *Webhook) HasForkEvent() bool {
  162. return w.SendEverything ||
  163. (w.ChooseEvents && w.HookEvents.Fork)
  164. }
  165. // HasPushEvent returns true if hook enabled push event.
  166. func (w *Webhook) HasPushEvent() bool {
  167. return w.PushOnly || w.SendEverything ||
  168. (w.ChooseEvents && w.HookEvents.Push)
  169. }
  170. // HasIssuesEvent returns true if hook enabled issues event.
  171. func (w *Webhook) HasIssuesEvent() bool {
  172. return w.SendEverything ||
  173. (w.ChooseEvents && w.HookEvents.Issues)
  174. }
  175. // HasPullRequestEvent returns true if hook enabled pull request event.
  176. func (w *Webhook) HasPullRequestEvent() bool {
  177. return w.SendEverything ||
  178. (w.ChooseEvents && w.HookEvents.PullRequest)
  179. }
  180. // HasIssueCommentEvent returns true if hook enabled issue comment event.
  181. func (w *Webhook) HasIssueCommentEvent() bool {
  182. return w.SendEverything ||
  183. (w.ChooseEvents && w.HookEvents.IssueComment)
  184. }
  185. // HasReleaseEvent returns true if hook enabled release event.
  186. func (w *Webhook) HasReleaseEvent() bool {
  187. return w.SendEverything ||
  188. (w.ChooseEvents && w.HookEvents.Release)
  189. }
  190. type eventChecker struct {
  191. checker func() bool
  192. typ HookEventType
  193. }
  194. // EventsArray returns an array of hook events
  195. func (w *Webhook) EventsArray() []string {
  196. events := make([]string, 0, 8)
  197. eventCheckers := []eventChecker{
  198. {w.HasCreateEvent, HookEventCreate},
  199. {w.HasDeleteEvent, HookEventDelete},
  200. {w.HasForkEvent, HookEventFork},
  201. {w.HasPushEvent, HookEventPush},
  202. {w.HasIssuesEvent, HookEventIssues},
  203. {w.HasPullRequestEvent, HookEventPullRequest},
  204. {w.HasIssueCommentEvent, HookEventIssueComment},
  205. {w.HasReleaseEvent, HookEventRelease},
  206. }
  207. for _, c := range eventCheckers {
  208. if c.checker() {
  209. events = append(events, string(c.typ))
  210. }
  211. }
  212. return events
  213. }
  214. // CreateWebhook creates a new web hook.
  215. func CreateWebhook(w *Webhook) error {
  216. _, err := x.Insert(w)
  217. return err
  218. }
  219. // getWebhook uses argument bean as query condition,
  220. // ID must be specified and do not assign unnecessary fields.
  221. func getWebhook(bean *Webhook) (*Webhook, error) {
  222. has, err := x.Get(bean)
  223. if err != nil {
  224. return nil, err
  225. } else if !has {
  226. return nil, errors.WebhookNotExist{bean.ID}
  227. }
  228. return bean, nil
  229. }
  230. // GetWebhookByID returns webhook by given ID.
  231. // Use this function with caution of accessing unauthorized webhook,
  232. // which means should only be used in non-user interactive functions.
  233. func GetWebhookByID(id int64) (*Webhook, error) {
  234. return getWebhook(&Webhook{
  235. ID: id,
  236. })
  237. }
  238. // GetWebhookOfRepoByID returns webhook of repository by given ID.
  239. func GetWebhookOfRepoByID(repoID, id int64) (*Webhook, error) {
  240. return getWebhook(&Webhook{
  241. ID: id,
  242. RepoID: repoID,
  243. })
  244. }
  245. // GetWebhookByOrgID returns webhook of organization by given ID.
  246. func GetWebhookByOrgID(orgID, id int64) (*Webhook, error) {
  247. return getWebhook(&Webhook{
  248. ID: id,
  249. OrgID: orgID,
  250. })
  251. }
  252. // getActiveWebhooksByRepoID returns all active webhooks of repository.
  253. func getActiveWebhooksByRepoID(e Engine, repoID int64) ([]*Webhook, error) {
  254. webhooks := make([]*Webhook, 0, 5)
  255. return webhooks, e.Where("repo_id = ?", repoID).And("is_active = ?", true).Find(&webhooks)
  256. }
  257. // GetWebhooksByRepoID returns all webhooks of a repository.
  258. func GetWebhooksByRepoID(repoID int64) ([]*Webhook, error) {
  259. webhooks := make([]*Webhook, 0, 5)
  260. return webhooks, x.Find(&webhooks, &Webhook{RepoID: repoID})
  261. }
  262. // UpdateWebhook updates information of webhook.
  263. func UpdateWebhook(w *Webhook) error {
  264. _, err := x.Id(w.ID).AllCols().Update(w)
  265. return err
  266. }
  267. // deleteWebhook uses argument bean as query condition,
  268. // ID must be specified and do not assign unnecessary fields.
  269. func deleteWebhook(bean *Webhook) (err error) {
  270. sess := x.NewSession()
  271. defer sess.Close()
  272. if err = sess.Begin(); err != nil {
  273. return err
  274. }
  275. if _, err = sess.Delete(bean); err != nil {
  276. return err
  277. } else if _, err = sess.Delete(&HookTask{HookID: bean.ID}); err != nil {
  278. return err
  279. }
  280. return sess.Commit()
  281. }
  282. // DeleteWebhookOfRepoByID deletes webhook of repository by given ID.
  283. func DeleteWebhookOfRepoByID(repoID, id int64) error {
  284. return deleteWebhook(&Webhook{
  285. ID: id,
  286. RepoID: repoID,
  287. })
  288. }
  289. // DeleteWebhookOfOrgByID deletes webhook of organization by given ID.
  290. func DeleteWebhookOfOrgByID(orgID, id int64) error {
  291. return deleteWebhook(&Webhook{
  292. ID: id,
  293. OrgID: orgID,
  294. })
  295. }
  296. // GetWebhooksByOrgID returns all webhooks for an organization.
  297. func GetWebhooksByOrgID(orgID int64) (ws []*Webhook, err error) {
  298. err = x.Find(&ws, &Webhook{OrgID: orgID})
  299. return ws, err
  300. }
  301. // getActiveWebhooksByOrgID returns all active webhooks for an organization.
  302. func getActiveWebhooksByOrgID(e Engine, orgID int64) ([]*Webhook, error) {
  303. ws := make([]*Webhook, 0, 3)
  304. return ws, e.Where("org_id=?", orgID).And("is_active=?", true).Find(&ws)
  305. }
  306. // HookTaskType is the type of an hook task
  307. type HookTaskType int
  308. // Types of hook tasks
  309. const (
  310. GITOTE HookTaskType = iota + 1
  311. SLACK
  312. DISCORD
  313. )
  314. var hookTaskTypes = map[string]HookTaskType{
  315. "gitote": GITOTE,
  316. "slack": SLACK,
  317. "discord": DISCORD,
  318. }
  319. // ToHookTaskType returns HookTaskType by given name.
  320. func ToHookTaskType(name string) HookTaskType {
  321. return hookTaskTypes[name]
  322. }
  323. // Name returns the name of an hook task type
  324. func (t HookTaskType) Name() string {
  325. switch t {
  326. case GITOTE:
  327. return "gitote"
  328. case SLACK:
  329. return "slack"
  330. case DISCORD:
  331. return "discord"
  332. }
  333. return ""
  334. }
  335. // IsValidHookTaskType returns true if given name is a valid hook task type.
  336. func IsValidHookTaskType(name string) bool {
  337. _, ok := hookTaskTypes[name]
  338. return ok
  339. }
  340. // HookEventType is the type of an hook event
  341. type HookEventType string
  342. // Types of hook events
  343. const (
  344. HookEventCreate HookEventType = "create"
  345. HookEventDelete HookEventType = "delete"
  346. HookEventFork HookEventType = "fork"
  347. HookEventPush HookEventType = "push"
  348. HookEventIssues HookEventType = "issues"
  349. HookEventPullRequest HookEventType = "pull_request"
  350. HookEventIssueComment HookEventType = "issue_comment"
  351. HookEventRelease HookEventType = "release"
  352. )
  353. // HookRequest represents hook task request information.
  354. type HookRequest struct {
  355. Headers map[string]string `json:"headers"`
  356. }
  357. // HookResponse represents hook task response information.
  358. type HookResponse struct {
  359. Status int `json:"status"`
  360. Headers map[string]string `json:"headers"`
  361. Body string `json:"body"`
  362. }
  363. // HookTask represents a hook task.
  364. type HookTask struct {
  365. ID int64
  366. RepoID int64 `xorm:"INDEX"`
  367. HookID int64
  368. UUID string
  369. Type HookTaskType
  370. URL string `xorm:"TEXT"`
  371. Signature string `xorm:"TEXT"`
  372. api.Payloader `xorm:"-" json:"-"`
  373. PayloadContent string `xorm:"TEXT"`
  374. ContentType HookContentType
  375. EventType HookEventType
  376. IsSSL bool
  377. IsDelivered bool
  378. Delivered int64
  379. DeliveredString string `xorm:"-" json:"-"`
  380. // History info.
  381. IsSucceed bool
  382. RequestContent string `xorm:"TEXT"`
  383. RequestInfo *HookRequest `xorm:"-" json:"-"`
  384. ResponseContent string `xorm:"TEXT"`
  385. ResponseInfo *HookResponse `xorm:"-" json:"-"`
  386. }
  387. // BeforeUpdate is invoked from XORM before updating this object.
  388. func (t *HookTask) BeforeUpdate() {
  389. if t.RequestInfo != nil {
  390. t.RequestContent = t.MarshalJSON(t.RequestInfo)
  391. }
  392. if t.ResponseInfo != nil {
  393. t.ResponseContent = t.MarshalJSON(t.ResponseInfo)
  394. }
  395. }
  396. // AfterSet is invoked from XORM after setting the values of all fields of this object.
  397. func (t *HookTask) AfterSet(colName string, _ xorm.Cell) {
  398. var err error
  399. switch colName {
  400. case "delivered":
  401. t.DeliveredString = time.Unix(0, t.Delivered).Format("2006-01-02 15:04:05 MST")
  402. case "request_content":
  403. if len(t.RequestContent) == 0 {
  404. return
  405. }
  406. t.RequestInfo = &HookRequest{}
  407. if err = jsoniter.Unmarshal([]byte(t.RequestContent), t.RequestInfo); err != nil {
  408. raven.CaptureErrorAndWait(err, nil)
  409. log.Error(3, "Unmarshal[%d]: %v", t.ID, err)
  410. }
  411. case "response_content":
  412. if len(t.ResponseContent) == 0 {
  413. return
  414. }
  415. t.ResponseInfo = &HookResponse{}
  416. if err = jsoniter.Unmarshal([]byte(t.ResponseContent), t.ResponseInfo); err != nil {
  417. raven.CaptureErrorAndWait(err, nil)
  418. log.Error(3, "Unmarshal [%d]: %v", t.ID, err)
  419. }
  420. }
  421. }
  422. // MarshalJSON encode to JSON
  423. func (t *HookTask) MarshalJSON(v interface{}) string {
  424. p, err := jsoniter.Marshal(v)
  425. if err != nil {
  426. raven.CaptureErrorAndWait(err, nil)
  427. log.Error(3, "Marshal [%d]: %v", t.ID, err)
  428. }
  429. return string(p)
  430. }
  431. // HookTasks returns a list of hook tasks by given conditions.
  432. func HookTasks(hookID int64, page int) ([]*HookTask, error) {
  433. tasks := make([]*HookTask, 0, setting.Webhook.PagingNum)
  434. return tasks, x.Limit(setting.Webhook.PagingNum, (page-1)*setting.Webhook.PagingNum).Where("hook_id=?", hookID).Desc("id").Find(&tasks)
  435. }
  436. // createHookTask creates a new hook task,
  437. // it handles conversion from Payload to PayloadContent.
  438. func createHookTask(e Engine, t *HookTask) error {
  439. data, err := t.Payloader.JSONPayload()
  440. if err != nil {
  441. return err
  442. }
  443. t.UUID = gouuid.NewV4().String()
  444. t.PayloadContent = string(data)
  445. _, err = e.Insert(t)
  446. return err
  447. }
  448. // GetHookTaskOfWebhookByUUID returns hook task of given webhook by UUID.
  449. func GetHookTaskOfWebhookByUUID(webhookID int64, uuid string) (*HookTask, error) {
  450. hookTask := &HookTask{
  451. HookID: webhookID,
  452. UUID: uuid,
  453. }
  454. has, err := x.Get(hookTask)
  455. if err != nil {
  456. return nil, err
  457. } else if !has {
  458. return nil, errors.HookTaskNotExist{webhookID, uuid}
  459. }
  460. return hookTask, nil
  461. }
  462. // UpdateHookTask updates information of hook task.
  463. func UpdateHookTask(t *HookTask) error {
  464. _, err := x.Id(t.ID).AllCols().Update(t)
  465. return err
  466. }
  467. // prepareHookTasks adds list of webhooks to task queue.
  468. func prepareHookTasks(e Engine, repo *Repository, event HookEventType, p api.Payloader, webhooks []*Webhook) (err error) {
  469. if len(webhooks) == 0 {
  470. return nil
  471. }
  472. var payloader api.Payloader
  473. for _, w := range webhooks {
  474. switch event {
  475. case HookEventCreate:
  476. if !w.HasCreateEvent() {
  477. continue
  478. }
  479. case HookEventDelete:
  480. if !w.HasDeleteEvent() {
  481. continue
  482. }
  483. case HookEventFork:
  484. if !w.HasForkEvent() {
  485. continue
  486. }
  487. case HookEventPush:
  488. if !w.HasPushEvent() {
  489. continue
  490. }
  491. case HookEventIssues:
  492. if !w.HasIssuesEvent() {
  493. continue
  494. }
  495. case HookEventPullRequest:
  496. if !w.HasPullRequestEvent() {
  497. continue
  498. }
  499. case HookEventIssueComment:
  500. if !w.HasIssueCommentEvent() {
  501. continue
  502. }
  503. case HookEventRelease:
  504. if !w.HasReleaseEvent() {
  505. continue
  506. }
  507. }
  508. // Use separate objects so modifcations won't be made on payload on non-Gitote type hooks.
  509. switch w.HookTaskType {
  510. case SLACK:
  511. payloader, err = GetSlackPayload(p, event, w.Meta)
  512. if err != nil {
  513. return fmt.Errorf("GetSlackPayload: %v", err)
  514. }
  515. case DISCORD:
  516. payloader, err = GetDiscordPayload(p, event, w.Meta)
  517. if err != nil {
  518. return fmt.Errorf("GetDiscordPayload: %v", err)
  519. }
  520. default:
  521. payloader = p
  522. }
  523. var signature string
  524. if len(w.Secret) > 0 {
  525. data, err := payloader.JSONPayload()
  526. if err != nil {
  527. raven.CaptureErrorAndWait(err, nil)
  528. log.Error(2, "prepareWebhooks.JSONPayload: %v", err)
  529. }
  530. sig := hmac.New(sha256.New, []byte(w.Secret))
  531. sig.Write(data)
  532. signature = hex.EncodeToString(sig.Sum(nil))
  533. }
  534. if err = createHookTask(e, &HookTask{
  535. RepoID: repo.ID,
  536. HookID: w.ID,
  537. Type: w.HookTaskType,
  538. URL: w.URL,
  539. Signature: signature,
  540. Payloader: payloader,
  541. ContentType: w.ContentType,
  542. EventType: event,
  543. IsSSL: w.IsSSL,
  544. }); err != nil {
  545. return fmt.Errorf("createHookTask: %v", err)
  546. }
  547. }
  548. // It's safe to fail when the whole function is called during hook execution
  549. // because resource released after exit. Also, there is no process started to
  550. // consume this input during hook execution.
  551. go HookQueue.Add(repo.ID)
  552. return nil
  553. }
  554. func prepareWebhooks(e Engine, repo *Repository, event HookEventType, p api.Payloader) error {
  555. webhooks, err := getActiveWebhooksByRepoID(e, repo.ID)
  556. if err != nil {
  557. return fmt.Errorf("getActiveWebhooksByRepoID [%d]: %v", repo.ID, err)
  558. }
  559. // check if repo belongs to org and append additional webhooks
  560. if repo.mustOwner(e).IsOrganization() {
  561. // get hooks for org
  562. orgws, err := getActiveWebhooksByOrgID(e, repo.OwnerID)
  563. if err != nil {
  564. return fmt.Errorf("getActiveWebhooksByOrgID [%d]: %v", repo.OwnerID, err)
  565. }
  566. webhooks = append(webhooks, orgws...)
  567. }
  568. return prepareHookTasks(e, repo, event, p, webhooks)
  569. }
  570. // PrepareWebhooks adds all active webhooks to task queue.
  571. func PrepareWebhooks(repo *Repository, event HookEventType, p api.Payloader) error {
  572. return prepareWebhooks(x, repo, event, p)
  573. }
  574. // TestWebhook adds the test webhook matches the ID to task queue.
  575. func TestWebhook(repo *Repository, event HookEventType, p api.Payloader, webhookID int64) error {
  576. webhook, err := GetWebhookOfRepoByID(repo.ID, webhookID)
  577. if err != nil {
  578. return fmt.Errorf("GetWebhookOfRepoByID [repo_id: %d, id: %d]: %v", repo.ID, webhookID, err)
  579. }
  580. return prepareHookTasks(x, repo, event, p, []*Webhook{webhook})
  581. }
  582. func (t *HookTask) deliver() {
  583. t.IsDelivered = true
  584. timeout := time.Duration(setting.Webhook.DeliverTimeout) * time.Second
  585. req := httplib.Post(t.URL).SetTimeout(timeout, timeout).
  586. Header("X-Github-Delivery", t.UUID).
  587. Header("X-Github-Event", string(t.EventType)).
  588. Header("X-Gitote-Delivery", t.UUID).
  589. Header("X-Gitote-Signature", t.Signature).
  590. Header("X-Gitote-Event", string(t.EventType)).
  591. SetTLSClientConfig(&tls.Config{InsecureSkipVerify: setting.Webhook.SkipTLSVerify})
  592. switch t.ContentType {
  593. case ContentTypeJSON:
  594. req = req.Header("Content-Type", "application/json").Body(t.PayloadContent)
  595. case ContentTypeForm:
  596. req.Param("payload", t.PayloadContent)
  597. }
  598. // Record delivery information.
  599. t.RequestInfo = &HookRequest{
  600. Headers: map[string]string{},
  601. }
  602. for k, vals := range req.Headers() {
  603. t.RequestInfo.Headers[k] = strings.Join(vals, ",")
  604. }
  605. t.ResponseInfo = &HookResponse{
  606. Headers: map[string]string{},
  607. }
  608. defer func() {
  609. t.Delivered = time.Now().UnixNano()
  610. if t.IsSucceed {
  611. log.Trace("Hook delivered: %s", t.UUID)
  612. } else {
  613. log.Trace("Hook delivery failed: %s", t.UUID)
  614. }
  615. // Update webhook last delivery status.
  616. w, err := GetWebhookByID(t.HookID)
  617. if err != nil {
  618. raven.CaptureErrorAndWait(err, nil)
  619. log.Error(3, "GetWebhookByID: %v", err)
  620. return
  621. }
  622. if t.IsSucceed {
  623. w.LastStatus = HookStatusSucceed
  624. } else {
  625. w.LastStatus = HookStatusFailed
  626. }
  627. if err = UpdateWebhook(w); err != nil {
  628. raven.CaptureErrorAndWait(err, nil)
  629. log.Error(3, "UpdateWebhook: %v", err)
  630. return
  631. }
  632. }()
  633. resp, err := req.Response()
  634. if err != nil {
  635. t.ResponseInfo.Body = fmt.Sprintf("Delivery: %v", err)
  636. return
  637. }
  638. defer resp.Body.Close()
  639. // Status code is 20x can be seen as succeed.
  640. t.IsSucceed = resp.StatusCode/100 == 2
  641. t.ResponseInfo.Status = resp.StatusCode
  642. for k, vals := range resp.Header {
  643. t.ResponseInfo.Headers[k] = strings.Join(vals, ",")
  644. }
  645. p, err := ioutil.ReadAll(resp.Body)
  646. if err != nil {
  647. t.ResponseInfo.Body = fmt.Sprintf("read body: %s", err)
  648. return
  649. }
  650. t.ResponseInfo.Body = string(p)
  651. }
  652. // DeliverHooks checks and delivers undelivered hooks.
  653. // TODO: shoot more hooks at same time.
  654. func DeliverHooks() {
  655. tasks := make([]*HookTask, 0, 10)
  656. x.Where("is_delivered = ?", false).Iterate(new(HookTask),
  657. func(idx int, bean interface{}) error {
  658. t := bean.(*HookTask)
  659. t.deliver()
  660. tasks = append(tasks, t)
  661. return nil
  662. })
  663. // Update hook task status.
  664. for _, t := range tasks {
  665. if err := UpdateHookTask(t); err != nil {
  666. raven.CaptureErrorAndWait(err, nil)
  667. log.Error(4, "UpdateHookTask [%d]: %v", t.ID, err)
  668. }
  669. }
  670. // Start listening on new hook requests.
  671. for repoID := range HookQueue.Queue() {
  672. log.Trace("DeliverHooks [repo_id: %v]", repoID)
  673. HookQueue.Remove(repoID)
  674. tasks = make([]*HookTask, 0, 5)
  675. if err := x.Where("repo_id = ?", repoID).And("is_delivered = ?", false).Find(&tasks); err != nil {
  676. raven.CaptureErrorAndWait(err, nil)
  677. log.Error(4, "Get repository [%s] hook tasks: %v", repoID, err)
  678. continue
  679. }
  680. for _, t := range tasks {
  681. t.deliver()
  682. if err := UpdateHookTask(t); err != nil {
  683. raven.CaptureErrorAndWait(err, nil)
  684. log.Error(4, "UpdateHookTask [%d]: %v", t.ID, err)
  685. continue
  686. }
  687. }
  688. }
  689. }
  690. // InitDeliverHooks starts the hooks delivery thread
  691. func InitDeliverHooks() {
  692. go DeliverHooks()
  693. }