Merge pull request #23 from gugutu/master

The previous implementation may encounter issues in specific scenarios and could potentially become invalid after Anki updates. Now, the approach has been modified to check whether the note content has been modified, which is a simpler and more understandable method.

.drone.yml

@@ -13,7 +13,7 @@ steps:
     image: debian:bookworm
     pull: always
     commands:
-      - apt-get update && apt-get install -y zip slugify
+      - apt-get update && apt-get install -y zip
       - ./build.sh
 
   - name: Upload Artifact to Gitea
@@ -25,8 +25,7 @@ steps:
         from_secret: gitea_api_token
       checksum: sha256
       base_url: https://git.tobiasmanske.de
-      files:
-        - "*.ankiaddon"
+      files: editor-preview.ankiaddon
 
 image_pull_secrets:
   - registry

.gitignore

@@ -117,6 +117,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.idea
 
 # Spyder project settings
 .spyderproject
@@ -169,4 +170,3 @@ tags
 
 # Stores actual addon config if the src directory is symlinked into an anki installation during development
 src/meta.json
-src/manifest.json

build.sh

@@ -1,27 +1,11 @@
 #!/bin/bash
 set -e
-set -o nounset
-
-SLUG=$(slugify "${DRONE_COMMIT_REF}")
 
 if [ -d src/__pycache__ ]; then
     rm -r src/__pycache__
 fi
 
 cd src
-
-# Create Manifest
-cat - > manifest.json <<EOF
-{
-  "name": "Editor Live Preview - ${SLUG}",
-  "package": "editor-live-preview-${SLUG}"
-}
-EOF
-
-zip -r ../editor-preview-external.ankiaddon --exclude meta.json -- *
-zip -r ../editor-preview-ankiweb.ankiaddon --exclude meta.json --exclude manifest.json -- *
+zip -r ../editor-preview.ankiaddon --exclude meta.json -- *
 cd ..
-echo "Ankiweb Contents"
-unzip -l editor-preview-ankiweb.ankiaddon
-echo "External Contents"
-unzip -l editor-preview-external.ankiaddon
+unzip -l  editor-preview.ankiaddon

src/__init__.py

@@ -1,4 +1,5 @@
 import json
+from typing import Set
 
 from anki import hooks, buildinfo
 from aqt import editor, gui_hooks, mw
@@ -10,6 +11,7 @@ config = mw.addonManager.getConfig(__name__)
 
 
 class EditorPreview(object):
