mirror of
https://github.com/ankitects/anki.git
synced 2025-11-16 09:37:12 -05:00
e759885734
* Implement colpkg exporting on backend * Use exporting logic in backup.rs * Refactor exporting.rs * Add backend function to export collection * Refactor backend/collection.rs * Use backend for colpkg exporting * Don't use default zip compression for media * Add exporting progress * Refactor media file writing * Write dummy collections * Localize dummy collection note * Minimize dummy db size * Use `NamedTempFile::new()` instead of `new_in` * Drop redundant v2 dummy collection * COLLECTION_VERSION -> PACKAGE_VERSION * Split `lock_collection()` into two to drop flag * Expose new colpkg in GUI * Improve dummy collection message * Please type checker * importing-colpkg-too-new -> exporting-... * Compress the media map in the v3 package (dae) On collections with lots of media, it can grow into megabytes. Also return an error in extract_media_file_names(), instead of masking it as an optional. * Store media map as a vector in the v3 package (dae) This compresses better (eg 280kb original, 100kb hashmap, 42kb vec) In the colpkg import case we don't need random access. When importing an apkg, we will need to be able to fetch file data for a given media filename, but the existing map doesn't help us there, as we need filename->index, not index->filename. * Ensure folders in the media dir don't break the file mapping (dae)
133 lines
3.1 KiB
Protocol Buffer
133 lines
3.1 KiB
Protocol Buffer
// Copyright: Ankitects Pty Ltd and contributors
|
|
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
|
|
|
|
syntax = "proto3";
|
|
|
|
package anki.collection;
|
|
|
|
import "anki/generic.proto";
|
|
|
|
service CollectionService {
|
|
rpc OpenCollection(OpenCollectionRequest) returns (generic.Empty);
|
|
rpc CloseCollection(CloseCollectionRequest) returns (generic.Empty);
|
|
rpc RestoreBackup(RestoreBackupRequest) returns (generic.String);
|
|
rpc CheckDatabase(generic.Empty) returns (CheckDatabaseResponse);
|
|
rpc GetUndoStatus(generic.Empty) returns (UndoStatus);
|
|
rpc Undo(generic.Empty) returns (OpChangesAfterUndo);
|
|
rpc Redo(generic.Empty) returns (OpChangesAfterUndo);
|
|
rpc AddCustomUndoEntry(generic.String) returns (generic.UInt32);
|
|
rpc MergeUndoEntries(generic.UInt32) returns (OpChanges);
|
|
rpc LatestProgress(generic.Empty) returns (Progress);
|
|
rpc SetWantsAbort(generic.Empty) returns (generic.Empty);
|
|
rpc AwaitBackupCompletion(generic.Empty) returns (generic.Empty);
|
|
rpc ExportCollection(ExportCollectionRequest) returns (generic.Empty);
|
|
}
|
|
|
|
message OpenCollectionRequest {
|
|
string collection_path = 1;
|
|
string media_folder_path = 2;
|
|
string media_db_path = 3;
|
|
string log_path = 4;
|
|
}
|
|
|
|
message CloseCollectionRequest {
|
|
bool downgrade_to_schema11 = 1;
|
|
// Skip backup if unset
|
|
optional string backup_folder = 2;
|
|
// Skip backup if one has been created in the last x seconds.
|
|
// If unset a default value is used.
|
|
optional uint64 minimum_backup_interval = 3;
|
|
}
|
|
|
|
message RestoreBackupRequest {
|
|
string col_path = 1;
|
|
string backup_path = 2;
|
|
string media_folder = 3;
|
|
}
|
|
|
|
message CheckDatabaseResponse {
|
|
repeated string problems = 1;
|
|
}
|
|
|
|
message OpChanges {
|
|
bool card = 1;
|
|
bool note = 2;
|
|
bool deck = 3;
|
|
bool tag = 4;
|
|
bool notetype = 5;
|
|
bool config = 6;
|
|
bool deck_config = 11;
|
|
bool mtime = 12;
|
|
|
|
bool browser_table = 7;
|
|
bool browser_sidebar = 8;
|
|
// editor and displayed card in review screen
|
|
bool note_text = 9;
|
|
// whether to call .reset() and getCard()
|
|
bool study_queues = 10;
|
|
}
|
|
|
|
message OpChangesWithCount {
|
|
uint32 count = 1;
|
|
OpChanges changes = 2;
|
|
}
|
|
|
|
message OpChangesWithId {
|
|
int64 id = 1;
|
|
OpChanges changes = 2;
|
|
}
|
|
|
|
message UndoStatus {
|
|
string undo = 1;
|
|
string redo = 2;
|
|
uint32 last_step = 3;
|
|
}
|
|
|
|
message OpChangesAfterUndo {
|
|
OpChanges changes = 1;
|
|
string operation = 2;
|
|
int64 reverted_to_timestamp = 3;
|
|
UndoStatus new_status = 4;
|
|
uint32 counter = 5;
|
|
}
|
|
|
|
message Progress {
|
|
message MediaSync {
|
|
string checked = 1;
|
|
string added = 2;
|
|
string removed = 3;
|
|
}
|
|
|
|
message FullSync {
|
|
uint32 transferred = 1;
|
|
uint32 total = 2;
|
|
}
|
|
|
|
message NormalSync {
|
|
string stage = 1;
|
|
string added = 2;
|
|
string removed = 3;
|
|
}
|
|
|
|
message DatabaseCheck {
|
|
string stage = 1;
|
|
uint32 stage_total = 2;
|
|
uint32 stage_current = 3;
|
|
}
|
|
oneof value {
|
|
generic.Empty none = 1;
|
|
MediaSync media_sync = 2;
|
|
string media_check = 3;
|
|
FullSync full_sync = 4;
|
|
NormalSync normal_sync = 5;
|
|
DatabaseCheck database_check = 6;
|
|
string importing = 7;
|
|
uint32 exporting = 8;
|
|
}
|
|
}
|
|
|
|
message ExportCollectionRequest {
|
|
string out_path = 1;
|
|
bool include_media = 2;
|
|
bool legacy = 3;
|
|
}
|