mirror of
https://github.com/stashapp/stash.git
synced 2025-12-07 17:02:38 +01:00
* Push scrapeByURL into scrapers Replace ScrapePerfomerByURL, ScrapeMovie..., ... with ScrapeByURL in the scraperActionImpl interface. This allows us to delete a lot of repeated code in the scrapers and replace the central part with a switch on the scraper type. * Fold name scraping into one call Follow up on scraper refactoring. Name scrapers use the same code path. This allows us to restructure some code and kill some functions, adding variance to the name scraping code. It allows us to remove some code repetition as well. * Do not export loop refs. * Simplify fragment scraping Generalize fragment scrapers into ScrapeByFragment. This simplifies fragment code flows into a simpler pathing which should be easier to handle in the future. * Eliminate more context.TODO() In a number of cases, we have a context now. Use the context rather than TODO() for those cases in order to make those operations cancellable. * Pass the context for the stashbox scraper This removes all context.TODO() in the path of the stashbox scraper, and replaces it with the context that's present on each of the paths. * Pass the context into subscrapers Mostly a mechanical update, where we pass in the context for subscraping. This removes the final context.TODO() in the scraper code. * Warn on unknown fields from scripts A common mistake for new script writers are that they return fields not known to stash. For instance the name "description" is used rather than "details". Decode disallowing unknown fields. If this fails, use a tee-reader to fall back to the old behavior, but print a warning for the user in this case. Thus, we retain the old behavior, but print warnings for scripts which fails the more strict unknown-fields detection. * Nil-check before running the postprocessing chain Fixes panics when scraping returns nil values. * Lift nil-ness in post-postprocessing If the struct we are trying to post-process is nil, we shouldn't enter the postprocessing flow at all. Pass the struct as a value rather than a pointer, eliminating nil-checks as we go. Use the top-level postProcess call to make the nil-check and then abort there if the object we are looking at is nil. * Allow conversion routines to handle values If we have a non-pointer type in the interface, we should also convert those into ScrapedContent. Otherwise we get errors on deprecated functions.
997 lines
25 KiB
Go
997 lines
25 KiB
Go
package scraper
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"math"
|
|
"reflect"
|
|
"regexp"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/stashapp/stash/pkg/logger"
|
|
"github.com/stashapp/stash/pkg/models"
|
|
"github.com/stashapp/stash/pkg/utils"
|
|
"gopkg.in/yaml.v2"
|
|
)
|
|
|
|
type mappedQuery interface {
|
|
runQuery(selector string) ([]string, error)
|
|
subScrape(ctx context.Context, value string) mappedQuery
|
|
}
|
|
|
|
type commonMappedConfig map[string]string
|
|
|
|
type mappedConfig map[string]mappedScraperAttrConfig
|
|
|
|
func (s mappedConfig) applyCommon(c commonMappedConfig, src string) string {
|
|
if c == nil {
|
|
return src
|
|
}
|
|
|
|
ret := src
|
|
for commonKey, commonVal := range c {
|
|
ret = strings.ReplaceAll(ret, commonKey, commonVal)
|
|
}
|
|
|
|
return ret
|
|
}
|
|
|
|
func (s mappedConfig) process(ctx context.Context, q mappedQuery, common commonMappedConfig) mappedResults {
|
|
var ret mappedResults
|
|
|
|
for k, attrConfig := range s {
|
|
|
|
if attrConfig.Fixed != "" {
|
|
// TODO - not sure if this needs to set _all_ indexes for the key
|
|
const i = 0
|
|
ret = ret.setKey(i, k, attrConfig.Fixed)
|
|
} else {
|
|
selector := attrConfig.Selector
|
|
selector = s.applyCommon(common, selector)
|
|
|
|
found, err := q.runQuery(selector)
|
|
if err != nil {
|
|
logger.Warnf("key '%v': %v", k, err)
|
|
}
|
|
|
|
if len(found) > 0 {
|
|
result := s.postProcess(ctx, q, attrConfig, found)
|
|
for i, text := range result {
|
|
ret = ret.setKey(i, k, text)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return ret
|
|
}
|
|
|
|
func (s mappedConfig) postProcess(ctx context.Context, q mappedQuery, attrConfig mappedScraperAttrConfig, found []string) []string {
|
|
// check if we're concatenating the results into a single result
|
|
var ret []string
|
|
if attrConfig.hasConcat() {
|
|
result := attrConfig.concatenateResults(found)
|
|
result = attrConfig.postProcess(ctx, result, q)
|
|
if attrConfig.hasSplit() {
|
|
results := attrConfig.splitString(result)
|
|
results = attrConfig.cleanResults(results)
|
|
return results
|
|
}
|
|
|
|
ret = []string{result}
|
|
} else {
|
|
for _, text := range found {
|
|
text = attrConfig.postProcess(ctx, text, q)
|
|
if attrConfig.hasSplit() {
|
|
return attrConfig.splitString(text)
|
|
}
|
|
|
|
ret = append(ret, text)
|
|
}
|
|
ret = attrConfig.cleanResults(ret)
|
|
}
|
|
|
|
return ret
|
|
}
|
|
|
|
type mappedSceneScraperConfig struct {
|
|
mappedConfig
|
|
|
|
Tags mappedConfig `yaml:"Tags"`
|
|
Performers mappedPerformerScraperConfig `yaml:"Performers"`
|
|
Studio mappedConfig `yaml:"Studio"`
|
|
Movies mappedConfig `yaml:"Movies"`
|
|
}
|
|
type _mappedSceneScraperConfig mappedSceneScraperConfig
|
|
|
|
const (
|
|
mappedScraperConfigSceneTags = "Tags"
|
|
mappedScraperConfigScenePerformers = "Performers"
|
|
mappedScraperConfigSceneStudio = "Studio"
|
|
mappedScraperConfigSceneMovies = "Movies"
|
|
)
|
|
|
|
func (s *mappedSceneScraperConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
|
// HACK - unmarshal to map first, then remove known scene sub-fields, then
|
|
// remarshal to yaml and pass that down to the base map
|
|
parentMap := make(map[string]interface{})
|
|
if err := unmarshal(parentMap); err != nil {
|
|
return err
|
|
}
|
|
|
|
// move the known sub-fields to a separate map
|
|
thisMap := make(map[string]interface{})
|
|
|
|
thisMap[mappedScraperConfigSceneTags] = parentMap[mappedScraperConfigSceneTags]
|
|
thisMap[mappedScraperConfigScenePerformers] = parentMap[mappedScraperConfigScenePerformers]
|
|
thisMap[mappedScraperConfigSceneStudio] = parentMap[mappedScraperConfigSceneStudio]
|
|
thisMap[mappedScraperConfigSceneMovies] = parentMap[mappedScraperConfigSceneMovies]
|
|
|
|
delete(parentMap, mappedScraperConfigSceneTags)
|
|
delete(parentMap, mappedScraperConfigScenePerformers)
|
|
delete(parentMap, mappedScraperConfigSceneStudio)
|
|
delete(parentMap, mappedScraperConfigSceneMovies)
|
|
|
|
// re-unmarshal the sub-fields
|
|
yml, err := yaml.Marshal(thisMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// needs to be a different type to prevent infinite recursion
|
|
c := _mappedSceneScraperConfig{}
|
|
if err := yaml.Unmarshal(yml, &c); err != nil {
|
|
return err
|
|
}
|
|
|
|
*s = mappedSceneScraperConfig(c)
|
|
|
|
yml, err = yaml.Marshal(parentMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := yaml.Unmarshal(yml, &s.mappedConfig); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
type mappedGalleryScraperConfig struct {
|
|
mappedConfig
|
|
|
|
Tags mappedConfig `yaml:"Tags"`
|
|
Performers mappedConfig `yaml:"Performers"`
|
|
Studio mappedConfig `yaml:"Studio"`
|
|
}
|
|
type _mappedGalleryScraperConfig mappedGalleryScraperConfig
|
|
|
|
func (s *mappedGalleryScraperConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
|
// HACK - unmarshal to map first, then remove known scene sub-fields, then
|
|
// remarshal to yaml and pass that down to the base map
|
|
parentMap := make(map[string]interface{})
|
|
if err := unmarshal(parentMap); err != nil {
|
|
return err
|
|
}
|
|
|
|
// move the known sub-fields to a separate map
|
|
thisMap := make(map[string]interface{})
|
|
|
|
thisMap[mappedScraperConfigSceneTags] = parentMap[mappedScraperConfigSceneTags]
|
|
thisMap[mappedScraperConfigScenePerformers] = parentMap[mappedScraperConfigScenePerformers]
|
|
thisMap[mappedScraperConfigSceneStudio] = parentMap[mappedScraperConfigSceneStudio]
|
|
|
|
delete(parentMap, mappedScraperConfigSceneTags)
|
|
delete(parentMap, mappedScraperConfigScenePerformers)
|
|
delete(parentMap, mappedScraperConfigSceneStudio)
|
|
|
|
// re-unmarshal the sub-fields
|
|
yml, err := yaml.Marshal(thisMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// needs to be a different type to prevent infinite recursion
|
|
c := _mappedGalleryScraperConfig{}
|
|
if err := yaml.Unmarshal(yml, &c); err != nil {
|
|
return err
|
|
}
|
|
|
|
*s = mappedGalleryScraperConfig(c)
|
|
|
|
yml, err = yaml.Marshal(parentMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := yaml.Unmarshal(yml, &s.mappedConfig); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
type mappedPerformerScraperConfig struct {
|
|
mappedConfig
|
|
|
|
Tags mappedConfig `yaml:"Tags"`
|
|
}
|
|
type _mappedPerformerScraperConfig mappedPerformerScraperConfig
|
|
|
|
const (
|
|
mappedScraperConfigPerformerTags = "Tags"
|
|
)
|
|
|
|
func (s *mappedPerformerScraperConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
|
// HACK - unmarshal to map first, then remove known scene sub-fields, then
|
|
// remarshal to yaml and pass that down to the base map
|
|
parentMap := make(map[string]interface{})
|
|
if err := unmarshal(parentMap); err != nil {
|
|
return err
|
|
}
|
|
|
|
// move the known sub-fields to a separate map
|
|
thisMap := make(map[string]interface{})
|
|
|
|
thisMap[mappedScraperConfigPerformerTags] = parentMap[mappedScraperConfigPerformerTags]
|
|
|
|
delete(parentMap, mappedScraperConfigPerformerTags)
|
|
|
|
// re-unmarshal the sub-fields
|
|
yml, err := yaml.Marshal(thisMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// needs to be a different type to prevent infinite recursion
|
|
c := _mappedPerformerScraperConfig{}
|
|
if err := yaml.Unmarshal(yml, &c); err != nil {
|
|
return err
|
|
}
|
|
|
|
*s = mappedPerformerScraperConfig(c)
|
|
|
|
yml, err = yaml.Marshal(parentMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := yaml.Unmarshal(yml, &s.mappedConfig); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
type mappedMovieScraperConfig struct {
|
|
mappedConfig
|
|
|
|
Studio mappedConfig `yaml:"Studio"`
|
|
}
|
|
type _mappedMovieScraperConfig mappedMovieScraperConfig
|
|
|
|
const (
|
|
mappedScraperConfigMovieStudio = "Studio"
|
|
)
|
|
|
|
func (s *mappedMovieScraperConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
|
// HACK - unmarshal to map first, then remove known movie sub-fields, then
|
|
// remarshal to yaml and pass that down to the base map
|
|
parentMap := make(map[string]interface{})
|
|
if err := unmarshal(parentMap); err != nil {
|
|
return err
|
|
}
|
|
|
|
// move the known sub-fields to a separate map
|
|
thisMap := make(map[string]interface{})
|
|
|
|
thisMap[mappedScraperConfigMovieStudio] = parentMap[mappedScraperConfigMovieStudio]
|
|
|
|
delete(parentMap, mappedScraperConfigMovieStudio)
|
|
|
|
// re-unmarshal the sub-fields
|
|
yml, err := yaml.Marshal(thisMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// needs to be a different type to prevent infinite recursion
|
|
c := _mappedMovieScraperConfig{}
|
|
if err := yaml.Unmarshal(yml, &c); err != nil {
|
|
return err
|
|
}
|
|
|
|
*s = mappedMovieScraperConfig(c)
|
|
|
|
yml, err = yaml.Marshal(parentMap)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := yaml.Unmarshal(yml, &s.mappedConfig); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
type mappedRegexConfig struct {
|
|
Regex string `yaml:"regex"`
|
|
With string `yaml:"with"`
|
|
}
|
|
|
|
type mappedRegexConfigs []mappedRegexConfig
|
|
|
|
func (c mappedRegexConfig) apply(value string) string {
|
|
if c.Regex != "" {
|
|
re, err := regexp.Compile(c.Regex)
|
|
if err != nil {
|
|
logger.Warnf("Error compiling regex '%s': %s", c.Regex, err.Error())
|
|
return value
|
|
}
|
|
|
|
ret := re.ReplaceAllString(value, c.With)
|
|
|
|
// trim leading and trailing whitespace
|
|
// this is done to maintain backwards compatibility with existing
|
|
// scrapers
|
|
ret = strings.TrimSpace(ret)
|
|
|
|
logger.Debugf(`Replace: '%s' with '%s'`, c.Regex, c.With)
|
|
logger.Debugf("Before: %s", value)
|
|
logger.Debugf("After: %s", ret)
|
|
return ret
|
|
}
|
|
|
|
return value
|
|
}
|
|
|
|
func (c mappedRegexConfigs) apply(value string) string {
|
|
// apply regex in order
|
|
for _, config := range c {
|
|
value = config.apply(value)
|
|
}
|
|
|
|
return value
|
|
}
|
|
|
|
type postProcessAction interface {
|
|
Apply(ctx context.Context, value string, q mappedQuery) string
|
|
}
|
|
|
|
type postProcessParseDate string
|
|
|
|
func (p *postProcessParseDate) Apply(ctx context.Context, value string, q mappedQuery) string {
|
|
parseDate := string(*p)
|
|
|
|
const internalDateFormat = "2006-01-02"
|
|
|
|
valueLower := strings.ToLower(value)
|
|
if valueLower == "today" || valueLower == "yesterday" { // handle today, yesterday
|
|
dt := time.Now()
|
|
if valueLower == "yesterday" { // subtract 1 day from now
|
|
dt = dt.AddDate(0, 0, -1)
|
|
}
|
|
return dt.Format(internalDateFormat)
|
|
}
|
|
|
|
if parseDate == "" {
|
|
return value
|
|
}
|
|
|
|
// try to parse the date using the pattern
|
|
// if it fails, then just fall back to the original value
|
|
parsedValue, err := time.Parse(parseDate, value)
|
|
if err != nil {
|
|
logger.Warnf("Error parsing date string '%s' using format '%s': %s", value, parseDate, err.Error())
|
|
return value
|
|
}
|
|
|
|
// convert it into our date format
|
|
return parsedValue.Format(internalDateFormat)
|
|
}
|
|
|
|
type postProcessSubtractDays bool
|
|
|
|
func (p *postProcessSubtractDays) Apply(ctx context.Context, value string, q mappedQuery) string {
|
|
const internalDateFormat = "2006-01-02"
|
|
|
|
i, err := strconv.Atoi(value)
|
|
if err != nil {
|
|
logger.Warnf("Error parsing day string %s: %s", value, err)
|
|
return value
|
|
}
|
|
|
|
dt := time.Now()
|
|
dt = dt.AddDate(0, 0, -i)
|
|
return dt.Format(internalDateFormat)
|
|
}
|
|
|
|
type postProcessReplace mappedRegexConfigs
|
|
|
|
func (c *postProcessReplace) Apply(ctx context.Context, value string, q mappedQuery) string {
|
|
replace := mappedRegexConfigs(*c)
|
|
return replace.apply(value)
|
|
}
|
|
|
|
type postProcessSubScraper mappedScraperAttrConfig
|
|
|
|
func (p *postProcessSubScraper) Apply(ctx context.Context, value string, q mappedQuery) string {
|
|
subScrapeConfig := mappedScraperAttrConfig(*p)
|
|
|
|
logger.Debugf("Sub-scraping for: %s", value)
|
|
ss := q.subScrape(ctx, value)
|
|
|
|
if ss != nil {
|
|
found, err := ss.runQuery(subScrapeConfig.Selector)
|
|
if err != nil {
|
|
logger.Warnf("subscrape for '%v': %v", value, err)
|
|
}
|
|
|
|
if len(found) > 0 {
|
|
// check if we're concatenating the results into a single result
|
|
var result string
|
|
if subScrapeConfig.hasConcat() {
|
|
result = subScrapeConfig.concatenateResults(found)
|
|
} else {
|
|
result = found[0]
|
|
}
|
|
|
|
result = subScrapeConfig.postProcess(ctx, result, ss)
|
|
return result
|
|
}
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
type postProcessMap map[string]string
|
|
|
|
func (p *postProcessMap) Apply(ctx context.Context, value string, q mappedQuery) string {
|
|
// return the mapped value if present
|
|
m := *p
|
|
mapped, ok := m[value]
|
|
|
|
if ok {
|
|
return mapped
|
|
}
|
|
|
|
return value
|
|
}
|
|
|
|
type postProcessFeetToCm bool
|
|
|
|
func (p *postProcessFeetToCm) Apply(ctx context.Context, value string, q mappedQuery) string {
|
|
const foot_in_cm = 30.48
|
|
const inch_in_cm = 2.54
|
|
|
|
reg := regexp.MustCompile("[0-9]+")
|
|
filtered := reg.FindAllString(value, -1)
|
|
|
|
var feet float64
|
|
var inches float64
|
|
if len(filtered) > 0 {
|
|
feet, _ = strconv.ParseFloat(filtered[0], 64)
|
|
}
|
|
if len(filtered) > 1 {
|
|
inches, _ = strconv.ParseFloat(filtered[1], 64)
|
|
}
|
|
|
|
var centimeters = feet*foot_in_cm + inches*inch_in_cm
|
|
|
|
// Return rounded integer string
|
|
return strconv.Itoa(int(math.Round(centimeters)))
|
|
}
|
|
|
|
type postProcessLbToKg bool
|
|
|
|
func (p *postProcessLbToKg) Apply(ctx context.Context, value string, q mappedQuery) string {
|
|
const lb_in_kg = 0.45359237
|
|
w, err := strconv.ParseFloat(value, 64)
|
|
if err == nil {
|
|
w *= lb_in_kg
|
|
value = strconv.Itoa(int(math.Round(w)))
|
|
}
|
|
return value
|
|
}
|
|
|
|
type mappedPostProcessAction struct {
|
|
ParseDate string `yaml:"parseDate"`
|
|
SubtractDays bool `yaml:"subtractDays"`
|
|
Replace mappedRegexConfigs `yaml:"replace"`
|
|
SubScraper *mappedScraperAttrConfig `yaml:"subScraper"`
|
|
Map map[string]string `yaml:"map"`
|
|
FeetToCm bool `yaml:"feetToCm"`
|
|
LbToKg bool `yaml:"lbToKg"`
|
|
}
|
|
|
|
func (a mappedPostProcessAction) ToPostProcessAction() (postProcessAction, error) {
|
|
var found string
|
|
var ret postProcessAction
|
|
|
|
if a.ParseDate != "" {
|
|
found = "parseDate"
|
|
action := postProcessParseDate(a.ParseDate)
|
|
ret = &action
|
|
}
|
|
if len(a.Replace) > 0 {
|
|
if found != "" {
|
|
return nil, fmt.Errorf("post-process actions must have a single field, found %s and %s", found, "replace")
|
|
}
|
|
found = "replace"
|
|
action := postProcessReplace(a.Replace)
|
|
ret = &action
|
|
}
|
|
if a.SubScraper != nil {
|
|
if found != "" {
|
|
return nil, fmt.Errorf("post-process actions must have a single field, found %s and %s", found, "subScraper")
|
|
}
|
|
found = "subScraper"
|
|
action := postProcessSubScraper(*a.SubScraper)
|
|
ret = &action
|
|
}
|
|
if a.Map != nil {
|
|
if found != "" {
|
|
return nil, fmt.Errorf("post-process actions must have a single field, found %s and %s", found, "map")
|
|
}
|
|
found = "map"
|
|
action := postProcessMap(a.Map)
|
|
ret = &action
|
|
}
|
|
if a.FeetToCm {
|
|
if found != "" {
|
|
return nil, fmt.Errorf("post-process actions must have a single field, found %s and %s", found, "feetToCm")
|
|
}
|
|
found = "feetToCm"
|
|
action := postProcessFeetToCm(a.FeetToCm)
|
|
ret = &action
|
|
}
|
|
if a.LbToKg {
|
|
if found != "" {
|
|
return nil, fmt.Errorf("post-process actions must have a single field, found %s and %s", found, "lbToKg")
|
|
}
|
|
found = "lbToKg"
|
|
action := postProcessLbToKg(a.LbToKg)
|
|
ret = &action
|
|
}
|
|
if a.SubtractDays {
|
|
if found != "" {
|
|
return nil, fmt.Errorf("post-process actions must have a single field, found %s and %s", found, "subtractDays")
|
|
}
|
|
// found = "subtractDays"
|
|
action := postProcessSubtractDays(a.SubtractDays)
|
|
ret = &action
|
|
}
|
|
|
|
if ret == nil {
|
|
return nil, errors.New("invalid post-process action")
|
|
}
|
|
|
|
return ret, nil
|
|
}
|
|
|
|
type mappedScraperAttrConfig struct {
|
|
Selector string `yaml:"selector"`
|
|
Fixed string `yaml:"fixed"`
|
|
PostProcess []mappedPostProcessAction `yaml:"postProcess"`
|
|
Concat string `yaml:"concat"`
|
|
Split string `yaml:"split"`
|
|
|
|
postProcessActions []postProcessAction
|
|
|
|
// Deprecated: use PostProcess instead
|
|
ParseDate string `yaml:"parseDate"`
|
|
Replace mappedRegexConfigs `yaml:"replace"`
|
|
SubScraper *mappedScraperAttrConfig `yaml:"subScraper"`
|
|
}
|
|
|
|
type _mappedScraperAttrConfig mappedScraperAttrConfig
|
|
|
|
func (c *mappedScraperAttrConfig) UnmarshalYAML(unmarshal func(interface{}) error) error {
|
|
// try unmarshalling into a string first
|
|
if err := unmarshal(&c.Selector); err != nil {
|
|
// if it's a type error then we try to unmarshall to the full object
|
|
var typeErr *yaml.TypeError
|
|
if !errors.As(err, &typeErr) {
|
|
return err
|
|
}
|
|
|
|
// unmarshall to full object
|
|
// need it as a separate object
|
|
t := _mappedScraperAttrConfig{}
|
|
if err = unmarshal(&t); err != nil {
|
|
return err
|
|
}
|
|
|
|
*c = mappedScraperAttrConfig(t)
|
|
}
|
|
|
|
return c.convertPostProcessActions()
|
|
}
|
|
|
|
func (c *mappedScraperAttrConfig) convertPostProcessActions() error {
|
|
// ensure we don't have the old deprecated fields and the new post process field
|
|
if len(c.PostProcess) > 0 {
|
|
if c.ParseDate != "" || len(c.Replace) > 0 || c.SubScraper != nil {
|
|
return errors.New("cannot include postProcess and (parseDate, replace, subScraper) deprecated fields")
|
|
}
|
|
|
|
// convert xpathPostProcessAction actions to postProcessActions
|
|
for _, a := range c.PostProcess {
|
|
action, err := a.ToPostProcessAction()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
c.postProcessActions = append(c.postProcessActions, action)
|
|
}
|
|
|
|
c.PostProcess = nil
|
|
} else {
|
|
// convert old deprecated fields if present
|
|
// in same order as they used to be executed
|
|
if len(c.Replace) > 0 {
|
|
action := postProcessReplace(c.Replace)
|
|
c.postProcessActions = append(c.postProcessActions, &action)
|
|
c.Replace = nil
|
|
}
|
|
|
|
if c.SubScraper != nil {
|
|
action := postProcessSubScraper(*c.SubScraper)
|
|
c.postProcessActions = append(c.postProcessActions, &action)
|
|
c.SubScraper = nil
|
|
}
|
|
|
|
if c.ParseDate != "" {
|
|
action := postProcessParseDate(c.ParseDate)
|
|
c.postProcessActions = append(c.postProcessActions, &action)
|
|
c.ParseDate = ""
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (c mappedScraperAttrConfig) hasConcat() bool {
|
|
return c.Concat != ""
|
|
}
|
|
|
|
func (c mappedScraperAttrConfig) hasSplit() bool {
|
|
return c.Split != ""
|
|
}
|
|
|
|
func (c mappedScraperAttrConfig) concatenateResults(nodes []string) string {
|
|
separator := c.Concat
|
|
return strings.Join(nodes, separator)
|
|
}
|
|
|
|
func (c mappedScraperAttrConfig) cleanResults(nodes []string) []string {
|
|
cleaned := utils.StrUnique(nodes) // remove duplicate values
|
|
cleaned = utils.StrDelete(cleaned, "") // remove empty values
|
|
return cleaned
|
|
}
|
|
|
|
func (c mappedScraperAttrConfig) splitString(value string) []string {
|
|
separator := c.Split
|
|
var res []string
|
|
|
|
if separator == "" {
|
|
return []string{value}
|
|
}
|
|
|
|
for _, str := range strings.Split(value, separator) {
|
|
if str != "" {
|
|
res = append(res, str)
|
|
}
|
|
}
|
|
|
|
return res
|
|
}
|
|
|
|
func (c mappedScraperAttrConfig) postProcess(ctx context.Context, value string, q mappedQuery) string {
|
|
for _, action := range c.postProcessActions {
|
|
value = action.Apply(ctx, value, q)
|
|
}
|
|
|
|
return value
|
|
}
|
|
|
|
type mappedScrapers map[string]*mappedScraper
|
|
|
|
type mappedScraper struct {
|
|
Common commonMappedConfig `yaml:"common"`
|
|
Scene *mappedSceneScraperConfig `yaml:"scene"`
|
|
Gallery *mappedGalleryScraperConfig `yaml:"gallery"`
|
|
Performer *mappedPerformerScraperConfig `yaml:"performer"`
|
|
Movie *mappedMovieScraperConfig `yaml:"movie"`
|
|
}
|
|
|
|
type mappedResult map[string]string
|
|
type mappedResults []mappedResult
|
|
|
|
func (r mappedResult) apply(dest interface{}) {
|
|
destVal := reflect.ValueOf(dest)
|
|
|
|
// dest should be a pointer
|
|
destVal = destVal.Elem()
|
|
|
|
for key, value := range r {
|
|
field := destVal.FieldByName(key)
|
|
|
|
if field.IsValid() {
|
|
var reflectValue reflect.Value
|
|
if field.Kind() == reflect.Ptr {
|
|
// need to copy the value, otherwise everything is set to the
|
|
// same pointer
|
|
localValue := value
|
|
reflectValue = reflect.ValueOf(&localValue)
|
|
} else {
|
|
reflectValue = reflect.ValueOf(value)
|
|
}
|
|
|
|
field.Set(reflectValue)
|
|
} else {
|
|
logger.Errorf("Field %s does not exist in %T", key, dest)
|
|
}
|
|
}
|
|
}
|
|
|
|
func (r mappedResults) setKey(index int, key string, value string) mappedResults {
|
|
if index >= len(r) {
|
|
r = append(r, make(mappedResult))
|
|
}
|
|
|
|
logger.Debugf(`[%d][%s] = %s`, index, key, value)
|
|
r[index][key] = value
|
|
return r
|
|
}
|
|
|
|
func (s mappedScraper) scrapePerformer(ctx context.Context, q mappedQuery) (*models.ScrapedPerformer, error) {
|
|
var ret models.ScrapedPerformer
|
|
|
|
performerMap := s.Performer
|
|
if performerMap == nil {
|
|
return nil, nil
|
|
}
|
|
|
|
performerTagsMap := performerMap.Tags
|
|
|
|
results := performerMap.process(ctx, q, s.Common)
|
|
if len(results) > 0 {
|
|
results[0].apply(&ret)
|
|
|
|
// now apply the tags
|
|
if performerTagsMap != nil {
|
|
logger.Debug(`Processing performer tags:`)
|
|
tagResults := performerTagsMap.process(ctx, q, s.Common)
|
|
|
|
for _, p := range tagResults {
|
|
tag := &models.ScrapedTag{}
|
|
p.apply(tag)
|
|
ret.Tags = append(ret.Tags, tag)
|
|
}
|
|
}
|
|
}
|
|
|
|
return &ret, nil
|
|
}
|
|
|
|
func (s mappedScraper) scrapePerformers(ctx context.Context, q mappedQuery) ([]*models.ScrapedPerformer, error) {
|
|
var ret []*models.ScrapedPerformer
|
|
|
|
performerMap := s.Performer
|
|
if performerMap == nil {
|
|
return nil, nil
|
|
}
|
|
|
|
results := performerMap.process(ctx, q, s.Common)
|
|
for _, r := range results {
|
|
var p models.ScrapedPerformer
|
|
r.apply(&p)
|
|
ret = append(ret, &p)
|
|
}
|
|
|
|
return ret, nil
|
|
}
|
|
|
|
func (s mappedScraper) processScene(ctx context.Context, q mappedQuery, r mappedResult) *models.ScrapedScene {
|
|
var ret models.ScrapedScene
|
|
|
|
sceneScraperConfig := s.Scene
|
|
|
|
scenePerformersMap := sceneScraperConfig.Performers
|
|
sceneTagsMap := sceneScraperConfig.Tags
|
|
sceneStudioMap := sceneScraperConfig.Studio
|
|
sceneMoviesMap := sceneScraperConfig.Movies
|
|
|
|
scenePerformerTagsMap := scenePerformersMap.Tags
|
|
|
|
r.apply(&ret)
|
|
|
|
// process performer tags once
|
|
var performerTagResults mappedResults
|
|
if scenePerformerTagsMap != nil {
|
|
performerTagResults = scenePerformerTagsMap.process(ctx, q, s.Common)
|
|
}
|
|
|
|
// now apply the performers and tags
|
|
if scenePerformersMap.mappedConfig != nil {
|
|
logger.Debug(`Processing scene performers:`)
|
|
performerResults := scenePerformersMap.process(ctx, q, s.Common)
|
|
|
|
for _, p := range performerResults {
|
|
performer := &models.ScrapedPerformer{}
|
|
p.apply(performer)
|
|
|
|
for _, p := range performerTagResults {
|
|
tag := &models.ScrapedTag{}
|
|
p.apply(tag)
|
|
ret.Tags = append(ret.Tags, tag)
|
|
}
|
|
|
|
ret.Performers = append(ret.Performers, performer)
|
|
}
|
|
}
|
|
|
|
if sceneTagsMap != nil {
|
|
logger.Debug(`Processing scene tags:`)
|
|
tagResults := sceneTagsMap.process(ctx, q, s.Common)
|
|
|
|
for _, p := range tagResults {
|
|
tag := &models.ScrapedTag{}
|
|
p.apply(tag)
|
|
ret.Tags = append(ret.Tags, tag)
|
|
}
|
|
}
|
|
|
|
if sceneStudioMap != nil {
|
|
logger.Debug(`Processing scene studio:`)
|
|
studioResults := sceneStudioMap.process(ctx, q, s.Common)
|
|
|
|
if len(studioResults) > 0 {
|
|
studio := &models.ScrapedStudio{}
|
|
studioResults[0].apply(studio)
|
|
ret.Studio = studio
|
|
}
|
|
}
|
|
|
|
if sceneMoviesMap != nil {
|
|
logger.Debug(`Processing scene movies:`)
|
|
movieResults := sceneMoviesMap.process(ctx, q, s.Common)
|
|
|
|
for _, p := range movieResults {
|
|
movie := &models.ScrapedMovie{}
|
|
p.apply(movie)
|
|
ret.Movies = append(ret.Movies, movie)
|
|
}
|
|
}
|
|
|
|
return &ret
|
|
}
|
|
|
|
func (s mappedScraper) scrapeScenes(ctx context.Context, q mappedQuery) ([]*models.ScrapedScene, error) {
|
|
var ret []*models.ScrapedScene
|
|
|
|
sceneScraperConfig := s.Scene
|
|
sceneMap := sceneScraperConfig.mappedConfig
|
|
if sceneMap == nil {
|
|
return nil, nil
|
|
}
|
|
|
|
logger.Debug(`Processing scenes:`)
|
|
results := sceneMap.process(ctx, q, s.Common)
|
|
for _, r := range results {
|
|
logger.Debug(`Processing scene:`)
|
|
ret = append(ret, s.processScene(ctx, q, r))
|
|
}
|
|
|
|
return ret, nil
|
|
}
|
|
|
|
func (s mappedScraper) scrapeScene(ctx context.Context, q mappedQuery) (*models.ScrapedScene, error) {
|
|
var ret models.ScrapedScene
|
|
|
|
sceneScraperConfig := s.Scene
|
|
sceneMap := sceneScraperConfig.mappedConfig
|
|
if sceneMap == nil {
|
|
return nil, nil
|
|
}
|
|
|
|
logger.Debug(`Processing scene:`)
|
|
results := sceneMap.process(ctx, q, s.Common)
|
|
if len(results) > 0 {
|
|
ss := s.processScene(ctx, q, results[0])
|
|
ret = *ss
|
|
}
|
|
|
|
return &ret, nil
|
|
}
|
|
|
|
func (s mappedScraper) scrapeGallery(ctx context.Context, q mappedQuery) (*models.ScrapedGallery, error) {
|
|
var ret models.ScrapedGallery
|
|
|
|
galleryScraperConfig := s.Gallery
|
|
galleryMap := galleryScraperConfig.mappedConfig
|
|
if galleryMap == nil {
|
|
return nil, nil
|
|
}
|
|
|
|
galleryPerformersMap := galleryScraperConfig.Performers
|
|
galleryTagsMap := galleryScraperConfig.Tags
|
|
galleryStudioMap := galleryScraperConfig.Studio
|
|
|
|
logger.Debug(`Processing gallery:`)
|
|
results := galleryMap.process(ctx, q, s.Common)
|
|
if len(results) > 0 {
|
|
results[0].apply(&ret)
|
|
|
|
// now apply the performers and tags
|
|
if galleryPerformersMap != nil {
|
|
logger.Debug(`Processing gallery performers:`)
|
|
performerResults := galleryPerformersMap.process(ctx, q, s.Common)
|
|
|
|
for _, p := range performerResults {
|
|
performer := &models.ScrapedPerformer{}
|
|
p.apply(performer)
|
|
ret.Performers = append(ret.Performers, performer)
|
|
}
|
|
}
|
|
|
|
if galleryTagsMap != nil {
|
|
logger.Debug(`Processing gallery tags:`)
|
|
tagResults := galleryTagsMap.process(ctx, q, s.Common)
|
|
|
|
for _, p := range tagResults {
|
|
tag := &models.ScrapedTag{}
|
|
p.apply(tag)
|
|
ret.Tags = append(ret.Tags, tag)
|
|
}
|
|
}
|
|
|
|
if galleryStudioMap != nil {
|
|
logger.Debug(`Processing gallery studio:`)
|
|
studioResults := galleryStudioMap.process(ctx, q, s.Common)
|
|
|
|
if len(studioResults) > 0 {
|
|
studio := &models.ScrapedStudio{}
|
|
studioResults[0].apply(studio)
|
|
ret.Studio = studio
|
|
}
|
|
}
|
|
}
|
|
|
|
return &ret, nil
|
|
}
|
|
|
|
func (s mappedScraper) scrapeMovie(ctx context.Context, q mappedQuery) (*models.ScrapedMovie, error) {
|
|
var ret models.ScrapedMovie
|
|
|
|
movieScraperConfig := s.Movie
|
|
movieMap := movieScraperConfig.mappedConfig
|
|
if movieMap == nil {
|
|
return nil, nil
|
|
}
|
|
|
|
movieStudioMap := movieScraperConfig.Studio
|
|
|
|
results := movieMap.process(ctx, q, s.Common)
|
|
if len(results) > 0 {
|
|
results[0].apply(&ret)
|
|
|
|
if movieStudioMap != nil {
|
|
logger.Debug(`Processing movie studio:`)
|
|
studioResults := movieStudioMap.process(ctx, q, s.Common)
|
|
|
|
if len(studioResults) > 0 {
|
|
studio := &models.ScrapedStudio{}
|
|
studioResults[0].apply(studio)
|
|
ret.Studio = studio
|
|
}
|
|
}
|
|
}
|
|
|
|
return &ret, nil
|
|
}
|