mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2024-05-18 04:22:40 +00: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
121 lines
5.1 KiB
Go
121 lines
5.1 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 admin
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
"github.com/superseriousbusiness/gotosocial/internal/processing"
|
|
)
|
|
|
|
const (
|
|
// BasePath is the base API path for this module, excluding the api prefix
|
|
BasePath = "/v1/admin"
|
|
// EmojiPath is used for posting/deleting custom emojis.
|
|
EmojiPath = BasePath + "/custom_emojis"
|
|
// EmojiPathWithID is used for interacting with a single emoji.
|
|
EmojiPathWithID = EmojiPath + "/:" + IDKey
|
|
// EmojiCategoriesPath is used for interacting with emoji categories.
|
|
EmojiCategoriesPath = EmojiPath + "/categories"
|
|
// DomainBlocksPath is used for posting domain blocks.
|
|
DomainBlocksPath = BasePath + "/domain_blocks"
|
|
// DomainBlocksPathWithID is used for interacting with a single domain block.
|
|
DomainBlocksPathWithID = DomainBlocksPath + "/:" + IDKey
|
|
// AccountsPath is used for listing + acting on accounts.
|
|
AccountsPath = BasePath + "/accounts"
|
|
// AccountsPathWithID is used for interacting with a single account.
|
|
AccountsPathWithID = AccountsPath + "/:" + IDKey
|
|
// AccountsActionPath is used for taking action on a single account.
|
|
AccountsActionPath = AccountsPathWithID + "/action"
|
|
MediaCleanupPath = BasePath + "/media_cleanup"
|
|
MediaRefetchPath = BasePath + "/media_refetch"
|
|
// ReportsPath is for serving admin view of user reports.
|
|
ReportsPath = BasePath + "/reports"
|
|
// ReportsPathWithID is for viewing/acting on one report.
|
|
ReportsPathWithID = ReportsPath + "/:" + IDKey
|
|
// ReportsResolvePath is for marking one report as resolved.
|
|
ReportsResolvePath = ReportsPathWithID + "/resolve"
|
|
|
|
// ExportQueryKey is for requesting a public export of some data.
|
|
ExportQueryKey = "export"
|
|
// ImportQueryKey is for submitting an import of some data.
|
|
ImportQueryKey = "import"
|
|
// IDKey specifies the ID of a single item being interacted with.
|
|
IDKey = "id"
|
|
// FilterKey is for applying filters to admin views of accounts, emojis, etc.
|
|
FilterQueryKey = "filter"
|
|
// MaxShortcodeDomainKey is the url query for returning emoji results lower (alphabetically)
|
|
// than the given `[shortcode]@[domain]` parameter.
|
|
MaxShortcodeDomainKey = "max_shortcode_domain"
|
|
// MaxShortcodeDomainKey is the url query for returning emoji results higher (alphabetically)
|
|
// than the given `[shortcode]@[domain]` parameter.
|
|
MinShortcodeDomainKey = "min_shortcode_domain"
|
|
// LimitKey is for specifying maximum number of results to return.
|
|
LimitKey = "limit"
|
|
// DomainQueryKey is for specifying a domain during admin actions.
|
|
DomainQueryKey = "domain"
|
|
// ResolvedKey is for filtering reports by their resolved status
|
|
ResolvedKey = "resolved"
|
|
// AccountIDKey is for selecting account in API paths.
|
|
AccountIDKey = "account_id"
|
|
// TargetAccountIDKey is for selecting target account in API paths.
|
|
TargetAccountIDKey = "target_account_id"
|
|
MaxIDKey = "max_id"
|
|
SinceIDKey = "since_id"
|
|
MinIDKey = "min_id"
|
|
)
|
|
|
|
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) {
|
|
// emoji stuff
|
|
attachHandler(http.MethodPost, EmojiPath, m.EmojiCreatePOSTHandler)
|
|
attachHandler(http.MethodGet, EmojiPath, m.EmojisGETHandler)
|
|
attachHandler(http.MethodDelete, EmojiPathWithID, m.EmojiDELETEHandler)
|
|
attachHandler(http.MethodGet, EmojiPathWithID, m.EmojiGETHandler)
|
|
attachHandler(http.MethodPatch, EmojiPathWithID, m.EmojiPATCHHandler)
|
|
attachHandler(http.MethodGet, EmojiCategoriesPath, m.EmojiCategoriesGETHandler)
|
|
|
|
// domain block stuff
|
|
attachHandler(http.MethodPost, DomainBlocksPath, m.DomainBlocksPOSTHandler)
|
|
attachHandler(http.MethodGet, DomainBlocksPath, m.DomainBlocksGETHandler)
|
|
attachHandler(http.MethodGet, DomainBlocksPathWithID, m.DomainBlockGETHandler)
|
|
attachHandler(http.MethodDelete, DomainBlocksPathWithID, m.DomainBlockDELETEHandler)
|
|
|
|
// accounts stuff
|
|
attachHandler(http.MethodPost, AccountsActionPath, m.AccountActionPOSTHandler)
|
|
|
|
// media stuff
|
|
attachHandler(http.MethodPost, MediaCleanupPath, m.MediaCleanupPOSTHandler)
|
|
attachHandler(http.MethodPost, MediaRefetchPath, m.MediaRefetchPOSTHandler)
|
|
|
|
// reports stuff
|
|
attachHandler(http.MethodGet, ReportsPath, m.ReportsGETHandler)
|
|
attachHandler(http.MethodGet, ReportsPathWithID, m.ReportGETHandler)
|
|
attachHandler(http.MethodPost, ReportsResolvePath, m.ReportResolvePOSTHandler)
|
|
}
|