Migrate to extension Manifest v3 for Chromium #755 (#984)

Both MV2 and MV3 are built for Chromium. Only MV2 for Firefox for now (until Service Workers are supported as backgroundscript.js).

.eslintrc.cjs

@@ -17,6 +17,8 @@ module.exports = {
         'no-extra-parens': 1,
         'no-unused-expressions': 1,
         'no-unused-vars': 1,
-        'n/no-callback-literal': 0
+        'n/no-callback-literal': 0,
+        'object-shorthand': 0,
+        'multiline-ternary': 0
     }
 }

CONTRIBUTING.md

@@ -19,11 +19,11 @@ Please follow these guidelines when contributing:
   - be sure to test your fix in both "JQuery" mode and "Service Worker" mode (see Configuration);
   - run the Unit tests (see below) in at least the above browsers.
 
-If all the tests are working fine, you can finally test the extension versions, like this:
+If all the tests are working fine, you can finally test the extension versions. Plese note that we are using Manifest V3 for the Chromium extensions, and Manifest V2
+for the Firefox extension, so there are different instructions for the two browser families:
 
-  - Remove the '-WIP' from the version key from the manifest.json file present in the root of this repo;
   - In Chromium, you can install the extension by loading the root folder with Extensions -> Load Unpacked (with Developer Mode turned ON) -> select the root folder of the repository;
-  - In Firefox, you can load an extension with Manage Your Extensions -> Debug Add-ons -> Load Temporary Add-on, and then pick any file in the repository.
+  - In Firefox, you need to rename manifest.json to manifest.v3.json, and then rename manifest.v2.json to manifest.json. Then you can load the extension with Manage Your Extensions -> Debug Add-ons -> Load Temporary Add-on, and then pick any file in the repository.
 
 If your feature works and tests are passing, make a PR, describe the testing you have done, and ask for a code review.
 

webextension/backgroundscript.js → backgroundscript.js

@@ -1,5 +1,5 @@
 /**
- * backgroundscript.js: Background script for the WebExtension
+ * backgroundscript.js: Background script for the WebExtension Manifest V2
  *
  * Copyright 2017 Mossroy and contributors
  * License GPL v3:
@@ -20,22 +20,20 @@
  * along with Kiwix (file LICENSE-GPLv3.txt).  If not, see <http://www.gnu.org/licenses/>
  */
 
+/* global chrome, browser */
+
 // In order to work on both Firefox and Chromium/Chrome (and derivatives).
 // browser and chrome variables expose almost the same APIs
 var genericBrowser;
 if (typeof browser !== 'undefined') {
     // Firefox
     genericBrowser = browser;
-}
-else {
+} else {
     // Chromium/Chrome
     genericBrowser = chrome;
 }
 
-genericBrowser.browserAction.onClicked.addListener(handleClick);
-
-function handleClick(event) {
-    genericBrowser.tabs.create({
-        url: genericBrowser.runtime.getURL('/www/index.html')
-    });
-}
+genericBrowser.browserAction.onClicked.addListener(function () {
+    var newURL = chrome.runtime.getURL('www/index.html');
+    chrome.tabs.create({ url: newURL });
+});

manifest.json

