initial commit

This commit is contained in:
2026-02-09 19:04:19 -08:00
commit f92b57c7b6
531 changed files with 196294 additions and 0 deletions

View File

@@ -0,0 +1,498 @@
/*
* Copyright (C) 2023-2025 Yomitan Authors
* Copyright (C) 2020-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {getFrequencyHarmonic} from '../data/anki-note-data-creator.js';
/**
* @param {import('dictionary').TermDictionaryEntry} dictionaryEntry
* @returns {import('dictionary-data-util').TagGroup[]}
*/
export function groupTermTags(dictionaryEntry) {
const {headwords} = dictionaryEntry;
const headwordCount = headwords.length;
const uniqueCheck = (headwordCount > 1);
/** @type {Map<string, number>} */
const resultsIndexMap = new Map();
const results = [];
for (let i = 0; i < headwordCount; ++i) {
const {tags} = headwords[i];
for (const tag of tags) {
if (uniqueCheck) {
const {name, category, content, dictionaries} = tag;
const key = createMapKey([name, category, content, dictionaries]);
const index = resultsIndexMap.get(key);
if (typeof index !== 'undefined') {
const existingItem = results[index];
existingItem.headwordIndices.push(i);
continue;
}
resultsIndexMap.set(key, results.length);
}
const item = {tag, headwordIndices: [i]};
results.push(item);
}
}
return results;
}
/**
* @param {import('dictionary').TermDictionaryEntry} dictionaryEntry
* @param {import('dictionary-importer').Summary[]} dictionaryInfo
* @returns {import('dictionary-data-util').DictionaryFrequency<import('dictionary-data-util').TermFrequency>[]}
*/
export function groupTermFrequencies(dictionaryEntry, dictionaryInfo) {
const {headwords, frequencies: sourceFrequencies} = dictionaryEntry;
/** @type {import('dictionary-data-util').TermFrequenciesMap1} */
const map1 = new Map();
/** @type {Map<string, string>} */
const aliasMap = new Map();
for (const {headwordIndex, dictionary, dictionaryAlias, hasReading, frequency, displayValue} of sourceFrequencies) {
const {term, reading} = headwords[headwordIndex];
let map2 = map1.get(dictionary);
if (typeof map2 === 'undefined') {
map2 = new Map();
map1.set(dictionary, map2);
aliasMap.set(dictionary, dictionaryAlias);
}
const readingKey = hasReading ? reading : null;
const key = createMapKey([term, readingKey]);
let frequencyData = map2.get(key);
if (typeof frequencyData === 'undefined') {
frequencyData = {term, reading: readingKey, values: new Map()};
map2.set(key, frequencyData);
}
frequencyData.values.set(createMapKey([frequency, displayValue]), {frequency, displayValue});
}
const results = [];
for (const [dictionary, map2] of map1.entries()) {
/** @type {import('dictionary-data-util').TermFrequency[]} */
const frequencies = [];
const dictionaryAlias = aliasMap.get(dictionary) ?? dictionary;
for (const {term, reading, values} of map2.values()) {
const termFrequency = {
term,
reading,
values: [...values.values()],
};
frequencies.push(termFrequency);
}
const currentDictionaryInfo = dictionaryInfo.find(({title}) => title === dictionary);
const freqCount = currentDictionaryInfo?.counts?.termMeta.freq ?? 0;
results.push({dictionary, frequencies, dictionaryAlias, freqCount});
}
const averageFrequencies = [];
for (let i = 0; i < dictionaryEntry.headwords.length; i++) {
const averageFrequency = getFrequencyHarmonic(dictionaryEntry, i);
averageFrequencies.push({
term: dictionaryEntry.headwords[i].term,
reading: dictionaryEntry.headwords[i].reading,
values: [{
frequency: averageFrequency,
displayValue: averageFrequency.toString(),
}],
});
}
results.push({
dictionary: 'Average',
frequencies: averageFrequencies,
dictionaryAlias: 'Average',
freqCount: averageFrequencies.length,
});
return results;
}
/**
* @param {import('dictionary').KanjiFrequency[]} sourceFrequencies
* @param {import('dictionary-importer').Summary[]} dictionaryInfo
* @returns {import('dictionary-data-util').DictionaryFrequency<import('dictionary-data-util').KanjiFrequency>[]}
*/
export function groupKanjiFrequencies(sourceFrequencies, dictionaryInfo) {
/** @type {import('dictionary-data-util').KanjiFrequenciesMap1} */
const map1 = new Map();
/** @type {Map<string, string>} */
const aliasMap = new Map();
for (const {dictionary, dictionaryAlias, character, frequency, displayValue} of sourceFrequencies) {
let map2 = map1.get(dictionary);
if (typeof map2 === 'undefined') {
map2 = new Map();
map1.set(dictionary, map2);
aliasMap.set(dictionary, dictionaryAlias);
}
let frequencyData = map2.get(character);
if (typeof frequencyData === 'undefined') {
frequencyData = {character, values: new Map()};
map2.set(character, frequencyData);
}
frequencyData.values.set(createMapKey([frequency, displayValue]), {frequency, displayValue});
}
const results = [];
for (const [dictionary, map2] of map1.entries()) {
const frequencies = [];
const dictionaryAlias = aliasMap.get(dictionary) ?? dictionary;
for (const {character, values} of map2.values()) {
frequencies.push({
character,
values: [...values.values()],
});
}
const currentDictionaryInfo = dictionaryInfo.find(({title}) => title === dictionary);
const freqCount = currentDictionaryInfo?.counts?.kanjiMeta.freq ?? 0;
results.push({dictionary, frequencies, dictionaryAlias, freqCount});
}
return results;
}
/**
* @param {import('dictionary').TermDictionaryEntry} dictionaryEntry
* @returns {import('dictionary-data-util').DictionaryGroupedPronunciations[]}
*/
export function getGroupedPronunciations(dictionaryEntry) {
const {headwords, pronunciations: termPronunciations} = dictionaryEntry;
/** @type {Set<string>} */
const allTerms = new Set();
const allReadings = new Set();
/** @type {Map<string, string>} */
const aliasMap = new Map();
for (const {term, reading} of headwords) {
allTerms.add(term);
allReadings.add(reading);
}
/** @type {Map<string, import('dictionary-data-util').GroupedPronunciationInternal[]>} */
const groupedPronunciationsMap = new Map();
for (const {headwordIndex, dictionary, dictionaryAlias, pronunciations} of termPronunciations) {
const {term, reading} = headwords[headwordIndex];
let dictionaryGroupedPronunciationList = groupedPronunciationsMap.get(dictionary);
if (typeof dictionaryGroupedPronunciationList === 'undefined') {
dictionaryGroupedPronunciationList = [];
groupedPronunciationsMap.set(dictionary, dictionaryGroupedPronunciationList);
aliasMap.set(dictionary, dictionaryAlias);
}
for (const pronunciation of pronunciations) {
let groupedPronunciation = findExistingGroupedPronunciation(reading, pronunciation, dictionaryGroupedPronunciationList);
if (groupedPronunciation === null) {
groupedPronunciation = {
pronunciation,
terms: new Set(),
reading,
};
dictionaryGroupedPronunciationList.push(groupedPronunciation);
}
groupedPronunciation.terms.add(term);
}
}
/** @type {import('dictionary-data-util').DictionaryGroupedPronunciations[]} */
const results2 = [];
const multipleReadings = (allReadings.size > 1);
for (const [dictionary, dictionaryGroupedPronunciationList] of groupedPronunciationsMap.entries()) {
/** @type {import('dictionary-data-util').GroupedPronunciation[]} */
const pronunciations2 = [];
const dictionaryAlias = aliasMap.get(dictionary) ?? dictionary;
for (const groupedPronunciation of dictionaryGroupedPronunciationList) {
const {pronunciation, terms, reading} = groupedPronunciation;
const exclusiveTerms = !areSetsEqual(terms, allTerms) ? getSetIntersection(terms, allTerms) : [];
const exclusiveReadings = [];
if (multipleReadings) {
exclusiveReadings.push(reading);
}
pronunciations2.push({
pronunciation,
terms: [...terms],
reading,
exclusiveTerms,
exclusiveReadings,
});
}
results2.push({dictionary, dictionaryAlias, pronunciations: pronunciations2});
}
return results2;
}
/**
* @template {import('dictionary').PronunciationType} T
* @param {import('dictionary').Pronunciation[]} pronunciations
* @param {T} type
* @returns {import('dictionary').PronunciationGeneric<T>[]}
*/
export function getPronunciationsOfType(pronunciations, type) {
/** @type {import('dictionary').PronunciationGeneric<T>[]} */
const results = [];
for (const pronunciation of pronunciations) {
if (pronunciation.type !== type) { continue; }
// This is type safe, but for some reason the cast is needed.
results.push(/** @type {import('dictionary').PronunciationGeneric<T>} */ (pronunciation));
}
return results;
}
/**
* @param {import('dictionary').Tag[]|import('anki-templates').Tag[]} termTags
* @returns {import('dictionary-data-util').TermFrequencyType}
*/
export function getTermFrequency(termTags) {
let totalScore = 0;
for (const {score} of termTags) {
totalScore += score;
}
if (totalScore > 0) {
return 'popular';
} else if (totalScore < 0) {
return 'rare';
} else {
return 'normal';
}
}
/**
* @param {import('dictionary').TermHeadword[]} headwords
* @param {number[]} headwordIndices
* @param {Set<string>} allTermsSet
* @param {Set<string>} allReadingsSet
* @returns {string[]}
*/
export function getDisambiguations(headwords, headwordIndices, allTermsSet, allReadingsSet) {
if (allTermsSet.size <= 1 && allReadingsSet.size <= 1) { return []; }
/** @type {Set<string>} */
const terms = new Set();
/** @type {Set<string>} */
const readings = new Set();
for (const headwordIndex of headwordIndices) {
const {term, reading} = headwords[headwordIndex];
terms.add(term);
readings.add(reading);
}
/** @type {string[]} */
const disambiguations = [];
const addTerms = !areSetsEqual(terms, allTermsSet);
const addReadings = !areSetsEqual(readings, allReadingsSet);
if (addTerms) {
disambiguations.push(...getSetIntersection(terms, allTermsSet));
}
if (addReadings) {
if (addTerms) {
for (const term of terms) {
readings.delete(term);
}
}
disambiguations.push(...getSetIntersection(readings, allReadingsSet));
}
return disambiguations;
}
/**
* @param {string[]} wordClasses
* @returns {boolean}
*/
export function isNonNounVerbOrAdjective(wordClasses) {
let isVerbOrAdjective = false;
let isSuruVerb = false;
let isNoun = false;
for (const wordClass of wordClasses) {
switch (wordClass) {
case 'v1':
case 'v5':
case 'vk':
case 'vz':
case 'adj-i':
isVerbOrAdjective = true;
break;
case 'vs':
isVerbOrAdjective = true;
isSuruVerb = true;
break;
case 'n':
isNoun = true;
break;
}
}
return isVerbOrAdjective && !(isSuruVerb && isNoun);
}
/**
* @param {string} current
* @param {string} latest
* @returns {boolean}
*/
export function compareRevisions(current, latest) {
const simpleVersionTest = /^(\d+\.)*\d+$/; // dot-separated integers, so 4.7 or 24.1.1.1 are ok, 1.0.0-alpha is not
if (!simpleVersionTest.test(current) || !simpleVersionTest.test(latest)) {
return current < latest;
}
const currentParts = current.split('.').map((part) => Number.parseInt(part, 10));
const latestParts = latest.split('.').map((part) => Number.parseInt(part, 10));
if (currentParts.length !== latestParts.length) {
return current < latest;
}
for (let i = 0; i < currentParts.length; i++) {
if (currentParts[i] !== latestParts[i]) {
return currentParts[i] < latestParts[i];
}
}
return false;
}
// Private
/**
* @param {string} reading
* @param {import('dictionary').Pronunciation} pronunciation
* @param {import('dictionary-data-util').GroupedPronunciationInternal[]} groupedPronunciationList
* @returns {?import('dictionary-data-util').GroupedPronunciationInternal}
*/
function findExistingGroupedPronunciation(reading, pronunciation, groupedPronunciationList) {
const existingGroupedPronunciation = groupedPronunciationList.find((groupedPronunciation) => {
return groupedPronunciation.reading === reading && arePronunciationsEquivalent(groupedPronunciation, pronunciation);
});
return existingGroupedPronunciation || null;
}
/**
* @param {import('dictionary-data-util').GroupedPronunciationInternal} groupedPronunciation
* @param {import('dictionary').Pronunciation} pronunciation2
* @returns {boolean}
*/
function arePronunciationsEquivalent({pronunciation: pronunciation1}, pronunciation2) {
if (
pronunciation1.type !== pronunciation2.type ||
!areTagListsEqual(pronunciation1.tags, pronunciation2.tags)
) {
return false;
}
switch (pronunciation1.type) {
case 'pitch-accent':
{
// This cast is valid based on the type check at the start of the function.
const pitchAccent2 = /** @type {import('dictionary').PitchAccent} */ (pronunciation2);
return (
pronunciation1.positions === pitchAccent2.positions &&
areArraysEqual(pronunciation1.nasalPositions, pitchAccent2.nasalPositions) &&
areArraysEqual(pronunciation1.devoicePositions, pitchAccent2.devoicePositions)
);
}
case 'phonetic-transcription':
{
// This cast is valid based on the type check at the start of the function.
const phoneticTranscription2 = /** @type {import('dictionary').PhoneticTranscription} */ (pronunciation2);
return pronunciation1.ipa === phoneticTranscription2.ipa;
}
}
return true;
}
/**
* @template [T=unknown]
* @param {T[]} array1
* @param {T[]} array2
* @returns {boolean}
*/
function areArraysEqual(array1, array2) {
const ii = array1.length;
if (ii !== array2.length) { return false; }
for (let i = 0; i < ii; ++i) {
if (array1[i] !== array2[i]) { return false; }
}
return true;
}
/**
* @param {import('dictionary').Tag[]} tagList1
* @param {import('dictionary').Tag[]} tagList2
* @returns {boolean}
*/
function areTagListsEqual(tagList1, tagList2) {
const ii = tagList1.length;
if (tagList2.length !== ii) { return false; }
for (let i = 0; i < ii; ++i) {
const tag1 = tagList1[i];
const tag2 = tagList2[i];
if (tag1.name !== tag2.name || !areArraysEqual(tag1.dictionaries, tag2.dictionaries)) {
return false;
}
}
return true;
}
/**
* @template [T=unknown]
* @param {Set<T>} set1
* @param {Set<T>} set2
* @returns {boolean}
*/
function areSetsEqual(set1, set2) {
if (set1.size !== set2.size) {
return false;
}
for (const value of set1) {
if (!set2.has(value)) {
return false;
}
}
return true;
}
/**
* @template [T=unknown]
* @param {Set<T>} set1
* @param {Set<T>} set2
* @returns {T[]}
*/
function getSetIntersection(set1, set2) {
const result = [];
for (const value of set1) {
if (set2.has(value)) {
result.push(value);
}
}
return result;
}
/**
* @param {unknown[]} array
* @returns {string}
*/
function createMapKey(array) {
return JSON.stringify(array);
}

