// Modify page
/* jshint esversion:6, -W097 */
/* jslint esversion:6 */
/* global GrammalectePanel, GrammalecteButton, GrammalecteTextFormatter, GrammalecteGrammarChecker, GrammalecteMessageBox, showError, MutationObserver, chrome, document, console */
/*
JS sucks (again, and again, and again, and again…)
Not possible to load content from within the extension:
https://bugzilla.mozilla.org/show_bug.cgi?id=1267027
No SharedWorker, no images allowed for now…
*/
"use strict";
function showError (e) {
// console can’t display error objects from content scripts
console.error(e.fileName + "\n" + e.name + "\nline: " + e.lineNumber + "\n" + e.message);
}
// Chrome don’t follow the W3C specification:
// https://browserext.github.io/browserext/
let bChrome = false;
if (typeof(browser) !== "object") {
var browser = chrome;
bChrome = true;
}
/*
function loadImage (sContainerClass, sImagePath) {
let xRequest = new XMLHttpRequest();
xRequest.open('GET', browser.extension.getURL("")+sImagePath, false);
xRequest.responseType = "arraybuffer";
xRequest.send();
let blobTxt = new Blob([xRequest.response], {type: 'image/png'});
let img = document.createElement('img');
img.src = (URL || webkitURL).createObjectURL(blobTxt); // webkitURL is obsolete: https://bugs.webkit.org/show_bug.cgi?id=167518
Array.filter(document.getElementsByClassName(sContainerClass), function (oElem) {
oElem.appendChild(img);
});
}
*/
const oGrammalecte = {
nButton: 0,
lButton: [],
oTFPanel: null,
oGCPanel: null,
oMessageBox: null,
xRightClickedNode: null,
xObserver: null,
sExtensionUrl: null,
oOptions: null,
bAutoRefresh: true,
listenRightClick: function () {
// Node where a right click is done
// Bug report: https://bugzilla.mozilla.org/show_bug.cgi?id=1325814
document.addEventListener('contextmenu', (xEvent) => {
this.xRightClickedNode = xEvent.target;
}, true);
},
clearRightClickedNode: function () {
this.xRightClickedNode = null;
},
createButtons: function () {
if (bChrome) {
browser.storage.local.get("ui_options", this._prepareButtons.bind(this));
return;
}
browser.storage.local.get("ui_options").then(this._prepareButtons.bind(this), showError);
},
_isEligibleNode: function (xNode) {
return (xNode.style.display !== "none" && xNode.style.visibility !== "hidden"
&& !(xNode.dataset.grammalecte_button && xNode.dataset.grammalecte_button == "false"))
},
_prepareButtons: function (oOptions) {
if (oOptions.hasOwnProperty("ui_options")) {
this.oOptions = oOptions.ui_options;
// textarea
if (this.oOptions && this.oOptions.textarea) {
for (let xNode of document.getElementsByTagName("textarea")) {
if (this._isEligibleNode(xNode) && xNode.getAttribute("spellcheck") !== "false") {
this.lButton.push(new GrammalecteButton(this.nButton, xNode));
this.nButton += 1;
}
}
}
// editable nodes
if (this.oOptions && this.oOptions.editablenode) {
for (let xNode of document.querySelectorAll("[contenteditable]")) {
if (this._isEligibleNode(xNode)) {
this.lButton.push(new GrammalecteButton(this.nButton, xNode));
this.nButton += 1;
}
}
}
}
},
observePage: function () {
// When a textarea is added via jascript we add the buttons
let that = this;
this.xObserver = new MutationObserver(function (lMutations) {
lMutations.forEach(function (xMutation) {
if (that.oOptions) {
for (let i = 0; i < xMutation.addedNodes.length; i++) {
let xNode = xMutation.addedNodes[i];
if (((xNode.tagName == "TEXTAREA" && that.oOptions.textarea && xNode.getAttribute("spellcheck") !== "false") || (xNode.isContentEditable && that.oOptions.editablenode))
&& that._isEligibleNode(xNode)) {
oGrammalecte.lButton.push(new GrammalecteButton(oGrammalecte.nButton, xNode));
oGrammalecte.nButton += 1;
}
else if (xNode.getElementsByTagName && that.oOptions.textarea) {
for (let xNode of xNode.getElementsByTagName("textarea")) {
if (that._isEligibleNode(xNode) && xNode.getAttribute("spellcheck") !== "false") {
oGrammalecte.lButton.push(new GrammalecteButton(oGrammalecte.nButton, xNode));
oGrammalecte.nButton += 1;
}
}
}
else if (xNode.querySelectorAll && that.oOptions.editablenode) {
for (let xNode of document.querySelectorAll("[contenteditable]")) {
if (that._isEligibleNode(xNode)) {
oGrammalecte.lButton.push(new GrammalecteButton(oGrammalecte.nButton, xNode));
oGrammalecte.nButton += 1;
}
}
}
}
}
});
});
this.xObserver.observe(document.body, { childList: true, subtree: true });
},
rescanPage: function () {
if (this.oTFPanel !== null) { this.oTFPanel.hide(); }
if (this.oGCPanel !== null) { this.oGCPanel.hide(); }
for (let oMenu of this.lButton) {
oMenu.deleteNodes();
}
this.lButton.length = 0; // to clear an array
this.listenRightClick();
this.createButtons();
},
createTFPanel: function () {
if (this.oTFPanel === null) {
this.oTFPanel = new GrammalecteTextFormatter("grammalecte_tf_panel", "Formateur de texte", 760, 595, false);
this.oTFPanel.insertIntoPage();
}
},
createGCPanel: function () {
if (this.oGCPanel === null) {
this.oGCPanel = new GrammalecteGrammarChecker("grammalecte_gc_panel", "Grammalecte", 540, 950);
this.oGCPanel.insertIntoPage();
}
},
createMessageBox: function () {
if (this.oMessageBox === null) {
this.oMessageBox = new GrammalecteMessageBox("grammalecte_message_box", "Grammalecte");
this.oMessageBox.insertIntoPage();
}
},
startGCPanel: function (what, bCheckText=true) {
this.createGCPanel();
this.oGCPanel.clear();
this.oGCPanel.show();
this.oGCPanel.showEditor();
this.oGCPanel.start(what);
this.oGCPanel.startWaitIcon();
if (what && bCheckText) {
let sText = this.oGCPanel.oTextControl.getText();
oGrammalecteBackgroundPort.parseAndSpellcheck(sText, "__GrammalectePanel__");
}
},
showMessage: function (sMessage) {
this.createMessageBox();
this.oMessageBox.show();
this.oMessageBox.setMessage(sMessage);
},
getPageText: function () {
let sPageText = document.body.innerText;
let nPos = sPageText.indexOf("__grammalecte_panel__");
if (nPos >= 0) {
sPageText = sPageText.slice(0, nPos).normalize("NFC");
}
return sPageText;
},
createNode: function (sType, oAttr, oDataset=null) {
try {
let xNode = document.createElement(sType);
Object.assign(xNode, oAttr);
if (oDataset) {
Object.assign(xNode.dataset, oDataset);
}
return xNode;
}
catch (e) {
showError(e);
}
},
createStyle: function (sLinkCss, sLinkId=null, xNodeToAppendTo=null) {
try {
let xNode = document.createElement("link");
Object.assign(xNode, {
rel: "stylesheet",
type: "text/css",
media: "all",
href: this.sExtensionUrl + sLinkCss
});
if (sLinkId) {
Object.assign(xNode, {id: sLinkId});
}
if (xNodeToAppendTo) {
xNodeToAppendTo.appendChild(xNode);
}
return xNode;
}
catch (e) {
showError(e);
}
},
getCaretPosition (xElement) {
// JS awfulness again.
// recepie from https://stackoverflow.com/questions/4811822/get-a-ranges-start-and-end-offsets-relative-to-its-parent-container
let nCaretOffsetStart = 0;
let nCaretOffsetEnd = 0;
let xSelection = window.getSelection();
if (xSelection.rangeCount > 0) {
let xRange = xSelection.getRangeAt(0);
let xPreCaretRange = xRange.cloneRange();
xPreCaretRange.selectNodeContents(xElement);
xPreCaretRange.setEnd(xRange.endContainer, xRange.endOffset);
nCaretOffsetStart = xPreCaretRange.toString().length;
nCaretOffsetEnd = nCaretOffsetStart + xRange.toString().length;
}
return [nCaretOffsetStart, nCaretOffsetEnd];
// for later: solution with multilines text
// https://stackoverflow.com/questions/4811822/get-a-ranges-start-and-end-offsets-relative-to-its-parent-container/4812022
},
setCaretPosition (xElement, nCaretOffsetStart, nCaretOffsetEnd) {
// JS awfulness again.
// recipie from https://stackoverflow.com/questions/6249095/how-to-set-caretcursor-position-in-contenteditable-element-div
let iChar = 0;
let xRange = document.createRange();
xRange.setStart(xElement, 0);
xRange.collapse(true);
let lNode = [xElement];
let xNode;
let bFoundStart = false;
let bStop = false;
while (!bStop && (xNode = lNode.pop())) {
if (xNode.nodeType == 3) { // Node.TEXT_NODE
let iNextChar = iChar + xNode.length;
if (!bFoundStart && nCaretOffsetStart >= iChar && nCaretOffsetStart <= iNextChar) {
xRange.setStart(xNode, nCaretOffsetStart - iChar);
bFoundStart = true;
}
if (bFoundStart && nCaretOffsetEnd >= iChar && nCaretOffsetEnd <= iNextChar) {
xRange.setEnd(xNode, nCaretOffsetEnd - iChar);
bStop = true;
}
iChar = iNextChar;
} else {
let i = xNode.childNodes.length;
while (i--) {
lNode.push(xNode.childNodes[i]);
}
}
}
let xSelection = window.getSelection();
xSelection.removeAllRanges();
xSelection.addRange(xRange);
}
};
function autoRefreshOption (oSavedOptions=null) {
// auto recallable function
if (oSavedOptions === null) {
if (bChrome) {
browser.storage.local.get("autorefresh_option", autoRefreshOption);
return;
}
browser.storage.local.get("autorefresh_option").then(autoRefreshOption, showError);
}
else if (oSavedOptions.hasOwnProperty("autorefresh_option")) {
oGrammalecte.bAutoRefresh = oSavedOptions["autorefresh_option"];
}
}
autoRefreshOption();
/*
Connexion to the background
*/
const oGrammalecteBackgroundPort = {
xConnect: browser.runtime.connect({name: "content-script port"}),
/*
Send messages to the background
object {
sCommand: the action to perform
oParam: parameters necessary for the execution of the action
oInfo: all kind of informations that needs to be sent back (usually to know where to use the result)
}
*/
parseAndSpellcheck: function (sText, sDestination) {
this.xConnect.postMessage({
sCommand: "parseAndSpellcheck",
oParam: { sText: sText, sCountry: "FR", bDebug: false, bContext: false },
oInfo: { sDestination: sDestination }
});
},
parseAndSpellcheck1: function (sText, sDestination, sParagraphId) {
this.xConnect.postMessage({
sCommand: "parseAndSpellcheck1",
oParam: { sText: sText, sCountry: "FR", bDebug: false, bContext: false },
oInfo: { sDestination: sDestination, sParagraphId: sParagraphId }
});
},
getListOfTokens: function (sText) {
this.xConnect.postMessage({ sCommand: "getListOfTokens", oParam: { sText: sText }, oInfo: {} });
},
parseFull: function (sText) {
this.xConnect.postMessage({
sCommand: "parseFull",
oParam: { sText: sTex, sCountry: "FR", bDebug: false, bContext: false },
oInfo: {}
});
},
getVerb: function (sVerb, bStart=true, bPro=false, bNeg=false, bTpsCo=false, bInt=false, bFem=false) {
this.xConnect.postMessage({
sCommand: "getVerb",
oParam: { sVerb: sVerb, bPro: bPro, bNeg: bNeg, bTpsCo: bTpsCo, bInt: bInt, bFem: bFem },
oInfo: { bStart: bStart }
});
},
getSpellSuggestions: function (sWord, sDestination, sErrorId) {
this.xConnect.postMessage({ sCommand: "getSpellSuggestions", oParam: { sWord: sWord }, oInfo: { sDestination: sDestination, sErrorId: sErrorId } });
},
openURL: function (sURL) {
this.xConnect.postMessage({ sCommand: "openURL", oParam: { "sURL": sURL }, oInfo: null });
},
openLexiconEditor: function () {
this.xConnect.postMessage({ sCommand: "openLexiconEditor", oParam: null, oInfo: null });
},
restartWorker: function (nTimeDelay=10) {
this.xConnect.postMessage({ sCommand: "restartWorker", oParam: { "nTimeDelay": nTimeDelay }, oInfo: {} });
},
/*
Messages from the background
*/
listen: function () {
this.xConnect.onMessage.addListener(function (oMessage) {
let {sActionDone, result, oInfo, bEnd, bError} = oMessage;
switch (sActionDone) {
case "init":
oGrammalecte.sExtensionUrl = oMessage.sUrl;
oGrammalecte.listenRightClick();
oGrammalecte.createButtons();
oGrammalecte.observePage();
break;
case "parseAndSpellcheck":
if (oInfo.sDestination == "__GrammalectePanel__") {
if (!bEnd) {
oGrammalecte.oGCPanel.addParagraphResult(result);
} else {
oGrammalecte.oGCPanel.stopWaitIcon();
oGrammalecte.oGCPanel.endTimer();
}
}
else if (oInfo.sDestination && document.getElementById(oInfo.sDestination)) {
const xEvent = new CustomEvent("GrammalecteResult", { detail: JSON.stringify({ sType: "proofreading", oResult: result, oInfo: oInfo }) });
document.getElementById(oInfo.sDestination).dispatchEvent(xEvent);
}
break;
case "parseAndSpellcheck1":
if (oInfo.sDestination == "__GrammalectePanel__") {
oGrammalecte.oGCPanel.refreshParagraph(oInfo.sParagraphId, result);
}
break;
case "parseFull":
// TODO
break;
case "getListOfTokens":
if (!bEnd) {
oGrammalecte.oGCPanel.addListOfTokens(result);
} else {
oGrammalecte.oGCPanel.stopWaitIcon();
oGrammalecte.oGCPanel.endTimer();
}
break;
case "getSpellSuggestions":
if (oInfo.sDestination == "__GrammalectePanel__") {
oGrammalecte.oGCPanel.oTooltip.setSpellSuggestionsFor(result.sWord, result.aSugg, result.iSuggBlock, oInfo.sErrorId);
}
else if (oInfo.sDestination && document.getElementById(oInfo.sDestination)) {
const xEvent = new CustomEvent("GrammalecteResult", { detail: JSON.stringify({ sType: "spellsugg", oResult: result, oInfo: oInfo }) });
document.getElementById(oInfo.sDestination).dispatchEvent(xEvent);
}
break;
case "getVerb":
if (oInfo.bStart) {
oGrammalecte.oGCPanel.conjugateWith(result.oVerb, result.oConjTable);
} else {
oGrammalecte.oGCPanel.displayConj(result.oConjTable);
}
break;
case "workerRestarted":
oGrammalecte.oGCPanel.stopWaitIcon();
oGrammalecte.oGCPanel.showMessage("Le serveur grammatical a été arrêté et relancé.");
oGrammalecte.oGCPanel.endTimer();
break;
/*
Commands received from the context menu
(Context menu are initialized in background)
*/
// Grammar checker commands
case "grammar_checker_editable":
if (oGrammalecte.xRightClickedNode !== null) {
oGrammalecte.startGCPanel(oGrammalecte.xRightClickedNode);
} else {
oGrammalecte.showMessage("Erreur. Le node sur lequel vous avez cliqué n’a pas pu être identifié. Sélectionnez le texte à corriger et relancez le correcteur via le menu contextuel.");
}
break;
case "grammar_checker_page":
oGrammalecte.startGCPanel(oGrammalecte.getPageText());
break;
case "grammar_checker_selection":
oGrammalecte.startGCPanel(result, false); // result is the selected text
// selected text is sent to the GC worker in the background script.
break;
case "grammar_checker_iframe":
console.log("[Grammalecte] selected iframe: ", result);
if (document.activeElement.tagName == "IFRAME") {
//console.log(document.activeElement.id); frameId given by result is different than frame.id
oGrammalecte.startGCPanel(document.activeElement);
} else {
oGrammalecte.showMessage("Erreur. Le cadre sur lequel vous avez cliqué n’a pas pu être identifié. Sélectionnez le texte à corriger et relancez le correcteur via le menu contextuel.");
}
break;
// rescan page command
case "rescanPage":
oGrammalecte.rescanPage();
break;
default:
console.log("[Content script] Unknown command: " + sActionDone);
}
});
},
/*
Other messages from background
*/
listen2: function () {
browser.runtime.onMessage.addListener(function (oMessage) {
let {sActionRequest} = oMessage;
let xActiveNode = document.activeElement;
switch (sActionRequest) {
/*
Commands received from the keyboard (shortcuts)
*/
case "shortcutGrammarChecker":
if (xActiveNode && (xActiveNode.tagName == "TEXTAREA" || xActiveNode.tagName == "INPUT" || xActiveNode.isContentEditable)) {
oGrammalecte.startGCPanel(xActiveNode);
} else {
oGrammalecte.startGCPanel(oGrammalecte.getPageText());
}
break;
default:
console.log("[Content script] Unknown command: " + sActionDone);
}
});
}
}
oGrammalecteBackgroundPort.listen()
oGrammalecteBackgroundPort.listen2()
/*
Callable API for the webpage.
The API script must be injected this way to be callable by the page
*/
let xScriptGrammalecteAPI = document.createElement("script");
xScriptGrammalecteAPI.src = browser.extension.getURL("content_scripts/api.js");
document.documentElement.appendChild(xScriptGrammalecteAPI);
document.addEventListener("GrammalecteCall", function (xEvent) {
// GrammalecteCall events are dispatched by functions in the API script
try {
let oCommand = xEvent.detail;
switch (oCommand.sCommand) {
case "openPanelForNode":
if (oCommand.xNode) {
oGrammalecte.startGCPanel(oCommand.xNode);
}
break;
case "openPanelForText":
if (oCommand.sText) {
oGrammalecte.startGCPanel(oCommand.sText);
}
break;
case "parseNode":
if (oCommand.xNode && oCommand.xNode.id) {
if (oCommand.xNode.tagName == "TEXTAREA" || oCommand.xNode.tagName == "INPUT") {
oGrammalecteBackgroundPort.parseAndSpellcheck(oCommand.xNode.value, oCommand.xNode.id);
}
else if (oCommand.xNode.tagName == "IFRAME") {
oGrammalecteBackgroundPort.parseAndSpellcheck(oCommand.xNode.contentWindow.document.body.innerText, oCommand.xNode.id);
}
else {
oGrammalecteBackgroundPort.parseAndSpellcheck(oCommand.xNode.innerText, oCommand.xNode.id);
}
}
break;
case "getSpellSuggestions":
if (oCommand.sWord) {
oGrammalecteBackgroundPort.getSpellSuggestions(oCommand.sWord, oCommand.sDestination, oCommand.sErrorId);
}
break;
default:
console.log("[Grammalecte] Event: Unknown command", oCommand.sCommand);
}
}
catch (e) {
showError(e);
}
});
/*
Note:
Initialization starts when the background is connected.
See: oGrammalecteBackgroundPort.listen() -> case "init"
*/