// Copyright 2015 - Present, The Gogs Authors. All rights reserved. // Copyright 2018 - Present, Gitote. All rights reserved. // // This source code is licensed under the MIT license found in the // LICENSE file in the root directory of this source tree. package models import ( "fmt" "gitote/gitote/models/errors" "gitote/gitote/pkg/setting" "gitote/gitote/pkg/tool" "path" "regexp" "strings" "time" "unicode" raven "github.com/getsentry/raven-go" "github.com/go-xorm/xorm" "github.com/json-iterator/go" "gitlab.com/gitote/com" "gitlab.com/gitote/git-module" api "gitlab.com/gitote/go-gitote-client" log "gopkg.in/clog.v1" ) // ActionType represents the type of an action. type ActionType int // Possible action types. const ( ActionCreateRepo ActionType = iota + 1 // 1 ActionRenameRepo // 2 ActionStarRepo // 3 ActionWatchRepo // 4 ActionCommitRepo // 5 ActionCreateIssue // 6 ActionCreatePullRequest // 7 ActionTransferRepo // 8 ActionPushTag // 9 ActionCommentIssue // 10 ActionMergePullRequest // 11 ActionCloseIssue // 12 ActionReopenIssue // 13 ActionClosePullRequest // 14 ActionReopenPullRequest // 15 ActionCreateBranch // 16 ActionDeleteBranch // 17 ActionDeleteTag // 18 ActionForkRepo // 19 ActionMirrorSyncPush // 20 ActionMirrorSyncCreate // 21 ActionMirrorSyncDelete // 22 ) var ( // IssueCloseKeywords Same as Github. // See https://help.github.com/articles/closing-issues-via-commit-messages IssueCloseKeywords = []string{"close", "closes", "closed", "fix", "fixes", "fixed", "resolve", "resolves", "resolved"} // IssueReopenKeywords Same as Github. IssueReopenKeywords = []string{"reopen", "reopens", "reopened"} // IssueCloseKeywordsPat close keyword pattern IssueCloseKeywordsPat = regexp.MustCompile(assembleKeywordsPattern(IssueCloseKeywords)) // IssueReopenKeywordsPat reopen keyword pattern IssueReopenKeywordsPat = regexp.MustCompile(assembleKeywordsPattern(IssueReopenKeywords)) // IssueReferenceKeywordsPat reference keyword pattern IssueReferenceKeywordsPat = regexp.MustCompile(`(?i)(?:)(^| )\S+`) ) func assembleKeywordsPattern(words []string) string { return fmt.Sprintf(`(?i)(?:%s) \S+`, strings.Join(words, "|")) } // Action represents user operation type and other information to repository, // it implemented interface base.Actioner so that can be used in template render. type Action struct { ID int64 UserID int64 // Receiver user ID OpType ActionType ActUserID int64 // Doer user ID ActUserName string // Doer user name ActAvatar string `xorm:"-" json:"-"` RepoID int64 `xorm:"INDEX"` RepoUserName string RepoName string RefName string IsPrivate bool `xorm:"NOT NULL DEFAULT false"` Content string `xorm:"TEXT"` Created time.Time `xorm:"-" json:"-"` CreatedUnix int64 } // BeforeInsert will be invoked by XORM before inserting a record func (a *Action) BeforeInsert() { a.CreatedUnix = time.Now().Unix() } // AfterSet is invoked from XORM after setting the values of all fields of this object. func (a *Action) AfterSet(colName string, _ xorm.Cell) { switch colName { case "created_unix": a.Created = time.Unix(a.CreatedUnix, 0).Local() } } // GetOpType gets the ActionType of this action. func (a *Action) GetOpType() int { return int(a.OpType) } // GetActUserName gets the action's user name. func (a *Action) GetActUserName() string { return a.ActUserName } // ShortActUserName gets the action's user name trimmed to max 20 // chars. func (a *Action) ShortActUserName() string { return tool.EllipsisString(a.ActUserName, 20) } // GetRepoUserName returns the name of the action repository owner. func (a *Action) GetRepoUserName() string { return a.RepoUserName } // ShortRepoUserName returns the name of the action repository owner // trimmed to max 20 chars. func (a *Action) ShortRepoUserName() string { return tool.EllipsisString(a.RepoUserName, 20) } // GetRepoName returns the name of the action repository. func (a *Action) GetRepoName() string { return a.RepoName } // ShortRepoName returns the name of the action repository // trimmed to max 33 chars. func (a *Action) ShortRepoName() string { return tool.EllipsisString(a.RepoName, 33) } // GetRepoPath returns the virtual path to the action repository. func (a *Action) GetRepoPath() string { return path.Join(a.RepoUserName, a.RepoName) } // ShortRepoPath returns the virtual path to the action repository // trimmed to max 20 + 1 + 33 chars. func (a *Action) ShortRepoPath() string { return path.Join(a.ShortRepoUserName(), a.ShortRepoName()) } // GetRepoLink returns relative link to action repository. func (a *Action) GetRepoLink() string { if len(setting.AppSubURL) > 0 { return path.Join(setting.AppSubURL, a.GetRepoPath()) } return "/" + a.GetRepoPath() } // GetBranch returns the action's repository branch. func (a *Action) GetBranch() string { return a.RefName } // GetContent returns the action's content. func (a *Action) GetContent() string { return a.Content } // GetCreate returns the action creation time. func (a *Action) GetCreate() time.Time { return a.Created } // GetIssueInfos returns a list of issues associated with // the action. func (a *Action) GetIssueInfos() []string { return strings.SplitN(a.Content, "|", 2) } // GetIssueTitle returns the title of first issue associated // with the action. func (a *Action) GetIssueTitle() string { index := com.StrTo(a.GetIssueInfos()[0]).MustInt64() issue, err := GetIssueByIndex(a.RepoID, index) if err != nil { raven.CaptureErrorAndWait(err, nil) log.Error(4, "GetIssueByIndex: %v", err) return "500 when get issue" } return issue.Title } // GetIssueContent returns the content of first issue associated with // this action. func (a *Action) GetIssueContent() string { index := com.StrTo(a.GetIssueInfos()[0]).MustInt64() issue, err := GetIssueByIndex(a.RepoID, index) if err != nil { raven.CaptureErrorAndWait(err, nil) log.Error(4, "GetIssueByIndex: %v", err) return "500 when get issue" } return issue.Content } func newRepoAction(e Engine, doer, owner *User, repo *Repository) (err error) { opType := ActionCreateRepo if repo.IsFork { opType = ActionForkRepo } return notifyWatchers(e, &Action{ ActUserID: doer.ID, ActUserName: doer.Name, OpType: opType, RepoID: repo.ID, RepoUserName: repo.Owner.Name, RepoName: repo.Name, IsPrivate: repo.IsPrivate, }) } // NewRepoAction adds new action for creating repository. func NewRepoAction(doer, owner *User, repo *Repository) (err error) { return newRepoAction(x, doer, owner, repo) } func renameRepoAction(e Engine, actUser *User, oldRepoName string, repo *Repository) (err error) { if err = notifyWatchers(e, &Action{ ActUserID: actUser.ID, ActUserName: actUser.Name, OpType: ActionRenameRepo, RepoID: repo.ID, RepoUserName: repo.Owner.Name, RepoName: repo.Name, IsPrivate: repo.IsPrivate, Content: oldRepoName, }); err != nil { return fmt.Errorf("notify watchers: %v", err) } log.Trace("action.renameRepoAction: %s/%s", actUser.Name, repo.Name) return nil } // RenameRepoAction adds new action for renaming a repository. func RenameRepoAction(actUser *User, oldRepoName string, repo *Repository) error { return renameRepoAction(x, actUser, oldRepoName, repo) } func issueIndexTrimRight(c rune) bool { return !unicode.IsDigit(c) } // PushCommit represents a commit in a push operation. type PushCommit struct { Sha1 string Message string AuthorEmail string AuthorName string CommitterEmail string CommitterName string Timestamp time.Time } // PushCommits represents list of commits in a push operation. type PushCommits struct { Len int Commits []*PushCommit CompareURL string avatars map[string]string } // NewPushCommits returns new push commits func NewPushCommits() *PushCommits { return &PushCommits{ avatars: make(map[string]string), } } // ToAPIPayloadCommits converts a PushCommits object to // api.PayloadCommit format. func (pc *PushCommits) ToAPIPayloadCommits(repoPath, repoURL string) ([]*api.PayloadCommit, error) { commits := make([]*api.PayloadCommit, len(pc.Commits)) for i, commit := range pc.Commits { authorUsername := "" author, err := GetUserByEmail(commit.AuthorEmail) if err == nil { authorUsername = author.Name } else if !errors.IsUserNotExist(err) { return nil, fmt.Errorf("GetUserByEmail: %v", err) } committerUsername := "" committer, err := GetUserByEmail(commit.CommitterEmail) if err == nil { committerUsername = committer.Name } else if !errors.IsUserNotExist(err) { return nil, fmt.Errorf("GetUserByEmail: %v", err) } fileStatus, err := git.GetCommitFileStatus(repoPath, commit.Sha1) if err != nil { return nil, fmt.Errorf("FileStatus [commit_sha1: %s]: %v", commit.Sha1, err) } commits[i] = &api.PayloadCommit{ ID: commit.Sha1, Message: commit.Message, URL: fmt.Sprintf("%s/commit/%s", repoURL, commit.Sha1), Author: &api.PayloadUser{ Name: commit.AuthorName, Email: commit.AuthorEmail, UserName: authorUsername, }, Committer: &api.PayloadUser{ Name: commit.CommitterName, Email: commit.CommitterEmail, UserName: committerUsername, }, Added: fileStatus.Added, Removed: fileStatus.Removed, Modified: fileStatus.Modified, Timestamp: commit.Timestamp, } } return commits, nil } // AvatarLink tries to match user in database with e-mail // in order to show custom avatar, and falls back to general avatar link. func (pc *PushCommits) AvatarLink(email string) string { _, ok := pc.avatars[email] if !ok { u, err := GetUserByEmail(email) if err != nil { pc.avatars[email] = tool.AvatarLink(email) if !errors.IsUserNotExist(err) { raven.CaptureErrorAndWait(err, nil) log.Error(4, "GetUserByEmail: %v", err) } } else { pc.avatars[email] = u.RelAvatarLink() } } return pc.avatars[email] } // UpdateIssuesCommit checks if issues are manipulated by commit message. func UpdateIssuesCommit(doer *User, repo *Repository, commits []*PushCommit) error { // Commits are appended in the reverse order. for i := len(commits) - 1; i >= 0; i-- { c := commits[i] refMarked := make(map[int64]bool) for _, ref := range IssueReferenceKeywordsPat.FindAllString(c.Message, -1) { ref = ref[strings.IndexByte(ref, byte(' '))+1:] ref = strings.TrimRightFunc(ref, issueIndexTrimRight) if len(ref) == 0 { continue } // Add repo name if missing if ref[0] == '#' { ref = fmt.Sprintf("%s%s", repo.FullName(), ref) } else if !strings.Contains(ref, "/") { // FIXME: We don't support User#ID syntax yet // return ErrNotImplemented continue } issue, err := GetIssueByRef(ref) if err != nil { if errors.IsIssueNotExist(err) { continue } return err } if refMarked[issue.ID] { continue } refMarked[issue.ID] = true msgLines := strings.Split(c.Message, "\n") shortMsg := msgLines[0] if len(msgLines) > 2 { shortMsg += "..." } message := fmt.Sprintf(`%s`, repo.Link(), c.Sha1, shortMsg) if err = CreateRefComment(doer, repo, issue, message, c.Sha1); err != nil { return err } } refMarked = make(map[int64]bool) // FIXME: can merge this one and next one to a common function. for _, ref := range IssueCloseKeywordsPat.FindAllString(c.Message, -1) { ref = ref[strings.IndexByte(ref, byte(' '))+1:] ref = strings.TrimRightFunc(ref, issueIndexTrimRight) if len(ref) == 0 { continue } // Add repo name if missing if ref[0] == '#' { ref = fmt.Sprintf("%s%s", repo.FullName(), ref) } else if !strings.Contains(ref, "/") { // FIXME: We don't support User#ID syntax yet continue } issue, err := GetIssueByRef(ref) if err != nil { if errors.IsIssueNotExist(err) { continue } return err } if refMarked[issue.ID] { continue } refMarked[issue.ID] = true if issue.RepoID != repo.ID || issue.IsClosed { continue } if err = issue.ChangeStatus(doer, repo, true); err != nil { return err } } // It is conflict to have close and reopen at same time, so refsMarkd doesn't need to reinit here. for _, ref := range IssueReopenKeywordsPat.FindAllString(c.Message, -1) { ref = ref[strings.IndexByte(ref, byte(' '))+1:] ref = strings.TrimRightFunc(ref, issueIndexTrimRight) if len(ref) == 0 { continue } // Add repo name if missing if ref[0] == '#' { ref = fmt.Sprintf("%s%s", repo.FullName(), ref) } else if !strings.Contains(ref, "/") { // We don't support User#ID syntax yet // return ErrNotImplemented continue } issue, err := GetIssueByRef(ref) if err != nil { if errors.IsIssueNotExist(err) { continue } return err } if refMarked[issue.ID] { continue } refMarked[issue.ID] = true if issue.RepoID != repo.ID || !issue.IsClosed { continue } if err = issue.ChangeStatus(doer, repo, false); err != nil { return err } } } return nil } // CommitRepoActionOptions represent options of a new commit action. type CommitRepoActionOptions struct { PusherName string RepoOwnerID int64 RepoName string RefFullName string OldCommitID string NewCommitID string Commits *PushCommits } // CommitRepoAction adds new commit actio to the repository, and prepare corresponding webhooks. func CommitRepoAction(opts CommitRepoActionOptions) error { pusher, err := GetUserByName(opts.PusherName) if err != nil { return fmt.Errorf("GetUserByName [%s]: %v", opts.PusherName, err) } repo, err := GetRepositoryByName(opts.RepoOwnerID, opts.RepoName) if err != nil { return fmt.Errorf("GetRepositoryByName [owner_id: %d, name: %s]: %v", opts.RepoOwnerID, opts.RepoName, err) } // Change repository bare status and update last updated time. repo.IsBare = false if err = UpdateRepository(repo, false); err != nil { return fmt.Errorf("UpdateRepository: %v", err) } isNewRef := opts.OldCommitID == git.EMPTY_SHA isDelRef := opts.NewCommitID == git.EMPTY_SHA opType := ActionCommitRepo // Check if it's tag push or branch. if strings.HasPrefix(opts.RefFullName, git.TAG_PREFIX) { opType = ActionPushTag } else { // if not the first commit, set the compare URL. if !isNewRef && !isDelRef { opts.Commits.CompareURL = repo.ComposeCompareURL(opts.OldCommitID, opts.NewCommitID) } // Only update issues via commits when internal issue tracker is enabled if repo.EnableIssues && !repo.EnableExternalTracker { if err = UpdateIssuesCommit(pusher, repo, opts.Commits.Commits); err != nil { raven.CaptureErrorAndWait(err, nil) log.Error(2, "UpdateIssuesCommit: %v", err) } } } if len(opts.Commits.Commits) > setting.UI.FeedMaxCommitNum { opts.Commits.Commits = opts.Commits.Commits[:setting.UI.FeedMaxCommitNum] } data, err := jsoniter.Marshal(opts.Commits) if err != nil { return fmt.Errorf("Marshal: %v", err) } refName := git.RefEndName(opts.RefFullName) action := &Action{ ActUserID: pusher.ID, ActUserName: pusher.Name, Content: string(data), RepoID: repo.ID, RepoUserName: repo.MustOwner().Name, RepoName: repo.Name, RefName: refName, IsPrivate: repo.IsPrivate, } apiRepo := repo.APIFormat(nil) apiPusher := pusher.APIFormat() switch opType { case ActionCommitRepo: // Push if isDelRef { if err = PrepareWebhooks(repo, HookEventDelete, &api.DeletePayload{ Ref: refName, RefType: "branch", PusherType: api.PUSHER_TYPE_USER, Repo: apiRepo, Sender: apiPusher, }); err != nil { return fmt.Errorf("PrepareWebhooks.(delete branch): %v", err) } action.OpType = ActionDeleteBranch if err = NotifyWatchers(action); err != nil { return fmt.Errorf("NotifyWatchers.(delete branch): %v", err) } // Delete branch doesn't have anything to push or compare return nil } compareURL := setting.AppURL + opts.Commits.CompareURL if isNewRef { compareURL = "" if err = PrepareWebhooks(repo, HookEventCreate, &api.CreatePayload{ Ref: refName, RefType: "branch", DefaultBranch: repo.DefaultBranch, Repo: apiRepo, Sender: apiPusher, }); err != nil { return fmt.Errorf("PrepareWebhooks.(new branch): %v", err) } action.OpType = ActionCreateBranch if err = NotifyWatchers(action); err != nil { return fmt.Errorf("NotifyWatchers.(new branch): %v", err) } } commits, err := opts.Commits.ToAPIPayloadCommits(repo.RepoPath(), repo.HTMLURL()) if err != nil { return fmt.Errorf("ToAPIPayloadCommits: %v", err) } if err = PrepareWebhooks(repo, HookEventPush, &api.PushPayload{ Ref: opts.RefFullName, Before: opts.OldCommitID, After: opts.NewCommitID, CompareURL: compareURL, Commits: commits, Repo: apiRepo, Pusher: apiPusher, Sender: apiPusher, }); err != nil { return fmt.Errorf("PrepareWebhooks.(new commit): %v", err) } action.OpType = ActionCommitRepo if err = NotifyWatchers(action); err != nil { return fmt.Errorf("NotifyWatchers.(new commit): %v", err) } case ActionPushTag: // Tag if isDelRef { if err = PrepareWebhooks(repo, HookEventDelete, &api.DeletePayload{ Ref: refName, RefType: "tag", PusherType: api.PUSHER_TYPE_USER, Repo: apiRepo, Sender: apiPusher, }); err != nil { return fmt.Errorf("PrepareWebhooks.(delete tag): %v", err) } action.OpType = ActionDeleteTag if err = NotifyWatchers(action); err != nil { return fmt.Errorf("NotifyWatchers.(delete tag): %v", err) } return nil } if err = PrepareWebhooks(repo, HookEventCreate, &api.CreatePayload{ Ref: refName, RefType: "tag", DefaultBranch: repo.DefaultBranch, Repo: apiRepo, Sender: apiPusher, }); err != nil { return fmt.Errorf("PrepareWebhooks.(new tag): %v", err) } action.OpType = ActionPushTag if err = NotifyWatchers(action); err != nil { return fmt.Errorf("NotifyWatchers.(new tag): %v", err) } } return nil } func transferRepoAction(e Engine, doer, oldOwner *User, repo *Repository) (err error) { if err = notifyWatchers(e, &Action{ ActUserID: doer.ID, ActUserName: doer.Name, OpType: ActionTransferRepo, RepoID: repo.ID, RepoUserName: repo.Owner.Name, RepoName: repo.Name, IsPrivate: repo.IsPrivate, Content: path.Join(oldOwner.Name, repo.Name), }); err != nil { return fmt.Errorf("notifyWatchers: %v", err) } // Remove watch for organization. if oldOwner.IsOrganization() { if err = watchRepo(e, oldOwner.ID, repo.ID, false); err != nil { return fmt.Errorf("watchRepo [false]: %v", err) } } return nil } // TransferRepoAction adds new action for transferring repository, // the Owner field of repository is assumed to be new owner. func TransferRepoAction(doer, oldOwner *User, repo *Repository) error { return transferRepoAction(x, doer, oldOwner, repo) } func mergePullRequestAction(e Engine, doer *User, repo *Repository, issue *Issue) error { return notifyWatchers(e, &Action{ ActUserID: doer.ID, ActUserName: doer.Name, OpType: ActionMergePullRequest, Content: fmt.Sprintf("%d|%s", issue.Index, issue.Title), RepoID: repo.ID, RepoUserName: repo.Owner.Name, RepoName: repo.Name, IsPrivate: repo.IsPrivate, }) } // MergePullRequestAction adds new action for merging pull request. func MergePullRequestAction(actUser *User, repo *Repository, pull *Issue) error { return mergePullRequestAction(x, actUser, repo, pull) } func mirrorSyncAction(opType ActionType, repo *Repository, refName string, data []byte) error { return NotifyWatchers(&Action{ ActUserID: repo.OwnerID, ActUserName: repo.MustOwner().Name, OpType: opType, Content: string(data), RepoID: repo.ID, RepoUserName: repo.MustOwner().Name, RepoName: repo.Name, RefName: refName, IsPrivate: repo.IsPrivate, }) } // MirrorSyncPushActionOptions mirror synchronization action options. type MirrorSyncPushActionOptions struct { RefName string OldCommitID string NewCommitID string Commits *PushCommits } // MirrorSyncPushAction adds new action for mirror synchronization of pushed commits. func MirrorSyncPushAction(repo *Repository, opts MirrorSyncPushActionOptions) error { if len(opts.Commits.Commits) > setting.UI.FeedMaxCommitNum { opts.Commits.Commits = opts.Commits.Commits[:setting.UI.FeedMaxCommitNum] } apiCommits, err := opts.Commits.ToAPIPayloadCommits(repo.RepoPath(), repo.HTMLURL()) if err != nil { return fmt.Errorf("ToAPIPayloadCommits: %v", err) } opts.Commits.CompareURL = repo.ComposeCompareURL(opts.OldCommitID, opts.NewCommitID) apiPusher := repo.MustOwner().APIFormat() if err := PrepareWebhooks(repo, HookEventPush, &api.PushPayload{ Ref: opts.RefName, Before: opts.OldCommitID, After: opts.NewCommitID, CompareURL: setting.AppURL + opts.Commits.CompareURL, Commits: apiCommits, Repo: repo.APIFormat(nil), Pusher: apiPusher, Sender: apiPusher, }); err != nil { return fmt.Errorf("PrepareWebhooks: %v", err) } data, err := jsoniter.Marshal(opts.Commits) if err != nil { return err } return mirrorSyncAction(ActionMirrorSyncPush, repo, opts.RefName, data) } // MirrorSyncCreateAction adds new action for mirror synchronization of new reference. func MirrorSyncCreateAction(repo *Repository, refName string) error { return mirrorSyncAction(ActionMirrorSyncCreate, repo, refName, nil) } // MirrorSyncDeleteAction deletes action for mirror synchronization of delete reference. func MirrorSyncDeleteAction(repo *Repository, refName string) error { return mirrorSyncAction(ActionMirrorSyncDelete, repo, refName, nil) } // GetFeeds returns action list of given user in given context. // actorID is the user who's requesting, ctxUserID is the user/org that is requested. // actorID can be -1 when isProfile is true or to skip the permission check. func GetFeeds(ctxUser *User, actorID, afterID int64, isProfile bool) ([]*Action, error) { actions := make([]*Action, 0, setting.UI.User.NewsFeedPagingNum) sess := x.Limit(setting.UI.User.NewsFeedPagingNum).Where("user_id = ?", ctxUser.ID).Desc("id") if afterID > 0 { sess.And("id < ?", afterID) } if isProfile { sess.And("is_private = ?", false).And("act_user_id = ?", ctxUser.ID) } else if actorID != -1 && ctxUser.IsOrganization() { // FIXME: only need to get IDs here, not all fields of repository. repos, _, err := ctxUser.GetUserRepositories(actorID, 1, ctxUser.NumRepos) if err != nil { return nil, fmt.Errorf("GetUserRepositories: %v", err) } var repoIDs []int64 for _, repo := range repos { repoIDs = append(repoIDs, repo.ID) } if len(repoIDs) > 0 { sess.In("repo_id", repoIDs) } } err := sess.Find(&actions) return actions, err }