View File

@@ -0,0 +1,60 @@
/*
* Copyright (C) 2024-2025 Yomitan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {ExtensionError} from '../core/extension-error.js';
import {log} from '../core/log.js';
import {DictionaryDatabase} from './dictionary-database.js';
export class DictionaryDatabaseWorkerHandler {
constructor() {
/** @type {DictionaryDatabase?} */
this._dictionaryDatabase = null;
}
/**
*
*/
async prepare() {
this._dictionaryDatabase = new DictionaryDatabase();
try {
await this._dictionaryDatabase.prepare();
} catch (e) {
log.error(e);
}
self.addEventListener('message', this._onMessage.bind(this), false);
self.addEventListener('messageerror', (event) => {
const error = new ExtensionError('DictionaryDatabaseWorkerHandler: Error receiving message from main thread');
error.data = event;
log.error(error);
});
}
// Private
/**
* @param {MessageEvent<import('dictionary-database-worker-handler').MessageToWorker>} event
*/
_onMessage(event) {
const {action} = event.data;
switch (action) {
case 'connectToDatabaseWorker':
void this._dictionaryDatabase?.connectToDatabaseWorker(event.ports[0]);
break;
default:
log.error(`Unknown action: ${action}`);
}
}
}

View File

@@ -0,0 +1,31 @@
/*
* Copyright (C) 2024-2025 Yomitan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {log} from '../core/log.js';
import {DictionaryDatabaseWorkerHandler} from './dictionary-database-worker-handler.js';
/** Entry point. */
function main() {
try {
const dictionaryDatabaseWorkerHandler = new DictionaryDatabaseWorkerHandler();
void dictionaryDatabaseWorkerHandler.prepare();
} catch (e) {
log.error(e);
}
}
main();

