API add/generalize pagination (#9452)

* paginate results

* fixed deadlock

* prevented breaking change

* updated swagger

* go fmt

* fixed find topic

* go mod tidy

* go mod vendor with go1.13.5

* fixed repo find topics

* fixed unit test

* added Limit method to Engine struct; use engine variable when provided; fixed gitignore

* use ItemsPerPage for default pagesize; fix GetWatchers, getOrgUsersByOrgID and GetStargazers; fix GetAllCommits headers; reverted some changed behaviors

* set Page value on Home route

* improved memory allocations

* fixed response headers

* removed logfiles

* fixed import order

* import order

* improved swagger

* added function to get models.ListOptions from context

* removed pagesize diff on unit test

* fixed imports

* removed unnecessary struct field

* fixed go fmt

* scoped PR

* code improvements

* code improvements

* go mod tidy

* fixed import order

* fixed commit statuses session

* fixed files headers

* fixed headers; added pagination for notifications

* go mod tidy

* go fmt

* removed Private from user search options; added setting.UI.IssuePagingNum as default valeu on repo's issues list

* Apply suggestions from code review

Co-Authored-By: 6543 <6543@obermui.de>
Co-Authored-By: zeripath <art27@cantab.net>

* fixed build error

* CI.restart()

* fixed merge conflicts resolve

* fixed conflicts resolve

* improved FindTrackedTimesOptions.ToOptions() method

* added backwards compatibility on ListReleases request; fixed issue tracked time ToSession

* fixed build error; fixed swagger template

* fixed swagger template

* fixed ListReleases backwards compatibility

* added page to user search route

Co-authored-by: techknowlogick <matti@mdranta.net>
Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: zeripath <art27@cantab.net>

1 files changed, 44 insertions, 0 deletions

diff --git a/models/list_options.go b/models/list_options.go
new file mode 100644
index 0000000000..91c4298c85
--- /dev/null
+++ b/models/list_options.go
@@ -0,0 +1,44 @@
+// Copyright 2020 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 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) setEnginePagination(e Engine) Engine {
+	opts.setDefaultValues()
+
+	return e.Limit(opts.PageSize, (opts.Page-1)*opts.PageSize)
+}
+
+func (opts ListOptions) setDefaultValues() {
+	if opts.PageSize <= 0 || opts.PageSize > setting.API.MaxResponseItems {
+		opts.PageSize = setting.API.MaxResponseItems
+	}
+	if opts.Page <= 0 {
+		opts.Page = 1
+	}
+}