Merge branch 'main' of https://git.wbell.dev/TussockyJoker/Aula-Extension

Reviewed-on: #2

.env_example

@@ -0,0 +1,2 @@
+API_KEY="YOUR_API_KEY"
+API_SECRET="YOUR_API_SECRET"

.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+Archive.zip
+.amo-upload-uuid
+dev-resources
+content copy.js
+aula-fixer_v1-2.zip
+.env
+
+web-ext-artifacts
+src.pem

README.md

@@ -1,7 +1,22 @@
-# Aula-Extension
+# Aula-Fixer
 
-Browser extension that removes all the notifications about rooms for rent and shit
+This is a browser extension that removes all the notifications about rooms for rent and tenancy takeovers etc. from Aula and changes the styling of the pages to stop wasting so much space.
 
-Will remove any notifications containing the any of the ~keywords~ keyphrases in keywords.txt so you can make it hide other stuff too if you wanted.
+Will remove any notifications containing the any of the ~keywords~ keyphrases in the keywords.txt file stored in this repo, it can also fall back on a local keywords.txt if the server cannot be reached.
 
-I've only tested with chrome, atm the easiest way to install this is to turn on dev mode in chrome://extensions/, click on 'Load unpacked' and select the Aula-Extension folder.
+I've only tested with Chrome, Brave and Firefox. The easiest way to install this on chromium or similar is to download the .zip file, extract it somewhere, turn on dev mode in chrome://extensions (or equivalent), clicking on 'Load unpacked' and select the extracted folder. Alternatively clone this repo and select the src folder. I did pack a .crx for this purpose but Chrome has removed the ability to load .crx files 😐
+
+For Firefox, I've made a signed .xpi which can be found in builds. To install from here, just open a new firefox tab and drag it into the window.
+
+The Firefox version will often be slightly more up-to-date compared to the chrome version as building for chrome cannot be done from the CLI (afaik).
+
+I'm working on getting the extension published on both the Chrome and Firefox stores.
+
+https://addons.mozilla.org/en-GB/firefox/addon/aula-ad-filter/
+
+https://chromewebstore.google.com/detail/aula-ad-filter/ooghijbicaoiccbkjplnellggncbcgbl?authuser=0&hl=en-GB
+
+If you just want the 'ad-blocker' function, I've kept a separate branch in this repo.
+If you have customised keywords.txt, you will have to break the url in 'background.js' so that it falls back on the local keywords.txt file. This only works if you are NOT using the prepackaged extensions or extensions from the chrome/firefox stores, these will only pull from the file in this repo or fall back on the included version if the server cannot be reached. If you think a word or phrase should be added to keywords.txt, either submit a pull request or raise an issue.
+
+If you would like to build the extension for yourself run /build_scripts/build.sh, which will give you a .zip compatible with most browsers, if you wish to build a Firefox .xpi you will need to get a developer api key and change the id in the manifest.

build_scripts/build.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+web-ext build --source-dir=./src --artifacts-dir=./builds

build_scripts/build_ff_listed.sh

@@ -0,0 +1,11 @@
+!/usr/bin/env bash
+
+source .env
+
+echo "Building/signing listed firefox extension"
+mv src/manifest.json src/manifest_temp.json
+mv src/manifest_ff.json src/manifest.json
+echo "manifest_ff > manifest"
+web-ext sign --channel=unlisted --api-key=user:$API_KEY --api-secret=$API_SECRET --source-dir=./src --artifacts-dir=./builds
+mv src/manifest.json src/manifest_ff.json
+mv src/manifest_temp.json src/manifest.json

build_scripts/build_ff_unlisted.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+source .env
+
+echo "Building/signing UNlisted firefox extension"
+mv src/manifest.json src/manifest_temp.json
+mv src/manifest_ff.json src/manifest.json
+web-ext sign --channel=unlisted --api-key=user:$API_KEY --api-secret=$API_SECRET --source-dir=./src --artifacts-dir=./builds
+mv src/manifest.json src/manifest_ff.json
+mv src/manifest_temp.json src/manifest.json

content.js

