Add an updated build

.gitignore

@@ -1,14 +1,14 @@
 # See https://help.github.com/ignore-files/ for more about ignoring files.
 
 # dependencies
-/node_modules
+node_modules
+.web-extension-id
+web-ext-artifacts/
+sign-firefox-extension.sh
 
 # testing
 /coverage
 
-# production
-/build
-
 # misc
 .DS_Store
 .env

.gitmodules

@@ -1,4 +0,0 @@
-[submodule "rules"]
-	path = data
-	url = https://gitlab.com/anti-tracking/ClearURLs/rules.git
-	branch = master

README.md

@@ -1,10 +1,40 @@
-<a href="https://www.paypal.me/KevinRoebert" target="_blank"><img src="https://raw.githubusercontent.com/KevinRoebert/DonateButtons/master/Paypal.png" alt="Buy Me A Coffee" height="55"></a>
-<a href="https://liberapay.com/kroeb" target="_blank"><img src="https://raw.githubusercontent.com/KevinRoebert/DonateButtons/master/LiberaPay.png" alt="Buy Me A Coffee" height="55"></a>
-<a href="https://www.buymeacoffee.com/KevinRoebert" target="_blank"><img src="https://raw.githubusercontent.com/KevinRoebert/DonateButtons/master/BuyMeACoffee.png" alt="Buy Me A Coffee" height="55"></a>
+This is a fork of [ClearURLs/Addon](https://github.com/ClearURLs/Addon) with some modifications. The
+main change is moving the data/rule files to this repo instead of loading them from a gitlab page
+that the original author hosts. This removes the risk of a bad actor gaining control over that URL
+and making changes that lead to arbitrary code execution or redirecting your browser to arbitrary
+URLs.
 
-[<img src="https://blog.mozilla.org/addons/files/2020/04/get-the-addon-fx-apr-2020.svg" alt="for Firefox" height="60px">](https://addons.mozilla.org/firefox/addon/clearurls/) [<img src="https://gitlab.com/KevinRoebert/ClearUrls/-/raw/master/promotion/MEA-button.png" alt="for Edge" height="60px">](https://microsoftedge.microsoft.com/addons/detail/mdkdmaickkfdekbjdoojfalpbkgaddei) [<img src="https://storage.googleapis.com/chrome-gcs-uploader.appspot.com/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/HRs9MPufa1J1h5glNhut.png" alt="for Chrome" height="60px">](https://chrome.google.com/webstore/detail/clearurls/lckanjgmijmafbedllaakclkaicjfmnk)
+## Install
 
-# <sub><img src="https://gitlab.com/KevinRoebert/ClearUrls/raw/master/img/clearurls.svg" width="64px" height="64px"></sub> ClearURLs [![Gitter](https://badges.gitter.im/ClearURLs/ClearURLs.svg)](https://gitter.im/ClearURLs/ClearURLs)
+**Firefox**
+* I have a signed xpi that you can immediately install. Open `build/` and drag the xpi into Firefox.
+  It may take a few seconds for the browser to display the extension installation dialog box.
+* You can also find the signed Firefox files in the project's [Releases page](https://github.com/sir-pinecone/clear-urls-browser-extension/releases).
+
+**Chrome**
+* Go to Chrome extensions page.
+* Toggle the developer mode (top-right of page).
+* Click `Load unpacked`.
+* Select this project's root folder.
+
+## Development
+
+### Local Testing
+
+* Firefox: open about:debugging and click `Load Temporary Add-on...` then select `manifest.json` file.
+* Chrome: follow the install steps from above.
+
+## Signing and Building
+
+### Firefox
+* Install web-ext with `$ npm install --global web-ext`
+* Generate an unlisted xpi with:
+  `web-ext sign --api-key <your JWT issuer> --api-secret <your JWT secret>`
+    * You can obtain these keys from https://addons.mozilla.org/en-US/developers/addon/api/key/
+* The signed xpi will be in `web-ext-artifacts/`. Drag this into Firefox to install it.
+* Alternatively use the private sign-firefox-extension.sh script (not included in the repo) which places the xpi in `build/`.
+
+---
 
 **ClearURLs** is an add-on based on the new WebExtensions technology and is optimized for *Firefox* and *Chrome* based browsers.
 
@@ -39,55 +69,6 @@ Indeed most of the above URL is tracking code. Once ClearURLs has cleaned the ad
 ## Permissons
 Reasoning for needed permissions can be found under [here](https://gitlab.com/KevinRoebert/ClearUrls/issues/159).
 
-## Screenshot
-![Interface (version 1.14.0)](https://gitlab.com/KevinRoebert/ClearUrls/raw/master/promotion/screens/Popup_v_1.14.0.png)
-
-## CI/CD Artifacts Download (for Firefox- and Chrome-Dev only)
-Here you can download the packed files for the Firefox- and Chrome-Dev:
-
-[<img src="promotion/download-128.png"/>](https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/ClearUrls.zip?job=bundle%20addon)
-
-## Test
-If you want to test whether ClearURLs works correctly on your system, you can go to this test page: [https://test.clearurls.xyz/](https://test.clearurls.xyz/)
-
-## Contribute
-If you have any suggestions or complaints, please [create an issue.](https://gitlab.com/KevinRoebert/ClearUrls/issues/new)
-
-**Note: If you have any suggestions or complaints regarding the rules, please [create an issue in this repo](https://gitlab.com/anti-tracking/ClearURLs/rules/-/issues/new) or email us rules.support (at) clearurls.xyz (this mail will automatically create a new issue in this repo).**
-
-### Translate ClearURLs
-You want to help translating ClearURLs into many languages? – Nice
-
-You can choose between two options to contribute. You can create a merge request, or you can use the POEditor to translate ClearURLs.
-
-*Hint: The description field in the translation files are only an information for what the translation is used. 
-It is not necessary to translate the description field; in the most cases it is empty.*
-
-#### Merge request
-If you want to create a merge request, you must open the path [`_locales/en/messages.json`](https://github.com/KevinRoebert/ClearUrls/blob/master/_locales/en/messages.json) in the ClearURLs repo 
-and translate the english terms into terms of your language. Once you have translated all the terms, you make a pull request of your translation. 
-Please push your translation into the folder `_locales/{language code}/messages.json`.
-
-#### POEditor
-[<img src="https://poeditor.com/public/images/logo/logo.svg" alt="https://poeditor.com/join/project/vKTpQWWvk2" width="150">](https://poeditor.com/join/project/vKTpQWWvk2)
-
-## Projects that use parts of ClearURLs
-
-* [Uroute](https://github.com/walterl/uroute) used ClearURLs to filter/clean URL before launching browser
-* [Scrub](https://gitlab.com/CrunchBangDev/cbd-cogs/-/tree/master/Scrub) used ClearURLs to filter/clean URLs as cog for the Red Discord bot
-* [Unalix](https://github.com/AmanoTeam/Unalix) a simple Python module that removes tracking fields from URLs and unshort shortened URLs
-* [Unalix-nim](https://github.com/AmanoTeam/Unalix-nim) a simple Nim library that removes tracking fields from URLs and unshort shortened URLs
-
-## Recommended by...
-*  [ghacks-user.js](https://github.com/ghacksuserjs/ghacks-user.js/wiki/4.1-Extensions)
-*  [Awesome Humane Tech List](https://github.com/humanetech-community/awesome-humane-tech#tracking)
-*  [PrivacyTools](https://www.privacytools.io/browsers/#addons)
-*  [New York Times Wirecutter](https://www.nytimes.com/wirecutter/reviews/our-favorite-ad-blockers-and-browser-extensions-to-protect-privacy/#cleaner-links-clearurls)
-*  ClearURLs is part of Mozilla's recommended extensions program
-
-## Permissions
-Reasoning for needed permissions you can find under [this discussion](https://gitlab.com/KevinRoebert/ClearUrls/issues/159).
-
 ## Copyright
 We use some third-party scripts in our add-on. The authors and licenses are listed below.
 -   [WebExtension browser API Polyfill](https://github.com/mozilla/webextension-polyfill) |

core_js/storage.js

@@ -193,8 +193,8 @@ function initSettings() {
     storage.log = {"log": []};
     storage.statisticsStatus = true;
     storage.badged_color = "#ffa500";
-    storage.hashURL = "https://rules2.clearurls.xyz/rules.minify.hash";
-    storage.ruleURL = "https://rules2.clearurls.xyz/data.minify.json";
+    storage.hashURL = "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
+    storage.ruleURL = "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
     storage.contextMenuEnabled = true;
     storage.historyListenerEnabled = true;
     storage.localHostsSkipping = true;
@@ -221,27 +221,23 @@ function initSettings() {
 function replaceOldURLs(url) {
     switch (url) {
         case "https://raw.githubusercontent.com/KevinRoebert/ClearUrls/master/data/rules.hash?flush_cache=true":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
         case "https://raw.githubusercontent.com/KevinRoebert/ClearUrls/master/data/data.json?flush_cache=true":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/rules.hash":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
         case "https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.json":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/rules.min.hash?job=hash%20rules":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
         case "https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.min.json":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.minify.json":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/data.minify.json?job=hash%20rules":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/data.minify.json";
         case "https://gitlab.com/KevinRoebert/ClearUrls/-/jobs/artifacts/master/raw/rules.minify.hash?job=hash%20rules":
-            return "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash";
-        case "https://kevinroebert.gitlab.io/ClearUrls/data/data.minify.json":
-            return "https://rules2.clearurls.xyz/data.minify.json";
-        case "https://kevinroebert.gitlab.io/ClearUrls/data/rules.minify.hash":
-            return "https://rules2.clearurls.xyz/rules.minify.hash";
+            return "https://git.michael.is/michael/clear-urls-browser-extension/raw/branch/master/data/rules.minify.hash";
         default:
             return url;
     }

data

@@ -1 +0,0 @@
-Subproject commit 7a180c3dbd2a48aeeb1271919f6a9218b4d45354

data/rules.minify.hash

@@ -0,0 +1 @@
+18ece9513135aefb68fdffa0e4d18b1ae441dc57076d1715bffb4bee27ec8963

manifest.json

@@ -1,10 +1,10 @@
 {
     "manifest_version": 2,
     "name": "ClearURLs",
-    "version": "1.21.0",
+    "version": "1.22.0",
     "author": "Kevin Röbert",
-    "description": "__MSG_extension_description__",
-    "homepage_url": "https://gitlab.com/KevinRoebert/ClearUrls",
+    "description": "Removes tracking info from URLs. Forked from github.com/ClearURLs/Addon",
+    "homepage_url": "https://git.michael.is/michael/clear-urls-browser-extension",
     "default_locale": "en",
     "icons": {
         "16": "img/clearurls_16x16.png",
@@ -19,6 +19,11 @@
         "96": "img/clearurls_96x96.png",
         "128": "img/clearurls_128x128.png"
     },
+    "browser_specific_settings": {
+        "gecko": {
+            "id": "{8460283f-b310-4e55-8c07-ebd5eefdc9b3}"
+        }
+    },
     "browser_action": {
         "browser_style": true,
         "default_icon": {

package-lock.json

@@ -0,0 +1,6 @@
+{
+  "name": "clear-urls",
+  "lockfileVersion": 2,
+  "requires": true,
+  "packages": {}
+}