rework background js stuff and manifest

Author: Siedlerchr

background.js

@@ -1,57 +1,44 @@
-/*
-    Initialize
-*/
-Zotero.Debug.init(1)
-// Zotero.Repo.init()
-Zotero.Messaging.init()
-Zotero.Connector_Types.init()
-Zotero.Translators.init()
-zsc.init()
-//wsClient.startClient(); // TODO: don't start websocket client, until JabRef's counterpart is integrated
-
-this.tabInfo = new Map()
-
-/*
-    Show/hide import button for all tabs (when add-on is loaded).
-*/
-browser.tabs.query({}).then((tabs) => {
-    // We wait a bit before injection to give Zotero time to load the translators
-    setTimeout(() => {
-        console.log('JabRef: Inject into open tabs %o', tabs)
-        for (let tab of tabs) {
-            installInTab(tab)
+const isFirefox = typeof browser !== 'undefined';
+const browserAPI = isFirefox ? browser : chrome;
+const actionAPI = isFirefox ? browserAPI.pageAction : browserAPI.action;
+
+// Initialize the translator framework
+init = async function() {
+    Zotero.Debug.init(1);
+    await Zotero.Connector_Browser.init();
+    await Zotero.Messaging.init();
+    await Zotero.Translators.init();
+    zsc.init();
+    
+    this.tabInfo = new Map();
+    
+    // Register message listeners
+    Zotero.Messaging.addMessageListener('Connector_Browser.onTranslators', onTranslators);
+    browserAPI.tabs.onUpdated.addListener(onTabUpdated);
+    browserAPI.tabs.onRemoved.addListener(Zotero.Connector_Browser.onPageLoad);
+    
+    // Initialize existing tabs
+    const tabs = await browserAPI.tabs.query({});
+    for (let tab of tabs) {
+        if (!isDisabledForURL(tab.url)) {
+            await installInTab(tab);
         }
-    }, 1500)
-})
-
-/*
-    Show/hide import button for the currently active tab, whenever the user navigates.
-*/
-browser.tabs.onUpdated.addListener((tabId, changeInfo, tab) => {
-    if (!changeInfo.url) {
-        return
     }
-    browser.tabs
-        .query({
-            active: true,
-            currentWindow: true,
-        })
-        .then((tabs) => {
-            if (tabId === tabs[0].id) {
-                var tab = tabs[0]
-
-                // Clear old translator information
-                Zotero.Connector_Browser.onPageLoad(tab)
-
-                installInTab(tab)
-            }
-        })
-})
+}
 
-/*
-    Remove translator information when tab is closed.
-*/
-browser.tabs.onRemoved.addListener(Zotero.Connector_Browser.onPageLoad)
+function onTabUpdated(tabId, changeInfo, tab) {
+    if (!changeInfo.url) return;
+    
+    browserAPI.tabs.query({
+        active: true,
+        currentWindow: true
+    }).then(tabs => {
+        if (tabId === tabs[0].id) {
+            Zotero.Connector_Browser.onPageLoad(tab);
+            installInTab(tab);
+        }
+    });
+}
 
 /*
     Disable add-on for special browser pages
@@ -64,64 +51,43 @@ function isDisabledForURL(url) {
     )
 }
 
-/*
-    Searches for translators for the given tab and shows/hides the import button accordingly.
-*/
-function installInTab(tab) {
-    if (isDisabledForURL(tab.url)) {
-        return
+async function installInTab(tab) {
+    if (isDisabledForURL(tab.url)) return;
+    
+    tabInfo.delete(tab.id);
+    
+    try {
+        await browserAPI.tabs.executeScript(tab.id, { code: 'document.contentType' });
+        await lookForTranslators(tab);
+        tabInfo.set(tab.id, { isPDF: false });
+    } catch (error) {
+        console.debug(`JabRef: PDF detection - ${error}`);
+        actionAPI.show(tab.id);
+        actionAPI.setTitle({
+            tabId: tab.id,
+            title: 'Import references into JabRef as PDF'
+        });
+        tabInfo.set(tab.id, { isPDF: true });
     }
-
-    // Reset tab info
-    tabInfo.delete(tab.id)
-
-    // We cannot inject content scripts into PDF: https://bugzilla.mozilla.org/show_bug.cgi?id=1454760
-    // Thus, our detection algorithm silently fails in this case, as the Inject#init is never called
-    // Try to detect these situations by calling a content script; this fails
-    browser.tabs
-        .executeScript(tab.id, {
-            code: 'document.contentType',
-        })
-        .then((result) => {
-            lookForTranslators(tab)
-            tabInfo.set(tab.id, { isPDF: false })
-        })
-        .catch((error) => {
-            console.debug(`JabRef: Error calling content script: ${error}`)
-
-            // Assume a PDF is displayed in this tab
-            browser.pageAction.show(tab.id)
-            browser.pageAction.setTitle({
-                tabId: tab.id,
-                title: 'Import references into JabRef as PDF',
-            })
-            tabInfo.set(tab.id, { isPDF: true })
-        })
 }
 
 function lookForTranslators(tab) {
-    console.log('JabRef: Searching for translators for %o', tab)
-    Zotero.Translators.getWebTranslatorsForLocation(tab.url, tab.url).then(
+    console.log('JabRef: Searching for translators for %o', tab);
+    return Zotero.Translators.getWebTranslatorsForLocation(tab.url, tab.url).then(
         (translators) => {
             if (translators[0].length === 0) {
-                // No translators found, so hide button
-                console.log('JabRef: No translators found')
-                browser.pageAction.hide(tab.id)
+                console.log('JabRef: No translators found');
+                actionAPI.hide(tab.id);
             } else {
-                // Potential translators found, Zotero will check if these can detect something on the website.
-                // We will be notified about the result of this check using the `onTranslators` method below, so nothing to do here.
-                console.log(
-                    'JabRef: Found potential translators %o',
-                    translators[0]
-                )
+                console.log('JabRef: Found potential translators %o', translators[0]);
             }
         }
-    )
+    );
 }
 
 async function evalInTab(tabsId, code) {
     try {
-        result = await browser.tabs.executeScript(tabsId, {
+        result = await browserAPI.tabs.executeScript(tabsId, {
             code: code,
         })
         console.log(`JabRef: code executed with result ${result}`)
@@ -131,7 +97,6 @@ async function evalInTab(tabsId, code) {
     }
 }
 
-
 saveAsWebpage = function (tab) {
     var title = tab.title
     var url = tab.url
@@ -173,14 +138,14 @@ onTranslators = function (translators, tabId, contentType) {
             JSON.parse(JSON.stringify(tabId))
         )
         tabInfo.set(tabId, { ...tabInfo.get(tabId), hasTranslator: false })
-        browser.pageAction.setIcon({
+        actionAPI.setIcon({
             tabId: tabId, path: {
                 "48": "data/JabRef-icon-48.png",
                 "96": "data/JabRef-icon-96.png"
             }
         })
-        browser.pageAction.show(tabId)
-        browser.pageAction.setTitle({
+        actionAPI.show(tabId)
+        actionAPI.setTitle({
             tabId: tabId,
             title:
                 'Import simple website reference into JabRef',
@@ -192,85 +157,39 @@ onTranslators = function (translators, tabId, contentType) {
             JSON.parse(JSON.stringify(tabId))
         )
         tabInfo.set(tabId, { ...tabInfo.get(tabId), hasTranslator: true })
-        browser.pageAction.setIcon({
+        actionAPI.setIcon({
             tabId: tabId, path: {
                 "48": "data/JabRef-icon-plus-48.png",
                 "96": "data/JabRef-icon-plus-96.png"
             }
         })
-        browser.pageAction.show(tabId)
-        browser.pageAction.setTitle({
+        actionAPI.show(tabId)
+        actionAPI.setTitle({
             tabId: tabId,
             title:
                 'Import references into JabRef using ' + translators[0].label,
         })
     }
 }
 
-browser.runtime.onMessage.addListener(function (message, sender, sendResponse) {
+browserAPI.runtime.onMessage.addListener((message, sender, sendResponse) => {
     if (message.popupOpened) {
-        // The popup opened, i.e. the user clicked on the page action button
-        console.log('JabRef: Popup opened confirmed')
-
-        browser.tabs
-            .query({
-                active: true,
-                currentWindow: true,
-            })
-            .then((tabs) => {
-                var tab = tabs[0]
-                var info = tabInfo.get(tab.id)
-
-                if (info && info.isPDF) {
-                    console.log(
-                        'JabRef: Export PDF in tab %o',
-                        JSON.parse(JSON.stringify(tab))
-                    )
-                    savePdf(tab)
-                } else if (info.hasTranslator === false) {
-                    console.log(
-                        'JabRef: No translation, simple saving %o',
-                        JSON.parse(JSON.stringify(tab))
-                    )
-                    saveAsWebpage(tab);
-                } else {
-                    console.log(
-                        'JabRef: Start translation for tab %o',
-                        JSON.parse(JSON.stringify(tab))
-                    )
-                    Zotero.Connector_Browser.saveWithTranslator(tab, 0)
-                }
-            })
+        handlePopupOpen();
     } else if (message.getWsClientState) {
-        console.debug('JabRef: wsClientState requested')
-        let wsClientState = {}
-        wsClientState.clientStarted = wsClient.isClientStarted()
-        wsClientState.connectionState = wsClient.getConnectionState()
-        sendResponse(wsClientState)
+        const wsClientState = {
+            clientStarted: wsClient.isClientStarted(),
+            connectionState: wsClient.getConnectionState()
+        };
+        sendResponse(wsClientState);
     } else if (message.eval) {
-        console.debug(
-            'JabRef: eval in background.js: %o',
-            JSON.parse(JSON.stringify(message.eval))
-        )
-        return evalInTab(sender.tab.id, message.eval)
-    } else if (message[0] === 'Connector_Browser.onTranslators') {
-        // Intercept message to Zotero background script
-        console.log(
-            'JabRef: Intercept message to Zotero background script',
-            JSON.parse(JSON.stringify(message))
-        )
-        message[1][1] = sender.tab.id
-        onTranslators.apply(null, message[1])
-    } else if (message[0] === 'Debug.log') {
-        console.log(message[1])
-    } else if (message[0] === 'Errors.log') {
-        console.log(message[1])
-    } else if (message[0] === 'Prefs.getAll') {
-        // Ignore, this is handled by Zotero
-    } else {
-        console.log(
-            'JabRef: other message in background.js: %o',
-            JSON.parse(JSON.stringify(message))
-        )
+        return evalInTab(sender.tab.id, message.eval);
+    } else if (Array.isArray(message) && message[0] === 'Connector_Browser.onTranslators') {
+        message[1][1] = sender.tab.id;
+        onTranslators.apply(null, message[1]);
+    } else if (['Debug.log', 'Errors.log'].includes(message[0])) {
+        console.log(message[1]);
     }
-})
+});
+
+// Initialize
+init();

gulpfile.js

@@ -55,6 +55,7 @@ gulp.task('copy-external-scripts', async function() {
 		// './zotero-connectors/src/common/connector.js', // backgroundInclude, we override this in our own connector.js file
 		'./zotero-connectors/src/common/repo.js', // backgroundInclude
 		'./zotero-connectors/src/common/utilities.js',
+		'./zotero-connectors/src/translate/src/promise.js',
 		'./zotero-connectors/src/translate/src/translation/translate_item.js',
 		'./zotero-connectors/src/common/translators.js', // backgroundInclude
 		'./zotero-connectors/src/common/inject/http.js',
@@ -77,6 +78,7 @@ gulp.task('copy-external-scripts', async function() {
 		'./zotero-connectors/src/utilities/utilities.js',
 		'./zotero-connectors/src/utilities/utilities_item.js',
 		'./zotero-connectors/src/utilities/schema.js',
+
 		'./zotero-connectors/src/translate/src/promise.js',
 		'./zotero-connectors/src/translate/src/debug.js',
 		'./zotero-connectors/src/translate/src/rdf/init.js',