model

type Account struct {
	ID       DBID       `db:"id"       json:"id"`
	Username string     `db:"username" json:"username"`
	Password string     `db:"password" json:"password,omitempty"`
	Owner    bool       `db:"owner"    json:"owner"`
	Config   UserConfig `db:"config"               json:"config"`
}

type AccountDTO struct {
	ID       DBID        `json:"id"`
	Username string      `json:"username"`
	Password string      `json:"passowrd,omitempty"` // Used only to store, not to retrieve
	Owner    *bool       `json:"owner"`
	Config   *UserConfig `json:"config"`
}

type AccountsDomain interface {
	ListAccounts(ctx context.Context) ([]AccountDTO, error)
	GetAccountByUsername(ctx context.Context, username string) (*AccountDTO, error)
	CreateAccount(ctx context.Context, account AccountDTO) (*AccountDTO, error)
	UpdateAccount(ctx context.Context, account AccountDTO) (*AccountDTO, error)
	DeleteAccount(ctx context.Context, id int) error
}

type ArchiverDomain interface {
	DownloadBookmarkArchive(book BookmarkDTO) (*BookmarkDTO, error)
	GetBookmarkArchive(book *BookmarkDTO) (*warc.Archive, error)
}

type AuthDomain interface {
	CheckToken(ctx context.Context, userJWT string) (*AccountDTO, error)
	GetAccountFromCredentials(ctx context.Context, username, password string) (*AccountDTO, error)
	CreateTokenForAccount(account *AccountDTO, expiration time.Time) (string, error)
}

type Bookmark struct {
	ID         int    `db:"id"`
	URL        string `db:"url"`
	Title      string `db:"title"`
	Excerpt    string `db:"excerpt"`
	Author     string `db:"author"`
	Public     int    `db:"public"`
	CreatedAt  string `db:"created_at"`
	ModifiedAt string `db:"modified_at"`
	HasContent bool   `db:"has_content"`
}

type BookmarkDTO struct {
	ID            int      `db:"id"            json:"id"`
	URL           string   `db:"url"           json:"url"`
	Title         string   `db:"title"         json:"title"`
	Excerpt       string   `db:"excerpt"       json:"excerpt"`
	Author        string   `db:"author"        json:"author"`
	Public        int      `db:"public"        json:"public"`
	CreatedAt     string   `db:"created_at"    json:"createdAt"`
	ModifiedAt    string   `db:"modified_at"   json:"modifiedAt"`
	Content       string   `db:"content"       json:"-"`
	HTML          string   `db:"html"          json:"html,omitempty"`
	ImageURL      string   `db:"image_url"     json:"imageURL"`
	HasContent    bool     `db:"has_content"   json:"hasContent"`
	Tags          []TagDTO `json:"tags"`
	HasArchive    bool     `json:"hasArchive"`
	HasEbook      bool     `json:"hasEbook"`
	CreateArchive bool     `json:"create_archive"` // TODO: migrate outside the DTO
	CreateEbook   bool     `json:"create_ebook"`   // TODO: migrate outside the DTO
}

type BookmarkTag struct {
	BookmarkID int `db:"bookmark_id"`
	TagID      int `db:"tag_id"`
}

type BookmarksDomain interface {
	HasEbook(b *BookmarkDTO) bool
	HasArchive(b *BookmarkDTO) bool
	HasThumbnail(b *BookmarkDTO) bool
	GetBookmark(ctx context.Context, id DBID) (*BookmarkDTO, error)
	GetBookmarks(ctx context.Context, ids []int) ([]BookmarkDTO, error)
	UpdateBookmarkCache(ctx context.Context, bookmark BookmarkDTO, keepMetadata bool, skipExist bool) (*BookmarkDTO, error)
	BulkUpdateBookmarkTags(ctx context.Context, bookmarkIDs []int, tagIDs []int) error
	AddTagToBookmark(ctx context.Context, bookmarkID int, tagID int) error
	RemoveTagFromBookmark(ctx context.Context, bookmarkID int, tagID int) error
	BookmarkExists(ctx context.Context, id int) (bool, error)
}

