From bc0d2c8ada14eae81542f30a81552ed5cef8bd5d Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Sun, 13 Mar 2022 17:40:47 +0100 Subject: [PATCH] RSS/Atom support for Repos (#19055) * support for repos * refactor * advertise the feeds via meta tags * allow feed suffix and feed header * optimize performance --- models/action.go | 7 +++-- models/action_list.go | 63 ++++++++++++++++++++----------------- models/action_test.go | 50 ++++++++++++++++++++++++++--- models/fixtures/action.yml | 14 ++++----- models/user_heatmap_test.go | 3 +- modules/auth/pam/pam.go | 6 ++-- modules/context/repo.go | 2 ++ routers/web/feed/convert.go | 18 ++++++++++- routers/web/feed/profile.go | 45 ++------------------------ routers/web/feed/repo.go | 44 ++++++++++++++++++++++++++ routers/web/repo/view.go | 9 ++++++ routers/web/user/home.go | 7 ++--- routers/web/user/profile.go | 26 ++++++--------- templates/base/head.tmpl | 4 +++ 14 files changed, 188 insertions(+), 110 deletions(-) create mode 100644 routers/web/feed/repo.go diff --git a/models/action.go b/models/action.go index f2723a201..e9f5138b4 100644 --- a/models/action.go +++ b/models/action.go @@ -328,7 +328,7 @@ type GetFeedsOptions struct { } // GetFeeds returns actions according to the provided options -func GetFeeds(opts GetFeedsOptions) ([]*Action, error) { +func GetFeeds(ctx context.Context, opts GetFeedsOptions) (ActionList, error) { if opts.RequestedUser == nil && opts.RequestedTeam == nil && opts.RequestedRepo == nil { return nil, fmt.Errorf("need at least one of these filters: RequestedUser, RequestedTeam, RequestedRepo") } @@ -338,7 +338,8 @@ func GetFeeds(opts GetFeedsOptions) ([]*Action, error) { return nil, err } - sess := db.GetEngine(db.DefaultContext).Where(cond) + e := db.GetEngine(ctx) + sess := e.Where(cond) opts.SetDefaultValues() sess = db.SetSessionPagination(sess, &opts) @@ -349,7 +350,7 @@ func GetFeeds(opts GetFeedsOptions) ([]*Action, error) { return nil, fmt.Errorf("Find: %v", err) } - if err := ActionList(actions).LoadAttributes(); err != nil { + if err := ActionList(actions).loadAttributes(e); err != nil { return nil, fmt.Errorf("LoadAttributes: %v", err) } diff --git a/models/action_list.go b/models/action_list.go index 3f52d3cd5..ce621753a 100644 --- a/models/action_list.go +++ b/models/action_list.go @@ -25,7 +25,7 @@ func (actions ActionList) getUserIDs() []int64 { return keysInt64(userIDs) } -func (actions ActionList) loadUsers(e db.Engine) ([]*user_model.User, error) { +func (actions ActionList) loadUsers(e db.Engine) (map[int64]*user_model.User, error) { if len(actions) == 0 { return nil, nil } @@ -42,12 +42,7 @@ func (actions ActionList) loadUsers(e db.Engine) ([]*user_model.User, error) { for _, action := range actions { action.ActUser = userMaps[action.ActUserID] } - return valuesUser(userMaps), nil -} - -// LoadUsers loads actions' all users -func (actions ActionList) LoadUsers() ([]*user_model.User, error) { - return actions.loadUsers(db.GetEngine(db.DefaultContext)) + return userMaps, nil } func (actions ActionList) getRepoIDs() []int64 { @@ -60,45 +55,57 @@ func (actions ActionList) getRepoIDs() []int64 { return keysInt64(repoIDs) } -func (actions ActionList) loadRepositories(e db.Engine) ([]*repo_model.Repository, error) { +func (actions ActionList) loadRepositories(e db.Engine) error { if len(actions) == 0 { - return nil, nil + return nil } repoIDs := actions.getRepoIDs() repoMaps := make(map[int64]*repo_model.Repository, len(repoIDs)) - err := e. - In("id", repoIDs). - Find(&repoMaps) + err := e.In("id", repoIDs).Find(&repoMaps) if err != nil { - return nil, fmt.Errorf("find repository: %v", err) + return fmt.Errorf("find repository: %v", err) } for _, action := range actions { action.Repo = repoMaps[action.RepoID] } - return valuesRepository(repoMaps), nil + return nil } -// LoadRepositories loads actions' all repositories -func (actions ActionList) LoadRepositories() ([]*repo_model.Repository, error) { - return actions.loadRepositories(db.GetEngine(db.DefaultContext)) -} - -// loadAttributes loads all attributes -func (actions ActionList) loadAttributes(e db.Engine) (err error) { - if _, err = actions.loadUsers(e); err != nil { - return +func (actions ActionList) loadRepoOwner(e db.Engine, userMap map[int64]*user_model.User) (err error) { + if userMap == nil { + userMap = make(map[int64]*user_model.User) } - if _, err = actions.loadRepositories(e); err != nil { - return + for _, action := range actions { + repoOwner, ok := userMap[action.Repo.OwnerID] + if !ok { + repoOwner, err = user_model.GetUserByID(action.Repo.OwnerID) + if err != nil { + if user_model.IsErrUserNotExist(err) { + continue + } + return err + } + userMap[repoOwner.ID] = repoOwner + } + action.Repo.Owner = repoOwner } return nil } -// LoadAttributes loads attributes of the actions -func (actions ActionList) LoadAttributes() error { - return actions.loadAttributes(db.GetEngine(db.DefaultContext)) +// loadAttributes loads all attributes +func (actions ActionList) loadAttributes(e db.Engine) error { + userMap, err := actions.loadUsers(e) + if err != nil { + return err + } + + if err := actions.loadRepositories(e); err != nil { + return err + } + + return actions.loadRepoOwner(e, userMap) } diff --git a/models/action_test.go b/models/action_test.go index 0ce9183b9..e247a5ec2 100644 --- a/models/action_test.go +++ b/models/action_test.go @@ -8,6 +8,7 @@ import ( "path" "testing" + "code.gitea.io/gitea/models/db" repo_model "code.gitea.io/gitea/models/repo" "code.gitea.io/gitea/models/unittest" user_model "code.gitea.io/gitea/models/user" @@ -39,7 +40,7 @@ func TestGetFeeds(t *testing.T) { assert.NoError(t, unittest.PrepareTestDatabase()) user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}).(*user_model.User) - actions, err := GetFeeds(GetFeedsOptions{ + actions, err := GetFeeds(db.DefaultContext, GetFeedsOptions{ RequestedUser: user, Actor: user, IncludePrivate: true, @@ -52,7 +53,7 @@ func TestGetFeeds(t *testing.T) { assert.EqualValues(t, user.ID, actions[0].UserID) } - actions, err = GetFeeds(GetFeedsOptions{ + actions, err = GetFeeds(db.DefaultContext, GetFeedsOptions{ RequestedUser: user, Actor: user, IncludePrivate: false, @@ -62,13 +63,54 @@ func TestGetFeeds(t *testing.T) { assert.Len(t, actions, 0) } +func TestGetFeedsForRepos(t *testing.T) { + assert.NoError(t, unittest.PrepareTestDatabase()) + user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}).(*user_model.User) + privRepo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 2}).(*repo_model.Repository) + pubRepo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 8}).(*repo_model.Repository) + + // private repo & no login + actions, err := GetFeeds(db.DefaultContext, GetFeedsOptions{ + RequestedRepo: privRepo, + IncludePrivate: true, + }) + assert.NoError(t, err) + assert.Len(t, actions, 0) + + // public repo & no login + actions, err = GetFeeds(db.DefaultContext, GetFeedsOptions{ + RequestedRepo: pubRepo, + IncludePrivate: true, + }) + assert.NoError(t, err) + assert.Len(t, actions, 1) + + // private repo and login + actions, err = GetFeeds(db.DefaultContext, GetFeedsOptions{ + RequestedRepo: privRepo, + IncludePrivate: true, + Actor: user, + }) + assert.NoError(t, err) + assert.Len(t, actions, 1) + + // public repo & login + actions, err = GetFeeds(db.DefaultContext, GetFeedsOptions{ + RequestedRepo: pubRepo, + IncludePrivate: true, + Actor: user, + }) + assert.NoError(t, err) + assert.Len(t, actions, 1) +} + func TestGetFeeds2(t *testing.T) { // test with an organization user assert.NoError(t, unittest.PrepareTestDatabase()) org := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 3}).(*user_model.User) user := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2}).(*user_model.User) - actions, err := GetFeeds(GetFeedsOptions{ + actions, err := GetFeeds(db.DefaultContext, GetFeedsOptions{ RequestedUser: org, Actor: user, IncludePrivate: true, @@ -82,7 +124,7 @@ func TestGetFeeds2(t *testing.T) { assert.EqualValues(t, org.ID, actions[0].UserID) } - actions, err = GetFeeds(GetFeedsOptions{ + actions, err = GetFeeds(db.DefaultContext, GetFeedsOptions{ RequestedUser: org, Actor: user, IncludePrivate: false, diff --git a/models/fixtures/action.yml b/models/fixtures/action.yml index e3f3d2a97..e283b01db 100644 --- a/models/fixtures/action.yml +++ b/models/fixtures/action.yml @@ -3,7 +3,7 @@ user_id: 2 op_type: 12 # close issue act_user_id: 2 - repo_id: 2 + repo_id: 2 # private is_private: true created_unix: 1603228283 @@ -12,7 +12,7 @@ user_id: 3 op_type: 2 # rename repo act_user_id: 2 - repo_id: 3 + repo_id: 3 # private is_private: true content: oldRepoName @@ -21,7 +21,7 @@ user_id: 11 op_type: 1 # create repo act_user_id: 11 - repo_id: 9 + repo_id: 9 # public is_private: false - @@ -29,7 +29,7 @@ user_id: 16 op_type: 12 # close issue act_user_id: 16 - repo_id: 22 + repo_id: 22 # private is_private: true created_unix: 1603267920 @@ -37,7 +37,7 @@ user_id: 10 op_type: 1 # create repo act_user_id: 10 - repo_id: 6 + repo_id: 6 # private is_private: true created_unix: 1603010100 @@ -45,7 +45,7 @@ user_id: 10 op_type: 1 # create repo act_user_id: 10 - repo_id: 7 + repo_id: 7 # private is_private: true created_unix: 1603011300 @@ -53,6 +53,6 @@ user_id: 10 op_type: 1 # create repo act_user_id: 10 - repo_id: 8 + repo_id: 8 # public is_private: false created_unix: 1603011540 # grouped with id:7 diff --git a/models/user_heatmap_test.go b/models/user_heatmap_test.go index 7915363d9..9361cb345 100644 --- a/models/user_heatmap_test.go +++ b/models/user_heatmap_test.go @@ -9,6 +9,7 @@ import ( "testing" "time" + "code.gitea.io/gitea/models/db" "code.gitea.io/gitea/models/unittest" user_model "code.gitea.io/gitea/models/user" "code.gitea.io/gitea/modules/json" @@ -72,7 +73,7 @@ func TestGetUserHeatmapDataByUser(t *testing.T) { } // get the action for comparison - actions, err := GetFeeds(GetFeedsOptions{ + actions, err := GetFeeds(db.DefaultContext, GetFeedsOptions{ RequestedUser: user, Actor: doer, IncludePrivate: true, diff --git a/modules/auth/pam/pam.go b/modules/auth/pam/pam.go index 0a3d8e9f9..1acd0b112 100644 --- a/modules/auth/pam/pam.go +++ b/modules/auth/pam/pam.go @@ -34,10 +34,10 @@ func Auth(serviceName, userName, passwd string) (string, error) { if err = t.Authenticate(0); err != nil { return "", err } - + if err = t.AcctMgmt(0); err != nil { - return "", err - } + return "", err + } // PAM login names might suffer transformations in the PAM stack. // We should take whatever the PAM stack returns for it. diff --git a/modules/context/repo.go b/modules/context/repo.go index 355c40af8..e55c13f49 100644 --- a/modules/context/repo.go +++ b/modules/context/repo.go @@ -418,6 +418,8 @@ func RepoAssignment(ctx *Context) (cancel context.CancelFunc) { userName := ctx.Params(":username") repoName := ctx.Params(":reponame") repoName = strings.TrimSuffix(repoName, ".git") + repoName = strings.TrimSuffix(repoName, ".rss") + repoName = strings.TrimSuffix(repoName, ".atom") // Check if the user is the same as the repository owner if ctx.IsSigned && ctx.User.LowerName == strings.ToLower(userName) { diff --git a/routers/web/feed/convert.go b/routers/web/feed/convert.go index 51df014f1..64801a607 100644 --- a/routers/web/feed/convert.go +++ b/routers/web/feed/convert.go @@ -7,6 +7,7 @@ package feed import ( "fmt" "html" + "net/http" "net/url" "strconv" "strings" @@ -66,7 +67,7 @@ func renderMarkdown(ctx *context.Context, act *models.Action, content string) st } // feedActionsToFeedItems convert gitea's Action feed to feeds Item -func feedActionsToFeedItems(ctx *context.Context, actions []*models.Action) (items []*feeds.Item, err error) { +func feedActionsToFeedItems(ctx *context.Context, actions models.ActionList) (items []*feeds.Item, err error) { for _, act := range actions { act.LoadActUser() @@ -247,3 +248,18 @@ func feedActionsToFeedItems(ctx *context.Context, actions []*models.Action) (ite } return } + +// GetFeedType return if it is a feed request and altered name and feed type. +func GetFeedType(name string, req *http.Request) (bool, string, string) { + if strings.HasSuffix(name, ".rss") || + strings.Contains(req.Header.Get("Accept"), "application/rss+xml") { + return true, strings.TrimSuffix(name, ".rss"), "rss" + } + + if strings.HasSuffix(name, ".atom") || + strings.Contains(req.Header.Get("Accept"), "application/atom+xml") { + return true, strings.TrimSuffix(name, ".atom"), "atom" + } + + return false, name, "" +} diff --git a/routers/web/feed/profile.go b/routers/web/feed/profile.go index 4c1eff04a..a7b8efcdb 100644 --- a/routers/web/feed/profile.go +++ b/routers/web/feed/profile.go @@ -15,48 +15,9 @@ import ( "github.com/gorilla/feeds" ) -// RetrieveFeeds loads feeds for the specified user -func RetrieveFeeds(ctx *context.Context, options models.GetFeedsOptions) []*models.Action { - actions, err := models.GetFeeds(options) - if err != nil { - ctx.ServerError("GetFeeds", err) - return nil - } - - // TODO: move load repoOwner of act.Repo into models.GetFeeds->loadAttributes() - { - userCache := map[int64]*user_model.User{options.RequestedUser.ID: options.RequestedUser} - if ctx.User != nil { - userCache[ctx.User.ID] = ctx.User - } - for _, act := range actions { - if act.ActUser != nil { - userCache[act.ActUserID] = act.ActUser - } - } - for _, act := range actions { - repoOwner, ok := userCache[act.Repo.OwnerID] - if !ok { - repoOwner, err = user_model.GetUserByID(act.Repo.OwnerID) - if err != nil { - if user_model.IsErrUserNotExist(err) { - continue - } - ctx.ServerError("GetUserByID", err) - return nil - } - userCache[repoOwner.ID] = repoOwner - } - act.Repo.Owner = repoOwner - } - } - - return actions -} - // ShowUserFeed show user activity as RSS / Atom feed func ShowUserFeed(ctx *context.Context, ctxUser *user_model.User, formatType string) { - actions := RetrieveFeeds(ctx, models.GetFeedsOptions{ + actions, err := models.GetFeeds(ctx, models.GetFeedsOptions{ RequestedUser: ctxUser, Actor: ctx.User, IncludePrivate: false, @@ -64,7 +25,8 @@ func ShowUserFeed(ctx *context.Context, ctxUser *user_model.User, formatType str IncludeDeleted: false, Date: ctx.FormString("date"), }) - if ctx.Written() { + if err != nil { + ctx.ServerError("GetFeeds", err) return } @@ -75,7 +37,6 @@ func ShowUserFeed(ctx *context.Context, ctxUser *user_model.User, formatType str Created: time.Now(), } - var err error feed.Items, err = feedActionsToFeedItems(ctx, actions) if err != nil { ctx.ServerError("convert feed", err) diff --git a/routers/web/feed/repo.go b/routers/web/feed/repo.go new file mode 100644 index 000000000..53fb8148e --- /dev/null +++ b/routers/web/feed/repo.go @@ -0,0 +1,44 @@ +// Copyright 2022 The Gitea 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 feed + +import ( + "time" + + "code.gitea.io/gitea/models" + repo_model "code.gitea.io/gitea/models/repo" + "code.gitea.io/gitea/modules/context" + + "github.com/gorilla/feeds" +) + +// ShowRepoFeed shows user activity on the repo as RSS / Atom feed +func ShowRepoFeed(ctx *context.Context, repo *repo_model.Repository, formatType string) { + actions, err := models.GetFeeds(ctx, models.GetFeedsOptions{ + RequestedRepo: repo, + Actor: ctx.User, + IncludePrivate: true, + Date: ctx.FormString("date"), + }) + if err != nil { + ctx.ServerError("GetFeeds", err) + return + } + + feed := &feeds.Feed{ + Title: ctx.Tr("home.feed_of", repo.FullName()), + Link: &feeds.Link{Href: repo.HTMLURL()}, + Description: repo.Description, + Created: time.Now(), + } + + feed.Items, err = feedActionsToFeedItems(ctx, actions) + if err != nil { + ctx.ServerError("convert feed", err) + return + } + + writeFeed(ctx, feed, formatType) +} diff --git a/routers/web/repo/view.go b/routers/web/repo/view.go index 9ff72b210..5293d3c6a 100644 --- a/routers/web/repo/view.go +++ b/routers/web/repo/view.go @@ -38,6 +38,7 @@ import ( "code.gitea.io/gitea/modules/structs" "code.gitea.io/gitea/modules/typesniffer" "code.gitea.io/gitea/modules/util" + "code.gitea.io/gitea/routers/web/feed" ) const ( @@ -691,6 +692,14 @@ func checkHomeCodeViewable(ctx *context.Context) { // Home render repository home page func Home(ctx *context.Context) { + isFeed, _, showFeedType := feed.GetFeedType(ctx.Params(":reponame"), ctx.Req) + if isFeed { + feed.ShowRepoFeed(ctx, ctx.Repo.Repository, showFeedType) + return + } + + ctx.Data["FeedURL"] = ctx.Repo.Repository.HTMLURL() + checkHomeCodeViewable(ctx) if ctx.Written() { return diff --git a/routers/web/user/home.go b/routers/web/user/home.go index 379e1f8e2..877aa4528 100644 --- a/routers/web/user/home.go +++ b/routers/web/user/home.go @@ -29,7 +29,6 @@ import ( "code.gitea.io/gitea/modules/markup/markdown" "code.gitea.io/gitea/modules/setting" "code.gitea.io/gitea/modules/util" - "code.gitea.io/gitea/routers/web/feed" issue_service "code.gitea.io/gitea/services/issue" pull_service "code.gitea.io/gitea/services/pull" @@ -131,7 +130,7 @@ func Dashboard(ctx *context.Context) { ctx.Data["MirrorCount"] = len(mirrors) ctx.Data["Mirrors"] = mirrors - ctx.Data["Feeds"] = feed.RetrieveFeeds(ctx, models.GetFeedsOptions{ + ctx.Data["Feeds"], err = models.GetFeeds(ctx, models.GetFeedsOptions{ RequestedUser: ctxUser, RequestedTeam: ctx.Org.Team, Actor: ctx.User, @@ -140,8 +139,8 @@ func Dashboard(ctx *context.Context) { IncludeDeleted: false, Date: ctx.FormString("date"), }) - - if ctx.Written() { + if err != nil { + ctx.ServerError("GetFeeds", err) return } diff --git a/routers/web/user/profile.go b/routers/web/user/profile.go index b4198ef8f..b84cee2b3 100644 --- a/routers/web/user/profile.go +++ b/routers/web/user/profile.go @@ -74,19 +74,7 @@ func Profile(ctx *context.Context) { uname = strings.TrimSuffix(uname, ".gpg") } - showFeedType := "" - if strings.HasSuffix(uname, ".rss") { - showFeedType = "rss" - uname = strings.TrimSuffix(uname, ".rss") - } else if strings.Contains(ctx.Req.Header.Get("Accept"), "application/rss+xml") { - showFeedType = "rss" - } - if strings.HasSuffix(uname, ".atom") { - showFeedType = "atom" - uname = strings.TrimSuffix(uname, ".atom") - } else if strings.Contains(ctx.Req.Header.Get("Accept"), "application/atom+xml") { - showFeedType = "atom" - } + isShowFeed, uname, showFeedType := feed.GetFeedType(uname, ctx.Req) ctxUser := GetUserByName(ctx, uname) if ctx.Written() { @@ -95,7 +83,7 @@ func Profile(ctx *context.Context) { if ctxUser.IsOrganization() { // Show Org RSS feed - if len(showFeedType) != 0 { + if isShowFeed { feed.ShowUserFeed(ctx, ctxUser, showFeedType) return } @@ -123,11 +111,14 @@ func Profile(ctx *context.Context) { } // Show User RSS feed - if len(showFeedType) != 0 { + if isShowFeed { feed.ShowUserFeed(ctx, ctxUser, showFeedType) return } + // advertise feed via meta tag + ctx.Data["FeedURL"] = ctxUser.HTMLURL() + // Show OpenID URIs openIDs, err := user_model.GetUserOpenIDs(ctxUser.ID) if err != nil { @@ -259,7 +250,7 @@ func Profile(ctx *context.Context) { total = ctxUser.NumFollowing case "activity": - ctx.Data["Feeds"] = feed.RetrieveFeeds(ctx, models.GetFeedsOptions{ + ctx.Data["Feeds"], err = models.GetFeeds(ctx, models.GetFeedsOptions{ RequestedUser: ctxUser, Actor: ctx.User, IncludePrivate: showPrivate, @@ -267,7 +258,8 @@ func Profile(ctx *context.Context) { IncludeDeleted: false, Date: ctx.FormString("date"), }) - if ctx.Written() { + if err != nil { + ctx.ServerError("GetFeeds", err) return } case "stars": diff --git a/templates/base/head.tmpl b/templates/base/head.tmpl index 32e206a95..666246a18 100644 --- a/templates/base/head.tmpl +++ b/templates/base/head.tmpl @@ -14,6 +14,10 @@ {{if .GoGetImport}} +{{end}} +{{if .FeedURL}} + + {{end}}