services

type ArchiveService interface {
	GetComicInfo(archive string) (*comicinfo.ComicInfo, error)
	GetCover(archive string) ([]byte, error)
}

type AuthService interface {
	// IsAuthenticated checks the current request for authentication. This should be handled by the middleware
	IsAuthenticated(ctx *fiber.Ctx) (bool, error)

	// Login logs the current user in.
	Login(loginRequest payload.LoginRequest) (*payload.LoginResponse, error)

	Middleware(ctx *fiber.Ctx) error
}

type CacheService interface {
	fiber.Storage
	Type() config.CacheType
}

type Client interface {
	// Download starts the download of the Content associated with the id. The returned error
	// might be because of the Content already have been added, or because of an error with the data
	// provider to create the Content
	Download(payload.DownloadRequest) error
	// RemoveDownload stops the download of the Content associated with the id. Will start cleanup,
	// should only return an error if the id has no associated Content
	RemoveDownload(payload.StopRequest) error
	// Content returns the Content associated with the passed id. If none is found, returns nil
	Content(string) Content
}

type Content interface {
	// Id returns a string that uniquely identifies this Content
	Id() string
	// Title returns the title of the Content, depending on how much info has been loaded, this may be equal to Id
	Title() string
	// Provider returns the provider this Content uses
	Provider() models.Provider
	// GetInfo returns the information to be displayed in the UI
	GetInfo() payload.InfoStat
	// State returns the payload.ContentState this Content currently is in
	State() payload.ContentState
	// SetState updates the state, and propagates to SignalR
	SetState(state payload.ContentState)
	// Message passes any payload.Message to the Content, and returns its response
	// The logic of what happens with the message may depend on the underlying Content
	Message(payload.Message) (payload.Message, error)
	// Request returns the original request made to start this content
	Request() payload.DownloadRequest
}

type ContentService interface {
	Search(payload.SearchRequest) ([]payload.Info, error)
	Download(payload.DownloadRequest) error
	DownloadSubscription(*models.Subscription, ...bool) error
	Stop(payload.StopRequest) error
	RegisterProvider(models.Provider, ProviderAdapter)
	DownloadMetadata(models.Provider) (payload.DownloadMetadata, error)
	Message(payload.Message) (payload.Message, error)
}

type CronService interface {
	NewJob(gocron.JobDefinition, gocron.Task, ...gocron.JobOption) (gocron.Job, error)
	RemoveJob(uuid.UUID) error
	Update(uuid.UUID, gocron.JobDefinition, gocron.Task, ...gocron.JobOption) (gocron.Job, error)
}

type DirectoryService interface {
	// ZipToCbz calls ZipFolder(folderPath, folderPath+".cbz")
	ZipToCbz(folderPath string) error
	ZipFolder(folderPath string, zipFileName string) error

	MoveDirectoryContent(src, dest string) error
}

type FileService interface{}

type ImageService interface {
	// Better check if candidateImg is similar to defaultImg with MSE. If the similarityThreshold (default 0.85)
	// is reached, returns the highest resolution one. Otherwise defaultImg
	Better(defaultImg, candidateImg []byte, similarityThresholds ...float64) ([]byte, bool, error)
	Similar(img1, img2 image.Image) float64
	MeanSquareError(img1, img2 image.Image) float64
	IsCover(data []byte) bool
	ToImage(data []byte) (image.Image, error)
	ConvertToWebp(data []byte) ([]byte, bool)
}

type MarkdownService interface {
	MdToSafeHtml(string) string
	SanitizeHtml(string) string
}

type MetadataService interface {
	Get() (payload.Metadata, error)
	Update(payload.Metadata) error
}

type MpClaims struct {
	User models.User `json:"user,omitempty"`
	jwt.RegisteredClaims
}

