Add apkg import/export on backend

.bazelrc

@@ -20,6 +20,9 @@ test --aspects=@rules_rust//rust:defs.bzl%rust_clippy_aspect --output_groups=+cl
 # print output when test fails
 test --test_output=errors
 
+# stop after one test failure
+test --notest_keep_going
+
 # don't add empty __init__.py files
 build --incompatible_default_to_explicit_init_py
 

ftl/core/exporting.ftl

@@ -5,7 +5,7 @@ exporting-anki-deck-package = Anki Deck Package
 exporting-cards-in-plain-text = Cards in Plain Text
 exporting-collection = collection
 exporting-collection-exported = Collection exported.
-exporting-colpkg-too-new = Please update to the latest Anki version, then import the .colpkg file again.
+exporting-colpkg-too-new = Please update to the latest Anki version, then import the .colpkg/.apkg file again.
 exporting-couldnt-save-file = Couldn't save file: { $val }
 exporting-export = Export...
 exporting-export-format = <b>Export format</b>:
@@ -14,6 +14,7 @@ exporting-include-html-and-media-references = Include HTML and media references
 exporting-include-media = Include media
 exporting-include-scheduling-information = Include scheduling information
 exporting-include-tags = Include tags
+exporting-support-older-anki-versions = Support older Anki versions (slower/larger files)
 exporting-notes-in-plain-text = Notes in Plain Text
 exporting-selected-notes = Selected Notes
 exporting-card-exported =

ftl/core/importing.ftl

@@ -78,4 +78,10 @@ importing-processed-media-file =
        *[other] Imported { $count } media files
     }
 importing-importing-collection = Importing collection...
+importing-importing-file = Importing file...
 importing-failed-to-import-media-file = Failed to import media file: { $debugInfo }
+importing-processed-notes =
+    { $count ->
+        [one] Processed { $count } note...
+       *[other] Processed { $count } notes...
+    }

proto/anki/import_export.proto

@@ -5,19 +5,25 @@ syntax = "proto3";
 
 package anki.import_export;
 
