Skip to content

Commit

Permalink
Covers: Rename "preview images" to "cover thumbs" for consistency #383
Browse files Browse the repository at this point in the history
  • Loading branch information
lastzero committed Oct 1, 2021
1 parent f6c18f7 commit 7423380
Show file tree
Hide file tree
Showing 17 changed files with 101 additions and 101 deletions.
8 changes: 4 additions & 4 deletions internal/api/batch.go
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ func BatchPhotosArchive(router *gin.RouterGroup) {
// Update precalculated photo and file counts.
logError("photos", entity.UpdatePhotoCounts())

// Update album, subject, and label preview thumbs.
logError("photos", query.UpdatePreviews())
// Update album, subject, and label cover thumbs.
logError("photos", query.UpdateCovers())

UpdateClientConfig()

Expand Down Expand Up @@ -130,8 +130,8 @@ func BatchPhotosRestore(router *gin.RouterGroup) {
// Update precalculated photo and file counts.
logError("photos", entity.UpdatePhotoCounts())

// Update album, subject, and label preview thumbs.
logError("photos", query.UpdatePreviews())
// Update album, subject, and label cover thumbs.
logError("photos", query.UpdateCovers())

UpdateClientConfig()

Expand Down
6 changes: 3 additions & 3 deletions internal/api/cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ func RemoveFromFolderCache(rootName string) {

cache.Delete(cacheKey)

if err := query.UpdateAlbumFolderPreviews(); err != nil {
if err := query.UpdateAlbumFolderCovers(); err != nil {
log.Error(err)
}

Expand All @@ -65,7 +65,7 @@ func RemoveFromAlbumCoverCache(uid string) {
log.Debugf("removed %s from cache", cacheKey)
}

if err := query.UpdateAlbumPreviews(); err != nil {
if err := query.UpdateAlbumCovers(); err != nil {
log.Error(err)
}
}
Expand All @@ -74,7 +74,7 @@ func RemoveFromAlbumCoverCache(uid string) {
func FlushCoverCache() {
service.CoverCache().Flush()

if err := query.UpdatePreviews(); err != nil {
if err := query.UpdateCovers(); err != nil {
log.Error(err)
}

Expand Down
6 changes: 3 additions & 3 deletions internal/api/import.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,9 @@ func StartImport(router *gin.RouterGroup) {

UpdateClientConfig()

// Update album, label, and subject preview images.
if err := query.UpdatePreviews(); err != nil {
log.Errorf("import: %s (update previews)", err)
// Update album, label, and subject cover thumbs.
if err := query.UpdateCovers(); err != nil {
log.Errorf("import: %s (update covers)", err)
}

c.JSON(http.StatusOK, i18n.Response{Code: http.StatusOK, Msg: msg})
Expand Down
8 changes: 4 additions & 4 deletions internal/api/marker.go
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ func UpdateMarker(router *gin.RouterGroup) {
}
}

if err := query.UpdateSubjectPreviews(); err != nil {
log.Errorf("faces: %s (update previews)", err)
if err := query.UpdateSubjectCovers(); err != nil {
log.Errorf("faces: %s (update covers)", err)
}

if err := entity.UpdateSubjectCounts(); err != nil {
Expand Down Expand Up @@ -148,8 +148,8 @@ func ClearMarkerSubject(router *gin.RouterGroup) {
log.Errorf("faces: %s (clear subject)", err)
AbortSaveFailed(c)
return
} else if err := query.UpdateSubjectPreviews(); err != nil {
log.Errorf("faces: %s (update previews)", err)
} else if err := query.UpdateSubjectCovers(); err != nil {
log.Errorf("faces: %s (update covers)", err)
} else if err := entity.UpdateSubjectCounts(); err != nil {
log.Errorf("faces: %s (update counts)", err)
}
Expand Down
2 changes: 1 addition & 1 deletion internal/api/share_preview.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func SharePreview(router *gin.RouterGroup) {

var f form.PhotoSearch

// Previews may only contain public content in shared albums.
// Covers may only contain public content in shared albums.
f.Album = share
f.Public = true
f.Private = false
Expand Down
4 changes: 2 additions & 2 deletions internal/entity/file.go
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,7 @@ func (m *File) DeletePermanently() error {
}

if err := m.ReplaceHash(""); err != nil {
log.Errorf("file: %s (remove previews)", err)
log.Errorf("file: %s (remove covers)", err)
}

return UnscopedDb().Delete(m).Error
Expand Down Expand Up @@ -262,7 +262,7 @@ func (m *File) ReplaceHash(newHash string) error {
if res := UnscopedDb().Model(entity).Where("thumb = ?", oldHash).UpdateColumn("thumb", newHash); res.Error != nil {
return res.Error
} else if res.RowsAffected > 0 {
log.Infof("%s: %s updated [%s]", name, english.Plural(int(res.RowsAffected), "preview", "previews"), time.Since(start))
log.Infof("%s: %s updated [%s]", name, english.Plural(int(res.RowsAffected), "cover", "covers"), time.Since(start))
}
}

Expand Down
8 changes: 4 additions & 4 deletions internal/photoprism/cleanup.go
Original file line number Diff line number Diff line change
Expand Up @@ -157,11 +157,11 @@ func (w *CleanUp) Start(opt CleanUpOptions) (thumbs int, orphans int, err error)
log.Errorf("cleanup: %s (update counts)", err)
}

log.Info("updating preview thumbs")
log.Info("updating cover thumbs")

// Update album, subject, and label preview thumbs.
if err := query.UpdatePreviews(); err != nil {
log.Errorf("cleanup: %s (update previews)", err)
// Update album, subject, and label cover thumbs.
if err := query.UpdateCovers(); err != nil {
log.Errorf("cleanup: %s (update covers)", err)
}

// Show success notification.
Expand Down
2 changes: 1 addition & 1 deletion internal/photoprism/index_mediafile.go
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ func (ind *Index) MediaFile(m *MediaFile, o IndexOptions, originalName string) (
if !fileExists || file.FileHash == "" || file.FileHash == fileHash {
// Do nothing.
} else if err := file.ReplaceHash(fileHash); err != nil {
log.Errorf("index: %s while updating previews of %s", err, logName)
log.Errorf("index: %s while updating covers of %s", err, logName)
}

photo.PhotoPath = filePath
Expand Down
8 changes: 4 additions & 4 deletions internal/photoprism/purge.go
Original file line number Diff line number Diff line change
Expand Up @@ -280,10 +280,10 @@ func (w *Purge) Start(opt PurgeOptions) (purgedFiles map[string]bool, purgedPhot
log.Errorf("purge: %s (update counts)", err)
}

// Update album, subject, and label preview thumbs.
log.Info("updating preview thumbs")
if err := query.UpdatePreviews(); err != nil {
log.Errorf("purge: %s (update previews)", err)
// Update album, subject, and label cover thumbs.
log.Info("updating cover thumbs")
if err := query.UpdateCovers(); err != nil {
log.Errorf("purge: %s (update covers)", err)
}

return purgedFiles, purgedPhotos, nil
Expand Down
2 changes: 1 addition & 1 deletion internal/query/albums.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func AlbumByUID(albumUID string) (album entity.Album, err error) {
return album, nil
}

// AlbumCoverByUID returns a album preview file based on the uid.
// AlbumCoverByUID returns an album cover file based on the uid.
func AlbumCoverByUID(uid string) (file entity.File, err error) {
a := entity.Album{}

Expand Down
60 changes: 30 additions & 30 deletions internal/query/previews.go → internal/query/covers.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ import (
"github.com/photoprism/photoprism/internal/entity"
)

// UpdateAlbumDefaultPreviews updates default album preview images.
func UpdateAlbumDefaultPreviews() (err error) {
// UpdateAlbumDefaultCovers updates default album cover thumbs.
func UpdateAlbumDefaultCovers() (err error) {
start := time.Now()

var res *gorm.DB
Expand Down Expand Up @@ -48,18 +48,18 @@ func UpdateAlbumDefaultPreviews() (err error) {
err = res.Error

if err == nil {
log.Debugf("previews: %s updated [%s]", english.Plural(int(res.RowsAffected), "album", "albums"), time.Since(start))
log.Debugf("covers: %s updated [%s]", english.Plural(int(res.RowsAffected), "album", "albums"), time.Since(start))
} else if strings.Contains(err.Error(), "Error 1054") {
log.Errorf("previews: failed updating albums, potentially incompatible database version")
log.Errorf("covers: failed updating albums, potentially incompatible database version")
log.Errorf("%s see https://jira.mariadb.org/browse/MDEV-25362", err)
return nil
}

return err
}

// UpdateAlbumFolderPreviews updates folder album preview images.
func UpdateAlbumFolderPreviews() (err error) {
// UpdateAlbumFolderCovers updates folder album cover thumbs.
func UpdateAlbumFolderCovers() (err error) {
start := time.Now()

var res *gorm.DB
Expand Down Expand Up @@ -95,18 +95,18 @@ func UpdateAlbumFolderPreviews() (err error) {
err = res.Error

if err == nil {
log.Debugf("previews: %s updated [%s]", english.Plural(int(res.RowsAffected), "folder", "folders"), time.Since(start))
log.Debugf("covers: %s updated [%s]", english.Plural(int(res.RowsAffected), "folder", "folders"), time.Since(start))
} else if strings.Contains(err.Error(), "Error 1054") {
log.Errorf("previews: failed updating folders, potentially incompatible database version")
log.Errorf("covers: failed updating folders, potentially incompatible database version")
log.Errorf("%s see https://jira.mariadb.org/browse/MDEV-25362", err)
return nil
}

return err
}

// UpdateAlbumMonthPreviews updates month album preview images.
func UpdateAlbumMonthPreviews() (err error) {
// UpdateAlbumMonthCovers updates month album cover thumbs.
func UpdateAlbumMonthCovers() (err error) {
start := time.Now()

var res *gorm.DB
Expand Down Expand Up @@ -142,38 +142,38 @@ func UpdateAlbumMonthPreviews() (err error) {
err = res.Error

if err == nil {
log.Debugf("previews: %s updated [%s]", english.Plural(int(res.RowsAffected), "month", "months"), time.Since(start))
log.Debugf("covers: %s updated [%s]", english.Plural(int(res.RowsAffected), "month", "months"), time.Since(start))
} else if strings.Contains(err.Error(), "Error 1054") {
log.Errorf("previews: failed updating calendar, potentially incompatible database version")
log.Errorf("covers: failed updating calendar, potentially incompatible database version")
log.Errorf("%s see https://jira.mariadb.org/browse/MDEV-25362", err)
return nil
}

return err
}

// UpdateAlbumPreviews updates album preview images.
func UpdateAlbumPreviews() (err error) {
// UpdateAlbumCovers updates album cover thumbs.
func UpdateAlbumCovers() (err error) {
// Update Default Albums.
if err = UpdateAlbumDefaultPreviews(); err != nil {
if err = UpdateAlbumDefaultCovers(); err != nil {
return err
}

// Update Folder Albums.
if err = UpdateAlbumFolderPreviews(); err != nil {
if err = UpdateAlbumFolderCovers(); err != nil {
return err
}

// Update Monthly Albums.
if err = UpdateAlbumMonthPreviews(); err != nil {
if err = UpdateAlbumMonthCovers(); err != nil {
return err
}

return nil
}

// UpdateLabelPreviews updates label preview images.
func UpdateLabelPreviews() (err error) {
// UpdateLabelCovers updates label cover thumbs.
func UpdateLabelCovers() (err error) {
start := time.Now()

var res *gorm.DB
Expand Down Expand Up @@ -226,18 +226,18 @@ func UpdateLabelPreviews() (err error) {
err = res.Error

if err == nil {
log.Debugf("previews: %s updated [%s]", english.Plural(int(res.RowsAffected), "label", "labels"), time.Since(start))
log.Debugf("covers: %s updated [%s]", english.Plural(int(res.RowsAffected), "label", "labels"), time.Since(start))
} else if strings.Contains(err.Error(), "Error 1054") {
log.Errorf("previews: failed updating labels, potentially incompatible database version")
log.Errorf("covers: failed updating labels, potentially incompatible database version")
log.Errorf("%s see https://jira.mariadb.org/browse/MDEV-25362", err)
return nil
}

return err
}

// UpdateSubjectPreviews updates subject preview images.
func UpdateSubjectPreviews() (err error) {
// UpdateSubjectCovers updates subject cover thumbs.
func UpdateSubjectCovers() (err error) {
start := time.Now()

var res *gorm.DB
Expand Down Expand Up @@ -272,30 +272,30 @@ func UpdateSubjectPreviews() (err error) {
err = res.Error

if err == nil {
log.Debugf("previews: %s updated [%s]", english.Plural(int(res.RowsAffected), "subject", "subjects"), time.Since(start))
log.Debugf("covers: %s updated [%s]", english.Plural(int(res.RowsAffected), "subject", "subjects"), time.Since(start))
} else if strings.Contains(err.Error(), "Error 1054") {
log.Errorf("previews: failed updating subjects, potentially incompatible database version")
log.Errorf("covers: failed updating subjects, potentially incompatible database version")
log.Errorf("%s see https://jira.mariadb.org/browse/MDEV-25362", err)
return nil
}

return err
}

// UpdatePreviews updates album, subject, and label preview thumbs.
func UpdatePreviews() (err error) {
// UpdateCovers updates album, subject, and label cover thumbs.
func UpdateCovers() (err error) {
// Update Albums.
if err = UpdateAlbumPreviews(); err != nil {
if err = UpdateAlbumCovers(); err != nil {
return err
}

// Update Labels.
if err = UpdateLabelPreviews(); err != nil {
if err = UpdateLabelCovers(); err != nil {
return err
}

// Update Subjects.
if err = UpdateSubjectPreviews(); err != nil {
if err = UpdateSubjectCovers(); err != nil {
return err
}

Expand Down
35 changes: 35 additions & 0 deletions internal/query/covers_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package query

import (
"testing"

"github.com/stretchr/testify/assert"
)

func TestUpdateAlbumDefaultCovers(t *testing.T) {
assert.NoError(t, UpdateAlbumDefaultCovers())
}

func TestUpdateAlbumFolderCovers(t *testing.T) {
assert.NoError(t, UpdateAlbumFolderCovers())
}

func TestUpdateAlbumMonthCovers(t *testing.T) {
assert.NoError(t, UpdateAlbumMonthCovers())
}

func TestUpdateAlbumCovers(t *testing.T) {
assert.NoError(t, UpdateAlbumCovers())
}

func TestUpdateLabelCovers(t *testing.T) {
assert.NoError(t, UpdateLabelCovers())
}

func TestUpdateSubjectCovers(t *testing.T) {
assert.NoError(t, UpdateSubjectCovers())
}

func TestUpdateCovers(t *testing.T) {
assert.NoError(t, UpdateCovers())
}
2 changes: 1 addition & 1 deletion internal/query/folders.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ func FoldersByPath(rootName, rootPath, path string, recursive bool) (folders ent
return folders, nil
}

// FolderCoverByUID returns a folder preview file based on the uid.
// FolderCoverByUID returns a folder cover file based on the uid.
func FolderCoverByUID(uid string) (file entity.File, err error) {
if err := Db().Where("files.file_primary = 1 AND files.file_missing = 0 AND files.file_type = 'jpg' AND files.deleted_at IS NULL").
Joins("JOIN photos ON photos.id = files.photo_id AND photos.deleted_at IS NULL AND photos.photo_quality > -1").
Expand Down
4 changes: 2 additions & 2 deletions internal/query/label.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func LabelByUID(labelUID string) (label entity.Label, err error) {
return label, nil
}

// LabelThumbBySlug returns a label preview file based on the slug name.
// LabelThumbBySlug returns a label cover file based on the slug name.
func LabelThumbBySlug(labelSlug string) (file entity.File, err error) {
if err := Db().Where("files.file_primary AND files.file_type = 'jpg' AND files.deleted_at IS NULL").
Joins("JOIN labels ON labels.label_slug = ?", labelSlug).
Expand All @@ -45,7 +45,7 @@ func LabelThumbBySlug(labelSlug string) (file entity.File, err error) {
return file, nil
}

// LabelThumbByUID returns a label preview file based on the label UID.
// LabelThumbByUID returns a label cover file based on the label UID.
func LabelThumbByUID(labelUID string) (file entity.File, err error) {
// Search matching label
err = Db().Where("files.file_primary AND files.deleted_at IS NULL").
Expand Down
Loading

0 comments on commit 7423380

Please sign in to comment.