catalogviews

package
v1.9.78 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 23, 2026 License: AGPL-3.0 Imports: 10 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AlbumCount added in v1.9.61

type AlbumCount struct {
	AlbumId    catalog.AlbumId
	MediaCount int
}

type AlbumCountDiff added in v1.9.61

type AlbumCountDiff struct {
	AlbumId        catalog.AlbumId
	MediaCountDiff int
}

type AlbumSummary added in v1.9.61

type AlbumSummary struct {
	AlbumId    catalog.AlbumId
	MediaCount int
	Name       string
	Start      time.Time
	End        time.Time
	Covers     []catalog.Cover
}

AlbumSummary is the per-album projection carried by the main album-list row: identity, display fields and the media count. The cover set lives on a sibling row (see AlbumCoversForUsers); the adapter merges both rows per album in Covers when a view is read.

type AlbumSummaryForUsers added in v1.9.61

type AlbumSummaryForUsers struct {
	AlbumSummary
	Users []Availability
}

AlbumSummaryForUsers is a full projection to be written for a set of users (owner + visitors). When Covers is non-empty, PutSummaries writes the sibling cover row for the listed users in the same call so a newly-created viewer row carries its covers without a second fan-out. Cross-viewer cover updates (cover changes, backfills) still travel through PutCoversForAllViewers so they stay independent from count / display-field writes.

func (AlbumSummaryForUsers) String added in v1.9.61

func (a AlbumSummaryForUsers) String() string

type AlbumSummaryInMemoryRepository added in v1.9.61

type AlbumSummaryInMemoryRepository struct {
	Summaries                 []UserAlbumSummary
	LegacyRowsCleanedForUsers []usermodel.UserId
}

func (*AlbumSummaryInMemoryRepository) DeleteAllRowsForAlbum added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) DeleteAllRowsForAlbum(ctx context.Context, albumId catalog.AlbumId) error

func (*AlbumSummaryInMemoryRepository) DeleteCoversForAllViewers added in v1.9.63

func (r *AlbumSummaryInMemoryRepository) DeleteCoversForAllViewers(ctx context.Context, albumId catalog.AlbumId) error

func (*AlbumSummaryInMemoryRepository) DeleteLegacyRowsForUser added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) DeleteLegacyRowsForUser(_ context.Context, userId usermodel.UserId) error

func (*AlbumSummaryInMemoryRepository) DeleteRow added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) DeleteRow(ctx context.Context, availability Availability, albumId catalog.AlbumId) error

func (*AlbumSummaryInMemoryRepository) IncrementCountForAllViewers added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) IncrementCountForAllViewers(ctx context.Context, updates []AlbumCountDiff) error

func (*AlbumSummaryInMemoryRepository) ListSummariesForUser added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) ListSummariesForUser(ctx context.Context, userId usermodel.UserId) ([]UserAlbumSummary, error)

func (*AlbumSummaryInMemoryRepository) ListSummariesForUserAndOwners added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) ListSummariesForUserAndOwners(ctx context.Context, userId usermodel.UserId, owner ...ownermodel.Owner) ([]UserAlbumSummary, error)

func (*AlbumSummaryInMemoryRepository) PutCoversForAllViewers added in v1.9.63

func (r *AlbumSummaryInMemoryRepository) PutCoversForAllViewers(ctx context.Context, albumId catalog.AlbumId, covers []catalog.Cover) error

func (*AlbumSummaryInMemoryRepository) PutSummaries added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) PutSummaries(ctx context.Context, summaries []AlbumSummaryForUsers) error

func (*AlbumSummaryInMemoryRepository) RenameAlbum added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) RenameAlbum(ctx context.Context, existingId, renamedId catalog.AlbumId, newName string) error

func (*AlbumSummaryInMemoryRepository) SetCountForAllViewers added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) SetCountForAllViewers(ctx context.Context, updates []AlbumCount) error

func (*AlbumSummaryInMemoryRepository) SetDisplayFieldsForAllViewers added in v1.9.61

func (r *AlbumSummaryInMemoryRepository) SetDisplayFieldsForAllViewers(ctx context.Context, albumId catalog.AlbumId, name string, start, end time.Time) error

