Studio Tagger

docs/DEVELOPMENT.md

@@ -40,6 +40,7 @@ NOTE: The `make` command in Windows will be `mingw32-make` with MinGW. For examp
 
 * `make pre-ui` - Installs the UI dependencies. This only needs to be run once after cloning the repository, or if the dependencies are updated.
 * `make generate` - Generates Go and UI GraphQL files. Requires `make pre-ui` to have been run.
+* `make generate-stash-box-client` - Generate Go files for the Stash-box client code.
 * `make ui` - Builds the UI. Requires `make pre-ui` to have been run.
 * `make stash` - Builds the `stash` binary (make sure to build the UI as well... see below)
 * `make stash-release` - Builds a release version the `stash` binary, with debug information removed

go.mod

@@ -10,6 +10,7 @@ require (
 	github.com/corona10/goimagehash v1.0.3
 	github.com/disintegration/imaging v1.6.0
 	github.com/go-chi/chi v4.0.2+incompatible
+	github.com/gofrs/uuid v4.4.0+incompatible
 	github.com/golang-jwt/jwt/v4 v4.0.0
 	github.com/golang-migrate/migrate/v4 v4.15.0-beta.1
 	github.com/gorilla/securecookie v1.1.1

go.sum

@@ -295,6 +295,8 @@ github.com/gocql/gocql v0.0.0-20190301043612-f6df8288f9b4/go.mod h1:4Fw1eo5iaEhD
 github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA=
 github.com/gofrs/uuid v3.2.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
 github.com/gofrs/uuid v4.0.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
+github.com/gofrs/uuid v4.4.0+incompatible h1:3qXRTX8/NbyulANqlc0lchS1gqAVxRgsuW1YrTJupqA=
+github.com/gofrs/uuid v4.4.0+incompatible/go.mod h1:b2aQJv3Z4Fp6yNu3cdSllBxTCLRxnplIgP/c0N/04lM=
 github.com/gogo/protobuf v1.1.1/go.mod h1:r8qH/GZQm5c6nD/R0oafs1akxWv10x8SbQlK7atdtwQ=
 github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q=
 github.com/golang-jwt/jwt/v4 v4.0.0 h1:RAqyYixv1p7uEnocuy8P1nru5wprCh/MH2BIlW5z5/o=

gqlgen.yml

@@ -74,8 +74,8 @@ models:
     model: github.com/stashapp/stash/internal/manager.AutoTagMetadataInput
   CleanMetadataInput:
     model: github.com/stashapp/stash/internal/manager.CleanMetadataInput
-  StashBoxBatchPerformerTagInput:
-    model: github.com/stashapp/stash/internal/manager.StashBoxBatchPerformerTagInput
+  StashBoxBatchTagInput:
+    model: github.com/stashapp/stash/internal/manager.StashBoxBatchTagInput
   SceneStreamEndpoint:
     model: github.com/stashapp/stash/internal/manager.SceneStreamEndpoint
   ExportObjectTypeInput:

graphql/documents/data/scrapers.graphql

@@ -1,3 +1,18 @@
+fragment ScrapedStudioData on ScrapedStudio {
+  stored_id
+  name
+  url
+  parent {
+    stored_id
+    name
+    url
+    image
+    remote_site_id
+  }
+  image
+  remote_site_id
+}
+
 fragment ScrapedPerformerData on ScrapedPerformer {
   stored_id
   name
@@ -101,6 +116,14 @@ fragment ScrapedSceneStudioData on ScrapedStudio {
   stored_id
   name
   url
+  parent {
+    stored_id
+    name
+    url
+    image
+    remote_site_id
+  }
+  image
   remote_site_id
 }
 

graphql/documents/mutations/stash-box.graphql

@@ -4,10 +4,14 @@ mutation SubmitStashBoxFingerprints(
   submitStashBoxFingerprints(input: $input)
 }
 
-mutation StashBoxBatchPerformerTag($input: StashBoxBatchPerformerTagInput!) {
+mutation StashBoxBatchPerformerTag($input: StashBoxBatchTagInput!) {
   stashBoxBatchPerformerTag(input: $input)
 }
 
+mutation StashBoxBatchStudioTag($input: StashBoxBatchTagInput!) {
+  stashBoxBatchStudioTag(input: $input)
+}
+
 mutation SubmitStashBoxSceneDraft($input: StashBoxDraftSubmissionInput!) {
   submitStashBoxSceneDraft(input: $input)
 }

graphql/documents/queries/scrapers/scrapers.graphql

@@ -42,6 +42,15 @@ query ListMovieScrapers {
   }
 }
 
+query ScrapeSingleStudio(
+  $source: ScraperSourceInput!
+  $input: ScrapeSingleStudioInput!
+) {
+  scrapeSingleStudio(source: $source, input: $input) {
+    ...ScrapedStudioData
+  }
+}
+
 query ScrapeSinglePerformer(
   $source: ScraperSourceInput!
   $input: ScrapeSinglePerformerInput!

graphql/schema/schema.graphql

@@ -128,6 +128,12 @@ type Query {
     input: ScrapeMultiScenesInput!
   ): [[ScrapedScene!]!]!
 
+  "Scrape for a single studio"
+  scrapeSingleStudio(
+    source: ScraperSourceInput!
+    input: ScrapeSingleStudioInput!
+  ): [ScrapedStudio!]!
+
   "Scrape for a single performer"
   scrapeSinglePerformer(
     source: ScraperSourceInput!
@@ -413,7 +419,9 @@ type Mutation {
   execSQL(sql: String!, args: [Any]): SQLExecResult!
 
   "Run batch performer tag task. Returns the job ID."
-  stashBoxBatchPerformerTag(input: StashBoxBatchPerformerTagInput!): String!
+  stashBoxBatchPerformerTag(input: StashBoxBatchTagInput!): String!
+  "Run batch studio tag task. Returns the job ID."
+  stashBoxBatchStudioTag(input: StashBoxBatchTagInput!): String!
 
   "Enables DLNA for an optional duration. Has no effect if DLNA is enabled by default"
   enableDLNA(input: EnableDLNAInput!): Boolean!

graphql/schema/types/scraper.graphql

@@ -48,6 +48,7 @@ type ScrapedStudio {
   stored_id: ID
   name: String!
   url: String
+  parent: ScrapedStudio
   image: String
 
   remote_site_id: String
@@ -148,6 +149,13 @@ input ScrapeMultiScenesInput {
   scene_ids: [ID!]
 }
 
+input ScrapeSingleStudioInput {
+  """
+  Query can be either a name or a Stash ID
+  """
+  query: String
+}
+
 input ScrapeSinglePerformerInput {
   "Instructs to query by string"
   query: String
@@ -209,16 +217,22 @@ type StashBoxFingerprint {
   duration: Int!
 }
 
-"If neither performer_ids nor performer_names are set, tag all performers"
-input StashBoxBatchPerformerTagInput {
-  "Stash endpoint to use for the performer tagging"
+"If neither ids nor names are set, tag all items"
+input StashBoxBatchTagInput {
+  "Stash endpoint to use for the tagging"
   endpoint: Int!
-  "Fields to exclude when executing the performer tagging"
+  "Fields to exclude when executing the tagging"
   exclude_fields: [String!]
-  "Refresh performers already tagged by StashBox if true. Only tag performers with no StashBox tagging if false"
+  "Refresh items already tagged by StashBox if true. Only tag items with no StashBox tagging if false"
   refresh: Boolean!
+  "If batch adding studios, should their parent studios also be created?"
+  createParent: Boolean!
+  "If set, only tag these ids"
+  ids: [ID!]
+  "If set, only tag these names"
+  names: [String!]
   "If set, only tag these performer ids"
-  performer_ids: [ID!]
+  performer_ids: [ID!] @deprecated(reason: "use ids")
   "If set, only tag these performer names"
-  performer_names: [String!]
+  performer_names: [String!] @deprecated(reason: "use names")
 }

graphql/stash-box/query.graphql

@@ -16,6 +16,10 @@ fragment StudioFragment on Studio {
   urls {
     ...URLFragment
   }
+  parent {
+    name
+    id
+  }
   images {
     ...ImageFragment
   }
@@ -163,6 +167,12 @@ query FindSceneByID($id: ID!) {
   }
 }
 
+query FindStudio($id: ID, $name: String) {
+  findStudio(id: $id, name: $name) {
+    ...StudioFragment
+  }
+}
+
 mutation SubmitFingerprint($input: FingerprintSubmission!) {
   submitFingerprint(input: $input)
 }

internal/api/resolver_model_studio.go

@@ -34,15 +34,16 @@ func (r *studioResolver) ImagePath(ctx context.Context, obj *models.Studio) (*st
 	return &imagePath, nil
 }
 
-func (r *studioResolver) Aliases(ctx context.Context, obj *models.Studio) (ret []string, err error) {
-	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
-		ret, err = r.repository.Studio.GetAliases(ctx, obj.ID)
-		return err
-	}); err != nil {
-		return nil, err
+func (r *studioResolver) Aliases(ctx context.Context, obj *models.Studio) ([]string, error) {
+	if !obj.Aliases.Loaded() {
+		if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+			return obj.LoadAliases(ctx, r.repository.Studio)
+		}); err != nil {
+			return nil, err
+		}
 	}
 
-	return ret, err
+	return obj.Aliases.List(), nil
 }
 
 func (r *studioResolver) SceneCount(ctx context.Context, obj *models.Studio, depth *int) (ret int, err error) {
@@ -120,16 +121,15 @@ func (r *studioResolver) ChildStudios(ctx context.Context, obj *models.Studio) (
 }
 
 func (r *studioResolver) StashIds(ctx context.Context, obj *models.Studio) ([]*models.StashID, error) {
-	var ret []models.StashID
-	if err := r.withReadTxn(ctx, func(ctx context.Context) error {
-		var err error
-		ret, err = r.repository.Studio.GetStashIDs(ctx, obj.ID)
-		return err
-	}); err != nil {
-		return nil, err
+	if !obj.StashIDs.Loaded() {
+		if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+			return obj.LoadStashIDs(ctx, r.repository.Studio)
+		}); err != nil {
+			return nil, err
+		}
 	}
 
-	return stashIDsSliceToPtrSlice(ret), nil
+	return stashIDsSliceToPtrSlice(obj.StashIDs.List()), nil
 }
 
 func (r *studioResolver) Rating(ctx context.Context, obj *models.Studio) (*int, error) {

internal/api/resolver_mutation_stash_box.go

@@ -32,11 +32,16 @@ func (r *mutationResolver) SubmitStashBoxFingerprints(ctx context.Context, input
 	return client.SubmitStashBoxFingerprints(ctx, input.SceneIds, boxes[input.StashBoxIndex].Endpoint)
 }
 
-func (r *mutationResolver) StashBoxBatchPerformerTag(ctx context.Context, input manager.StashBoxBatchPerformerTagInput) (string, error) {
+func (r *mutationResolver) StashBoxBatchPerformerTag(ctx context.Context, input manager.StashBoxBatchTagInput) (string, error) {
 	jobID := manager.GetInstance().StashBoxBatchPerformerTag(ctx, input)
 	return strconv.Itoa(jobID), nil
 }
 
+func (r *mutationResolver) StashBoxBatchStudioTag(ctx context.Context, input manager.StashBoxBatchTagInput) (string, error) {
+	jobID := manager.GetInstance().StashBoxBatchStudioTag(ctx, input)
+	return strconv.Itoa(jobID), nil
+}
+
 func (r *mutationResolver) SubmitStashBoxSceneDraft(ctx context.Context, input StashBoxDraftSubmissionInput) (*string, error) {
 	boxes := config.GetInstance().GetStashBoxes()