catalog

type Album struct {
	Name       string
	FolderName string // unique and immutable
	Start      time.Time
	End        time.Time
}

type AlbumStat struct {
	Album Album
	// contains filtered or unexported fields
}

type CreateAlbum struct {
	Name             string
	Start            time.Time
	End              time.Time
	ForcedFolderName string
}

type CreateMediaRequest struct {
	Location  MediaLocation
	Type      MediaType
	Details   MediaDetails
	Signature MediaSignature
}

type FindMediaFilter struct {
	PageRequest PageRequest // PageRequest size will use a default if too high or not set (0)
	TimeRange   TimeRange   // TimeRange is optional
}

type MediaDetails struct {
	Width, Height             int
	DateTime                  time.Time
	Orientation               MediaOrientation
	Make                      string
	Model                     string
	GPSLatitude, GPSLongitude float64
	Duration                  int64  // Duration is the length, in milliseconds, of a video
	VideoEncoding             string // VideoEncoding is the codec used to encode the video (ex: 'H264')
}

type MediaLocation struct {
	FolderName string
	Filename   string
}

type MediaMeta struct {
	Signature MediaSignature // Signature is the key used to get the image (or its location)
	Filename  string         // Filename original filename when image was uploaded
	Type      MediaType
	Details   MediaDetails
}

type MediaOrientation string

type MediaPage struct {
	NextPage string // NextPage is empty if no other pages
	Content  []*MediaMeta
}

type MediaSignature struct {
	SignatureSha256 string
	SignatureSize   int
}

type MediaSignatureAndLocation struct {
	Location  MediaLocation
	Signature MediaSignature
}

type MediaType string

type MoveMediaOperator interface {
	// Move must perform the physical move of the file to a different directory ; return the final name if it has been changed
	Move(source, dest MediaLocation) (string, error)

	// UpdateStatus informs of the global status of the move operation
	UpdateStatus(done, total int) error
	// Continue requests if the operation should continue or be interrupted
	Continue() bool
}

type MoveTransaction struct {
	TransactionId string
	Count         int // Number of medias to be moved as part of this transaction
}

type MovedMedia struct {
	Signature        MediaSignature
	SourceFolderName string
	SourceFilename   string
	TargetFolderName string
	TargetFilename   string
}

type PageRequest struct {
	Size     int64  // defaulted to 50 if not defined
	NextPage string // empty for the first page
}

type PrioritySegment struct {
	Start  time.Time
	End    time.Time
	Albums []Album // sorted by priority
}

type RepositoryPort interface {
	FindAllAlbums() ([]*Album, error)
	InsertAlbum(album Album) error
	DeleteEmptyAlbum(folderName string) error
	// FindAlbum returns (nil, NotFoundError) when not found
	FindAlbum(folderName string) (*Album, error)
	// UpdateAlbum updates data of matching Album.FolderName
	UpdateAlbum(album Album) error
	// CountMedias counts number of media within the album
	CountMedias(folderName string) (int, error)

	// InsertMedias bulks insert medias
	InsertMedias(media []CreateMediaRequest) error
	// FindMedias is a paginated search of medias within an album, and optionally within a time range
	FindMedias(folderName string, filter FindMediaFilter) (*MediaPage, error)
	// FindExistingSignatures returns the signatures that are already known
	FindExistingSignatures(signatures []*MediaSignature) ([]*MediaSignature, error)
	// UpdateMedias updates metadata and mark the media to be moved, the AlbumFolderName is never updated (part of the primary key)
	UpdateMedias(filter *UpdateMediaFilter, newFolderName string) (string, int, error)

	FindReadyMoveTransactions() ([]*MoveTransaction, error)
	FindFilesToMove(transactionId, pageToken string) ([]*MovedMedia, string, error)
	UpdateMediasLocation(transactionId string, moves []*MovedMedia) error
	DeleteEmptyMoveTransaction(transactionId string) error
}

type TimeRange struct {
	Start time.Time
	End   time.Time
}

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

type UpdateMediaFilter struct {
	AlbumFolderNames map[string]interface{} // AlbumFolderNames is a set of folder names (map value is nil)
	Ranges           []TimeRange            // empty = no restriction
}