feat: add limit

Author: Buco7854

api/controllers/image/binding.go

@@ -60,7 +60,7 @@ func QueryParamsBinder(
 	gif *string,
 	orderBy *string,
 	orientation *string,
-	many *bool,
+	limit *int,
 	full *bool,
 	width *string,
 	height *string,
@@ -189,7 +189,7 @@ func QueryParamsBinder(
 			}
 			return []error{echo.NewBindingError("byte_size", values[0:1], regexError(ComparatorRegexRule), nil)}
 		}).
-		Bool("many", many).
+		Int("limit", limit).
 		Bool("full", full).
 		BindError()
 }

api/controllers/image/image_controller.go

@@ -86,7 +86,7 @@ func (controller Controller) RouteSelector(favRoute bool) echo.HandlerFunc {
 		var gif = constants.Null
 		var orderBy = constants.Random
 		var orientation = constants.Random
-		var many = false
+		var limit = 0
 		var full = false
 		var width string
 		var height string
@@ -115,14 +115,21 @@ func (controller Controller) RouteSelector(favRoute bool) echo.HandlerFunc {
 			&gif,
 			&orderBy,
 			&orientation,
-			&many,
+			&limit,
 			&full,
 			&width,
 			&height,
 			&byteSize,
 		); err != nil {
 			return err
 		}
+		if limit != 0 && limit < 2 {
+			return &echo.HTTPError{
+				Code:     http.StatusBadRequest,
+				Message:  "If provided limit should be greater than 1",
+				Internal: nil,
+			}
+		}
 		rows, execTime, err := controller.Globals.Database.FetchImages(
 			isNsfw,
 			includedTags,
@@ -132,7 +139,7 @@ func (controller Controller) RouteSelector(favRoute bool) echo.HandlerFunc {
 			gif,
 			orderBy,
 			orientation,
-			many,
+			limit,
 			full,
 			width,
 			height,

api/middlewares/skippers.go

@@ -3,6 +3,7 @@ package middlewares
 import (
 	"bytes"
 	"encoding/json"
+	"github.com/Waifu-im/waifu-api/constants"
 	"github.com/Waifu-im/waifu-api/serializers"
 	"github.com/labstack/echo/v4"
 	"io"
@@ -45,6 +46,24 @@ func Int64ParamsSkipper(sourceParam string, contextKey string, skipAfter bool) f
 	}
 }
 
+// LimitParamsSkipper return true when skipAfter and the param provided is not superior to MaxLimit (only for int param).
+// If a param is provided it can assign it to a context 'variable' if contextKey is passed
+func LimitParamsSkipper(sourceParam string, contextKey string, skipAfter bool) func(echo.Context) (bool, error) {
+	return func(c echo.Context) (bool, error) {
+		var param int
+		if err := echo.QueryParamsBinder(c).Int(sourceParam, &param).BindError(); err != nil {
+			return false, err
+		}
+		if param <= constants.MaxLimit && skipAfter {
+			return true, nil
+		}
+		if contextKey != "" {
+			(c).Set(contextKey, param)
+		}
+		return false, nil
+	}
+}
+
 // SkipOrSetUser I use this 'skipper' has a function to set the user id present in the body so that permissions can check for it later
 func SkipOrSetUser(isSkipper bool) func(echo.Context) (bool, error) {
 	return func(c echo.Context) (bool, error) {

api/routes/image.go

@@ -4,6 +4,7 @@ import (
 	"github.com/Waifu-im/waifu-api/api/controllers/image"
 	"github.com/Waifu-im/waifu-api/api/middlewares"
 	"github.com/Waifu-im/waifu-api/api/utils"
+	"github.com/Waifu-im/waifu-api/constants"
 	"github.com/labstack/echo/v4"
 )
 
@@ -19,14 +20,23 @@ func AddImageRouter(globals utils.Globals, app *echo.Echo) error {
 			globals,
 			func(c echo.Context) (bool, error) {
 				var full bool
+				var limit int
 				_ = echo.QueryParamsBinder(c).Bool("full", &full)
+				_ = echo.QueryParamsBinder(c).Int("limit", &limit)
 				// when new release will be out this middleware will be on the whole group with that condition in addition
 				// c.Request().URL.Path == "/search"
-				return !full, nil
+				skip := !full && limit <= constants.MaxLimit
+				return skip, nil
 			}),
-		middlewares.PermissionsVerification(globals, []string{"admin"}, middlewares.BoolParamsSkipper("full", "", true)),
+		middlewares.PermissionsVerification(
+			globals, []string{"admin"},
+			middlewares.BoolParamsSkipper("full", "", true),
+		),
+		middlewares.PermissionsVerification(
+			globals, []string{"admin"},
+			middlewares.LimitParamsSkipper("limit", "", true),
+		),
 	)
-
 	app.GET(
 		"/fav",
 		controller.Fav(),

constants/database.go

@@ -21,4 +21,4 @@ const (
 	Portrait  = "PORTRAIT"
 )
 
-const ManyLimit = "30"
+const MaxLimit = 30

database/queries.go

@@ -25,13 +25,14 @@ func (database Database) FetchImages(
 	gif string,
 	orderBy string,
 	orientation string,
-	many bool,
+	limit int,
 	full bool,
 	width string,
 	height string,
 	byteSize string,
 	userId int64,
 ) (ImageRows, time.Duration, error) {
+	limitString := strconv.Itoa(limit)
 	var parameters []any
 
 	// Select some information about the images
@@ -85,9 +86,10 @@ func (database Database) FetchImages(
 	if len(includedTags) > 0 {
 		query += "HAVING COUNT(*)=" + strconv.FormatInt(int64(len(includedTags)), 10) + " "
 	}
+	// If it's not in full mode or files has been provided, and it's not in fav mode and limit is provided then add the limit.
 	query += FormatOrderBy(orderBy, "", true)
-	if !(full || len(includedFiles) > 0) && userId == 0 && many {
-		query += "LIMIT " + constants.ManyLimit + " "
+	if !(full || len(includedFiles) > 0) && userId == 0 && limit > 0 {
+		query += "LIMIT " + limitString + " "
 	} else if !(full || len(includedFiles) > 0) && userId == 0 {
 		query += "LIMIT  1 "
 	}
@@ -163,7 +165,7 @@ func (database Database) FetchImages(
 	if err = rows.Err(); err != nil {
 		return imageRows, time.Since(start), err
 	}
-	if orderBy == constants.Random && (full || many || len(includedFiles) > 0 || userId != 0) {
+	if orderBy == constants.Random && len(imageRows.Rows) > 1 {
 		rand.Seed(time.Now().UnixNano())
 		rand.Shuffle(
 			len(imageRows.Rows),