+import "anki/collection.proto";
+import "anki/notes.proto";
 import "anki/generic.proto";
 
 service ImportExportService {
   rpc ImportCollectionPackage(ImportCollectionPackageRequest)
       returns (generic.Empty);
   rpc ExportCollectionPackage(ExportCollectionPackageRequest)
       returns (generic.Empty);
+  rpc ImportAnkiPackage(ImportAnkiPackageRequest)
+      returns (ImportAnkiPackageResponse);
+  rpc ExportAnkiPackage(ExportAnkiPackageRequest) returns (generic.UInt32);
 }
 
 message ImportCollectionPackageRequest {
   string col_path = 1;
   string backup_path = 2;
   string media_folder = 3;
+  string media_db = 4;
 }
 
 message ExportCollectionPackageRequest {
@@ -26,6 +32,37 @@ message ExportCollectionPackageRequest {
   bool legacy = 3;
 }
 
+message ImportAnkiPackageRequest {
+  string package_path = 1;
+}
+
+message ImportAnkiPackageResponse {
+  message Note {
+    notes.NoteId id = 1;
+    repeated string fields = 2;
+  }
+  message Log {
+    repeated Note new = 1;
+    repeated Note updated = 2;
+    repeated Note duplicate = 3;
+    repeated Note conflicting = 4;
+  }
+  collection.OpChanges changes = 1;
+  Log log = 2;
+}
+
+message ExportAnkiPackageRequest {
+  string out_path = 1;
+  bool with_scheduling = 2;
+  bool with_media = 3;
+  bool legacy = 4;
+  oneof selector {
+    generic.Empty whole_collection = 5;
+    int64 deck_id = 6;
+    notes.NoteIds note_ids = 7;
+  }
+}
+
 message PackageMetadata {
   enum Version {
     VERSION_UNKNOWN = 0;

pylib/.pylintrc

@@ -22,6 +22,7 @@ ignored-classes=
   CustomStudyRequest,
   Cram,
   ScheduleCardsAsNewRequest,
+  ExportAnkiPackageRequest,
 
 [REPORTS]
 output-format=colorized

pylib/anki/collection.py

@@ -10,6 +10,7 @@
     collection_pb2,
     config_pb2,
     generic_pb2,
+    import_export_pb2,
     links_pb2,
     search_pb2,
     stats_pb2,
@@ -32,6 +33,7 @@
 BrowserRow = search_pb2.BrowserRow
 BrowserColumns = search_pb2.BrowserColumns
 StripHtmlMode = card_rendering_pb2.StripHtmlRequest
+ImportLogWithChanges = import_export_pb2.ImportAnkiPackageResponse
 
 import copy
 import os
@@ -90,6 +92,19 @@ class LegacyCheckpoint:
 LegacyUndoResult = Union[None, LegacyCheckpoint, LegacyReviewUndo]
 
 
+@dataclass
+class DeckIdLimit:
+    deck_id: DeckId
+
+
+@dataclass
+class NoteIdsLimit:
+    note_ids: Sequence[NoteId]
+
+
+ExportLimit = Union[DeckIdLimit, NoteIdsLimit, None]
+
+
 class Collection(DeprecatedNamesMixin):
     sched: V1Scheduler | V2Scheduler | V3Scheduler
 
@@ -259,14 +274,6 @@ def close_for_full_sync(self) -> None:
             self._clear_caches()
             self.db = None
 
-    def export_collection(
-        self, out_path: str, include_media: bool, legacy: bool
-    ) -> None:
-        self.close_for_full_sync()
-        self._backend.export_collection_package(
-            out_path=out_path, include_media=include_media, legacy=legacy
-        )
-
     def rollback(self) -> None:
         self._clear_caches()
         self.db.rollback()
@@ -321,6 +328,15 @@ def usn(self) -> int:
         else:
             return -1
 
+    def legacy_checkpoint_pending(self) -> bool:
+        return (
+            self._have_outstanding_checkpoint()
+            and time.time() - self._last_checkpoint_at < 300
+        )
+
+    # Import/export
+    ##########################################################################
+
     def create_backup(
         self,
         *,
@@ -353,12 +369,40 @@ def await_backup_completion(self) -> None:
         "Throws if backup creation failed."
         self._backend.await_backup_completion()
 
-    def legacy_checkpoint_pending(self) -> bool:
-        return (
-            self._have_outstanding_checkpoint()
-            and time.time() - self._last_checkpoint_at < 300
+    def export_collection_package(
+        self, out_path: str, include_media: bool, legacy: bool
+    ) -> None:
+        self.close_for_full_sync()
+        self._backend.export_collection_package(
+            out_path=out_path, include_media=include_media, legacy=legacy
         )
 
+    def import_anki_package(self, path: str) -> ImportLogWithChanges:
+        return self._backend.import_anki_package(package_path=path)
+
+    def export_anki_package(
+        self,
+        *,
+        out_path: str,
+        limit: ExportLimit,
+        with_scheduling: bool,
+        with_media: bool,
+        legacy_support: bool,
+    ) -> int:
+        request = import_export_pb2.ExportAnkiPackageRequest(
+            out_path=out_path,
+            with_scheduling=with_scheduling,
+            with_media=with_media,
+            legacy=legacy_support,
+        )
+        if isinstance(limit, DeckIdLimit):
+            request.deck_id = limit.deck_id
+        elif isinstance(limit, NoteIdsLimit):
+            request.note_ids.note_ids.extend(limit.note_ids)
+        else:
+            request.whole_collection.SetInParent()
+        return self._backend.export_anki_package(request)
+
     # Object helpers
     ##########################################################################
 

pylib/anki/exporting.py

@@ -446,7 +446,7 @@ def progress() -> None:
                 time.sleep(0.1)
 
         threading.Thread(target=progress).start()
-        self.col.export_collection(path, self.includeMedia, self.LEGACY)
+        self.col.export_collection_package(path, self.includeMedia, self.LEGACY)
 
 
 class AnkiCollectionPackage21bExporter(AnkiCollectionPackageExporter):

pylib/anki/import_export_pb2.pyi

@@ -0,0 +1 @@
+../../.bazel/bin/pylib/anki/import_export_pb2.pyi

pylib/anki/importing/anki2.py

@@ -25,6 +25,10 @@ class V2ImportIntoV1(Exception):
     pass
 
 
+class MediaMapInvalid(Exception):
+    pass
+
+
 class Anki2Importer(Importer):
 
     needMapper = False

pylib/anki/importing/apkg.py

@@ -9,7 +9,7 @@
 import zipfile
 from typing import Any, Optional
 
-from anki.importing.anki2 import Anki2Importer
+from anki.importing.anki2 import Anki2Importer, MediaMapInvalid
 from anki.utils import tmpfile
 
 
@@ -36,7 +36,11 @@ def run(self) -> None:  # type: ignore
         # number to use during the import
         self.nameToNum = {}
         dir = self.col.media.dir()
-        for k, v in list(json.loads(z.read("media").decode("utf8")).items()):
+        try:
+            media_dict = json.loads(z.read("media").decode("utf8"))
+        except Exception as exc:
+            raise MediaMapInvalid() from exc
+        for k, v in list(media_dict.items()):
             path = os.path.abspath(os.path.join(dir, v))
             if os.path.commonprefix([path, dir]) != dir:
                 raise Exception("Invalid file")

qt/aqt/browser/browser.py

@@ -23,7 +23,8 @@
 from anki.utils import is_mac
 from aqt import AnkiQt, gui_hooks
 from aqt.editor import Editor
-from aqt.exporting import ExportDialog
+from aqt.exporting import ExportDialog as LegacyExportDialog
+from aqt.import_export.exporting import ExportDialog
 from aqt.operations.card import set_card_deck, set_card_flag
 from aqt.operations.collection import redo, undo
 from aqt.operations.note import remove_notes
@@ -792,8 +793,12 @@ def suspend_selected_cards(self, checked: bool) -> None:
     @no_arg_trigger
     @skip_if_selection_is_empty
     def _on_export_notes(self) -> None:
-        cids = self.selectedNotesAsCards()
-        ExportDialog(self.mw, cids=list(cids))
+        if self.mw.pm.new_import_export():
+            nids = self.selected_notes()
+            ExportDialog(self.mw, nids=nids)
+        else:
+            cids = self.selectedNotesAsCards()
+            LegacyExportDialog(self.mw, cids=list(cids))
 
     # Flags & Marking
     ######################################################################

qt/aqt/errors.py

@@ -12,7 +12,7 @@
 from markdown import markdown
 
 import aqt
-from anki.errors import DocumentedError, LocalizedError
+from anki.errors import DocumentedError, Interrupted, LocalizedError
 from aqt.qt import *
 from aqt.utils import showText, showWarning, supportText, tr
 
@@ -22,7 +22,7 @@
 
 def show_exception(*, parent: QWidget, exception: Exception) -> None:
     "Present a caught exception to the user using a pop-up."
-    if isinstance(exception, InterruptedError):
+    if isinstance(exception, Interrupted):
         # nothing to do
         return
     help_page = exception.help_page if isinstance(exception, DocumentedError) else None

qt/aqt/exporting.py

@@ -40,6 +40,7 @@ def __init__(
         self.col = mw.col.weakref()
         self.frm = aqt.forms.exporting.Ui_ExportDialog()
         self.frm.setupUi(self)
+        self.frm.legacy_support.setVisible(False)
         self.exporter: Exporter | None = None
         self.cids = cids
         disable_help_button(self)

qt/aqt/forms/exporting.ui

@@ -6,8 +6,8 @@
    <rect>
     <x>0</x>
     <y>0</y>
-    <width>295</width>
-    <height>223</height>
+    <width>563</width>
+    <height>245</height>
    </rect>
   </property>
   <property name="windowTitle">
@@ -30,7 +30,14 @@
       </widget>
      </item>
      <item row="0" column="1">
-      <widget class="QComboBox" name="format"/>
+      <widget class="QComboBox" name="format">
+       <property name="sizePolicy">
+        <sizepolicy hsizetype="MinimumExpanding" vsizetype="Fixed">
+         <horstretch>0</horstretch>
+         <verstretch>0</verstretch>
+        </sizepolicy>
+       </property>
+      </widget>
      </item>
      <item row="1" column="0">
       <widget class="QLabel" name="label_2">
@@ -40,7 +47,11 @@
       </widget>
      </item>
      <item row="1" column="1">
-      <widget class="QComboBox" name="deck"/>
+      <widget class="QComboBox" name="deck">
+       <property name="minimumContentsLength">
+        <number>50</number>
+       </property>
+      </widget>
      </item>
     </layout>
    </item>
@@ -83,6 +94,16 @@
        </property>
       </widget>
      </item>
+     <item>
+      <widget class="QCheckBox" name="legacy_support">
+       <property name="text">
+        <string>exporting_support_older_anki_versions</string>
+       </property>
+       <property name="checked">
+        <bool>true</bool>
+       </property>
+      </widget>
+     </item>
     </layout>
    </item>
    <item>