From 68c4beab4669b64f31b92615d27ea7145effaaae Mon Sep 17 00:00:00 2001
From: Danil Boldyrev <daswerq123@gmail.com>
Date: Fri, 2 Jun 2023 01:04:17 +0300
Subject: [PATCH] Added the ability to configure hotkeys via webui

Now you can configure the hotkeys directly through the settings

JS and Python scripts are tested and code style compliant
---
 .../canvas-zoom-and-pan/javascript/zoom.js    | 88 ++++++++++++++-----
 .../scripts/hotkey_config.py                  |  8 ++
 2 files changed, 75 insertions(+), 21 deletions(-)
 create mode 100644 extensions-builtin/canvas-zoom-and-pan/scripts/hotkey_config.py

diff --git a/extensions-builtin/canvas-zoom-and-pan/javascript/zoom.js b/extensions-builtin/canvas-zoom-and-pan/javascript/zoom.js
index e39ce296e..4e0e5ba12 100644
--- a/extensions-builtin/canvas-zoom-and-pan/javascript/zoom.js
+++ b/extensions-builtin/canvas-zoom-and-pan/javascript/zoom.js
@@ -14,14 +14,60 @@ function getActiveTab(elements, all = false) {
     }
 }
 
+// Wait until opts loaded
+async function waitForOpts() {
+    return new Promise(resolve => {
+        const checkInterval = setInterval(() => {
+            if (window.opts && Object.keys(window.opts).length !== 0) {
+                clearInterval(checkInterval);
+                resolve(window.opts);
+            }
+        }, 100);
+    });
+}
+
+// Check is hotkey valid
+function isSingleLetter(value) {
+    return (
+        typeof value === "string" && value.length === 1 && /[a-z]/i.test(value)
+    );
+}
+
+// Create hotkeyConfig from opts
+function createHotkeyConfig(defaultHotkeysConfig, hotkeysConfigOpts) {
+    const result = {};
+    for (const key in defaultHotkeysConfig) {
+        if (hotkeysConfigOpts[key] && isSingleLetter(hotkeysConfigOpts[key])) {
+            // If the property passes the test, add 'Key' before it and save it
+            result[key] = "Key" + hotkeysConfigOpts[key].toUpperCase();
+        } else {
+            // Если свойство не прошло проверку, сохраняем значение по умолчанию
+            console.error(
+                `Hotkey: "${hotkeysConfigOpts[key]}" for ${key}, must contain only 1 letter. The default hotkey is set: ${defaultHotkeysConfig[key][3]}`
+            );
+            result[key] = defaultHotkeysConfig[key];
+        }
+    }
+    return result;
+}
+
+// Main
 onUiLoaded(async() => {
-    const hotkeysConfig = {
-        resetZoom: "KeyR",
-        fitToScreen: "KeyS",
-        moveKey: "KeyF",
-        overlap: "KeyO"
+    const hotkeysConfigOpts = await waitForOpts();
+
+    // Default config
+    const defaultHotkeysConfig = {
+        canvas_hotkey_reset: "KeyR",
+        canvas_hotkey_fullscreen: "KeyS",
+        canvas_hotkey_move: "KeyF",
+        canvas_hotkey_overlap: "KeyO"
     };
 
+    const hotkeysConfig = createHotkeyConfig(
+        defaultHotkeysConfig,
+        hotkeysConfigOpts
+    );
+
     let isMoving = false;
     let mouseX, mouseY;
 
@@ -65,25 +111,25 @@ onUiLoaded(async() => {
         // Add info about hotkets
         const hotkeys = [
             {key: "Shift + wheel", action: "Zoom canvas"},
+            {key: "Ctr+wheel", action: "Adjust brush size"},
             {
-                key: hotkeysConfig.moveKey.charAt(
-                    hotkeysConfig.moveKey.length - 1
-                ),
-                action: "Move canvas"
-            },
-            {
-                key: hotkeysConfig.resetZoom.charAt(
-                    hotkeysConfig.resetZoom.length - 1
+                key: hotkeysConfig.canvas_hotkey_reset.charAt(
+                    hotkeysConfig.canvas_hotkey_reset.length - 1
                 ),
                 action: "Reset zoom"
             },
             {
-                key: hotkeysConfig.fitToScreen.charAt(
-                    hotkeysConfig.fitToScreen.length - 1
+                key: hotkeysConfig.canvas_hotkey_fullscreen.charAt(
+                    hotkeysConfig.canvas_hotkey_fullscreen.length - 1
                 ),
                 action: "Fullscreen mode"
             },
-            {key: "Ctr+wheel", action: "Adjust brush size"}
+            {
+                key: hotkeysConfig.canvas_hotkey_move.charAt(
+                    hotkeysConfig.canvas_hotkey_move.length - 1
+                ),
+                action: "Move canvas"
+            }
         ];
         hotkeys.forEach(function(hotkey) {
             const p = document.createElement("p");
@@ -363,9 +409,9 @@ onUiLoaded(async() => {
         // Handle keydown events
         function handleKeyDown(event) {
             const hotkeyActions = {
-                [hotkeysConfig.resetZoom]: resetZoom,
-                [hotkeysConfig.overlap]: toggleOverlap,
-                [hotkeysConfig.fitToScreen]: fitToScreen
+                [hotkeysConfig.canvas_hotkey_reset]: resetZoom,
+                [hotkeysConfig.canvas_hotkey_overlap]: toggleOverlap,
+                [hotkeysConfig.canvas_hotkey_fullscreen]: fitToScreen
             };
 
             const action = hotkeyActions[event.code];
@@ -429,7 +475,7 @@ onUiLoaded(async() => {
 
         // Handle the move event for pan functionality. Updates the panX and panY variables and applies the new transform to the target element.
         function handleMoveKeyDown(e) {
-            if (e.code === hotkeysConfig.moveKey) {
+            if (e.code === hotkeysConfig.canvas_hotkey_move) {
                 if (!e.ctrlKey && !e.metaKey && isKeyDownHandlerAttached) {
                     e.preventDefault();
                     document.activeElement.blur();
@@ -439,7 +485,7 @@ onUiLoaded(async() => {
         }
 
         function handleMoveKeyUp(e) {
-            if (e.code === hotkeysConfig.moveKey) {
+            if (e.code === hotkeysConfig.canvas_hotkey_move) {
                 isMoving = false;
             }
         }
diff --git a/extensions-builtin/canvas-zoom-and-pan/scripts/hotkey_config.py b/extensions-builtin/canvas-zoom-and-pan/scripts/hotkey_config.py
new file mode 100644
index 000000000..de2c41297
--- /dev/null
+++ b/extensions-builtin/canvas-zoom-and-pan/scripts/hotkey_config.py
@@ -0,0 +1,8 @@
+from modules import shared
+
+shared.options_templates.update(shared.options_section(('canvas_hotkey', "Canvas hotkeys"), {
+    "canvas_hotkey_move": shared.OptionInfo("F", "Moving the canvas"),
+    "canvas_hotkey_fullscreen": shared.OptionInfo("S", "Fullscreen Mode, maximizes the picture so that it fits into the screen and stretches it to its full width "),
+    "canvas_hotkey_reset": shared.OptionInfo("R", "Reset zoom and canvas positon"),
+    "canvas_hotkey_overlap": shared.OptionInfo("O", "Toggle overlap ( Technical button, neededs for testing )"),
+}))