diff options
Diffstat (limited to 'ext/bg/js')
| -rw-r--r-- | ext/bg/js/backend.js | 7 | ||||
| -rw-r--r-- | ext/bg/js/database.js | 43 | ||||
| -rw-r--r-- | ext/bg/js/dictionary-importer.js | 90 | ||||
| -rw-r--r-- | ext/bg/js/media-utility.js | 98 | 
4 files changed, 236 insertions, 2 deletions
| diff --git a/ext/bg/js/backend.js b/ext/bg/js/backend.js index e0814c17..8a19203f 100644 --- a/ext/bg/js/backend.js +++ b/ext/bg/js/backend.js @@ -111,7 +111,8 @@ class Backend {              ['getAnkiModelFieldNames', {handler: this._onApiGetAnkiModelFieldNames.bind(this), async: true}],              ['getDictionaryInfo', {handler: this._onApiGetDictionaryInfo.bind(this), async: true}],              ['getDictionaryCounts', {handler: this._onApiGetDictionaryCounts.bind(this), async: true}], -            ['purgeDatabase', {handler: this._onApiPurgeDatabase.bind(this), async: true}] +            ['purgeDatabase', {handler: this._onApiPurgeDatabase.bind(this), async: true}], +            ['getMedia', {handler: this._onApiGetMedia.bind(this), async: true}]          ]);          this._commandHandlers = new Map([ @@ -762,6 +763,10 @@ class Backend {          return await this.translator.purgeDatabase();      } +    async _onApiGetMedia({targets}) { +        return await this.database.getMedia(targets); +    } +      // Command handlers      async _onCommandSearch(params) { diff --git a/ext/bg/js/database.js b/ext/bg/js/database.js index 260c815a..16612403 100644 --- a/ext/bg/js/database.js +++ b/ext/bg/js/database.js @@ -33,7 +33,7 @@ class Database {          }          try { -            this.db = await Database._open('dict', 5, (db, transaction, oldVersion) => { +            this.db = await Database._open('dict', 6, (db, transaction, oldVersion) => {                  Database._upgrade(db, transaction, oldVersion, [                      {                          version: 2, @@ -90,6 +90,15 @@ class Database {                                  indices: ['dictionary', 'expression', 'reading', 'sequence', 'expressionReverse', 'readingReverse']                              }                          } +                    }, +                    { +                        version: 6, +                        stores: { +                            media: { +                                primaryKey: {keyPath: 'id', autoIncrement: true}, +                                indices: ['dictionary', 'path'] +                            } +                        }                      }                  ]);              }); @@ -268,6 +277,34 @@ class Database {          return result;      } +    async getMedia(targets) { +        this._validate(); + +        const count = targets.length; +        const promises = []; +        const results = new Array(count).fill(null); +        const createResult = Database._createMedia; +        const processRow = (row, [index, dictionaryName]) => { +            if (row.dictionary === dictionaryName) { +                results[index] = createResult(row, index); +            } +        }; + +        const transaction = this.db.transaction(['media'], 'readonly'); +        const objectStore = transaction.objectStore('media'); +        const index = objectStore.index('path'); + +        for (let i = 0; i < count; ++i) { +            const {path, dictionaryName} = targets[i]; +            const only = IDBKeyRange.only(path); +            promises.push(Database._getAll(index, only, [i, dictionaryName], processRow)); +        } + +        await Promise.all(promises); + +        return results; +    } +      async getDictionaryInfo() {          this._validate(); @@ -432,6 +469,10 @@ class Database {          return {character, mode, data, dictionary, index};      } +    static _createMedia(row, index) { +        return Object.assign({}, row, {index}); +    } +      static _getAll(dbIndex, query, context, processRow) {          const fn = typeof dbIndex.getAll === 'function' ? Database._getAllFast : Database._getAllUsingCursor;          return fn(dbIndex, query, context, processRow); diff --git a/ext/bg/js/dictionary-importer.js b/ext/bg/js/dictionary-importer.js index bf6809ec..3727f7ee 100644 --- a/ext/bg/js/dictionary-importer.js +++ b/ext/bg/js/dictionary-importer.js @@ -18,6 +18,7 @@  /* global   * JSZip   * JsonSchema + * mediaUtility   * requestJson   */ @@ -148,6 +149,22 @@ class DictionaryImporter {              }          } +        // Extended data support +        const extendedDataContext = { +            archive, +            media: new Map() +        }; +        for (const entry of termList) { +            const glossaryList = entry.glossary; +            for (let i = 0, ii = glossaryList.length; i < ii; ++i) { +                const glossary = glossaryList[i]; +                if (typeof glossary !== 'object' || glossary === null) { continue; } +                glossaryList[i] = await this._formatDictionaryTermGlossaryObject(glossary, extendedDataContext, entry); +            } +        } + +        const media = [...extendedDataContext.media.values()]; +          // Add dictionary          const summary = this._createSummary(dictionaryTitle, version, index, {prefixWildcardsSupported}); @@ -188,6 +205,7 @@ class DictionaryImporter {          await bulkAdd('kanji', kanjiList);          await bulkAdd('kanjiMeta', kanjiMetaList);          await bulkAdd('tagMeta', tagList); +        await bulkAdd('media', media);          return {result: summary, errors};      } @@ -275,4 +293,76 @@ class DictionaryImporter {          return [termBank, termMetaBank, kanjiBank, kanjiMetaBank, tagBank];      } + +    async _formatDictionaryTermGlossaryObject(data, context, entry) { +        switch (data.type) { +            case 'text': +                return data.text; +            case 'image': +                return await this._formatDictionaryTermGlossaryImage(data, context, entry); +            default: +                throw new Error(`Unhandled data type: ${data.type}`); +        } +    } + +    async _formatDictionaryTermGlossaryImage(data, context, entry) { +        const dictionary = entry.dictionary; +        const {path, width: preferredWidth, height: preferredHeight, title, description, pixelated} = data; +        if (context.media.has(path)) { +            // Already exists +            return data; +        } + +        let errorSource = entry.expression; +        if (entry.reading.length > 0) { +            errorSource += ` (${entry.reading});`; +        } + +        const file = context.archive.file(path); +        if (file === null) { +            throw new Error(`Could not find image at path ${JSON.stringify(path)} for ${errorSource}`); +        } + +        const content = await file.async('base64'); +        const mediaType = mediaUtility.getImageMediaTypeFromFileName(path); +        if (mediaType === null) { +            throw new Error(`Could not determine media type for image at path ${JSON.stringify(path)} for ${errorSource}`); +        } + +        let image; +        try { +            image = await mediaUtility.loadImageBase64(mediaType, content); +        } catch (e) { +            throw new Error(`Could not load image at path ${JSON.stringify(path)} for ${errorSource}`); +        } + +        const width = image.naturalWidth; +        const height = image.naturalHeight; + +        // Create image data +        const mediaData = { +            dictionary, +            path, +            mediaType, +            width, +            height, +            content +        }; +        context.media.set(path, mediaData); + +        // Create new data +        const newData = { +            type: 'image', +            path, +            width, +            height +        }; +        if (typeof preferredWidth === 'number') { newData.preferredWidth = preferredWidth; } +        if (typeof preferredHeight === 'number') { newData.preferredHeight = preferredHeight; } +        if (typeof title === 'string') { newData.title = title; } +        if (typeof description === 'string') { newData.description = description; } +        if (typeof pixelated === 'boolean') { newData.pixelated = pixelated; } + +        return newData; +    }  } diff --git a/ext/bg/js/media-utility.js b/ext/bg/js/media-utility.js new file mode 100644 index 00000000..1f93b2b4 --- /dev/null +++ b/ext/bg/js/media-utility.js @@ -0,0 +1,98 @@ +/* + * Copyright (C) 2020  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/>. + */ + +/** + * mediaUtility is an object containing helper methods related to media processing. + */ +const mediaUtility = (() => { +    /** +     * Gets the file extension of a file path. URL search queries and hash +     * fragments are not handled. +     * @param path The path to the file. +     * @returns The file extension, including the '.', or an empty string +     *   if there is no file extension. +     */ +    function getFileNameExtension(path) { +        const match = /\.[^./\\]*$/.exec(path); +        return match !== null ? match[0] : ''; +    } + +    /** +     * Gets an image file's media type using a file path. +     * @param path The path to the file. +     * @returns The media type string if it can be determined from the file path, +     *   otherwise null. +     */ +    function getImageMediaTypeFromFileName(path) { +        switch (getFileNameExtension(path).toLowerCase()) { +            case '.apng': +                return 'image/apng'; +            case '.bmp': +                return 'image/bmp'; +            case '.gif': +                return 'image/gif'; +            case '.ico': +            case '.cur': +                return 'image/x-icon'; +            case '.jpg': +            case '.jpeg': +            case '.jfif': +            case '.pjpeg': +            case '.pjp': +                return 'image/jpeg'; +            case '.png': +                return 'image/png'; +            case '.svg': +                return 'image/svg+xml'; +            case '.tif': +            case '.tiff': +                return 'image/tiff'; +            case '.webp': +                return 'image/webp'; +            default: +                return null; +        } +    } + +    /** +     * Attempts to load an image using a base64 encoded content and a media type. +     * @param mediaType The media type for the image content. +     * @param content The binary content for the image, encoded in base64. +     * @returns A Promise which resolves with an HTMLImageElement instance on +     *   successful load, otherwise an error is thrown. +     */ +    function loadImageBase64(mediaType, content) { +        return new Promise((resolve, reject) => { +            const image = new Image(); +            const eventListeners = new EventListenerCollection(); +            eventListeners.addEventListener(image, 'load', () => { +                eventListeners.removeAllEventListeners(); +                resolve(image); +            }, false); +            eventListeners.addEventListener(image, 'error', () => { +                eventListeners.removeAllEventListeners(); +                reject(new Error('Image failed to load')); +            }, false); +            image.src = `data:${mediaType};base64,${content}`; +        }); +    } + +    return { +        getImageMediaTypeFromFileName, +        loadImageBase64 +    }; +})(); |