feat(kagi): adds Kagi search engine support (#483)

iorate · Jun 9, 2024 · 34dd7b8 · 34dd7b8
1 parent a06525d
commit 34dd7b8
Show file tree

Hide file tree

Showing 20 changed files with 89 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -28,6 +28,7 @@ This extension is available in the below search engines.
 | Brave \*3    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | DuckDuckGo   | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | Ecosia       | :heavy_check_mark: |                    |                    |                    |
+| Kagi         | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | Qwant        | :heavy_check_mark: | :heavy_check_mark: | \*1                | :heavy_check_mark: |
 | SearX \*2    | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
 | Startpage    | :heavy_check_mark: |                    | :heavy_check_mark: | :heavy_check_mark: |

diff --git a/src/_locales/de/messages.json.ts b/src/_locales/de/messages.json.ts
@@ -161,6 +161,7 @@ export default exportAsMessages({
   searchEngines_braveName: "Brave",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_qwantDescription:

diff --git a/src/_locales/en/messages.json.ts b/src/_locales/en/messages.json.ts
@@ -444,6 +444,9 @@ export default exportAsMessages({
   // The localized name of Ecosia.
   searchEngines_ecosiaName: "Ecosia",
 
+  // The localized name of Kagi.
+  searchEngines_kagiName: "Kagi",
+
   // The localized name of Qwant.
   searchEngines_qwantName: "Qwant",
 

diff --git a/src/_locales/es/messages.json.ts b/src/_locales/es/messages.json.ts
@@ -140,6 +140,7 @@ export default exportAsMessages({
   searchEngines_braveName: "Brave",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_startpageName: "Startpage.com",

diff --git a/src/_locales/fr/messages.json.ts b/src/_locales/fr/messages.json.ts
@@ -157,6 +157,7 @@ export default exportAsMessages({
   searchEngines_bingName: "Bing",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_qwantDescription:

diff --git a/src/_locales/pl/messages.json.ts b/src/_locales/pl/messages.json.ts
@@ -158,6 +158,7 @@ export default exportAsMessages({
   searchEngines_braveName: "Brave",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_qwantDescription: 'Wyłącz "Odtwarzaj filmy na Qwant.com".',

diff --git a/src/_locales/pt_BR/messages.json.ts b/src/_locales/pt_BR/messages.json.ts
@@ -161,6 +161,7 @@ export default exportAsMessages({
   searchEngines_braveName: "Brave",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_qwantDescription:

diff --git a/src/_locales/ru/messages.json.ts b/src/_locales/ru/messages.json.ts
@@ -145,6 +145,7 @@ export default exportAsMessages({
   searchEngines_braveName: "Brave",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_startpageName: "Startpage.com",

diff --git a/src/_locales/uk/messages.json.ts b/src/_locales/uk/messages.json.ts
@@ -146,6 +146,7 @@ export default exportAsMessages({
   searchEngines_braveName: "Brave",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_startpageName: "Startpage.com",

diff --git a/src/_locales/zh_CN/messages.json.ts b/src/_locales/zh_CN/messages.json.ts
@@ -151,6 +151,7 @@ export default exportAsMessages({
   searchEngines_braveName: "Brave",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_startpageName: "Startpage.com",

diff --git a/src/_locales/zh_TW/messages.json.ts b/src/_locales/zh_TW/messages.json.ts
@@ -153,6 +153,7 @@ export default exportAsMessages({
   searchEngines_braveName: "Brave",
   searchEngines_duckduckgoName: "DuckDuckGo",
   searchEngines_ecosiaName: "Ecosia",
+  searchEngines_kagiName: "Kagi",
   searchEngines_qwantName: "Qwant",
   searchEngines_searxName: "SearX",
   searchEngines_qwantDescription: "請關閉「總是在 Qwant.com 播放影片」選項。",

diff --git a/src/common/locales.ts b/src/common/locales.ts
@@ -138,6 +138,7 @@ export type MessageName =
   | "searchEngines_braveName"
   | "searchEngines_duckduckgoName"
   | "searchEngines_ecosiaName"
+  | "searchEngines_kagiName"
   | "searchEngines_qwantName"
   | "searchEngines_qwantDescription"
   | "searchEngines_searxName"

diff --git a/src/common/search-engines.ts b/src/common/search-engines.ts
@@ -6,6 +6,7 @@ export type SearchEngineId =
   | "brave"
   | "duckduckgo"
   | "ecosia"
+  | "kagi"
   | "qwant"
   | "searx"
   | "startpage"
@@ -313,6 +314,23 @@ export const SEARCH_ENGINES: Readonly<
       name: "searchEngines_ecosiaName",
     },
   },
+  kagi: {
+    contentScripts: [
+      {
+        matches: [
+          "https://kagi.com/search?*",
+          "https://kagi.com/images?*",
+          "https://kagi.com/videos?*",
+          "https://kagi.com/news?*",
+          "https://kagi.com/podcasts?*",
+        ],
+        runAt: "document_idle",
+      },
+    ],
+    messageNames: {
+      name: "searchEngines_kagiName",
+    },
+  },
   qwant: {
     contentScripts: [
       {

diff --git a/src/scripts/search-engines.ts b/src/scripts/search-engines.ts
@@ -3,6 +3,7 @@ import { brave } from "./search-engines/brave.ts";
 import { duckduckgo } from "./search-engines/duckduckgo.ts";
 import { ecosia } from "./search-engines/ecosia.ts";
 import { google } from "./search-engines/google.ts";
+import { kagi } from "./search-engines/kagi.ts";
 import { qwant } from "./search-engines/qwant.ts";
 import { searx } from "./search-engines/searx.ts";
 import { startpage } from "./search-engines/startpage.ts";
@@ -18,6 +19,7 @@ export const SEARCH_ENGINES: Readonly<
   brave,
   duckduckgo,
   ecosia,
+  kagi,
   qwant,
   searx,
   startpage,

diff --git a/src/scripts/search-engines/kagi.ts b/src/scripts/search-engines/kagi.ts
@@ -0,0 +1,43 @@
+import { SEARCH_ENGINES } from "../../common/search-engines.ts";
+import type { SearchEngine, SerpHandler } from "../types.ts";
+import { getDialogThemeFromBody, handleSerp } from "./helpers.ts";
+
+function getSerpHandler(): SerpHandler {
+  return handleSerp({
+    // https://github.com/iorate/ublacklist/pull/374
+    delay: 400,
+
+    globalStyle: {
+      '[data-ub-blocked="visible"]': {
+        backgroundColor:
+          "var(--ub-block-color, rgba(255, 192, 192, 0.5)) !important",
+      },
+      ".ub-button:hover": {
+        textDecoration: "underline",
+      },
+    },
+    controlHandlers: [
+      {
+        target: "._ext_filter_box",
+        position: "afterend",
+        style: "_ub_filter_box",
+      },
+    ],
+    entryHandlers: [
+      // All
+      {
+        target: "._ext_r",
+        url: "._ext_u",
+        title: "._ext_t",
+        actionTarget: "._ext_a",
+        actionStyle: "_ub_act_btn_box",
+      },
+    ],
+    getDialogTheme: getDialogThemeFromBody(),
+  });
+}
+
+export const kagi: Readonly<SearchEngine> = {
+  ...SEARCH_ENGINES.kagi,
+  getSerpHandler,
+};
diff --git a/website/docs/advanced-features.md b/website/docs/advanced-features.md
@@ -88,7 +88,7 @@ Comments begin with `#`. Although any line that cannot be interpreted as a rule
 
 ## Other search engines {#other-search-engines}
 
-This extension supports [Bing](#bing), [Brave](#brave) (partially), [DuckDuckGo](#duckduckgo), [Ecosia](#ecosia) (partially), [Qwant](#qwant), [SearX](#searx) (partially), [Startpage.com](#startpagecom), [Yahoo! JAPAN](#yahoo-japan) (partially) and [Yandex](#yandex) (partially). This feature is disabled by default and can be enabled in the options page.
+This extension supports [Bing](#bing), [Brave](#brave) (partially), [DuckDuckGo](#duckduckgo), [Ecosia](#ecosia) (partially), [Kagi](#kagi), [Qwant](#qwant), [SearX](#searx) (partially), [Startpage.com](#startpagecom), [Yahoo! JAPAN](#yahoo-japan) (partially) and [Yandex](#yandex) (partially). This feature is disabled by default and can be enabled in the options page.
 
 ![other search engines](/img/advanced-features/other-search-engines-1.png)
 
@@ -110,6 +110,10 @@ You can also enable it by clicking the toolbar icon when a search result page is
 
 ![ecosia](/img/advanced-features/ecosia.png)
 
+### Kagi {#kagi}
+
+![kagi](/img/advanced-features/kagi.png)
+
 ### Qwant {#qwant}
 
 "Videos" search will only work if you disable qwant custom links by clicking on "Always read on Qwant.com".

diff --git a/website/docs/introduction.md b/website/docs/introduction.md
@@ -21,6 +21,6 @@ uBlacklist is a Google Search filter for Chrome, Firefox and Safari.
 - Block sites with specific URLs using match patterns or regular expressions
 - Block sites with specific titles using regular expressions
 - Highlight sites
-- Support Bing, Brave, DuckDuckGo, Ecosia, Qwant, Searx, Startpage.com, Yahoo! JAPAN and Yandex
+- Support Bing, Brave, DuckDuckGo, Ecosia, Kagi, Qwant, Searx, Startpage.com, Yahoo! JAPAN and Yandex
 - Synchronize block rules among devices using Google Drive or Dropbox
 - Subscribe to public block rules
diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/advanced-features.md b/website/i18n/ja/docusaurus-plugin-content-docs/current/advanced-features.md
@@ -88,7 +88,7 @@ sidebar_position: 2
 
 ## Google 以外の検索エンジン {#other-search-engines}
 
-[Bing](#bing)、[Brave](#brave)、[DuckDuckGo](#duckduckgo)、[Ecosia](#ecosia)、[Qwant](#qwant)、[SearX](#searx)、[Startpage.com](#startpagecom)、[Yahoo! JAPAN](#yahoo-japan)、[Yandex](#yandex) がサポートされています。この機能はデフォルトで無効ですが、オプションページで有効にすることができます。
+[Bing](#bing)、[Brave](#brave)、[DuckDuckGo](#duckduckgo)、[Ecosia](#ecosia)、[Kagi](#kagi)、[Qwant](#qwant)、[SearX](#searx)、[Startpage.com](#startpagecom)、[Yahoo! JAPAN](#yahoo-japan)、[Yandex](#yandex) がサポートされています。この機能はデフォルトで無効ですが、オプションページで有効にすることができます。
 
 ![その他の検索エンジン](/img/advanced-features/other-search-engines-1.png)
 
@@ -110,6 +110,10 @@ sidebar_position: 2
 
 ![ecosia](/img/advanced-features/ecosia.png)
 
+### Kagi {#kagi}
+
+![kagi](/img/advanced-features/kagi.png)
+
 ### Qwant {#qwant}
 
 動画検索上では、"Always read on Qwant.com" を無効にする必要があります。

diff --git a/website/i18n/ja/docusaurus-plugin-content-docs/current/introduction.md b/website/i18n/ja/docusaurus-plugin-content-docs/current/introduction.md
@@ -21,6 +21,6 @@ uBlacklist は Google の検索結果をフィルタリングするブラウザ
 - マッチパターンまたは正規表現でブロックするサイトの URL を指定できます
 - 正規表現でブロックするサイトのタイトルを指定できます
 - サイトをハイライトできます
-- Bing、Brave、DuckDuckGo、Ecosia、Qwant、SearX、Startpage.com、Yahoo! JAPAN、Yandex でも使用できます
+- Bing、Brave、DuckDuckGo、Ecosia、Kagi、Qwant、SearX、Startpage.com、Yahoo! JAPAN、Yandex でも使用できます
 - ルールを Google ドライブまたは Dropbox で同期できます
 - 公開されたルールを購読できます
diff --git a/website/static/img/advanced-features/kagi.png b/website/static/img/advanced-features/kagi.png