From d3807d88ecf40b2c37ed31d823af038a091ffca0 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Sat, 20 Aug 2022 12:53:22 -0400 Subject: ArrayBufferUtil (#2215) * Rename StringUtil to ArrayBufferUtil * Update docs * Rename file string-util.js to array-buffer-util.js --- ext/js/background/backend.js | 4 +- ext/js/data/sandbox/array-buffer-util.js | 76 ++++++++++++++++++++++++++++++ ext/js/data/sandbox/string-util.js | 76 ------------------------------ ext/js/display/display-content-manager.js | 4 +- ext/js/media/audio-downloader.js | 4 +- ext/js/pages/settings/backup-controller.js | 4 +- 6 files changed, 84 insertions(+), 84 deletions(-) create mode 100644 ext/js/data/sandbox/array-buffer-util.js delete mode 100644 ext/js/data/sandbox/string-util.js (limited to 'ext/js') diff --git a/ext/js/background/backend.js b/ext/js/background/backend.js index f3c76311..a3694dd3 100644 --- a/ext/js/background/backend.js +++ b/ext/js/background/backend.js @@ -19,6 +19,7 @@ * AccessibilityController * AnkiConnect * AnkiUtil + * ArrayBufferUtil * AudioDownloader * ClipboardMonitor * ClipboardReader @@ -33,7 +34,6 @@ * ProfileConditionsUtil * RequestBuilder * ScriptManager - * StringUtil * Translator * wanakana */ @@ -2223,7 +2223,7 @@ class Backend { for (const item of results) { const {content} = item; if (content instanceof ArrayBuffer) { - item.content = StringUtil.arrayBufferToBase64(content); + item.content = ArrayBufferUtil.arrayBufferToBase64(content); } } return results; diff --git a/ext/js/data/sandbox/array-buffer-util.js b/ext/js/data/sandbox/array-buffer-util.js new file mode 100644 index 00000000..13988e76 --- /dev/null +++ b/ext/js/data/sandbox/array-buffer-util.js @@ -0,0 +1,76 @@ +/* + * 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 . + */ + +/** + * Class containing generic ArrayBuffer utility functions. + */ +class ArrayBufferUtil { + /** + * Decodes the contents of an ArrayBuffer using UTF8. + * @param {ArrayBuffer} arrayBuffer The input ArrayBuffer. + * @returns {string} A UTF8-decoded string. + */ + static arrayBufferUtf8Decode(arrayBuffer) { + try { + return new TextDecoder('utf-8').decode(arrayBuffer); + } catch (e) { + return decodeURIComponent(escape(this.arrayBufferToBinaryString(arrayBuffer))); + } + } + + /** + * Converts the contents of an ArrayBuffer to a base64 string. + * @param {ArrayBuffer} arrayBuffer The input ArrayBuffer. + * @returns {string} A base64 string representing the binary content. + */ + static arrayBufferToBase64(arrayBuffer) { + return btoa(this.arrayBufferToBinaryString(arrayBuffer)); + } + + /** + * Converts the contents of an ArrayBuffer to a binary string. + * @param {ArrayBuffer} arrayBuffer The input ArrayBuffer. + * @returns {string} A string representing the binary content. + */ + static arrayBufferToBinaryString(arrayBuffer) { + const bytes = new Uint8Array(arrayBuffer); + try { + return String.fromCharCode(...bytes); + } catch (e) { + let binary = ''; + for (let i = 0, ii = bytes.byteLength; i < ii; ++i) { + binary += String.fromCharCode(bytes[i]); + } + return binary; + } + } + + /** + * Converts a base64 string to an ArrayBuffer. + * @param {string} content The binary content string encoded in base64. + * @returns {ArrayBuffer} A new `ArrayBuffer` object corresponding to the specified content. + */ + static base64ToArrayBuffer(content) { + const binaryContent = atob(content); + const length = binaryContent.length; + const array = new Uint8Array(length); + for (let i = 0; i < length; ++i) { + array[i] = binaryContent.charCodeAt(i); + } + return array.buffer; + } +} diff --git a/ext/js/data/sandbox/string-util.js b/ext/js/data/sandbox/string-util.js deleted file mode 100644 index de6933cd..00000000 --- a/ext/js/data/sandbox/string-util.js +++ /dev/null @@ -1,76 +0,0 @@ -/* - * 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 . - */ - -/** - * Class containing generic string utility functions. - */ -class StringUtil { - /** - * Decodes the contents of an ArrayBuffer using UTF8. - * @param {ArrayBuffer} arrayBuffer The input ArrayBuffer. - * @returns {string} A UTF8-decoded string. - */ - static arrayBufferUtf8Decode(arrayBuffer) { - try { - return new TextDecoder('utf-8').decode(arrayBuffer); - } catch (e) { - return decodeURIComponent(escape(this.arrayBufferToBinaryString(arrayBuffer))); - } - } - - /** - * Converts the contents of an ArrayBuffer to a base64 string. - * @param {ArrayBuffer} arrayBuffer The input ArrayBuffer. - * @returns {string} A base64 string representing the binary content. - */ - static arrayBufferToBase64(arrayBuffer) { - return btoa(this.arrayBufferToBinaryString(arrayBuffer)); - } - - /** - * Converts the contents of an ArrayBuffer to a binary string. - * @param {ArrayBuffer} arrayBuffer The input ArrayBuffer. - * @returns {string} A string representing the binary content. - */ - static arrayBufferToBinaryString(arrayBuffer) { - const bytes = new Uint8Array(arrayBuffer); - try { - return String.fromCharCode(...bytes); - } catch (e) { - let binary = ''; - for (let i = 0, ii = bytes.byteLength; i < ii; ++i) { - binary += String.fromCharCode(bytes[i]); - } - return binary; - } - } - - /** - * Converts a base64 string to an ArrayBuffer. - * @param {string} content The binary content string encoded in base64. - * @returns {ArrayBuffer} A new `ArrayBuffer` object corresponding to the specified content. - */ - static base64ToArrayBuffer(content) { - const binaryContent = atob(content); - const length = binaryContent.length; - const array = new Uint8Array(length); - for (let i = 0; i < length; ++i) { - array[i] = binaryContent.charCodeAt(i); - } - return array.buffer; - } -} diff --git a/ext/js/display/display-content-manager.js b/ext/js/display/display-content-manager.js index 0b91b40c..bfba5fb8 100644 --- a/ext/js/display/display-content-manager.js +++ b/ext/js/display/display-content-manager.js @@ -16,7 +16,7 @@ */ /* global - * StringUtil + * ArrayBufferUtil */ /** @@ -139,7 +139,7 @@ class DisplayContentManager { const token = this._token; const data = (await yomichan.api.getMedia([{path, dictionary}]))[0]; if (token === this._token && data !== null) { - const buffer = StringUtil.base64ToArrayBuffer(data.content); + const buffer = ArrayBufferUtil.base64ToArrayBuffer(data.content); const blob = new Blob([buffer], {type: data.mediaType}); const url = URL.createObjectURL(blob); cachedData.data = data; diff --git a/ext/js/media/audio-downloader.js b/ext/js/media/audio-downloader.js index 4142e3f4..77e9afd2 100644 --- a/ext/js/media/audio-downloader.js +++ b/ext/js/media/audio-downloader.js @@ -16,11 +16,11 @@ */ /* global + * ArrayBufferUtil * JsonSchema * NativeSimpleDOMParser * RequestBuilder * SimpleDOMParser - * StringUtil */ class AudioDownloader { @@ -283,7 +283,7 @@ class AudioDownloader { throw new Error('Could not retrieve audio'); } - const data = StringUtil.arrayBufferToBase64(arrayBuffer); + const data = ArrayBufferUtil.arrayBufferToBase64(arrayBuffer); const contentType = response.headers.get('Content-Type'); return {data, contentType}; } diff --git a/ext/js/pages/settings/backup-controller.js b/ext/js/pages/settings/backup-controller.js index ba36a828..a232ce34 100644 --- a/ext/js/pages/settings/backup-controller.js +++ b/ext/js/pages/settings/backup-controller.js @@ -16,9 +16,9 @@ */ /* global + * ArrayBufferUtil * DictionaryController * OptionsUtil - * StringUtil */ class BackupController { @@ -319,7 +319,7 @@ class BackupController { } async _importSettingsFile(file) { - const dataString = StringUtil.arrayBufferUtf8Decode(await this._readFileArrayBuffer(file)); + const dataString = ArrayBufferUtil.arrayBufferUtf8Decode(await this._readFileArrayBuffer(file)); const data = JSON.parse(dataString); // Type check -- cgit v1.2.3