Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix google docs #473

Merged
merged 5 commits into from
Dec 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dev/data/manifest-variants.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
]
}
],
"minimum_chrome_version": "96.0.0.0",
"minimum_chrome_version": "102.0.0.0",
"options_ui": {
"page": "settings.html",
"open_in_tab": true
Expand Down
37 changes: 28 additions & 9 deletions ext/js/accessibility/accessibility-controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -86,20 +86,39 @@ export class AccessibilityController {
try {
if (forceGoogleDocsHtmlRenderingAny) {
if (await isContentScriptRegistered(id)) { return; }
/** @type {import('script-manager').RegistrationDetails} */
const details = {
allFrames: true,
matches: ['*://docs.google.com/*'],
runAt: 'document_start',
js: ['js/accessibility/google-docs.js']
};
await registerContentScript(id, details);
try {
await this._registerGoogleDocsContentScript(id, false);
} catch (e) {
// Firefox doesn't support `world` field and will throw an error.
// In this case, use the xray vision version.
await this._registerGoogleDocsContentScript(id, true);
}
} else {
await unregisterContentScript(id);
}
} catch (e) {
log.error(e);
}
}
}

/**
* @param {string} id
* @param {boolean} xray
* @returns {Promise<void>}
*/
_registerGoogleDocsContentScript(id, xray) {
/** @type {import('script-manager').RegistrationDetails} */
const details = {
allFrames: true,
matches: ['*://docs.google.com/*'],
runAt: 'document_start',
js: [
xray ?
'js/accessibility/google-docs-xray.js' :
'js/accessibility/google-docs.js'
]
};
if (!xray) { details.world = 'MAIN'; }
return registerContentScript(id, details);
}
}
30 changes: 30 additions & 0 deletions ext/js/accessibility/google-docs-xray.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
/*
* Copyright (C) 2023 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/>.
*/

/** Entry point. */
function main() {
/** @type {Window} */
// @ts-expect-error - Firefox Xray vision
const window2 = window.wrappedJSObject;
if (!(typeof window2 === 'object' && window2 !== null)) { return; }
// The extension ID below is on an allow-list that is used on the Google Docs webpage.
// @ts-expect-error - Adding a property to the global object
djahandarie marked this conversation as resolved.
Show resolved Hide resolved
// eslint-disable-next-line no-underscore-dangle
window2._docs_annotate_canvas_by_ext = 'ogmnaimimemjmbakcfefmnahgdfhfami';
djahandarie marked this conversation as resolved.
Show resolved Hide resolved
}

main();
61 changes: 4 additions & 57 deletions ext/js/accessibility/google-docs.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/*
* Copyright (C) 2023 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
Expand All @@ -16,59 +15,7 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/

(async () => {
// Reentrant check
// @ts-expect-error - Checking a property to the global object
if (self.googleDocsAccessibilitySetup) { return; }
// @ts-expect-error - Adding a property to the global object
self.googleDocsAccessibilitySetup = true;

/**
* @template {import('api').ApiNames} TAction
* @template {import('api').ApiParams<TAction>} TParams
* @param {TAction} action
* @param {TParams} params
* @returns {Promise<import('api').ApiReturn<TAction>>}
*/
const invokeApi = (action, params) => {
return new Promise((resolve, reject) => {
chrome.runtime.sendMessage({action, params}, (response) => {
void chrome.runtime.lastError;
if (typeof response !== 'object' || response === null) {
reject(new Error('Unexpected response'));
} else if (typeof response.error !== 'undefined') {
reject(new Error('Invalid response'));
} else {
resolve(response.result);
}
});
});
};

const optionsContext = {depth: 0, url: location.href};
/** @type {import('api').ApiReturn<'optionsGet'>} */
let options;
try {
options = await invokeApi('optionsGet', {optionsContext});
} catch (e) {
return;
}

if (!options.accessibility.forceGoogleDocsHtmlRendering) { return; }

// The extension ID below is on an allow-list that is used on the Google Docs webpage.
/* eslint-disable */
// @ts-expect-error : Adding a property to the global object
const inject = () => { window._docs_annotate_canvas_by_ext = 'ogmnaimimemjmbakcfefmnahgdfhfami'; };
/* eslint-enable */

let parent = document.head;
if (parent === null) {
parent = document.documentElement;
if (parent === null) { return; }
}
const script = document.createElement('script');
script.textContent = `(${inject.toString()})();`;
parent.appendChild(script);
parent.removeChild(script);
})();
// The extension ID below is on an allow-list that is used on the Google Docs webpage.
// @ts-expect-error - Adding a property to the global object
// eslint-disable-next-line no-underscore-dangle
window._docs_annotate_canvas_by_ext = 'ogmnaimimemjmbakcfefmnahgdfhfami';
5 changes: 4 additions & 1 deletion ext/js/background/script-manager.js
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ export async function unregisterContentScript(id) {
* @returns {chrome.scripting.RegisteredContentScript}
*/
function createContentScriptRegistrationOptions(details, id) {
const {css, js, allFrames, matches, runAt} = details;
const {css, js, allFrames, matches, runAt, world} = details;
/** @type {chrome.scripting.RegisteredContentScript} */
const options = {
id: id,
Expand All @@ -150,5 +150,8 @@ function createContentScriptRegistrationOptions(details, id) {
if (typeof runAt !== 'undefined') {
options.runAt = runAt;
}
if (typeof world !== 'undefined') {
options.world = world;
}
return options;
}
4 changes: 4 additions & 0 deletions ext/settings.html
Original file line number Diff line number Diff line change
Expand Up @@ -2134,6 +2134,10 @@ <h1>Yomitan Settings</h1>
Enabling this option will force Google Docs webpages to expose some additional text
information which should allow Yomitan to still work.
</p>
<p class="warning-text">
If any profile has this setting enabled, compatibility mode will be activated;
profile conditions are ignored.
</p>
<p class="danger-text">
Google has changed this compatibility implementation several times, and the changes do not seem to be announced or documented.
Therefore, it is possible that this feature could stop working at any time the future without warning.
Expand Down
4 changes: 4 additions & 0 deletions types/ext/script-manager.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ export type RegistrationDetails = {
css?: string[];
/** List of script paths. */
js?: string[];
/** The execution world for the script. */
world?: ExecutionWorld;
};

export type ContentScriptInjectionDetails = {
Expand All @@ -39,3 +41,5 @@ export type ContentScriptInjectionDetails = {
js?: string[];
urlRegex: RegExp | null;
};

export type ExecutionWorld = 'MAIN' | 'ISOLATED';