Added initial support for Ecosia

package.json

@@ -1,54 +1,53 @@
 {
-  "name": "web-search-navigator",
-  "description": "Keyboard shortcuts for Google™ search.",
-  "repository": "https://github.com/infokiller/web-search-navigator",
-  "author": "https://github.com/infokiller",
-  "contributors": [
-    {
-      "name": "infokiller"
+    "version": "1.0.0",
+    "name": "web-search-navigator",
+    "description": "Keyboard shortcuts for Google™ search.",
+    "repository": "https://github.com/infokiller/web-search-navigator",
+    "author": "https://github.com/infokiller",
+    "contributors": [
+        {
+            "name": "infokiller"
+        },
+        {
+            "name": "Michal Novák",
+            "url": "https://www.weborama.cz/"
+        }
+    ],
+    "license": "MIT",
+    "scripts": {
+        "build": "gulp",
+        "eslint": "eslint $(git ls-files '*.js' ':(exclude)vendor')",
+        "prettier-markdown-check": "prettier --check $(git ls-files '*.md')",
+        "prettier-markdown-format": "prettier --write $(git ls-files '*.md')",
+        "stylelint": "stylelint src/*.css",
+        "shellcheck": "shellcheck tools/*.sh",
+        "shfmt-check": "shfmt -i 2 -sr -ci -d tools",
+        "shfmt-format": "shfmt -i 2 -sr -ci -w tools",
+        "check": "yarn run eslint && yarn run stylelint && yarn run shellcheck && yarn run prettier-markdown-check"
     },
-    {
-      "name": "Michal Novák",
-      "url": "https://www.weborama.cz/"
+    "dependencies": {
+        "mousetrap": "^1.6.5",
+        "webextension-polyfill": "^0.12.0"
+    },
+    "devDependencies": {
+        "eslint": "^9.4.0",
+        "eslint-config-google": "^0.14.0",
+        "eslint-plugin-json": "^4.0.0",
+        "gulp": "^5.0.0",
+        "gulp-if": "^3.0.0",
+        "gulp-terser": "^2.1.0",
+        "markdownlint-cli": "^0.41.0",
+        "minimist": "^1.2.8",
+        "prettier": "3.2.5",
+        "prettier-eslint-cli": "^8.0.1",
+        "set-value": "^4.1.0",
+        "shellcheck": "^2.2.0",
+        "stylelint": "^15.11.0",
+        "stylelint-config-standard": "^34.0.0",
+        "web-ext": "^7.11.0"
+    },
+    "resolutions": {
+        "bl": "^1.2.3",
+        "node-forge": "^0.10.0"
     }
-  ],
-  "license": "MIT",
-  "scripts": {
-    "build": "gulp",
-    "eslint": "eslint $(git ls-files '*.js' ':(exclude)vendor')",
-    "prettier-markdown-check": "prettier --check $(git ls-files '*.md')",
-    "prettier-markdown-format": "prettier --write $(git ls-files '*.md')",
-    "stylelint": "stylelint src/*.css",
-    "shellcheck": "shellcheck tools/*.sh",
-    "shfmt-check": "shfmt -i 2 -sr -ci -d tools",
-    "shfmt-format": "shfmt -i 2 -sr -ci -w tools",
-    "check": "yarn run eslint && yarn run stylelint && yarn run shellcheck && yarn run prettier-markdown-check"
-  },
-  "dependencies": {
-    "mousetrap": "^1.6.5",
-    "webextension-polyfill": "^0.12.0"
-  },
-  "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "eslint": "^9.3.0",
-    "eslint-config-google": "^0.14.0",
-    "eslint-plugin-json": "^4.0.0",
-    "gulp": "^5.0.0",
-    "gulp-if": "^3.0.0",
-    "gulp-terser": "^2.1.0",
-    "markdownlint-cli": "^0.41.0",
-    "minimist": "^1.2.8",
-    "prettier": "3.2.5",
-    "prettier-eslint-cli": "^8.0.1",
-    "set-value": "^4.1.0",
-    "shellcheck": "^2.2.0",
-    "stylelint": "^15.11.0",
-    "stylelint-config-standard": "^34.0.0",
-    "web-ext": "^7.11.0"
-  },
-  "resolutions": {
-    "bl": "^1.2.3",
-    "node-forge": "^0.10.0"
-  }
-}
+}

src/manifest.json

@@ -1,7 +1,7 @@
 {
     "manifest_version": 2,
     "name": "Web Search Navigator",
-    "version": "0.5.2",
+    "version": "0.5.3",
     "description": "Keyboard shortcuts for Google search, YouTube, Startpage, Brave Search, Google Scholar, Github, Gitlab, and Amazon.",
     "author": "Web Search Navigator",
     "icons": {
@@ -451,6 +451,7 @@
         "https://scholar.google.tt/*",
         "https://scholar.google.vg/*",
         "https://scholar.google.vu/*",
-        "https://scholar.google.ws/*"
+        "https://scholar.google.ws/*",
+        "https://www.ecosia.org/*"
     ]
 }

