backup

Nov 19, 2024

Changes in this version

type BatchScanner

+ CataloguerFactory CataloguerFactory

+ DetailsReaders DetailsReaderAdapter

Nov 17, 2024

Changes in this version

+ var ErrAnalyserNoDateTime = errors.New("media must have a date time included in the metadata")

+ var ErrCatalogerFilterMustBeInAlbum = errors.New("media must be in album")

+ var ErrCatalogerFilterMustNotAlreadyExists = errors.New("media must not already exists")

+ var ErrMediaMustNotBeDuplicated = errors.New("media is present twice in the volume")

+ type AlbumReport struct

+ New bool

+ func (c *AlbumReport) GetMediaIndex(mediaType MediaType) int

+ func (c *AlbumReport) IncrementCounter(counter *[numberOfMediaType]int, mediaType MediaType, delta int)

+ func (c *AlbumReport) IncrementFoundCounter(mediaType MediaType, count int, size int) *AlbumReport

+ func (c *AlbumReport) OfType(mediaType MediaType) MediaCounter

+ func (c *AlbumReport) Total() MediaCounter

+ type AnalysedMediaObserverFunc func(ctx context.Context, media *AnalysedMedia) error

+ func (a AnalysedMediaObserverFunc) OnAnalysedMedia(ctx context.Context, media *AnalysedMedia) error

+ type AnalyserObserver interface

+ type BatchScanner struct

+ func (s *BatchScanner) Scan(ctx context.Context, owner ownermodel.Owner, volume SourceVolume, ...) ([]*ScannedFolder, error)

+ type CatalogReferencerObserverFunc func(ctx context.Context, requests []BackingUpMediaRequest) error

+ func (c CatalogReferencerObserverFunc) OnMediaCatalogued(ctx context.Context, requests []BackingUpMediaRequest) error

type Cataloguer

+ Reference func(ctx context.Context, medias []*AnalysedMedia, ...) error

+ type CataloguerFactory interface

+ NewAlbumCreatorCataloguer func(ctx context.Context, owner ownermodel.Owner) (Cataloguer, error)

+ NewDryRunCataloguer func(ctx context.Context, owner ownermodel.Owner) (Cataloguer, error)

type CataloguerWithFilters

+ CatalogReferencerObserver CatalogReferencerObserver

+ CataloguerFilterObserver CataloguerFilterObserver

+ type ConcurrencyParameters struct

+ ConcurrentAnalyserRoutines int

+ ConcurrentCataloguerRoutines int

+ ConcurrentUploaderRoutines int

+ func (c ConcurrencyParameters) NumberOfConcurrentAnalyserRoutines() int

+ func (c ConcurrencyParameters) NumberOfConcurrentCataloguerRoutines() int

+ func (c ConcurrencyParameters) NumberOfConcurrentUploaderRoutines() int

type Options

+ ConcurrencyParameters ConcurrencyParameters

+ func OptionsBatchSize(batchSize int) Options

+ func OptionsConcurrentAnalyserRoutines(concurrent int) Options

+ func OptionsConcurrentCataloguerRoutines(concurrent int) Options

+ func OptionsConcurrentUploaderRoutines(concurrent int) Options

+ func OptionsSkipRejects(skip bool) Options

+ func (o Options) GetBatchSize() int

type ProgressObserver

+ func (p *ProgressObserver) OnDuplicatedBackupMediaRequest(ctx context.Context, request []BackingUpMediaRequest) error

+ func (p *ProgressObserver) OnUniqueBackupMediaRequest(ctx context.Context, request []BackingUpMediaRequest) error

type ScannedFolder

+ RejectsCount int

Oct 26, 2024

Changes in this version

+ var CatalogerFilterMustBeInAlbumError = errors.New("media must be in album")

+ var CatalogerFilterMustNotAlreadyExistsError = errors.New("media must not already exists")

+ type ApplyFiltersOnCataloguer struct

+ CataloguerFilters []CataloguerFilter

+ Delegate CatalogReferencerObserver

+ Observer CataloguerFilterObserver

+ func (a *ApplyFiltersOnCataloguer) OnMediaCatalogued(ctx context.Context, requests []BackingUpMediaRequest) error

type CatalogReferencer

+ func NewReferencer(owner ownermodel.Owner, dryRun bool) (CatalogReferencer, error)

+ type CatalogReferencerObserver interface

+ OnMediaCatalogued func(ctx context.Context, requests []BackingUpMediaRequest) error