type AlbumSummaryRepository added in v1.9.61

type AlbumSummaryRepository interface {
	ListSummariesForUser(ctx context.Context, userId usermodel.UserId) ([]UserAlbumSummary, error)
	PutSummaries(ctx context.Context, summaries []AlbumSummaryForUsers) error
	SetDisplayFieldsForAllViewers(ctx context.Context, albumId catalog.AlbumId, name string, start, end time.Time) error
	PutCoversForAllViewers(ctx context.Context, albumId catalog.AlbumId, covers []catalog.Cover) error
	DeleteCoversForAllViewers(ctx context.Context, albumId catalog.AlbumId) error
	IncrementCountForAllViewers(ctx context.Context, updates []AlbumCountDiff) error
	SetCountForAllViewers(ctx context.Context, updates []AlbumCount) error
	RenameAlbum(ctx context.Context, existingId, renamedId catalog.AlbumId, newName string) error
	DeleteRow(ctx context.Context, availability Availability, albumId catalog.AlbumId) error
	DeleteAllRowsForAlbum(ctx context.Context, albumId catalog.AlbumId) error
}

type AlbumSummaryReprojector added in v1.9.61

type AlbumSummaryReprojector struct {
	ListUserWhoCanAccessAlbumPort ListUserWhoCanAccessAlbumPort
	MediaCounterPort              MediaCounterPort
	FindCoversByAlbumPort         FindCoversByAlbumPort
}

AlbumSummaryReprojector rebuilds AlbumSummaryForUsers projections from canonical albums, combining media counts, viewer availabilities and the album cover set queried per call. The albums are supplied by the caller so it can decide the scope (per-owner, per-album, ...) without a second round-trip.

func (*AlbumSummaryReprojector) Reproject added in v1.9.61

Reproject returns the expected AlbumSummaryForUsers for every album.

type AlbumView

type AlbumView struct {
	Repository              AlbumSummaryRepository
	GetAlbumSharingGridPort GetAlbumSharingGridPort
	MediaCounterPort        MediaCounterPort
	FindAlbumsByIdsPort     FindAlbumsByIdsPort
	OwnerUserIdPort         OwnerUserIdPort
	FindCoversByAlbumPort   FindCoversByAlbumPort
}

func NewAlbumView added in v1.5.49

func NewAlbumView(
	repository AlbumSummaryRepository,
	getAlbumSharingGridPort GetAlbumSharingGridPort,
	mediaCounterPort MediaCounterPort,
	findAlbumsByIdsPort FindAlbumsByIdsPort,
	ownerUserIdPort OwnerUserIdPort,
	findCoversByAlbumPort FindCoversByAlbumPort,
) *AlbumView

func (*AlbumView) AlbumShared added in v1.9.61

func (v *AlbumView) AlbumShared(ctx context.Context, album catalog.Album, userId usermodel.UserId) error

func (*AlbumView) AlbumUnShared added in v1.9.61

func (v *AlbumView) AlbumUnShared(ctx context.Context, albumId catalog.AlbumId, userId usermodel.UserId) error

func (*AlbumView) ListAlbums

func (v *AlbumView) ListAlbums(ctx context.Context, user usermodel.CurrentUser, filter ListAlbumsFilter) ([]*VisibleAlbum, error)

func (*AlbumView) OnAlbumCoversRandomised added in v1.9.63

func (v *AlbumView) OnAlbumCoversRandomised(ctx context.Context, event catalog.AlbumCoversRandomised) error

func (*AlbumView) OnAlbumCreated added in v1.9.61

func (v *AlbumView) OnAlbumCreated(ctx context.Context, event catalog.AlbumCreated) error

func (*AlbumView) OnAlbumDatesAmended added in v1.9.61

func (v *AlbumView) OnAlbumDatesAmended(ctx context.Context, event catalog.AlbumDatesAmended) error

func (*AlbumView) OnAlbumDeleted added in v1.9.61

func (v *AlbumView) OnAlbumDeleted(ctx context.Context, event catalog.AlbumDeleted) error

func (*AlbumView) OnAlbumRenamed added in v1.9.61

