Pierre-Olivier Mercier
e6c50b876e
Introduce dedicated input types (DomainUpdateInput, SessionInput) to limit writable fields on update endpoints, and add binding:required tags across model structs to improve validation and Swagger documentation accuracy.
105 lines
3.7 KiB
Go
105 lines
3.7 KiB
Go
// This file is part of the happyDomain (R) project.
|
|
// Copyright (c) 2020-2024 happyDomain
|
|
// Authors: Pierre-Olivier Mercier, et al.
|
|
//
|
|
// This program is offered under a commercial and under the AGPL license.
|
|
// For commercial licensing, contact us at <contact@happydomain.org>.
|
|
//
|
|
// For AGPL licensing:
|
|
// 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 <https://www.gnu.org/licenses/>.
|
|
|
|
package happydns
|
|
|
|
import (
|
|
"fmt"
|
|
"reflect"
|
|
)
|
|
|
|
type ServiceRestrictions struct {
|
|
// Alone restricts the service to be the only one for a given subdomain.
|
|
Alone bool `json:"alone,omitempty"`
|
|
|
|
// ExclusiveRR restricts the service to be present along with others given types.
|
|
ExclusiveRR []string `json:"exclusive,omitempty"`
|
|
|
|
// GLUE allows a service to be present under Leaf, as GLUE record.
|
|
GLUE bool `json:"glue,omitempty"`
|
|
|
|
// Leaf restricts the creation of subdomains under this kind of service (blocks NearAlone).
|
|
Leaf bool `json:"leaf,omitempty"`
|
|
|
|
// NearAlone allows a service to be present along with Alone restricted services (eg. services that will create sub-subdomain from their given subdomain).
|
|
NearAlone bool `json:"nearAlone,omitempty"`
|
|
|
|
// NeedTypes restricts the service to sources that are compatibles with ALL the given types.
|
|
NeedTypes []uint16 `json:"needTypes,omitempty"`
|
|
|
|
// RootOnly restricts the service to be present at the root of the domain only.
|
|
RootOnly bool `json:"rootOnly,omitempty"`
|
|
|
|
// Single restricts the service to be present only once per subdomain.
|
|
Single bool `json:"single,omitempty"`
|
|
}
|
|
|
|
type ServiceInfos struct {
|
|
Name string `json:"name" binding:"required"`
|
|
Type string `json:"_svctype" binding:"required"`
|
|
Icon string `json:"_svcicon,omitempty"`
|
|
Description string `json:"description" binding:"required"`
|
|
Family string `json:"family" binding:"required"`
|
|
Categories []string `json:"categories" binding:"required"`
|
|
RecordTypes []uint16 `json:"record_types" binding:"required"`
|
|
Tabs bool `json:"tabs,omitempty"`
|
|
Restrictions ServiceRestrictions `json:"restrictions,omitempty"`
|
|
}
|
|
|
|
type ServiceNotFoundError struct {
|
|
name string
|
|
}
|
|
|
|
func NewServiceNotFoundError(name string) *ServiceNotFoundError {
|
|
return &ServiceNotFoundError{
|
|
name,
|
|
}
|
|
}
|
|
|
|
func (err ServiceNotFoundError) Error() string {
|
|
return fmt.Sprintf("Unable to find corresponding service for `%s`.", err.name)
|
|
}
|
|
|
|
const (
|
|
SERVICE_FAMILY_ABSTRACT = "abstract"
|
|
SERVICE_FAMILY_HIDDEN = "hidden"
|
|
SERVICE_FAMILY_PROVIDER = "provider"
|
|
)
|
|
|
|
type ServiceCreator func() ServiceBody
|
|
type SubServiceCreator func() any
|
|
|
|
type ServiceSpecs struct {
|
|
Fields []Field `json:"fields,omitempty"`
|
|
}
|
|
|
|
// ServiceInitializer is an optional interface that services can implement
|
|
// to provide custom initialization logic for creating new service instances.
|
|
type ServiceInitializer interface {
|
|
Initialize() (any, error)
|
|
}
|
|
|
|
type ServiceSpecsUsecase interface {
|
|
ListServices() map[string]ServiceInfos
|
|
GetServiceIcon(string) ([]byte, error)
|
|
GetServiceSpecs(reflect.Type) (*ServiceSpecs, error)
|
|
InitializeService(reflect.Type) (any, error)
|
|
}
|