+ type Cataloguer interface

+ Catalog func(ctx context.Context, medias []*AnalysedMedia, observer CataloguerObserver) error

+ type CataloguerFilter interface

+ FilterOut func(ctx context.Context, media AnalysedMedia, reference CatalogReference) error

+ func ListCataloguerFilters(options Options) []CataloguerFilter

+ type CataloguerFilterObserver interface

+ OnFilteredOut func(ctx context.Context, media AnalysedMedia, reference CatalogReference, ...) error

+ type CataloguerObserver interface

+ type CataloguerWithFilters struct

+ CataloguerFilters []CataloguerFilter

+ Delegate CatalogReferencer

+ func (c *CataloguerWithFilters) Catalog(ctx context.Context, medias []*AnalysedMedia, observer CataloguerObserver) error

type ChannelPublisher

+ func (a *ChannelPublisher) CataloguedChannelCloser()

+ func (a *ChannelPublisher) OnMediaCatalogued(ctx context.Context, requests []BackingUpMediaRequest) error

type CompositeRunnerObserver

+ func (c *CompositeRunnerObserver) OnFilteredOut(ctx context.Context, media AnalysedMedia, reference CatalogReference, ...) error

+ func (c *CompositeRunnerObserver) OnMediaCatalogued(ctx context.Context, requests []BackingUpMediaRequest) error

type ProgressObserver

+ func (p *ProgressObserver) OnFilteredOut(ctx context.Context, media AnalysedMedia, reference CatalogReference, ...) error

+ func (p *ProgressObserver) OnMediaCatalogued(ctx context.Context, requests []BackingUpMediaRequest) error

Oct 24, 2024

Changes in this version

+ const ProgressEventRejected

+ type AnalyserAsync interface

+ Analyse func(ctx context.Context, found FoundMedia, ...)

+ type AnalyserAsyncWrapper struct

+ Analyser Analyser

+ func (a *AnalyserAsyncWrapper) Analyse(ctx context.Context, found FoundMedia, ...)

+ type CopyRejectsObserver struct

+ RejectDir string

+ func (c *CopyRejectsObserver) OnRejectedMedia(ctx context.Context, found FoundMedia, _ error)

type DefaultInterrupterObserver

+ func (c *DefaultInterrupterObserver) OnRejectedMedia(ctx context.Context, found FoundMedia, err error)

+ type ExtraCounts struct

+ Cached MediaCounter

+ Rejected MediaCounter

+ func (c ExtraCounts) String() interface{}

+ type IErrorCollectorObserver interface

+ Errors func() []error

type Options

+ RejectDir string

+ func OptionWithRejectDir(rejectDir string) Options

+ func ReduceOptions(requestedOptions ...Options) Options

type RejectedMediaObserver

+ func NewCopyRejectsObserver(rejectDir string) (RejectedMediaObserver, error)

Oct 22, 2024

Changes in this version

+ type AnalysedMediaObserver interface

+ OnAnalysedMedia func(media *AnalysedMedia)

+ type Analyser interface

+ Analyse func(found FoundMedia, analysedMediaObserver AnalysedMediaObserver, ...)

+ type AnalyserDecoratorObserver interface

+ OnDecoratedAnalyser func(found FoundMedia, cacheHit bool)

+ type AnalyserInterrupterObserver struct

+ func (c *AnalyserInterrupterObserver) OnRejectedMedia(found FoundMedia, err error)

+ type ChannelPublisher struct

+ AnalysedMediaChannel chan *AnalysedMedia

+ BufferedAnalysedChannel chan []*AnalysedMedia

+ BufferedCataloguedChannel chan []*BackingUpMediaRequest

+ CataloguedChannel chan *BackingUpMediaRequest

+ CompletionChannel chan []error

+ FoundChannel chan FoundMedia

+ func NewAsyncPublisher(sizeHint int, batchSize int) *ChannelPublisher

+ func (a *ChannelPublisher) AnalysedMediaChannelCloser()

+ func (a *ChannelPublisher) OnAnalysedMedia(media *AnalysedMedia)

+ func (a *ChannelPublisher) WaitToFinish() []error

+ type CompositeRunnerObserver struct

+ Observers []interface{}

+ func (c *CompositeRunnerObserver) OnAnalysedMedia(media *AnalysedMedia)

+ func (c *CompositeRunnerObserver) OnRejectedMedia(found FoundMedia, err error)

