Skip to content

Commit

Permalink
Various bugfixes for scene tagger (stashapp#1014)
Browse files Browse the repository at this point in the history 
* Tagger fixes
* Validate stash-box endpoint pattern
  • Loading branch information
InfiniteTF authored Dec 28, 2020
1 parent bafa8eb commit ca49011
Show file tree
Hide file tree
Showing 10 changed files with 185 additions and 105 deletions.
8 changes: 8 additions & 0 deletions pkg/manager/config/config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"errors"
"io/ioutil"
"path/filepath"
"regexp"

"github.com/spf13/viper"

Expand Down Expand Up @@ -427,11 +428,18 @@ func ValidateCredentials(username string, password string) bool {
func ValidateStashBoxes(boxes []*models.StashBoxInput) error {
isMulti := len(boxes) > 1

re, err := regexp.Compile("^http.*graphql$")
if err != nil {
return errors.New("Failure to generate regular expression")
}

for _, box := range boxes {
if box.APIKey == "" {
return errors.New("Stash-box API Key cannot be blank")
} else if box.Endpoint == "" {
return errors.New("Stash-box Endpoint cannot be blank")
} else if !re.Match([]byte(box.Endpoint)) {
return errors.New("Stash-box Endpoint is invalid")
} else if isMulti && box.Name == "" {
return errors.New("Stash-box Name cannot be blank")
}
Expand Down
1 change: 1 addition & 0 deletions ui/v2.5/src/components/Changelog/versions/v050.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@
### 🐛 Bug fixes
* Corrected file sizes on 32bit platforms
* Fixed login redirect to remember the current page.
* Fixed scene tagger config saving
4 changes: 2 additions & 2 deletions ui/v2.5/src/components/Settings/StashBoxConfiguration.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const Instance: React.FC<IInstanceProps> = ({
value={instance?.endpoint}
isValid={(instance?.endpoint?.length ?? 0) > 0}
onInput={(e: React.ChangeEvent<HTMLInputElement>) =>
handleInput("endpoint", e.currentTarget.value)
handleInput("endpoint", e.currentTarget.value.trim())
}
/>
<Form.Control
Expand All @@ -50,7 +50,7 @@ const Instance: React.FC<IInstanceProps> = ({
value={instance?.api_key}
isValid={(instance?.api_key?.length ?? 0) > 0}
onInput={(e: React.ChangeEvent<HTMLInputElement>) =>
handleInput("api_key", e.currentTarget.value)
handleInput("api_key", e.currentTarget.value.trim())
}
/>
<InputGroup.Append>
Expand Down
2 changes: 1 addition & 1 deletion ui/v2.5/src/components/Shared/styles.scss
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
}

&.inline {
display: inline-block;
display: inline;
height: auto;
margin-left: 0.5rem;
}
Expand Down
82 changes: 9 additions & 73 deletions ui/v2.5/src/components/Tagger/Config.tsx
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { Dispatch, useEffect, useState } from "react";
import React, { Dispatch, useRef } from "react";
import {
Badge,
Button,
Expand All @@ -8,51 +8,9 @@ import {
InputGroup,
} from "react-bootstrap";
import { Icon } from "src/components/Shared";
import localForage from "localforage";

import { useConfiguration } from "src/core/StashService";

const DEFAULT_BLACKLIST = [
"\\sXXX\\s",
"1080p",
"720p",
"2160p",
"KTR",
"RARBG",
"\\scom\\s",
"\\[",
"\\]",
];

export const initialConfig: ITaggerConfig = {
blacklist: DEFAULT_BLACKLIST,
showMales: false,
mode: "auto",
setCoverImage: true,
setTags: false,
tagOperation: "merge",
fingerprintQueue: {},
};

export type ParseMode = "auto" | "filename" | "dir" | "path" | "metadata";
const ModeDesc = {
auto: "Uses metadata if present, or filename",
metadata: "Only uses metadata",
filename: "Only uses filename",
dir: "Only uses parent directory of video file",
path: "Uses entire file path",
};

export interface ITaggerConfig {
blacklist: string[];
showMales: boolean;
mode: ParseMode;
setCoverImage: boolean;
setTags: boolean;
tagOperation: string;
selectedEndpoint?: string;
fingerprintQueue: Record<string, string[]>;
}
import { ITaggerConfig, ParseMode, ModeDesc } from "./constants";

interface IConfigProps {
show: boolean;
Expand All @@ -62,26 +20,7 @@ interface IConfigProps {

const Config: React.FC<IConfigProps> = ({ show, config, setConfig }) => {
const stashConfig = useConfiguration();
const [blacklistInput, setBlacklistInput] = useState<string>("");

useEffect(() => {
localForage.getItem<ITaggerConfig>("tagger").then((data) => {
setConfig({
blacklist: data?.blacklist ?? DEFAULT_BLACKLIST,
showMales: data?.showMales ?? false,
mode: data?.mode ?? "auto",
setCoverImage: data?.setCoverImage ?? true,
setTags: data?.setTags ?? false,
tagOperation: data?.tagOperation ?? "merge",
selectedEndpoint: data?.selectedEndpoint,
fingerprintQueue: data?.fingerprintQueue ?? {},
});
});
}, [setConfig]);

useEffect(() => {
localForage.setItem("tagger", config);
}, [config]);
const blacklistRef = useRef<HTMLInputElement | null>(null);

const handleInstanceSelect = (e: React.ChangeEvent<HTMLSelectElement>) => {
const selectedEndpoint = e.currentTarget.value;
Expand All @@ -102,11 +41,14 @@ const Config: React.FC<IConfigProps> = ({ show, config, setConfig }) => {
};

const handleBlacklistAddition = () => {
if (!blacklistRef.current) return;

const input = blacklistRef.current.value;
setConfig({
...config,
blacklist: [...config.blacklist, blacklistInput],
blacklist: [...config.blacklist, input],
});
setBlacklistInput("");
blacklistRef.current.value = "";
};

const stashBoxes = stashConfig.data?.configuration.general.stashBoxes ?? [];
Expand Down Expand Up @@ -204,13 +146,7 @@ const Config: React.FC<IConfigProps> = ({ show, config, setConfig }) => {
<div className="col-md-6">
<h5>Blacklist</h5>
<InputGroup>
<Form.Control
className="text-input"
value={blacklistInput}
onChange={(e: React.ChangeEvent<HTMLInputElement>) =>
setBlacklistInput(e.currentTarget.value)
}
/>
<Form.Control className="text-input" ref={blacklistRef} />
<InputGroup.Append>
<Button onClick={handleBlacklistAddition}>Add</Button>
</InputGroup.Append>
Expand Down
19 changes: 12 additions & 7 deletions ui/v2.5/src/components/Tagger/StashSearchResult.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,18 @@ const StashSearchResult: React.FC<IStashSearchResultProps> = ({
const updatePerformerStashID = useUpdatePerformerStashID();
const updateStudioStashID = useUpdateStudioStashID();
const [updateScene] = GQL.useSceneUpdateMutation({
onError: (errors) => errors,
onError: (e) => {
const message =
e.message === "invalid JPEG format: short Huffman data"
? "Failed to save scene due to corrupted cover image"
: "Failed to save scene";
setError({
message,
details: e.message,
});
},
});

const { data: allTags } = GQL.useAllTagsForFilterQuery();

const setPerformer = (
Expand Down Expand Up @@ -302,12 +312,7 @@ const StashSearchResult: React.FC<IStashSearchResultProps> = ({
},
});

if (!sceneUpdateResult?.data?.sceneUpdate) {
setError({
message: "Failed to save scene",
details: sceneUpdateResult?.errors?.[0].message,
});
} else if (sceneUpdateResult.data?.sceneUpdate)
if (sceneUpdateResult?.data?.sceneUpdate)
setScene(sceneUpdateResult.data.sceneUpdate);

queueFingerprintSubmission(stashScene.id, endpoint);
Expand Down
108 changes: 93 additions & 15 deletions ui/v2.5/src/components/Tagger/Tagger.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Button, Card, Form, InputGroup } from "react-bootstrap";
import { Link } from "react-router-dom";
import { HashLink } from "react-router-hash-link";
import { ScenePreview } from "src/components/Scenes/SceneCard";
import { useLocalForage } from "src/hooks";

import * as GQL from "src/core/generated-graphql";
import { LoadingIndicator, TruncatedText } from "src/components/Shared";
Expand All @@ -14,15 +15,93 @@ import {
import { Manual } from "src/components/Help/Manual";

import StashSearchResult from "./StashSearchResult";
import Config, { ITaggerConfig, initialConfig, ParseMode } from "./Config";
import Config from "./Config";
import {
LOCAL_FORAGE_KEY,
ITaggerConfig,
ParseMode,
initialConfig,
} from "./constants";
import {
parsePath,
selectScenes,
IStashBoxScene,
sortScenesByDuration,
} from "./utils";

const dateRegex = /\.(\d\d)\.(\d\d)\.(\d\d)\./;
const months = [
"jan",
"feb",
"mar",
"apr",
"may",
"jun",
"jul",
"aug",
"sep",
"oct",
"nov",
"dec",
];

const ddmmyyRegex = /\.(\d\d)\.(\d\d)\.(\d\d)\./;
const yyyymmddRegex = /(\d{4})[-.](\d{2})[-.](\d{2})/;
const mmddyyRegex = /(\d{2})[-.](\d{2})[-.](\d{4})/;
const ddMMyyRegex = new RegExp(
`(\\d{1,2}).(${months.join("|")})\\.?.(\\d{4})`,
"i"
);
const MMddyyRegex = new RegExp(
`(${months.join("|")})\\.?.(\\d{1,2}),?.(\\d{4})`,
"i"
);
const parseDate = (input: string): string => {
let output = input;
const ddmmyy = output.match(ddmmyyRegex);
if (ddmmyy) {
output = output.replace(
ddmmyy[0],
` 20${ddmmyy[1]}-${ddmmyy[2]}-${ddmmyy[3]} `
);
}
const mmddyy = output.match(mmddyyRegex);
if (mmddyy) {
output = output.replace(
mmddyy[0],
` 20${mmddyy[1]}-${mmddyy[2]}-${mmddyy[3]} `
);
}
const ddMMyy = output.match(ddMMyyRegex);
if (ddMMyy) {
const month = (months.indexOf(ddMMyy[2].toLowerCase()) + 1)
.toString()
.padStart(2, "0");
output = output.replace(
ddMMyy[0],
` ${ddMMyy[3]}-${month}-${ddMMyy[1].padStart(2, "0")} `
);
}
const MMddyy = output.match(MMddyyRegex);
if (MMddyy) {
const month = (months.indexOf(MMddyy[1].toLowerCase()) + 1)
.toString()
.padStart(2, "0");
output = output.replace(
MMddyy[0],
` ${MMddyy[3]}-${month}-${MMddyy[2].padStart(2, "0")} `
);
}

const yyyymmdd = output.search(yyyymmddRegex);
if (yyyymmdd !== -1)
return (
output.slice(0, yyyymmdd).replace(/-/g, " ") +
output.slice(yyyymmdd, yyyymmdd + 10) +
output.slice(yyyymmdd + 10).replace(/-/g, " ")
);
return output.replace(/-/g, " ");
};

function prepareQueryString(
scene: Partial<GQL.SlimSceneDataFragment>,
paths: string[],
Expand All @@ -45,6 +124,7 @@ function prepareQueryString(
return str;
}
let s = "";

if (mode === "auto" || mode === "filename") {
s = filename;
} else if (mode === "path") {
Expand All @@ -55,11 +135,7 @@ function prepareQueryString(
blacklist.forEach((b) => {
s = s.replace(new RegExp(b, "i"), "");
});
const date = s.match(dateRegex);
s = s.replace(/-/g, " ");
if (date) {
s = s.replace(date[0], ` 20${date[1]}-${date[2]}-${date[3]} `);
}
s = parseDate(s);
return s.replace(/\./g, " ");
}

Expand Down Expand Up @@ -248,6 +324,9 @@ const TaggerList: React.FC<ITaggerListProps> = ({
} else if (!isTagged && !hasStashIDs) {
mainContent = (
<InputGroup>
<InputGroup.Prepend>
<InputGroup.Text>Query</InputGroup.Text>
</InputGroup.Prepend>
<Form.Control
className="text-input"
value={modifiedQuery || defaultQueryString}
Expand Down Expand Up @@ -417,12 +496,6 @@ const TaggerList: React.FC<ITaggerListProps> = ({
return (
<Card className="tagger-table">
<div className="tagger-table-header d-flex flex-nowrap align-items-center">
<div className="col-md-6 pl-0">
<b>Scene</b>
</div>
<div className="col-md-2">
<b>Query</b>
</div>
<b className="ml-auto mr-2 text-danger">{fingerprintError}</b>
<div className="mr-2">
{fingerprintQueue.length > 0 && (
Expand Down Expand Up @@ -460,10 +533,15 @@ interface ITaggerProps {

export const Tagger: React.FC<ITaggerProps> = ({ scenes }) => {
const stashConfig = useConfiguration();
const [config, setConfig] = useState<ITaggerConfig>(initialConfig);
const [{ data: config }, setConfig] = useLocalForage<ITaggerConfig>(
LOCAL_FORAGE_KEY,
initialConfig
);
const [showConfig, setShowConfig] = useState(false);
const [showManual, setShowManual] = useState(false);

if (!config) return <LoadingIndicator />;

const savedEndpointIndex =
stashConfig.data?.configuration.general.stashBoxes.findIndex(
(s) => s.endpoint === config.selectedEndpoint
Expand Down Expand Up @@ -503,7 +581,7 @@ export const Tagger: React.FC<ITaggerProps> = ({ scenes }) => {
onClose={() => setShowManual(false)}
defaultActiveTab="Tagger.md"
/>
<div className="tagger-container row mx-md-auto">
<div className="tagger-container mx-md-auto">
{selectedEndpointIndex !== -1 && selectedEndpoint ? (
<>
<div className="row mb-2 no-gutters">
Expand Down
Loading

0 comments on commit ca49011

Please sign in to comment.