@@ -1,51 +0,0 @@
-let keywords = [];
-
-async function loadKeywords() {
-    try {
-        const response = await fetch(chrome.runtime.getURL("keywords.txt"));
-        const text = await response.text();
-
-        keywords = text
-            .split("\n")
-            .map(k => k.trim().toLowerCase())
-            .filter(Boolean);
-
-        console.log("Loaded keywords:", keywords);
-
-        startFiltering();
-
-    } catch (error) {
-        console.error("Failed to load keywords.txt:", error);
-    }
-}
-
-function filterNotifications() {
-    const notifications = document.querySelectorAll('div[role="button"]');
-
-    notifications.forEach(notification => {
-        const text = notification.innerText.toLowerCase();
-
-        const containsKeyword = keywords.some(keyword =>
-            text.includes(keyword)
-        );
-
-        if (containsKeyword) {
-            notification.remove();
-        }
-    });
-}
-
-function startFiltering() {
-    filterNotifications();
-
-    const observer = new MutationObserver(() => {
-        filterNotifications();
-    });
-
-    observer.observe(document.body, {
-        childList: true,
-        subtree: true
-    });
-}
-
-loadKeywords();

keywords.txt

@@ -1,10 +0,0 @@
-tenancy
-bedroom available
-bedroom is available
-spacious room
-i'm looking for a place to rent
-short-term let available
-i am looking for accomodation
-i'm looking for accomodation
-fully furnished house
-ensuite room available

manifest.json

@@ -1,20 +0,0 @@
-{
-  "manifest_version": 3,
-  "name": "Aula Ad Filter",
-  "version": "1.1",
-  "description": "Removes all the notifications about rooms for rent on Aula",
-
-  "content_scripts": [
-    {
-      "matches": ["https://coventry.aula.education/*"],
-      "js": ["content.js"]
-    }
-  ],
-
-  "web_accessible_resources": [
-    {
-      "resources": ["keywords.txt"],
-      "matches": ["https://coventry.aula.education/*"]
-    }
-  ]
-}

src/background.js

@@ -0,0 +1,34 @@
+chrome.runtime.onMessage.addListener((request, sender, sendResponse) => {
+    if (request.type === "GET_KEYWORDS") {
+
+        const remoteUrl = "https://git.wbell.dev/TussockyJoker/Aula-Fixer/raw/branch/main/src/keywords.txt";
+        const localUrl = chrome.runtime.getURL("keywords.txt");
+
+        // remote
+        fetch(remoteUrl)
+            .then(response => {
+                if (!response.ok) throw new Error("Remote fetch failed");
+                return response.text();
+            })
+            .then(text => {
+                console.log("Loaded remote keywords");
+                sendResponse({ success: true, data: text });
+            })
+            .catch(() => {
+                console.warn("Remote failed, loading local fallback");
+
+                // local
+                fetch(localUrl)
+                    .then(response => response.text())
+                    .then(text => {
+                        console.log("Loaded local fallback keywords");
+                        sendResponse({ success: true, data: text });
+                    })
+                    .catch(error => {
+                        sendResponse({ success: false, error: error.toString() });
+                    });
+            });
+
+        return true;
+    }
+});

src/content.js

@@ -0,0 +1,89 @@
+let keywords = [];
+
+function loadKeywords() {
+    chrome.runtime.sendMessage({ type: "GET_KEYWORDS" }, (response) => {
+        if (!response || !response.success) {
+            console.error("Failed to load remote keywords:", response?.error);
+            return;
+        }
+
+        keywords = response.data
+            .split("\n")
+            .map(k => k.trim().toLowerCase())
+            .filter(Boolean);
+
+        console.log("Loaded keywords:", keywords);
+
+        injectStyles();
+        startFiltering();
+    });
+}
+
+function filterNotifications() {
+    const notifications = document.querySelectorAll('div[role="button"]');
+
+    notifications.forEach(notification => {
+        const text = notification.innerText?.toLowerCase() || "";
+
+        const containsKeyword = keywords.some(keyword =>
+            text.includes(keyword)
+        );
+
+        if (containsKeyword) {
+            notification.remove();
+        }
+    });
+}
+
+function injectStyles() {
+    // Prevent duplicate injection
+    if (document.getElementById("aula-fixer-styles")) return;
+
+    const style = document.createElement("style");
+    style.id = "aula-fixer-styles";
+
+    style.textContent = `
+        .css-qbgecn {
+            max-height: 99% !important;
+            padding: 0 !important;
+        }
+        
+        .css-15ampbt {
+            overflow: hidden !important;
+        }
+
+        .css-1iji2l6 {
+            margin: 1px !important;
+        }
+
+        #main-content > div > div > div.css-qbgecn.e1f8gytw1 {
+            overflow-y: hidden !important;
+        }
+
+        .css-1vz9kb2 {
+            flex-basis: 85% !important;
+            padding: 0px 0px 0px 1% !important;
+        }
+
+        .css-nivjaw {
+            padding: 12px 12px 12px 12px !important;
+        }
+    `;
+
+    document.head.appendChild(style);
+}
+
+function startFiltering() {
+    filterNotifications();
+
+    const observer = new MutationObserver(() => {
+        filterNotifications();
+    });
+
+    observer.observe(document.body, {
+        childList: true,
+        subtree: true
+    });
+}
+
+loadKeywords();