+ type CoreAnalyser struct

+ func (a *CoreAnalyser) Analyse(found FoundMedia, analysedMediaObserver AnalysedMediaObserver, ...)

+ type DefaultInterrupterObserver struct

+ func (c *DefaultInterrupterObserver) Cancel()

+ type ErrorCollectorObserver struct

+ func NewErrorCollectorObserver() *ErrorCollectorObserver

+ func (e *ErrorCollectorObserver) Errors() []error

+ func (e *ErrorCollectorObserver) OnRejectedMedia(found FoundMedia, err error)

+ type Interrupter interface

+ Cancel func()

+ func NewInterrupterObserver(ctx context.Context, options Options) (Interrupter, context.Context)

+ type ProgressObserver struct

+ EventChannel chan *ProgressEvent

+ func NewProgressObserver(sizeHint int) *ProgressObserver

+ func (c *ProgressObserver) OnAnalysedMedia(media *AnalysedMedia)

+ func (c *ProgressObserver) OnDecoratedAnalyser(found FoundMedia, cacheHit bool)

+ func (c *ProgressObserver) OnRejectedMedia(found FoundMedia, err error)

+ type RejectedMediaObserver interface

+ OnRejectedMedia func(found FoundMedia, err error)

Aug 4, 2024

Changes in this version

type Options

+ BatchSize int

+ ConcurrentAnalyser int

+ ConcurrentCataloguer int

+ ConcurrentUploader int

+ func WithBatchSize(batchSize int) Options

+ func WithConcurrentAnalyser(concurrent int) Options

+ func WithConcurrentCataloguer(concurrent int) Options

+ func WithConcurrentUploader(concurrent int) Options

type Tracker

+ func (t *Tracker) MediaCount() int

Jun 1, 2024

Changes in this version

+ func ClearDetailsReader()

type BackingUpMediaRequest

+ CatalogReference CatalogReference

type CatalogReference

+ UniqueIdentifier func() string

+ type InsertMediaPort interface

+ IndexMedias func(ctx context.Context, owner ownermodel.Owner, requests []*CatalogMediaRequest) error

type Options

+ DryRun bool

+ type RunnerUploader interface

+ Upload func(buffer []*BackingUpMediaRequest, progressChannel chan *ProgressEvent) error

+ type RunnerUploaderFunc func(buffer []*BackingUpMediaRequest, progressChannel chan *ProgressEvent) error

+ func (r RunnerUploaderFunc) Upload(buffer []*BackingUpMediaRequest, progressChannel chan *ProgressEvent) error

+ type Uploader struct

+ InsertMediaPort InsertMediaPort

+ Owner ownermodel.Owner

+ func (u *Uploader) Upload(buffer []*BackingUpMediaRequest, progressChannel chan *ProgressEvent) error

May 31, 2024

Changes in this version

+ type AlbumLookupPort interface

+ FindOrCreateAlbum func(owner ownermodel.Owner, mediaTime time.Time) (folderName string, created bool, err error)

+ type CatalogReference interface

+ AlbumCreated func() bool

+ AlbumFolderName func() string

+ Exists func() bool

+ MediaId func() string

+ type CatalogReferencer interface

+ Reference func(ctx context.Context, medias []*AnalysedMedia) (map[*AnalysedMedia]CatalogReference, error)

+ type Cataloger struct

+ CatalogReferencer CatalogReferencer

+ CatalogerFilters []CatalogerFilter

+ func (c *Cataloger) Catalog(ctx context.Context, medias []*AnalysedMedia, ...) ([]*BackingUpMediaRequest, error)

+ type CatalogerFilter interface

+ FilterOut func(media AnalysedMedia, reference CatalogReference) (ProgressEventType, bool)

+ type CatalogerFilterFunc func(media AnalysedMedia, reference CatalogReference) (ProgressEventType, bool)

+ func (f CatalogerFilterFunc) FilterOut(media AnalysedMedia, reference CatalogReference) (ProgressEventType, bool)

+ type ReferencerFactory interface

+ NewCreatorReferencer func(ctx context.Context, owner ownermodel.Owner) (CatalogReferencer, error)

+ NewDryRunReferencer func(ctx context.Context, owner string) (CatalogReferencer, error)

+ type RunnerCataloger interface

+ Catalog func(ctx context.Context, medias []*AnalysedMedia, ...) ([]*BackingUpMediaRequest, error)

