mirror of
https://github.com/superseriousbusiness/gotosocial
synced 2024-12-11 16:20:16 +01:00
5e2bf0bdca
* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
80 lines
3.4 KiB
Go
80 lines
3.4 KiB
Go
// 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 <http://www.gnu.org/licenses/>.
|
|
|
|
package users
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/superseriousbusiness/gotosocial/internal/processing"
|
|
"github.com/superseriousbusiness/gotosocial/internal/uris"
|
|
)
|
|
|
|
const (
|
|
// UsernameKey is for account usernames.
|
|
UsernameKey = "username"
|
|
// StatusIDKey is for status IDs
|
|
StatusIDKey = "status"
|
|
// OnlyOtherAccountsKey is for filtering status responses.
|
|
OnlyOtherAccountsKey = "only_other_accounts"
|
|
// MinIDKey is for filtering status responses.
|
|
MinIDKey = "min_id"
|
|
// MaxIDKey is for filtering status responses.
|
|
MaxIDKey = "max_id"
|
|
// PageKey is for filtering status responses.
|
|
PageKey = "page"
|
|
|
|
// BasePath is the base path for serving AP 'users' requests, minus the 'users' prefix.
|
|
BasePath = "/:" + UsernameKey
|
|
// InboxPath is for serving POST requests to a user's inbox with the given username key.
|
|
InboxPath = BasePath + "/" + uris.InboxPath
|
|
// OutboxPath is for serving GET requests to a user's outbox with the given username key.
|
|
OutboxPath = BasePath + "/" + uris.OutboxPath
|
|
// FollowersPath is for serving GET request's to a user's followers list, with the given username key.
|
|
FollowersPath = BasePath + "/" + uris.FollowersPath
|
|
// FollowingPath is for serving GET request's to a user's following list, with the given username key.
|
|
FollowingPath = BasePath + "/" + uris.FollowingPath
|
|
// FeaturedCollectionPath is for serving GET requests to a user's list of featured (pinned) statuses.
|
|
FeaturedCollectionPath = BasePath + "/" + uris.CollectionsPath + "/" + uris.FeaturedPath
|
|
// StatusPath is for serving GET requests to a particular status by a user, with the given username key and status ID
|
|
StatusPath = BasePath + "/" + uris.StatusesPath + "/:" + StatusIDKey
|
|
// StatusRepliesPath is for serving the replies collection of a status.
|
|
StatusRepliesPath = StatusPath + "/replies"
|
|
)
|
|
|
|
type Module struct {
|
|
processor *processing.Processor
|
|
}
|
|
|
|
func New(processor *processing.Processor) *Module {
|
|
return &Module{
|
|
processor: processor,
|
|
}
|
|
}
|
|
|
|
func (m *Module) Route(attachHandler func(method string, path string, f ...gin.HandlerFunc) gin.IRoutes) {
|
|
attachHandler(http.MethodGet, BasePath, m.UsersGETHandler)
|
|
attachHandler(http.MethodPost, InboxPath, m.InboxPOSTHandler)
|
|
attachHandler(http.MethodGet, FollowersPath, m.FollowersGETHandler)
|
|
attachHandler(http.MethodGet, FollowingPath, m.FollowingGETHandler)
|
|
attachHandler(http.MethodGet, FeaturedCollectionPath, m.FeaturedCollectionGETHandler)
|
|
attachHandler(http.MethodGet, StatusPath, m.StatusGETHandler)
|
|
attachHandler(http.MethodGet, StatusRepliesPath, m.StatusRepliesGETHandler)
|
|
attachHandler(http.MethodGet, OutboxPath, m.OutboxGETHandler)
|
|
}
|