type NotificationService interface {
	Notify(models.Notification)
	// NotifyHelper constructs the struct, and calls Notify
	NotifyHelper(title, summary, body string, colour models.NotificationColour, group models.NotificationGroup)

	// NotifyContent calls NotifyHelper with GroupContent, default colour is blue(info)
	NotifyContent(title, summary, body string, colours ...models.NotificationColour)
	// NotifyContentQ calls NotifyContent with summary being the first 40 characters of body
	NotifyContentQ(title, body string, colours ...models.NotificationColour)

	// NotifySecurity calls NotifyHelper with GroupSecurity, default colour is orange(warn)
	NotifySecurity(title, summary, body string, colours ...models.NotificationColour)
	// NotifySecurityQ calls NotifySecurity with summary being the first 40 characters of body
	NotifySecurityQ(title, body string, colours ...models.NotificationColour)

	// NotifyGeneral calls NotifyHelper with GroupGeneral, default colour is white(secondary)
	NotifyGeneral(title, summary, body string, colours ...models.NotificationColour)
	// NotifyGeneralQ calls NotifyGeneral with summary being the first 40 characters of body
	NotifyGeneralQ(title, body string, colours ...models.NotificationColour)

	// MarkRead marks the notification with id as read, and sends the NotificationRead event through SignalR
	MarkRead(id uint) error
	// MarkReadMany marks all the notifications as read, and sends the NotificationRead event through SignalR
	MarkReadMany([]uint) error
	// MarkUnRead marks the notification with id as unread, and sends the Notification event through SignalR
	MarkUnRead(id uint) error
}

type Notifier interface {
	Notify(models.Notification)
}

type PageService interface {
	UpdateOrCreate(page *models.Page) error
	OrderPages([]uint) error
	LoadDefaultPages() error
}

type PreferencesService interface {
	Update(preference payload.PreferencesDto) error
	GetDto() (payload.PreferencesDto, error)
}

type ProviderAdapter interface {
	Search(payload.SearchRequest) ([]payload.Info, error)
	DownloadMetadata() payload.DownloadMetadata
	Client() Client
}

type SettingsService interface {
	GetSettingsDto() (payload.Settings, error)
	UpdateSettingsDto(settings payload.Settings) error
}

type SignalRParams struct {
	dig.In
	Log  zerolog.Logger
	Auth AuthService `name:"jwt-auth"`
}

type SignalRService interface {
	signalr.HubInterface

	Broadcast(eventType payload.EventType, data interface{})

	SizeUpdate(id string, size string)
	ProgressUpdate(data payload.ContentProgressUpdate)
	StateUpdate(id string, state payload.ContentState)

	AddContent(data payload.InfoStat)
	UpdateContentInfo(data payload.InfoStat)
	DeleteContent(id string)

	// Notify may be used directly by anyone to send a quick toast to the frontend.
	// Use NotificationService for notification that must persist
	Notify(notification models.Notification)
}

type SubscriptionService interface {
	// Get the subscription with ID
	Get(uint) (*models.Subscription, error)
	// All returns all active subscriptions
	All() ([]models.Subscription, error)
	// Add a new subscription, saved to DB and starts the cron job
	// Subscription is normalized in the process
	Add(models.Subscription) (*models.Subscription, error)
	// Update an existing subscription, updates DB. Subscription is normalized in the process
	Update(models.Subscription) error
	// Delete the subscription with ID
	Delete(uint) error

	// UpdateTask recreates the underlying cronjob. Generally only called when the hour to run susbcriptions changes
	UpdateTask(hour ...int) error
}

type TranslocoService interface {
	// GetTranslation calls GetTranslationLang with lang = DefaultLanguage
	GetTranslation(key string, params ...any) string
	// GetTranslationLang returns the formatted string if found, otherwise the key
	GetTranslationLang(lang, key string, params ...any) string
	// TryTranslationLang returns the formatted string if found, otherwise an appropriate error
	TryTranslationLang(lang, key string, params ...any) (string, error)

	// GetLanguages returns a list of all loaded languages
	GetLanguages() []string
}

type ValidationService interface {
	Validate(out any) error
	ValidateCtx(ctx *fiber.Ctx, out any) error
}