mk6i-open-oscar-server/server/http/types.go

package http

import (
	"context"
	"net/mail"
	"time"

	"github.com/mk6i/open-oscar-server/state"
	"github.com/mk6i/open-oscar-server/wire"
)

// AccountManager defines methods for managing user account attributes
// such as email, confirmation status, registration status, and suspension.
type AccountManager interface {
	// ConfirmStatus returns whether a user account has been confirmed.
	ConfirmStatus(ctx context.Context, screenName state.IdentScreenName) (bool, error)

	// EmailAddress looks up a user's email address by screen name.
	EmailAddress(ctx context.Context, screenName state.IdentScreenName) (*mail.Address, error)

	// RegStatus looks up a user's registration status by screen name.
	// It returns one of the following values:
	//   - wire.AdminInfoRegStatusFullDisclosure
	//   - wire.AdminInfoRegStatusLimitDisclosure
	//   - wire.AdminInfoRegStatusNoDisclosure
	RegStatus(ctx context.Context, screenName state.IdentScreenName) (uint16, error)

	// UpdateSuspendedStatus updates the suspension status of a user account.
	UpdateSuspendedStatus(ctx context.Context, suspendedStatus uint16, screenName state.IdentScreenName) error

	// SetBotStatus updates the flag that indicates whether the user is a bot.
	SetBotStatus(ctx context.Context, isBot bool, screenName state.IdentScreenName) error
}

// BARTAssetManager defines methods for managing BART (Buddy ART) assets.
type BARTAssetManager interface {
	// BARTItem retrieves a BART asset by its hash.
	BARTItem(ctx context.Context, hash []byte) ([]byte, error)

	// InsertBARTItem inserts a BART asset.
	InsertBARTItem(ctx context.Context, hash []byte, blob []byte, itemType uint16) error

	// ListBARTItems returns BART assets filtered by type.
	ListBARTItems(ctx context.Context, itemType uint16) ([]state.BARTItem, error)

	// DeleteBARTItem deletes a BART asset by hash.
	DeleteBARTItem(ctx context.Context, hash []byte) error
}

// BuddyBroadcaster defines a method for broadcasting presence updates.
type BuddyBroadcaster interface {
	// BroadcastVisibility sends presence updates to the specified filter list.
	// If sendDepartures is true, departure events are sent as well.
	BroadcastVisibility(ctx context.Context, you *state.SessionInstance, filter []state.IdentScreenName, sendDepartures bool) error
}

// ChatRoomCreator defines a method for creating a new chat room.
type ChatRoomCreator interface {
	// CreateChatRoom creates a new chat room.
	CreateChatRoom(ctx context.Context, chatRoom *state.ChatRoom) error
}

// ChatRoomRetriever defines a method for retrieving all chat rooms
// under a specific exchange.
type ChatRoomRetriever interface {
	// AllChatRooms returns all chat rooms associated with the given exchange ID.
	AllChatRooms(ctx context.Context, exchange uint16) ([]state.ChatRoom, error)
}

// ChatRoomDeleter defines a method for deleting chat rooms.
type ChatRoomDeleter interface {
	// DeleteChatRooms deletes chat rooms by their names under a specific exchange.
	DeleteChatRooms(ctx context.Context, exchange uint16, names []string) error
}

// ChatSessionRetriever defines a method for retrieving all sessions
// associated with a specific chat room.
type ChatSessionRetriever interface {
	// AllSessions returns all active sessions in the chat room identified by cookie.
	AllSessions(cookie string) []*state.Session
}

// DirectoryManager defines methods for managing interest categories and keywords
// used in user profiles and directory listings.
type DirectoryManager interface {
	// AIMDirectoryEntries returns the user directory listing of every user
	// who has directory info or keywords set.
	AIMDirectoryEntries(ctx context.Context) ([]state.AIMDirectoryEntry, error)

	// Categories returns all existing directory categories.
	Categories(ctx context.Context) ([]state.Category, error)

	// CreateCategory adds a new directory category.
	CreateCategory(ctx context.Context, name string) (state.Category, error)

	// CreateKeyword adds a new keyword to the specified category.
	CreateKeyword(ctx context.Context, name string, categoryID uint8) (state.Keyword, error)

	// DeleteCategory removes a directory category by ID.
	DeleteCategory(ctx context.Context, categoryID uint8) error

	// DeleteKeyword removes a keyword by ID.
	DeleteKeyword(ctx context.Context, id uint8) error

	// KeywordsByCategory returns all keywords under the specified category.
	KeywordsByCategory(ctx context.Context, categoryID uint8) ([]state.Keyword, error)
}