+ func NewCataloger(owner ownermodel.Owner, options Options) (RunnerCataloger, error)

+ type RunnerCatalogerFunc func(ctx context.Context, medias []*AnalysedMedia, ...) ([]*BackingUpMediaRequest, error)

+ func (r RunnerCatalogerFunc) Catalog(ctx context.Context, medias []*AnalysedMedia, ...) ([]*BackingUpMediaRequest, error)

Apr 21, 2024

Changes in this version

+ type RunnerAnalyser interface

+ Analyse func(found FoundMedia, progressChannel chan *ProgressEvent) (*AnalysedMedia, error)

type RunnerAnalyserFunc

+ func (r RunnerAnalyserFunc) Analyse(found FoundMedia, progressChannel chan *ProgressEvent) (*AnalysedMedia, error)

Mar 17, 2024

Changes in this version

+ const ProgressEventAnalysedFromCache

+ type AnalyserDecorator interface

+ Decorate func(analyseFunc RunnerAnalyserFunc) RunnerAnalyserFunc

type FoundMedia

+ func NewInMemoryMedia(name string, date time.Time, content []byte) FoundMedia

+ LastModification func() time.Time

+ type InMemoryMedia struct

+ func (i *InMemoryMedia) LastModification() time.Time

+ func (i *InMemoryMedia) MediaPath() MediaPath

+ func (i *InMemoryMedia) ReadMedia() (io.ReadCloser, error)

+ func (i *InMemoryMedia) Size() int

+ func (i *InMemoryMedia) String() string

type MediaPath

+ func (m MediaPath) Absolute() string

+ func (m MediaPath) String() string

+ type NopeAnalyserDecorator struct

+ func (n *NopeAnalyserDecorator) Decorate(analyseFunc RunnerAnalyserFunc) RunnerAnalyserFunc

type Options

+ AnalyserDecorator AnalyserDecorator

+ func (o Options) GetAnalyserDecorator() AnalyserDecorator

+ func (o Options) WithCachedAnalysis(analyserDecorator AnalyserDecorator) Options

+ type RunnerAnalyserFunc func(found FoundMedia, progressChannel chan *ProgressEvent) (*AnalysedMedia, error)

Jan 7, 2023

Changes in this version

+ const MediaTypeImage

+ const MediaTypeOther

+ const MediaTypeVideo

+ const OrientationLowerLeft

+ const OrientationLowerRight

+ const OrientationUpperLeft

+ const OrientationUpperRight

+ const ProgressEventAlbumCreated

+ const ProgressEventAlreadyExists

+ const ProgressEventAnalysed

+ const ProgressEventCatalogued

+ const ProgressEventDuplicate

+ const ProgressEventReadyForUpload

+ const ProgressEventScanComplete

+ const ProgressEventUploaded

+ const ProgressEventWrongAlbum

+ var BatchSize = 1

+ var ConcurrentAnalyser = 1

+ var ConcurrentCataloguer = 1

+ var ConcurrentUploader = 1

+ var MediaCounterZero = MediaCounter

+ var SupportedExtensions = map[string]MediaType

+ func Init(catalog CatalogAdapter, archive BArchiveAdapter)

+ func RegisterDetailsReader(reader DetailsReaderAdapter)

+ func Scan(owner string, volume SourceVolume, optionSlice ...Options) ([]*ScannedFolder, []FoundMedia, error)

+ type AnalysedMedia struct

+ Details *MediaDetails

+ FoundMedia FoundMedia

+ Sha256Hash string

+ Type MediaType

+ type BArchiveAdapter interface

+ ArchiveMedia func(owner string, media *BackingUpMediaRequest) (string, error)

+ type BackingUpMediaRequest struct

+ AnalysedMedia *AnalysedMedia

+ FolderName string

+ Id string

+ type CatalogAdapter interface

+ AssignIdsToNewMedias func(owner string, medias []*AnalysedMedia) (map[*AnalysedMedia]string, error)

+ GetAlbumsTimeline func(owner string) (TimelineAdapter, error)

+ IndexMedias func(owner string, requests []*CatalogMediaRequest) error

+ type CatalogMediaRequest struct

+ ArchiveFilename string

+ BackingUpMediaRequest *BackingUpMediaRequest

+ type ClosableFoundMedia interface

+ Close func() error

+ type CompletionReport interface

+ CountPerAlbum func() map[string]*TypeCounter

+ NewAlbums func() []string

