Performer urls (#4958)

* Populate URLs from legacy fields * Return nil properly in xpath/json scrapers * Improve migration logging
2025-12-18 04:44:37 +03:00 · 2024-06-18 13:41:05 +10:00
parent fda4776d30
commit f26766033e
47 changed files with 992 additions and 379 deletions
--- a/internal/api/resolver_model_performer.go
+++ b/internal/api/resolver_model_performer.go
@@ -24,6 +24,79 @@ func (r *performerResolver) AliasList(ctx context.Context, obj *models.Performer
 	return obj.Aliases.List(), nil
 }

+func (r *performerResolver) URL(ctx context.Context, obj *models.Performer) (*string, error) {
+	if !obj.URLs.Loaded() {
+		if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+			return obj.LoadURLs(ctx, r.repository.Performer)
+		}); err != nil {
+			return nil, err
+		}
+	}
+
+	urls := obj.URLs.List()
+	if len(urls) == 0 {
+		return nil, nil
+	}
+
+	return &urls[0], nil
+}
+
+func (r *performerResolver) Twitter(ctx context.Context, obj *models.Performer) (*string, error) {
+	if !obj.URLs.Loaded() {
+		if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+			return obj.LoadURLs(ctx, r.repository.Performer)
+		}); err != nil {
+			return nil, err
+		}
+	}
+
+	urls := obj.URLs.List()
+
+	// find the first twitter url
+	for _, url := range urls {
+		if performer.IsTwitterURL(url) {
+			u := url
+			return &u, nil
+		}
+	}
+
+	return nil, nil
+}
+
+func (r *performerResolver) Instagram(ctx context.Context, obj *models.Performer) (*string, error) {
+	if !obj.URLs.Loaded() {
+		if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+			return obj.LoadURLs(ctx, r.repository.Performer)
+		}); err != nil {
+			return nil, err
+		}
+	}
+
+	urls := obj.URLs.List()
+
+	// find the first instagram url
+	for _, url := range urls {
+		if performer.IsInstagramURL(url) {
+			u := url
+			return &u, nil
+		}
+	}
+
+	return nil, nil
+}
+
+func (r *performerResolver) Urls(ctx context.Context, obj *models.Performer) ([]string, error) {
+	if !obj.URLs.Loaded() {
+		if err := r.withReadTxn(ctx, func(ctx context.Context) error {
+			return obj.LoadURLs(ctx, r.repository.Performer)
+		}); err != nil {
+			return nil, err
+		}
+	}
+
+	return obj.URLs.List(), nil
+}
+
 func (r *performerResolver) Height(ctx context.Context, obj *models.Performer) (*string, error) {
 	if obj.Height != nil {
 		ret := strconv.Itoa(*obj.Height)
--- a/internal/api/resolver_mutation_performer.go
+++ b/internal/api/resolver_mutation_performer.go
@@ -12,6 +12,11 @@ import (
 	"github.com/stashapp/stash/pkg/utils"
 )

+const (
+	twitterURL   = "https://twitter.com"
+	instagramURL = "https://instagram.com"
+)
+
 // used to refetch performer after hooks run
 func (r *mutationResolver) getPerformer(ctx context.Context, id int) (ret *models.Performer, err error) {
 	if err := r.withTxn(ctx, func(ctx context.Context) error {
@@ -35,7 +40,6 @@ func (r *mutationResolver) PerformerCreate(ctx context.Context, input models.Per
 	newPerformer.Name = input.Name
 	newPerformer.Disambiguation = translator.string(input.Disambiguation)
 	newPerformer.Aliases = models.NewRelatedStrings(input.AliasList)
-	newPerformer.URL = translator.string(input.URL)
 	newPerformer.Gender = input.Gender
 	newPerformer.Ethnicity = translator.string(input.Ethnicity)
 	newPerformer.Country = translator.string(input.Country)
@@ -47,8 +51,6 @@ func (r *mutationResolver) PerformerCreate(ctx context.Context, input models.Per
 	newPerformer.CareerLength = translator.string(input.CareerLength)
 	newPerformer.Tattoos = translator.string(input.Tattoos)
 	newPerformer.Piercings = translator.string(input.Piercings)
-	newPerformer.Twitter = translator.string(input.Twitter)
-	newPerformer.Instagram = translator.string(input.Instagram)
 	newPerformer.Favorite = translator.bool(input.Favorite)
 	newPerformer.Rating = input.Rating100
 	newPerformer.Details = translator.string(input.Details)
@@ -58,6 +60,21 @@ func (r *mutationResolver) PerformerCreate(ctx context.Context, input models.Per
 	newPerformer.IgnoreAutoTag = translator.bool(input.IgnoreAutoTag)
 	newPerformer.StashIDs = models.NewRelatedStashIDs(input.StashIds)

+	newPerformer.URLs = models.NewRelatedStrings([]string{})
+	if input.URL != nil {
+		newPerformer.URLs.Add(*input.URL)
+	}
+	if input.Twitter != nil {
+		newPerformer.URLs.Add(utils.URLFromHandle(*input.Twitter, twitterURL))
+	}
+	if input.Instagram != nil {
+		newPerformer.URLs.Add(utils.URLFromHandle(*input.Instagram, instagramURL))
+	}
+
+	if input.Urls != nil {
+		newPerformer.URLs.Add(input.Urls...)
+	}
+
 	var err error

 	newPerformer.Birthdate, err = translator.datePtr(input.Birthdate)
@@ -112,6 +129,96 @@ func (r *mutationResolver) PerformerCreate(ctx context.Context, input models.Per
 	return r.getPerformer(ctx, newPerformer.ID)
 }

+func (r *mutationResolver) validateNoLegacyURLs(translator changesetTranslator) error {
+	// ensure url/twitter/instagram are not included in the input
+	if translator.hasField("url") {
+		return fmt.Errorf("url field must not be included if urls is included")
+	}
+	if translator.hasField("twitter") {
+		return fmt.Errorf("twitter field must not be included if urls is included")
+	}
+	if translator.hasField("instagram") {
+		return fmt.Errorf("instagram field must not be included if urls is included")
+	}
+
+	return nil
+}
+
+func (r *mutationResolver) handleLegacyURLs(ctx context.Context, performerID int, legacyURL, legacyTwitter, legacyInstagram models.OptionalString, updatedPerformer *models.PerformerPartial) error {
+	qb := r.repository.Performer
+
+	// we need to be careful with URL/Twitter/Instagram
+	// treat URL as replacing the first non-Twitter/Instagram URL in the list
+	// twitter should replace any existing twitter URL
+	// instagram should replace any existing instagram URL
+	p, err := qb.Find(ctx, performerID)
+	if err != nil {
+		return err
+	}
+
+	if err := p.LoadURLs(ctx, qb); err != nil {
+		return fmt.Errorf("loading performer URLs: %w", err)
+	}
+
+	existingURLs := p.URLs.List()
+
+	// performer partial URLs should be empty
+	if legacyURL.Set {
+		replaced := false
+		for i, url := range existingURLs {
+			if !performer.IsTwitterURL(url) && !performer.IsInstagramURL(url) {
+				existingURLs[i] = legacyURL.Value
+				replaced = true
+				break
+			}
+		}
+
+		if !replaced {
+			existingURLs = append(existingURLs, legacyURL.Value)
+		}
+	}
+
+	if legacyTwitter.Set {
+		value := utils.URLFromHandle(legacyTwitter.Value, twitterURL)
+		found := false
+		// find and replace the first twitter URL
+		for i, url := range existingURLs {
+			if performer.IsTwitterURL(url) {
+				existingURLs[i] = value
+				found = true
+				break
+			}
+		}
+
+		if !found {
+			existingURLs = append(existingURLs, value)
+		}
+	}
+	if legacyInstagram.Set {
+		found := false
+		value := utils.URLFromHandle(legacyInstagram.Value, instagramURL)
+		// find and replace the first instagram URL
+		for i, url := range existingURLs {
+			if performer.IsInstagramURL(url) {
+				existingURLs[i] = value
+				found = true
+				break
+			}
+		}
+
+		if !found {
+			existingURLs = append(existingURLs, value)
+		}
+	}
+
+	updatedPerformer.URLs = &models.UpdateStrings{
+		Values: existingURLs,
+		Mode:   models.RelationshipUpdateModeSet,
+	}
+
+	return nil
+}
+
 func (r *mutationResolver) PerformerUpdate(ctx context.Context, input models.PerformerUpdateInput) (*models.Performer, error) {
 	performerID, err := strconv.Atoi(input.ID)
 	if err != nil {
@@ -127,7 +234,6 @@ func (r *mutationResolver) PerformerUpdate(ctx context.Context, input models.Per

 	updatedPerformer.Name = translator.optionalString(input.Name, "name")
 	updatedPerformer.Disambiguation = translator.optionalString(input.Disambiguation, "disambiguation")
-	updatedPerformer.URL = translator.optionalString(input.URL, "url")
 	updatedPerformer.Gender = translator.optionalString((*string)(input.Gender), "gender")
 	updatedPerformer.Ethnicity = translator.optionalString(input.Ethnicity, "ethnicity")
 	updatedPerformer.Country = translator.optionalString(input.Country, "country")
@@ -139,8 +245,6 @@ func (r *mutationResolver) PerformerUpdate(ctx context.Context, input models.Per
 	updatedPerformer.CareerLength = translator.optionalString(input.CareerLength, "career_length")
 	updatedPerformer.Tattoos = translator.optionalString(input.Tattoos, "tattoos")
 	updatedPerformer.Piercings = translator.optionalString(input.Piercings, "piercings")
-	updatedPerformer.Twitter = translator.optionalString(input.Twitter, "twitter")
-	updatedPerformer.Instagram = translator.optionalString(input.Instagram, "instagram")
 	updatedPerformer.Favorite = translator.optionalBool(input.Favorite, "favorite")
 	updatedPerformer.Rating = translator.optionalInt(input.Rating100, "rating100")
 	updatedPerformer.Details = translator.optionalString(input.Details, "details")
@@ -149,6 +253,19 @@ func (r *mutationResolver) PerformerUpdate(ctx context.Context, input models.Per
 	updatedPerformer.IgnoreAutoTag = translator.optionalBool(input.IgnoreAutoTag, "ignore_auto_tag")
 	updatedPerformer.StashIDs = translator.updateStashIDs(input.StashIds, "stash_ids")

+	if translator.hasField("urls") {
+		// ensure url/twitter/instagram are not included in the input
+		if err := r.validateNoLegacyURLs(translator); err != nil {
+			return nil, err
+		}
+
+		updatedPerformer.URLs = translator.updateStrings(input.Urls, "urls")
+	}
+
+	legacyURL := translator.optionalString(input.URL, "url")
+	legacyTwitter := translator.optionalString(input.Twitter, "twitter")
+	legacyInstagram := translator.optionalString(input.Instagram, "instagram")
+
 	updatedPerformer.Birthdate, err = translator.optionalDate(input.Birthdate, "birthdate")
 	if err != nil {
 		return nil, fmt.Errorf("converting birthdate: %w", err)
@@ -186,6 +303,12 @@ func (r *mutationResolver) PerformerUpdate(ctx context.Context, input models.Per
 	if err := r.withTxn(ctx, func(ctx context.Context) error {
 		qb := r.repository.Performer

+		if legacyURL.Set || legacyTwitter.Set || legacyInstagram.Set {
+			if err := r.handleLegacyURLs(ctx, performerID, legacyURL, legacyTwitter, legacyInstagram, &updatedPerformer); err != nil {
+				return err
+			}
+		}
+
 		if err := performer.ValidateUpdate(ctx, performerID, updatedPerformer, qb); err != nil {
 			return err
 		}
@@ -225,7 +348,7 @@ func (r *mutationResolver) BulkPerformerUpdate(ctx context.Context, input BulkPe
 	updatedPerformer := models.NewPerformerPartial()

 	updatedPerformer.Disambiguation = translator.optionalString(input.Disambiguation, "disambiguation")
-	updatedPerformer.URL = translator.optionalString(input.URL, "url")
+
 	updatedPerformer.Gender = translator.optionalString((*string)(input.Gender), "gender")
 	updatedPerformer.Ethnicity = translator.optionalString(input.Ethnicity, "ethnicity")
 	updatedPerformer.Country = translator.optionalString(input.Country, "country")
@@ -237,8 +360,7 @@ func (r *mutationResolver) BulkPerformerUpdate(ctx context.Context, input BulkPe
 	updatedPerformer.CareerLength = translator.optionalString(input.CareerLength, "career_length")
 	updatedPerformer.Tattoos = translator.optionalString(input.Tattoos, "tattoos")
 	updatedPerformer.Piercings = translator.optionalString(input.Piercings, "piercings")
-	updatedPerformer.Twitter = translator.optionalString(input.Twitter, "twitter")
-	updatedPerformer.Instagram = translator.optionalString(input.Instagram, "instagram")
+
 	updatedPerformer.Favorite = translator.optionalBool(input.Favorite, "favorite")
 	updatedPerformer.Rating = translator.optionalInt(input.Rating100, "rating100")
 	updatedPerformer.Details = translator.optionalString(input.Details, "details")
@@ -246,6 +368,19 @@ func (r *mutationResolver) BulkPerformerUpdate(ctx context.Context, input BulkPe
 	updatedPerformer.Weight = translator.optionalInt(input.Weight, "weight")
 	updatedPerformer.IgnoreAutoTag = translator.optionalBool(input.IgnoreAutoTag, "ignore_auto_tag")

+	if translator.hasField("urls") {
+		// ensure url/twitter/instagram are not included in the input
+		if err := r.validateNoLegacyURLs(translator); err != nil {
+			return nil, err
+		}
+
+		updatedPerformer.URLs = translator.updateStringsBulk(input.Urls, "urls")
+	}
+
+	legacyURL := translator.optionalString(input.URL, "url")
+	legacyTwitter := translator.optionalString(input.Twitter, "twitter")
+	legacyInstagram := translator.optionalString(input.Instagram, "instagram")
+
 	updatedPerformer.Birthdate, err = translator.optionalDate(input.Birthdate, "birthdate")
 	if err != nil {
 		return nil, fmt.Errorf("converting birthdate: %w", err)
@@ -277,6 +412,12 @@ func (r *mutationResolver) BulkPerformerUpdate(ctx context.Context, input BulkPe
 		qb := r.repository.Performer

 		for _, performerID := range performerIDs {
+			if legacyURL.Set || legacyTwitter.Set || legacyInstagram.Set {
+				if err := r.handleLegacyURLs(ctx, performerID, legacyURL, legacyTwitter, legacyInstagram, &updatedPerformer); err != nil {
+					return err
+				}
+			}
+
 			if err := performer.ValidateUpdate(ctx, performerID, updatedPerformer, qb); err != nil {
 				return err
 			}