# Copyright: Ankitects Pty Ltd and contributors # License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html from __future__ import annotations from concurrent.futures import Future from copy import deepcopy from dataclasses import dataclass from typing import Any import aqt from anki.collection import OperationInfo from anki.decks import DeckTreeNode from anki.errors import DeckIsFilteredError from anki.utils import intTime from aqt import AnkiQt, gui_hooks from aqt.qt import * from aqt.sound import av_player from aqt.toolbar import BottomBar from aqt.utils import ( TR, askUser, getOnlyText, openLink, shortcut, showInfo, showWarning, tooltip, tr, ) class DeckBrowserBottomBar: def __init__(self, deck_browser: DeckBrowser) -> None: self.deck_browser = deck_browser @dataclass class DeckBrowserContent: """Stores sections of HTML content that the deck browser will be populated with. Attributes: tree {str} -- HTML of the deck tree section stats {str} -- HTML of the stats section """ tree: str stats: str @dataclass class RenderDeckNodeContext: current_deck_id: int class DeckBrowser: _dueTree: DeckTreeNode def __init__(self, mw: AnkiQt) -> None: self.mw = mw self.web = mw.web self.bottom = BottomBar(mw, mw.bottomWeb) self.scrollPos = QPoint(0, 0) self._v1_message_dismissed_at = 0 self._refresh_needed = False def show(self) -> None: av_player.stop_and_clear_queue() self.web.set_bridge_command(self._linkHandler, self) self._renderPage() # redraw top bar for theme change self.mw.toolbar.redraw() self.refresh() def refresh(self) -> None: self._renderPage() self._refresh_needed = False def refresh_if_needed(self) -> None: if self._refresh_needed: self.refresh() def op_executed(self, op: OperationInfo, focused: bool) -> bool: if self.mw.col.op_affects_study_queue(op): self._refresh_needed = True if focused: self.refresh_if_needed() return self._refresh_needed # Event handlers ########################################################################## def _linkHandler(self, url: str) -> Any: if ":" in url: (cmd, arg) = url.split(":", 1) else: cmd = url if cmd == "open": self._selDeck(arg) elif cmd == "opts": self._showOptions(arg) elif cmd == "shared": self._onShared() elif cmd == "import": self.mw.onImport() elif cmd == "create": self._on_create() elif cmd == "drag": source, target = arg.split(",") self._handle_drag_and_drop(int(source), int(target or 0)) elif cmd == "collapse": self._collapse(int(arg)) elif cmd == "v2upgrade": self._confirm_upgrade() elif cmd == "v2upgradeinfo": openLink("https://faqs.ankiweb.net/the-anki-2.1-scheduler.html") elif cmd == "v2upgradelater": self._v1_message_dismissed_at = intTime() self.refresh() return False def _selDeck(self, did: str) -> None: self.mw.col.decks.select(int(did)) self.mw.onOverview() # HTML generation ########################################################################## _body = """
%(tree)s