func (v *AlbumView) OnAlbumRenamed(ctx context.Context, event catalog.AlbumRenamed) error

func (*AlbumView) OnCoverBackfilled added in v1.9.63

func (v *AlbumView) OnCoverBackfilled(ctx context.Context, coversByAlbumId map[catalog.AlbumId][]catalog.Cover) error

OnCoverBackfilled denormalises the cover sets produced by an admin backfill into every viewer's cover row. The backfill is the only path that writes covers outside of a lifecycle event, so it needs its own observer hook.

func (*AlbumView) OnMediasInserted added in v1.9.61

func (v *AlbumView) OnMediasInserted(ctx context.Context, event catalog.MediasInserted) error

type Availability added in v1.6.4

type Availability struct {
	UserId  usermodel.UserId
	AsOwner bool // AsOwner is true if the user is the owner of the album
}

func OwnerAvailability added in v1.6.4

func OwnerAvailability(userId usermodel.UserId) Availability

func VisitorAvailability added in v1.6.4

func VisitorAvailability(userId usermodel.UserId) Availability

func (Availability) String added in v1.6.7

func (a Availability) String() string

type DeleteCoversForAllViewersPort added in v1.9.63

type DeleteCoversForAllViewersPort interface {
	DeleteCoversForAllViewers(ctx context.Context, albumId catalog.AlbumId) error
}

type DeleteLegacyRowsForUserPort added in v1.9.61

type DeleteLegacyRowsForUserPort interface {
	DeleteLegacyRowsForUser(ctx context.Context, userId usermodel.UserId) error
}

type DeleteRowPort added in v1.9.61

type DeleteRowPort interface {
	DeleteRow(ctx context.Context, availability Availability, albumId catalog.AlbumId) error
}

type Drift added in v1.6.7

type Drift struct {
	AlbumId     catalog.AlbumId
	Reason      DriftReason
	Expected    *UserAlbumSummary // Expected is the row that should exist ; set on MISSING and OVERRIDDEN.
	NotExpected *UserAlbumSummary // NotExpected is the row that currently exists but must be removed ; set on DELETED.
}

Drift describes a single divergence between a projection and its canonical source, for one album and one viewer. Expected is set when the row must be written; NotExpected is set when a row must be removed. Both are set for a swap (availability changed).

func NewDeletedDrift added in v1.9.61

func NewDeletedDrift(current UserAlbumSummary) Drift

func NewMissingDrift added in v1.6.7

func NewMissingDrift(expected UserAlbumSummary) Drift

func NewOverrideDrift added in v1.6.7

func NewOverrideDrift(expected UserAlbumSummary) Drift

type DriftDetector added in v1.6.7

type DriftDetector struct {
	GetCurrentAlbumSummariesPort GetCurrentAlbumSummariesPort
}

DriftDetector compares an expected projection against the current stored projection and returns the per-album drifts.

func (*DriftDetector) Detect added in v1.9.61

func (d *DriftDetector) Detect(ctx context.Context, summaries []AlbumSummaryForUsers) ([]Drift, []usermodel.UserId, error)

type DriftObserver added in v1.6.7

type DriftObserver interface {
	OnDetectedDrifts(ctx context.Context, drifts []Drift) error
}

type DriftOption added in v1.6.7

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

func DriftOptionDryMode added in v1.6.7

func DriftOptionDryMode(dry bool, synchronizer DriftSynchronizerPort) DriftOption

DriftOptionDryMode enable or not the DRY mode.

func DriftOptionObserver added in v1.6.7

func DriftOptionObserver(observer DriftObserver) DriftOption

DriftOptionObserver adds a custom observer.

func DriftOptionSynchronizer added in v1.6.7

func DriftOptionSynchronizer(synchronizer DriftSynchronizerPort) DriftOption

func (*DriftOption) Observer added in v1.6.7

func (o *DriftOption) Observer() DriftObserver

type DriftReason added in v1.9.61

type DriftReason string

DriftReason categorises a Drift.

const (
	DriftReasonMissing    DriftReason = "MISSING"    // row absent from the projection but expected
	DriftReasonOverridden DriftReason = "OVERRIDDEN" // row present but with a stale content
	DriftReasonDeleted    DriftReason = "DELETED"    // row present but not expected any more (must be removed)
)

