Refactor stash-box fingerprint submissions

gqlgen.yml

@@ -144,4 +144,8 @@ models:
     fields:
       career_length:
         resolver: true
+  FingerprintSubmission:
+    fields:
+      scene:
+        resolver: true
 

graphql/schema/schema.graphql

@@ -247,6 +247,11 @@ type Query {
   ): Directory!
   validateStashBoxCredentials(input: StashBoxInput!): StashBoxValidationResult!
 
+  "List pending fingerprint submissions for a stash-box endpoint"
+  pendingFingerprintSubmissions(
+    stash_box_endpoint: String!
+  ): [FingerprintSubmission!]!
+
   # System status
   systemStatus: SystemStatus!
 
@@ -563,13 +568,20 @@ type Mutation {
   "Submit fingerprints to stash-box instance"
   submitStashBoxFingerprints(
     input: StashBoxFingerprintSubmissionInput!
-  ): Boolean!
+  ): Boolean! @deprecated(reason: "Use submitFingerprintSubmissions")
 
   "Submit scene as draft to stash-box instance"
   submitStashBoxSceneDraft(input: StashBoxDraftSubmissionInput!): ID
   "Submit performer as draft to stash-box instance"
   submitStashBoxPerformerDraft(input: StashBoxDraftSubmissionInput!): ID
 
+  "Add a fingerprint submission to the queue"
+  queueFingerprintSubmission(input: QueueFingerprintInput!): Boolean!
+  "Remove a fingerprint submission from the queue"
+  removeFingerprintSubmission(input: RemoveFingerprintInput!): Boolean!
+  "Submit all pending fingerprint submissions for a stash-box endpoint"
+  submitFingerprintSubmissions(stash_box_endpoint: String!): Boolean!
+
   "Backup the database. Optionally returns a link to download the database file"
   backupDatabase(input: BackupDatabaseInput!): String
 

graphql/schema/types/scraper.graphql