@@ -1,9 +1,9 @@
 {
-    "manifest_version": 2,
+    "manifest_version": 3,
     "name": "Kiwix",
     "version": "3.8.1",
 
-    "description": "Kiwix : offline Wikipedia reader",
+    "description": "Kiwix Offline Browser",
 
     "icons": {
         "16": "www/img/icons/kiwix-16.png",
@@ -16,7 +16,7 @@
         "128": "www/img/icons/kiwix-128.png"
     },
 
-    "browser_action": {
+    "action": {
         "default_icon": {
             "16": "www/img/icons/kiwix-16.png",
             "19": "www/img/icons/kiwix-19.png",
@@ -26,22 +26,24 @@
         },
         "default_title": "Kiwix"
     },
-
-    "applications": {
-        "gecko": {
-            "id": "[email protected]"
-        }
-    },
-
-    "web_accessible_resources": ["www/index.html"],
 
     "background": {
-        "scripts": ["webextension/backgroundscript.js"]
+        "service_worker": "service-worker.js"
     },
 
-    "content_security_policy": "script-src 'self' 'unsafe-eval'; object-src 'self'",
+    "permissions": ["storage", "activeTab", "scripting"],
 
-    "author": "mossroy",
+    "content_security_policy": {
+        "extension_pages": "script-src 'self' 'wasm-unsafe-eval'; object-src 'self';",
+        "sandbox": "sandbox allow-scripts allow-downloads allow-forms allow-popups allow-modals; script-src 'self' 'unsafe-inline' 'unsafe-eval'; child-src 'self';"
+    },
+
+    "web_accessible_resources": [{
+        "resources": ["www/index.html", "www/article.html"],
+        "matches": ["https://*.kiwix.org/*"]
+    }],
+
+    "author": "Kiwix",
     "homepage_url": "https://www.kiwix.org",
     "offline_enabled": true
 }

manifest.v2.json

@@ -0,0 +1,47 @@
+{
+    "manifest_version": 2,
+    "name": "Kiwix",
+    "version": "3.8.1",
+
+    "description": "Kiwix : offline Wikipedia reader",
+
+    "icons": {
+        "16": "www/img/icons/kiwix-16.png",
+        "19": "www/img/icons/kiwix-19.png",
+        "32": "www/img/icons/kiwix-32.png",
+        "38": "www/img/icons/kiwix-38.png",
+        "48": "www/img/icons/kiwix-48.png",
+        "64": "www/img/icons/kiwix-64.png",
+        "90": "www/img/icons/kiwix-90.png",
+        "128": "www/img/icons/kiwix-128.png"
+    },
+
+    "browser_action": {
+        "default_icon": {
+            "16": "www/img/icons/kiwix-16.png",
+            "19": "www/img/icons/kiwix-19.png",
+            "32": "www/img/icons/kiwix-32.png",
+            "38": "www/img/icons/kiwix-38.png",
+            "64": "www/img/icons/kiwix-64.png"
+        },
+        "default_title": "Kiwix"
+    },
+
+    "applications": {
+        "gecko": {
+            "id": "[email protected]"
+        }
+    },
+
+    "web_accessible_resources": ["www/index.html"],
+
+    "background": {
+        "scripts": ["backgroundscript.js"]
+    },
+
+    "content_security_policy": "script-src 'self' 'unsafe-eval'; object-src 'self'",
+
+    "author": "mossroy",
+    "homepage_url": "https://www.kiwix.org",
+    "offline_enabled": true
+}

scripts/create_all_packages.sh

@@ -55,7 +55,7 @@ fi
 # Copy only the necessary files in a temporary directory
 mkdir -p tmp
 rm -rf tmp/*
-cp -r www webextension manifest.json manifest.webapp LICENSE-GPLv3.txt service-worker.js README.md tmp/
+cp -r www manifest.json manifest.v2.json manifest.webapp LICENSE-GPLv3.txt service-worker.js README.md tmp/
 # Remove unwanted files
 rm -f tmp/www/js/lib/libzim-*dev.*
 
@@ -64,26 +64,37 @@ rm -f tmp/www/js/lib/libzim-*dev.*
 regexpNumericVersion='^[0-9\.]+$'
 if [[ $VERSION =~ $regexpNumericVersion ]] ; then
    sed -i -e "s/$VERSION_TO_REPLACE/$VERSION/" tmp/manifest.json
+   sed -i -e "s/$VERSION_TO_REPLACE/$VERSION/" tmp/manifest.v2.json
 else
    sed -i -e "s/$VERSION_TO_REPLACE/$MAJOR_NUMERIC_VERSION/" tmp/manifest.json
+   sed -i -e "s/$VERSION_TO_REPLACE/$MAJOR_NUMERIC_VERSION/" tmp/manifest.v2.json
 fi
 sed -i -e "s/$VERSION_TO_REPLACE/$VERSION/" tmp/manifest.webapp
 sed -i -e "s/$VERSION_TO_REPLACE/$VERSION/" tmp/service-worker.js
 sed -i -e "s/$VERSION_TO_REPLACE/$VERSION/" tmp/www/js/app.js
 
 mkdir -p build
 rm -rf build/*
-# Package for Chromium/Chrome
-scripts/package_chrome_extension.sh $DRYRUN $TAG -v $VERSION
+# Package for Chromium/Chrome with Manifest V3
+scripts/package_chrome_extension.sh -m 3 $DRYRUN $TAG -v $VERSION
+# Package for Chromium/Chrome with Manifest V2
+cp backgroundscript.js tmp/
+rm tmp/manifest.json
+mv tmp/manifest.v2.json tmp/manifest.json
+scripts/package_chrome_extension.sh -m 2 $DRYRUN $TAG -v $VERSION
+
 # Package for Firefox and Firefox OS
 # We have to put a unique version string inside the manifest.json (which Chrome might not have accepted)
-# So we take the original manifest again, and replace the version inside it again
-cp manifest.json tmp/
+# So we take the original manifest v2 again, and replace the version inside it again
+cp manifest.v2.json tmp/manifest.json
 sed -i -e "s/$VERSION_TO_REPLACE/$VERSION_FOR_MOZILLA_MANIFEST/" tmp/manifest.json
+echo ""
 scripts/package_firefox_extension.sh $DRYRUN $TAG -v $VERSION
+echo ""
 scripts/package_firefoxos_app.sh $DRYRUN $TAG -v $VERSION
 cp -f ubuntu_touch/* tmp/
 sed -i -e "s/$VERSION_TO_REPLACE/$VERSION/" tmp/manifest.json
+echo ""
 scripts/package_ubuntu_touch_app.sh $DRYRUN $TAG -v $VERSION
 
 # Change permissions on source files to match those expected by the server

scripts/package_chrome_extension.sh

@@ -3,19 +3,23 @@ BASEDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"/..
 cd "$BASEDIR"
 
 # Reading arguments
-while getopts tdv: option; do
+while getopts m:tdv: option; do
     case "${option}" in
+        m) MV=$OPTARG;; # Optionally indicates the manifest version we're using (2 or 3); if present, the version will be added to filename
         t) TAG="-t";; # Indicates that we're releasing a public version from a tag
         d) DRYRUN="-d";; # Indicates a dryrun test, that does not modify anything on the network
         v) VERSION=${OPTARG};;
     esac
 done
-
+if [ -n $MV ]; then
+    echo -e "\nManifest version requested: $MV"
+    VERSION="MV$MV-$VERSION"
+fi
 echo "Packaging unsigned Chrome extension, version $VERSION"
 cd tmp
-zip -r ../build/kiwix-chrome-unsigned-extension-$VERSION.zip www webextension manifest.json LICENSE-GPLv3.txt service-worker.js README.md
+zip -r ../build/kiwix-chrome-unsigned-extension-$VERSION.zip www manifest.json LICENSE-GPLv3.txt service-worker.js README.md
 cd ..
-if [ "${TAG}zz" == "zz" ]; then
+if [ -z $TAG ]; then
     # Package the extension with Chrome or Chromium, if we're not packaging a public version
     if hash chromium-browser 2>/dev/null
     then
@@ -28,6 +32,7 @@ if [ "${TAG}zz" == "zz" ]; then
     echo "Signing the extension for $CHROME_BIN, version $VERSION"
     $CHROME_BIN --no-sandbox --pack-extension=tmp --pack-extension-key=./scripts/kiwix-html5.pem
     mv tmp.crx build/kiwix-chrome-signed-extension-$VERSION.crx
+    ls -l build/kiwix-chrome-signed-extension-$VERSION.crx
 else
     echo "This unsigned extension must be manually uploaded to Google to be signed and distributed from their store"
 fi