// FeedBagRetriever defines methods for retrieving buddy list metadata.
type FeedBagRetriever interface {
	// BuddyIconMetadata retrieves a user's buddy icon metadata. It returns nil
	// if the user does not have a buddy icon.
	BuddyIconMetadata(ctx context.Context, screenName state.IdentScreenName) (*wire.BARTID, error)
}

// FeedbagManager defines methods for managing feedbag (buddy list) entries.
// This interface matches foodgroup.FeedbagManager and is implemented by state.SQLiteUserStore.
type FeedbagManager interface {
	// Feedbag retrieves all feedbag items for a user.
	Feedbag(ctx context.Context, screenName state.IdentScreenName) ([]wire.FeedbagItem, error)

	// FeedbagUpsert inserts or updates feedbag items.
	FeedbagUpsert(ctx context.Context, screenName state.IdentScreenName, items []wire.FeedbagItem) error

	// FeedbagDelete deletes feedbag items.
	FeedbagDelete(ctx context.Context, screenName state.IdentScreenName, items []wire.FeedbagItem) error
}

// MessageRelayer defines a method for sending a SNAC message to a specific screen name.
type MessageRelayer interface {
	// RelayToScreenName sends the given SNAC message to the specified screen name.
	RelayToScreenName(ctx context.Context, screenName state.IdentScreenName, msg wire.SNACMessage)
}

// ICBMSender sends an instant message from the given sender instance as if
// the sender submitted wire.ICBMChannelMsgToHost.
type ICBMSender func(ctx context.Context, instance *state.SessionInstance, inFrame wire.SNACFrame, inBody wire.SNAC_0x04_0x06_ICBMChannelMsgToHost) (*wire.SNACMessage, error)

// ProfileRetriever defines a method for retrieving a user's free-form profile.
type ProfileRetriever interface {
	// Profile returns the user's profile information for the given screen name.
	Profile(ctx context.Context, screenName state.IdentScreenName) (state.UserProfile, error)
}

// SessionRetriever defines methods for retrieving active sessions,
// either all of them or by screen name.
type SessionRetriever interface {
	// AllSessions returns all active user sessions.
	AllSessions() []*state.Session

	// RetrieveSession returns the session associated with the given screen name,
	// or nil if no active session exists. Returns the Session object if there
	// are active instances with complete signon.
	RetrieveSession(screenName state.IdentScreenName) *state.Session
}

// UserManager defines methods for accessing and inserting AIM user records.
type UserManager interface {
	// AllUsers returns all registered users.
	AllUsers(ctx context.Context) ([]state.User, error)

	// DeleteUser removes a user from the system by screen name.
	DeleteUser(ctx context.Context, screenName state.IdentScreenName) error

	// InsertUser inserts a new user into the system. Return state.ErrDupUser
	// if a user with the same screen name already exists.
	InsertUser(ctx context.Context, u state.User) error

	// SetUserPassword sets the user's password hashes and auth key.
	SetUserPassword(ctx context.Context, screenName state.IdentScreenName, newPassword string) error

	// User returns all attributes for a user.
	User(ctx context.Context, screenName state.IdentScreenName) (*state.User, error)
}

// ICQProfileManager defines methods for getting and setting ICQ user profile data.
type ICQProfileManager interface {
	// User returns all attributes for a user.
	User(ctx context.Context, screenName state.IdentScreenName) (*state.User, error)

	// SetBasicInfo updates the user's basic ICQ profile info.
	SetBasicInfo(ctx context.Context, name state.IdentScreenName, data state.ICQBasicInfo) error

	// SetMoreInfo updates the user's additional ICQ info.
	SetMoreInfo(ctx context.Context, name state.IdentScreenName, data state.ICQMoreInfo) error

	// SetWorkInfo updates the user's work info.
	SetWorkInfo(ctx context.Context, name state.IdentScreenName, data state.ICQWorkInfo) error

	// SetUserNotes updates the user's notes.
	SetUserNotes(ctx context.Context, name state.IdentScreenName, data state.ICQUserNotes) error

	// SetInterests updates the user's interests.
	SetInterests(ctx context.Context, name state.IdentScreenName, data state.ICQInterests) error

	// SetAffiliations updates the user's affiliations.
	SetAffiliations(ctx context.Context, name state.IdentScreenName, data state.ICQAffiliations) error

	// SetPermissions updates the user's privacy permissions.
	SetPermissions(ctx context.Context, name state.IdentScreenName, data state.ICQPermissions) error

	// SetICQInfo updates all ICQ profile columns for the user in one operation.
	SetICQInfo(ctx context.Context, name state.IdentScreenName, info state.ICQInfo) error
}

