types

type Book struct {
	BookInfo
	Pages Pages `json:"pages"` //storm:"inline" 内联字段，结构体嵌套时使用
}

type BookGroup struct {
	BookInfo
	ChildBook sync.Map //key：BookID,value: *BookInfo
}

type BookInfo struct {
	Title           string          `json:"title"`          //书名
	BookID          string          `json:"id"`             //根据FilePath生成的唯一ID
	BookStorePath   string          `json:"-"   `           //在哪个子书库
	Type            SupportFileType `json:"type"`           //书籍类型
	Depth           int             `json:"depth"`          //书籍深度
	ChildBookNum    int             `json:"child_book_num"` //子书籍数量
	PageCount       int             `json:"page_count"`     //总页数
	Cover           ImageInfo       `json:"cover"`          //封面图
	ParentFolder    string          `json:"parent_folder"`  //父文件夹
	Author          string          `json:"author"`         //作者
	ISBN            string          `json:"isbn"`           //ISBN
	Press           string          `json:"press"`          //出版社
	PublishedAt     string          `json:"published_at"`   //出版日期
	FilePath        string          `json:"-"`              //文件绝对路径，json不解析
	FileSize        int64           `json:"file_size"`      //文件大小
	Modified        time.Time       `json:"modified_time"`  //修改时间
	ReadPercent     float64         `json:"read_percent"`   //阅读进度
	ExtractPath     string          `json:"-"`              //解压路径，7z用，json不解析
	ExtractNum      int             `json:"-"`              //文件解压数    extract_num
	InitComplete    bool            `json:"-"`              //是否解压完成  extract_complete
	NonUTF8Zip      bool            `json:"-"`              //是否为特殊编码zip
	ZipTextEncoding string          `json:"-"`              //zip文件编码
}

type BookInfoList struct {
	SortBy    string
	BookInfos []BookInfo
}

type ComigoConfig struct {
	Port                   int      `` /* 312-byte string literal not displayed */
	ConfigPath             string   `json:"-" toml:"-" comment:"用户指定的的yaml设置文件路径"`
	Host                   string   `json:"Host" comment:"自定义二维码显示的主机名"`
	StoresPath             []string `json:"StoresPath" comment:"默认扫描的书库文件夹"`
	ExcludePath            []string `json:"ExcludePath" comment:"扫描书籍的时候，需要排除的文件或文件夹的名字"`
	SupportMediaType       []string `json:"SupportMediaType" comment:"扫描压缩包时，用于统计图片数量的图片文件后缀"`
	SupportFileType        []string `json:"SupportFileType" comment:"支持的书籍压缩包后缀"`
	MinImageNum            int      `json:"MinImageNum" comment:"压缩包或文件夹内，至少有几张图片，才算作书籍"`
	TimeoutLimitForScan    int      `` /* 130-byte string literal not displayed */
	EnableUpload           bool     `json:"EnableUpload" comment:"启用上传功能"`
	UploadPath             string   `json:"UploadPath" comment:"上传文件存储位置，默认在当前执行目录下创建 upload 文件夹"`
	MaxScanDepth           int      `json:"MaxScanDepth" comment:"最大扫描深度"`
	ZipFileTextEncoding    string   `json:"ZipFileTextEncoding" comment:"非utf-8编码的ZIP文件，尝试用什么编码解析，默认GBK"`
	PrintAllPossibleQRCode bool     `json:"PrintAllPossibleQRCode" comment:"扫描完成后，打印所有可能的阅读链接二维码"`
	Debug                  bool     `json:"Debug" comment:"开启Debug模式"`
	OpenBrowser            bool     `json:"OpenBrowser" comment:"是否同时打开浏览器，windows默认true，其他默认false"`
	DisableLAN             bool     `json:"DisableLAN" comment:"只在本机提供阅读服务，不对外共享，此项配置不支持热重载"`
	DefaultMode            string   `json:"DefaultMode" comment:"默认阅读模式，默认为空，可以设置为scroll或flip"`
	EnableLogin            bool     `json:"EnableLogin" comment:"是否启用登录。默认不需要登陆。此项配置不支持热重载。"`
	Username               string   `json:"Username" comment:"启用登陆后，登录界面需要的用户名。"`
	Password               string   `json:"Password" comment:"启用登陆后，登录界面需要的密码。"`
	Timeout                int      `json:"Timeout" comment:"启用登陆后，cookie过期的时间。单位为分钟。默认180分钟后过期。"`
	EnableTLS              bool     `json:"EnableTLS" comment:"是否启用HTTPS协议。需要设置证书于key文件。"`
	CertFile               string   `json:"CertFile" comment:"TLS/SSL 证书文件路径 (default: "~/.config/.comigo/cert.crt")"`
	KeyFile                string   `json:"KeyFile" comment:"TLS/SSL key文件路径 (default: "~/.config/.comigo/key.key")"`
	UseCache               bool     `json:"UseCache" comment:"开启本地图片缓存，可以加快二次读取，但会占用硬盘空间"`
	CachePath              string   `json:"CachePath" comment:"本地图片缓存位置，默认系统临时文件夹"`
	ClearCacheExit         bool     `json:"ClearCacheExit" comment:"退出程序的时候，清理web图片缓存"`
	EnableDatabase         bool     `json:"EnableDatabase" comment:"启用本地数据库，保存扫描到的书籍数据。此项配置不支持热重载。"`
	ClearDatabaseWhenExit  bool     `json:"ClearDatabaseWhenExit" comment:"启用本地数据库时，扫描完成后，清除不存在的书籍。"`
	LogToFile              bool     `json:"LogToFile" comment:"是否保存程序Log到本地文件。默认不保存。"`
	LogFilePath            string   `json:"LogFilePath" comment:"Log文件的保存位置"`
	LogFileName            string   `json:"LogFileName" comment:"Log文件名"`
	GenerateMetaData       bool     `json:"GenerateMetaData" toml:"GenerateMetaData" comment:"生成书籍元数据"`
}

