mirror of
https://github.com/ankitects/anki.git
synced 2025-11-12 23:57:13 -05:00
c2e8d89fc6
* Fix legacy colpkg import; disable v3 import/export; add roundtrip test The test has revealed we weren't decompressing the media files on v3 import. That's easy to fix, but means all files need decompressing even when they already exist, which is not ideal - it would be better to store size/checksum in the metadata instead. * Switch media and meta to protobuf; re-enable v3 import/export - Fixed media not being decompressed on import - The uncompressed size and checksum is now included for each media entry, so that we can quickly check if a given file needs to be extracted. We're still just doing a naive size comparison on colpkg import at the moment, but we may want to use a checksum in the future, and will need a checksum for apkg imports. - Checksums can't be efficiently encoded in JSON, so the media list has been switched to protobuf to reduce the the space requirements. - The meta file has been switched to protobuf as well, for consistency. This will mean any colpkg files exported with beta7 will be unreadable. * Avoid integer version comparisons * Re-enable v3 test * Apply suggestions from code review Co-authored-by: RumovZ <gp5glkw78@relay.firefox.com> * Add export_colpkg() method to Collection More discoverable, and easier to call from unit tests * Split import/export code out into separate folders Currently colpkg/*.rs contain some routines that will be useful for apkg import/export as well; in the future we can refactor them into a separate file in the parent module. * Return a proper error when media import fails This tripped me up when writing the earlier unit test - I had called the equivalent of import_colpkg()?, and it was returning a string error that I didn't notice. In practice this should result in the same text being shown in the UI, but just skips the tooltip. * Automatically create media folder on import * Move roundtrip test into separate file; check collection too * Remove zstd version suffix Prevents a warning shown each time Rust Analyzer is used to check the code. Co-authored-by: RumovZ <gp5glkw78@relay.firefox.com>
119 lines
2.8 KiB
Protocol Buffer
119 lines
2.8 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 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);
|
|
}
|
|
|
|
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 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;
|
|
}
|
|
}
|