type userWithPassword struct {
	ScreenName string `json:"screen_name"`
	Password   string `json:"password,omitempty"`
}

type onlineUsers struct {
	Count    int             `json:"count"`
	Sessions []sessionHandle `json:"sessions"`
}

type userHandle struct {
	ID              string `json:"id"`
	ScreenName      string `json:"screen_name"`
	IsICQ           bool   `json:"is_icq"`
	SuspendedStatus string `json:"suspended_status"`
	IsBot           bool   `json:"is_bot"`
}

type aimChatUserHandle struct {
	ID         string `json:"id"`
	ScreenName string `json:"screen_name"`
}

type userAccountHandle struct {
	ID              string `json:"id"`
	ScreenName      string `json:"screen_name"`
	Profile         string `json:"profile"`
	EmailAddress    string `json:"email_address"`
	RegStatus       uint16 `json:"reg_status"`
	Confirmed       bool   `json:"confirmed"`
	IsICQ           bool   `json:"is_icq"`
	SuspendedStatus string `json:"suspended_status"`
	IsBot           bool   `json:"is_bot"`
}

type userAccountPatch struct {
	SuspendedStatusText *string `json:"suspended_status"`
	IsBot               *bool   `json:"is_bot"`
}

type sessionHandle struct {
	ID            string           `json:"id"`
	ScreenName    string           `json:"screen_name"`
	OnlineSeconds int              `json:"online_seconds"`
	IsAway        bool             `json:"is_away"`
	AwayMessage   string           `json:"away_message"`
	IdleSeconds   int              `json:"idle_seconds"`
	IsInvisible   bool             `json:"is_invisible"`
	IsICQ         bool             `json:"is_icq"`
	InstanceCount int              `json:"instance_count"`
	Instances     []instanceHandle `json:"instances"`
}

type instanceHandle struct {
	Num         int    `json:"num"`
	IdleSeconds int    `json:"idle_seconds"`
	IsAway      bool   `json:"is_away"`
	AwayMessage string `json:"away_message"`
	IsInvisible bool   `json:"is_invisible"`
	RemoteAddr  string `json:"remote_addr"`
	RemotePort  int    `json:"remote_port"`
	ClientID    string `json:"client_id"`
}

type chatRoomCreate struct {
	Name string `json:"name"`
}

type chatRoomDelete struct {
	Names []string `json:"names"`
}

type chatRoom struct {
	Name         string              `json:"name"`
	CreateTime   time.Time           `json:"create_time"`
	CreatorID    string              `json:"creator_id,omitempty"`
	URL          string              `json:"url"`
	Participants []aimChatUserHandle `json:"participants"`
}

type instantMessage struct {
	From         string `json:"from"`
	To           string `json:"to"`
	Text         string `json:"text"`
	StoreOffline bool   `json:"storeOffline"`
}

type directoryKeyword struct {
	ID   uint8  `json:"id"`
	Name string `json:"name"`
}

type directoryCategory struct {
	ID   uint8  `json:"id"`
	Name string `json:"name"`
}

type aimDirectoryEntryHandle struct {
	ScreenName string   `json:"screen_name"`
	FirstName  string   `json:"first_name"`
	MiddleName string   `json:"middle_name"`
	LastName   string   `json:"last_name"`
	MaidenName string   `json:"maiden_name"`
	Nickname   string   `json:"nickname"`
	City       string   `json:"city"`
	State      string   `json:"state"`
	Country    string   `json:"country"`
	Address    string   `json:"address"`
	ZIP        string   `json:"zip"`
	Keywords   []string `json:"keywords"`
}

type directoryCategoryCreate struct {
	Name string `json:"name"`
}

