Add findFiles and findFile graphql queries (#5941)

* Add findFile and findFiles
* Add parent folder and zip file fields to file graphql types
* Add parent_folder, zip_file fields to Folder graphql type
* Add format to ImageFile type
* Add format filter fields to image/video file filters

internal/api/fields.go

@@ -0,0 +1,23 @@
+package api
+
+import (
+	"context"
+
+	"github.com/99designs/gqlgen/graphql"
+)
+
+type queryFields []string
+
+func collectQueryFields(ctx context.Context) queryFields {
+	fields := graphql.CollectAllFields(ctx)
+	return queryFields(fields)
+}
+
+func (f queryFields) Has(field string) bool {
+	for _, v := range f {
+		if v == field {
+			return true
+		}
+	}
+	return false
+}

internal/api/loaders/dataloaders.go

@@ -10,6 +10,7 @@
 //go:generate go run github.com/vektah/dataloaden TagLoader int *github.com/stashapp/stash/pkg/models.Tag
 //go:generate go run github.com/vektah/dataloaden GroupLoader int *github.com/stashapp/stash/pkg/models.Group
 //go:generate go run github.com/vektah/dataloaden FileLoader github.com/stashapp/stash/pkg/models.FileID github.com/stashapp/stash/pkg/models.File
+//go:generate go run github.com/vektah/dataloaden FolderLoader github.com/stashapp/stash/pkg/models.FolderID *github.com/stashapp/stash/pkg/models.Folder
 //go:generate go run github.com/vektah/dataloaden SceneFileIDsLoader int []github.com/stashapp/stash/pkg/models.FileID
 //go:generate go run github.com/vektah/dataloaden ImageFileIDsLoader int []github.com/stashapp/stash/pkg/models.FileID
 //go:generate go run github.com/vektah/dataloaden GalleryFileIDsLoader int []github.com/stashapp/stash/pkg/models.FileID
@@ -62,6 +63,7 @@ type Loaders struct {
 	TagByID    *TagLoader
 	GroupByID  *GroupLoader
 	FileByID   *FileLoader
+	FolderByID *FolderLoader
 }
 
 type Middleware struct {
@@ -117,6 +119,11 @@ func (m Middleware) Middleware(next http.Handler) http.Handler {
 				maxBatch: maxBatch,
 				fetch:    m.fetchFiles(ctx),
 			},
+			FolderByID: &FolderLoader{
+				wait:     wait,
+				maxBatch: maxBatch,
+				fetch:    m.fetchFolders(ctx),
+			},
 			SceneFiles: &SceneFileIDsLoader{
 				wait:     wait,
 				maxBatch: maxBatch,
@@ -279,6 +286,17 @@ func (m Middleware) fetchFiles(ctx context.Context) func(keys []models.FileID) (
 	}
 }
 
+func (m Middleware) fetchFolders(ctx context.Context) func(keys []models.FolderID) ([]*models.Folder, []error) {
+	return func(keys []models.FolderID) (ret []*models.Folder, errs []error) {
+		err := m.Repository.WithDB(ctx, func(ctx context.Context) error {
+			var err error
+			ret, err = m.Repository.Folder.FindMany(ctx, keys)
+			return err
+		})
+		return ret, toErrorSlice(err)
+	}
+}
+
 func (m Middleware) fetchScenesFileIDs(ctx context.Context) func(keys []int) ([][]models.FileID, []error) {
 	return func(keys []int) (ret [][]models.FileID, errs []error) {
 		err := m.Repository.WithDB(ctx, func(ctx context.Context) error {

internal/api/loaders/folderloader_gen.go

@@ -0,0 +1,224 @@
+// Code generated by github.com/vektah/dataloaden, DO NOT EDIT.
+
+package loaders
+
+import (
+	"sync"
+	"time"
+
+	"github.com/stashapp/stash/pkg/models"
+)
+
+// FolderLoaderConfig captures the config to create a new FolderLoader
+type FolderLoaderConfig struct {
+	// Fetch is a method that provides the data for the loader
+	Fetch func(keys []models.FolderID) ([]*models.Folder, []error)
+
+	// Wait is how long wait before sending a batch
+	Wait time.Duration
+
+	// MaxBatch will limit the maximum number of keys to send in one batch, 0 = not limit
+	MaxBatch int
+}
+
+// NewFolderLoader creates a new FolderLoader given a fetch, wait, and maxBatch
+func NewFolderLoader(config FolderLoaderConfig) *FolderLoader {
+	return &FolderLoader{
+		fetch:    config.Fetch,
+		wait:     config.Wait,
+		maxBatch: config.MaxBatch,
+	}
+}
+
+// FolderLoader batches and caches requests
+type FolderLoader struct {
+	// this method provides the data for the loader
+	fetch func(keys []models.FolderID) ([]*models.Folder, []error)
+
+	// how long to done before sending a batch
+	wait time.Duration
+
+	// this will limit the maximum number of keys to send in one batch, 0 = no limit
+	maxBatch int
+
+	// INTERNAL
+
+	// lazily created cache
+	cache map[models.FolderID]*models.Folder
+
+	// the current batch. keys will continue to be collected until timeout is hit,
+	// then everything will be sent to the fetch method and out to the listeners
+	batch *folderLoaderBatch
+
+	// mutex to prevent races
+	mu sync.Mutex
+}
+
+type folderLoaderBatch struct {
+	keys    []models.FolderID
+	data    []*models.Folder
+	error   []error
+	closing bool
+	done    chan struct{}
+}
+
+// Load a Folder by key, batching and caching will be applied automatically
+func (l *FolderLoader) Load(key models.FolderID) (*models.Folder, error) {
+	return l.LoadThunk(key)()
+}
+
+// LoadThunk returns a function that when called will block waiting for a Folder.
+// This method should be used if you want one goroutine to make requests to many
+// different data loaders without blocking until the thunk is called.
+func (l *FolderLoader) LoadThunk(key models.FolderID) func() (*models.Folder, error) {
+	l.mu.Lock()
+	if it, ok := l.cache[key]; ok {
+		l.mu.Unlock()
+		return func() (*models.Folder, error) {
+			return it, nil
+		}
+	}
+	if l.batch == nil {
+		l.batch = &folderLoaderBatch{done: make(chan struct{})}
+	}
+	batch := l.batch
+	pos := batch.keyIndex(l, key)
+	l.mu.Unlock()
+
+	return func() (*models.Folder, error) {
+		<-batch.done
+
+		var data *models.Folder
+		if pos < len(batch.data) {
+			data = batch.data[pos]
+		}
+
+		var err error
+		// its convenient to be able to return a single error for everything
+		if len(batch.error) == 1 {
+			err = batch.error[0]
+		} else if batch.error != nil {
+			err = batch.error[pos]
+		}
+
+		if err == nil {
+			l.mu.Lock()
+			l.unsafeSet(key, data)
+			l.mu.Unlock()
+		}
+
+		return data, err
+	}
+}
+
+// LoadAll fetches many keys at once. It will be broken into appropriate sized
+// sub batches depending on how the loader is configured
+func (l *FolderLoader) LoadAll(keys []models.FolderID) ([]*models.Folder, []error) {
+	results := make([]func() (*models.Folder, error), len(keys))
+
+	for i, key := range keys {
+		results[i] = l.LoadThunk(key)
+	}
+
+	folders := make([]*models.Folder, len(keys))
+	errors := make([]error, len(keys))
+	for i, thunk := range results {
+		folders[i], errors[i] = thunk()
+	}
+	return folders, errors
+}
+
+// LoadAllThunk returns a function that when called will block waiting for a Folders.
+// This method should be used if you want one goroutine to make requests to many
+// different data loaders without blocking until the thunk is called.
+func (l *FolderLoader) LoadAllThunk(keys []models.FolderID) func() ([]*models.Folder, []error) {
+	results := make([]func() (*models.Folder, error), len(keys))
+	for i, key := range keys {
+		results[i] = l.LoadThunk(key)
+	}
+	return func() ([]*models.Folder, []error) {
+		folders := make([]*models.Folder, len(keys))
+		errors := make([]error, len(keys))
+		for i, thunk := range results {
+			folders[i], errors[i] = thunk()
+		}
+		return folders, errors
+	}
+}
+
+// Prime the cache with the provided key and value. If the key already exists, no change is made
+// and false is returned.
+// (To forcefully prime the cache, clear the key first with loader.clear(key).prime(key, value).)
+func (l *FolderLoader) Prime(key models.FolderID, value *models.Folder) bool {
+	l.mu.Lock()
+	var found bool
+	if _, found = l.cache[key]; !found {
+		// make a copy when writing to the cache, its easy to pass a pointer in from a loop var
+		// and end up with the whole cache pointing to the same value.
+		cpy := *value
+		l.unsafeSet(key, &cpy)
+	}
+	l.mu.Unlock()
+	return !found
+}
+
+// Clear the value at key from the cache, if it exists
+func (l *FolderLoader) Clear(key models.FolderID) {
+	l.mu.Lock()
+	delete(l.cache, key)
+	l.mu.Unlock()
+}
+
+func (l *FolderLoader) unsafeSet(key models.FolderID, value *models.Folder) {
+	if l.cache == nil {
+		l.cache = map[models.FolderID]*models.Folder{}
+	}
+	l.cache[key] = value
+}
+
+// keyIndex will return the location of the key in the batch, if its not found
+// it will add the key to the batch
+func (b *folderLoaderBatch) keyIndex(l *FolderLoader, key models.FolderID) int {
+	for i, existingKey := range b.keys {
+		if key == existingKey {
+			return i
+		}
+	}
+
+	pos := len(b.keys)
+	b.keys = append(b.keys, key)
+	if pos == 0 {
+		go b.startTimer(l)
+	}
+
+	if l.maxBatch != 0 && pos >= l.maxBatch-1 {
+		if !b.closing {
+			b.closing = true
+			l.batch = nil
+			go b.end(l)
+		}
+	}
+
+	return pos
+}
+
+func (b *folderLoaderBatch) startTimer(l *FolderLoader) {
+	time.Sleep(l.wait)
+	l.mu.Lock()
+
+	// we must have hit a batch limit and are already finalizing this batch
+	if b.closing {
+		l.mu.Unlock()
+		return
+	}
+
+	l.batch = nil
+	l.mu.Unlock()
+
+	b.end(l)
+}
+
+func (b *folderLoaderBatch) end(l *FolderLoader) {
+	b.data, b.error = l.fetch(b.keys)
+	close(b.done)
+}

internal/api/models.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	"github.com/stashapp/stash/pkg/models"
+	"github.com/stashapp/stash/pkg/sliceutil"
 )
 
 type BaseFile interface {
@@ -27,6 +28,29 @@ func convertVisualFile(f models.File) (VisualFile, error) {
 	}
 }
 
+func convertBaseFile(f models.File) BaseFile {
+	if f == nil {
+		return nil
+	}
+
+	switch f := f.(type) {
+	case BaseFile:
+		return f
+	case *models.VideoFile:
+		return &VideoFile{VideoFile: f}
+	case *models.ImageFile:
+		return &ImageFile{ImageFile: f}
+	case *models.BaseFile:
+		return &BasicFile{BaseFile: f}
+	default:
+		panic("unknown file type")
+	}
+}
+
+func convertBaseFiles(files []models.File) []BaseFile {
+	return sliceutil.Map(files, convertBaseFile)
+}
+
 type GalleryFile struct {
 	*models.BaseFile
 }
@@ -62,3 +86,15 @@ func (ImageFile) IsVisualFile() {}
 func (f *ImageFile) Fingerprints() []models.Fingerprint {
 	return f.ImageFile.Fingerprints
 }
+
+type BasicFile struct {
+	*models.BaseFile
+}
+
+func (BasicFile) IsBaseFile() {}
+
+func (BasicFile) IsVisualFile() {}
+
+func (f *BasicFile) Fingerprints() []models.Fingerprint {
+	return f.BaseFile.Fingerprints
+}

internal/api/resolver.go

@@ -95,6 +95,12 @@ func (r *Resolver) VideoFile() VideoFileResolver {
 func (r *Resolver) ImageFile() ImageFileResolver {
 	return &imageFileResolver{r}
 }
+func (r *Resolver) BasicFile() BasicFileResolver {
+	return &basicFileResolver{r}
+}
+func (r *Resolver) Folder() FolderResolver {
+	return &folderResolver{r}
+}
 func (r *Resolver) SavedFilter() SavedFilterResolver {
 	return &savedFilterResolver{r}
 }
@@ -125,6 +131,8 @@ type tagResolver struct{ *Resolver }
 type galleryFileResolver struct{ *Resolver }
 type videoFileResolver struct{ *Resolver }
 type imageFileResolver struct{ *Resolver }
+type basicFileResolver struct{ *Resolver }
+type folderResolver struct{ *Resolver }
 type savedFilterResolver struct{ *Resolver }
 type pluginResolver struct{ *Resolver }
 type configResultResolver struct{ *Resolver }

internal/api/resolver_model_file.go

@@ -1,30 +1,80 @@
 package api
 
-import "context"
+import (
+	"context"
 
-func (r *galleryFileResolver) Fingerprint(ctx context.Context, obj *GalleryFile, type_ string) (*string, error) {
-	fp := obj.BaseFile.Fingerprints.For(type_)
-	if fp != nil {
-		v := fp.Value()
-		return &v, nil
+	"github.com/stashapp/stash/internal/api/loaders"
+	"github.com/stashapp/stash/pkg/models"
+)
+
+func fingerprintResolver(fp models.Fingerprints, type_ string) (*string, error) {
+	fingerprint := fp.For(type_)
+	if fingerprint != nil {
+		value := fingerprint.Value()
+		return &value, nil
 	}
 	return nil, nil
 }
 
+func (r *galleryFileResolver) Fingerprint(ctx context.Context, obj *GalleryFile, type_ string) (*string, error) {
+	return fingerprintResolver(obj.BaseFile.Fingerprints, type_)
+}
+
 func (r *imageFileResolver) Fingerprint(ctx context.Context, obj *ImageFile, type_ string) (*string, error) {
-	fp := obj.ImageFile.Fingerprints.For(type_)
-	if fp != nil {
-		v := fp.Value()
-		return &v, nil
-	}
-	return nil, nil
+	return fingerprintResolver(obj.ImageFile.Fingerprints, type_)
 }
 
 func (r *videoFileResolver) Fingerprint(ctx context.Context, obj *VideoFile, type_ string) (*string, error) {
-	fp := obj.VideoFile.Fingerprints.For(type_)
-	if fp != nil {
-		v := fp.Value()
-		return &v, nil
-	}
-	return nil, nil
+	return fingerprintResolver(obj.VideoFile.Fingerprints, type_)
+}
+
+func (r *basicFileResolver) Fingerprint(ctx context.Context, obj *BasicFile, type_ string) (*string, error) {
+	return fingerprintResolver(obj.BaseFile.Fingerprints, type_)
+}
+
+func (r *galleryFileResolver) ParentFolder(ctx context.Context, obj *GalleryFile) (*models.Folder, error) {
+	return loaders.From(ctx).FolderByID.Load(obj.ParentFolderID)
+}
+
+func (r *imageFileResolver) ParentFolder(ctx context.Context, obj *ImageFile) (*models.Folder, error) {
+	return loaders.From(ctx).FolderByID.Load(obj.ParentFolderID)
+}
+
+func (r *videoFileResolver) ParentFolder(ctx context.Context, obj *VideoFile) (*models.Folder, error) {
+	return loaders.From(ctx).FolderByID.Load(obj.ParentFolderID)
+}
+
+func (r *basicFileResolver) ParentFolder(ctx context.Context, obj *BasicFile) (*models.Folder, error) {
+	return loaders.From(ctx).FolderByID.Load(obj.ParentFolderID)
+}
+
+func zipFileResolver(ctx context.Context, zipFileID *models.FileID) (*BasicFile, error) {
+	if zipFileID == nil {
+		return nil, nil
+	}
+
+	f, err := loaders.From(ctx).FileByID.Load(*zipFileID)
+	if err != nil {
+		return nil, err
+	}
+
+	return &BasicFile{
+		BaseFile: f.Base(),
+	}, nil
+}
+
+func (r *galleryFileResolver) ZipFile(ctx context.Context, obj *GalleryFile) (*BasicFile, error) {
+	return zipFileResolver(ctx, obj.ZipFileID)
+}
+
+func (r *imageFileResolver) ZipFile(ctx context.Context, obj *ImageFile) (*BasicFile, error) {
+	return zipFileResolver(ctx, obj.ZipFileID)
+}
+
+func (r *videoFileResolver) ZipFile(ctx context.Context, obj *VideoFile) (*BasicFile, error) {
+	return zipFileResolver(ctx, obj.ZipFileID)
+}
+
+func (r *basicFileResolver) ZipFile(ctx context.Context, obj *BasicFile) (*BasicFile, error) {
+	return zipFileResolver(ctx, obj.ZipFileID)
 }

internal/api/resolver_model_folder.go

@@ -0,0 +1,20 @@
+package api
+
+import (
+	"context"
+
+	"github.com/stashapp/stash/internal/api/loaders"
+	"github.com/stashapp/stash/pkg/models"
+)
+
+func (r *folderResolver) ParentFolder(ctx context.Context, obj *models.Folder) (*models.Folder, error) {
+	if obj.ParentFolderID == nil {
+		return nil, nil
+	}
+
+	return loaders.From(ctx).FolderByID.Load(*obj.ParentFolderID)
+}
+
+func (r *folderResolver) ZipFile(ctx context.Context, obj *models.Folder) (*BasicFile, error) {
+	return zipFileResolver(ctx, obj.ZipFileID)
+}

internal/api/resolver_query_find_file.go

@@ -0,0 +1,120 @@
+package api
+
+import (
+	"context"
+	"errors"
+	"strconv"
+
+	"github.com/stashapp/stash/pkg/models"
+	"github.com/stashapp/stash/pkg/sliceutil/stringslice"
+)
+
+func (r *queryResolver) FindFile(ctx context.Context, id *string, path *string) (BaseFile, error) {
+	var ret models.File
+	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+		qb := r.repository.File
+		var err error
+		switch {
+		case id != nil:
+			idInt, err := strconv.Atoi(*id)
+			if err != nil {
+				return err
+			}
+			var files []models.File
+			files, err = qb.Find(ctx, models.FileID(idInt))
+			if err != nil {
+				return err
+			}
+			if len(files) > 0 {
+				ret = files[0]
+			}
+		case path != nil:
+			ret, err = qb.FindByPath(ctx, *path)
+			if err == nil && ret == nil {
+				return errors.New("file not found")
+			}
+		default:
+			return errors.New("either id or path must be provided")
+		}
+
+		return err
+	}); err != nil {
+		return nil, err
+	}
+
+	return convertBaseFile(ret), nil
+}
+
+func (r *queryResolver) FindFiles(
+	ctx context.Context,
+	fileFilter *models.FileFilterType,
+	filter *models.FindFilterType,
+	ids []string,
+) (ret *FindFilesResultType, err error) {
+	var fileIDs []models.FileID
+	if len(ids) > 0 {
+		fileIDsInt, err := stringslice.StringSliceToIntSlice(ids)
+		if err != nil {
+			return nil, err
+		}
+
+		fileIDs = models.FileIDsFromInts(fileIDsInt)
+	}
+
+	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+		var files []models.File
+		var err error
+
+		fields := collectQueryFields(ctx)
+		result := &models.FileQueryResult{}
+
+		if len(fileIDs) > 0 {
+			files, err = r.repository.File.Find(ctx, fileIDs...)
+			if err == nil {
+				result.Count = len(files)
+				for _, f := range files {
+					if asVideo, ok := f.(*models.VideoFile); ok {
+						result.TotalDuration += asVideo.Duration
+					}
+					if asImage, ok := f.(*models.ImageFile); ok {
+						result.Megapixels += asImage.Megapixels()
+					}
+
+					result.TotalSize += f.Base().Size
+				}
+			}
+		} else {
+			result, err = r.repository.File.Query(ctx, models.FileQueryOptions{
+				QueryOptions: models.QueryOptions{
+					FindFilter: filter,
+					Count:      fields.Has("count"),
+				},
+				FileFilter:    fileFilter,
+				TotalDuration: fields.Has("duration"),
+				Megapixels:    fields.Has("megapixels"),
+				TotalSize:     fields.Has("size"),
+			})
+			if err == nil {
+				files, err = result.Resolve(ctx)
+			}
+		}
+
+		if err != nil {
+			return err
+		}
+
+		ret = &FindFilesResultType{
+			Count:      result.Count,
+			Files:      convertBaseFiles(files),
+			Duration:   result.TotalDuration,
+			Megapixels: result.Megapixels,
+			Size:       int(result.TotalSize),
+		}
+
+		return nil
+	}); err != nil {
+		return nil, err
+	}
+
+	return ret, nil
+}