Add tag auto-complete feature

next
neobooru 2021-06-26 16:27:55 +02:00
parent 4381b4ebbf
commit bd8780e2ba
5 changed files with 1022 additions and 871 deletions

View File

@ -1,6 +1,6 @@
{ {
"name": "szuru-chrome", "name": "szuru-chrome",
"version": "0.7.0", "version": "0.7.1",
"description": "Import media from various sites into szurubooru.", "description": "Import media from various sites into szurubooru.",
"author": "neobooru", "author": "neobooru",
"license": "MIT", "license": "MIT",

View File

@ -3,6 +3,7 @@
*/ */
export type Safety = "safe" | "sketchy" | "unsafe"; export type Safety = "safe" | "sketchy" | "unsafe";
export type TagFields = "names" | "category" | "usages" | "implications";
export type TagsResult = PagedSearchResult<Tag>; export type TagsResult = PagedSearchResult<Tag>;
export type TagCategoriesResult = UnpagedSearchResult<TagCategory>; export type TagCategoriesResult = UnpagedSearchResult<TagCategory>;

View File

@ -1,7 +1,7 @@
import axios, { AxiosRequestConfig } from "axios"; import axios, { AxiosRequestConfig, CancelToken } from "axios";
import { ScrapedPost } from "neo-scraper"; import { ScrapedPost } from "neo-scraper";
import { SzuruSiteConfig } from "./Config"; import { SzuruSiteConfig } from "./Config";
import { TagsResult, TagCategoriesResult, Post, Tag, SzuruError, ImageSearchResult } from "./SzuruTypes"; import { TagsResult, TagCategoriesResult, Post, Tag, SzuruError, ImageSearchResult, TagFields } from "./SzuruTypes";
/** /**
* A 1:1 wrapper around the szurubooru API. * A 1:1 wrapper around the szurubooru API.
@ -40,13 +40,21 @@ export default class SzuruWrapper {
return (await this.apiPut("tag/" + tag.names[0], tag)).data; return (await this.apiPut("tag/" + tag.names[0], tag)).data;
} }
async getTags(query: string, offset: number = 0): Promise<TagsResult> { async getTags(
query: string,
offset: number = 0,
limit: number = 100,
fields: TagFields[] | undefined = undefined,
cancelToken: CancelToken | undefined = undefined
): Promise<TagsResult> {
const params = new URLSearchParams(); const params = new URLSearchParams();
params.append("offset", offset.toString()); params.append("offset", offset.toString());
if (query) { params.append("limit", limit.toString());
params.append("query", query);
} if (fields && fields.length > 0) params.append("fields", fields.join());
return (await this.apiGet("tags?" + params.toString())).data; if (query) params.append("query", query);
return (await this.apiGet("tags?" + params.toString(), {}, cancelToken)).data;
} }
async getTagCategories(): Promise<TagCategoriesResult> { async getTagCategories(): Promise<TagCategoriesResult> {
@ -75,11 +83,16 @@ export default class SzuruWrapper {
return (await this.apiPost("posts/reverse-search", obj)).data; return (await this.apiPost("posts/reverse-search", obj)).data;
} }
private async apiGet(url: string, additionalHeaders: any = {}): Promise<any> { private async apiGet(
url: string,
additionalHeaders: any = {},
cancelToken: CancelToken | undefined = undefined
): Promise<any> {
const fullUrl = this.apiUrl + url; const fullUrl = this.apiUrl + url;
const config: AxiosRequestConfig = { const config: AxiosRequestConfig = {
method: "GET", method: "GET",
url: fullUrl url: fullUrl,
cancelToken
}; };
config.headers = { ...this.baseHeaders, ...additionalHeaders }; config.headers = { ...this.baseHeaders, ...additionalHeaders };

View File

@ -1,127 +1,132 @@
body { body {
margin: 0px; margin: 0px;
font-family: "Open Sans", sans-serif; font-family: "Open Sans", sans-serif;
display: block; display: block;
font-size: 100%; font-size: 100%;
} }
button { button {
background-color: #a2a2a2; background-color: #a2a2a2;
border: none; border: none;
color: white; color: white;
font-family: "Open Sans", sans-serif; font-family: "Open Sans", sans-serif;
height: 30px; height: 30px;
cursor: pointer; cursor: pointer;
padding: 0 10px; padding: 0 10px;
white-space: nowrap; white-space: nowrap;
} }
button.primary { button.primary {
background-color: #24aadd; background-color: #24aadd;
} }
input[type="text"] { input[type="text"] {
background-color: #fafafa; background-color: #fafafa;
border: 1px solid #eee; border: 1px solid #eee;
height: 26px; height: 26px;
width: 100%; width: 100%;
}
input[type="text"]:focus {
outline: #24aadd solid 2px;
box-sizing: content-box;
} }
img { img {
max-width: 100%; max-width: 100%;
max-height: 100%; max-height: 100%;
} }
.full { .full {
width: 100%; width: 100%;
} }
select { select {
background-color: #fafafa; background-color: #fafafa;
border: 1px solid #eee; border: 1px solid #eee;
height: 30px; height: 30px;
width: 100%; width: 100%;
} }
.compact-tags { .compact-tags {
list-style-type: none; list-style-type: none;
padding: 0; padding: 0;
display: inline; display: inline;
} }
.tag-general { .tag-general {
color: #24aadd; color: #24aadd;
} }
.tag-copyright { .tag-copyright {
color: rgb(170, 0, 170); color: rgb(170, 0, 170);
} }
.tag-character { .tag-character {
color: rgb(0, 170, 0); color: rgb(0, 170, 0);
} }
.tag-artist { .tag-artist {
color: rgb(170, 0, 0); color: rgb(170, 0, 0);
} }
.tag-meta { .tag-meta {
color: rgb(255, 128, 0); color: rgb(255, 128, 0);
} }
.tag-species { .tag-species {
color: rgb(17, 14, 247); color: rgb(17, 14, 247);
} }
.tag-lore { .tag-lore {
color: rgb(48, 48, 48); color: rgb(48, 48, 48);
} }
.remove-tag, .remove-tag,
.tag-usages { .tag-usages {
color: #888; color: #888;
} }
a.remove-tag { a.remove-tag {
text-decoration: none; text-decoration: none;
cursor: pointer; cursor: pointer;
} }
.tag-usages { .tag-usages {
font-size: 90%; font-size: 90%;
margin-left: 0.7em; margin-left: 0.7em;
} }
.messages { .messages {
list-style-type: none; list-style-type: none;
padding: 0; padding: 0;
display: inline; display: inline;
} }
.messages > li { .messages > li {
padding: 5px; padding: 5px;
border-radius: 2px; border-radius: 2px;
background: #24aadd; background: #24aadd;
color: white; color: white;
} }
.messages > li > a { .messages > li > a {
color: white; color: white;
text-decoration: none; text-decoration: none;
} }
.messages > li:first-child { .messages > li:first-child {
margin-top: 10px; margin-top: 10px;
} }
.messages > li:not(:last-child) { .messages > li:not(:last-child) {
margin-bottom: 5px; margin-bottom: 5px;
} }
.message-error { .message-error {
background: #f44336 !important; background: #f44336 !important;
} }
.message-success { .message-success {
background: #4caf50 !important; background: #4caf50 !important;
} }

View File

@ -46,9 +46,30 @@
<span>Tags</span> <span>Tags</span>
</div> </div>
<div class="section-row" style="display: flex"> <div class="section-row" style="display: flex; flex-direction: column">
<input type="text" v-model="addTagInput" v-on:keyup.enter="addTag" /> <div style="display: flex">
<button class="primary" style="margin-left: 5px; height: auto" @click="addTag">Add</button> <input
type="text"
v-model="addTagInput"
@keyup="onAddTagKeyUp"
@keydown="onAddTagKeyDown"
autocomplete="off"
/>
<button class="primary" style="margin-left: 5px" @click="addTag">Add</button>
</div>
<div class="autocomplete-items" v-bind:class="{ show: autocompleteShown }">
<div
v-for="(tag, idx) in autocompleteTags"
:key="tag.name"
:class="{
active: idx == autocompleteIndex,
}"
>
<span :class="getTagClasses(tag)">{{ tag.name }}</span>
<span class="tag-usages">{{ tag.usages ? tag.usages : "" }}</span>
</div>
</div>
</div> </div>
<div class="section-row"> <div class="section-row">
@ -98,19 +119,32 @@ import Vue from "vue";
import { browser, Runtime, WebRequest } from "webextension-polyfill-ts"; import { browser, Runtime, WebRequest } from "webextension-polyfill-ts";
import { ContentType, ScrapedPost, ScrapedTag, ScrapeResults, BooruTypes } from "neo-scraper"; import { ContentType, ScrapedPost, ScrapedTag, ScrapeResults, BooruTypes } from "neo-scraper";
import SzuruWrapper from "../SzuruWrapper"; import SzuruWrapper from "../SzuruWrapper";
import { Post } from "../SzuruTypes"; import { MicroTag, Post, Tag } from "../SzuruTypes";
import { Config, SzuruSiteConfig } from "../Config"; import { Config, SzuruSiteConfig } from "../Config";
import { BrowserCommand, Message, getUrl, isChrome, encodeTagName } from "../Common"; import { BrowserCommand, Message, getUrl, isChrome, encodeTagName } from "../Common";
import axios, { CancelTokenSource } from "axios";
class TagViewModel { class TagViewModel {
name: string; public implications: TagViewModel[] = [];
category?: BooruTypes.TagCategory;
usages: number | undefined;
constructor(tag: ScrapedTag) { constructor(public name: string, public category?: BooruTypes.TagCategory, public usages?: number | undefined) {}
this.name = tag.name;
this.category = tag.category; static fromTag(tag: Tag) {
this.usages = 0; let x = new TagViewModel(tag.names[0], <BooruTypes.TagCategory>tag.category, tag.usages);
if (tag.implications) {
x.implications = tag.implications.map((x) => TagViewModel.fromMicroTag(x));
}
return x;
}
static fromMicroTag(tag: MicroTag) {
return new TagViewModel(tag.names[0], <BooruTypes.TagCategory>tag.category, tag.usages);
}
static fromScapedTag(tag: ScrapedTag): TagViewModel {
return new TagViewModel(tag.name, tag.category);
} }
} }
@ -131,7 +165,7 @@ class PostViewModel {
this.rating = post.rating; this.rating = post.rating;
this.source = post.source; this.source = post.source;
this.referrer = post.referrer; this.referrer = post.referrer;
this.tags = post.tags.map((x) => new TagViewModel(x)); this.tags = post.tags.map((x) => TagViewModel.fromScapedTag(x));
} }
} }
@ -142,9 +176,13 @@ export default Vue.extend({
activeSite: null as SzuruSiteConfig | null, activeSite: null as SzuruSiteConfig | null,
szuru: null as SzuruWrapper | null, szuru: null as SzuruWrapper | null,
posts: [] as PostViewModel[], posts: [] as PostViewModel[],
selectedPost: new ScrapedPost(), // Shouldn't be null because VueJS gets a mental breakdown when it sees a null. selectedPost: new PostViewModel(new ScrapedPost()), // Shouldn't be null because VueJS gets a mental breakdown when it sees a null.
messages: [] as Message[], messages: [] as Message[],
addTagInput: "", addTagInput: "",
autocompleteShown: false,
autocompleteTags: [] as TagViewModel[],
cancelSource: null as CancelTokenSource | null,
autocompleteIndex: -1,
}; };
}, },
watch: { watch: {
@ -215,10 +253,10 @@ export default Vue.extend({
const url = browser.extension.getURL("options/options.html"); const url = browser.extension.getURL("options/options.html");
window.open(url); window.open(url);
}, },
getTagClasses(tag: ScrapedTag): string[] { getTagClasses(tag: TagViewModel): string[] {
let classes: string[] = []; let classes: string[] = [];
if (tag.category) { if (tag.category && <any>tag.category != "default") {
classes.push("tag-" + tag.category); classes.push("tag-" + tag.category);
} else { } else {
classes.push("tag-general"); classes.push("tag-general");
@ -227,7 +265,7 @@ export default Vue.extend({
return classes; return classes;
}, },
// Remove tag from post's taglist // Remove tag from post's taglist
removeTag(tag: ScrapedTag) { removeTag(tag: TagViewModel) {
if (this.selectedPost) { if (this.selectedPost) {
const idx = this.selectedPost.tags.indexOf(tag); const idx = this.selectedPost.tags.indexOf(tag);
if (idx != -1) { if (idx != -1) {
@ -281,12 +319,11 @@ export default Vue.extend({
return getUrl(this.activeSite.domain, "post", post.id.toString()); return getUrl(this.activeSite.domain, "post", post.id.toString());
}, },
// Add tag to the post's taglist // Add tag to the post's taglist
addTag() { addTag(tag: TagViewModel) {
if (this.selectedPost) { if (this.selectedPost) {
const tagName = this.addTagInput; // Only add tag if it doesn't already exist
this.addTagInput = ""; if (tag.name.length > 0 && this.selectedPost.tags.find((x) => x.name == tag.name) == undefined) {
if (tagName.length > 0 && this.selectedPost.tags.find((x) => x.name == tagName) == undefined) { this.selectedPost.tags.push(tag);
this.selectedPost.tags.push(new ScrapedTag(tagName));
} }
} }
}, },
@ -342,6 +379,7 @@ export default Vue.extend({
.join(); .join();
const resp = await this.szuru?.getTags(query); const resp = await this.szuru?.getTags(query);
// Not the best code, but it works I guess?
if (resp) { if (resp) {
for (let post of this.posts) for (let post of this.posts)
for (let tag of resp.results) for (let tag of resp.results)
@ -353,6 +391,66 @@ export default Vue.extend({
} }
} }
}, },
async onAddTagKeyUp(e: KeyboardEvent) {
await this.autoCompletePopulator((<HTMLInputElement>e.target).value);
},
onAddTagKeyDown(e: KeyboardEvent) {
if (e.code == "ArrowDown") {
e.preventDefault();
if (this.autocompleteIndex < this.autocompleteTags.length - 1) {
this.autocompleteIndex++;
}
} else if (e.code == "ArrowUp") {
e.preventDefault();
if (this.autocompleteIndex >= 0) {
this.autocompleteIndex--;
}
} else if (e.code == "Enter") {
if (this.autocompleteIndex == -1) {
this.addTag(new TagViewModel(this.addTagInput));
this.addTagInput = ""; // Reset input
// TODO: Do we also want to add the implications?
} else {
// Add auto completed tag
const tagToAdd = this.autocompleteTags[this.autocompleteIndex];
this.addTag(tagToAdd);
this.addTagInput = ""; // Reset input
// Add implications for the tag
tagToAdd.implications.forEach(this.addTag);
}
}
},
async autoCompletePopulator(input: string) {
// Based on https://www.w3schools.com/howto/howto_js_autocomplete.asp
// TODO: Put this in a separate component
// Hide autocomplete when the input is empty, and don't do anything else.
if (input.length == 0) {
this.autocompleteIndex = -1;
this.autocompleteShown = false;
return;
}
// Cancel previous request
if (this.cancelSource) {
this.cancelSource.cancel();
}
this.cancelSource = axios.CancelToken.source();
const query = decodeURIComponent(`*${encodeTagName(input)}* sort:usages`);
const resp = await this.szuru?.getTags(
query,
0,
100,
["names", "category", "usages", "implications"],
this.cancelSource.token
);
this.autocompleteTags = resp!.results.map((x) => TagViewModel.fromTag(x));
if (this.autocompleteTags.length > 0) this.autocompleteShown = true;
},
}, },
async mounted() { async mounted() {
this.config = await Config.load(); this.config = await Config.load();
@ -405,7 +503,7 @@ export default Vue.extend({
); );
// Always call grabPost, even when there is no activeSite // Always call grabPost, even when there is no activeSite
this.grabPost(); await this.grabPost();
}, },
}); });
</script> </script>
@ -461,4 +559,38 @@ video {
display: block; display: block;
margin: 0 0 5px 0; margin: 0 0 5px 0;
} }
.autocomplete-items {
position: absolute;
z-index: 10;
background-color: white;
border: 2px solid #24aadd;
margin-top: 34px;
display: none;
}
.autocomplete-items.show {
display: block;
}
.autocomplete-items > div {
cursor: pointer;
padding: 2px 4px;
}
.autocomplete-items > div:hover {
background: #24aadd;
}
.autocomplete-items > div:hover > span {
color: #fff;
}
.autocomplete-items > div.active {
background: #24aadd;
}
.autocomplete-items > div.active > span {
color: #fff;
}
</style> </style>