go-ssb-room/admindb/types.go

// SPDX-License-Identifier: MIT

package admindb

import (
	"database/sql/driver"
	"errors"
	"fmt"

	refs "go.mindeco.de/ssb-refs"
)

// ErrNotFound is returned by the admin db if an object couldn't be found.
var ErrNotFound = errors.New("admindb: object not found")

// It's important to wrap all the model generated types into these since we don't want the admindb interfaces to depend on them.

// User holds all the information an authenticated user of the site has.
type User struct {
	ID   int64
	Name string
}

type ErrAlreadyAdded struct {
	Ref refs.FeedRef
}

func (aa ErrAlreadyAdded) Error() string {
	return fmt.Sprintf("admindb: the item (%s) is already on the list", aa.Ref.Ref())
}

// ListEntry values are returned by Allow- and DenyListServices
type ListEntry struct {
	ID     int64
	PubKey refs.FeedRef
}

// ListEntries is a slice of ListEntries
type ListEntries []ListEntry

// DBFeedRef wraps a feed reference and implements the SQL marshaling interfaces.
type DBFeedRef struct{ refs.FeedRef }

// Scan implements https://pkg.go.dev/database/sql#Scanner to read strings into feed references.
func (r *DBFeedRef) Scan(src interface{}) error {
	str, ok := src.(string)
	if !ok {
		return fmt.Errorf("unexpected type: %T", src)
	}

	fr, err := refs.ParseFeedRef(str)
	if err != nil {
		return err
	}

	r.FeedRef = *fr
	return nil
}

// Value returns feed references as strings to the database.
// https://pkg.go.dev/database/sql/driver#Valuer
func (r DBFeedRef) Value() (driver.Value, error) {
	return driver.Value(r.Ref()), nil
}

// PinnedNoticeName holds a name of a well known part of the page with a fixed location.
// These also double as the i18n labels.
type PinnedNoticeName string

// These are the well known names that the room page will display
const (
	NoticeDescription   PinnedNoticeName = "NoticeDescription"
	NoticeNews          PinnedNoticeName = "NoticeNews"
	NoticePrivacyPolicy PinnedNoticeName = "NoticePrivacyPolicy"
	NoticeCodeOfConduct PinnedNoticeName = "NoticeCodeOfConduct"
)

// Valid returns true if the page name is well known.
func (fpn PinnedNoticeName) Valid() bool {
	return fpn == NoticeNews ||
		fpn == NoticeDescription ||
		fpn == NoticePrivacyPolicy ||
		fpn == NoticeCodeOfConduct
}

// Notice holds the title and content of a page that is user generated
type Notice struct {
	ID       int64
	Title    string
	Content  string
	Language string
}