summaryrefslogtreecommitdiff
path: root/internal/api/client/admin/admin.go
blob: 1b9ea302d6b305806b23c967d0e98bca8479f7e6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*
   GoToSocial
   Copyright (C) 2021-2023 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 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)
}