View File

@@ -0,0 +1,883 @@
/*
* Copyright (C) 2023-2025 Yomitan Authors
* Copyright (C) 2016-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {initWasm, Resvg} from '../../lib/resvg-wasm.js';
import {createApiMap, invokeApiMapHandler} from '../core/api-map.js';
import {ExtensionError} from '../core/extension-error.js';
import {log} from '../core/log.js';
import {safePerformance} from '../core/safe-performance.js';
import {stringReverse} from '../core/utilities.js';
import {Database} from '../data/database.js';
export class DictionaryDatabase {
constructor() {
/** @type {Database<import('dictionary-database').ObjectStoreName>} */
this._db = new Database();
/** @type {string} */
this._dbName = 'dict';
/** @type {import('dictionary-database').CreateQuery<string>} */
this._createOnlyQuery1 = (item) => IDBKeyRange.only(item);
/** @type {import('dictionary-database').CreateQuery<import('dictionary-database').DictionaryAndQueryRequest>} */
this._createOnlyQuery2 = (item) => IDBKeyRange.only(item.query);
/** @type {import('dictionary-database').CreateQuery<import('dictionary-database').TermExactRequest>} */
this._createOnlyQuery3 = (item) => IDBKeyRange.only(item.term);
/** @type {import('dictionary-database').CreateQuery<import('dictionary-database').MediaRequest>} */
this._createOnlyQuery4 = (item) => IDBKeyRange.only(item.path);
/** @type {import('dictionary-database').CreateQuery<import('dictionary-database').DrawMediaGroupedRequest>} */
this._createOnlyQuery5 = (item) => IDBKeyRange.only(item.path);
/** @type {import('dictionary-database').CreateQuery<string>} */
this._createBoundQuery1 = (item) => IDBKeyRange.bound(item, `${item}\uffff`, false, false);
/** @type {import('dictionary-database').CreateQuery<string>} */
this._createBoundQuery2 = (item) => {
item = stringReverse(item);
return IDBKeyRange.bound(item, `${item}\uffff`, false, false);
};
/** @type {import('dictionary-database').CreateResult<import('dictionary-database').TermExactRequest, import('dictionary-database').DatabaseTermEntryWithId, import('dictionary-database').TermEntry>} */
this._createTermBind1 = this._createTermExact.bind(this);
/** @type {import('dictionary-database').CreateResult<import('dictionary-database').DictionaryAndQueryRequest, import('dictionary-database').DatabaseTermEntryWithId, import('dictionary-database').TermEntry>} */
this._createTermBind2 = this._createTermSequenceExact.bind(this);
/** @type {import('dictionary-database').CreateResult<string, import('dictionary-database').DatabaseTermMeta, import('dictionary-database').TermMeta>} */
this._createTermMetaBind = this._createTermMeta.bind(this);
/** @type {import('dictionary-database').CreateResult<string, import('dictionary-database').DatabaseKanjiEntry, import('dictionary-database').KanjiEntry>} */
this._createKanjiBind = this._createKanji.bind(this);
/** @type {import('dictionary-database').CreateResult<string, import('dictionary-database').DatabaseKanjiMeta, import('dictionary-database').KanjiMeta>} */
this._createKanjiMetaBind = this._createKanjiMeta.bind(this);
/** @type {import('dictionary-database').CreateResult<import('dictionary-database').MediaRequest, import('dictionary-database').MediaDataArrayBufferContent, import('dictionary-database').Media>} */
this._createMediaBind = this._createMedia.bind(this);
/** @type {import('dictionary-database').CreateResult<import('dictionary-database').DrawMediaGroupedRequest, import('dictionary-database').MediaDataArrayBufferContent, import('dictionary-database').DrawMedia>} */
this._createDrawMediaBind = this._createDrawMedia.bind(this);
/**
* @type {Worker?}
*/
this._worker = null;
/**
* @type {Uint8Array?}
*/
this._resvgFontBuffer = null;
/** @type {import('dictionary-database').ApiMap} */
this._apiMap = createApiMap([
['drawMedia', this._onDrawMedia.bind(this)],
]);
}
/**
* do upgrades for the IndexedDB schema (basically limited to adding new stores when needed)
*/
async prepare() {
// do not do upgrades in web workers as they are considered to be children of the main thread and are not responsible for database upgrades
const isWorker = self.constructor.name !== 'Window';
const upgrade =
/** @type {import('database').StructureDefinition<import('dictionary-database').ObjectStoreName>[]?} */
([
/** @type {import('database').StructureDefinition<import('dictionary-database').ObjectStoreName>} */
({
version: 20,
stores: {
terms: {
primaryKey: {keyPath: 'id', autoIncrement: true},
indices: ['dictionary', 'expression', 'reading'],
},
kanji: {
primaryKey: {autoIncrement: true},
indices: ['dictionary', 'character'],
},
tagMeta: {
primaryKey: {autoIncrement: true},
indices: ['dictionary'],
},
dictionaries: {
primaryKey: {autoIncrement: true},
indices: ['title', 'version'],
},
},
}),
{
version: 30,
stores: {
termMeta: {
primaryKey: {autoIncrement: true},
indices: ['dictionary', 'expression'],
},
kanjiMeta: {
primaryKey: {autoIncrement: true},
indices: ['dictionary', 'character'],
},
tagMeta: {
primaryKey: {autoIncrement: true},
indices: ['dictionary', 'name'],
},
},
},
{
version: 40,
stores: {
terms: {
primaryKey: {keyPath: 'id', autoIncrement: true},
indices: ['dictionary', 'expression', 'reading', 'sequence'],
},
},
},
{
version: 50,
stores: {
terms: {
primaryKey: {keyPath: 'id', autoIncrement: true},
indices: ['dictionary', 'expression', 'reading', 'sequence', 'expressionReverse', 'readingReverse'],
},
},
},
{
version: 60,
stores: {
media: {
primaryKey: {keyPath: 'id', autoIncrement: true},
indices: ['dictionary', 'path'],
},
},
},
]);
await this._db.open(
this._dbName,
60,
isWorker ? null : upgrade,
);
// when we are not a worker ourselves, create a worker which is basically just a wrapper around this class, which we can use to offload some functions to
if (!isWorker) {
this._worker = new Worker('/js/dictionary/dictionary-database-worker-main.js', {type: 'module'});
this._worker.addEventListener('error', (event) => {
log.log('Worker terminated with error:', event);
});
this._worker.addEventListener('unhandledrejection', (event) => {
log.log('Unhandled promise rejection in worker:', event);
});
} else {
// when we are the worker, prepare to need to do some SVG work and load appropriate wasm & fonts
await initWasm(fetch('/lib/resvg.wasm'));
const font = await fetch('/fonts/NotoSansJP-Regular.ttf');
const fontData = await font.arrayBuffer();
this._resvgFontBuffer = new Uint8Array(fontData);
}
}
/** */
async close() {
this._db.close();
}
/**
* @returns {boolean}
*/
isPrepared() {
return this._db.isOpen();
}
/**
* @returns {Promise<boolean>}
*/
async purge() {
if (this._db.isOpening()) {
throw new Error('Cannot purge database while opening');
}
if (this._db.isOpen()) {
this._db.close();
}
if (this._worker !== null) {
this._worker.terminate();
this._worker = null;
}
let result = false;
try {
await Database.deleteDatabase(this._dbName);
result = true;
} catch (e) {
log.error(e);
}
await this.prepare();
return result;
}
/**
* @param {string} dictionaryName
* @param {number} progressRate
* @param {import('dictionary-database').DeleteDictionaryProgressCallback} onProgress
*/
async deleteDictionary(dictionaryName, progressRate, onProgress) {
/** @type {[objectStoreName: import('dictionary-database').ObjectStoreName, key: string][][]} */
const targetGroups = [
[
['kanji', 'dictionary'],
['kanjiMeta', 'dictionary'],
['terms', 'dictionary'],
['termMeta', 'dictionary'],
['tagMeta', 'dictionary'],
['media', 'dictionary'],
],
[
['dictionaries', 'title'],
],
];
let storeCount = 0;
for (const targets of targetGroups) {
storeCount += targets.length;
}
/** @type {import('dictionary-database').DeleteDictionaryProgressData} */
const progressData = {
count: 0,
processed: 0,
storeCount,
storesProcesed: 0,
};
/**
* @param {IDBValidKey[]} keys
* @returns {IDBValidKey[]}
*/
const filterKeys = (keys) => {
++progressData.storesProcesed;
progressData.count += keys.length;
onProgress(progressData);
return keys;
};
const onProgressWrapper = () => {
const processed = progressData.processed + 1;
progressData.processed = processed;
if ((processed % progressRate) === 0 || processed === progressData.count) {
onProgress(progressData);
}
};
for (const targets of targetGroups) {
const promises = [];
for (const [objectStoreName, indexName] of targets) {
const query = IDBKeyRange.only(dictionaryName);
const promise = this._db.bulkDelete(objectStoreName, indexName, query, filterKeys, onProgressWrapper);
promises.push(promise);
}
await Promise.all(promises);
}
}
/**
* @param {string[]} termList
* @param {import('dictionary-database').DictionarySet} dictionaries
* @param {import('dictionary-database').MatchType} matchType
* @returns {Promise<import('dictionary-database').TermEntry[]>}
*/
findTermsBulk(termList, dictionaries, matchType) {
const visited = new Set();
/** @type {import('dictionary-database').FindPredicate<string, import('dictionary-database').DatabaseTermEntryWithId>} */
const predicate = (row) => {
if (!dictionaries.has(row.dictionary)) { return false; }
const {id} = row;
if (visited.has(id)) { return false; }
visited.add(id);
return true;
};
const indexNames = (matchType === 'suffix') ? ['expressionReverse', 'readingReverse'] : ['expression', 'reading'];
let createQuery = this._createOnlyQuery1;
switch (matchType) {
case 'prefix':
createQuery = this._createBoundQuery1;
break;
case 'suffix':
createQuery = this._createBoundQuery2;
break;
}
const createResult = this._createTermGeneric.bind(this, matchType);
return this._findMultiBulk('terms', indexNames, termList, createQuery, predicate, createResult);
}
/**
* @param {import('dictionary-database').TermExactRequest[]} termList
* @param {import('dictionary-database').DictionarySet} dictionaries
* @returns {Promise<import('dictionary-database').TermEntry[]>}
*/
findTermsExactBulk(termList, dictionaries) {
/** @type {import('dictionary-database').FindPredicate<import('dictionary-database').TermExactRequest, import('dictionary-database').DatabaseTermEntry>} */
const predicate = (row, item) => (row.reading === item.reading && dictionaries.has(row.dictionary));
return this._findMultiBulk('terms', ['expression'], termList, this._createOnlyQuery3, predicate, this._createTermBind1);
}
/**
* @param {import('dictionary-database').DictionaryAndQueryRequest[]} items
* @returns {Promise<import('dictionary-database').TermEntry[]>}
*/
findTermsBySequenceBulk(items) {
/** @type {import('dictionary-database').FindPredicate<import('dictionary-database').DictionaryAndQueryRequest, import('dictionary-database').DatabaseTermEntry>} */
const predicate = (row, item) => (row.dictionary === item.dictionary);
return this._findMultiBulk('terms', ['sequence'], items, this._createOnlyQuery2, predicate, this._createTermBind2);
}
/**
* @param {string[]} termList
* @param {import('dictionary-database').DictionarySet} dictionaries
* @returns {Promise<import('dictionary-database').TermMeta[]>}
*/
findTermMetaBulk(termList, dictionaries) {
/** @type {import('dictionary-database').FindPredicate<string, import('dictionary-database').DatabaseTermMeta>} */
const predicate = (row) => dictionaries.has(row.dictionary);
return this._findMultiBulk('termMeta', ['expression'], termList, this._createOnlyQuery1, predicate, this._createTermMetaBind);
}
/**
* @param {string[]} kanjiList
* @param {import('dictionary-database').DictionarySet} dictionaries
* @returns {Promise<import('dictionary-database').KanjiEntry[]>}
*/
findKanjiBulk(kanjiList, dictionaries) {
/** @type {import('dictionary-database').FindPredicate<string, import('dictionary-database').DatabaseKanjiEntry>} */
const predicate = (row) => dictionaries.has(row.dictionary);
return this._findMultiBulk('kanji', ['character'], kanjiList, this._createOnlyQuery1, predicate, this._createKanjiBind);
}
/**
* @param {string[]} kanjiList
* @param {import('dictionary-database').DictionarySet} dictionaries
* @returns {Promise<import('dictionary-database').KanjiMeta[]>}
*/
findKanjiMetaBulk(kanjiList, dictionaries) {
/** @type {import('dictionary-database').FindPredicate<string, import('dictionary-database').DatabaseKanjiMeta>} */
const predicate = (row) => dictionaries.has(row.dictionary);
return this._findMultiBulk('kanjiMeta', ['character'], kanjiList, this._createOnlyQuery1, predicate, this._createKanjiMetaBind);
}
/**
* @param {import('dictionary-database').DictionaryAndQueryRequest[]} items
* @returns {Promise<(import('dictionary-database').Tag|undefined)[]>}
*/
findTagMetaBulk(items) {
/** @type {import('dictionary-database').FindPredicate<import('dictionary-database').DictionaryAndQueryRequest, import('dictionary-database').Tag>} */
const predicate = (row, item) => (row.dictionary === item.dictionary);
return this._findFirstBulk('tagMeta', 'name', items, this._createOnlyQuery2, predicate);
}
/**
* @param {string} name
* @param {string} dictionary
* @returns {Promise<?import('dictionary-database').Tag>}
*/
findTagForTitle(name, dictionary) {
const query = IDBKeyRange.only(name);
return this._db.find('tagMeta', 'name', query, (row) => (/** @type {import('dictionary-database').Tag} */ (row).dictionary === dictionary), null, null);
}
/**
* @param {import('dictionary-database').MediaRequest[]} items
* @returns {Promise<import('dictionary-database').Media[]>}
*/
getMedia(items) {
/** @type {import('dictionary-database').FindPredicate<import('dictionary-database').MediaRequest, import('dictionary-database').MediaDataArrayBufferContent>} */
const predicate = (row, item) => (row.dictionary === item.dictionary);
return this._findMultiBulk('media', ['path'], items, this._createOnlyQuery4, predicate, this._createMediaBind);
}
/**
* @param {import('dictionary-database').DrawMediaRequest[]} items
* @param {MessagePort} source
*/
async drawMedia(items, source) {
if (this._worker !== null) { // if a worker is available, offload the work to it
this._worker.postMessage({action: 'drawMedia', params: {items}}, [source]);
return;
}
// otherwise, you are the worker, so do the work
safePerformance.mark('drawMedia:start');
// merge items with the same path to reduce the number of database queries. collects the canvases into a single array for each path.
/** @type {Map<string, import('dictionary-database').DrawMediaGroupedRequest>} */
const groupedItems = new Map();
for (const item of items) {
const {path, dictionary, canvasIndex, canvasWidth, canvasHeight, generation} = item;
const key = `${path}:::${dictionary}`;
if (!groupedItems.has(key)) {
groupedItems.set(key, {path, dictionary, canvasIndexes: [], canvasWidth, canvasHeight, generation});
}
groupedItems.get(key)?.canvasIndexes.push(canvasIndex);
}
const groupedItemsArray = [...groupedItems.values()];
/** @type {import('dictionary-database').FindPredicate<import('dictionary-database').MediaRequest, import('dictionary-database').MediaDataArrayBufferContent>} */
const predicate = (row, item) => (row.dictionary === item.dictionary);
const results = await this._findMultiBulk('media', ['path'], groupedItemsArray, this._createOnlyQuery5, predicate, this._createDrawMediaBind);
// move all svgs to front to have a hotter loop
results.sort((a, _b) => (a.mediaType === 'image/svg+xml' ? -1 : 1));
safePerformance.mark('drawMedia:draw:start');
for (const m of results) {
if (m.mediaType === 'image/svg+xml') {
safePerformance.mark('drawMedia:draw:svg:start');
/** @type {import('@resvg/resvg-wasm').ResvgRenderOptions} */
const opts = {
fitTo: {
mode: 'width',
value: m.canvasWidth,
},
font: {
fontBuffers: this._resvgFontBuffer !== null ? [this._resvgFontBuffer] : [],
},
};
const resvgJS = new Resvg(new Uint8Array(m.content), opts);
const render = resvgJS.render();
source.postMessage({action: 'drawBufferToCanvases', params: {buffer: render.pixels.buffer, width: render.width, height: render.height, canvasIndexes: m.canvasIndexes, generation: m.generation}}, [render.pixels.buffer]);
safePerformance.mark('drawMedia:draw:svg:end');
safePerformance.measure('drawMedia:draw:svg', 'drawMedia:draw:svg:start', 'drawMedia:draw:svg:end');
} else {
safePerformance.mark('drawMedia:draw:raster:start');
// ImageDecoder is slightly faster than Blob/createImageBitmap, but
// 1) it is not available in Firefox <133
// 2) it is available in Firefox >=133, but it's not possible to transfer VideoFrames cross-process
//
// So the second branch is a fallback for all versions of Firefox and doesn't use ImageDecoder at all
// The second branch can eventually be changed to use ImageDecoder when we are okay with dropping support for Firefox <133
// The branches can be unified entirely when Firefox implements support for transferring VideoFrames cross-process in postMessage
if ('serviceWorker' in navigator) { // this is just a check for chrome, we don't actually use service worker functionality here
const imageDecoder = new ImageDecoder({type: m.mediaType, data: m.content});
await imageDecoder.decode().then((decodedImageResult) => {
source.postMessage({action: 'drawDecodedImageToCanvases', params: {decodedImage: decodedImageResult.image, canvasIndexes: m.canvasIndexes, generation: m.generation}}, [decodedImageResult.image]);
});
} else {
const image = new Blob([m.content], {type: m.mediaType});
await createImageBitmap(image, {resizeWidth: m.canvasWidth, resizeHeight: m.canvasHeight, resizeQuality: 'high'}).then((decodedImage) => {
// we need to do a dumb hack where we convert this ImageBitmap to an ImageData by drawing it to a temporary canvas, because Firefox doesn't support transferring ImageBitmaps cross-process
const canvas = new OffscreenCanvas(decodedImage.width, decodedImage.height);
const ctx = canvas.getContext('2d');
if (ctx !== null) {
ctx.drawImage(decodedImage, 0, 0);
const imageData = ctx.getImageData(0, 0, decodedImage.width, decodedImage.height);
source.postMessage({action: 'drawBufferToCanvases', params: {buffer: imageData.data.buffer, width: decodedImage.width, height: decodedImage.height, canvasIndexes: m.canvasIndexes, generation: m.generation}}, [imageData.data.buffer]);
}
});
}
safePerformance.mark('drawMedia:draw:raster:end');
safePerformance.measure('drawMedia:draw:raster', 'drawMedia:draw:raster:start', 'drawMedia:draw:raster:end');
}
}
safePerformance.mark('drawMedia:draw:end');
safePerformance.measure('drawMedia:draw', 'drawMedia:draw:start', 'drawMedia:draw:end');
safePerformance.mark('drawMedia:end');
safePerformance.measure('drawMedia', 'drawMedia:start', 'drawMedia:end');
}
/**
* @returns {Promise<import('dictionary-importer').Summary[]>}
*/
getDictionaryInfo() {
return new Promise((resolve, reject) => {
const transaction = this._db.transaction(['dictionaries'], 'readonly');
const objectStore = transaction.objectStore('dictionaries');
this._db.getAll(objectStore, null, resolve, reject, null);
});
}
/**
* @param {string[]} dictionaryNames
* @param {boolean} getTotal
* @returns {Promise<import('dictionary-database').DictionaryCounts>}
*/
getDictionaryCounts(dictionaryNames, getTotal) {
return new Promise((resolve, reject) => {
const targets = [
['kanji', 'dictionary'],
['kanjiMeta', 'dictionary'],
['terms', 'dictionary'],
['termMeta', 'dictionary'],
['tagMeta', 'dictionary'],
['media', 'dictionary'],
];
const objectStoreNames = targets.map(([objectStoreName]) => objectStoreName);
const transaction = this._db.transaction(objectStoreNames, 'readonly');
const databaseTargets = targets.map(([objectStoreName, indexName]) => {
const objectStore = transaction.objectStore(objectStoreName);
const index = objectStore.index(indexName);
return {objectStore, index};
});
/** @type {import('database').CountTarget[]} */
const countTargets = [];
if (getTotal) {
for (const {objectStore} of databaseTargets) {
countTargets.push([objectStore, void 0]);
}
}
for (const dictionaryName of dictionaryNames) {
const query = IDBKeyRange.only(dictionaryName);
for (const {index} of databaseTargets) {
countTargets.push([index, query]);
}
}
/**
* @param {number[]} results
*/
const onCountComplete = (results) => {
const resultCount = results.length;
const targetCount = targets.length;
/** @type {import('dictionary-database').DictionaryCountGroup[]} */
const counts = [];
for (let i = 0; i < resultCount; i += targetCount) {
/** @type {import('dictionary-database').DictionaryCountGroup} */
const countGroup = {};
for (let j = 0; j < targetCount; ++j) {
countGroup[targets[j][0]] = results[i + j];
}
counts.push(countGroup);
}
const total = getTotal ? /** @type {import('dictionary-database').DictionaryCountGroup} */ (counts.shift()) : null;
resolve({total, counts});
};
this._db.bulkCount(countTargets, onCountComplete, reject);
});
}
/**
* @param {string} title
* @returns {Promise<boolean>}
*/
async dictionaryExists(title) {
const query = IDBKeyRange.only(title);
const result = await this._db.find('dictionaries', 'title', query, null, null, void 0);
return typeof result !== 'undefined';
}
/**
* @template {import('dictionary-database').ObjectStoreName} T
* @param {T} objectStoreName
* @param {import('dictionary-database').ObjectStoreData<T>[]} items
* @param {number} start
* @param {number} count
* @returns {Promise<void>}
*/
bulkAdd(objectStoreName, items, start, count) {
return this._db.bulkAdd(objectStoreName, items, start, count);
}
/**
* @template {import('dictionary-database').ObjectStoreName} T
* @param {T} objectStoreName
* @param {import('dictionary-database').ObjectStoreData<T>} item
* @returns {Promise<IDBRequest<IDBValidKey>>}
*/
addWithResult(objectStoreName, item) {
return this._db.addWithResult(objectStoreName, item);
}
/**
* @template {import('dictionary-database').ObjectStoreName} T
* @param {T} objectStoreName
* @param {import('dictionary-database').DatabaseUpdateItem[]} items
* @param {number} start
* @param {number} count
* @returns {Promise<void>}
*/
bulkUpdate(objectStoreName, items, start, count) {
return this._db.bulkUpdate(objectStoreName, items, start, count);
}
// Private
/**
* @template [TRow=unknown]
* @template [TItem=unknown]
* @template [TResult=unknown]
* @param {import('dictionary-database').ObjectStoreName} objectStoreName
* @param {string[]} indexNames
* @param {TItem[]} items
* @param {import('dictionary-database').CreateQuery<TItem>} createQuery
* @param {import('dictionary-database').FindPredicate<TItem, TRow>} predicate
* @param {import('dictionary-database').CreateResult<TItem, TRow, TResult>} createResult
* @returns {Promise<TResult[]>}
*/
_findMultiBulk(objectStoreName, indexNames, items, createQuery, predicate, createResult) {
safePerformance.mark('findMultiBulk:start');
return new Promise((resolve, reject) => {
const itemCount = items.length;
const indexCount = indexNames.length;
/** @type {TResult[]} */
const results = [];
if (itemCount === 0 || indexCount === 0) {
resolve(results);
safePerformance.mark('findMultiBulk:end');
safePerformance.measure('findMultiBulk', 'findMultiBulk:start', 'findMultiBulk:end');
return;
}
const transaction = this._db.transaction([objectStoreName], 'readonly');
const objectStore = transaction.objectStore(objectStoreName);
const indexList = [];
for (const indexName of indexNames) {
indexList.push(objectStore.index(indexName));
}
let completeCount = 0;
const requiredCompleteCount = itemCount * indexCount;
/**
* @param {TItem} item
* @returns {(rows: TRow[], data: import('dictionary-database').FindMultiBulkData<TItem>) => void}
*/
const onGetAll = (item) => (rows, data) => {
if (typeof item === 'object' && item !== null && 'path' in item) {
safePerformance.mark(`findMultiBulk:onGetAll:${item.path}:end`);
safePerformance.measure(`findMultiBulk:onGetAll:${item.path}`, `findMultiBulk:onGetAll:${item.path}:start`, `findMultiBulk:onGetAll:${item.path}:end`);
}
for (const row of rows) {
if (predicate(row, data.item)) {
results.push(createResult(row, data));
}
}
if (++completeCount >= requiredCompleteCount) {
resolve(results);
safePerformance.mark('findMultiBulk:end');
safePerformance.measure('findMultiBulk', 'findMultiBulk:start', 'findMultiBulk:end');
}
};
safePerformance.mark('findMultiBulk:getAll:start');
for (let i = 0; i < itemCount; ++i) {
const item = items[i];
const query = createQuery(item);
for (let j = 0; j < indexCount; ++j) {
/** @type {import('dictionary-database').FindMultiBulkData<TItem>} */
const data = {item, itemIndex: i, indexIndex: j};
if (typeof item === 'object' && item !== null && 'path' in item) {
safePerformance.mark(`findMultiBulk:onGetAll:${item.path}:start`);
}
this._db.getAll(indexList[j], query, onGetAll(item), reject, data);
}
}
safePerformance.mark('findMultiBulk:getAll:end');
safePerformance.measure('findMultiBulk:getAll', 'findMultiBulk:getAll:start', 'findMultiBulk:getAll:end');
});
}
/**
* @template [TRow=unknown]
* @template [TItem=unknown]
* @param {import('dictionary-database').ObjectStoreName} objectStoreName
* @param {string} indexName
* @param {TItem[]} items
* @param {import('dictionary-database').CreateQuery<TItem>} createQuery
* @param {import('dictionary-database').FindPredicate<TItem, TRow>} predicate
* @returns {Promise<(TRow|undefined)[]>}
*/
_findFirstBulk(objectStoreName, indexName, items, createQuery, predicate) {
return new Promise((resolve, reject) => {
const itemCount = items.length;
/** @type {(TRow|undefined)[]} */
const results = new Array(itemCount);
if (itemCount === 0) {
resolve(results);
return;
}
const transaction = this._db.transaction([objectStoreName], 'readonly');
const objectStore = transaction.objectStore(objectStoreName);
const index = objectStore.index(indexName);
let completeCount = 0;
/**
* @param {TRow|undefined} row
* @param {number} itemIndex
*/
const onFind = (row, itemIndex) => {
results[itemIndex] = row;
if (++completeCount >= itemCount) {
resolve(results);
}
};
for (let i = 0; i < itemCount; ++i) {
const item = items[i];
const query = createQuery(item);
this._db.findFirst(index, query, onFind, reject, i, predicate, item, void 0);
}
});
}
/**
* @param {import('dictionary-database').MatchType} matchType
* @param {import('dictionary-database').DatabaseTermEntryWithId} row
* @param {import('dictionary-database').FindMultiBulkData<string>} data
* @returns {import('dictionary-database').TermEntry}
*/
_createTermGeneric(matchType, row, data) {
const matchSourceIsTerm = (data.indexIndex === 0);
const matchSource = (matchSourceIsTerm ? 'term' : 'reading');
if ((matchSourceIsTerm ? row.expression : row.reading) === data.item) {
matchType = 'exact';
}
return this._createTerm(matchSource, matchType, row, data.itemIndex);
}
/**
* @param {import('dictionary-database').DatabaseTermEntryWithId} row
* @param {import('dictionary-database').FindMultiBulkData<import('dictionary-database').TermExactRequest>} data
* @returns {import('dictionary-database').TermEntry}
*/
_createTermExact(row, data) {
return this._createTerm('term', 'exact', row, data.itemIndex);
}
/**
* @param {import('dictionary-database').DatabaseTermEntryWithId} row
* @param {import('dictionary-database').FindMultiBulkData<import('dictionary-database').DictionaryAndQueryRequest>} data
* @returns {import('dictionary-database').TermEntry}
*/
_createTermSequenceExact(row, data) {
return this._createTerm('sequence', 'exact', row, data.itemIndex);
}
/**
* @param {import('dictionary-database').MatchSource} matchSource
* @param {import('dictionary-database').MatchType} matchType
* @param {import('dictionary-database').DatabaseTermEntryWithId} row
* @param {number} index
* @returns {import('dictionary-database').TermEntry}
*/
_createTerm(matchSource, matchType, row, index) {
const {sequence} = row;
return {
index,
matchType,
matchSource,
term: row.expression,
reading: row.reading,
definitionTags: this._splitField(row.definitionTags || row.tags),
termTags: this._splitField(row.termTags),
rules: this._splitField(row.rules),
definitions: row.glossary,
score: row.score,
dictionary: row.dictionary,
id: row.id,
sequence: typeof sequence === 'number' ? sequence : -1,
};
}
/**
* @param {import('dictionary-database').DatabaseKanjiEntry} row
* @param {import('dictionary-database').FindMultiBulkData<string>} data
* @returns {import('dictionary-database').KanjiEntry}
*/
_createKanji(row, {itemIndex: index}) {
const {stats} = row;
return {
index,
character: row.character,
onyomi: this._splitField(row.onyomi),
kunyomi: this._splitField(row.kunyomi),
tags: this._splitField(row.tags),
definitions: row.meanings,
stats: typeof stats === 'object' && stats !== null ? stats : {},
dictionary: row.dictionary,
};
}
/**
* @param {import('dictionary-database').DatabaseTermMeta} row
* @param {import('dictionary-database').FindMultiBulkData<string>} data
* @returns {import('dictionary-database').TermMeta}
* @throws {Error}
*/
_createTermMeta({expression: term, mode, data, dictionary}, {itemIndex: index}) {
switch (mode) {
case 'freq':
return {index, term, mode, data, dictionary};
case 'pitch':
return {index, term, mode, data, dictionary};
case 'ipa':
return {index, term, mode, data, dictionary};
default:
throw new Error(`Unknown mode: ${mode}`);
}
}
/**
* @param {import('dictionary-database').DatabaseKanjiMeta} row
* @param {import('dictionary-database').FindMultiBulkData<string>} data
* @returns {import('dictionary-database').KanjiMeta}
*/
_createKanjiMeta({character, mode, data, dictionary}, {itemIndex: index}) {
return {index, character, mode, data, dictionary};
}
/**
* @param {import('dictionary-database').MediaDataArrayBufferContent} row
* @param {import('dictionary-database').FindMultiBulkData<import('dictionary-database').MediaRequest>} data
* @returns {import('dictionary-database').Media}
*/
_createMedia(row, {itemIndex: index}) {
const {dictionary, path, mediaType, width, height, content} = row;
return {index, dictionary, path, mediaType, width, height, content};
}
/**
* @param {import('dictionary-database').MediaDataArrayBufferContent} row
* @param {import('dictionary-database').FindMultiBulkData<import('dictionary-database').DrawMediaGroupedRequest>} data
* @returns {import('dictionary-database').DrawMedia}
*/
_createDrawMedia(row, {itemIndex: index, item: {canvasIndexes, canvasWidth, canvasHeight, generation}}) {
const {dictionary, path, mediaType, width, height, content} = row;
return {index, dictionary, path, mediaType, width, height, content, canvasIndexes, canvasWidth, canvasHeight, generation};
}
/**
* @param {unknown} field
* @returns {string[]}
*/
_splitField(field) {
return typeof field === 'string' && field.length > 0 ? field.split(' ') : [];
}
// Parent-Worker API
/**
* @param {MessagePort} port
*/
async connectToDatabaseWorker(port) {
if (this._worker !== null) {
// executes outside of worker
this._worker.postMessage({action: 'connectToDatabaseWorker'}, [port]);
return;
}
// executes inside worker
port.onmessage = (/** @type {MessageEvent<import('dictionary-database').ApiMessageAny>} */event) => {
const {action, params} = event.data;
return invokeApiMapHandler(this._apiMap, action, params, [port], () => {});
};
port.onmessageerror = (event) => {
const error = new ExtensionError('DictionaryDatabase: Error receiving message from main thread');
error.data = event;
log.error(error);
};
}
/** @type {import('dictionary-database').ApiHandler<'drawMedia'>} */
_onDrawMedia(params, port) {
void this.drawMedia(params.requests, port);
}
}