@@ -289,6 +289,9 @@ type StashBoxFingerprint {
   algorithm: String!
   hash: String!
   duration: Int!
+  reports: Int!
+  user_submitted: Boolean!
+  user_reported: Boolean!
 }
 
 """

graphql/schema/types/stash-box.graphql

@@ -25,6 +25,11 @@ input StashIDInput {
   updated_at: Time
 }
 
+enum FingerprintVote {
+  VALID
+  INVALID
+}
+
 input StashBoxFingerprintSubmissionInput {
   scene_ids: [String!]!
   stash_box_index: Int @deprecated(reason: "use stash_box_endpoint")
@@ -36,3 +41,23 @@ input StashBoxDraftSubmissionInput {
   stash_box_index: Int @deprecated(reason: "use stash_box_endpoint")
   stash_box_endpoint: String
 }
+
+type FingerprintSubmission {
+  endpoint: String!
+  stash_id: String!
+  scene: Scene!
+  vote: FingerprintVote!
+  created_at: Time!
+}
+
+input QueueFingerprintInput {
+  endpoint: String!
+  stash_id: String!
+  scene_id: ID!
+  vote: FingerprintVote!
+}
+
+input RemoveFingerprintInput {
+  endpoint: String!
+  stash_id: String!
+}

graphql/stash-box/query.graphql

@@ -97,6 +97,9 @@ fragment FingerprintFragment on Fingerprint {
   algorithm
   hash
   duration
+  reports
+  user_submitted
+  user_reported
 }
 
 fragment SceneFragment on Scene {

internal/api/resolver.go

@@ -111,6 +111,9 @@ func (r *Resolver) Plugin() PluginResolver {
 func (r *Resolver) ConfigResult() ConfigResultResolver {
 	return &configResultResolver{r}
 }
+func (r *Resolver) FingerprintSubmission() FingerprintSubmissionResolver {
+	return &fingerprintSubmissionResolver{r}
+}
 
 type mutationResolver struct{ *Resolver }
 type queryResolver struct{ *Resolver }
@@ -137,6 +140,7 @@ type folderResolver struct{ *Resolver }
 type savedFilterResolver struct{ *Resolver }
 type pluginResolver struct{ *Resolver }
 type configResultResolver struct{ *Resolver }
+type fingerprintSubmissionResolver struct{ *Resolver }
 
 func (r *Resolver) withTxn(ctx context.Context, fn func(ctx context.Context) error) error {
 	return r.repository.WithTxn(ctx, fn)

internal/api/resolver_model_fingerprint_submission.go

@@ -0,0 +1,25 @@
+package api
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/stashapp/stash/pkg/models"
+)
+
+func (r *fingerprintSubmissionResolver) Scene(ctx context.Context, obj *models.FingerprintSubmission) (*models.Scene, error) {
+	var ret *models.Scene
+	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+		var err error
+		ret, err = r.repository.Scene.Find(ctx, obj.SceneID)
+		return err
+	}); err != nil {
+		return nil, err
+	}
+
+	if ret == nil {
+		return nil, fmt.Errorf("scene %d not found", obj.SceneID)
+	}
+
+	return ret, nil
+}

internal/api/resolver_mutation_stash_box.go

@@ -4,6 +4,7 @@ import (
 	"context"
 	"fmt"
 	"strconv"
+	"time"
 
 	"github.com/stashapp/stash/internal/manager"
 	"github.com/stashapp/stash/pkg/logger"
@@ -14,7 +15,7 @@ import (
 )
 
 func (r *mutationResolver) SubmitStashBoxFingerprints(ctx context.Context, input StashBoxFingerprintSubmissionInput) (bool, error) {
-	b, err := resolveStashBox(input.StashBoxIndex, input.StashBoxEndpoint)
+	b, err := resolveStashBox(input.StashBoxIndex, input.StashBoxEndpoint) //nolint:staticcheck
 	if err != nil {
 		return false, err
 	}
@@ -222,3 +223,121 @@ func (r *mutationResolver) SubmitStashBoxPerformerDraft(ctx context.Context, inp
 
 	return res, err
 }
+
+func (r *mutationResolver) QueueFingerprintSubmission(ctx context.Context, input QueueFingerprintInput) (bool, error) {
+	sceneID, err := strconv.Atoi(input.SceneID)
+	if err != nil {
+		return false, fmt.Errorf("invalid scene ID: %w", err)
+	}
+
+	submission := &models.FingerprintSubmission{
+		Endpoint:  input.Endpoint,
+		StashID:   input.StashID,
+		SceneID:   sceneID,
+		Vote:      models.FingerprintVote(input.Vote),
+		CreatedAt: time.Now(),
+	}
+
+	if err := r.withTxn(ctx, func(ctx context.Context) error {
+		// Remove any existing submission for this stash ID before creating a new one
+		if err := r.repository.FingerprintSubmission.Delete(ctx, input.Endpoint, input.StashID); err != nil {
+			return err
+		}
+		return r.repository.FingerprintSubmission.Create(ctx, submission)
+	}); err != nil {
+		return false, err
+	}
+
+	return true, nil
+}
+
+func (r *mutationResolver) RemoveFingerprintSubmission(ctx context.Context, input RemoveFingerprintInput) (bool, error) {
+	if err := r.withTxn(ctx, func(ctx context.Context) error {
+		return r.repository.FingerprintSubmission.Delete(ctx, input.Endpoint, input.StashID)
+	}); err != nil {
+		return false, err
+	}
+
+	return true, nil
+}
+
+func (r *mutationResolver) SubmitFingerprintSubmissions(ctx context.Context, stashBoxEndpoint string) (bool, error) {
+	b, err := resolveStashBox(nil, &stashBoxEndpoint)
+	if err != nil {
+		return false, err
+	}
+
+	var submissions []*models.FingerprintSubmission
+	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+		var err error
+		submissions, err = r.repository.FingerprintSubmission.FindByEndpoint(ctx, stashBoxEndpoint)
+		return err
+	}); err != nil {
+		return false, err
+	}
+
+	if len(submissions) == 0 {
+		return true, nil
+	}
+
+	ids := make([]int, len(submissions))
+	for i, sub := range submissions {
+		ids[i] = sub.SceneID
+	}
+
+	var scenes []*models.Scene
+	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+		var err error
+		scenes, err = r.sceneService.FindByIDs(ctx, ids, scene.LoadFiles)
+		return err
+	}); err != nil {
+		return false, err
+	}
+
+	sceneMap := make(map[int]*models.Scene)
+	for _, s := range scenes {
+		sceneMap[s.ID] = s
+	}
+
+	client := r.newStashBoxClient(*b)
+
+	if len(submissions) > 40 {
+		// Submit async to avoid timeouts for large batches
+		go r.submitFingerprintBatch(client, submissions, sceneMap)
+	} else {
+		r.submitFingerprintBatch(client, submissions, sceneMap)
+	}
+
+	return true, nil
+}
+
+func (r *mutationResolver) submitFingerprintBatch(client *stashbox.Client, submissions []*models.FingerprintSubmission, sceneMap map[int]*models.Scene) {
+	var successfulSubmissions []*models.FingerprintSubmission
+	for _, sub := range submissions {
+		s, ok := sceneMap[sub.SceneID]
+		if !ok {
+			logger.Warnf("Scene %d not found for fingerprint submission, skipping", sub.SceneID)
+			continue
+		}
+
+		if err := client.SubmitFingerprintsWithVote(context.Background(), s, sub.StashID, sub.Vote); err != nil {
+			logger.Warnf("Failed to submit fingerprint for scene %d: %v", sub.SceneID, err)
+			continue
+		}
+
+		successfulSubmissions = append(successfulSubmissions, sub)
+	}
+
+	if len(successfulSubmissions) > 0 {
+		if err := r.withTxn(context.Background(), func(ctx context.Context) error {
+			for _, sub := range successfulSubmissions {
+				if err := r.repository.FingerprintSubmission.Delete(ctx, sub.Endpoint, sub.StashID); err != nil {
+					return err
+				}
+			}
+			return nil
+		}); err != nil {
+			logger.Warnf("Failed to delete fingerprint submissions: %v", err)
+		}
+	}
+}

internal/api/resolver_query_stash_box.go

@@ -0,0 +1,17 @@
+package api
+
+import (
+	"context"
+
+	"github.com/stashapp/stash/pkg/models"
+)
+
+func (r *queryResolver) PendingFingerprintSubmissions(ctx context.Context, stashBoxEndpoint string) (ret []*models.FingerprintSubmission, err error) {
+	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+		ret, err = r.repository.FingerprintSubmission.FindByEndpoint(ctx, stashBoxEndpoint)
+		return err
+	}); err != nil {
+		return nil, err
+	}
+	return ret, nil
+}

pkg/models/fingerprint_submission.go

@@ -0,0 +1,47 @@
+package models
+
+import (
+	"context"
+	"time"
+)
+
+type FingerprintVote string
+
+const (
+	FingerprintVoteValid   FingerprintVote = "VALID"
+	FingerprintVoteInvalid FingerprintVote = "INVALID"
+)
+
+func (e FingerprintVote) IsValid() bool {
+	switch e {
+	case FingerprintVoteValid, FingerprintVoteInvalid:
+		return true
+	}
+	return false
+}
+
+func (e FingerprintVote) String() string {
+	return string(e)
+}
+
+type FingerprintSubmission struct {
+	Endpoint  string          `json:"endpoint"`
+	StashID   string          `json:"stash_id"`
+	SceneID   int             `json:"scene_id"`
+	Vote      FingerprintVote `json:"vote"`
+	CreatedAt time.Time       `json:"created_at"`
+}
+
+type FingerprintSubmissionReader interface {
+	FindByEndpoint(ctx context.Context, endpoint string) ([]*FingerprintSubmission, error)
+}
+
+type FingerprintSubmissionWriter interface {
+	Create(ctx context.Context, newObject *FingerprintSubmission) error
+	Delete(ctx context.Context, endpoint string, stashID string) error
+}
+
+type FingerprintSubmissionReaderWriter interface {
+	FingerprintSubmissionReader
+	FingerprintSubmissionWriter
+}

pkg/models/repository.go

@@ -14,19 +14,20 @@ type TxnManager interface {
 type Repository struct {
 	TxnManager TxnManager
 
-	Blob           BlobReader
-	File           FileReaderWriter
-	Folder         FolderReaderWriter
-	Gallery        GalleryReaderWriter
-	GalleryChapter GalleryChapterReaderWriter
-	Image          ImageReaderWriter
-	Group          GroupReaderWriter
-	Performer      PerformerReaderWriter
-	Scene          SceneReaderWriter
-	SceneMarker    SceneMarkerReaderWriter
-	Studio         StudioReaderWriter
-	Tag            TagReaderWriter
-	SavedFilter    SavedFilterReaderWriter
+	Blob                  BlobReader
+	File                  FileReaderWriter
+	Folder                FolderReaderWriter
+	Gallery               GalleryReaderWriter
+	GalleryChapter        GalleryChapterReaderWriter
+	Image                 ImageReaderWriter
+	Group                 GroupReaderWriter
+	Performer             PerformerReaderWriter
+	Scene                 SceneReaderWriter
+	SceneMarker           SceneMarkerReaderWriter
+	Studio                StudioReaderWriter
+	Tag                   TagReaderWriter
+	SavedFilter           SavedFilterReaderWriter
+	FingerprintSubmission FingerprintSubmissionReaderWriter
 }
 
 func (r *Repository) WithTxn(ctx context.Context, fn txn.TxnFunc) error {

pkg/models/stash_box.go

@@ -1,9 +1,12 @@
 package models
 
 type StashBoxFingerprint struct {
-	Algorithm string `json:"algorithm"`
-	Hash      string `json:"hash"`
-	Duration  int    `json:"duration"`
+	Algorithm     string `json:"algorithm"`
+	Hash          string `json:"hash"`
+	Duration      int    `json:"duration"`
+	Reports       int    `json:"reports"`
+	UserSubmitted bool   `json:"user_submitted"`
+	UserReported  bool   `json:"user_reported"`
 }
 
 type StashBox struct {