type DB interface {
	// WriterDB is the underlying sqlx.DB
	WriterDB() *sqlx.DB

	// ReaderDB is the underlying sqlx.DB
	ReaderDB() *sqlx.DB

	// Init initializes the database
	Init(ctx context.Context) error

	// Migrate runs migrations for this database
	Migrate(ctx context.Context) error

	// GetDatabaseSchemaVersion gets the version of the database
	GetDatabaseSchemaVersion(ctx context.Context) (string, error)

	// SetDatabaseSchemaVersion sets the version of the database
	SetDatabaseSchemaVersion(ctx context.Context, version string) error

	// SaveBookmarks saves bookmarks data to database.
	SaveBookmarks(ctx context.Context, create bool, bookmarks ...BookmarkDTO) ([]BookmarkDTO, error)

	// SaveBookmark saves a single bookmark to database without handling tags.
	// It only updates the bookmark data in the database.
	SaveBookmark(ctx context.Context, bookmark Bookmark) error

	// GetBookmarks fetch list of bookmarks based on submitted options.
	GetBookmarks(ctx context.Context, opts DBGetBookmarksOptions) ([]BookmarkDTO, error)

	// GetBookmarksCount get count of bookmarks in database.
	GetBookmarksCount(ctx context.Context, opts DBGetBookmarksOptions) (int, error)

	// DeleteBookmarks removes all record with matching ids from database.
	DeleteBookmarks(ctx context.Context, ids ...int) error

	// GetBookmark fetches bookmark based on its ID or URL.
	GetBookmark(ctx context.Context, id int, url string) (BookmarkDTO, bool, error)

	// CreateAccount saves new account in database
	CreateAccount(ctx context.Context, a Account) (*Account, error)

	// UpdateAccount updates account in database
	UpdateAccount(ctx context.Context, a Account) error

	// ListAccounts fetch list of account (without its password) with matching keyword.
	ListAccounts(ctx context.Context, opts DBListAccountsOptions) ([]Account, error)

	// GetAccount fetch account with matching username.
	GetAccount(ctx context.Context, id DBID) (*Account, bool, error)

	// DeleteAccount removes account with matching id
	DeleteAccount(ctx context.Context, id DBID) error

	// CreateTags creates new tags in database.
	CreateTags(ctx context.Context, tags ...Tag) ([]Tag, error)

	// CreateTag creates a new tag in database.
	CreateTag(ctx context.Context, tag Tag) (Tag, error)

	// GetTags fetch list of tags and its frequency from database.
	GetTags(ctx context.Context, opts DBListTagsOptions) ([]TagDTO, error)

	// RenameTag change the name of a tag.
	RenameTag(ctx context.Context, id int, newName string) error

	// GetTag fetch a tag by its ID.
	GetTag(ctx context.Context, id int) (TagDTO, bool, error)

	// UpdateTag updates a tag in the database.
	UpdateTag(ctx context.Context, tag Tag) error

	// DeleteTag removes a tag from the database.
	DeleteTag(ctx context.Context, id int) error

	// BulkUpdateBookmarkTags updates tags for multiple bookmarks.
	// It ensures that all bookmarks and tags exist before proceeding.
	BulkUpdateBookmarkTags(ctx context.Context, bookmarkIDs []int, tagIDs []int) error

	// AddTagToBookmark adds a tag to a bookmark
	AddTagToBookmark(ctx context.Context, bookmarkID int, tagID int) error

	// RemoveTagFromBookmark removes a tag from a bookmark
	RemoveTagFromBookmark(ctx context.Context, bookmarkID int, tagID int) error

	// TagExists checks if a tag with the given ID exists in the database
	TagExists(ctx context.Context, tagID int) (bool, error)

	// BookmarkExists checks if a bookmark with the given ID exists in the database
	BookmarkExists(ctx context.Context, bookmarkID int) (bool, error)
}

