image

Documentation

Index

• 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 FileExists(path string) bool
• 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 IsZipPath(p string) bool
• func PathDisplayName(path string) string
• 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)
• func ZipFilename(zipFilename, filenameInZip string) string
• 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 ThumbnailEncoder
  • func NewThumbnailEncoder(ffmpegPath string) ThumbnailEncoder
  • func (e *ThumbnailEncoder) GetThumbnail(img *models.Image, maxSize int) ([]byte, error)

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 FileExists

func FileExists(path string) bool

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 IsZipPath

func IsZipPath(p string) bool

IsZipPath returns true if the path includes the zip separator byte, indicating it is within a zip file. TODO - this should be moved to utils

func PathDisplayName

func PathDisplayName(path string) string

PathDisplayName converts an image path for display. It translates the zip file separator character into '/', since this character is also used for path separators within zip files. It returns the original provided path if it does not contain the zip file separator character.

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)

func ZipFilename

func ZipFilename(zipFilename, filenameInZip string) string

Types

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 ThumbnailEncoder

type ThumbnailEncoder struct {
	FFMPEGPath string
	VipsPath   string
}

func NewThumbnailEncoder

func NewThumbnailEncoder(ffmpegPath string) 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.