View File

@@ -0,0 +1,50 @@
/*
* Copyright (C) 2023-2025 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {EventListenerCollection} from '../core/event-listener-collection.js';
/**
* Class used for loading and validating media during the dictionary import process.
*/
export class DictionaryImporterMediaLoader {
/** @type {import('dictionary-importer-media-loader').GetImageDetailsFunction} */
getImageDetails(content, mediaType, transfer) {
return new Promise((resolve, reject) => {
const image = new Image();
const eventListeners = new EventListenerCollection();
const cleanup = () => {
image.removeAttribute('src');
URL.revokeObjectURL(url);
eventListeners.removeAllEventListeners();
};
eventListeners.addEventListener(image, 'load', () => {
const {naturalWidth: width, naturalHeight: height} = image;
if (Array.isArray(transfer)) { transfer.push(content); }
cleanup();
resolve({content, width, height});
}, false);
eventListeners.addEventListener(image, 'error', () => {
cleanup();
reject(new Error('Image failed to load'));
}, false);
const blob = new Blob([content], {type: mediaType});
const url = URL.createObjectURL(blob);
image.src = url;
});
}
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,137 @@
/*
* Copyright (C) 2023-2025 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {ExtensionError} from '../core/extension-error.js';
import {DictionaryDatabase} from './dictionary-database.js';
import {DictionaryImporter} from './dictionary-importer.js';
import {DictionaryWorkerMediaLoader} from './dictionary-worker-media-loader.js';
export class DictionaryWorkerHandler {
constructor() {
/** @type {DictionaryWorkerMediaLoader} */
this._mediaLoader = new DictionaryWorkerMediaLoader();
}
/** */
prepare() {
self.addEventListener('message', this._onMessage.bind(this), false);
}
// Private
/**
* @param {MessageEvent<import('dictionary-worker-handler').Message>} event
*/
_onMessage(event) {
const {action, params} = event.data;
switch (action) {
case 'importDictionary':
void this._onMessageWithProgress(params, this._importDictionary.bind(this));
break;
case 'deleteDictionary':
void this._onMessageWithProgress(params, this._deleteDictionary.bind(this));
break;
case 'getDictionaryCounts':
void this._onMessageWithProgress(params, this._getDictionaryCounts.bind(this));
break;
case 'getImageDetails.response':
this._mediaLoader.handleMessage(params);
break;
}
}
/**
* @template [T=unknown]
* @param {T} params
* @param {(details: T, onProgress: import('dictionary-worker-handler').OnProgressCallback) => Promise<unknown>} handler
*/
async _onMessageWithProgress(params, handler) {
/**
* @param {...unknown} args
*/
const onProgress = (...args) => {
self.postMessage({
action: 'progress',
params: {args},
});
};
let response;
try {
const result = await handler(params, onProgress);
response = {result};
} catch (e) {
response = {error: ExtensionError.serialize(e)};
}
self.postMessage({action: 'complete', params: response});
}
/**
* @param {import('dictionary-worker-handler').ImportDictionaryMessageParams} details
* @param {import('dictionary-worker-handler').OnProgressCallback} onProgress
* @returns {Promise<import('dictionary-worker').MessageCompleteResultSerialized>}
*/
async _importDictionary({details, archiveContent}, onProgress) {
const dictionaryDatabase = await this._getPreparedDictionaryDatabase();
try {
const dictionaryImporter = new DictionaryImporter(this._mediaLoader, onProgress);
const {result, errors} = await dictionaryImporter.importDictionary(dictionaryDatabase, archiveContent, details);
return {
result,
errors: errors.map((error) => ExtensionError.serialize(error)),
};
} finally {
void dictionaryDatabase.close();
}
}
/**
* @param {import('dictionary-worker-handler').DeleteDictionaryMessageParams} details
* @param {import('dictionary-database').DeleteDictionaryProgressCallback} onProgress
* @returns {Promise<void>}
*/
async _deleteDictionary({dictionaryTitle}, onProgress) {
const dictionaryDatabase = await this._getPreparedDictionaryDatabase();
try {
return await dictionaryDatabase.deleteDictionary(dictionaryTitle, 1000, onProgress);
} finally {
void dictionaryDatabase.close();
}
}
/**
* @param {import('dictionary-worker-handler').GetDictionaryCountsMessageParams} details
* @returns {Promise<import('dictionary-database').DictionaryCounts>}
*/
async _getDictionaryCounts({dictionaryNames, getTotal}) {
const dictionaryDatabase = await this._getPreparedDictionaryDatabase();
try {
return await dictionaryDatabase.getDictionaryCounts(dictionaryNames, getTotal);
} finally {
void dictionaryDatabase.close();
}
}
/**
* @returns {Promise<DictionaryDatabase>}
*/
async _getPreparedDictionaryDatabase() {
const dictionaryDatabase = new DictionaryDatabase();
await dictionaryDatabase.prepare();
return dictionaryDatabase;
}
}