src/options.js

@@ -68,6 +68,10 @@ html[dark], [dark] {
     outline: var(--result-outline) !important;
 }
 
+.wsn-ecosia-focused-link {
+  outline: 2px solid var(--color-link-primary) !important;
+}
+
 .wsn-google-focused-memex-result {
     border: var(--result-outline) !important;
     box-sizing: border-box;

src/options_page.html

@@ -232,6 +232,11 @@ <h2>EXPERIMENTAL: Alternative search engines</h2>
                 <input type="checkbox" id="github"> Enable on Github
             </label>
         </div>
+        <div class="option">
+            <label for="github">
+                <input type="checkbox" id="ecosia"> Enable on Ecosia
+            </label>
+        </div>
         <div class="option">
             <label for="gitlab">
                 <input type="checkbox" id="gitlab"> Enable on Gitlab

src/options_page.js

@@ -72,6 +72,7 @@ const OPTIONAL_PERMISSIONS_URLS = {
   'amazon': generateURLPatterns('https://www.amazon', AMAZON_DOMAINS, '/*'),
   'gitlab': ['https://gitlab.com/*'],
   'custom-gitlab': ['https://*/*'],
+  'ecosia': ['https://www.ecosia.org/*']
 };
 
 const KEYBINDING_TO_DIV = {
@@ -156,6 +157,10 @@ class OptionsPageManager {
     customGitlab.addEventListener('change', () => {
       setSearchEnginePermission_(customGitlab);
     });
+    const ecosia = document.getElementById('ecosia');
+    ecosia.addEventListener('change', () => {
+      setSearchEnginePermission_(ecosia);
+    });
     // NOTE: this.saveOptions and this.resetToDefaults cannot be passed directly
     // or otherwise `this` won't be bound to the object.
     document.getElementById('save').addEventListener('click', () => {
@@ -268,6 +273,10 @@ class OptionsPageManager {
     github.checked = OPTIONAL_PERMISSIONS_URLS['github'].every((url) => {
       return permissions.origins.includes(url);
     });
+    const ecosia = document.getElementById('ecosia');
+    ecosia.checked = OPTIONAL_PERMISSIONS_URLS['ecosia'].every((url) => {
+      return permissions.origins.includes(url);
+    });
     const gitlab = document.getElementById('gitlab');
     gitlab.checked = OPTIONAL_PERMISSIONS_URLS['gitlab'].every((url) => {
       return permissions.origins.includes(url);

src/search_engines.js

@@ -1542,6 +1542,73 @@ class CustomGitlab extends Gitlab {
   }
 }
 
+
+class Ecosia {
+  constructor(options) {
+    this.options = options;
+  }
+  get urlPattern() {
+    return /^https:\/\/(www\.)?ecosia\.org/;;
+  }
+  get searchBoxSelector() {
+    return 'input[name="q"][type="search"]';
+  }
+
+  onChangedResults(callback) {
+    const container = document.querySelector('main');
+    if (!container) {
+      return;
+    }
+
+    let lastURL = window.location.search;
+    const observer = new MutationObserver(
+        (mutationsList, observer) => {
+          if (lastURL !== window.location.search) {
+            lastURL = window.location.search;
+            callback(true);
+          }
+        },
+    );
+
+    observer.observe(container, {
+      attributes: false,
+      childList: true,
+      subtree: false,
+    });
+  }
+
+  getSearchResults() {
+    const includedElements = [
+      {
+        nodes: document.querySelectorAll('a.result__link.link--color-result'),
+        highlightClass: 'wsn-ecosia-focused-link',
+        highlightedElementSelector: (n) => n,
+        containerSelector: (n) => n.parentElement.parentElement,
+      }
+    ];
+    return getSortedSearchResults(includedElements, []);
+  }
+
+  get previousPageButton() {
+    const previousPageElement = document.querySelector('a[data-test-id="back-button"]');
+    if (previousPageElement !== null) {
+      return previousPageElement;
+    }
+
+    return null;
+  }
+
+  get nextPageButton() {
+    const previousPageElement = document.querySelector('a[data-test-id="next-button"]');
+    if (previousPageElement !== null) {
+      return previousPageElement;
+    }
+
+    return null;
+  }
+}
+
+
 // Get search engine object matching the current url
 /* eslint-disable-next-line no-unused-vars */
 const getSearchEngine = (options) => {
@@ -1554,6 +1621,7 @@ const getSearchEngine = (options) => {
     new Amazon(options),
     new Github(options),
     new Gitlab(options),
+    new Ecosia(options),
     new CustomGitlab(options),
   ];
   // Switch over all compatible search engines