type DBGetBookmarksOptions struct {
	IDs          []int
	Tags         []string
	ExcludedTags []string
	Keyword      string
	WithContent  bool
	OrderMethod  DBOrderMethod
	Limit        int
	Offset       int
}

type DBID int

type DBListAccountsOptions struct {
	// Filter accounts by a keyword
	Keyword string
	// Filter accounts by exact useranme
	Username string
	// Return owner accounts only
	Owner bool
	// Retrieve password content
	WithPassword bool
}

type DBListTagsOptions struct {
	BookmarkID        int
	WithBookmarkCount bool
	OrderBy           DBTagOrderBy
	Search            string
}

type DBOrderMethod int

type DBTagOrderBy string

type Dependencies interface {
	Logger() *logrus.Logger
	Domains() DomainDependencies
	Config() *config.Config
	Database() DB
}

type DomainDependencies interface {
	Auth() AuthDomain
	SetAuth(auth AuthDomain)
	Accounts() AccountsDomain
	SetAccounts(accounts AccountsDomain)
	Bookmarks() BookmarksDomain
	SetBookmarks(bookmarks BookmarksDomain)
	Archiver() ArchiverDomain
	SetArchiver(archiver ArchiverDomain)
	Storage() StorageDomain
	SetStorage(storage StorageDomain)
	Tags() TagsDomain
	SetTags(tags TagsDomain)
}

type HttpHandler func(deps Dependencies, c WebContext)

type HttpMiddleware interface {
	OnRequest(deps Dependencies, c WebContext) error
	OnResponse(deps Dependencies, c WebContext) error
}

type JWTClaim struct {
	jwt.RegisteredClaims

	Account *Account
}

type LegacyLoginHandler func(account *AccountDTO, expTime time.Duration) (string, error)

type ListTagsOptions struct {
	BookmarkID        int
	WithBookmarkCount bool
	OrderBy           DBTagOrderBy
	Search            string
}

type StorageDomain interface {
	Stat(name string) (fs.FileInfo, error)
	FS() afero.Fs
	FileExists(path string) bool
	DirExists(path string) bool
	WriteData(dst string, data []byte) error
	WriteFile(dst string, src *os.File) error
}

type Tag struct {
	ID   int    `db:"id"          json:"id"`
	Name string `db:"name"        json:"name"`
}

type TagDTO struct {
	Tag
	BookmarkCount int64 `db:"bookmark_count" json:"bookmark_count"` // Number of bookmarks with this tag
	Deleted       bool  `json:"deleted"`                            // Marks when a tag is deleted from a bookmark
}

type TagsDomain interface {
	ListTags(ctx context.Context, opts ListTagsOptions) ([]TagDTO, error)
	CreateTag(ctx context.Context, tag TagDTO) (TagDTO, error)
	GetTag(ctx context.Context, id int) (TagDTO, error)
	UpdateTag(ctx context.Context, tag TagDTO) (TagDTO, error)
	DeleteTag(ctx context.Context, id int) error
	TagExists(ctx context.Context, id int) (bool, error)
}

type UserConfig struct {
	ShowId        bool
	ListMode      bool
	HideThumbnail bool
	HideExcerpt   bool
	Theme         string
	KeepMetadata  bool
	UseArchive    bool
	CreateEbook   bool
	MakePublic    bool
}

type ValidationError struct {
	Field   string `json:"field"`
	Message string `json:"message"`
}

type WebContext interface {
	Request() *http.Request
	ResponseWriter() http.ResponseWriter
	SetResponseWriter(w http.ResponseWriter)
	GetAccount() *AccountDTO
	SetAccount(*AccountDTO)
	UserIsLogged() bool
	GetRequestID() string
	SetRequestID(id string)
}