// Copyright 2014 The Gogs Authors. All rights reserved. // Use of this source code is governed by a MIT-style // license that can be found in the LICENSE file. package gogs import ( "bytes" "encoding/json" "errors" "fmt" "strings" "time" ) var ( ErrInvalidReceiveHook = errors.New("Invalid JSON payload received over webhook") ) type Hook struct { ID int64 `json:"id"` Type string `json:"type"` URL string `json:"-"` Config map[string]string `json:"config"` Events []string `json:"events"` Active bool `json:"active"` Updated time.Time `json:"updated_at"` Created time.Time `json:"created_at"` } func (c *Client) ListRepoHooks(user, repo string) ([]*Hook, error) { hooks := make([]*Hook, 0, 10) return hooks, c.getParsedResponse("GET", fmt.Sprintf("/repos/%s/%s/hooks", user, repo), nil, nil, &hooks) } type CreateHookOption struct { Type string `json:"type" binding:"Required"` Config map[string]string `json:"config" binding:"Required"` Events []string `json:"events"` Active bool `json:"active"` } func (c *Client) CreateRepoHook(user, repo string, opt CreateHookOption) (*Hook, error) { body, err := json.Marshal(&opt) if err != nil { return nil, err } h := new(Hook) return h, c.getParsedResponse("POST", fmt.Sprintf("/repos/%s/%s/hooks", user, repo), jsonHeader, bytes.NewReader(body), h) } type EditHookOption struct { Config map[string]string `json:"config"` Events []string `json:"events"` Active *bool `json:"active"` } func (c *Client) EditRepoHook(user, repo string, id int64, opt EditHookOption) error { body, err := json.Marshal(&opt) if err != nil { return err } _, err = c.getResponse("PATCH", fmt.Sprintf("/repos/%s/%s/hooks/%d", user, repo, id), jsonHeader, bytes.NewReader(body)) return err } func (c *Client) DeleteRepoHook(user, repo string, id int64) error { _, err := c.getResponse("DELETE", fmt.Sprintf("/repos/%s/%s/hooks/%d", user, repo, id), nil, nil) return err } type Payloader interface { JSONPayload() ([]byte, error) } type PayloadUser struct { Name string `json:"name"` Email string `json:"email"` UserName string `json:"username"` } // FIXME: consider use same format as API when commits API are added. type PayloadCommit struct { ID string `json:"id"` Message string `json:"message"` URL string `json:"url"` Author *PayloadUser `json:"author"` Committer *PayloadUser `json:"committer"` Added []string `json:"added"` Removed []string `json:"removed"` Modified []string `json:"modified"` Timestamp time.Time `json:"timestamp"` } var ( _ Payloader = &CreatePayload{} _ Payloader = &DeletePayload{} _ Payloader = &ForkPayload{} _ Payloader = &PushPayload{} _ Payloader = &IssuesPayload{} _ Payloader = &IssueCommentPayload{} _ Payloader = &PullRequestPayload{} ) // _________ __ // \_ ___ \_______ ____ _____ _/ |_ ____ // / \ \/\_ __ \_/ __ \\__ \\ __\/ __ \ // \ \____| | \/\ ___/ / __ \| | \ ___/ // \______ /|__| \___ >____ /__| \___ > // \/ \/ \/ \/ type CreatePayload struct { Ref string `json:"ref"` RefType string `json:"ref_type"` Sha string `json:"sha"` DefaultBranch string `json:"default_branch"` Repo *Repository `json:"repository"` Sender *User `json:"sender"` } func (p *CreatePayload) JSONPayload() ([]byte, error) { return json.MarshalIndent(p, "", " ") } // ParseCreateHook parses create event hook content. func ParseCreateHook(raw []byte) (*CreatePayload, error) { hook := new(CreatePayload) if err := json.Unmarshal(raw, hook); err != nil { return nil, err } // it is possible the JSON was parsed, however, // was not from Gogs (maybe was from Bitbucket) // So we'll check to be sure certain key fields // were populated switch { case hook.Repo == nil: return nil, ErrInvalidReceiveHook case len(hook.Ref) == 0: return nil, ErrInvalidReceiveHook } return hook, nil } // ________ .__ __ // \______ \ ____ | | _____/ |_ ____ // | | \_/ __ \| | _/ __ \ __\/ __ \ // | ` \ ___/| |_\ ___/| | \ ___/ // /_______ /\___ >____/\___ >__| \___ > // \/ \/ \/ \/ type PusherType string const ( PUSHER_TYPE_USER PusherType = "user" ) type DeletePayload struct { Ref string `json:"ref"` RefType string `json:"ref_type"` PusherType PusherType `json:"pusher_type"` Repo *Repository `json:"repository"` Sender *User `json:"sender"` } func (p *DeletePayload) JSONPayload() ([]byte, error) { return json.MarshalIndent(p, "", " ") } // ___________ __ // \_ _____/__________| | __ // | __)/ _ \_ __ \ |/ / // | \( <_> ) | \/ < // \___ / \____/|__| |__|_ \ // \/ \/ type ForkPayload struct { Forkee *Repository `json:"forkee"` Repo *Repository `json:"repository"` Sender *User `json:"sender"` } func (p *ForkPayload) JSONPayload() ([]byte, error) { return json.MarshalIndent(p, "", " ") } // __________ .__ // \______ \__ __ _____| |__ // | ___/ | \/ ___/ | \ // | | | | /\___ \| Y \ // |____| |____//____ >___| / // \/ \/ // PushPayload represents a payload information of push event. type PushPayload struct { Ref string `json:"ref"` Before string `json:"before"` After string `json:"after"` CompareURL string `json:"compare_url"` Commits []*PayloadCommit `json:"commits"` Repo *Repository `json:"repository"` Pusher *User `json:"pusher"` Sender *User `json:"sender"` } func (p *PushPayload) JSONPayload() ([]byte, error) { return json.MarshalIndent(p, "", " ") } // ParsePushHook parses push event hook content. func ParsePushHook(raw []byte) (*PushPayload, error) { hook := new(PushPayload) if err := json.Unmarshal(raw, hook); err != nil { return nil, err } switch { case hook.Repo == nil: return nil, ErrInvalidReceiveHook case len(hook.Ref) == 0: return nil, ErrInvalidReceiveHook } return hook, nil } // Branch returns branch name from a payload func (p *PushPayload) Branch() string { return strings.Replace(p.Ref, "refs/heads/", "", -1) } // .___ // | | ______ ________ __ ____ // | |/ ___// ___/ | \_/ __ \ // | |\___ \ \___ \| | /\ ___/ // |___/____ >____ >____/ \___ > // \/ \/ \/ type HookIssueAction string const ( HOOK_ISSUE_OPENED HookIssueAction = "opened" HOOK_ISSUE_CLOSED HookIssueAction = "closed" HOOK_ISSUE_REOPENED HookIssueAction = "reopened" HOOK_ISSUE_EDITED HookIssueAction = "edited" HOOK_ISSUE_ASSIGNED HookIssueAction = "assigned" HOOK_ISSUE_UNASSIGNED HookIssueAction = "unassigned" HOOK_ISSUE_LABEL_UPDATED HookIssueAction = "label_updated" HOOK_ISSUE_LABEL_CLEARED HookIssueAction = "label_cleared" HOOK_ISSUE_MILESTONED HookIssueAction = "milestoned" HOOK_ISSUE_DEMILESTONED HookIssueAction = "demilestoned" HOOK_ISSUE_SYNCHRONIZED HookIssueAction = "synchronized" ) type ChangesFromPayload struct { From string `json:"from"` } type ChangesPayload struct { Title *ChangesFromPayload `json:"title,omitempty"` Body *ChangesFromPayload `json:"body,omitempty"` } // IssuesPayload represents a payload information of issues event. type IssuesPayload struct { Action HookIssueAction `json:"action"` Index int64 `json:"number"` Issue *Issue `json:"issue"` Changes *ChangesPayload `json:"changes,omitempty"` Repository *Repository `json:"repository"` Sender *User `json:"sender"` } func (p *IssuesPayload) JSONPayload() ([]byte, error) { return json.MarshalIndent(p, "", " ") } type HookIssueCommentAction string const ( HOOK_ISSUE_COMMENT_CREATED HookIssueCommentAction = "created" HOOK_ISSUE_COMMENT_EDITED HookIssueCommentAction = "edited" HOOK_ISSUE_COMMENT_DELETED HookIssueCommentAction = "deleted" ) // IssueCommentPayload represents a payload information of issue comment event. type IssueCommentPayload struct { Action HookIssueCommentAction `json:"action"` Issue *Issue `json:"issue"` Comment *Comment `json:"comment"` Changes *ChangesPayload `json:"changes,omitempty"` Repository *Repository `json:"repository"` Sender *User `json:"sender"` } func (p *IssueCommentPayload) JSONPayload() ([]byte, error) { return json.MarshalIndent(p, "", " ") } // __________ .__ .__ __________ __ // \______ \__ __| | | | \______ \ ____ ________ __ ____ _______/ |_ // | ___/ | \ | | | | _// __ \/ ____/ | \_/ __ \ / ___/\ __\ // | | | | / |_| |__ | | \ ___< <_| | | /\ ___/ \___ \ | | // |____| |____/|____/____/ |____|_ /\___ >__ |____/ \___ >____ > |__| // \/ \/ |__| \/ \/ // PullRequestPayload represents a payload information of pull request event. type PullRequestPayload struct { Action HookIssueAction `json:"action"` Index int64 `json:"number"` PullRequest *PullRequest `json:"pull_request"` Changes *ChangesPayload `json:"changes,omitempty"` Repository *Repository `json:"repository"` Sender *User `json:"sender"` } func (p *PullRequestPayload) JSONPayload() ([]byte, error) { return json.MarshalIndent(p, "", " ") } // __________ .__ // \______ \ ____ | | ____ _____ ______ ____ // | _// __ \| | _/ __ \\__ \ / ___// __ \ // | | \ ___/| |_\ ___/ / __ \_\___ \\ ___/ // |____|_ /\___ >____/\___ >____ /____ >\___ > // \/ \/ \/ \/ \/ \/ type HookReleaseAction string const ( HOOK_RELEASE_PUBLISHED HookReleaseAction = "published" ) // ReleasePayload represents a payload information of release event. type ReleasePayload struct { Action HookReleaseAction `json:"action"` Release *Release `json:"release"` Repository *Repository `json:"repository"` Sender *User `json:"sender"` } func (p *ReleasePayload) JSONPayload() ([]byte, error) { return json.MarshalIndent(p, "", " ") }