image

Documentation

Index

• Variables
• func AddPerformer(qb models.ImageReaderWriter, id int, performerID int) (bool, error)
• func AddTag(qb models.ImageReaderWriter, id int, tagID int) (bool, error)
• func CalculateMD5(path string) (string, error)
• func CountByPerformerID(r models.ImageReader, id int) (int, error)
• func CountByStudioID(r models.ImageReader, id int) (int, error)
• func CountByTagID(r models.ImageReader, id int) (int, error)
• func DecodeSourceImage(i *models.Image) (*image.Config, *string, error)
• func Destroy(i *models.Image, destroyer Destroyer, fileDeleter *FileDeleter, ...) error
• func FileExists(path string) bool
• func FileScanner(hasher file.Hasher) file.Scanner
• func FindByGalleryID(r models.ImageReader, galleryID int, sortBy string, ...) ([]*models.Image, error)
• func GetFileDetails(path string) (*models.Image, error)
• func GetFileModTime(path string) (time.Time, error)
• func GetFilename(s *models.Image, stripExt bool) string
• func GetSourceImage(i *models.Image) (image.Image, error)
• func GetStudioName(reader models.StudioReader, image *models.Image) (string, error)
• func GetTitle(s *models.Image) string
• func GetVipsPath() string
• func IsCover(img *models.Image) bool
• func PathsFilter(paths []string) *models.ImageFilterType
• func Query(qb Queryer, imageFilter *models.ImageFilterType, ...) ([]*models.Image, error)
• func QueryOptions(imageFilter *models.ImageFilterType, findFilter *models.FindFilterType, ...) models.ImageQueryOptions
• func Serve(w http.ResponseWriter, r *http.Request, path string)
• func SetFileDetails(i *models.Image) error
• func ToBasicJSON(image *models.Image) *jsonschema.Image
• func UpdateFileModTime(qb models.ImageWriter, id int, modTime models.NullSQLiteTimestamp) (*models.Image, error)
• type Destroyer
• type FileDeleter
  • func (d *FileDeleter) MarkGeneratedFiles(image *models.Image) error
• type Importer
  • func (i *Importer) Create() (*int, error)
  • func (i *Importer) FindExistingID() (*int, error)
  • func (i *Importer) Name() string
  • func (i *Importer) PostImport(id int) error
  • func (i *Importer) PreImport() error
  • func (i *Importer) Update(id int) error
• type Queryer
• type Scanner
  • func (scanner *Scanner) ScanExisting(ctx context.Context, existing file.FileBased, file file.SourceFile) (retImage *models.Image, err error)
  • func (scanner *Scanner) ScanNew(ctx context.Context, f file.SourceFile) (retImage *models.Image, err error)
• type ThumbnailEncoder
  • func NewThumbnailEncoder(ffmpegEncoder ffmpeg.FFMpeg) ThumbnailEncoder
  • func (e *ThumbnailEncoder) GetThumbnail(img *models.Image, maxSize int) ([]byte, error)

Variables

var (
	ErrUnsupportedImageFormat = errors.New("unsupported image format")

	// ErrNotSupportedForThumbnail is returned if the image format is not supported for thumbnail generation
	ErrNotSupportedForThumbnail = errors.New("unsupported image format for thumbnail")
)

Functions

func AddPerformer

func AddPerformer(qb models.ImageReaderWriter, id int, performerID int) (bool, error)

func AddTag

func AddTag(qb models.ImageReaderWriter, id int, tagID int) (bool, error)

func CalculateMD5

func CalculateMD5(path string) (string, error)

func CountByPerformerID

func CountByPerformerID(r models.ImageReader, id int) (int, error)

func CountByStudioID

func CountByStudioID(r models.ImageReader, id int) (int, error)

func CountByTagID

func CountByTagID(r models.ImageReader, id int) (int, error)

func DecodeSourceImage

func DecodeSourceImage(i *models.Image) (*image.Config, *string, error)

func Destroy

func Destroy(i *models.Image, destroyer Destroyer, fileDeleter *FileDeleter, deleteGenerated, deleteFile bool) error

Destroy destroys an image, optionally marking the file and generated files for deletion.

func FileExists

func FileExists(path string) bool

func FileScanner

func FileScanner(hasher file.Hasher) file.Scanner

func FindByGalleryID

func FindByGalleryID(r models.ImageReader, galleryID int, sortBy string, sortDir models.SortDirectionEnum) ([]*models.Image, error)

func GetFileDetails

func GetFileDetails(path string) (*models.Image, error)

