gotosocial/internal/gtsmodel/domainpermission.go
tobi 183eaa5b29
[feature] Implement explicit domain allows + allowlist federation mode (#2200)
* love like winter! wohoah, wohoah

* domain allow side effects

* tests! logging! unallow!

* document federation modes

* linty linterson

* test

* further adventures in documentation

* finish up domain block documentation (i think)

* change wording a wee little bit

* docs, example

* consolidate shared domainPermission code

* call mode once

* fetch federation mode within domain blocked func

* read domain perm import in streaming manner

* don't use pointer to slice for domain perms

* don't bother copying blocks + allows before deleting

* admonish!

* change wording just a scooch

* update docs
2023-09-21 12:12:04 +02:00

67 lines
1.9 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 gtsmodel
import "time"
// DomainPermission models a domain
// permission entry (block/allow).
type DomainPermission interface {
GetID() string
GetCreatedAt() time.Time
GetUpdatedAt() time.Time
GetDomain() string
GetCreatedByAccountID() string
GetCreatedByAccount() *Account
GetPrivateComment() string
GetPublicComment() string
GetObfuscate() *bool
GetSubscriptionID() string
GetType() DomainPermissionType
}
// Domain permission type.
type DomainPermissionType uint8
const (
DomainPermissionUnknown DomainPermissionType = iota
DomainPermissionBlock // Explicitly block a domain.
DomainPermissionAllow // Explicitly allow a domain.
)
func (p DomainPermissionType) String() string {
switch p {
case DomainPermissionBlock:
return "block"
case DomainPermissionAllow:
return "allow"
default:
return "unknown"
}
}
func NewDomainPermissionType(in string) DomainPermissionType {
switch in {
case "block":
return DomainPermissionBlock
case "allow":
return DomainPermissionAllow
default:
return DomainPermissionUnknown
}
}