Reorganize platform directory to avoid Chromium-centric appearance

Though Firefox shares a lot of WebExtensions code with Chromium, these platforms have their own specific code paths, for various reasons. The reorganization here makes it clear that Chromium platform is just one flavor of WebExtensions, and as such all Chromium-specific code paths should no longer be automatically pulled by other platforms where these code paths are not needed. Given that the filepath of many files changed, here is the parent commit to quickly browse back to the previous directory layout: ec7db30
gorhill · Jul 16, 2021 · a4aced6 · a4aced6
1 parent ec7db30
commit a4aced6
Show file tree

Hide file tree

Showing 16 changed files with 33 additions and 132 deletions.
diff --git a/platform/chromium/vapi-webrequest.js → platform/chromium/vapi-background-ext.js b/platform/chromium/vapi-webrequest.js → platform/chromium/vapi-background-ext.js
diff --git a/platform/chromium/managed_storage.json → platform/common/managed_storage.json b/platform/chromium/managed_storage.json → platform/common/managed_storage.json
diff --git a/platform/chromium/vapi-background.js → platform/common/vapi-background.js b/platform/chromium/vapi-background.js → platform/common/vapi-background.js
diff --git a/platform/chromium/vapi-client-extra.js → platform/common/vapi-client-extra.js b/platform/chromium/vapi-client-extra.js → platform/common/vapi-client-extra.js
diff --git a/platform/chromium/vapi-client.js → platform/common/vapi-client.js b/platform/chromium/vapi-client.js → platform/common/vapi-client.js
diff --git a/platform/chromium/vapi-common.js → platform/common/vapi-common.js b/platform/chromium/vapi-common.js → platform/common/vapi-common.js
diff --git a/platform/chromium/vapi.js → platform/common/vapi.js b/platform/chromium/vapi.js → platform/common/vapi.js
diff --git a/platform/firefox/vapi-webrequest.js → platform/firefox/vapi-background-ext.js b/platform/firefox/vapi-webrequest.js → platform/firefox/vapi-background-ext.js
diff --git a/platform/webext/README.md b/platform/webext/README.md
diff --git a/platform/webext/manifest.json b/platform/webext/manifest.json
diff --git a/src/background.html b/src/background.html
@@ -14,7 +14,7 @@
 <script src="js/vapi.js"></script>
 <script src="js/vapi-common.js"></script>
 <script src="js/vapi-background.js"></script>
-<script src="js/vapi-webrequest.js"></script><!-- Forks can pick the webext, chromium, or their own implementation -->
+<script src="js/vapi-background-ext.js"></script><!-- platform-specific to extend common code paths -->
 <script src="js/background.js"></script>
 <script src="js/traffic.js"></script>
 <script src="js/hntrie.js"></script>

diff --git a/tools/copy-common-files.sh b/tools/copy-common-files.sh
@@ -14,7 +14,6 @@ cp -R src/web_accessible_resources $DES/
 cp -R src/_locales                 $DES/
 
 cp src/*.html                      $DES/
-cp platform/chromium/*.js          $DES/js/
-cp platform/chromium/*.html        $DES/
-cp platform/chromium/*.json        $DES/
+cp platform/common/*.js            $DES/js/
+cp platform/common/*.json          $DES/
 cp LICENSE.txt                     $DES/
diff --git a/tools/make-chromium.sh b/tools/make-chromium.sh
@@ -8,9 +8,15 @@ DES=dist/build/uBlock0.chromium
 rm -rf $DES
 mkdir -p $DES
 
-echo "*** uBlock0.chromium: copying common files"
+echo "*** uBlock0.chromium: Copying common files"
 bash ./tools/copy-common-files.sh  $DES
 
+# Chromium-specific
+echo "*** uBlock0.chromium: Copying chromium-specific files"
+cp platform/chromium/*.js          $DES/js/
+cp platform/chromium/*.html        $DES/
+cp platform/chromium/*.json        $DES/
+
 # Chrome store-specific
 cp -R $DES/_locales/nb $DES/_locales/no
 

diff --git a/tools/make-firefox.sh b/tools/make-firefox.sh
@@ -9,14 +9,16 @@ DES="$BLDIR"/uBlock0.firefox
 rm -rf $DES
 mkdir -p $DES
 
-echo "*** uBlock0.firefox: copying common files"
+echo "*** uBlock0.firefox: Copying common files"
 bash ./tools/copy-common-files.sh  $DES
 
-cp -R $DES/_locales/nb                 $DES/_locales/no
+# Firefox-specific
+echo "*** uBlock0.firefox: Copying firefox-specific files"
+cp platform/firefox/*.json         $DES/
+cp platform/firefox/*.js           $DES/js/
 
-cp platform/firefox/manifest.json      $DES/
-cp platform/firefox/webext.js          $DES/js/
-cp platform/firefox/vapi-webrequest.js $DES/js/
+# Firefox store-specific
+cp -R $DES/_locales/nb             $DES/_locales/no
 
 # Firefox/webext-specific
 rm $DES/img/icon_128.png

diff --git a/tools/make-opera.sh b/tools/make-opera.sh
@@ -8,11 +8,18 @@ DES=dist/build/uBlock0.opera
 rm -rf $DES
 mkdir -p $DES
 
-echo "*** uBlock0.opera: copying common files"
+echo "*** uBlock0.opera: Copying common files"
 bash ./tools/copy-common-files.sh  $DES
 
+# Chromium-specific
+echo "*** uBlock0.opera: Copying chromium-specific files"
+cp platform/chromium/*.js          $DES/js/
+cp platform/chromium/*.html        $DES/
+
 # Opera-specific
-cp platform/opera/manifest.json $DES/
+echo "*** uBlock0.opera: Copying opera-specific files"
+cp platform/opera/manifest.json    $DES/
+
 rm -r $DES/_locales/az
 rm -r $DES/_locales/cv
 rm -r $DES/_locales/hi

diff --git a/tools/make-thunderbird.sh b/tools/make-thunderbird.sh
@@ -12,11 +12,14 @@ mkdir -p $DES
 echo "*** uBlock0.thunderbird: copying common files"
 bash ./tools/copy-common-files.sh  $DES
 
-cp -R $DES/_locales/nb                 $DES/_locales/no
+echo "*** uBlock0.firefox: Copying firefox-specific files"
+cp platform/firefox/*.js           $DES/js/
 
-cp platform/thunderbird/manifest.json  $DES/
-cp platform/firefox/webext.js          $DES/js/
-cp platform/firefox/vapi-webrequest.js $DES/js/
+echo "*** uBlock0.firefox: Copying thunderbird-specific files"
+cp platform/thunderbird/manifest.json $DES/
+
+# Firefox store-specific
+cp -R $DES/_locales/nb             $DES/_locales/no
 
 # Firefox/webext-specific
 rm $DES/img/icon_128.png