-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Notification - Step 1 #523
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,245 @@ | ||
package models | ||
|
||
import ( | ||
"time" | ||
) | ||
|
||
type ( | ||
// NotificationStatus is the status of the notification (read or unread) | ||
NotificationStatus uint8 | ||
// NotificationSource is the source of the notification (issue, PR, commit, etc) | ||
NotificationSource uint8 | ||
) | ||
|
||
const ( | ||
// NotificationStatusUnread represents an unread notification | ||
NotificationStatusUnread NotificationStatus = iota + 1 | ||
// NotificationStatusRead represents a read notification | ||
NotificationStatusRead | ||
) | ||
|
||
const ( | ||
// NotificationSourceIssue is a notification of an issue | ||
NotificationSourceIssue NotificationSource = iota + 1 | ||
// NotificationSourcePullRequest is a notification of a pull request | ||
NotificationSourcePullRequest | ||
// NotificationSourceCommit is a notification of a commit | ||
NotificationSourceCommit | ||
) | ||
|
||
// Notification represents a notification | ||
type Notification struct { | ||
ID int64 `xorm:"pk autoincr"` | ||
UserID int64 `xorm:"INDEX NOT NULL"` | ||
RepoID int64 `xorm:"INDEX NOT NULL"` | ||
|
||
Status NotificationStatus `xorm:"SMALLINT INDEX NOT NULL"` | ||
Source NotificationSource `xorm:"SMALLINT INDEX NOT NULL"` | ||
|
||
IssueID int64 `xorm:"INDEX NOT NULL"` | ||
CommitID string `xorm:"INDEX"` | ||
|
||
UpdatedBy int64 `xorm:"INDEX NOT NULL"` | ||
|
||
Issue *Issue `xorm:"-"` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
PullRequest *PullRequest `xorm:"-"` | ||
|
||
Created time.Time `xorm:"-"` | ||
CreatedUnix int64 `xorm:"INDEX NOT NULL"` | ||
Updated time.Time `xorm:"-"` | ||
UpdatedUnix int64 `xorm:"INDEX NOT NULL"` | ||
} | ||
|
||
// BeforeInsert runs while inserting a record | ||
func (n *Notification) BeforeInsert() { | ||
var ( | ||
now = time.Now() | ||
nowUnix = now.Unix() | ||
) | ||
n.Created = now | ||
n.CreatedUnix = nowUnix | ||
n.Updated = now | ||
n.UpdatedUnix = nowUnix | ||
} | ||
|
||
// BeforeUpdate runs while updateing a record | ||
func (n *Notification) BeforeUpdate() { | ||
var ( | ||
now = time.Now() | ||
nowUnix = now.Unix() | ||
) | ||
n.Updated = now | ||
n.UpdatedUnix = nowUnix | ||
} | ||
|
||
// CreateOrUpdateIssueNotifications creates an issue notification | ||
// for each watcher, or updates it if already exists | ||
func CreateOrUpdateIssueNotifications(issue *Issue, notificationAuthorID int64) error { | ||
sess := x.NewSession() | ||
defer sess.Close() | ||
if err := sess.Begin(); err != nil { | ||
return err | ||
} | ||
|
||
if err := createOrUpdateIssueNotifications(sess, issue, notificationAuthorID); err != nil { | ||
return err | ||
} | ||
|
||
return sess.Commit() | ||
} | ||
|
||
func createOrUpdateIssueNotifications(e Engine, issue *Issue, notificationAuthorID int64) error { | ||
watches, err := getWatchers(e, issue.RepoID) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
notifications, err := getNotificationsByIssueID(e, issue.ID) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
for _, watch := range watches { | ||
// do not send notification for the own issuer/commenter | ||
if watch.UserID == notificationAuthorID { | ||
continue | ||
} | ||
|
||
if notificationExists(notifications, issue.ID, watch.UserID) { | ||
err = updateIssueNotification(e, watch.UserID, issue.ID, notificationAuthorID) | ||
} else { | ||
err = createIssueNotification(e, watch.UserID, issue, notificationAuthorID) | ||
} | ||
|
||
if err != nil { | ||
return err | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func getNotificationsByIssueID(e Engine, issueID int64) (notifications []*Notification, err error) { | ||
err = e. | ||
Where("issue_id = ?", issueID). | ||
Find(¬ifications) | ||
return | ||
} | ||
|
||
func notificationExists(notifications []*Notification, issueID, userID int64) bool { | ||
for _, notification := range notifications { | ||
if notification.IssueID == issueID && notification.UserID == userID { | ||
return true | ||
} | ||
} | ||
|
||
return false | ||
} | ||
|
||
func createIssueNotification(e Engine, userID int64, issue *Issue, updatedByID int64) error { | ||
notification := &Notification{ | ||
UserID: userID, | ||
RepoID: issue.RepoID, | ||
Status: NotificationStatusUnread, | ||
IssueID: issue.ID, | ||
UpdatedBy: updatedByID, | ||
} | ||
|
||
if issue.IsPull { | ||
notification.Source = NotificationSourcePullRequest | ||
} else { | ||
notification.Source = NotificationSourceIssue | ||
} | ||
|
||
_, err := e.Insert(notification) | ||
return err | ||
} | ||
|
||
func updateIssueNotification(e Engine, userID, issueID, updatedByID int64) error { | ||
notification, err := getIssueNotification(e, userID, issueID) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
notification.Status = NotificationStatusUnread | ||
notification.UpdatedBy = updatedByID | ||
|
||
_, err = e.Id(notification.ID).Update(notification) | ||
return err | ||
} | ||
|
||
func getIssueNotification(e Engine, userID, issueID int64) (*Notification, error) { | ||
notification := new(Notification) | ||
_, err := e. | ||
Where("user_id = ?", userID). | ||
And("issue_id = ?", issueID). | ||
Get(notification) | ||
return notification, err | ||
} | ||
|
||
// NotificationsForUser returns notifications for a given user and status | ||
func NotificationsForUser(user *User, status NotificationStatus) ([]*Notification, error) { | ||
return notificationsForUser(x, user, status) | ||
} | ||
func notificationsForUser(e Engine, user *User, status NotificationStatus) (notifications []*Notification, err error) { | ||
err = e. | ||
Where("user_id = ?", user.ID). | ||
And("status = ?", status). | ||
OrderBy("updated_unix DESC"). | ||
Find(¬ifications) | ||
return | ||
} | ||
|
||
// GetRepo returns the repo of the notification | ||
func (n *Notification) GetRepo() (repo *Repository, err error) { | ||
repo = new(Repository) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Store repo to struct field for cache. |
||
_, err = x. | ||
Where("id = ?", n.RepoID). | ||
Get(repo) | ||
return | ||
} | ||
|
||
// GetIssue returns the issue of the notification | ||
func (n *Notification) GetIssue() (issue *Issue, err error) { | ||
issue = new(Issue) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Store issue to struct field for cache. |
||
_, err = x. | ||
Where("id = ?", n.IssueID). | ||
Get(issue) | ||
return | ||
} | ||
|
||
// GetNotificationReadCount returns the notification read count for user | ||
func GetNotificationReadCount(user *User) (int64, error) { | ||
return GetNotificationCount(user, NotificationStatusRead) | ||
} | ||
|
||
// GetNotificationUnreadCount returns the notification unread count for user | ||
func GetNotificationUnreadCount(user *User) (int64, error) { | ||
return GetNotificationCount(user, NotificationStatusUnread) | ||
} | ||
|
||
// GetNotificationCount returns the notification count for user | ||
func GetNotificationCount(user *User, status NotificationStatus) (int64, error) { | ||
return getNotificationCount(x, user, status) | ||
} | ||
|
||
func getNotificationCount(e Engine, user *User, status NotificationStatus) (count int64, err error) { | ||
count, err = e. | ||
Where("user_id = ?", user.ID). | ||
And("status = ?", status). | ||
Count(&Notification{}) | ||
return | ||
} | ||
|
||
func setNotificationStatusRead(e Engine, userID, issueID int64) error { | ||
notification, err := getIssueNotification(e, userID, issueID) | ||
// ignore if not exists | ||
if err != nil { | ||
return nil | ||
} | ||
|
||
notification.Status = NotificationStatusRead | ||
|
||
_, err = e.Id(notification.ID).Update(notification) | ||
return err | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
package notification | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. copyright header |
||
|
||
import ( | ||
"code.gitea.io/gitea/models" | ||
"code.gitea.io/gitea/modules/log" | ||
) | ||
|
||
type ( | ||
notificationService struct { | ||
issueQueue chan issueNotificationOpts | ||
} | ||
|
||
issueNotificationOpts struct { | ||
issue *models.Issue | ||
notificationAuthorID int64 | ||
} | ||
) | ||
|
||
var ( | ||
// Service is the notification service | ||
Service = ¬ificationService{ | ||
issueQueue: make(chan issueNotificationOpts, 100), | ||
} | ||
) | ||
|
||
func init() { | ||
go Service.Run() | ||
} | ||
|
||
func (ns *notificationService) Run() { | ||
for { | ||
select { | ||
case opts := <-ns.issueQueue: | ||
if err := models.CreateOrUpdateIssueNotifications(opts.issue, opts.notificationAuthorID); err != nil { | ||
log.Error(4, "Was unable to create issue notification: %v", err) | ||
} | ||
} | ||
} | ||
} | ||
|
||
func (ns *notificationService) NotifyIssue(issue *models.Issue, notificationAuthorID int64) { | ||
ns.issueQueue <- issueNotificationOpts{ | ||
issue, | ||
notificationAuthorID, | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
copyright header