View File

@@ -0,0 +1,32 @@
/*
* Copyright (C) 2023-2025 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {log} from '../core/log.js';
import {DictionaryWorkerHandler} from './dictionary-worker-handler.js';
/** Entry point. */
function main() {
try {
const dictionaryWorkerHandler = new DictionaryWorkerHandler();
dictionaryWorkerHandler.prepare();
} catch (e) {
log.error(e);
}
}
main();

View File

@@ -0,0 +1,64 @@
/*
* Copyright (C) 2023-2025 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {generateId} from '../core/utilities.js';
import {ExtensionError} from '../core/extension-error.js';
/**
* Class used for loading and validating media from a worker thread
* during the dictionary import process.
*/
export class DictionaryWorkerMediaLoader {
/**
* Creates a new instance of the media loader.
*/
constructor() {
/** @type {Map<string, {resolve: (result: import('dictionary-worker-media-loader').ImageDetails) => void, reject: (reason?: import('core').RejectionReason) => void}>} */
this._requests = new Map();
}
/**
* Handles a response message posted to the worker thread.
* @param {import('dictionary-worker-media-loader').HandleMessageParams} params Details of the response.
*/
handleMessage(params) {
const {id} = params;
const request = this._requests.get(id);
if (typeof request === 'undefined') { return; }
this._requests.delete(id);
const {error} = params;
if (typeof error !== 'undefined') {
request.reject(ExtensionError.deserialize(error));
} else {
request.resolve(params.result);
}
}
/** @type {import('dictionary-importer-media-loader').GetImageDetailsFunction} */
getImageDetails(content, mediaType) {
return new Promise((resolve, reject) => {
const id = generateId(16);
this._requests.set(id, {resolve, reject});
// This is executed in a Worker context, so the self needs to be force cast
/** @type {Worker} */ (/** @type {unknown} */ (self)).postMessage({
action: 'getImageDetails',
params: {id, content, mediaType},
}, [content]);
});
}
}