%(stats)s
""" def _renderPage(self, reuse: bool = False) -> None: if not reuse: self._dueTree = self.mw.col.sched.deck_due_tree() self.__renderPage(None) return self.web.evalWithCallback("window.pageYOffset", self.__renderPage) def __renderPage(self, offset: int) -> None: content = DeckBrowserContent( tree=self._renderDeckTree(self._dueTree), stats=self._renderStats(), ) gui_hooks.deck_browser_will_render_content(self, content) self.web.stdHtml( self._v1_upgrade_message() + self._body % content.__dict__, css=["css/deckbrowser.css"], js=[ "js/vendor/jquery.min.js", "js/vendor/jquery-ui.min.js", "js/deckbrowser.js", ], context=self, ) self.web.key = "deckBrowser" self._drawButtons() if offset is not None: self._scrollToOffset(offset) gui_hooks.deck_browser_did_render(self) def _scrollToOffset(self, offset: int) -> None: self.web.eval("$(function() { window.scrollTo(0, %d, 'instant'); });" % offset) def _renderStats(self) -> str: return '
{}
'.format( self.mw.col.studied_today(), ) def _renderDeckTree(self, top: DeckTreeNode) -> str: buf = """ %s%s %s""" % ( tr(TR.DECKS_DECK), tr(TR.STATISTICS_DUE_COUNT), tr(TR.ACTIONS_NEW), ) buf += self._topLevelDragRow() ctx = RenderDeckNodeContext(current_deck_id=self.mw.col.conf["curDeck"]) for child in top.children: buf += self._render_deck_node(child, ctx) return buf def _render_deck_node(self, node: DeckTreeNode, ctx: RenderDeckNodeContext) -> str: if node.collapsed: prefix = "+" else: prefix = "-" due = node.review_count + node.learn_count def indent() -> str: return " " * 6 * (node.level - 1) if node.deck_id == ctx.current_deck_id: klass = "deck current" else: klass = "deck" buf = "" % (klass, node.deck_id) # deck link if node.children: collapse = ( "%s" % (node.deck_id, prefix) ) else: collapse = "" if node.filtered: extraclass = "filtered" else: extraclass = "" buf += """ %s%s%s""" % ( indent(), collapse, extraclass, node.deck_id, node.name, ) # due counts def nonzeroColour(cnt: int, klass: str) -> str: if not cnt: klass = "zero-count" return f'{cnt}' buf += "%s%s" % ( nonzeroColour(due, "review-count"), nonzeroColour(node.new_count, "new-count"), ) # options buf += ( "" "" % node.deck_id ) # children if not node.collapsed: for child in node.children: buf += self._render_deck_node(child, ctx) return buf def _topLevelDragRow(self) -> str: return " " # Options ########################################################################## def _showOptions(self, did: str) -> None: m = QMenu(self.mw) a = m.addAction(tr(TR.ACTIONS_RENAME)) qconnect(a.triggered, lambda b, did=did: self._rename(int(did))) a = m.addAction(tr(TR.ACTIONS_OPTIONS)) qconnect(a.triggered, lambda b, did=did: self._options(did)) a = m.addAction(tr(TR.ACTIONS_EXPORT)) qconnect(a.triggered, lambda b, did=did: self._export(int(did))) a = m.addAction(tr(TR.ACTIONS_DELETE)) qconnect(a.triggered, lambda b, did=did: self._delete(int(did))) gui_hooks.deck_browser_will_show_options_menu(m, int(did)) m.exec_(QCursor.pos()) def _export(self, did: int) -> None: self.mw.onExport(did=did) def _rename(self, did: int) -> None: deck = self.mw.col.decks.get(did) oldName = deck["name"] newName = getOnlyText(tr(TR.DECKS_NEW_DECK_NAME), default=oldName) newName = newName.replace('"', "") if not newName or newName == oldName: return try: self.mw.col.decks.rename(deck, newName) gui_hooks.sidebar_should_refresh_decks() except DeckIsFilteredError as err: showWarning(str(err)) return self.mw.update_undo_actions() self.show() def _options(self, did: str) -> None: # select the deck first, because the dyn deck conf assumes the deck # we're editing is the current one self.mw.col.decks.select(int(did)) self.mw.onDeckConf() def _collapse(self, did: int) -> None: self.mw.col.decks.collapse(did) node = self.mw.col.decks.find_deck_in_tree(self._dueTree, did) if node: node.collapsed = not node.collapsed self._renderPage(reuse=True) def _handle_drag_and_drop(self, source: int, target: int) -> None: def process() -> None: self.mw.col.decks.drag_drop_decks([source], target) def on_done(fut: Future) -> None: try: fut.result() except Exception as e: showWarning(str(e)) return self.mw.update_undo_actions() gui_hooks.sidebar_should_refresh_decks() self.show() self.mw.taskman.with_progress(process, on_done) def _delete(self, did: int) -> None: def do_delete() -> int: return self.mw.col.decks.remove([did]) def on_done(fut: Future) -> None: self.mw.reset() self.mw.update_undo_actions() self.show() tooltip(tr(TR.BROWSING_CARDS_DELETED, count=fut.result())) self.mw.taskman.with_progress(do_delete, on_done) # Top buttons ###################################################################### drawLinks = [ ["", "shared", tr(TR.DECKS_GET_SHARED)], ["", "create", tr(TR.DECKS_CREATE_DECK)], ["Ctrl+Shift+I", "import", tr(TR.DECKS_IMPORT_FILE)], ] def _drawButtons(self) -> None: buf = "" drawLinks = deepcopy(self.drawLinks) for b in drawLinks: if b[0]: b[0] = tr(TR.ACTIONS_SHORTCUT_KEY, val=shortcut(b[0])) buf += """ """ % tuple( b ) self.bottom.draw( buf=buf, link_handler=self._linkHandler, web_context=DeckBrowserBottomBar(self), ) def _onShared(self) -> None: openLink(f"{aqt.appShared}decks/") def _on_create(self) -> None: deck = getOnlyText(tr(TR.DECKS_NAME_FOR_DECK)) if deck: try: self.mw.col.decks.id(deck) except DeckIsFilteredError as err: showWarning(str(err)) return gui_hooks.sidebar_should_refresh_decks() self.refresh() ###################################################################### def _v1_upgrade_message(self) -> str: if self.mw.col.schedVer() == 2: return "" if (intTime() - self._v1_message_dismissed_at) < 86_400: return "" return f"""
{tr(TR.SCHEDULING_UPDATE_SOON)}
""" def _confirm_upgrade(self) -> None: self.mw.col.modSchema(check=True) self.mw.col.upgrade_to_v2_scheduler() # not translated, as 2.15 should not be too far off if askUser( "Do you use AnkiDroid <= 2.14, or plan to use it in the near future? If unsure, choose No. You can adjust the setting later in the preferences screen.", defaultno=True, ): prefs = self.mw.col.get_preferences() prefs.scheduling.new_timezone = False self.mw.col.set_preferences(prefs) showInfo(tr(TR.SCHEDULING_UPDATE_DONE)) self.refresh()