Improved gallery cover lookup

internal/api/resolver_model_gallery.go

@@ -6,6 +6,7 @@ import (
 	"time"
 
 	"github.com/stashapp/stash/internal/api/loaders"
+	"github.com/stashapp/stash/internal/manager/config"
 
 	"github.com/stashapp/stash/pkg/file"
 	"github.com/stashapp/stash/pkg/image"
@@ -145,8 +146,8 @@ func (r *galleryResolver) Images(ctx context.Context, obj *models.Gallery) (ret
 
 func (r *galleryResolver) Cover(ctx context.Context, obj *models.Gallery) (ret *models.Image, err error) {
 	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
-		// find cover.jpg first
-		ret, err = image.FindGalleryCover(ctx, r.repository.Image, obj.ID)
+		// Find cover image first
+		ret, err = image.FindGalleryCover(ctx, r.repository.Image, obj.ID, config.GetInstance().GetGalleryCoverRegex())
 		return err
 	}); err != nil {
 		return nil, err

internal/manager/config/config.go

@@ -21,6 +21,7 @@ import (
 	"github.com/stashapp/stash/pkg/logger"
 	"github.com/stashapp/stash/pkg/models"
 	"github.com/stashapp/stash/pkg/models/paths"
+	"github.com/stashapp/stash/pkg/plugin/common/log"
 )
 
 var officialBuild string
@@ -129,6 +130,10 @@ const (
 	// rather than use the embedded UI.
 	CustomUILocation = "custom_ui_location"
 
+	// Gallery Cover Regex
+	GalleryCoverRegex        = "gallery_cover_regex"
+	galleryCoverRegexDefault = `(poster|cover|folder|board)\.[^\.]+$`
+
 	// Interface options
 	MenuItems = "menu_items"
 
@@ -635,6 +640,18 @@ func (i *Instance) GetVideoFileNamingAlgorithm() models.HashAlgorithm {
 	return models.HashAlgorithm(ret)
 }
 
+func (i *Instance) GetGalleryCoverRegex() string {
+	var regexString = i.getString(GalleryCoverRegex)
+
+	_, err := regexp.Compile(regexString)
+	if err != nil {
+		log.Warn(fmt.Sprintf("Gallery cover regex '%v' invalid, reverting to default.", regexString))
+		return galleryCoverRegexDefault
+	}
+
+	return i.getString(GalleryCoverRegex)
+}
+
 func (i *Instance) GetScrapersPath() string {
 	return i.getString(ScrapersPath)
 }
@@ -1440,6 +1457,9 @@ func (i *Instance) setDefaultValues(write bool) error {
 	i.main.SetDefault(ScrapersPath, defaultScrapersPath)
 	i.main.SetDefault(PluginsPath, defaultPluginsPath)
 
+	// Set default gallery cover regex
+	i.main.SetDefault(GalleryCoverRegex, galleryCoverRegexDefault)
+
 	if write {
 		return i.main.WriteConfig()
 	}

pkg/image/query.go

@@ -7,11 +7,6 @@ import (
 	"github.com/stashapp/stash/pkg/models"
 )
 
-const (
-	coverFilename             = "cover.jpg"
-	coverFilenameSearchString = "%" + coverFilename
-)
-
 type Queryer interface {
 	Query(ctx context.Context, options models.ImageQueryOptions) (*models.ImageQueryResult, error)
 }
@@ -102,9 +97,9 @@ func FindByGalleryID(ctx context.Context, r Queryer, galleryID int, sortBy strin
 	}, &findFilter)
 }
 
-func FindGalleryCover(ctx context.Context, r Queryer, galleryID int) (*models.Image, error) {
+func FindGalleryCover(ctx context.Context, r Queryer, galleryID int, galleryCoverRegex string) (*models.Image, error) {
 	const useCoverJpg = true
-	img, err := findGalleryCover(ctx, r, galleryID, useCoverJpg)
+	img, err := findGalleryCover(ctx, r, galleryID, useCoverJpg, galleryCoverRegex)
 	if err != nil {
 		return nil, err
 	}
@@ -114,10 +109,10 @@ func FindGalleryCover(ctx context.Context, r Queryer, galleryID int) (*models.Im
 	}
 
 	// return the first image in the gallery
-	return findGalleryCover(ctx, r, galleryID, !useCoverJpg)
+	return findGalleryCover(ctx, r, galleryID, !useCoverJpg, galleryCoverRegex)
 }
 
-func findGalleryCover(ctx context.Context, r Queryer, galleryID int, useCoverJpg bool) (*models.Image, error) {
+func findGalleryCover(ctx context.Context, r Queryer, galleryID int, useCoverJpg bool, galleryCoverRegex string) (*models.Image, error) {
 	// try to find cover.jpg in the gallery
 	perPage := 1
 	sortBy := "path"
@@ -138,8 +133,8 @@ func findGalleryCover(ctx context.Context, r Queryer, galleryID int, useCoverJpg
 
 	if useCoverJpg {
 		imageFilter.Path = &models.StringCriterionInput{
-			Value:    coverFilenameSearchString,
-			Modifier: models.CriterionModifierEquals,
+			Value:    "(?i)" + galleryCoverRegex,
+			Modifier: models.CriterionModifierMatchesRegex,
 		}
 	}
 

ui/v2.5/src/docs/en/Manual/Configuration.md

@@ -129,6 +129,7 @@ These options are typically not exposed in the UI and must be changed manually i
 | `custom_ui_location` | The file system folder where the UI files will be served from, instead of using the embedded UI. Empty to disable. Stash must be restarted to take effect. |
 | `max_upload_size` | Maximum file upload size for import files. Defaults to 1GB. |
 | `theme_color` | Sets the `theme-color` property in the UI. |
+| `gallery_cover_regex` | The regex responsible for selecting images as gallery covers |
 
 ### Custom served folders