anki/qt/aqt/deckbrowser.py

337 lines
10 KiB
Python
Raw Normal View History

2019-02-05 04:59:03 +01:00
# Copyright: Ankitects Pty Ltd and contributors
# -*- coding: utf-8 -*-
# License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
from __future__ import annotations
2021-01-05 11:43:37 +01:00
from concurrent.futures import Future
2019-12-20 10:19:03 +01:00
from copy import deepcopy
from dataclasses import dataclass
2021-01-30 11:37:29 +01:00
from typing import Any
import aqt
from anki.decks import DeckTreeNode
2019-12-20 10:19:03 +01:00
from anki.errors import DeckRenameError
from aqt import AnkiQt, gui_hooks
2019-12-20 10:19:03 +01:00
from aqt.qt import *
2020-01-20 11:10:38 +01:00
from aqt.sound import av_player
from aqt.toolbar import BottomBar
from aqt.utils import TR, askUser, getOnlyText, openLink, shortcut, showWarning, tr
2019-12-20 10:19:03 +01:00
class DeckBrowserBottomBar:
2021-02-01 14:28:21 +01:00
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.
2020-08-31 05:29:28 +02:00
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)
2021-02-01 14:28:21 +01:00
def show(self) -> None:
2020-01-20 11:10:38 +01:00
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()
2021-02-01 14:28:21 +01:00
def refresh(self) -> None:
self._renderPage()
# Event handlers
##########################################################################
2021-01-30 11:37:29 +01:00
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":
deck = getOnlyText(tr(TR.DECKS_NAME_FOR_DECK))
if deck:
self.mw.col.decks.id(deck)
gui_hooks.sidebar_should_refresh_decks()
self.refresh()
elif cmd == "drag":
2021-01-30 11:37:29 +01:00
source, target = arg.split(",")
self._handle_drag_and_drop(int(source), int(target or 0))
elif cmd == "collapse":
self._collapse(int(arg))
return False
2021-02-01 14:28:21 +01:00
def _selDeck(self, did) -> None:
self.mw.col.decks.select(did)
self.mw.onOverview()
# HTML generation
##########################################################################
_body = """
<center>
<table cellspacing=0 cellpading=3>
%(tree)s
</table>
<br>
%(stats)s
</center>
"""
2021-02-01 14:28:21 +01:00
def _renderPage(self, reuse=False) -> None:
if not reuse:
self._dueTree = self.mw.col.sched.deck_due_tree()
self.__renderPage(None)
2019-06-01 08:35:19 +02:00
return
self.web.evalWithCallback("window.pageYOffset", self.__renderPage)
2021-02-01 14:28:21 +01:00
def __renderPage(self, offset) -> None:
content = DeckBrowserContent(
2020-08-31 05:29:28 +02:00
tree=self._renderDeckTree(self._dueTree),
stats=self._renderStats(),
)
gui_hooks.deck_browser_will_render_content(self, content)
2019-12-23 01:34:10 +01:00
self.web.stdHtml(
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,
2019-12-23 01:34:10 +01:00
)
self.web.key = "deckBrowser"
self._drawButtons()
if offset is not None:
self._scrollToOffset(offset)
2020-04-09 05:40:19 +02:00
gui_hooks.deck_browser_did_render(self)
2021-02-01 14:28:21 +01:00
def _scrollToOffset(self, offset) -> None:
self.web.eval("$(function() { window.scrollTo(0, %d, 'instant'); });" % offset)
2021-02-01 14:28:21 +01:00
def _renderStats(self) -> str:
return '<div id="studiedToday"><span>{}</span></div>'.format(
self.mw.col.studied_today(),
)
def _renderDeckTree(self, top: DeckTreeNode) -> str:
buf = """
<tr><th colspan=5 align=start>%s</th><th class=count>%s</th>
<th class=count>%s</th><th class=optscol></th></tr>""" % (
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
2019-12-23 01:34:10 +01:00
2021-02-01 14:28:21 +01:00
def indent() -> str:
return "&nbsp;" * 6 * (node.level - 1)
2019-12-23 01:34:10 +01:00
if node.deck_id == ctx.current_deck_id:
2019-12-23 01:34:10 +01:00
klass = "deck current"
else:
2019-12-23 01:34:10 +01:00
klass = "deck"
buf = "<tr class='%s' id='%d'>" % (klass, node.deck_id)
# deck link
if node.children:
2019-12-23 01:34:10 +01:00
collapse = (
"<a class=collapse href=# onclick='return pycmd(\"collapse:%d\")'>%s</a>"
% (node.deck_id, prefix)
2019-12-23 01:34:10 +01:00
)
else:
collapse = "<span class=collapse></span>"
if node.filtered:
extraclass = "filtered"
else:
extraclass = ""
buf += """
<td class=decktd colspan=5>%s%s<a class="deck %s"
2019-12-23 01:34:10 +01:00
href=# onclick="return pycmd('open:%d')">%s</a></td>""" % (
indent(),
collapse,
extraclass,
node.deck_id,
node.name,
2019-12-23 01:34:10 +01:00
)
# due counts
2021-02-01 14:28:21 +01:00
def nonzeroColour(cnt: int, klass: str) -> str:
if not cnt:
klass = "zero-count"
return f'<span class="{klass}">{cnt}</span>'
2019-12-23 01:34:10 +01:00
buf += "<td align=right>%s</td><td align=right>%s</td>" % (
nonzeroColour(due, "review-count"),
nonzeroColour(node.new_count, "new-count"),
2019-12-23 01:34:10 +01:00
)
# options
2019-12-23 01:34:10 +01:00
buf += (
"<td align=center class=opts><a onclick='return pycmd(\"opts:%d\");'>"
"<img src='/_anki/imgs/gears.svg' class=gears></a></td></tr>" % node.deck_id
2019-12-23 01:34:10 +01:00
)
# children
if not node.collapsed:
for child in node.children:
buf += self._render_deck_node(child, ctx)
return buf
2021-02-01 14:28:21 +01:00
def _topLevelDragRow(self) -> str:
return "<tr class='top-level-drag-row'><td colspan='6'>&nbsp;</td></tr>"
# 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))
2021-02-01 11:59:18 +01:00
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)))
2020-05-22 03:27:40 +02:00
gui_hooks.deck_browser_will_show_options_menu(m, int(did))
m.exec_(QCursor.pos())
2021-02-01 11:59:18 +01:00
def _export(self, did: int) -> None:
2014-06-20 02:13:12 +02:00
self.mw.onExport(did=did)
def _rename(self, did: int) -> None:
self.mw.checkpoint(tr(TR.ACTIONS_RENAME_DECK))
deck = self.mw.col.decks.get(did)
2019-12-23 01:34:10 +01:00
oldName = deck["name"]
newName = getOnlyText(tr(TR.DECKS_NEW_DECK_NAME), default=oldName)
2013-06-12 04:12:03 +02:00
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 DeckRenameError as e:
showWarning(e.description)
return
self.show()
2021-02-01 14:28:21 +01:00
def _options(self, did) -> 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(did)
self.mw.onDeckConf()
def _collapse(self, did: int) -> None:
self.mw.col.decks.collapse(did)
2020-05-16 05:05:20 +02:00
node = self.mw.col.decks.find_deck_in_tree(self._dueTree, did)
if node:
node.collapsed = not node.collapsed
2020-05-16 05:05:20 +02:00
self._renderPage(reuse=True)
2021-01-30 11:37:29 +01:00
def _handle_drag_and_drop(self, source: int, target: int) -> None:
self.mw.col.decks.drag_drop_decks([source], target)
gui_hooks.sidebar_should_refresh_decks()
self.show()
def ask_delete_deck(self, did: int) -> bool:
deck = self.mw.col.decks.get(did)
if deck["dyn"]:
return True
count = self.mw.col.decks.card_count(did, include_subdecks=True)
if not count:
return True
extra = tr(TR.DECKS_IT_HAS_CARD, count=count)
if askUser(
tr(TR.DECKS_ARE_YOU_SURE_YOU_WISH_TO, val=deck["name"]) + " " + extra
2019-12-23 01:34:10 +01:00
):
return True
return False
def _delete(self, did: int) -> None:
if self.ask_delete_deck(did):
2021-01-05 11:43:37 +01:00
2021-02-01 14:28:21 +01:00
def do_delete() -> None:
2021-01-05 11:43:37 +01:00
return self.mw.col.decks.rem(did, True)
2021-02-01 14:28:21 +01:00
def on_done(fut: Future) -> None:
2021-01-05 11:43:37 +01:00
self.show()
res = fut.result() # Required to check for errors
self.mw.checkpoint(tr(TR.DECKS_DELETE_DECK))
2021-01-05 11:43:37 +01:00
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)],
]
2021-02-01 14:28:21 +01:00
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 += """
2019-12-23 01:34:10 +01:00
<button title='%s' onclick='pycmd(\"%s\");'>%s</button>""" % tuple(
b
)
self.bottom.draw(
buf=buf,
link_handler=self._linkHandler,
web_context=DeckBrowserBottomBar(self),
)
2021-02-01 14:28:21 +01:00
def _onShared(self) -> None:
2019-12-23 01:34:10 +01:00
openLink(aqt.appShared + "decks/")