+ Skipped func() MediaCounter

+ func Backup(owner string, volume SourceVolume, optionsSlice ...Options) (CompletionReport, error)

+ type DetailsReaderAdapter interface

+ ReadDetails func(reader io.Reader, options DetailsReaderOptions) (*MediaDetails, error)

+ Supports func(media FoundMedia, mediaType MediaType) bool

+ type DetailsReaderOptions struct

+ Fast bool

+ type FoundMedia interface

+ MediaPath func() MediaPath

+ ReadMedia func() (io.ReadCloser, error)

+ Size func() int

+ String func() string

+ func NewInmemoryMedia(name string, date time.Time, content []byte) FoundMedia

+ type FullMediaSignature struct

+ Sha256 string

+ Size uint

+ func (s *FullMediaSignature) String() string

+ type ImageOrientation string

+ type InmemoryMedia struct

+ func (i *InmemoryMedia) MediaPath() MediaPath

+ func (i *InmemoryMedia) ReadMedia() (io.ReadCloser, error)

+ func (i *InmemoryMedia) Size() int

+ func (i *InmemoryMedia) String() string

+ type MediaCounter struct

+ Count int

+ Size int

+ func NewMediaCounter(count int, size int) MediaCounter

+ func (c MediaCounter) Add(count int, size int) MediaCounter

+ func (c MediaCounter) AddCounter(counter MediaCounter) MediaCounter

+ func (c MediaCounter) IsZero() bool

+ type MediaDetails struct

+ DateTime time.Time

+ Duration int64

+ GPSLatitude float64

+ GPSLongitude float64

+ Height int

+ Make string

+ Model string

+ Orientation ImageOrientation

+ VideoEncoding string

+ Width int

+ func (s *MediaDetails) String() string

+ type MediaPath struct

+ Filename string

+ ParentDir string

+ ParentFullPath string

+ Path string

+ Root string

+ type MediaType string

+ type Options struct

+ Listener interface{}

+ RestrictedAlbumFolderName map[string]interface{}

+ SkipRejects bool

+ func OptionOnlyAlbums(albums ...string) Options

+ func OptionSkipRejects(skip bool) Options

+ func OptionWithListener(listener interface{}) Options

+ type PostAnalyseFilter interface

+ AcceptAnalysedMedia func(media *AnalysedMedia, folderName string) bool

+ type ProgressEvent struct

+ Album string

+ Count int

+ MediaType MediaType

+ Size int

+ Type ProgressEventType

+ type ProgressEventType string

+ type ScannedFolder struct

+ AbsolutePath string

+ Distribution map[string]MediaCounter

+ End time.Time

+ FolderName string

+ Name string

+ RelativePath string

+ Start time.Time

+ func (f *ScannedFolder) PushBoundaries(date time.Time, size int)

+ type SourceVolume interface

+ FindMedias func() ([]FoundMedia, error)

+ String func() string

+ type TimelineAdapter interface

+ FindAlbum func(dateTime time.Time) (folderName string, exists bool, err error)

+ FindOrCreateAlbum func(mediaTime time.Time) (folderName string, created bool, err error)

+ type TrackAnalysed interface

+ OnAnalysed func(done, total MediaCounter)

+ type TrackEvents interface

+ OnEvent func(event ProgressEvent)

+ type TrackScanComplete interface

+ OnScanComplete func(total MediaCounter)

+ type TrackUploaded interface

+ OnUploaded func(done, total MediaCounter)

+ type Tracker struct

+ Done chan struct{}

+ func NewTracker(progressChannel chan *ProgressEvent, listeners ...interface{}) *Tracker

+ func (t *Tracker) CountPerAlbum() map[string]*TypeCounter

+ func (t *Tracker) NewAlbums() []string

+ func (t *Tracker) Skipped() MediaCounter

+ func (t *Tracker) WaitToComplete()

+ type TypeCounter struct

+ func NewTypeCounter(mediaType MediaType, count int, size int) *TypeCounter

+ func (c *TypeCounter) GetMediaIndex(mediaType MediaType) int

+ func (c *TypeCounter) IncrementCounter(counter *[numberOfMediaType]int, mediaType MediaType, delta int)

+ func (c *TypeCounter) IncrementFoundCounter(mediaType MediaType, count int, size int) *TypeCounter

+ func (c *TypeCounter) OfType(mediaType MediaType) MediaCounter

+ func (c *TypeCounter) Total() MediaCounter