+    editors: Set[editor.Editor] = set()
     js = [
         "js/mathjax.js",
         "js/vendor/mathjax/tex-chtml.js",
@@ -19,8 +21,18 @@ class EditorPreview(object):
     def __init__(self):
         gui_hooks.editor_did_init.append(self.editor_init_hook)
         gui_hooks.editor_did_init_buttons.append(self.editor_init_button_hook)
-        self.scrollLock = config["enableScrollLockByDefault"]
-        if int(buildinfo.version.split(".")[2]) < 45:  # < 2.1.45
+        gui_hooks.editor_did_load_note.append(self.editor_note_hook)
+        gui_hooks.editor_did_fire_typing_timer.append(self.onedit_hook)
+        buildversion = buildinfo.version.split(".")
+
+        # Anki changed their versioning scheme in 2023 to year.month(.patch), causing things to explode here.
+        if int(buildversion[0]) >= 24 or (int(buildversion[0]) == 23 and int(buildversion[1]) == 12 and 2 < len(buildversion) and int(buildversion[2])) >= 1:  # >= 23.12.1
+            self.js = [
+                "js/mathjax.js",
+                "js/vendor/mathjax/tex-chtml-full.js",
+                "js/reviewer.js",
+            ]
+        elif int(buildversion[0]) < 23 and int(buildversion[2]) < 45:  # < 2.1.45
             self.js = [
                 "js/vendor/jquery.min.js",
                 "js/vendor/css_browser_selector.min.js",
@@ -43,34 +55,29 @@ class EditorPreview(object):
             ed.editor_preview.hide()
 
         self._inject_splitter(ed)
-        gui_hooks.editor_did_fire_typing_timer.append(lambda o: self.onedit_hook(ed, o))
-        gui_hooks.editor_did_load_note.append(
-            lambda o: None if o != ed else self.editor_note_hook(o)
-        )
 
     def _get_splitter(self, editor):
-        layout = editor.outerLayout
-        mainR, editorR = [int(r) for r in config["splitRatio"].split(":")]
+        mainR, editorR = [int(r) * 10000 for r in config["splitRatio"].split(":")]
         location = config["location"]
         split = QSplitter()
         if location == "above":
-            split.setOrientation(Qt.Vertical)
+            split.setOrientation(Qt.Orientation.Vertical)
             split.addWidget(editor.editor_preview)
-            split.addWidget(editor.web)
+            split.addWidget(editor.wrapped_web)
             sizes = [editorR, mainR]
         elif location == "below":
-            split.setOrientation(Qt.Vertical)
-            split.addWidget(editor.web)
+            split.setOrientation(Qt.Orientation.Vertical)
+            split.addWidget(editor.wrapped_web)
             split.addWidget(editor.editor_preview)
             sizes = [mainR, editorR]
         elif location == "left":
-            split.setOrientation(Qt.Horizontal)
+            split.setOrientation(Qt.Orientation.Horizontal)
             split.addWidget(editor.editor_preview)
-            split.addWidget(editor.web)
+            split.addWidget(editor.wrapped_web)
             sizes = [editorR, mainR]
         elif location == "right":
-            split.setOrientation(Qt.Horizontal)
-            split.addWidget(editor.web)
+            split.setOrientation(Qt.Orientation.Horizontal)
+            split.addWidget(editor.wrapped_web)
             split.addWidget(editor.editor_preview)
             sizes = [mainR, editorR]
         else:
@@ -80,45 +87,43 @@ class EditorPreview(object):
         return split
 
     def _inject_splitter(self, editor: editor.Editor):
-        layout = editor.outerLayout
+        layout = editor.web.parentWidget().layout()
+        if layout is None:
+            layout = QVBoxLayout()
+            editor.web.parentWidget().setLayout(layout)
         web_index = layout.indexOf(editor.web)
         layout.removeWidget(editor.web)
 
+        # Wrap a widget on the outer layer of the webview
+        # So that other plugins can continue to modify the layout
+        editor.wrapped_web = QWidget()
+        wrapLayout = QHBoxLayout()
+        editor.wrapped_web.setLayout(wrapLayout)
+        wrapLayout.addWidget(editor.web)
+
         split = self._get_splitter(editor)
         layout.insertWidget(web_index, split)
 
-    def isScrollLocked(self):
-        return self.scrollLock
-
-    def toggleScrollLock(self):
-        self.scrollLock = not self.scrollLock
-
     def editor_note_hook(self, editor):
-        # Dont lock the editor in place when loading a new note
-        # i.e. when using the cards browser
-        self.onedit_hook(editor, editor.note, keep_scrollbar_value=False)
+        self.editors = set(filter(lambda it: it.note is not None, self.editors))
+        self.editors.add(editor)
+        # The initial loading of notes will also trigger an editing event
+        # which will cause a second refresh
+        # Caching the content of notes here will be used to determine if the content has changed
+        editor.cached_fields = list(editor.note.fields)
+        self.refresh(editor)
 
     def editor_init_button_hook(self, buttons, editor):
         addon_path = os.path.dirname(__file__)
         icons_dir = os.path.join(addon_path, "icons")
-        previewButton = editor.addButton(
+        b = editor.addButton(
             icon=os.path.join(icons_dir, "file.svg"),
             cmd="_editor_toggle_preview",
             tip="Toggle Live Preview",
             func=lambda o=editor: self.onEditorPreviewButton(o),
             disables=False,
         )
-        scrollLockButton = editor.addButton(
-            # icon=os.path.join(icons_dir, "file.svg"),
-            icon=None,
-            label="🔒",
-            cmd="_editor_toggle_scroll_lock",
-            tip="Toggle Scroll Locking",
-            func=lambda o=editor: self.onEditorScrollLockButton(o),
-            disables=True,
-        )
-        buttons.append(previewButton)
-        buttons.append(scrollLockButton)
+        buttons.append(b)
 
     def onEditorPreviewButton(self, origin: editor.Editor):
         if origin.editor_preview.isHidden():
@@ -126,29 +131,22 @@ class EditorPreview(object):
         else:
             origin.editor_preview.hide()
 
-    def onEditorScrollLockButton(self, origin: editor.Editor):
-        self.toggleScrollLock()
-
     def _obtainCardText(self, note):
         c = note.ephemeral_card()
         a = mw.prepare_card_text_for_display(c.answer())
         a = gui_hooks.card_will_show(a, c, "clayoutAnswer")
-        bodyclass = theme_manager.body_classes_for_card_ord(
-            c.ord, theme_manager.night_mode
-        )
+        bodyclass = theme_manager.body_classes_for_card_ord(c.ord, theme_manager.night_mode)
         bodyclass += " editor-preview"
 
         return f"_showAnswer({json.dumps(a)},'{bodyclass}');"
 
-    def onedit_hook(self, editor, origin, keep_scrollbar_value=True):
-        if editor.note == origin:
-            page: QWebEnginePage = editor.editor_preview.page()
-            scrollbar_value = page.scrollPosition()
-            editor.editor_preview.eval(self._obtainCardText(editor.note))
-            if keep_scrollbar_value and self.isScrollLocked():
-                page.runJavaScript(
-                    f"window.scrollTo({scrollbar_value.x()}, {scrollbar_value.y()});"
-                )
+    def onedit_hook(self, note):
+        for editor in self.editors:
+            if editor.note == note and editor.cached_fields != note.fields:
+                editor.cached_fields = list(note.fields)
+                self.refresh(editor)
 
+    def refresh(self, editor):
+        editor.editor_preview.eval(self._obtainCardText(editor.note))
 
 eprev = EditorPreview()

src/config.json

@@ -1,6 +1,5 @@
 {
   "showPreviewAutomatically": true,
   "splitRatio": "1:1",
-  "location": "below",
-  "enableScrollLockByDefault": true
+  "location": "below"
 }

src/config.md

@@ -7,6 +7,3 @@
 \- `location` [string (above | below | left | right)]:<br/>
 &nbsp;&nbsp;&nbsp;Defines where to render the preview (default: below)
 <br/>
-\- `showPreviewAutomatically` [boolean (true | false)]:<br/>
-&nbsp;&nbsp;&nbsp;Whether to keep the scrollbar at the same location when text changed or not (default: true)<br/>
-<br/>