GetFileDetails returns a pointer to an Image object with the width, height and size populated.

func GetFileModTime

func GetFileModTime(path string) (time.Time, error)

GetFileModTime gets the file modification time, handling files in zip files.

func GetFilename

func GetFilename(s *models.Image, stripExt bool) string

GetFilename gets the base name of the image file If stripExt is set the file extension is omitted from the name

func GetSourceImage

func GetSourceImage(i *models.Image) (image.Image, error)

func GetStudioName

func GetStudioName(reader models.StudioReader, image *models.Image) (string, error)

GetStudioName returns the name of the provided image's studio. It returns an empty string if there is no studio assigned to the image.

func GetTitle

func GetTitle(s *models.Image) string

func GetVipsPath

func GetVipsPath() string

func IsCover

func IsCover(img *models.Image) bool

func PathsFilter

func PathsFilter(paths []string) *models.ImageFilterType

func Query

func Query(qb Queryer, imageFilter *models.ImageFilterType, findFilter *models.FindFilterType) ([]*models.Image, error)

Query queries for images using the provided filters.

func QueryOptions

func QueryOptions(imageFilter *models.ImageFilterType, findFilter *models.FindFilterType, count bool) models.ImageQueryOptions

QueryOptions returns a ImageQueryResult populated with the provided filters.

func Serve

func Serve(w http.ResponseWriter, r *http.Request, path string)

func SetFileDetails

func SetFileDetails(i *models.Image) error

func ToBasicJSON

func ToBasicJSON(image *models.Image) *jsonschema.Image

ToBasicJSON converts a image object into its JSON object equivalent. It does not convert the relationships to other objects, with the exception of cover image.

func UpdateFileModTime

func UpdateFileModTime(qb models.ImageWriter, id int, modTime models.NullSQLiteTimestamp) (*models.Image, error)

Types

type Destroyer

type Destroyer interface {
	Destroy(id int) error
}

type FileDeleter

type FileDeleter struct {
	file.Deleter

	Paths *paths.Paths
}

FileDeleter is an extension of file.Deleter that handles deletion of image files.

func (*FileDeleter) MarkGeneratedFiles

func (d *FileDeleter) MarkGeneratedFiles(image *models.Image) error

MarkGeneratedFiles marks for deletion the generated files for the provided image.

type Importer

type Importer struct {
	ReaderWriter        models.ImageReaderWriter
	StudioWriter        models.StudioReaderWriter
	GalleryWriter       models.GalleryReaderWriter
	PerformerWriter     models.PerformerReaderWriter
	TagWriter           models.TagReaderWriter
	Input               jsonschema.Image
	Path                string
	MissingRefBehaviour models.ImportMissingRefEnum

	ID int
	// contains filtered or unexported fields
}

func (*Importer) Create

func (i *Importer) Create() (*int, error)

func (*Importer) FindExistingID

func (i *Importer) FindExistingID() (*int, error)

func (*Importer) Name

func (i *Importer) Name() string

func (*Importer) PostImport

func (i *Importer) PostImport(id int) error

func (*Importer) PreImport

func (i *Importer) PreImport() error

func (*Importer) Update

func (i *Importer) Update(id int) error

type Queryer

type Queryer interface {
	Query(options models.ImageQueryOptions) (*models.ImageQueryResult, error)
}

type Scanner

type Scanner struct {
	file.Scanner

	StripFileExtension bool

	CaseSensitiveFs bool
	TxnManager      models.TransactionManager
	Paths           *paths.Paths
	PluginCache     *plugin.Cache
	MutexManager    *utils.MutexManager
}

func (*Scanner) ScanExisting

func (scanner *Scanner) ScanExisting(ctx context.Context, existing file.FileBased, file file.SourceFile) (retImage *models.Image, err error)

func (*Scanner) ScanNew

func (scanner *Scanner) ScanNew(ctx context.Context, f file.SourceFile) (retImage *models.Image, err error)

type ThumbnailEncoder

type ThumbnailEncoder struct {
	// contains filtered or unexported fields
}

func NewThumbnailEncoder

func NewThumbnailEncoder(ffmpegEncoder ffmpeg.FFMpeg) ThumbnailEncoder

func (*ThumbnailEncoder) GetThumbnail

func (e *ThumbnailEncoder) GetThumbnail(img *models.Image, maxSize int) ([]byte, error)

GetThumbnail returns the thumbnail image of the provided image resized to the provided max size. It resizes based on the largest X/Y direction. It returns nil and an error if an error occurs reading, decoding or encoding the image, or if the image is not suitable for thumbnails.