mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-30 22:22:25 -05:00
43f1c6d872
# Description > If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements. > > If this is a documentation change, please briefly describe what you've changed and why. Does as it says on the tin! Should make things a bit easier for clients that don't provide an access token to the custom emojis endpoint. Closes https://codeberg.org/superseriousbusiness/gotosocial/issues/2430 ## Checklist Please put an x inside each checkbox to indicate that you've read and followed it: `[ ]` -> `[x]` If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want). - [x] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md). - [x] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat. - [x] I/we have not leveraged AI to create the proposed changes. - [x] I/we have performed a self-review of added code. - [x] I/we have written code that is legible and maintainable by others. - [x] I/we have commented the added code, particularly in hard-to-understand areas. - [x] I/we have made any necessary changes to documentation. - [ ] I/we have added tests that cover new code. - [x] I/we have run tests and they pass locally with the changes. - [x] I/we have run `go fmt ./...` and `golangci-lint run`. Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4233 Reviewed-by: Daenney <daenney@noreply.codeberg.org> Co-authored-by: tobi <tobi.smethurst@protonmail.com> Co-committed-by: tobi <tobi.smethurst@protonmail.com>
126 lines
4.8 KiB
Go
126 lines
4.8 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 util
|
|
|
|
import (
|
|
"strings"
|
|
)
|
|
|
|
type Scope string
|
|
|
|
const (
|
|
/* Sub-scopes / scope components */
|
|
|
|
scopeAccounts = "accounts"
|
|
scopeApplications = "applications"
|
|
scopeBlocks = "blocks"
|
|
scopeBookmarks = "bookmarks"
|
|
scopeConversations = "conversations"
|
|
scopeCustomEmojis = "custom_emojis"
|
|
scopeDomainAllows = "domain_allows"
|
|
scopeDomainBlocks = "domain_blocks"
|
|
scopeFavourites = "favourites"
|
|
scopeFilters = "filters"
|
|
scopeFollows = "follows"
|
|
scopeLists = "lists"
|
|
scopeMedia = "media"
|
|
scopeMutes = "mutes"
|
|
scopeNotifications = "notifications"
|
|
scopeReports = "reports"
|
|
scopeSearch = "search"
|
|
scopeStatuses = "statuses"
|
|
|
|
/* Top-level scopes */
|
|
|
|
ScopeProfile Scope = "profile"
|
|
ScopePush Scope = "push"
|
|
ScopeRead Scope = "read"
|
|
ScopeWrite Scope = "write"
|
|
ScopeAdmin Scope = "admin"
|
|
ScopeAdminRead Scope = ScopeAdmin + ":" + ScopeRead
|
|
ScopeAdminWrite Scope = ScopeAdmin + ":" + ScopeWrite
|
|
|
|
/* Granular scopes */
|
|
|
|
ScopeReadAccounts Scope = ScopeRead + ":" + scopeAccounts
|
|
ScopeWriteAccounts Scope = ScopeWrite + ":" + scopeAccounts
|
|
ScopeReadApplications Scope = ScopeRead + ":" + scopeApplications
|
|
ScopeWriteApplications Scope = ScopeWrite + ":" + scopeApplications
|
|
ScopeReadBlocks Scope = ScopeRead + ":" + scopeBlocks
|
|
ScopeWriteBlocks Scope = ScopeWrite + ":" + scopeBlocks
|
|
ScopeReadBookmarks Scope = ScopeRead + ":" + scopeBookmarks
|
|
ScopeWriteBookmarks Scope = ScopeWrite + ":" + scopeBookmarks
|
|
ScopeWriteConversations Scope = ScopeWrite + ":" + scopeConversations
|
|
ScopeReadCustomEmojis Scope = ScopeRead + ":" + scopeCustomEmojis
|
|
ScopeReadFavourites Scope = ScopeRead + ":" + scopeFavourites
|
|
ScopeWriteFavourites Scope = ScopeWrite + ":" + scopeFavourites
|
|
ScopeReadFilters Scope = ScopeRead + ":" + scopeFilters
|
|
ScopeWriteFilters Scope = ScopeWrite + ":" + scopeFilters
|
|
ScopeReadFollows Scope = ScopeRead + ":" + scopeFollows
|
|
ScopeWriteFollows Scope = ScopeWrite + ":" + scopeFollows
|
|
ScopeReadLists Scope = ScopeRead + ":" + scopeLists
|
|
ScopeWriteLists Scope = ScopeWrite + ":" + scopeLists
|
|
ScopeWriteMedia Scope = ScopeWrite + ":" + scopeMedia
|
|
ScopeReadMutes Scope = ScopeRead + ":" + scopeMutes
|
|
ScopeWriteMutes Scope = ScopeWrite + ":" + scopeMutes
|
|
ScopeReadNotifications Scope = ScopeRead + ":" + scopeNotifications
|
|
ScopeWriteNotifications Scope = ScopeWrite + ":" + scopeNotifications
|
|
ScopeWriteReports Scope = ScopeWrite + ":" + scopeReports
|
|
ScopeReadSearch Scope = ScopeRead + ":" + scopeSearch
|
|
ScopeReadStatuses Scope = ScopeRead + ":" + scopeStatuses
|
|
ScopeWriteStatuses Scope = ScopeWrite + ":" + scopeStatuses
|
|
ScopeAdminReadAccounts Scope = ScopeAdminRead + ":" + scopeAccounts
|
|
ScopeAdminWriteAccounts Scope = ScopeAdminWrite + ":" + scopeAccounts
|
|
ScopeAdminReadReports Scope = ScopeAdminRead + ":" + scopeReports
|
|
ScopeAdminWriteReports Scope = ScopeAdminWrite + ":" + scopeReports
|
|
ScopeAdminReadDomainAllows Scope = ScopeAdminRead + ":" + scopeDomainAllows
|
|
ScopeAdminWriteDomainAllows Scope = ScopeAdminWrite + ":" + scopeDomainAllows
|
|
ScopeAdminReadDomainBlocks Scope = ScopeAdminRead + ":" + scopeDomainBlocks
|
|
ScopeAdminWriteDomainBlocks Scope = ScopeAdminWrite + ":" + scopeDomainBlocks
|
|
)
|
|
|
|
// Permits returns true if the
|
|
// scope permits the wanted scope.
|
|
func (has Scope) Permits(wanted Scope) bool {
|
|
if has == wanted {
|
|
// Exact match on either a
|
|
// top-level or granular scope.
|
|
return true
|
|
}
|
|
|
|
// Ensure we have a
|
|
// known top-level scope.
|
|
switch has {
|
|
|
|
case ScopeProfile,
|
|
ScopePush,
|
|
ScopeRead,
|
|
ScopeWrite,
|
|
ScopeAdmin,
|
|
ScopeAdminRead,
|
|
ScopeAdminWrite:
|
|
// Check if top-level includes wanted,
|
|
// eg., have "admin", want "admin:read".
|
|
return strings.HasPrefix(string(wanted), string(has)+":")
|
|
|
|
default:
|
|
// Unknown top-level scope,
|
|
// can't permit anything.
|
|
return false
|
|
}
|
|
}
|