type ConfigStatus struct {
	// 当前生效的配置文件路径 None、HomeDirectory、WorkingDirectory、ProgramDirectory
	// 设置读取顺序：None（默认值） -> HomeDirectory -> ProgramDirectory -> WorkingDirectory
	In   string
	Path struct {
		// 对应配置文件的绝对路径
		WorkingDirectory string
		HomeDirectory    string
		ProgramDirectory string
	}
}

type Folder struct {
	Path       string
	SortBy     string   //新字段   //排序方式
	SubFolders sync.Map //key为路径 存储 *subFolder
}

type FrpClientConfig struct {
	FrpcCommand      string `comment:"手动设定frpc可执行程序的路径,默认为frpc"`
	ServerAddr       string
	ServerPort       int
	Token            string
	FrpType          string //本地转发端口设置
	RemotePort       int
	RandomRemotePort bool
}

type ImageInfo struct {
	PageNum           int       `json:"-"`        //这个字段不解析
	NameInArchive     string    `json:"filename"` //用于解压的压缩文件内文件路径，或图片名，为了适应特殊字符，经过一次转义
	Url               string    `json:"url"`      //远程用户读取图片的URL，为了适应特殊字符，经过一次转义
	Blurhash          string    `json:"-"`        //`json:"blurhash"` //blurhash占位符。需要扫描图片生成（util.GetImageDataBlurHash）
	Height            int       `json:"-"`        //暂时用不着 这个字段不解析`json:"height"`   //blurhash用，图片高
	Width             int       `json:"-"`        //暂时用不着 这个字段不解析`json:"width"`    //blurhash用，图片宽
	ModeTime          time.Time `json:"-"`        //这个字段不解析
	FileSize          int64     `json:"-"`        //这个字段不解析
	RealImageFilePATH string    `json:"-"`        //这个字段不解析  书籍为文件夹的时候，实际图片的路径
	ImgType           string    `json:"-"`        //这个字段不解析
}

type Pages struct {
	Images []ImageInfo `json:"images"`
	SortBy string      `json:"sort_by"`
}

type SupportFileType string

type User struct {
	ID        int    `json:"id"`
	Username  string `json:"username"`
	Password  string `json:"password"`
	FirstName string `json:"first_name"`
	LastName  string `json:"last_name"`
	Email     string `json:"email"`
}

type WebPServerConfig struct {
	WebpCommand  string
	HOST         string
	PORT         string
	ImgPath      string
	QUALITY      int
	AllowedTypes []string
	ExhaustPath  string
}