type DriftSynchronizerObserver added in v1.6.7

type DriftSynchronizerObserver struct {
	DriftSynchronizerPort DriftSynchronizerPort
}

func (*DriftSynchronizerObserver) OnDetectedDrifts added in v1.6.7

func (d *DriftSynchronizerObserver) OnDetectedDrifts(ctx context.Context, drifts []Drift) error

func (*DriftSynchronizerObserver) OnReconciledUser added in v1.9.61

func (d *DriftSynchronizerObserver) OnReconciledUser(ctx context.Context, userId usermodel.UserId) error

type FindAlbumByOwnerFunc added in v1.5.49

type FindAlbumByOwnerFunc func(ctx context.Context, owner ownermodel.Owner) ([]*catalog.Album, error)

func (FindAlbumByOwnerFunc) FindAlbumsByOwner added in v1.5.49

func (f FindAlbumByOwnerFunc) FindAlbumsByOwner(ctx context.Context, owner ownermodel.Owner) ([]*catalog.Album, error)

type FindAlbumByOwnerPort

type FindAlbumByOwnerPort interface {
	FindAlbumsByOwner(ctx context.Context, owner ownermodel.Owner) ([]*catalog.Album, error)
}

type FindAlbumsByIdsFunc added in v1.5.49

type FindAlbumsByIdsFunc func(ctx context.Context, ids []catalog.AlbumId) ([]*catalog.Album, error)

func (FindAlbumsByIdsFunc) FindAlbumsById added in v1.5.49

func (f FindAlbumsByIdsFunc) FindAlbumsById(ctx context.Context, ids []catalog.AlbumId) ([]*catalog.Album, error)

type FindAlbumsByIdsPort

type FindAlbumsByIdsPort interface {
	FindAlbumsById(ctx context.Context, ids []catalog.AlbumId) ([]*catalog.Album, error)
}

type FindCoversByAlbumFunc added in v1.9.63

type FindCoversByAlbumFunc func(ctx context.Context, albumId catalog.AlbumId) ([]catalog.Cover, error)

func (FindCoversByAlbumFunc) FindCoversByAlbum added in v1.9.63

func (f FindCoversByAlbumFunc) FindCoversByAlbum(ctx context.Context, albumId catalog.AlbumId) ([]catalog.Cover, error)

type FindCoversByAlbumPort added in v1.9.63

type FindCoversByAlbumPort interface {
	FindCoversByAlbum(ctx context.Context, albumId catalog.AlbumId) ([]catalog.Cover, error)
}

type GetAlbumSharingGridFunc added in v1.5.49

type GetAlbumSharingGridFunc func(ctx context.Context, owner ownermodel.Owner) (map[catalog.AlbumId][]usermodel.UserId, error)

func (GetAlbumSharingGridFunc) GetAlbumSharingGrid added in v1.5.49

func (f GetAlbumSharingGridFunc) GetAlbumSharingGrid(ctx context.Context, owner ownermodel.Owner) (map[catalog.AlbumId][]usermodel.UserId, error)

type GetAlbumSharingGridPort added in v1.5.49

type GetAlbumSharingGridPort interface {
	GetAlbumSharingGrid(ctx context.Context, owner ownermodel.Owner) (map[catalog.AlbumId][]usermodel.UserId, error)
}

type GetCurrentAlbumSummariesPort added in v1.9.61

type GetCurrentAlbumSummariesPort interface {
	ListSummariesForUserAndOwners(ctx context.Context, userId usermodel.UserId, owner ...ownermodel.Owner) ([]UserAlbumSummary, error)
}

type LegacyRowsCleaner added in v1.9.61

type LegacyRowsCleaner interface {
	OnReconciledUser(ctx context.Context, userId usermodel.UserId) error
}

type ListAlbumsFilter

type ListAlbumsFilter struct {
	OnlyDirectlyOwned bool // OnlyDirectlyOwned provides a sub-view where only resources directly owned by user are displayed and accessible
}

type ListUserWhoCanAccessAlbumPort added in v1.6.4

