From e5467c548703fbb4e619326e8b2a26cbb8fc0304 Mon Sep 17 00:00:00 2001 From: neobooru <50623835+neobooru@users.noreply.github.com> Date: Thu, 8 Aug 2019 23:20:44 +0200 Subject: [PATCH] Cleanup + some setup required for the "change tag category" feature --- README.md | 1 - src/LocalTypes.ts | 31 +++++++++++++++++ src/SzuruTypes.ts | 75 ++++++++++++++++++++++------------------- src/SzuruWrapper.ts | 19 ++++++++--- src/loaders/Danbooru.ts | 18 +++++----- src/loaders/Gelbooru.ts | 18 +++++----- src/loaders/ILoader.ts | 4 +-- src/loaders/Moebooru.ts | 18 +++++----- src/loaders/Reddit.ts | 6 ++-- src/loaders/Shimmie2.ts | 8 ++--- src/loaders/Twitter.ts | 6 ++-- src/popup/App.vue | 14 ++++---- src/scripts/content.ts | 4 +-- 13 files changed, 134 insertions(+), 88 deletions(-) create mode 100644 src/LocalTypes.ts diff --git a/README.md b/README.md index f681846..9954be8 100644 --- a/README.md +++ b/README.md @@ -56,7 +56,6 @@ Firefox: `about:debugging` -> "Load Temporary Add-on..." -> Select any file in t - Auto-set tag category when creating a new tag (imported tag) - Reverse image search to check whether (similar) file already exist before uploading it - Right click any image on a page to import it -- Support more sites - Configurable list of tags to always ignore (e.g. tagme, highres) - [low priority] Import artist commentary - [low priority] Import notes diff --git a/src/LocalTypes.ts b/src/LocalTypes.ts new file mode 100644 index 0000000..8469a91 --- /dev/null +++ b/src/LocalTypes.ts @@ -0,0 +1,31 @@ +/** + * These types are NOT compatible with szurubooru, they are only used in the WebExtension. + */ + +import { Safety } from "./SzuruTypes"; + +export type LocalCategory = "copyright" | "character" | "artist" | "meta"; + +export class LocalTag { + name: string = ""; + category?: string; + + constructor(name: string, category?: string) { + this.name = name.replace(/\s/g, "_"); // Replace all spaces with underscores + this.category = category; + } +} + +// FIXME: LocalPost -> valid szurubooru type +export class LocalPost { + safety: Safety = "safe"; + source: string = ""; + imageUrl: string = ""; + tags: LocalTag[] = []; +} + +export interface LocalError { + name: string; + title: string; + description: string; +} diff --git a/src/SzuruTypes.ts b/src/SzuruTypes.ts index 31e25fe..740e935 100644 --- a/src/SzuruTypes.ts +++ b/src/SzuruTypes.ts @@ -1,39 +1,46 @@ -export type SzuruSafety = "safe" | "sketchy" | "unsafe"; +/** + * Generated based on my setup, so some fields might be missing (but they also are unused so far so it doesn't really matter). + */ -export class SzuruCategory { +export type Safety = "safe" | "sketchy" | "unsafe"; + +export interface PagedSearchResult { + query: string; + offset: number; + limit: number; + total: number; + results: T[]; +} + +export interface UnpagedSearchResult { + results: T[]; +} + +export interface MicroTag { + names: string[]; + category: string; + usages: number; +} + +export interface Tag { + names: string[]; + category: string; + version: number; + description?: any; + creationTime: Date; + lastEditTime?: Date; + usages: number; + suggestions: MicroTag[]; + implications: MicroTag[]; +} + +export interface TagCategory { name: string; + version: number; color: string; - - private constructor(name: string, color: string = "") { - this.name = name; - this.color = color; - } - - static readonly Copyright = new SzuruCategory("copyright", "#a0a"); - static readonly Character = new SzuruCategory("character", "#0a0"); - static readonly Artist = new SzuruCategory("artist", "#a00"); - static readonly Meta = new SzuruCategory("meta", "#f80"); + usages: number; + default: boolean; } -export class SzuruTag { - name: string = ""; - category?: SzuruCategory; - - constructor(name: string, category?: SzuruCategory) { - this.name = name.replace(/\s/g, "_"); // Replace all spaces with underscores - this.category = category; - } -} - -export class SzuruPost { - safety: SzuruSafety = "safe"; - source: string = ""; - imageUrl: string = ""; - tags: SzuruTag[] = []; -} - -export interface SzuruError { - name: string; - title: string; - description: string; -} +export type TagsResult = PagedSearchResult +export type TagCategoriesResult = UnpagedSearchResult diff --git a/src/SzuruWrapper.ts b/src/SzuruWrapper.ts index 041a754..06a03f7 100644 --- a/src/SzuruWrapper.ts +++ b/src/SzuruWrapper.ts @@ -1,6 +1,7 @@ -import axios, { AxiosRequestConfig, AxiosPromise, Method } from 'axios'; -import { SzuruPost, SzuruError } from './SzuruTypes'; +import axios, { AxiosRequestConfig } from 'axios'; +import { LocalPost, LocalError } from './LocalTypes'; import { Config } from './Config'; +import { TagsResult, TagCategoriesResult } from './SzuruTypes'; /** * A 1:1 wrapper around the szurubooru API. @@ -32,10 +33,18 @@ export default class SzuruWrapper { } async getInfo(): Promise { - return await this.apiGet("info"); + return (await this.apiGet("info")).data; } - async createPost(post: SzuruPost): Promise { + async getTags(): Promise { + return (await this.apiGet("tags")).data; + } + + async getTagCategories(): Promise { + return (await this.apiGet("tag-categories")).data; + } + + async createPost(post: LocalPost): Promise { var obj = { tags: post.tags.map(x => x.name), safety: post.safety, @@ -82,7 +91,7 @@ export default class SzuruWrapper { try { return await axios(config); } catch (ex) { - const error = ex.response.data as SzuruError; + const error = ex.response.data as LocalError; throw error ? error : ex; } } diff --git a/src/loaders/Danbooru.ts b/src/loaders/Danbooru.ts index cb67836..6d9840c 100644 --- a/src/loaders/Danbooru.ts +++ b/src/loaders/Danbooru.ts @@ -1,5 +1,5 @@ import ILoader from "./ILoader" -import { SzuruPost, SzuruTag, SzuruCategory } from "../SzuruTypes"; +import { LocalPost, LocalTag, LocalCategory } from "../LocalTypes"; export default class Danbooru implements ILoader { canImport(location: Location): boolean { @@ -9,8 +9,8 @@ export default class Danbooru implements ILoader { ); } - async grabPost(dom: Document): Promise { - let post = new SzuruPost(); + async grabPost(dom: Document): Promise { + let post = new LocalPost(); post.source = dom.location.href; // Set image url @@ -54,24 +54,24 @@ export default class Danbooru implements ILoader { tagName = tagNameElement.innerText; } - let category: SzuruCategory | undefined; + let category: LocalCategory | undefined; switch (tagElement.className) { case "category-3": - category = SzuruCategory.Copyright; + category = "copyright"; break; case "category-4": - category = SzuruCategory.Character; + category = "character"; break; case "category-1": - category = SzuruCategory.Artist; + category = "artist"; break; case "category-5": - category = SzuruCategory.Meta; + category = "meta"; break; } if (tagName) { - let tag = new SzuruTag(tagName, category); + let tag = new LocalTag(tagName, category); post.tags.push(tag); } } diff --git a/src/loaders/Gelbooru.ts b/src/loaders/Gelbooru.ts index 8198ab2..906cd0d 100644 --- a/src/loaders/Gelbooru.ts +++ b/src/loaders/Gelbooru.ts @@ -1,5 +1,5 @@ import ILoader from "./ILoader" -import { SzuruPost, SzuruTag, SzuruCategory } from "../SzuruTypes"; +import { LocalPost, LocalTag, LocalCategory } from "../LocalTypes"; // Small hack to avoid screwing with semver enum Version { @@ -16,7 +16,7 @@ export default class Gelbooru implements ILoader { ); } - async grabPost(dom: Document): Promise { + async grabPost(dom: Document): Promise { /** * Make sure to use the `dom` variable and NOT `document`! */ @@ -37,7 +37,7 @@ export default class Gelbooru implements ILoader { console.log("Gelbooru guessed version: " + version); - let post = new SzuruPost(); + let post = new LocalPost(); post.source = dom.location.href; // Set image url (direct url to image) @@ -115,24 +115,24 @@ export default class Gelbooru implements ILoader { tagName = el.getElementsByTagName("a")[1].innerText; } - let category: SzuruCategory | undefined; + let category: LocalCategory | undefined; switch (el.className) { case "tag-type-copyright": - category = SzuruCategory.Copyright; + category = "copyright"; break; case "tag-type-character": - category = SzuruCategory.Character; + category = "character"; break; case "tag-type-artist": - category = SzuruCategory.Artist; + category = "artist"; break; case "tag-type-metadata": - category = SzuruCategory.Meta; + category = "meta"; break; } - let tag = new SzuruTag(tagName, category); + let tag = new LocalTag(tagName, category); post.tags.push(tag); } } diff --git a/src/loaders/ILoader.ts b/src/loaders/ILoader.ts index d9b4af6..1e62f4e 100644 --- a/src/loaders/ILoader.ts +++ b/src/loaders/ILoader.ts @@ -1,6 +1,6 @@ -import { SzuruPost } from "../SzuruTypes"; +import { LocalPost } from "../LocalTypes"; export default interface ILoader { canImport(location: Location): boolean; - grabPost(dom: Document): Promise; + grabPost(dom: Document): Promise; } diff --git a/src/loaders/Moebooru.ts b/src/loaders/Moebooru.ts index 25d8ff2..e0a810b 100644 --- a/src/loaders/Moebooru.ts +++ b/src/loaders/Moebooru.ts @@ -1,5 +1,5 @@ import ILoader from "./ILoader" -import { SzuruPost, SzuruTag, SzuruCategory } from "../SzuruTypes"; +import { LocalPost, LocalTag, LocalCategory } from "../LocalTypes"; export default class Moebooru implements ILoader { canImport(location: Location): boolean { @@ -9,8 +9,8 @@ export default class Moebooru implements ILoader { ); } - async grabPost(dom: Document): Promise { - let post = new SzuruPost(); + async grabPost(dom: Document): Promise { + let post = new LocalPost(); post.source = dom.location.href; // Set image url @@ -60,28 +60,28 @@ export default class Moebooru implements ILoader { continue; } - let category: SzuruCategory | undefined; + let category: LocalCategory | undefined; // Loop over all classes because some sites (konachan) // have mutliple classes, e.g. "tag-link tag-type-copyright" for (const className of Array.from(el.classList)) { switch (className) { case "tag-type-copyright": - category = SzuruCategory.Copyright; + category = "copyright"; break; case "tag-type-character": - category = SzuruCategory.Character; + category = "character"; break; case "tag-type-artist": - category = SzuruCategory.Artist; + category = "artist"; break; case "tag-type-metadata": - category = SzuruCategory.Meta; + category = "meta"; break; } } - let tag = new SzuruTag(tagName, category); + let tag = new LocalTag(tagName, category); post.tags.push(tag); } diff --git a/src/loaders/Reddit.ts b/src/loaders/Reddit.ts index 063f48c..b1e45e7 100644 --- a/src/loaders/Reddit.ts +++ b/src/loaders/Reddit.ts @@ -1,5 +1,5 @@ import ILoader from "./ILoader" -import { SzuruPost, SzuruTag } from "../SzuruTypes"; +import { LocalPost, LocalTag } from "../LocalTypes"; export default class Reddit implements ILoader { canImport(location: Location): boolean { @@ -10,8 +10,8 @@ export default class Reddit implements ILoader { ); } - async grabPost(dom: Document): Promise { - let post = new SzuruPost(); + async grabPost(dom: Document): Promise { + let post = new LocalPost(); post.source = dom.location.href; // Set image url diff --git a/src/loaders/Shimmie2.ts b/src/loaders/Shimmie2.ts index bfcf088..590c19f 100644 --- a/src/loaders/Shimmie2.ts +++ b/src/loaders/Shimmie2.ts @@ -1,13 +1,13 @@ import ILoader from "./ILoader" -import { SzuruPost, SzuruTag } from "../SzuruTypes"; +import { LocalPost, LocalTag } from "../LocalTypes"; export default class Shimmie2 implements ILoader { canImport(location: Location): boolean { return location.host == "rule34.paheal.net"; } - async grabPost(dom: Document): Promise { - let post = new SzuruPost(); + async grabPost(dom: Document): Promise { + let post = new LocalPost(); post.source = dom.location.href; // Set image url @@ -29,7 +29,7 @@ export default class Shimmie2 implements ILoader { // For example by deleting 'wrong' tags or setting up some aliases in szurubooru. post.tags = Array.from(dom.querySelectorAll("a.tag_name")) .map(x => (x as HTMLAnchorElement).innerText.toLowerCase()) - .map(x => new SzuruTag(x)); + .map(x => new LocalTag(x)); // console.dir(post); diff --git a/src/loaders/Twitter.ts b/src/loaders/Twitter.ts index e930219..d252f34 100644 --- a/src/loaders/Twitter.ts +++ b/src/loaders/Twitter.ts @@ -1,5 +1,5 @@ import ILoader from "./ILoader" -import { SzuruPost, SzuruTag } from "../SzuruTypes"; +import { LocalPost, LocalTag } from "../LocalTypes"; function getOriginalImage(imageUrl: string) { const x = imageUrl.replace(/:large|:med|:small|:orig$/, ""); // Remove `:large`, `:small` etc from url @@ -11,8 +11,8 @@ export default class Twitter implements ILoader { return location.host == "twitter.com"; } - async grabPost(dom: Document): Promise { - let post = new SzuruPost(); + async grabPost(dom: Document): Promise { + let post = new LocalPost(); post.source = dom.location.href; // Set image url diff --git a/src/popup/App.vue b/src/popup/App.vue index c2ad165..ab16089 100644 --- a/src/popup/App.vue +++ b/src/popup/App.vue @@ -88,7 +88,7 @@