aboutsummaryrefslogtreecommitdiffstats
path: root/modules
diff options
context:
space:
mode:
authordelvh <leon@kske.dev>2023-01-01 16:23:15 +0100
committerGitHub <noreply@github.com>2023-01-01 23:23:15 +0800
commit0f4e1b9ac66b8ffa0083a5a2516e4710393bb0da (patch)
tree4514951316ebfb10dabf1ffbc856142839817a80 /modules
parentf8e93ce4238253c01e3ca36c88eb59979be99d12 (diff)
downloadgitea-0f4e1b9ac66b8ffa0083a5a2516e4710393bb0da.tar.gz
gitea-0f4e1b9ac66b8ffa0083a5a2516e4710393bb0da.zip
Restructure `webhook` module (#22256)
Previously, there was an `import services/webhooks` inside `modules/notification/webhook`. This import was removed (after fighting against many import cycles). Additionally, `modules/notification/webhook` was moved to `modules/webhook`, and a few structs/constants were extracted from `models/webhooks` to `modules/webhook`. Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Diffstat (limited to 'modules')
-rw-r--r--modules/notification/notification.go2
-rw-r--r--modules/notification/webhook/webhook.go856
-rw-r--r--modules/webhook/structs.go38
-rw-r--r--modules/webhook/type.go95
4 files changed, 133 insertions, 858 deletions
diff --git a/modules/notification/notification.go b/modules/notification/notification.go
index c3e09bb8a9..10581eb87f 100644
--- a/modules/notification/notification.go
+++ b/modules/notification/notification.go
@@ -16,7 +16,6 @@ import (
"code.gitea.io/gitea/modules/notification/mail"
"code.gitea.io/gitea/modules/notification/mirror"
"code.gitea.io/gitea/modules/notification/ui"
- "code.gitea.io/gitea/modules/notification/webhook"
"code.gitea.io/gitea/modules/repository"
"code.gitea.io/gitea/modules/setting"
)
@@ -36,7 +35,6 @@ func NewContext() {
RegisterNotifier(mail.NewNotifier())
}
RegisterNotifier(indexer.NewNotifier())
- RegisterNotifier(webhook.NewNotifier())
RegisterNotifier(action.NewNotifier())
RegisterNotifier(mirror.NewNotifier())
}
diff --git a/modules/notification/webhook/webhook.go b/modules/notification/webhook/webhook.go
deleted file mode 100644
index 97d5e04340..0000000000
--- a/modules/notification/webhook/webhook.go
+++ /dev/null
@@ -1,856 +0,0 @@
-// Copyright 2019 The Gitea Authors. All rights reserved.
-// SPDX-License-Identifier: MIT
-
-package webhook
-
-import (
- "context"
-
- issues_model "code.gitea.io/gitea/models/issues"
- packages_model "code.gitea.io/gitea/models/packages"
- "code.gitea.io/gitea/models/perm"
- access_model "code.gitea.io/gitea/models/perm/access"
- repo_model "code.gitea.io/gitea/models/repo"
- "code.gitea.io/gitea/models/unit"
- user_model "code.gitea.io/gitea/models/user"
- "code.gitea.io/gitea/models/webhook"
- "code.gitea.io/gitea/modules/git"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/notification/base"
- "code.gitea.io/gitea/modules/repository"
- "code.gitea.io/gitea/modules/setting"
- api "code.gitea.io/gitea/modules/structs"
- "code.gitea.io/gitea/services/convert"
- webhook_services "code.gitea.io/gitea/services/webhook"
-)
-
-type webhookNotifier struct {
- base.NullNotifier
-}
-
-var _ base.Notifier = &webhookNotifier{}
-
-// NewNotifier create a new webhookNotifier notifier
-func NewNotifier() base.Notifier {
- return &webhookNotifier{}
-}
-
-func (m *webhookNotifier) NotifyIssueClearLabels(ctx context.Context, doer *user_model.User, issue *issues_model.Issue) {
- if err := issue.LoadPoster(ctx); err != nil {
- log.Error("LoadPoster: %v", err)
- return
- }
-
- if err := issue.LoadRepo(ctx); err != nil {
- log.Error("LoadRepo: %v", err)
- return
- }
-
- mode, _ := access_model.AccessLevel(ctx, issue.Poster, issue.Repo)
- var err error
- if issue.IsPull {
- if err = issue.LoadPullRequest(ctx); err != nil {
- log.Error("LoadPullRequest: %v", err)
- return
- }
-
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventPullRequestLabel, &api.PullRequestPayload{
- Action: api.HookIssueLabelCleared,
- Index: issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, issue.PullRequest, nil),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- } else {
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventIssueLabel, &api.IssuePayload{
- Action: api.HookIssueLabelCleared,
- Index: issue.Index,
- Issue: convert.ToAPIIssue(ctx, issue),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- }
- if err != nil {
- log.Error("PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
- }
-}
-
-func (m *webhookNotifier) NotifyForkRepository(ctx context.Context, doer *user_model.User, oldRepo, repo *repo_model.Repository) {
- oldMode, _ := access_model.AccessLevel(ctx, doer, oldRepo)
- mode, _ := access_model.AccessLevel(ctx, doer, repo)
-
- // forked webhook
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: oldRepo}, webhook.HookEventFork, &api.ForkPayload{
- Forkee: convert.ToRepo(ctx, oldRepo, oldMode),
- Repo: convert.ToRepo(ctx, repo, mode),
- Sender: convert.ToUser(doer, nil),
- }); err != nil {
- log.Error("PrepareWebhooks [repo_id: %d]: %v", oldRepo.ID, err)
- }
-
- u := repo.MustOwner(ctx)
-
- // Add to hook queue for created repo after session commit.
- if u.IsOrganization() {
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventRepository, &api.RepositoryPayload{
- Action: api.HookRepoCreated,
- Repository: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Organization: convert.ToUser(u, nil),
- Sender: convert.ToUser(doer, nil),
- }); err != nil {
- log.Error("PrepareWebhooks [repo_id: %d]: %v", repo.ID, err)
- }
- }
-}
-
-func (m *webhookNotifier) NotifyCreateRepository(ctx context.Context, doer, u *user_model.User, repo *repo_model.Repository) {
- // Add to hook queue for created repo after session commit.
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventRepository, &api.RepositoryPayload{
- Action: api.HookRepoCreated,
- Repository: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Organization: convert.ToUser(u, nil),
- Sender: convert.ToUser(doer, nil),
- }); err != nil {
- log.Error("PrepareWebhooks [repo_id: %d]: %v", repo.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyDeleteRepository(ctx context.Context, doer *user_model.User, repo *repo_model.Repository) {
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventRepository, &api.RepositoryPayload{
- Action: api.HookRepoDeleted,
- Repository: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Organization: convert.ToUser(repo.MustOwner(ctx), nil),
- Sender: convert.ToUser(doer, nil),
- }); err != nil {
- log.Error("PrepareWebhooks [repo_id: %d]: %v", repo.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyMigrateRepository(ctx context.Context, doer, u *user_model.User, repo *repo_model.Repository) {
- // Add to hook queue for created repo after session commit.
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventRepository, &api.RepositoryPayload{
- Action: api.HookRepoCreated,
- Repository: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Organization: convert.ToUser(u, nil),
- Sender: convert.ToUser(doer, nil),
- }); err != nil {
- log.Error("PrepareWebhooks [repo_id: %d]: %v", repo.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyIssueChangeAssignee(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, assignee *user_model.User, removed bool, comment *issues_model.Comment) {
- if issue.IsPull {
- mode, _ := access_model.AccessLevelUnit(ctx, doer, issue.Repo, unit.TypePullRequests)
-
- if err := issue.LoadPullRequest(ctx); err != nil {
- log.Error("LoadPullRequest failed: %v", err)
- return
- }
- issue.PullRequest.Issue = issue
- apiPullRequest := &api.PullRequestPayload{
- Index: issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, issue.PullRequest, nil),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- }
- if removed {
- apiPullRequest.Action = api.HookIssueUnassigned
- } else {
- apiPullRequest.Action = api.HookIssueAssigned
- }
- // Assignee comment triggers a webhook
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventPullRequestAssign, apiPullRequest); err != nil {
- log.Error("PrepareWebhooks [is_pull: %v, remove_assignee: %v]: %v", issue.IsPull, removed, err)
- return
- }
- } else {
- mode, _ := access_model.AccessLevelUnit(ctx, doer, issue.Repo, unit.TypeIssues)
- apiIssue := &api.IssuePayload{
- Index: issue.Index,
- Issue: convert.ToAPIIssue(ctx, issue),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- }
- if removed {
- apiIssue.Action = api.HookIssueUnassigned
- } else {
- apiIssue.Action = api.HookIssueAssigned
- }
- // Assignee comment triggers a webhook
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventIssueAssign, apiIssue); err != nil {
- log.Error("PrepareWebhooks [is_pull: %v, remove_assignee: %v]: %v", issue.IsPull, removed, err)
- return
- }
- }
-}
-
-func (m *webhookNotifier) NotifyIssueChangeTitle(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, oldTitle string) {
- mode, _ := access_model.AccessLevel(ctx, issue.Poster, issue.Repo)
- var err error
- if issue.IsPull {
- if err = issue.LoadPullRequest(ctx); err != nil {
- log.Error("LoadPullRequest failed: %v", err)
- return
- }
- issue.PullRequest.Issue = issue
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventPullRequest, &api.PullRequestPayload{
- Action: api.HookIssueEdited,
- Index: issue.Index,
- Changes: &api.ChangesPayload{
- Title: &api.ChangesFromPayload{
- From: oldTitle,
- },
- },
- PullRequest: convert.ToAPIPullRequest(ctx, issue.PullRequest, nil),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- } else {
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventIssues, &api.IssuePayload{
- Action: api.HookIssueEdited,
- Index: issue.Index,
- Changes: &api.ChangesPayload{
- Title: &api.ChangesFromPayload{
- From: oldTitle,
- },
- },
- Issue: convert.ToAPIIssue(ctx, issue),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- }
-
- if err != nil {
- log.Error("PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
- }
-}
-
-func (m *webhookNotifier) NotifyIssueChangeStatus(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, actionComment *issues_model.Comment, isClosed bool) {
- mode, _ := access_model.AccessLevel(ctx, issue.Poster, issue.Repo)
- var err error
- if issue.IsPull {
- if err = issue.LoadPullRequest(ctx); err != nil {
- log.Error("LoadPullRequest: %v", err)
- return
- }
- // Merge pull request calls issue.changeStatus so we need to handle separately.
- apiPullRequest := &api.PullRequestPayload{
- Index: issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, issue.PullRequest, nil),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- }
- if isClosed {
- apiPullRequest.Action = api.HookIssueClosed
- } else {
- apiPullRequest.Action = api.HookIssueReOpened
- }
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventPullRequest, apiPullRequest)
- } else {
- apiIssue := &api.IssuePayload{
- Index: issue.Index,
- Issue: convert.ToAPIIssue(ctx, issue),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- }
- if isClosed {
- apiIssue.Action = api.HookIssueClosed
- } else {
- apiIssue.Action = api.HookIssueReOpened
- }
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventIssues, apiIssue)
- }
- if err != nil {
- log.Error("PrepareWebhooks [is_pull: %v, is_closed: %v]: %v", issue.IsPull, isClosed, err)
- }
-}
-
-func (m *webhookNotifier) NotifyNewIssue(ctx context.Context, issue *issues_model.Issue, mentions []*user_model.User) {
- if err := issue.LoadRepo(ctx); err != nil {
- log.Error("issue.LoadRepo: %v", err)
- return
- }
- if err := issue.LoadPoster(ctx); err != nil {
- log.Error("issue.LoadPoster: %v", err)
- return
- }
-
- mode, _ := access_model.AccessLevel(ctx, issue.Poster, issue.Repo)
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventIssues, &api.IssuePayload{
- Action: api.HookIssueOpened,
- Index: issue.Index,
- Issue: convert.ToAPIIssue(ctx, issue),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(issue.Poster, nil),
- }); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
-
-func (m *webhookNotifier) NotifyNewPullRequest(ctx context.Context, pull *issues_model.PullRequest, mentions []*user_model.User) {
- if err := pull.LoadIssue(ctx); err != nil {
- log.Error("pull.LoadIssue: %v", err)
- return
- }
- if err := pull.Issue.LoadRepo(ctx); err != nil {
- log.Error("pull.Issue.LoadRepo: %v", err)
- return
- }
- if err := pull.Issue.LoadPoster(ctx); err != nil {
- log.Error("pull.Issue.LoadPoster: %v", err)
- return
- }
-
- mode, _ := access_model.AccessLevel(ctx, pull.Issue.Poster, pull.Issue.Repo)
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: pull.Issue.Repo}, webhook.HookEventPullRequest, &api.PullRequestPayload{
- Action: api.HookIssueOpened,
- Index: pull.Issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, pull, nil),
- Repository: convert.ToRepo(ctx, pull.Issue.Repo, mode),
- Sender: convert.ToUser(pull.Issue.Poster, nil),
- }); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
-
-func (m *webhookNotifier) NotifyIssueChangeContent(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, oldContent string) {
- if err := issue.LoadRepo(ctx); err != nil {
- log.Error("LoadRepo: %v", err)
- return
- }
-
- mode, _ := access_model.AccessLevel(ctx, issue.Poster, issue.Repo)
- var err error
- if issue.IsPull {
- issue.PullRequest.Issue = issue
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventPullRequest, &api.PullRequestPayload{
- Action: api.HookIssueEdited,
- Index: issue.Index,
- Changes: &api.ChangesPayload{
- Body: &api.ChangesFromPayload{
- From: oldContent,
- },
- },
- PullRequest: convert.ToAPIPullRequest(ctx, issue.PullRequest, nil),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- } else {
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventIssues, &api.IssuePayload{
- Action: api.HookIssueEdited,
- Index: issue.Index,
- Changes: &api.ChangesPayload{
- Body: &api.ChangesFromPayload{
- From: oldContent,
- },
- },
- Issue: convert.ToAPIIssue(ctx, issue),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- }
- if err != nil {
- log.Error("PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
- }
-}
-
-func (m *webhookNotifier) NotifyUpdateComment(ctx context.Context, doer *user_model.User, c *issues_model.Comment, oldContent string) {
- if err := c.LoadPoster(ctx); err != nil {
- log.Error("LoadPoster: %v", err)
- return
- }
- if err := c.LoadIssue(ctx); err != nil {
- log.Error("LoadIssue: %v", err)
- return
- }
-
- if err := c.Issue.LoadAttributes(ctx); err != nil {
- log.Error("LoadAttributes: %v", err)
- return
- }
-
- var eventType webhook.HookEventType
- if c.Issue.IsPull {
- eventType = webhook.HookEventPullRequestComment
- } else {
- eventType = webhook.HookEventIssueComment
- }
-
- mode, _ := access_model.AccessLevel(ctx, doer, c.Issue.Repo)
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: c.Issue.Repo}, eventType, &api.IssueCommentPayload{
- Action: api.HookIssueCommentEdited,
- Issue: convert.ToAPIIssue(ctx, c.Issue),
- Comment: convert.ToComment(c),
- Changes: &api.ChangesPayload{
- Body: &api.ChangesFromPayload{
- From: oldContent,
- },
- },
- Repository: convert.ToRepo(ctx, c.Issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- IsPull: c.Issue.IsPull,
- }); err != nil {
- log.Error("PrepareWebhooks [comment_id: %d]: %v", c.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyCreateIssueComment(ctx context.Context, doer *user_model.User, repo *repo_model.Repository,
- issue *issues_model.Issue, comment *issues_model.Comment, mentions []*user_model.User,
-) {
- var eventType webhook.HookEventType
- if issue.IsPull {
- eventType = webhook.HookEventPullRequestComment
- } else {
- eventType = webhook.HookEventIssueComment
- }
-
- mode, _ := access_model.AccessLevel(ctx, doer, repo)
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, eventType, &api.IssueCommentPayload{
- Action: api.HookIssueCommentCreated,
- Issue: convert.ToAPIIssue(ctx, issue),
- Comment: convert.ToComment(comment),
- Repository: convert.ToRepo(ctx, repo, mode),
- Sender: convert.ToUser(doer, nil),
- IsPull: issue.IsPull,
- }); err != nil {
- log.Error("PrepareWebhooks [comment_id: %d]: %v", comment.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyDeleteComment(ctx context.Context, doer *user_model.User, comment *issues_model.Comment) {
- var err error
-
- if err = comment.LoadPoster(ctx); err != nil {
- log.Error("LoadPoster: %v", err)
- return
- }
- if err = comment.LoadIssue(ctx); err != nil {
- log.Error("LoadIssue: %v", err)
- return
- }
-
- if err = comment.Issue.LoadAttributes(ctx); err != nil {
- log.Error("LoadAttributes: %v", err)
- return
- }
-
- var eventType webhook.HookEventType
- if comment.Issue.IsPull {
- eventType = webhook.HookEventPullRequestComment
- } else {
- eventType = webhook.HookEventIssueComment
- }
-
- mode, _ := access_model.AccessLevel(ctx, doer, comment.Issue.Repo)
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: comment.Issue.Repo}, eventType, &api.IssueCommentPayload{
- Action: api.HookIssueCommentDeleted,
- Issue: convert.ToAPIIssue(ctx, comment.Issue),
- Comment: convert.ToComment(comment),
- Repository: convert.ToRepo(ctx, comment.Issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- IsPull: comment.Issue.IsPull,
- }); err != nil {
- log.Error("PrepareWebhooks [comment_id: %d]: %v", comment.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyNewWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, page, comment string) {
- // Add to hook queue for created wiki page.
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventWiki, &api.WikiPayload{
- Action: api.HookWikiCreated,
- Repository: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Sender: convert.ToUser(doer, nil),
- Page: page,
- Comment: comment,
- }); err != nil {
- log.Error("PrepareWebhooks [repo_id: %d]: %v", repo.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyEditWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, page, comment string) {
- // Add to hook queue for edit wiki page.
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventWiki, &api.WikiPayload{
- Action: api.HookWikiEdited,
- Repository: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Sender: convert.ToUser(doer, nil),
- Page: page,
- Comment: comment,
- }); err != nil {
- log.Error("PrepareWebhooks [repo_id: %d]: %v", repo.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyDeleteWikiPage(ctx context.Context, doer *user_model.User, repo *repo_model.Repository, page string) {
- // Add to hook queue for edit wiki page.
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventWiki, &api.WikiPayload{
- Action: api.HookWikiDeleted,
- Repository: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Sender: convert.ToUser(doer, nil),
- Page: page,
- }); err != nil {
- log.Error("PrepareWebhooks [repo_id: %d]: %v", repo.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyIssueChangeLabels(ctx context.Context, doer *user_model.User, issue *issues_model.Issue,
- addedLabels, removedLabels []*issues_model.Label,
-) {
- var err error
-
- if err = issue.LoadRepo(ctx); err != nil {
- log.Error("LoadRepo: %v", err)
- return
- }
-
- if err = issue.LoadPoster(ctx); err != nil {
- log.Error("LoadPoster: %v", err)
- return
- }
-
- mode, _ := access_model.AccessLevel(ctx, issue.Poster, issue.Repo)
- if issue.IsPull {
- if err = issue.LoadPullRequest(ctx); err != nil {
- log.Error("loadPullRequest: %v", err)
- return
- }
- if err = issue.PullRequest.LoadIssue(ctx); err != nil {
- log.Error("LoadIssue: %v", err)
- return
- }
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventPullRequestLabel, &api.PullRequestPayload{
- Action: api.HookIssueLabelUpdated,
- Index: issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, issue.PullRequest, nil),
- Repository: convert.ToRepo(ctx, issue.Repo, perm.AccessModeNone),
- Sender: convert.ToUser(doer, nil),
- })
- } else {
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventIssueLabel, &api.IssuePayload{
- Action: api.HookIssueLabelUpdated,
- Index: issue.Index,
- Issue: convert.ToAPIIssue(ctx, issue),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- }
- if err != nil {
- log.Error("PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
- }
-}
-
-func (m *webhookNotifier) NotifyIssueChangeMilestone(ctx context.Context, doer *user_model.User, issue *issues_model.Issue, oldMilestoneID int64) {
- var hookAction api.HookIssueAction
- var err error
- if issue.MilestoneID > 0 {
- hookAction = api.HookIssueMilestoned
- } else {
- hookAction = api.HookIssueDemilestoned
- }
-
- if err = issue.LoadAttributes(ctx); err != nil {
- log.Error("issue.LoadAttributes failed: %v", err)
- return
- }
-
- mode, _ := access_model.AccessLevel(ctx, doer, issue.Repo)
- if issue.IsPull {
- err = issue.PullRequest.LoadIssue(ctx)
- if err != nil {
- log.Error("LoadIssue: %v", err)
- return
- }
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventPullRequestMilestone, &api.PullRequestPayload{
- Action: hookAction,
- Index: issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, issue.PullRequest, nil),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- } else {
- err = webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventIssueMilestone, &api.IssuePayload{
- Action: hookAction,
- Index: issue.Index,
- Issue: convert.ToAPIIssue(ctx, issue),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- })
- }
- if err != nil {
- log.Error("PrepareWebhooks [is_pull: %v]: %v", issue.IsPull, err)
- }
-}
-
-func (m *webhookNotifier) NotifyPushCommits(ctx context.Context, pusher *user_model.User, repo *repo_model.Repository, opts *repository.PushUpdateOptions, commits *repository.PushCommits) {
- apiPusher := convert.ToUser(pusher, nil)
- apiCommits, apiHeadCommit, err := commits.ToAPIPayloadCommits(ctx, repo.RepoPath(), repo.HTMLURL())
- if err != nil {
- log.Error("commits.ToAPIPayloadCommits failed: %v", err)
- return
- }
-
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventPush, &api.PushPayload{
- Ref: opts.RefFullName,
- Before: opts.OldCommitID,
- After: opts.NewCommitID,
- CompareURL: setting.AppURL + commits.CompareURL,
- Commits: apiCommits,
- TotalCommits: commits.Len,
- HeadCommit: apiHeadCommit,
- Repo: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Pusher: apiPusher,
- Sender: apiPusher,
- }); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
-
-func (m *webhookNotifier) NotifyAutoMergePullRequest(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest) {
- // just redirect to the NotifyMergePullRequest
- m.NotifyMergePullRequest(ctx, doer, pr)
-}
-
-func (*webhookNotifier) NotifyMergePullRequest(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest) {
- // Reload pull request information.
- if err := pr.LoadAttributes(ctx); err != nil {
- log.Error("LoadAttributes: %v", err)
- return
- }
-
- if err := pr.LoadIssue(ctx); err != nil {
- log.Error("LoadIssue: %v", err)
- return
- }
-
- if err := pr.Issue.LoadRepo(ctx); err != nil {
- log.Error("pr.Issue.LoadRepo: %v", err)
- return
- }
-
- mode, err := access_model.AccessLevel(ctx, doer, pr.Issue.Repo)
- if err != nil {
- log.Error("models.AccessLevel: %v", err)
- return
- }
-
- // Merge pull request calls issue.changeStatus so we need to handle separately.
- apiPullRequest := &api.PullRequestPayload{
- Index: pr.Issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, pr, nil),
- Repository: convert.ToRepo(ctx, pr.Issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- Action: api.HookIssueClosed,
- }
-
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: pr.Issue.Repo}, webhook.HookEventPullRequest, apiPullRequest); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
-
-func (m *webhookNotifier) NotifyPullRequestChangeTargetBranch(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest, oldBranch string) {
- if err := pr.LoadIssue(ctx); err != nil {
- log.Error("LoadIssue: %v", err)
- return
- }
-
- issue := pr.Issue
-
- mode, _ := access_model.AccessLevel(ctx, issue.Poster, issue.Repo)
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: issue.Repo}, webhook.HookEventPullRequest, &api.PullRequestPayload{
- Action: api.HookIssueEdited,
- Index: issue.Index,
- Changes: &api.ChangesPayload{
- Ref: &api.ChangesFromPayload{
- From: oldBranch,
- },
- },
- PullRequest: convert.ToAPIPullRequest(ctx, pr, nil),
- Repository: convert.ToRepo(ctx, issue.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- }); err != nil {
- log.Error("PrepareWebhooks [pr: %d]: %v", pr.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyPullRequestReview(ctx context.Context, pr *issues_model.PullRequest, review *issues_model.Review, comment *issues_model.Comment, mentions []*user_model.User) {
- var reviewHookType webhook.HookEventType
-
- switch review.Type {
- case issues_model.ReviewTypeApprove:
- reviewHookType = webhook.HookEventPullRequestReviewApproved
- case issues_model.ReviewTypeComment:
- reviewHookType = webhook.HookEventPullRequestComment
- case issues_model.ReviewTypeReject:
- reviewHookType = webhook.HookEventPullRequestReviewRejected
- default:
- // unsupported review webhook type here
- log.Error("Unsupported review webhook type")
- return
- }
-
- if err := pr.LoadIssue(ctx); err != nil {
- log.Error("LoadIssue: %v", err)
- return
- }
-
- mode, err := access_model.AccessLevel(ctx, review.Issue.Poster, review.Issue.Repo)
- if err != nil {
- log.Error("models.AccessLevel: %v", err)
- return
- }
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: review.Issue.Repo}, reviewHookType, &api.PullRequestPayload{
- Action: api.HookIssueReviewed,
- Index: review.Issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, pr, nil),
- Repository: convert.ToRepo(ctx, review.Issue.Repo, mode),
- Sender: convert.ToUser(review.Reviewer, nil),
- Review: &api.ReviewPayload{
- Type: string(reviewHookType),
- Content: review.Content,
- },
- }); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
-
-func (m *webhookNotifier) NotifyCreateRef(ctx context.Context, pusher *user_model.User, repo *repo_model.Repository, refType, refFullName, refID string) {
- apiPusher := convert.ToUser(pusher, nil)
- apiRepo := convert.ToRepo(ctx, repo, perm.AccessModeNone)
- refName := git.RefEndName(refFullName)
-
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventCreate, &api.CreatePayload{
- Ref: refName,
- Sha: refID,
- RefType: refType,
- Repo: apiRepo,
- Sender: apiPusher,
- }); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
-
-func (m *webhookNotifier) NotifyPullRequestSynchronized(ctx context.Context, doer *user_model.User, pr *issues_model.PullRequest) {
- if err := pr.LoadIssue(ctx); err != nil {
- log.Error("LoadIssue: %v", err)
- return
- }
- if err := pr.Issue.LoadAttributes(ctx); err != nil {
- log.Error("LoadAttributes: %v", err)
- return
- }
-
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: pr.Issue.Repo}, webhook.HookEventPullRequestSync, &api.PullRequestPayload{
- Action: api.HookIssueSynchronized,
- Index: pr.Issue.Index,
- PullRequest: convert.ToAPIPullRequest(ctx, pr, nil),
- Repository: convert.ToRepo(ctx, pr.Issue.Repo, perm.AccessModeNone),
- Sender: convert.ToUser(doer, nil),
- }); err != nil {
- log.Error("PrepareWebhooks [pull_id: %v]: %v", pr.ID, err)
- }
-}
-
-func (m *webhookNotifier) NotifyDeleteRef(ctx context.Context, pusher *user_model.User, repo *repo_model.Repository, refType, refFullName string) {
- apiPusher := convert.ToUser(pusher, nil)
- apiRepo := convert.ToRepo(ctx, repo, perm.AccessModeNone)
- refName := git.RefEndName(refFullName)
-
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventDelete, &api.DeletePayload{
- Ref: refName,
- RefType: refType,
- PusherType: api.PusherTypeUser,
- Repo: apiRepo,
- Sender: apiPusher,
- }); err != nil {
- log.Error("PrepareWebhooks.(delete %s): %v", refType, err)
- }
-}
-
-func sendReleaseHook(ctx context.Context, doer *user_model.User, rel *repo_model.Release, action api.HookReleaseAction) {
- if err := rel.LoadAttributes(ctx); err != nil {
- log.Error("LoadAttributes: %v", err)
- return
- }
-
- mode, _ := access_model.AccessLevel(ctx, doer, rel.Repo)
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: rel.Repo}, webhook.HookEventRelease, &api.ReleasePayload{
- Action: action,
- Release: convert.ToRelease(rel),
- Repository: convert.ToRepo(ctx, rel.Repo, mode),
- Sender: convert.ToUser(doer, nil),
- }); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
-
-func (m *webhookNotifier) NotifyNewRelease(ctx context.Context, rel *repo_model.Release) {
- sendReleaseHook(ctx, rel.Publisher, rel, api.HookReleasePublished)
-}
-
-func (m *webhookNotifier) NotifyUpdateRelease(ctx context.Context, doer *user_model.User, rel *repo_model.Release) {
- sendReleaseHook(ctx, doer, rel, api.HookReleaseUpdated)
-}
-
-func (m *webhookNotifier) NotifyDeleteRelease(ctx context.Context, doer *user_model.User, rel *repo_model.Release) {
- sendReleaseHook(ctx, doer, rel, api.HookReleaseDeleted)
-}
-
-func (m *webhookNotifier) NotifySyncPushCommits(ctx context.Context, pusher *user_model.User, repo *repo_model.Repository, opts *repository.PushUpdateOptions, commits *repository.PushCommits) {
- apiPusher := convert.ToUser(pusher, nil)
- apiCommits, apiHeadCommit, err := commits.ToAPIPayloadCommits(ctx, repo.RepoPath(), repo.HTMLURL())
- if err != nil {
- log.Error("commits.ToAPIPayloadCommits failed: %v", err)
- return
- }
-
- if err := webhook_services.PrepareWebhooks(ctx, webhook_services.EventSource{Repository: repo}, webhook.HookEventPush, &api.PushPayload{
- Ref: opts.RefFullName,
- Before: opts.OldCommitID,
- After: opts.NewCommitID,
- CompareURL: setting.AppURL + commits.CompareURL,
- Commits: apiCommits,
- TotalCommits: commits.Len,
- HeadCommit: apiHeadCommit,
- Repo: convert.ToRepo(ctx, repo, perm.AccessModeOwner),
- Pusher: apiPusher,
- Sender: apiPusher,
- }); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
-
-func (m *webhookNotifier) NotifySyncCreateRef(ctx context.Context, pusher *user_model.User, repo *repo_model.Repository, refType, refFullName, refID string) {
- m.NotifyCreateRef(ctx, pusher, repo, refType, refFullName, refID)
-}
-
-func (m *webhookNotifier) NotifySyncDeleteRef(ctx context.Context, pusher *user_model.User, repo *repo_model.Repository, refType, refFullName string) {
- m.NotifyDeleteRef(ctx, pusher, repo, refType, refFullName)
-}
-
-func (m *webhookNotifier) NotifyPackageCreate(ctx context.Context, doer *user_model.User, pd *packages_model.PackageDescriptor) {
- notifyPackage(ctx, doer, pd, api.HookPackageCreated)
-}
-
-func (m *webhookNotifier) NotifyPackageDelete(ctx context.Context, doer *user_model.User, pd *packages_model.PackageDescriptor) {
- notifyPackage(ctx, doer, pd, api.HookPackageDeleted)
-}
-
-func notifyPackage(ctx context.Context, sender *user_model.User, pd *packages_model.PackageDescriptor, action api.HookPackageAction) {
- source := webhook_services.EventSource{
- Repository: pd.Repository,
- Owner: pd.Owner,
- }
-
- apiPackage, err := convert.ToPackage(ctx, pd, sender)
- if err != nil {
- log.Error("Error converting package: %v", err)
- return
- }
-
- if err := webhook_services.PrepareWebhooks(ctx, source, webhook.HookEventPackage, &api.PackagePayload{
- Action: action,
- Package: apiPackage,
- Sender: convert.ToUser(sender, nil),
- }); err != nil {
- log.Error("PrepareWebhooks: %v", err)
- }
-}
diff --git a/modules/webhook/structs.go b/modules/webhook/structs.go
new file mode 100644
index 0000000000..96012de352
--- /dev/null
+++ b/modules/webhook/structs.go
@@ -0,0 +1,38 @@
+// Copyright 2022 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package webhook
+
+// HookEvents is a set of web hook events
+type HookEvents struct {
+ Create bool `json:"create"`
+ Delete bool `json:"delete"`
+ Fork bool `json:"fork"`
+ Issues bool `json:"issues"`
+ IssueAssign bool `json:"issue_assign"`
+ IssueLabel bool `json:"issue_label"`
+ IssueMilestone bool `json:"issue_milestone"`
+ IssueComment bool `json:"issue_comment"`
+ Push bool `json:"push"`
+ PullRequest bool `json:"pull_request"`
+ PullRequestAssign bool `json:"pull_request_assign"`
+ PullRequestLabel bool `json:"pull_request_label"`
+ PullRequestMilestone bool `json:"pull_request_milestone"`
+ PullRequestComment bool `json:"pull_request_comment"`
+ PullRequestReview bool `json:"pull_request_review"`
+ PullRequestSync bool `json:"pull_request_sync"`
+ Wiki bool `json:"wiki"`
+ Repository bool `json:"repository"`
+ Release bool `json:"release"`
+ Package bool `json:"package"`
+}
+
+// HookEvent represents events that will delivery hook.
+type HookEvent struct {
+ PushOnly bool `json:"push_only"`
+ SendEverything bool `json:"send_everything"`
+ ChooseEvents bool `json:"choose_events"`
+ BranchFilter string `json:"branch_filter"`
+
+ HookEvents `json:"events"`
+}
diff --git a/modules/webhook/type.go b/modules/webhook/type.go
new file mode 100644
index 0000000000..db4ab17931
--- /dev/null
+++ b/modules/webhook/type.go
@@ -0,0 +1,95 @@
+// Copyright 2022 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package webhook
+
+// HookEventType is the type of a hook event
+type HookEventType string
+
+// Types of hook events
+const (
+ HookEventCreate HookEventType = "create"
+ HookEventDelete HookEventType = "delete"
+ HookEventFork HookEventType = "fork"
+ HookEventPush HookEventType = "push"
+ HookEventIssues HookEventType = "issues"
+ HookEventIssueAssign HookEventType = "issue_assign"
+ HookEventIssueLabel HookEventType = "issue_label"
+ HookEventIssueMilestone HookEventType = "issue_milestone"
+ HookEventIssueComment HookEventType = "issue_comment"
+ HookEventPullRequest HookEventType = "pull_request"
+ HookEventPullRequestAssign HookEventType = "pull_request_assign"
+ HookEventPullRequestLabel HookEventType = "pull_request_label"
+ HookEventPullRequestMilestone HookEventType = "pull_request_milestone"
+ HookEventPullRequestComment HookEventType = "pull_request_comment"
+ HookEventPullRequestReviewApproved HookEventType = "pull_request_review_approved"
+ HookEventPullRequestReviewRejected HookEventType = "pull_request_review_rejected"
+ HookEventPullRequestReviewComment HookEventType = "pull_request_review_comment"
+ HookEventPullRequestSync HookEventType = "pull_request_sync"
+ HookEventWiki HookEventType = "wiki"
+ HookEventRepository HookEventType = "repository"
+ HookEventRelease HookEventType = "release"
+ HookEventPackage HookEventType = "package"
+)
+
+// Event returns the HookEventType as an event string
+func (h HookEventType) Event() string {
+ switch h {
+ case HookEventCreate:
+ return "create"
+ case HookEventDelete:
+ return "delete"
+ case HookEventFork:
+ return "fork"
+ case HookEventPush:
+ return "push"
+ case HookEventIssues, HookEventIssueAssign, HookEventIssueLabel, HookEventIssueMilestone:
+ return "issues"
+ case HookEventPullRequest, HookEventPullRequestAssign, HookEventPullRequestLabel, HookEventPullRequestMilestone,
+ HookEventPullRequestSync:
+ return "pull_request"
+ case HookEventIssueComment, HookEventPullRequestComment:
+ return "issue_comment"
+ case HookEventPullRequestReviewApproved:
+ return "pull_request_approved"
+ case HookEventPullRequestReviewRejected:
+ return "pull_request_rejected"
+ case HookEventPullRequestReviewComment:
+ return "pull_request_comment"
+ case HookEventWiki:
+ return "wiki"
+ case HookEventRepository:
+ return "repository"
+ case HookEventRelease:
+ return "release"
+ }
+ return ""
+}
+
+// HookType is the type of a webhook
+type HookType = string
+
+// Types of webhooks
+const (
+ GITEA HookType = "gitea"
+ GOGS HookType = "gogs"
+ SLACK HookType = "slack"
+ DISCORD HookType = "discord"
+ DINGTALK HookType = "dingtalk"
+ TELEGRAM HookType = "telegram"
+ MSTEAMS HookType = "msteams"
+ FEISHU HookType = "feishu"
+ MATRIX HookType = "matrix"
+ WECHATWORK HookType = "wechatwork"
+ PACKAGIST HookType = "packagist"
+)
+
+// HookStatus is the status of a web hook
+type HookStatus int
+
+// Possible statuses of a web hook
+const (
+ HookStatusNone HookStatus = iota
+ HookStatusSucceed
+ HookStatusFail
+)