API add/generalize pagination

cmd/admin.go

@@ -349,9 +349,11 @@ func runRepoSyncReleases(c *cli.Context) error {
 	log.Trace("Synchronizing repository releases (this may take a while)")
 	for page := 1; ; page++ {
 		repos, count, err := models.SearchRepositoryByName(&models.SearchRepoOptions{
-			Page:     page,
-			PageSize: models.RepositoryListDefaultPageSize,
-			Private:  true,
+			ListOptions: models.ListOptions{
+				PageSize: models.RepositoryListDefaultPageSize,
+				Page:     page,
+			},
+			Private: true,
 		})
 		if err != nil {
 			return fmt.Errorf("SearchRepositoryByName: %v", err)

models/access.go

@@ -192,7 +192,7 @@ func (repo *Repository) refreshAccesses(e Engine, accessMap map[int64]AccessMode
 
 // refreshCollaboratorAccesses retrieves repository collaborations with their access modes.
 func (repo *Repository) refreshCollaboratorAccesses(e Engine, accessMap map[int64]AccessMode) error {
-	collaborations, err := repo.getCollaborations(e)
+	collaborations, err := repo.getCollaborations(e, ListOptions{})
 	if err != nil {
 		return fmt.Errorf("getCollaborations: %v", err)
 	}

models/gpg_key.go

@@ -64,9 +64,14 @@ func (key *GPGKey) AfterLoad(session *xorm.Session) {
 }
 
 // ListGPGKeys returns a list of public keys belongs to given user.
-func ListGPGKeys(uid int64) ([]*GPGKey, error) {
-	keys := make([]*GPGKey, 0, 5)
-	return keys, x.Where("owner_id=? AND primary_key_id=''", uid).Find(&keys)
+func ListGPGKeys(uid int64, listOptions ListOptions) ([]*GPGKey, error) {
+	sess := x.Where("owner_id=? AND primary_key_id=''", uid)
+	if listOptions.Page != 0 {
+		sess = listOptions.setSessionPagination(sess)
+	}
+
+	var keys []*GPGKey
+	return keys, sess.Find(&keys)
 }
 
 // GetGPGKeyByID returns public key by given ID.
@@ -628,7 +633,7 @@ func ParseCommitWithSignature(c *git.Commit) *CommitVerification {
 
 	// Now try to associate the signature with the committer, if present
 	if committer.ID != 0 {
-		keys, err := ListGPGKeys(committer.ID)
+		keys, err := ListGPGKeys(committer.ID, ListOptions{})
 		if err != nil { //Skipping failed to get gpg keys of user
 			log.Error("ListGPGKeys: %v", err)
 			return &CommitVerification{

models/issue.go

@@ -1072,13 +1072,12 @@ func GetIssuesByIDs(issueIDs []int64) ([]*Issue, error) {
 
 // IssuesOptions represents options of an issue.
 type IssuesOptions struct {
+	ListOptions
 	RepoIDs     []int64 // include all repos if empty
 	AssigneeID  int64
 	PosterID    int64
 	MentionedID int64
 	MilestoneID int64
-	Page        int
-	PageSize    int
 	IsClosed    util.OptionalBool
 	IsPull      util.OptionalBool
 	LabelIDs    []int64

models/issue_comment.go

@@ -759,6 +759,7 @@ func GetCommentByID(id int64) (*Comment, error) {
 
 // FindCommentsOptions describes the conditions to Find comments
 type FindCommentsOptions struct {
+	ListOptions
 	RepoID   int64
 	IssueID  int64
 	ReviewID int64
@@ -792,6 +793,11 @@ func findComments(e Engine, opts FindCommentsOptions) ([]*Comment, error) {
 	if opts.RepoID > 0 {
 		sess.Join("INNER", "issue", "issue.id = comment.issue_id")
 	}
+
+	if opts.Page != 0 {
+		sess = opts.setSessionPagination(sess)
+	}
+
 	return comments, sess.
 		Asc("comment.created_unix").
 		Asc("comment.id").

models/issue_label.go

@@ -298,7 +298,7 @@ func GetLabelsInRepoByIDs(repoID int64, labelIDs []int64) ([]*Label, error) {
 		Find(&labels)
 }
 
-func getLabelsByRepoID(e Engine, repoID int64, sortType string) ([]*Label, error) {
+func getLabelsByRepoID(e Engine, repoID int64, sortType string, listOptions ListOptions) ([]*Label, error) {
 	labels := make([]*Label, 0, 10)
 	sess := e.Where("repo_id = ?", repoID)
 
@@ -313,12 +313,16 @@ func getLabelsByRepoID(e Engine, repoID int64, sortType string) ([]*Label, error
 		sess.Asc("name")
 	}
 
+	if listOptions.Page != 0 {
+		sess = listOptions.setSessionPagination(sess)
+	}
+
 	return labels, sess.Find(&labels)
 }
 
 // GetLabelsByRepoID returns all labels that belong to given repository by ID.
-func GetLabelsByRepoID(repoID int64, sortType string) ([]*Label, error) {
-	return getLabelsByRepoID(x, repoID, sortType)
+func GetLabelsByRepoID(repoID int64, sortType string, listOptions ListOptions) ([]*Label, error) {
+	return getLabelsByRepoID(x, repoID, sortType, listOptions)
 }
 
 func getLabelsByIssueID(e Engine, issueID int64) ([]*Label, error) {

models/issue_label_test.go

@@ -131,7 +131,7 @@ func TestGetLabelsInRepoByIDs(t *testing.T) {
 func TestGetLabelsByRepoID(t *testing.T) {
 	assert.NoError(t, PrepareTestDatabase())
 	testSuccess := func(repoID int64, sortType string, expectedIssueIDs []int64) {
-		labels, err := GetLabelsByRepoID(repoID, sortType)
+		labels, err := GetLabelsByRepoID(repoID, sortType, ListOptions{})
 		assert.NoError(t, err)
 		assert.Len(t, labels, len(expectedIssueIDs))
 		for i, label := range labels {

models/issue_milestone.go

@@ -219,7 +219,7 @@ func (milestones MilestoneList) getMilestoneIDs() []int64 {
 }
 
 // GetMilestonesByRepoID returns all opened milestones of a repository.
-func GetMilestonesByRepoID(repoID int64, state api.StateType) (MilestoneList, error) {
+func GetMilestonesByRepoID(repoID int64, state api.StateType, listOptions ListOptions) (MilestoneList, error) {
 	sess := x.Where("repo_id = ?", repoID)
 
 	switch state {
@@ -236,7 +236,11 @@ func GetMilestonesByRepoID(repoID int64, state api.StateType) (MilestoneList, er
 		sess = sess.And("is_closed = ?", false)
 	}
 
-	miles := make([]*Milestone, 0, 10)
+	if listOptions.Page != 0 {
+		sess = listOptions.setSessionPagination(sess)
+	}
+
+	var miles []*Milestone
 	return miles, sess.Asc("deadline_unix").Asc("id").Find(&miles)
 }
 

models/issue_milestone_test.go

@@ -71,7 +71,7 @@ func TestGetMilestonesByRepoID(t *testing.T) {
 	assert.NoError(t, PrepareTestDatabase())
 	test := func(repoID int64, state api.StateType) {
 		repo := AssertExistsAndLoadBean(t, &Repository{ID: repoID}).(*Repository)
-		milestones, err := GetMilestonesByRepoID(repo.ID, state)
+		milestones, err := GetMilestonesByRepoID(repo.ID, state, ListOptions{})
 		assert.NoError(t, err)
 
 		var n int
@@ -105,7 +105,7 @@ func TestGetMilestonesByRepoID(t *testing.T) {
 	test(3, api.StateClosed)
 	test(3, api.StateAll)
 
-	milestones, err := GetMilestonesByRepoID(NonexistentID, api.StateOpen)
+	milestones, err := GetMilestonesByRepoID(NonexistentID, api.StateOpen, ListOptions{})
 	assert.NoError(t, err)
 	assert.Len(t, milestones, 0)
 }

models/issue_reaction.go

@@ -28,6 +28,7 @@ type Reaction struct {
 
 // FindReactionsOptions describes the conditions to Find reactions
 type FindReactionsOptions struct {
+	ListOptions
 	IssueID   int64
 	CommentID int64
 }
@@ -58,16 +59,21 @@ func FindCommentReactions(comment *Comment) (ReactionList, error) {
 }
 
 // FindIssueReactions returns a ReactionList of all reactions from an issue
-func FindIssueReactions(issue *Issue) (ReactionList, error) {
+func FindIssueReactions(issue *Issue, listOptions ListOptions) (ReactionList, error) {
 	return findReactions(x, FindReactionsOptions{
-		IssueID:   issue.ID,
-		CommentID: -1,
+		ListOptions: listOptions,
+		IssueID:     issue.ID,
+		CommentID:   -1,
 	})
 }
 
 func findReactions(e Engine, opts FindReactionsOptions) ([]*Reaction, error) {
-	reactions := make([]*Reaction, 0, 10)
+	var reactions []*Reaction
 	sess := e.Where(opts.toConds())
+	if opts.Page != 0 {
+		sess = opts.setSessionPagination(sess)
+	}
+
 	return reactions, sess.
 		In("reaction.`type`", setting.UI.Reactions).
 		Asc("reaction.issue_id", "reaction.comment_id", "reaction.created_unix", "reaction.id").

models/issue_stopwatch.go

@@ -33,9 +33,14 @@ func getStopwatch(e Engine, userID, issueID int64) (sw *Stopwatch, exists bool,
 }
 
 // GetUserStopwatches return list of all stopwatches of a user
-func GetUserStopwatches(userID int64) (sws *Stopwatches, err error) {
+func GetUserStopwatches(userID int64, listOptions ListOptions) (sws *Stopwatches, err error) {
 	sws = new(Stopwatches)
-	err = x.Where("stopwatch.user_id = ?", userID).Find(sws)
+	sess := x.Where("stopwatch.user_id = ?", userID)
+	if listOptions.Page != 0 {
+		sess = listOptions.setSessionPagination(sess)
+	}
+
+	err = sess.Find(sws)
 	if err != nil {
 		return nil, err
 	}

models/issue_test.go

@@ -139,24 +139,30 @@ func TestIssues(t *testing.T) {
 			IssuesOptions{
 				RepoIDs:  []int64{1, 3},
 				SortType: "oldest",
-				Page:     1,
-				PageSize: 4,
+				ListOptions: ListOptions{
+					Page:     1,
+					PageSize: 4,
+				},
 			},
 			[]int64{1, 2, 3, 5},
 		},
 		{
 			IssuesOptions{
 				LabelIDs: []int64{1},
-				Page:     1,
-				PageSize: 4,
+				ListOptions: ListOptions{
+					Page:     1,
+					PageSize: 4,
+				},
 			},
 			[]int64{2, 1},
 		},
 		{
 			IssuesOptions{
 				LabelIDs: []int64{1, 2},
-				Page:     1,
-				PageSize: 4,
+				ListOptions: ListOptions{
+					Page:     1,
+					PageSize: 4,
+				},
 			},
 			[]int64{}, // issues with **both** label 1 and 2, none of these issues matches, TODO: add more tests
 		},

models/issue_tracked_time.go

@@ -42,6 +42,7 @@ func (t *TrackedTime) APIFormat() *api.TrackedTime {
 
 // FindTrackedTimesOptions represent the filters for tracked times. If an ID is 0 it will be ignored.
 type FindTrackedTimesOptions struct {
+	ListOptions
 	IssueID      int64
 	UserID       int64
 	RepositoryID int64
@@ -68,10 +69,24 @@ func (opts *FindTrackedTimesOptions) ToCond() builder.Cond {
 
 // ToSession will convert the given options to a xorm Session by using the conditions from ToCond and joining with issue table if required
 func (opts *FindTrackedTimesOptions) ToSession(e Engine) *xorm.Session {
+	var sess *xorm.Session
 	if opts.RepositoryID > 0 || opts.MilestoneID > 0 {
-		return e.Join("INNER", "issue", "issue.id = tracked_time.issue_id").Where(opts.ToCond())
+		sess = e.Join("INNER", "issue", "issue.id = tracked_time.issue_id")
 	}
-	return x.Where(opts.ToCond())
+
+	if opts.Page != 0 {
+		if sess == nil {
+			sess = opts.getPaginatedSession()
+		} else {
+			sess = opts.setSessionPagination(sess)
+		}
+	}
+
+	if sess == nil {
+		return e.Where(opts.ToCond())
+	}
+
+	return sess.Where(opts.ToCond())
 }
 
 // GetTrackedTimes returns all tracked times that fit to the given options.

models/issue_watch.go

@@ -74,18 +74,22 @@ func GetIssueWatchersIDs(issueID int64) ([]int64, error) {
 }
 
 // GetIssueWatchers returns watchers/unwatchers of a given issue
-func GetIssueWatchers(issueID int64) (IssueWatchList, error) {
-	return getIssueWatchers(x, issueID)
+func GetIssueWatchers(issueID int64, listOptions ListOptions) (IssueWatchList, error) {
+	return getIssueWatchers(x, issueID, listOptions)
 }
 
-func getIssueWatchers(e Engine, issueID int64) (watches IssueWatchList, err error) {
-	err = e.
+func getIssueWatchers(e Engine, issueID int64, listOptions ListOptions) (watches IssueWatchList, err error) {
+	sess := e.
 		Where("`issue_watch`.issue_id = ?", issueID).
 		And("`issue_watch`.is_watching = ?", true).
 		And("`user`.is_active = ?", true).
 		And("`user`.prohibit_login = ?", false).
-		Join("INNER", "`user`", "`user`.id = `issue_watch`.user_id").
-		Find(&watches)
+		Join("INNER", "`user`", "`user`.id = `issue_watch`.user_id")
+
+	if listOptions.Page == 0 {
+		sess = listOptions.setSessionPagination(sess)
+	}
+	err = sess.Find(&watches)
 	return
 }
 

models/issue_watch_test.go

@@ -41,22 +41,22 @@ func TestGetIssueWatch(t *testing.T) {
 func TestGetIssueWatchers(t *testing.T) {
 	assert.NoError(t, PrepareTestDatabase())
 
-	iws, err := GetIssueWatchers(1)
+	iws, err := GetIssueWatchers(1, ListOptions{})
 	assert.NoError(t, err)
 	// Watcher is inactive, thus 0
 	assert.Len(t, iws, 0)
 
-	iws, err = GetIssueWatchers(2)
+	iws, err = GetIssueWatchers(2, ListOptions{})
 	assert.NoError(t, err)
 	// Watcher is explicit not watching
 	assert.Len(t, iws, 0)
 
-	iws, err = GetIssueWatchers(5)
+	iws, err = GetIssueWatchers(5, ListOptions{})
 	assert.NoError(t, err)
 	// Issue has no Watchers
 	assert.Len(t, iws, 0)
 
-	iws, err = GetIssueWatchers(7)
+	iws, err = GetIssueWatchers(7, ListOptions{})
 	assert.NoError(t, err)
 	// Issue has one watcher
 	assert.Len(t, iws, 1)

models/list_options.go

@@ -0,0 +1,33 @@
+package models
+
+import (
+	"code.gitea.io/gitea/modules/setting"
+	"xorm.io/xorm"
+)
+
+// ListOptions options to paginate results
+type ListOptions struct {
+	PageSize int
+	Page     int
+}
+
+func (opts ListOptions) getPaginatedSession() *xorm.Session {
+	opts.setDefaultValues()
+
+	return x.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize)
+}
+
+func (opts ListOptions) setSessionPagination(sess *xorm.Session) *xorm.Session {
+	opts.setDefaultValues()
+
+	return sess.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize)
+}
+
+func (opts ListOptions) setDefaultValues() {
+	if opts.PageSize <= 0 || opts.PageSize > setting.UI.ExplorePagingNum {
+		opts.PageSize = setting.UI.ExplorePagingNum
+	}
+	if opts.Page <= 0 {
+		opts.Page = 1
+	}
+}

models/notification.go

@@ -75,7 +75,7 @@ func CreateOrUpdateIssueNotifications(issueID, commentID int64, notificationAuth
 }
 
 func createOrUpdateIssueNotifications(e Engine, issueID, commentID int64, notificationAuthorID int64) error {
-	issueWatches, err := getIssueWatchers(e, issueID)
+	issueWatches, err := getIssueWatchers(e, issueID, ListOptions{})
 	if err != nil {
 		return err
 	}