View File

@@ -0,0 +1,206 @@
/*
* Copyright (C) 2023-2025 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
import {ExtensionError} from '../core/extension-error.js';
import {DictionaryImporterMediaLoader} from './dictionary-importer-media-loader.js';
export class DictionaryWorker {
constructor() {
/** @type {DictionaryImporterMediaLoader} */
this._dictionaryImporterMediaLoader = new DictionaryImporterMediaLoader();
}
/**
* @param {ArrayBuffer} archiveContent
* @param {import('dictionary-importer').ImportDetails} details
* @param {?import('dictionary-worker').ImportProgressCallback} onProgress
* @returns {Promise<import('dictionary-importer').ImportResult>}
*/
importDictionary(archiveContent, details, onProgress) {
return this._invoke(
'importDictionary',
{details, archiveContent},
[archiveContent],
onProgress,
this._formatImportDictionaryResult.bind(this),
);
}
/**
* @param {string} dictionaryTitle
* @param {?import('dictionary-worker').DeleteProgressCallback} onProgress
* @returns {Promise<void>}
*/
deleteDictionary(dictionaryTitle, onProgress) {
return this._invoke('deleteDictionary', {dictionaryTitle}, [], onProgress, null);
}
/**
* @param {string[]} dictionaryNames
* @param {boolean} getTotal
* @returns {Promise<import('dictionary-database').DictionaryCounts>}
*/
getDictionaryCounts(dictionaryNames, getTotal) {
return this._invoke('getDictionaryCounts', {dictionaryNames, getTotal}, [], null, null);
}
// Private
/**
* @template [TParams=import('core').SerializableObject]
* @template [TResponseRaw=unknown]
* @template [TResponse=unknown]
* @param {string} action
* @param {TParams} params
* @param {Transferable[]} transfer
* @param {?(arg: import('core').SafeAny) => void} onProgress
* @param {?(result: TResponseRaw) => TResponse} formatResult
*/
_invoke(action, params, transfer, onProgress, formatResult) {
return new Promise((resolve, reject) => {
const worker = new Worker('/js/dictionary/dictionary-worker-main.js', {type: 'module'});
/** @type {import('dictionary-worker').InvokeDetails<TResponseRaw, TResponse>} */
const details = {
complete: false,
worker,
resolve,
reject,
onMessage: null,
onProgress,
formatResult,
};
// Ugly typecast below due to not being able to explicitly state the template types
/** @type {(event: MessageEvent<import('dictionary-worker').MessageData<TResponseRaw>>) => void} */
const onMessage = /** @type {(details: import('dictionary-worker').InvokeDetails<TResponseRaw, TResponse>, event: MessageEvent<import('dictionary-worker').MessageData<TResponseRaw>>) => void} */ (this._onMessage).bind(this, details);
details.onMessage = onMessage;
worker.addEventListener('message', onMessage);
worker.postMessage({action, params}, transfer);
});
}
/**
* @template [TResponseRaw=unknown]
* @template [TResponse=unknown]
* @param {import('dictionary-worker').InvokeDetails<TResponseRaw, TResponse>} details
* @param {MessageEvent<import('dictionary-worker').MessageData<TResponseRaw>>} event
*/
_onMessage(details, event) {
if (details.complete) { return; }
const {action, params} = event.data;
switch (action) {
case 'complete':
{
const {worker, resolve, reject, onMessage, formatResult} = details;
if (worker === null || onMessage === null || resolve === null || reject === null) { return; }
details.complete = true;
details.worker = null;
details.resolve = null;
details.reject = null;
details.onMessage = null;
details.onProgress = null;
details.formatResult = null;
worker.removeEventListener('message', onMessage);
worker.terminate();
this._onMessageComplete(params, resolve, reject, formatResult);
}
break;
case 'progress':
this._onMessageProgress(params, details.onProgress);
break;
case 'getImageDetails':
{
const {worker} = details;
if (worker === null) { return; }
void this._onMessageGetImageDetails(params, worker);
}
break;
}
}
/**
* @template [TResponseRaw=unknown]
* @template [TResponse=unknown]
* @param {import('dictionary-worker').MessageCompleteParams<TResponseRaw>} params
* @param {(result: TResponse) => void} resolve
* @param {(reason?: import('core').RejectionReason) => void} reject
* @param {?(result: TResponseRaw) => TResponse} formatResult
*/
_onMessageComplete(params, resolve, reject, formatResult) {
const {error} = params;
if (typeof error !== 'undefined') {
reject(ExtensionError.deserialize(error));
} else {
const {result} = params;
if (typeof formatResult === 'function') {
let result2;
try {
result2 = formatResult(result);
} catch (e) {
reject(e);
return;
}
resolve(result2);
} else {
// If formatResult is not provided, the response is assumed to be the same type
// For some reason, eslint thinks the TResponse type is undefined
// eslint-disable-next-line jsdoc/no-undefined-types
resolve(/** @type {TResponse} */ (/** @type {unknown} */ (result)));
}
}
}
/**
* @param {import('dictionary-worker').MessageProgressParams} params
* @param {?(...args: unknown[]) => void} onProgress
*/
_onMessageProgress(params, onProgress) {
if (typeof onProgress !== 'function') { return; }
const {args} = params;
onProgress(...args);
}
/**
* @param {import('dictionary-worker').MessageGetImageDetailsParams} params
* @param {Worker} worker
*/
async _onMessageGetImageDetails(params, worker) {
const {id, content, mediaType} = params;
/** @type {Transferable[]} */
const transfer = [];
let response;
try {
const result = await this._dictionaryImporterMediaLoader.getImageDetails(content, mediaType, transfer);
response = {id, result};
} catch (e) {
response = {id, error: ExtensionError.serialize(e)};
}
worker.postMessage({action: 'getImageDetails.response', params: response}, transfer);
}
/**
* @param {import('dictionary-worker').MessageCompleteResultSerialized} response
* @returns {import('dictionary-worker').MessageCompleteResult}
*/
_formatImportDictionaryResult(response) {
const {result, errors} = response;
return {
result,
errors: errors.map((error) => ExtensionError.deserialize(error)),
};
}
}