type directoryKeywordCreate struct {
	CategoryID uint8  `json:"category_id"`
	Name       string `json:"name"`
}

type messageBody struct {
	Message string `json:"message"`
}

type feedbagGroupHandle struct {
	GroupID   uint16 `json:"group_id"`
	GroupName string `json:"group_name"`
}

func feedbagGroupFromItem(item wire.FeedbagItem) feedbagGroupHandle {
	return feedbagGroupHandle{
		GroupID:   item.GroupID,
		GroupName: item.Name,
	}
}

// icqProfileHandle is the JSON representation of a full ICQ user profile.
type icqProfileHandle struct {
	UIN          uint32                `json:"uin"`
	BasicInfo    icqBasicInfoHandle    `json:"basic_info"`
	MoreInfo     icqMoreInfoHandle     `json:"more_info"`
	WorkInfo     icqWorkInfoHandle     `json:"work_info"`
	Notes        string                `json:"notes"`
	Interests    icqInterestsHandle    `json:"interests"`
	Affiliations icqAffiliationsHandle `json:"affiliations"`
	Permissions  icqPermissionsHandle  `json:"permissions"`
}

type icqBasicInfoHandle struct {
	Nickname     string `json:"nickname"`
	FirstName    string `json:"first_name"`
	LastName     string `json:"last_name"`
	EmailAddress string `json:"email"`
	City         string `json:"city"`
	State        string `json:"state"`
	Phone        string `json:"phone"`
	Fax          string `json:"fax"`
	Address      string `json:"address"`
	CellPhone    string `json:"cell_phone"`
	ZIPCode      string `json:"zip"`
	CountryCode  uint16 `json:"country_code"`
	GMTOffset    uint8  `json:"gmt_offset"`
	PublishEmail bool   `json:"publish_email"`
	OriginCity   string `json:"origin_city"`
	OriginState  string `json:"origin_state"`
	// OriginCountryCode is the ICQ country code for the user's original home.
	OriginCountryCode uint16 `json:"origin_country_code"`
}

type icqMoreInfoHandle struct {
	Gender       uint16 `json:"gender"`
	HomePageAddr string `json:"homepage"`
	BirthYear    uint16 `json:"birth_year"`
	BirthMonth   uint8  `json:"birth_month"`
	BirthDay     uint8  `json:"birth_day"`
	Lang1        uint8  `json:"lang1"`
	Lang2        uint8  `json:"lang2"`
	Lang3        uint8  `json:"lang3"`
}

type icqWorkInfoHandle struct {
	Company        string `json:"company"`
	Department     string `json:"department"`
	Position       string `json:"position"`
	OccupationCode uint16 `json:"occupation_code"`
	Address        string `json:"address"`
	City           string `json:"city"`
	State          string `json:"state"`
	ZIPCode        string `json:"zip"`
	CountryCode    uint16 `json:"country_code"`
	Phone          string `json:"phone"`
	Fax            string `json:"fax"`
	WebPage        string `json:"web_page"`
}

type icqInterestsHandle struct {
	Code1    uint16 `json:"code1"`
	Keyword1 string `json:"keyword1"`
	Code2    uint16 `json:"code2"`
	Keyword2 string `json:"keyword2"`
	Code3    uint16 `json:"code3"`
	Keyword3 string `json:"keyword3"`
	Code4    uint16 `json:"code4"`
	Keyword4 string `json:"keyword4"`
}

type icqAffiliationsHandle struct {
	PastCode1       uint16 `json:"past_code1"`
	PastKeyword1    string `json:"past_keyword1"`
	PastCode2       uint16 `json:"past_code2"`
	PastKeyword2    string `json:"past_keyword2"`
	PastCode3       uint16 `json:"past_code3"`
	PastKeyword3    string `json:"past_keyword3"`
	CurrentCode1    uint16 `json:"current_code1"`
	CurrentKeyword1 string `json:"current_keyword1"`
	CurrentCode2    uint16 `json:"current_code2"`
	CurrentKeyword2 string `json:"current_keyword2"`
	CurrentCode3    uint16 `json:"current_code3"`
	CurrentKeyword3 string `json:"current_keyword3"`
}

type icqPermissionsHandle struct {
	AuthRequired bool `json:"auth_required"`
	WebAware     bool `json:"web_aware"`
	AllowSpam    bool `json:"allow_spam"`
}