// GoToSocial // Copyright (C) GoToSocial Authors admin@gotosocial.org // SPDX-License-Identifier: AGPL-3.0-or-later // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package bookmarks import ( "fmt" "net/http" "strconv" "github.com/gin-gonic/gin" apiutil "github.com/superseriousbusiness/gotosocial/internal/api/util" "github.com/superseriousbusiness/gotosocial/internal/gtserror" "github.com/superseriousbusiness/gotosocial/internal/oauth" ) const ( // LimitKey is for setting the return amount limit for eg., requesting an account's statuses LimitKey = "limit" // MaxIDKey is for specifying the maximum ID of the bookmark to retrieve. MaxIDKey = "max_id" // MinIDKey is for specifying the minimum ID of the bookmark to retrieve. MinIDKey = "min_id" ) // BookmarksGETHandler swagger:operation GET /api/v1/bookmarks bookmarksGet // // Get an array of statuses bookmarked in the instance // // --- // tags: // - bookmarks // // produces: // - application/json // // security: // - OAuth2 Bearer: // - read:bookmarks // // parameters: // - // name: limit // type: integer // description: Number of statuses to return. // default: 30 // in: query // - // name: max_id // type: string // description: >- // Return only bookmarked statuses *OLDER* than the given bookmark ID. // The status with the corresponding bookmark ID will not be included in the response. // in: query // - // name: min_id // type: string // description: >- // Return only bookmarked statuses *NEWER* than the given bookmark ID. // The status with the corresponding bookmark ID will not be included in the response. // in: query // // responses: // '200': // description: Array of bookmarked statuses // schema: // type: array // items: // "$ref": "#/definitions/status" // headers: // Link: // type: string // description: Links to the next and previous queries. // '401': // description: unauthorized // '406': // description: not acceptable // '500': // description: internal server error func (m *Module) BookmarksGETHandler(c *gin.Context) { authed, err := oauth.Authed(c, true, true, true, true) if err != nil { apiutil.ErrorHandler(c, gtserror.NewErrorUnauthorized(err, err.Error()), m.processor.InstanceGetV1) return } if _, err := apiutil.NegotiateAccept(c, apiutil.JSONAcceptHeaders...); err != nil { apiutil.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGetV1) return } limit := 30 limitString := c.Query(LimitKey) if limitString != "" { i, err := strconv.ParseInt(limitString, 10, 64) if err != nil { err := fmt.Errorf("error parsing %s: %s", LimitKey, err) apiutil.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGetV1) return } limit = int(i) } maxID := "" maxIDString := c.Query(MaxIDKey) if maxIDString != "" { maxID = maxIDString } minID := "" minIDString := c.Query(MinIDKey) if minIDString != "" { minID = minIDString } resp, errWithCode := m.processor.Account().BookmarksGet(c.Request.Context(), authed.Account, limit, maxID, minID) if errWithCode != nil { apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1) return } if errWithCode != nil { apiutil.ErrorHandler(c, errWithCode, m.processor.InstanceGetV1) return } if resp.LinkHeader != "" { c.Header("Link", resp.LinkHeader) } apiutil.JSON(c, http.StatusOK, resp.Items) }