anki/qt/aqt/sync.py

330 lines
8.7 KiB
Python
Raw Normal View History

2019-02-05 04:59:03 +01:00
# Copyright: Ankitects Pty Ltd and contributors
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
2020-05-30 04:28:22 +02:00
from __future__ import annotations
import enum
import os
2020-05-30 04:28:22 +02:00
from typing import Callable, Tuple
import aqt
2020-08-24 15:37:13 +02:00
from anki.lang import without_unicode_isolation
2020-05-30 04:28:22 +02:00
from anki.rsbackend import (
TR,
FullSyncProgress,
Interrupted,
NormalSyncProgress,
2020-05-30 04:28:22 +02:00
ProgressKind,
SyncError,
SyncErrorKind,
SyncOutput,
SyncStatus,
2020-05-30 04:28:22 +02:00
)
from anki.utils import platDesc
2020-05-30 04:28:22 +02:00
from aqt.qt import (
QDialog,
QDialogButtonBox,
QGridLayout,
QLabel,
QLineEdit,
Qt,
QTimer,
QVBoxLayout,
qconnect,
)
2020-05-30 12:52:32 +02:00
from aqt.utils import askUser, askUserDialog, showText, showWarning, tr
2020-05-30 04:28:22 +02:00
class FullSyncChoice(enum.Enum):
CANCEL = 0
UPLOAD = 1
DOWNLOAD = 2
def get_sync_status(mw: aqt.main.AnkiQt, callback: Callable[[SyncStatus], None]):
2020-05-30 04:28:22 +02:00
auth = mw.pm.sync_auth()
if not auth:
2020-06-02 09:58:14 +02:00
return SyncStatus(required=SyncStatus.NO_CHANGES) # pylint:disable=no-member
2020-05-30 04:28:22 +02:00
2020-05-31 02:53:54 +02:00
def on_future_done(fut):
try:
out = fut.result()
except Exception as e:
# swallow errors
print("sync status check failed:", str(e))
return
callback(out)
2020-05-30 04:28:22 +02:00
mw.taskman.run_in_background(
lambda: mw.col.backend.sync_status(auth), on_future_done
)
2020-05-30 04:28:22 +02:00
def handle_sync_error(mw: aqt.main.AnkiQt, err: Exception):
if isinstance(err, SyncError):
if err.kind() == SyncErrorKind.AUTH_FAILED:
mw.pm.clear_sync_auth()
elif isinstance(err, Interrupted):
# no message to show
return
showWarning(str(err))
def on_normal_sync_timer(mw: aqt.main.AnkiQt) -> None:
progress = mw.col.latest_progress()
if progress.kind != ProgressKind.NormalSync:
return
assert isinstance(progress.val, NormalSyncProgress)
mw.progress.update(
label=f"{progress.val.added}\n{progress.val.removed}", process=False,
)
mw.progress.set_title(progress.val.stage)
if mw.progress.want_cancel():
mw.col.backend.abort_sync()
2020-05-31 02:53:54 +02:00
def sync_collection(mw: aqt.main.AnkiQt, on_done: Callable[[], None]) -> None:
2020-05-30 04:28:22 +02:00
auth = mw.pm.sync_auth()
assert auth
2020-05-30 04:28:22 +02:00
def on_timer():
on_normal_sync_timer(mw)
timer = QTimer(mw)
qconnect(timer.timeout, on_timer)
timer.start(150)
2020-05-31 02:53:54 +02:00
def on_future_done(fut):
2020-05-30 04:28:22 +02:00
mw.col.db.begin()
timer.stop()
2020-05-30 06:19:21 +02:00
try:
out: SyncOutput = fut.result()
except Exception as err:
handle_sync_error(mw, err)
2020-05-31 02:53:54 +02:00
return on_done()
2020-05-30 06:19:21 +02:00
2020-05-30 04:28:22 +02:00
mw.pm.set_host_number(out.host_number)
2020-05-30 12:52:32 +02:00
if out.server_message:
showText(out.server_message)
2020-05-30 04:28:22 +02:00
if out.required == out.NO_CHANGES:
# all done
2020-05-31 02:53:54 +02:00
return on_done()
else:
2020-05-31 02:53:54 +02:00
full_sync(mw, out, on_done)
2020-05-30 04:28:22 +02:00
if not mw.col.basicCheck():
showWarning("Please use Tools>Check Database")
2020-05-31 02:53:54 +02:00
return on_done()
2020-05-30 04:28:22 +02:00
mw.col.save(trx=False)
mw.taskman.with_progress(
lambda: mw.col.backend.sync_collection(auth),
2020-05-31 02:53:54 +02:00
on_future_done,
2020-05-30 04:28:22 +02:00
label=tr(TR.SYNC_CHECKING),
immediate=True,
2020-05-30 04:28:22 +02:00
)
2020-05-31 02:53:54 +02:00
def full_sync(
mw: aqt.main.AnkiQt, out: SyncOutput, on_done: Callable[[], None]
) -> None:
2020-05-30 04:28:22 +02:00
if out.required == out.FULL_DOWNLOAD:
2020-05-31 02:53:54 +02:00
confirm_full_download(mw, on_done)
2020-05-30 04:28:22 +02:00
elif out.required == out.FULL_UPLOAD:
2020-05-31 02:53:54 +02:00
full_upload(mw, on_done)
2020-05-30 04:28:22 +02:00
else:
choice = ask_user_to_decide_direction()
if choice == FullSyncChoice.UPLOAD:
2020-05-31 02:53:54 +02:00
full_upload(mw, on_done)
2020-05-30 04:28:22 +02:00
elif choice == FullSyncChoice.DOWNLOAD:
2020-05-31 02:53:54 +02:00
full_download(mw, on_done)
else:
on_done()
2020-05-30 04:28:22 +02:00
2020-05-31 02:53:54 +02:00
def confirm_full_download(mw: aqt.main.AnkiQt, on_done: Callable[[], None]) -> None:
2020-05-30 04:28:22 +02:00
# confirmation step required, as some users customize their notetypes
# in an empty collection, then want to upload them
if not askUser(tr(TR.SYNC_CONFIRM_EMPTY_DOWNLOAD)):
2020-05-31 02:53:54 +02:00
return on_done()
2020-05-30 04:28:22 +02:00
else:
2020-05-31 02:53:54 +02:00
mw.closeAllWindows(lambda: full_download(mw, on_done))
2020-05-30 04:28:22 +02:00
def on_full_sync_timer(mw: aqt.main.AnkiQt) -> None:
progress = mw.col.latest_progress()
if progress.kind != ProgressKind.FullSync:
return
2020-05-30 06:19:21 +02:00
assert isinstance(progress.val, FullSyncProgress)
if progress.val.transferred == progress.val.total:
label = tr(TR.SYNC_CHECKING)
else:
label = None
2020-05-30 12:52:32 +02:00
mw.progress.update(
value=progress.val.transferred,
max=progress.val.total,
process=False,
label=label,
2020-05-30 12:52:32 +02:00
)
2020-05-30 04:28:22 +02:00
if mw.progress.want_cancel():
mw.col.backend.abort_sync()
2020-05-31 02:53:54 +02:00
def full_download(mw: aqt.main.AnkiQt, on_done: Callable[[], None]) -> None:
2020-05-30 04:28:22 +02:00
mw.col.close_for_full_sync()
def on_timer():
on_full_sync_timer(mw)
timer = QTimer(mw)
qconnect(timer.timeout, on_timer)
timer.start(150)
2020-05-31 02:53:54 +02:00
def on_future_done(fut):
2020-05-30 04:28:22 +02:00
timer.stop()
mw.col.reopen(after_full_sync=True)
mw.reset()
try:
2020-05-30 04:28:22 +02:00
fut.result()
except Exception as err:
handle_sync_error(mw, err)
mw.media_syncer.start()
2020-05-31 02:53:54 +02:00
return on_done()
2020-05-30 04:28:22 +02:00
mw.taskman.with_progress(
lambda: mw.col.backend.full_download(mw.pm.sync_auth()),
2020-05-31 02:53:54 +02:00
on_future_done,
2020-05-30 04:28:22 +02:00
label=tr(TR.SYNC_DOWNLOADING_FROM_ANKIWEB),
)
2020-05-31 02:53:54 +02:00
def full_upload(mw: aqt.main.AnkiQt, on_done: Callable[[], None]) -> None:
2020-05-30 04:28:22 +02:00
mw.col.close_for_full_sync()
def on_timer():
on_full_sync_timer(mw)
timer = QTimer(mw)
qconnect(timer.timeout, on_timer)
timer.start(150)
2020-05-31 02:53:54 +02:00
def on_future_done(fut):
2020-05-30 04:28:22 +02:00
timer.stop()
mw.col.reopen(after_full_sync=True)
mw.reset()
try:
2020-05-30 04:28:22 +02:00
fut.result()
except Exception as err:
handle_sync_error(mw, err)
return on_done()
mw.media_syncer.start()
2020-05-31 02:53:54 +02:00
return on_done()
2020-05-30 04:28:22 +02:00
mw.taskman.with_progress(
lambda: mw.col.backend.full_upload(mw.pm.sync_auth()),
2020-05-31 02:53:54 +02:00
on_future_done,
2020-05-30 04:28:22 +02:00
label=tr(TR.SYNC_UPLOADING_TO_ANKIWEB),
)
2020-05-31 02:53:54 +02:00
def sync_login(
2020-05-30 04:28:22 +02:00
mw: aqt.main.AnkiQt, on_success: Callable[[], None], username="", password=""
) -> None:
while True:
(username, password) = get_id_and_pass_from_user(mw, username, password)
if not username and not password:
return
2020-05-30 04:28:22 +02:00
if username and password:
break
2020-05-31 02:53:54 +02:00
def on_future_done(fut):
try:
2020-05-30 04:28:22 +02:00
auth = fut.result()
except SyncError as e:
if e.kind() == SyncErrorKind.AUTH_FAILED:
showWarning(str(e))
2020-05-31 02:53:54 +02:00
sync_login(mw, on_success, username, password)
return
except Exception as err:
handle_sync_error(mw, err)
2020-05-30 04:28:22 +02:00
return
2020-05-30 04:28:22 +02:00
mw.pm.set_host_number(auth.host_number)
mw.pm.set_sync_key(auth.hkey)
mw.pm.set_sync_username(username)
on_success()
mw.taskman.with_progress(
2020-05-31 02:53:54 +02:00
lambda: mw.col.backend.sync_login(username=username, password=password),
on_future_done,
2020-05-30 04:28:22 +02:00
)
def ask_user_to_decide_direction() -> FullSyncChoice:
button_labels = [
tr(TR.SYNC_UPLOAD_TO_ANKIWEB),
tr(TR.SYNC_DOWNLOAD_FROM_ANKIWEB),
tr(TR.SYNC_CANCEL_BUTTON),
]
diag = askUserDialog(tr(TR.SYNC_CONFLICT_EXPLANATION), button_labels)
diag.setDefault(2)
ret = diag.run()
if ret == button_labels[0]:
return FullSyncChoice.UPLOAD
elif ret == button_labels[1]:
return FullSyncChoice.DOWNLOAD
else:
return FullSyncChoice.CANCEL
def get_id_and_pass_from_user(
mw: aqt.main.AnkiQt, username="", password=""
) -> Tuple[str, str]:
diag = QDialog(mw)
diag.setWindowTitle("Anki")
diag.setWindowModality(Qt.WindowModal)
vbox = QVBoxLayout()
info_label = QLabel(
2020-08-24 15:37:13 +02:00
without_unicode_isolation(
tr(TR.SYNC_ACCOUNT_REQUIRED, link="https://ankiweb.net/account/login")
)
2020-05-30 04:28:22 +02:00
)
info_label.setOpenExternalLinks(True)
info_label.setWordWrap(True)
vbox.addWidget(info_label)
vbox.addSpacing(20)
g = QGridLayout()
l1 = QLabel(tr(TR.SYNC_ANKIWEB_ID_LABEL))
g.addWidget(l1, 0, 0)
user = QLineEdit()
user.setText(username)
g.addWidget(user, 0, 1)
l2 = QLabel(tr(TR.SYNC_PASSWORD_LABEL))
g.addWidget(l2, 1, 0)
passwd = QLineEdit()
passwd.setText(password)
passwd.setEchoMode(QLineEdit.Password)
g.addWidget(passwd, 1, 1)
vbox.addLayout(g)
bb = QDialogButtonBox(QDialogButtonBox.Ok | QDialogButtonBox.Cancel) # type: ignore
bb.button(QDialogButtonBox.Ok).setAutoDefault(True)
qconnect(bb.accepted, diag.accept)
qconnect(bb.rejected, diag.reject)
vbox.addWidget(bb)
diag.setLayout(vbox)
diag.show()
accepted = diag.exec_()
if not accepted:
return ("", "")
return (user.text().strip(), passwd.text())
2020-07-16 05:55:53 +02:00
# export platform version to syncing code
os.environ["PLATFORM"] = platDesc()