type ListUserWhoCanAccessAlbumPort interface {
	ListUsersWhoCanAccessAlbum(ctx context.Context, albumId ...catalog.AlbumId) (map[catalog.AlbumId][]Availability, error)
}

type LoggerDriftObserver added in v1.6.7

type LoggerDriftObserver struct{}

func (LoggerDriftObserver) OnDetectedDrifts added in v1.6.7

func (l LoggerDriftObserver) OnDetectedDrifts(_ context.Context, drifts []Drift) error

type MediaCounterFunc added in v1.5.50

type MediaCounterFunc func(ctx context.Context, album ...catalog.AlbumId) (map[catalog.AlbumId]int, error)

func (MediaCounterFunc) CountMedia added in v1.5.50

func (f MediaCounterFunc) CountMedia(ctx context.Context, album ...catalog.AlbumId) (map[catalog.AlbumId]int, error)

type MediaCounterPort added in v1.5.50

type MediaCounterPort interface {
	CountMedia(ctx context.Context, album ...catalog.AlbumId) (map[catalog.AlbumId]int, error)
}

type OwnerDriftReconciler added in v1.6.7

type OwnerDriftReconciler struct {
	FindAlbumByOwnerPort    FindAlbumByOwnerPort
	AlbumSummaryReprojector AlbumSummaryReprojector
	DriftDetector           *DriftDetector
	DriftObservers          []DriftObserver
}

func NewDriftReconciler added in v1.6.7

func NewDriftReconciler(
	findAlbumByOwnerPort FindAlbumByOwnerPort,
	getCurrentAlbumSummariesPort GetCurrentAlbumSummariesPort,
	listUserWhoCanAccessAlbumPort ListUserWhoCanAccessAlbumPort,
	mediaCounterPort MediaCounterPort,
	findCoversByAlbumPort FindCoversByAlbumPort,
	driftOptions ...DriftOption,
) *OwnerDriftReconciler

NewDriftReconciler creates a new DriftReconciler in DRY mode ; use the option DriftOptionSynchronizer to reconcile.

func (*OwnerDriftReconciler) Reconcile added in v1.6.7

func (d *OwnerDriftReconciler) Reconcile(ctx context.Context, owner ownermodel.Owner) ([]Drift, error)

Reconcile rebuilds the album-list projection for the owner, detects drifts against the current projection, hands them to every observer (logger, synchronizer, ...) and returns them so callers can render their own reports.

type OwnerUserIdFunc added in v1.9.61

type OwnerUserIdFunc func(ctx context.Context, owner ownermodel.Owner) (usermodel.UserId, error)

func (OwnerUserIdFunc) GetOwnerUserId added in v1.9.61

func (f OwnerUserIdFunc) GetOwnerUserId(ctx context.Context, owner ownermodel.Owner) (usermodel.UserId, error)

type OwnerUserIdPort added in v1.9.61

type OwnerUserIdPort interface {
	GetOwnerUserId(ctx context.Context, owner ownermodel.Owner) (usermodel.UserId, error)
}

type PutCoversForAllViewersPort added in v1.9.63

type PutCoversForAllViewersPort interface {
	PutCoversForAllViewers(ctx context.Context, albumId catalog.AlbumId, covers []catalog.Cover) error
}

type PutSummariesPort added in v1.9.61

type PutSummariesPort interface {
	PutSummaries(ctx context.Context, summaries []AlbumSummaryForUsers) error
}

type UserAlbumSummary added in v1.9.61

type UserAlbumSummary struct {
	AlbumSummary AlbumSummary
	Availability Availability
}

func (UserAlbumSummary) ToSummaryForUsers added in v1.9.61

func (s UserAlbumSummary) ToSummaryForUsers() AlbumSummaryForUsers

type VisibleAlbum

type VisibleAlbum struct {
	catalog.Album
	MediaCount         int                // MediaCount is the number of medias on the album
	Visitors           []usermodel.UserId // Visitors are the users that can see the album ; only visible to the owner of the album
	OwnedByCurrentUser bool               // OwnedByCurrentUser is set to true when the user is an owner of the album
	Covers             []catalog.Cover    // Covers are the 0 to 4 featured medias of the album, denormalised from the canonical cover set
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL