Implement FindNextOperator

12 files changed, 365 insertions, 2 deletions

diff --git a/src/background/Application.ts b/src/background/Application.ts
index 69fe4a4..2006965 100644
--- a/src/background/Application.ts
+++ b/src/background/Application.ts
@@ -3,6 +3,7 @@ import ContentMessageListener from "./infrastructures/ContentMessageListener";
 import SettingController from "./controllers/SettingController";
 import VersionController from "./controllers/VersionController";
 import SettingRepository from "./repositories/SettingRepository";
+import FindRepositoryImpl from "./repositories/FindRepository";
 
 @injectable()
 export default class Application {
@@ -11,12 +12,19 @@ export default class Application {
     private settingController: SettingController,
     private versionController: VersionController,
     @inject("SyncSettingRepository")
-    private syncSettingRepository: SettingRepository
+    private syncSettingRepository: SettingRepository,
+    @inject("FindRepository")
+    private readonly findRepository: FindRepositoryImpl
   ) {}
 
   run() {
     this.settingController.reload();
 
+    browser.tabs.onUpdated.addListener((tabId: number, info) => {
+      if (info.status == "loading") {
+        this.findRepository.deleteLocalState(tabId);
+      }
+    });
     browser.runtime.onInstalled.addListener((details) => {
       if (details.reason !== "install" && details.reason !== "update") {
         return;
diff --git a/src/background/clients/FindClient.ts b/src/background/clients/FindClient.ts
new file mode 100644
index 0000000..863c5ad
--- /dev/null
+++ b/src/background/clients/FindClient.ts
@@ -0,0 +1,30 @@
+import * as messages from "../../shared/messages";
+
+export default interface FindClient {
+  findNext(tabId: number, frameId: number, keyword: string): Promise<boolean>;
+
+  clearSelection(tabId: number, frameId: number): Promise<void>;
+}
+
+export class FindClientImpl implements FindClient {
+  async findNext(
+    tabId: number,
+    frameId: number,
+    keyword: string
+  ): Promise<boolean> {
+    const found = (await browser.tabs.sendMessage(
+      tabId,
+      { type: messages.FIND_NEXT, keyword },
+      { frameId }
+    )) as boolean;
+    return found;
+  }
+
+  clearSelection(tabId: number, frameId: number): Promise<void> {
+    return browser.tabs.sendMessage(
+      tabId,
+      { type: messages.FIND_CLEAR_SELECTION },
+      { frameId }
+    );
+  }
+}
diff --git a/src/background/controllers/FindController.ts b/src/background/controllers/FindController.ts
new file mode 100644
index 0000000..0772866
--- /dev/null
+++ b/src/background/controllers/FindController.ts
@@ -0,0 +1,11 @@
+import { injectable } from "tsyringe";
+import StartFindUseCase from "../usecases/StartFindUseCase";
+
+@injectable()
+export default class FindController {
+  constructor(private startFindUseCase: StartFindUseCase) {}
+
+  startFind(tabId: number, keyword?: string): Promise<void> {
+    return this.startFindUseCase.startFind(tabId, keyword);
+  }
+}
diff --git a/src/background/di.ts b/src/background/di.ts
index a571c7d..e97c4a8 100644
--- a/src/background/di.ts
+++ b/src/background/di.ts
@@ -18,7 +18,10 @@ import { BrowserSettingRepositoryImpl } from "./repositories/BrowserSettingRepos
 import { RepeatRepositoryImpl } from "./repositories/RepeatRepository";
 import { ZoomPresenterImpl } from "./presenters/ZoomPresenter";
 import { WindowPresenterImpl } from "./presenters/WindowPresenter";
+import { FramePresenterImpl } from "./presenters/FramePresenter";
+import { FindClientImpl } from "./clients/FindClient";
 import { ConsoleFrameClientImpl } from "./clients/ConsoleFrameClient";
+import { FindRepositoryImpl } from "./repositories/FindRepository";
 
 container.register("LocalSettingRepository", {
   useClass: LocalSettingRepository,
@@ -40,6 +43,9 @@ container.register("TabRepository", { useClass: TabRepositoryImpl });
 container.register("ZoomPresenter", { useClass: ZoomPresenterImpl });
 container.register("TabPresenter", { useClass: TabPresenterImpl });
 container.register("WindowPresenter", { useClass: WindowPresenterImpl });
+container.register("FramePresenter", { useClass: FramePresenterImpl });
+container.register("FindRepository", { useClass: FindRepositoryImpl });
+container.register("FindClient", { useClass: FindClientImpl });
 container.register("NavigateClient", { useClass: NavigateClientImpl });
 container.register("ConsoleClient", { useClass: ConsoleClientImpl });
 container.register("ConsoleFrameClient", { useClass: ConsoleFrameClientImpl });
diff --git a/src/background/infrastructures/ContentMessageListener.ts b/src/background/infrastructures/ContentMessageListener.ts
index 6189e7c..ce7ff09 100644
--- a/src/background/infrastructures/ContentMessageListener.ts
+++ b/src/background/infrastructures/ContentMessageListener.ts
@@ -9,6 +9,7 @@ import OperationController from "../controllers/OperationController";
 import MarkController from "../controllers/MarkController";
 import CompletionController from "../controllers/CompletionController";
 import ConsoleController from "../controllers/ConsoleController";
+import FindController from "../controllers/FindController";
 
 @injectable()
 export default class ContentMessageListener {
@@ -22,7 +23,8 @@ export default class ContentMessageListener {
     private readonly linkController: LinkController,
     private readonly operationController: OperationController,
     private readonly markController: MarkController,
-    private readonly consoleController: ConsoleController
+    private readonly consoleController: ConsoleController,
+    private readonly findController: FindController
   ) {}
 
   run(): void {
@@ -80,6 +82,8 @@ export default class ContentMessageListener {
         return this.completionController.getProperties();
       case messages.CONSOLE_ENTER_COMMAND:
         return this.onConsoleEnterCommand(message.text);
+      case messages.CONSOLE_ENTER_FIND:
+        return this.findController.startFind(senderTab.id!, message.keyword);
       case messages.CONSOLE_RESIZE:
         return this.onConsoleResize(
           senderTab.id!,
diff --git a/src/background/operators/impls/FindNextOperator.ts b/src/background/operators/impls/FindNextOperator.ts
new file mode 100644
index 0000000..241f71d
--- /dev/null
+++ b/src/background/operators/impls/FindNextOperator.ts
@@ -0,0 +1,94 @@
+import Operator from "../Operator";
+import TabPresenter from "../../presenters/TabPresenter";
+import FindRepository from "../../repositories/FindRepository";
+import FindClient from "../../clients/FindClient";
+import ConsoleClient from "../../infrastructures/ConsoleClient";
+import FramePresenter from "../../presenters/FramePresenter";
+
+export default class FindNextOperator implements Operator {
+  constructor(
+    private readonly tabPresenter: TabPresenter,
+    private readonly findRepository: FindRepository,
+    private readonly findClient: FindClient,
+    private readonly consoleClient: ConsoleClient,
+    private readonly framePresenter: FramePresenter
+  ) {}
+
+  async run(): Promise<void> {
+    const tab = await this.tabPresenter.getCurrent();
+    const tabId = tab?.id;
+    if (tabId == null) {
+      return;
+    }
+
+    const state = await this.findRepository.getLocalState(tabId);
+    if (state) {
+      // Start to find the keyword from the current frame which last found on,
+      // and concat it to end of frame ids to perform a wrap-search
+      //
+      //                ,- keyword should be in this frame
+      //                |
+      // [100, 101, 0, 100]
+      //   |
+      //   `- continue from frame id 100
+      //
+      const targetFrameIds = state.frameIds
+        .slice(state.framePos)
+        .concat(
+          state.frameIds.slice(0, state.framePos),
+          state.frameIds[state.framePos]
+        );
+
+      for (let i = 0; i < targetFrameIds.length; ++i) {
+        const found = await this.findClient.findNext(
+          tabId,
+          targetFrameIds[i],
+          state.keyword
+        );
+        if (found) {
+          this.findRepository.setLocalState(tabId, {
+            ...state,
+            framePos: (i + state.framePos) % state.frameIds.length, // save current frame position or first
+          });
+          return;
+        }
+        this.findClient.clearSelection(tabId, targetFrameIds[i]);
+      }
+
+      // The keyword is gone.
+      this.consoleClient.showError(
+        tabId,
+        "Pattern not found: " + state.keyword
+      );
+      return;
+    }
+
+    const keyword = await this.findRepository.getGlobalKeyword();
+    if (keyword) {
+      const frameIds = await this.framePresenter.getAllFrameIds(tabId);
+      for (const frameId of frameIds) {
+        await this.findClient.clearSelection(tabId, frameId);
+      }
+
+      for (let framePos = 0; framePos < frameIds.length; ++framePos) {
+        const found = await this.findClient.findNext(
+          tabId,
+          frameIds[framePos],
+          keyword
+        );
+        if (found) {
+          await this.findRepository.setLocalState(tabId, {
+            frameIds,
+            framePos,
+            keyword,
+          });
+          await this.consoleClient.showInfo(tabId, "Pattern found: " + keyword);
+          return;
+        }
+      }
+      this.consoleClient.showError(tabId, "Pattern not found: " + keyword);
+      return;
+    }
+    await this.consoleClient.showError(tabId, "No previous search keywords");
+  }
+}
diff --git a/src/background/operators/impls/FindOperatorFactoryChain.ts b/src/background/operators/impls/FindOperatorFactoryChain.ts
new file mode 100644
index 0000000..b71f032
--- /dev/null
+++ b/src/background/operators/impls/FindOperatorFactoryChain.ts
@@ -0,0 +1,49 @@
+import { inject, injectable } from "tsyringe";
+import Operator from "../Operator";
+import OperatorFactoryChain from "../OperatorFactoryChain";
+import TabPresenter from "../../presenters/TabPresenter";
+import * as operations from "../../../shared/operations";
+import FindNextOperator from "./FindNextOperator";
+import FindPrevOperator from "./FindPrevOperator";
+import FindRepository from "../../repositories/FindRepository";
+import FindClient from "../../clients/FindClient";
+import FramePresenter from "../../presenters/FramePresenter";
+import ConsoleClient from "../../infrastructures/ConsoleClient";
+
+@injectable()
+export default class FindOperatorFactoryChain implements OperatorFactoryChain {
+  constructor(
+    @inject("TabPresenter")
+    private readonly tabPresenter: TabPresenter,
+    @inject("FindRepository")
+    private readonly findRepository: FindRepository,
+    @inject("FindClient")
+    private readonly findClient: FindClient,
+    @inject("ConsoleClient")
+    private readonly consoleClient: ConsoleClient,
+    @inject("FramePresenter")
+    private readonly framePresenter: FramePresenter
+  ) {}
+
+  create(op: operations.Operation): Operator | null {
+    switch (op.type) {
+      case operations.FIND_NEXT:
+        return new FindNextOperator(
+          this.tabPresenter,
+          this.findRepository,
+          this.findClient,
+          this.consoleClient,
+          this.framePresenter
+        );
+      case operations.FIND_PREV:
+        return new FindPrevOperator(
+          this.tabPresenter,
+          this.findRepository,
+          this.findClient,
+          this.consoleClient,
+          this.framePresenter
+        );
+    }
+    return null;
+  }
+}
diff --git a/src/background/operators/impls/FindPrevOperator.ts b/src/background/operators/impls/FindPrevOperator.ts
new file mode 100644
index 0000000..28238f6
--- /dev/null
+++ b/src/background/operators/impls/FindPrevOperator.ts
@@ -0,0 +1,20 @@
+import Operator from "../Operator";
+import TabPresenter from "../../presenters/TabPresenter";
+import FindRepository from "../../repositories/FindRepository";
+import FindClient from "../../clients/FindClient";
+import ConsoleClient from "../../infrastructures/ConsoleClient";
+import FramePresenter from "../../presenters/FramePresenter";
+
+export default class FindPrevOperator implements Operator {
+  constructor(
+    _tabPresenter: TabPresenter,
+    _findRepository: FindRepository,
+    _findClient: FindClient,
+    _consoleClient: ConsoleClient,
+    _framePresenter: FramePresenter
+  ) {}
+
+  async run(): Promise<void> {
+    throw new Error("not implemented");
+  }
+}
diff --git a/src/background/operators/impls/OperatorFactoryImpl.ts b/src/background/operators/impls/OperatorFactoryImpl.ts
index 34e7bb5..ce87491 100644
--- a/src/background/operators/impls/OperatorFactoryImpl.ts
+++ b/src/background/operators/impls/OperatorFactoryImpl.ts
@@ -8,6 +8,7 @@ import NavigateOperatorFactoryChain from "./NavigateOperatorFactoryChain";
 import RepeatOperatorFactoryChain from "./RepeatOperatorFactoryChain";
 import TabOperatorFactoryChain from "./TabOperatorFactoryChain";
 import ZoomOperatorFactoryChain from "./ZoomOperatorFactoryChain";
+import FindOperatorFactoryChain from "./FindOperatorFactoryChain";
 import * as operations from "../../../shared/operations";
 
 @injectable()
@@ -20,6 +21,7 @@ export class OperatorFactoryImpl implements OperatorFactory {
     navigateOperatorFactoryChain: NavigateOperatorFactoryChain,
     tabOperatorFactoryChain: TabOperatorFactoryChain,
     zoomOperatorFactoryChain: ZoomOperatorFactoryChain,
+    findOperatorFactoryChain: FindOperatorFactoryChain,
     @inject(delay(() => RepeatOperatorFactoryChain))
     repeatOperatorFactoryChain: RepeatOperatorFactoryChain
   ) {
@@ -30,6 +32,7 @@ export class OperatorFactoryImpl implements OperatorFactory {
       repeatOperatorFactoryChain,
       tabOperatorFactoryChain,
       zoomOperatorFactoryChain,
+      findOperatorFactoryChain,
     ];
   }
 
diff --git a/src/background/presenters/FramePresenter.ts b/src/background/presenters/FramePresenter.ts
new file mode 100644
index 0000000..c94f8dd
--- /dev/null
+++ b/src/background/presenters/FramePresenter.ts
@@ -0,0 +1,12 @@
+export default interface FramePresenter {
+  getAllFrameIds(tabId: number): Promise<Array<number>>;
+}
+
+export class FramePresenterImpl implements FramePresenter {
+  async getAllFrameIds(tabId: number): Promise<Array<number>> {
+    const frames = await browser.webNavigation.getAllFrames({ tabId: tabId });
+    return frames
+      .filter((f) => !f.url.startsWith("moz-extension://"))
+      .map((f) => f.frameId);
+  }
+}
diff --git a/src/background/repositories/FindRepository.ts b/src/background/repositories/FindRepository.ts
new file mode 100644
index 0000000..46ee390
--- /dev/null
+++ b/src/background/repositories/FindRepository.ts
@@ -0,0 +1,69 @@
+import { injectable } from "tsyringe";
+import MemoryStorage from "../infrastructures/MemoryStorage";
+
+const FIND_GLOBAL_KEYWORD_KEY = "find-global-keyword";
+const FIND_LOCAL_KEYWORD_KEY = "find-local-keyword";
+
+export type FindState = {
+  keyword: string;
+  framePos: number;
+  frameIds: number[];
+};
+
+export default interface FindRepository {
+  getGlobalKeyword(): Promise<string | undefined>;
+
+  setGlobalKeyword(keyword: string): Promise<void>;
+
+  getLocalState(tabId: number): Promise<undefined | FindState>;
+
+  setLocalState(tabId: number, state: FindState): Promise<void>;
+
+  deleteLocalState(tabId: number): Promise<void>;
+}
+
+@injectable()
+export class FindRepositoryImpl implements FindRepository {
+  private cache: MemoryStorage;
+
+  constructor() {
+    this.cache = new MemoryStorage();
+  }
+
+  getGlobalKeyword(): Promise<string | undefined> {
+    return Promise.resolve(this.cache.get(FIND_GLOBAL_KEYWORD_KEY));
+  }
+
+  setGlobalKeyword(keyword: string): Promise<void> {
+    this.cache.set(FIND_GLOBAL_KEYWORD_KEY, keyword);
+    return Promise.resolve();
+  }
+
+  getLocalState(tabId: number): Promise<FindState | undefined> {
+    let states = this.cache.get(FIND_LOCAL_KEYWORD_KEY);
+    if (typeof states === "undefined") {
+      states = {};
+    }
+    return Promise.resolve(states[tabId]);
+  }
+
+  setLocalState(tabId: number, state: FindState): Promise<void> {
+    let states = this.cache.get(FIND_LOCAL_KEYWORD_KEY);
+    if (typeof states === "undefined") {
+      states = {};
+    }
+    states[tabId] = state;
+    this.cache.set(FIND_LOCAL_KEYWORD_KEY, states);
+    return Promise.resolve();
+  }
+
+  deleteLocalState(tabId: number): Promise<void> {
+    const states = this.cache.get(FIND_LOCAL_KEYWORD_KEY);
+    if (typeof states === "undefined") {
+      return Promise.resolve();
+    }
+    delete states[tabId];
+    this.cache.set(FIND_LOCAL_KEYWORD_KEY, states);
+    return Promise.resolve();
+  }
+}
diff --git a/src/background/usecases/StartFindUseCase.ts b/src/background/usecases/StartFindUseCase.ts
new file mode 100644
index 0000000..066d930
--- /dev/null
+++ b/src/background/usecases/StartFindUseCase.ts
@@ -0,0 +1,57 @@
+import { inject, injectable } from "tsyringe";
+import ConsoleClient from "../infrastructures/ConsoleClient";
+import FindRepositoryImpl from "../repositories/FindRepository";
+import FindClient from "../clients/FindClient";
+import FramePresenter from "../presenters/FramePresenter";
+
+@injectable()
+export default class StartFindUseCase {
+  constructor(
+    @inject("FindClient")
+    private readonly findClient: FindClient,
+    @inject("FindRepository")
+    private readonly findRepository: FindRepositoryImpl,
+    @inject("ConsoleClient")
+    private readonly consoleClient: ConsoleClient,
+    @inject("FramePresenter")
+    private readonly framePresenter: FramePresenter
+  ) {}
+
+  async startFind(tabId: number, keyword?: string): Promise<void> {
+    if (typeof keyword === "undefined") {
+      keyword = (await this.findRepository.getLocalState(tabId))?.keyword;
+    }
+    if (typeof keyword === "undefined") {
+      keyword = await this.findRepository.getGlobalKeyword();
+    }
+    if (typeof keyword === "undefined") {
+      await this.consoleClient.showError(tabId, "No previous search keywords");
+      return;
+    }
+
+    this.findRepository.setGlobalKeyword(keyword);
+
+    const frameIds = await this.framePresenter.getAllFrameIds(tabId);
+    for (const frameId of frameIds) {
+      await this.findClient.clearSelection(tabId, frameId);
+    }
+
+    for (let framePos = 0; framePos < frameIds.length; ++framePos) {
+      const found = await this.findClient.findNext(
+        tabId,
+        frameIds[framePos],
+        keyword
+      );
+      if (found) {
+        await this.findRepository.setLocalState(tabId, {
+          frameIds,
+          framePos,
+          keyword,
+        });
+        await this.consoleClient.showInfo(tabId, "Pattern found: " + keyword);
+        return;
+      }
+    }
+    this.consoleClient.showError(tabId, "Pattern not found: " + keyword);
+  }
+}