src/keywords.txt

@@ -0,0 +1,19 @@
+tenancy
+bedroom available
+bedroom is available
+spacious room
+i'm looking for a place to rent
+short-term let available
+i am looking for accomodation
+i'm looking for accomodation
+fully furnished house
+ensuite room available
+room available cv13gx queens park house unite student
+en-suite room available
+double studio room is available
+need a space for 1 person (girl) to stay
+hey everyone looking space for one
+room available for girl (shared accommodation)
+takeover an en-suite room
+i'm currently seeking for someone who can take over an en-suite room
+accomodation alert

src/manifest.json

@@ -0,0 +1,35 @@
+{
+  "manifest_version": 3,
+  "name": "Aula Fixer",
+  "version": "1.4",
+  "description": "Removes all notifications about rooms for rent etc. on Aula and changes styling so that less screen space is wasted.",
+
+  "background": {
+    "service_worker": "background.js",
+    "scripts": ["background.js"]
+  },
+
+  "content_scripts": [
+    {
+      "matches": ["https://coventry.aula.education/*"],
+      "js": ["content.js"]
+    }
+  ],
+
+  "host_permissions": [
+    "https://git.wbell.dev/*"
+  ],
+
+  "web_accessible_resources": [
+  {
+    "resources": ["keywords.txt"],
+    "matches": ["https://coventry.aula.education/*"]
+  }
+  ],
+
+  "browser_specific_settings": {
+    "gecko": {
+      "id": "aula-fixer@tussockyjoker.com"
+    }
+  }
+}

src/manifest_chrome.json

@@ -0,0 +1,34 @@
+{
+  "manifest_version": 3,
+  "name": "Aula Fixer",
+  "version": "1.4",
+  "description": "Removes all notifications about rooms for rent etc. on Aula and changes styling so that less screen space is wasted.",
+
+  "background": {
+    "service_worker": "background.js"
+  },
+
+  "content_scripts": [
+    {
+      "matches": ["https://coventry.aula.education/*"],
+      "js": ["content.js"]
+    }
+  ],
+
+  "host_permissions": [
+    "https://git.wbell.dev/*"
+  ],
+
+  "web_accessible_resources": [
+  {
+    "resources": ["keywords.txt"],
+    "matches": ["https://coventry.aula.education/*"]
+  }
+  ],
+
+  "browser_specific_settings": {
+    "gecko": {
+      "id": "aula-fixer@tussockyjoker.com"
+    }
+  }
+}

src/manifest_ff.json

@@ -0,0 +1,34 @@
+{
+  "manifest_version": 3,
+  "name": "Aula Fixer",
+  "version": "1.4.1",
+  "description": "Removes all notifications about rooms for rent etc. on Aula and changes styling so that less screen space is wasted.",
+
+  "background": {
+    "scripts": ["background.js"]
+  },
+
+  "content_scripts": [
+    {
+      "matches": ["https://coventry.aula.education/*"],
+      "js": ["content.js"]
+    }
+  ],
+
+  "host_permissions": [
+    "https://git.wbell.dev/*"
+  ],
+
+  "web_accessible_resources": [
+  {
+    "resources": ["keywords.txt"],
+    "matches": ["https://coventry.aula.education/*"]
+  }
+  ],
+
+  "browser_specific_settings": {
+    "gecko": {
+      "id": "aula-fixer@tussockyjoker.com"
+    }
+  }
+}