diff options
Diffstat (limited to 'internal/api/client/notification')
| -rw-r--r-- | internal/api/client/notification/notification.go | 66 | ||||
| -rw-r--r-- | internal/api/client/notification/notificationsclear.go | 80 | ||||
| -rw-r--r-- | internal/api/client/notification/notificationsget.go | 159 |
3 files changed, 0 insertions, 305 deletions
diff --git a/internal/api/client/notification/notification.go b/internal/api/client/notification/notification.go deleted file mode 100644 index 6ade0b02f..000000000 --- a/internal/api/client/notification/notification.go +++ /dev/null @@ -1,66 +0,0 @@ -/* - GoToSocial - Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org - - 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 <http://www.gnu.org/licenses/>. -*/ - -package notification - -import ( - "net/http" - - "github.com/superseriousbusiness/gotosocial/internal/api" - "github.com/superseriousbusiness/gotosocial/internal/processing" - "github.com/superseriousbusiness/gotosocial/internal/router" -) - -const ( - // IDKey is for notification UUIDs - IDKey = "id" - // BasePath is the base path for serving the notification API - BasePath = "/api/v1/notifications" - // BasePathWithID is just the base path with the ID key in it. - // Use this anywhere you need to know the ID of the notification being queried. - BasePathWithID = BasePath + "/:" + IDKey - BasePathWithClear = BasePath + "/clear" - - // ExcludeTypes is an array specifying notification types to exclude - ExcludeTypesKey = "exclude_types[]" - // MaxIDKey is the url query for setting a max notification ID to return - MaxIDKey = "max_id" - // LimitKey is for specifying maximum number of notifications to return. - LimitKey = "limit" - // SinceIDKey is for specifying the minimum notification ID to return. - SinceIDKey = "since_id" -) - -// Module implements the ClientAPIModule interface for every related to posting/deleting/interacting with notifications -type Module struct { - processor processing.Processor -} - -// New returns a new notification module -func New(processor processing.Processor) api.ClientModule { - return &Module{ - processor: processor, - } -} - -// Route attaches all routes from this module to the given router -func (m *Module) Route(r router.Router) error { - r.AttachHandler(http.MethodGet, BasePath, m.NotificationsGETHandler) - r.AttachHandler(http.MethodPost, BasePathWithClear, m.NotificationsClearPOSTHandler) - return nil -} diff --git a/internal/api/client/notification/notificationsclear.go b/internal/api/client/notification/notificationsclear.go deleted file mode 100644 index b97371638..000000000 --- a/internal/api/client/notification/notificationsclear.go +++ /dev/null @@ -1,80 +0,0 @@ -/* - GoToSocial - Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org - - 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 <http://www.gnu.org/licenses/>. -*/ - -package notification - -import ( - "net/http" - - "github.com/gin-gonic/gin" - "github.com/superseriousbusiness/gotosocial/internal/api" - "github.com/superseriousbusiness/gotosocial/internal/gtserror" - "github.com/superseriousbusiness/gotosocial/internal/oauth" -) - -// NotificationsClearPOSTHandler swagger:operation POST /api/v1/notifications clearNotifications -// -// Clear/delete all notifications for currently authorized user. -// -// Will return an empty object `{}` to indicate success. -// -// --- -// tags: -// - notifications -// -// produces: -// - application/json -// -// security: -// - OAuth2 Bearer: -// - read:notifications -// -// responses: -// '200': -// schema: -// type: object -// '400': -// description: bad request -// '401': -// description: unauthorized -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error -func (m *Module) NotificationsClearPOSTHandler(c *gin.Context) { - authed, err := oauth.Authed(c, true, true, true, true) - if err != nil { - api.ErrorHandler(c, gtserror.NewErrorUnauthorized(err, err.Error()), m.processor.InstanceGet) - return - } - - if _, err := api.NegotiateAccept(c, api.JSONAcceptHeaders...); err != nil { - api.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGet) - return - } - - errWithCode := m.processor.NotificationsClear(c.Request.Context(), authed) - if errWithCode != nil { - api.ErrorHandler(c, errWithCode, m.processor.InstanceGet) - return - } - - c.JSON(http.StatusOK, struct{}{}) -} diff --git a/internal/api/client/notification/notificationsget.go b/internal/api/client/notification/notificationsget.go deleted file mode 100644 index d6b3f5162..000000000 --- a/internal/api/client/notification/notificationsget.go +++ /dev/null @@ -1,159 +0,0 @@ -/* - GoToSocial - Copyright (C) 2021-2022 GoToSocial Authors admin@gotosocial.org - - 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 <http://www.gnu.org/licenses/>. -*/ - -package notification - -import ( - "fmt" - "net/http" - "strconv" - - "github.com/gin-gonic/gin" - "github.com/superseriousbusiness/gotosocial/internal/api" - "github.com/superseriousbusiness/gotosocial/internal/gtserror" - "github.com/superseriousbusiness/gotosocial/internal/oauth" -) - -// NotificationsGETHandler swagger:operation GET /api/v1/notifications notifications -// -// Get notifications for currently authorized user. -// -// The notifications will be returned in descending chronological order (newest first), with sequential IDs (bigger = newer). -// -// The next and previous queries can be parsed from the returned Link header. -// Example: -// -// ``` -// <https://example.org/api/v1/notifications?limit=80&max_id=01FC0SKA48HNSVR6YKZCQGS2V8>; rel="next", <https://example.org/api/v1/notifications?limit=80&since_id=01FC0SKW5JK2Q4EVAV2B462YY0>; rel="prev" -// ```` -// -// --- -// tags: -// - notifications -// -// produces: -// - application/json -// -// parameters: -// - -// name: limit -// type: integer -// description: Number of notifications to return. -// default: 20 -// in: query -// required: false -// - -// name: exclude_types -// type: array -// items: -// type: string -// description: Array of types of notifications to exclude (follow, favourite, reblog, mention, poll, follow_request) -// in: query -// required: false -// - -// name: max_id -// type: string -// description: >- -// Return only notifications *OLDER* than the given max status ID. -// The status with the specified ID will not be included in the response. -// in: query -// required: false -// - -// name: since_id -// type: string -// description: |- -// Return only notifications *NEWER* than the given since status ID. -// The status with the specified ID will not be included in the response. -// in: query -// required: false -// -// security: -// - OAuth2 Bearer: -// - read:notifications -// -// responses: -// '200': -// headers: -// Link: -// type: string -// description: Links to the next and previous queries. -// name: notifications -// description: Array of notifications. -// schema: -// type: array -// items: -// "$ref": "#/definitions/notification" -// '400': -// description: bad request -// '401': -// description: unauthorized -// '404': -// description: not found -// '406': -// description: not acceptable -// '500': -// description: internal server error -func (m *Module) NotificationsGETHandler(c *gin.Context) { - authed, err := oauth.Authed(c, true, true, true, true) - if err != nil { - api.ErrorHandler(c, gtserror.NewErrorUnauthorized(err, err.Error()), m.processor.InstanceGet) - return - } - - if _, err := api.NegotiateAccept(c, api.JSONAcceptHeaders...); err != nil { - api.ErrorHandler(c, gtserror.NewErrorNotAcceptable(err, err.Error()), m.processor.InstanceGet) - return - } - - limit := 20 - limitString := c.Query(LimitKey) - if limitString != "" { - i, err := strconv.ParseInt(limitString, 10, 32) - if err != nil { - err := fmt.Errorf("error parsing %s: %s", LimitKey, err) - api.ErrorHandler(c, gtserror.NewErrorBadRequest(err, err.Error()), m.processor.InstanceGet) - return - } - limit = int(i) - } - - maxID := "" - maxIDString := c.Query(MaxIDKey) - if maxIDString != "" { - maxID = maxIDString - } - - sinceID := "" - sinceIDString := c.Query(SinceIDKey) - if sinceIDString != "" { - sinceID = sinceIDString - } - - excludeTypes := c.QueryArray(ExcludeTypesKey) - - resp, errWithCode := m.processor.NotificationsGet(c.Request.Context(), authed, excludeTypes, limit, maxID, sinceID) - if errWithCode != nil { - api.ErrorHandler(c, errWithCode, m.processor.InstanceGet) - return - } - - if resp.LinkHeader != "" { - c.Header("Link", resp.LinkHeader) - } - c.JSON(http.StatusOK, resp.Items) -} |