anki/qt/aqt/editor.py

1198 lines
39 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
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
2019-12-20 10:19:03 +01:00
import base64
import html
import itertools
2019-12-20 10:19:03 +01:00
import json
import mimetypes
2019-12-20 10:19:03 +01:00
import re
import urllib.error
import urllib.parse
import urllib.request
import warnings
2019-12-22 03:30:29 +01:00
from typing import Callable, List, Optional, Tuple
2019-12-20 10:19:03 +01:00
import requests
from bs4 import BeautifulSoup
import aqt
import aqt.sound
2020-03-04 17:41:26 +01:00
from anki.cards import Card
2020-01-15 04:49:26 +01:00
from anki.hooks import runFilter
2020-01-19 02:33:27 +01:00
from anki.httpclient import HttpClient
from anki.lang import _
from anki.notes import Note
from anki.utils import checksum, isLin, isWin, namedtmp, stripHTMLMedia
from aqt import AnkiQt, gui_hooks
from aqt.qt import *
2020-01-20 11:10:38 +01:00
from aqt.sound import av_player, getAudio
2020-01-26 09:47:28 +01:00
from aqt.theme import theme_manager
2019-12-23 01:34:10 +01:00
from aqt.utils import (
getFile,
openHelp,
qtMenuShortcutWorkaround,
restoreGeom,
saveGeom,
2019-12-23 01:34:10 +01:00
shortcut,
showInfo,
showWarning,
tooltip,
)
from aqt.webview import AnkiWebView
pics = ("jpg", "jpeg", "png", "tif", "tiff", "gif", "svg", "webp")
2019-12-23 01:34:10 +01:00
audio = (
"wav",
"mp3",
"ogg",
"flac",
"mp4",
"swf",
"mov",
"mpeg",
"mkv",
"m4a",
"3gp",
"spx",
"oga",
"webm",
)
_html = """
<style>
html { background: %s; }
#topbutsOuter { background: %s; }
</style>
<div id="topbutsOuter">
<div id="topbuts" class="clearfix">
%s
</div>
</div>
<div id="fields">
</div>
<div id="dupes" style="display:none;">
<a href="#" onclick="pycmd('dupes');return false;">
%s
</a>
</div>
"""
# caller is responsible for resetting note on reset
class Editor:
def __init__(self, mw: AnkiQt, widget, parentWindow, addMode=False) -> None:
self.mw = mw
self.widget = widget
self.parentWindow = parentWindow
self.note: Optional[Note] = None
self.addMode = addMode
self.currentField: Optional[int] = None
# current card, for card layout
2020-03-04 17:41:26 +01:00
self.card: Optional[Card] = None
self.setupOuter()
self.setupWeb()
2017-10-11 20:51:26 +02:00
self.setupShortcuts()
self.setupTags()
gui_hooks.editor_did_init(self)
# Initial setup
############################################################
def setupOuter(self):
l = QVBoxLayout()
2019-12-23 01:34:10 +01:00
l.setContentsMargins(0, 0, 0, 0)
l.setSpacing(0)
self.widget.setLayout(l)
self.outerLayout = l
def setupWeb(self) -> None:
self.web = EditorWebView(self.widget, self)
self.web.allowDrops = True
self.web.set_bridge_command(self.onBridgeCmd, self)
self.outerLayout.addWidget(self.web, 1)
2019-12-22 13:56:17 +01:00
righttopbtns: List[str] = [
2019-12-23 01:34:10 +01:00
self._addButton("text_bold", "bold", _("Bold text (Ctrl+B)"), id="bold"),
self._addButton(
"text_italic", "italic", _("Italic text (Ctrl+I)"), id="italic"
),
self._addButton(
"text_under", "underline", _("Underline text (Ctrl+U)"), id="underline"
),
self._addButton(
"text_super", "super", _("Superscript (Ctrl++)"), id="superscript"
),
self._addButton("text_sub", "sub", _("Subscript (Ctrl+=)"), id="subscript"),
self._addButton("text_clear", "clear", _("Remove formatting (Ctrl+R)")),
2019-12-22 13:56:17 +01:00
]
# The color selection buttons do not use an icon so the HTML must be specified manually
tip = _("Set foreground colour (F7)")
2019-12-23 01:34:10 +01:00
righttopbtns.append(
""" <button tabindex=-1
class=linkb
title="{}"
type="button"
onclick="pycmd('colour'); return false;"
>
<div id=forecolor
style="display:inline-block; background: #000;border-radius: 5px;"
class=topbut
>
</div>
</button>""".format(
2019-12-23 01:34:10 +01:00
tip
)
)
tip = _("Change colour (F8)")
2019-12-23 03:51:13 +01:00
righttopbtns.extend(
[
"""<button tabindex=-1
class=linkb
title="{}"
type="button"
onclick="pycmd('changeCol');return false;"
>
<div style="display:inline-block; border-radius: 5px;"
class="topbut rainbow"
>
</div>
</button>""".format(
2019-12-23 03:51:13 +01:00
tip
),
self._addButton(
"text_cloze", "cloze", _("Cloze deletion (Ctrl+Shift+C)")
),
self._addButton(
"paperclip", "attach", _("Attach pictures/audio/video (F3)")
),
self._addButton("media-record", "record", _("Record audio (F5)")),
self._addButton("more", "more"),
]
2019-12-22 13:56:17 +01:00
)
gui_hooks.editor_did_init_buttons(righttopbtns, self)
# legacy filter
2017-01-06 16:37:57 +01:00
righttopbtns = runFilter("setupEditorButtons", righttopbtns, self)
topbuts = """
<div id="topbutsleft" style="float:left;">
2018-12-06 23:33:47 +01:00
<button title='%(fldsTitle)s' onclick="pycmd('fields')">%(flds)s...</button>
<button title='%(cardsTitle)s' onclick="pycmd('cards')">%(cards)s...</button>
</div>
<div id="topbutsright" style="float:right;">
%(rightbts)s
</div>
2019-12-23 01:34:10 +01:00
""" % dict(
flds=_("Fields"),
cards=_("Cards"),
rightbts="".join(righttopbtns),
fldsTitle=_("Customize Fields"),
cardsTitle=shortcut(_("Customize Card Templates (Ctrl+L)")),
)
bgcol = self.mw.app.palette().window().color().name() # type: ignore
# then load page
2019-12-23 01:34:10 +01:00
self.web.stdHtml(
_html % (bgcol, bgcol, topbuts, _("Show Duplicates")),
css=["editor.css"],
js=["jquery.js", "editor.js"],
context=self,
2019-12-23 01:34:10 +01:00
)
# Top buttons
######################################################################
def resourceToData(self, path):
"""Convert a file (specified by a path) into a data URI."""
2017-01-14 21:16:50 +01:00
if not os.path.exists(path):
raise FileNotFoundError
mime, _ = mimetypes.guess_type(path)
2019-12-23 01:34:10 +01:00
with open(path, "rb") as fp:
data = fp.read()
2019-12-23 01:34:10 +01:00
data64 = b"".join(base64.encodebytes(data).splitlines())
return "data:%s;base64,%s" % (mime, data64.decode("ascii"))
def addButton(
self,
icon: str,
cmd: str,
func: Callable[["Editor"], None],
tip: str = "",
label: str = "",
id: str = None,
toggleable: bool = False,
keys: str = None,
disables: bool = True,
):
"""Assign func to bridge cmd, register shortcut, return button"""
2020-04-26 17:01:23 +02:00
if func:
self._links[cmd] = func
if keys:
2019-12-23 02:31:42 +01:00
QShortcut( # type: ignore
QKeySequence(keys), self.widget, activated=lambda s=self: func(s),
2019-12-23 01:34:10 +01:00
)
btn = self._addButton(
icon,
cmd,
tip=tip,
label=label,
id=id,
toggleable=toggleable,
disables=disables,
)
return btn
2019-12-23 01:34:10 +01:00
def _addButton(
self,
icon: str,
cmd: str,
tip: str = "",
label: str = "",
id: Optional[str] = None,
toggleable: bool = False,
disables: bool = True,
):
if icon:
if icon.startswith("qrc:/"):
iconstr = icon
elif os.path.isabs(icon):
iconstr = self.resourceToData(icon)
else:
iconstr = "/_anki/imgs/{}.png".format(icon)
2019-12-23 01:34:10 +01:00
imgelm = """<img class=topbut src="{}">""".format(iconstr)
else:
imgelm = ""
if label or not imgelm:
2019-12-23 01:34:10 +01:00
labelelm = """<span class=blabel>{}</span>""".format(label or cmd)
else:
labelelm = ""
2017-01-06 16:40:10 +01:00
if id:
2019-12-23 01:34:10 +01:00
idstr = "id={}".format(id)
2017-01-06 16:40:10 +01:00
else:
idstr = ""
2017-01-08 14:33:45 +01:00
if toggleable:
2019-12-23 01:34:10 +01:00
toggleScript = "toggleEditorButton(this);"
2017-01-08 14:33:45 +01:00
else:
2019-12-23 01:34:10 +01:00
toggleScript = ""
tip = shortcut(tip)
theclass = "linkb"
if not disables:
theclass += " perm"
return """ <button tabindex=-1
{id}
class="{theclass}"
type="button"
title="{tip}"
onclick="pycmd('{cmd}');{togglesc}return false;"
>
{imgelm}
{labelelm}
</button>""".format(
imgelm=imgelm,
cmd=cmd,
tip=tip,
labelelm=labelelm,
id=idstr,
togglesc=toggleScript,
theclass=theclass,
2019-12-23 01:34:10 +01:00
)
def setupShortcuts(self) -> None:
# if a third element is provided, enable shortcut even when no field selected
cuts: List[Tuple] = [
("Ctrl+L", self.onCardLayout, True),
("Ctrl+B", self.toggleBold),
("Ctrl+I", self.toggleItalic),
("Ctrl+U", self.toggleUnderline),
("Ctrl++", self.toggleSuper),
("Ctrl+=", self.toggleSub),
("Ctrl+R", self.removeFormat),
("F7", self.onForeground),
("F8", self.onChangeCol),
("Ctrl+Shift+C", self.onCloze),
("Ctrl+Shift+Alt+C", self.onCloze),
("F3", self.onAddMedia),
("F5", self.onRecSound),
("Ctrl+T, T", self.insertLatex),
("Ctrl+T, E", self.insertLatexEqn),
("Ctrl+T, M", self.insertLatexMathEnv),
("Ctrl+M, M", self.insertMathjaxInline),
("Ctrl+M, E", self.insertMathjaxBlock),
2018-08-06 05:17:57 +02:00
("Ctrl+M, C", self.insertMathjaxChemistry),
("Ctrl+Shift+X", self.onHtmlEdit),
2019-12-23 01:34:10 +01:00
("Ctrl+Shift+T", self.onFocusTags, True),
]
gui_hooks.editor_did_init_shortcuts(cuts, self)
for row in cuts:
if len(row) == 2:
2019-12-23 02:31:42 +01:00
keys, fn = row # pylint: disable=unbalanced-tuple-unpacking
fn = self._addFocusCheck(fn)
else:
keys, fn, _ = row
QShortcut(QKeySequence(keys), self.widget, activated=fn) # type: ignore
def _addFocusCheck(self, fn):
def checkFocus():
if self.currentField is None:
return
fn()
2019-12-23 01:34:10 +01:00
return checkFocus
def onFields(self):
self.saveNow(self._onFields)
def _onFields(self):
from aqt.fields import FieldDialog
2019-12-23 01:34:10 +01:00
FieldDialog(self.mw, self.note.model(), parent=self.parentWindow)
def onCardLayout(self):
self.saveNow(self._onCardLayout)
def _onCardLayout(self):
from aqt.clayout import CardLayout
2019-12-23 01:34:10 +01:00
if self.card:
ord = self.card.ord
else:
ord = 0
2019-12-23 01:34:10 +01:00
CardLayout(
2020-05-14 12:58:45 +02:00
self.mw,
self.note,
ord=ord,
parent=self.parentWindow,
fill_empty=self.addMode,
2019-12-23 01:34:10 +01:00
)
if isWin:
self.parentWindow.activateWindow()
# JS->Python bridge
######################################################################
def onBridgeCmd(self, cmd) -> None:
if not self.note:
# shutdown
return
# focus lost or key/button pressed?
if cmd.startswith("blur") or cmd.startswith("key"):
(type, ord, nid, txt) = cmd.split(":", 3)
ord = int(ord)
try:
nid = int(nid)
except ValueError:
nid = 0
if nid != self.note.id:
print("ignored late blur")
return
txt = self.mungeHTML(txt)
# misbehaving apps may include a null byte in the text
txt = txt.replace("\x00", "")
# reverse the url quoting we added to get images to display
txt = self.mw.col.media.escapeImages(txt, unescape=True)
self.note.fields[ord] = txt
if not self.addMode:
self.note.flush()
self.mw.requireReset()
if type == "blur":
self.currentField = None
# run any filters
if gui_hooks.editor_did_unfocus_field(False, self.note, ord):
# something updated the note; update it after a subsequent focus
# event has had time to fire
self.mw.progress.timer(100, self.loadNoteKeepingFocus, False)
else:
self.checkValid()
else:
gui_hooks.editor_did_fire_typing_timer(self.note)
self.checkValid()
# focused into field?
elif cmd.startswith("focus"):
(type, num) = cmd.split(":", 1)
self.currentField = int(num)
gui_hooks.editor_did_focus_field(self.note, self.currentField)
elif cmd in self._links:
self._links[cmd](self)
else:
print("uncaught cmd", cmd)
def mungeHTML(self, txt):
2019-12-23 01:34:10 +01:00
if txt in ("<br>", "<div><br></div>"):
return ""
return txt
# Setting/unsetting the current note
######################################################################
def setNote(self, note, hide=True, focusTo=None):
"Make NOTE the current note."
self.note = note
self.currentField = None
if self.note:
self.loadNote(focusTo=focusTo)
else:
self.hideCompleters()
if hide:
self.widget.hide()
def loadNoteKeepingFocus(self):
self.loadNote(self.currentField)
def loadNote(self, focusTo=None) -> None:
if not self.note:
return
2019-12-23 01:34:10 +01:00
data = [
(fld, self.mw.col.media.escapeImages(val)) for fld, val in self.note.items()
]
self.widget.show()
self.updateTags()
def oncallback(arg):
if not self.note:
return
self.setupForegroundButton()
self.checkValid()
if focusTo is not None:
self.web.setFocus()
gui_hooks.editor_did_load_note(self)
2019-12-22 23:44:43 +01:00
js = "setFields(%s); setFonts(%s); focusField(%s); setNoteId(%s)" % (
2019-12-23 01:34:10 +01:00
json.dumps(data),
json.dumps(self.fonts()),
json.dumps(focusTo),
json.dumps(self.note.id),
)
js = gui_hooks.editor_will_load_note(js, self.note, self)
2019-12-22 23:44:43 +01:00
self.web.evalWithCallback(js, oncallback)
def fonts(self) -> List[Tuple[str, int, bool]]:
2019-12-23 01:34:10 +01:00
return [
(gui_hooks.editor_will_use_font_for_field(f["font"]), f["size"], f["rtl"])
2019-12-23 01:34:10 +01:00
for f in self.note.model()["flds"]
]
def saveNow(self, callback, keepFocus=False):
"Save unsaved edits then call callback()."
if not self.note:
2019-12-23 01:34:10 +01:00
# calling code may not expect the callback to fire immediately
self.mw.progress.timer(10, callback, False)
return
self.saveTags()
self.web.evalWithCallback("saveNow(%d)" % keepFocus, lambda res: callback())
def checkValid(self):
cols = [""] * len(self.note.fields)
err = self.note.dupeOrEmpty()
if err == 2:
cols[0] = "dupe"
self.web.eval("showDupes();")
else:
self.web.eval("hideDupes();")
self.web.eval("setBackgrounds(%s);" % json.dumps(cols))
def showDupes(self):
contents = stripHTMLMedia(self.note.fields[0])
browser = aqt.dialogs.open("Browser", self.mw)
browser.form.searchEdit.lineEdit().setText(
2019-12-23 01:34:10 +01:00
'"dupe:%s,%s"' % (self.note.model()["id"], contents)
)
browser.onSearchActivated()
def fieldsAreBlank(self, previousNote=None):
if not self.note:
return True
m = self.note.model()
for c, f in enumerate(self.note.fields):
2020-03-24 11:54:19 +01:00
f = f.replace("<br>", "").strip()
notChangedvalues = {"", "<br>"}
2019-12-23 01:34:10 +01:00
if previousNote and m["flds"][c]["sticky"]:
2020-03-24 11:54:19 +01:00
notChangedvalues.add(previousNote.fields[c].replace("<br>", "").strip())
if f not in notChangedvalues:
return False
return True
def cleanup(self):
self.setNote(None)
# prevent any remaining evalWithCallback() events from firing after C++ object deleted
self.web = None
# HTML editing
######################################################################
def onHtmlEdit(self):
field = self.currentField
self.saveNow(lambda: self._onHtmlEdit(field))
def _onHtmlEdit(self, field):
d = QDialog(self.widget, Qt.Window)
form = aqt.forms.edithtml.Ui_Dialog()
form.setupUi(d)
restoreGeom(d, "htmlEditor")
qconnect(form.buttonBox.helpRequested, lambda: openHelp("editor"))
form.textEdit.setPlainText(self.note.fields[field])
d.show()
form.textEdit.moveCursor(QTextCursor.End)
d.exec_()
html = form.textEdit.toPlainText()
if html.find(">") > -1:
# filter html through beautifulsoup so we can strip out things like a
# leading </div>
html_escaped = self.mw.col.media.escapeImages(html)
with warnings.catch_warnings():
warnings.simplefilter("ignore", UserWarning)
html_escaped = str(BeautifulSoup(html_escaped, "html.parser"))
html = self.mw.col.media.escapeImages(html_escaped, unescape=True)
self.note.fields[field] = html
2020-05-20 06:59:22 +02:00
if not self.addMode:
self.note.flush()
self.loadNote(focusTo=field)
saveGeom(d, "htmlEditor")
# Tag handling
######################################################################
def setupTags(self):
import aqt.tagedit
2019-12-23 01:34:10 +01:00
g = QGroupBox(self.widget)
2020-01-26 09:47:28 +01:00
g.setStyleSheet("border: 0")
tb = QGridLayout()
tb.setSpacing(12)
2020-01-26 09:47:28 +01:00
tb.setContentsMargins(2, 6, 2, 6)
# tags
l = QLabel(_("Tags"))
tb.addWidget(l, 1, 0)
self.tags = aqt.tagedit.TagEdit(self.widget)
qconnect(self.tags.lostFocus, self.saveTags)
2013-05-17 07:32:50 +02:00
self.tags.setToolTip(shortcut(_("Jump to tags with Ctrl+Shift+T")))
2020-01-26 09:47:28 +01:00
border = theme_manager.str_color("border")
self.tags.setStyleSheet(f"border: 1px solid {border}")
tb.addWidget(self.tags, 1, 1)
g.setLayout(tb)
self.outerLayout.addWidget(g)
def updateTags(self):
if self.tags.col != self.mw.col:
self.tags.setCol(self.mw.col)
if not self.tags.text() or not self.addMode:
self.tags.setText(self.note.stringTags().strip())
def saveTags(self) -> None:
if not self.note:
return
self.note.tags = self.mw.col.tags.split(self.tags.text())
if not self.addMode:
self.note.flush()
gui_hooks.editor_did_update_tags(self.note)
def saveAddModeVars(self):
if self.addMode:
# save tags to model
m = self.note.model()
2019-12-23 01:34:10 +01:00
m["tags"] = self.note.tags
self.mw.col.models.save(m, updateReqs=False)
def hideCompleters(self):
self.tags.hideCompleter()
def onFocusTags(self):
self.tags.setFocus()
# Format buttons
######################################################################
def toggleBold(self):
self.web.eval("setFormat('bold');")
def toggleItalic(self):
self.web.eval("setFormat('italic');")
def toggleUnderline(self):
self.web.eval("setFormat('underline');")
def toggleSuper(self):
self.web.eval("setFormat('superscript');")
def toggleSub(self):
self.web.eval("setFormat('subscript');")
def removeFormat(self):
self.web.eval("setFormat('removeFormat');")
def onCloze(self):
self.saveNow(self._onCloze, keepFocus=True)
def _onCloze(self):
# check that the model is set up for cloze deletion
2019-12-23 01:34:10 +01:00
if not re.search("{{(.*:)*cloze:", self.note.model()["tmpls"][0]["qfmt"]):
if self.addMode:
2019-12-23 01:34:10 +01:00
tooltip(
_(
"Warning, cloze deletions will not work until "
"you switch the type at the top to Cloze."
)
)
else:
2019-12-23 01:34:10 +01:00
showInfo(
_(
"""\
To make a cloze deletion on an existing note, you need to change it \
2020-06-12 01:04:19 +02:00
to a cloze type first, via 'Notes>Change Note Type'"""
2019-12-23 01:34:10 +01:00
)
)
return
# find the highest existing cloze
highest = 0
for name, val in list(self.note.items()):
2017-12-13 05:34:54 +01:00
m = re.findall(r"\{\{c(\d+)::", val)
if m:
highest = max(highest, sorted([int(x) for x in m])[-1])
# reuse last?
if not self.mw.app.keyboardModifiers() & Qt.AltModifier:
highest += 1
# must start at 1
highest = max(1, highest)
self.web.eval("wrap('{{c%d::', '}}');" % highest)
# Foreground colour
######################################################################
def setupForegroundButton(self):
self.fcolour = self.mw.pm.profile.get("lastColour", "#00f")
self.onColourChanged()
# use last colour
def onForeground(self):
self._wrapWithColour(self.fcolour)
# choose new colour
def onChangeCol(self):
if isLin:
new = QColorDialog.getColor(
QColor(self.fcolour), None, None, QColorDialog.DontUseNativeDialog
)
else:
new = QColorDialog.getColor(QColor(self.fcolour), None)
# native dialog doesn't refocus us for some reason
self.parentWindow.activateWindow()
if new.isValid():
self.fcolour = new.name()
self.onColourChanged()
self._wrapWithColour(self.fcolour)
def _updateForegroundButton(self):
self.web.eval("setFGButton('%s')" % self.fcolour)
def onColourChanged(self):
self._updateForegroundButton()
2019-12-23 01:34:10 +01:00
self.mw.pm.profile["lastColour"] = self.fcolour
def _wrapWithColour(self, colour):
self.web.eval("setFormat('forecolor', '%s')" % colour)
# Audio/video/images
######################################################################
def onAddMedia(self):
2019-12-23 01:34:10 +01:00
extension_filter = " ".join(
"*." + extension for extension in sorted(itertools.chain(pics, audio))
)
key = _("Media") + " (" + extension_filter + ")"
def accept(file):
self.addMedia(file, canDelete=True)
2019-12-23 01:34:10 +01:00
file = getFile(self.widget, _("Add Media"), accept, key, key="media")
self.parentWindow.activateWindow()
def addMedia(self, path, canDelete=False):
try:
html = self._addMedia(path, canDelete)
except Exception as e:
showWarning(str(e))
return
self.web.eval("insertHtmlRemovingInitialBR(%s);" % json.dumps(html))
def _addMedia(self, path, canDelete=False):
"Add to media folder and return local img or sound tag."
# copy to media folder
fname = self.mw.col.media.addFile(path)
# remove original?
2019-12-23 01:34:10 +01:00
if canDelete and self.mw.pm.profile["deleteMedia"]:
if os.path.abspath(fname) != os.path.abspath(path):
try:
os.unlink(path)
except:
pass
# return a local html link
return self.fnameToLink(fname)
def _addMediaFromData(self, fname: str, data: bytes) -> str:
return self.mw.col.media.writeData(fname, data)
def onRecSound(self):
try:
file = getAudio(self.widget)
except Exception as e:
2019-12-23 01:34:10 +01:00
showWarning(
_("Couldn't record audio. Have you installed 'lame'?")
+ "\n\n"
+ repr(str(e))
)
return
2017-06-23 05:04:32 +02:00
if file:
self.addMedia(file)
# Media downloads
######################################################################
def urlToLink(self, url: str) -> Optional[str]:
fname = self.urlToFile(url)
if not fname:
return None
return self.fnameToLink(fname)
def fnameToLink(self, fname: str) -> str:
ext = fname.split(".")[-1].lower()
if ext in pics:
name = urllib.parse.quote(fname.encode("utf8"))
return '<img src="%s">' % name
else:
2020-01-20 11:10:38 +01:00
av_player.play_file(fname)
2019-12-23 01:34:10 +01:00
return "[sound:%s]" % fname
def urlToFile(self, url: str) -> Optional[str]:
l = url.lower()
2019-12-23 01:34:10 +01:00
for suffix in pics + audio:
if l.endswith("." + suffix):
return self._retrieveURL(url)
# not a supported type
return None
2013-07-18 13:32:41 +02:00
def isURL(self, s):
s = s.lower()
2019-12-23 01:34:10 +01:00
return (
s.startswith("http://")
2013-07-18 13:32:41 +02:00
or s.startswith("https://")
or s.startswith("ftp://")
2019-12-23 01:34:10 +01:00
or s.startswith("file://")
)
2013-07-18 13:32:41 +02:00
def inlinedImageToFilename(self, txt: str) -> str:
prefix = "data:image/"
suffix = ";base64,"
for ext in ("jpg", "jpeg", "png", "gif"):
fullPrefix = prefix + ext + suffix
if txt.startswith(fullPrefix):
2019-12-23 01:34:10 +01:00
b64data = txt[len(fullPrefix) :].strip()
data = base64.b64decode(b64data, validate=True)
if ext == "jpeg":
ext = "jpg"
2019-12-23 01:34:10 +01:00
return self._addPastedImage(data, "." + ext)
return ""
def inlinedImageToLink(self, src: str) -> str:
fname = self.inlinedImageToFilename(src)
if fname:
return self.fnameToLink(fname)
return ""
# ext should include dot
def _addPastedImage(self, data: bytes, ext: str) -> str:
# hash and write
csum = checksum(data)
fname = "{}-{}{}".format("paste", csum, ext)
return self._addMediaFromData(fname, data)
def _retrieveURL(self, url: str) -> Optional[str]:
"Download file into media folder and return local filename or None."
# urllib doesn't understand percent-escaped utf8, but requires things like
# '#' to be escaped.
url = urllib.parse.unquote(url)
if url.lower().startswith("file://"):
url = url.replace("%", "%25")
url = url.replace("#", "%23")
local = True
else:
local = False
# fetch it into a temporary folder
2019-12-23 01:34:10 +01:00
self.mw.progress.start(immediate=not local, parent=self.parentWindow)
2020-05-21 01:22:34 +02:00
content_type = None
error_msg: Optional[str] = None
try:
if local:
2019-12-23 01:34:10 +01:00
req = urllib.request.Request(
url, None, {"User-Agent": "Mozilla/5.0 (compatible; Anki)"}
)
2020-05-21 02:57:49 +02:00
with urllib.request.urlopen(req) as response:
filecontents = response.read()
else:
2020-05-21 02:57:49 +02:00
with HttpClient() as client:
client.timeout = 30
with client.get(url) as response:
if response.status_code != 200:
error_msg = (
_("Unexpected response code: %s") % response.status_code
)
return None
2020-05-21 02:57:49 +02:00
filecontents = response.content
content_type = response.headers.get("content-type")
except (urllib.error.URLError, requests.exceptions.RequestException) as e:
error_msg = _("An error occurred while opening %s") % e
return None
finally:
self.mw.progress.finish()
if error_msg:
showWarning(error_msg)
# strip off any query string
2017-12-13 05:34:54 +01:00
url = re.sub(r"\?.*?$", "", url)
2020-01-28 12:45:26 +01:00
fname = os.path.basename(urllib.parse.unquote(url))
if not fname.strip():
fname = "paste"
2020-05-21 01:22:34 +02:00
if content_type:
fname = self.mw.col.media.add_extension_based_on_mime(fname, content_type)
2020-01-28 12:45:26 +01:00
return self.mw.col.media.write_data(fname, filecontents)
# Paste/drag&drop
######################################################################
removeTags = ["script", "iframe", "object", "style"]
def _pastePreFilter(self, html, internal):
# https://anki.tenderapp.com/discussions/ankidesktop/39543-anki-is-replacing-the-character-by-when-i-exit-the-html-edit-mode-ctrlshiftx
if html.find(">") < 0:
return html
with warnings.catch_warnings() as w:
2019-12-23 01:34:10 +01:00
warnings.simplefilter("ignore", UserWarning)
doc = BeautifulSoup(html, "html.parser")
if not internal:
for tag in self.removeTags:
for node in doc(tag):
node.decompose()
# convert p tags to divs
for node in doc("p"):
node.name = "div"
for tag in doc("img"):
try:
2019-12-23 01:34:10 +01:00
src = tag["src"]
except KeyError:
# for some bizarre reason, mnemosyne removes src elements
# from missing media
continue
# in internal pastes, rewrite mediasrv references to relative
if internal:
2017-12-13 05:34:54 +01:00
m = re.match(r"http://127.0.0.1:\d+/(.*)$", src)
if m:
2019-12-23 01:34:10 +01:00
tag["src"] = m.group(1)
else:
# in external pastes, download remote media
if self.isURL(src):
fname = self._retrieveURL(src)
if fname:
2019-12-23 01:34:10 +01:00
tag["src"] = fname
elif src.startswith("data:image/"):
# and convert inlined data
2019-12-23 01:34:10 +01:00
tag["src"] = self.inlinedImageToFilename(src)
html = str(doc)
return html
def doPaste(self, html: str, internal: bool, extended: bool = False) -> None:
html = self._pastePreFilter(html, internal)
if extended:
ext = "true"
else:
ext = "false"
2019-12-23 01:34:10 +01:00
self.web.eval(
"pasteHTML(%s, %s, %s);" % (json.dumps(html), json.dumps(internal), ext)
2019-12-23 01:34:10 +01:00
)
def doDrop(self, html, internal):
2019-12-23 01:34:10 +01:00
self.web.evalWithCallback(
"makeDropTargetCurrent();", lambda _: self.doPaste(html, internal)
)
def onPaste(self):
self.web.onPaste()
def onCutOrCopy(self):
self.web.flagAnkiText()
# Advanced menu
######################################################################
def onAdvanced(self):
m = QMenu(self.mw)
2019-12-22 13:56:17 +01:00
for text, handler, shortcut in (
(_("MathJax inline"), self.insertMathjaxInline, "Ctrl+M, M"),
(_("MathJax block"), self.insertMathjaxBlock, "Ctrl+M, E"),
(_("MathJax chemistry"), self.insertMathjaxChemistry, "Ctrl+M, C"),
(_("LaTeX"), self.insertLatex, "Ctrl+T, T"),
(_("LaTeX equation"), self.insertLatexEqn, "Ctrl+T, E"),
(_("LaTeX math env."), self.insertLatexMathEnv, "Ctrl+T, M"),
2019-12-23 01:34:10 +01:00
(_("Edit HTML"), self.onHtmlEdit, "Ctrl+Shift+X"),
2019-12-22 13:56:17 +01:00
):
a = m.addAction(text)
qconnect(a.triggered, handler)
2019-12-22 13:56:17 +01:00
a.setShortcut(QKeySequence(shortcut))
qtMenuShortcutWorkaround(m)
m.exec_(QCursor.pos())
# LaTeX
######################################################################
def insertLatex(self):
self.web.eval("wrap('[latex]', '[/latex]');")
def insertLatexEqn(self):
self.web.eval("wrap('[$]', '[/$]');")
def insertLatexMathEnv(self):
self.web.eval("wrap('[$$]', '[/$$]');")
def insertMathjaxInline(self):
self.web.eval("wrap('\\\\(', '\\\\)');")
def insertMathjaxBlock(self):
self.web.eval("wrap('\\\\[', '\\\\]');")
2018-08-06 05:17:57 +02:00
def insertMathjaxChemistry(self):
self.web.eval("wrap('\\\\(\\\\ce{', '}\\\\)');")
2018-08-06 05:17:57 +02:00
# Links from HTML
######################################################################
_links = dict(
fields=onFields,
cards=onCardLayout,
bold=toggleBold,
italic=toggleItalic,
underline=toggleUnderline,
super=toggleSuper,
sub=toggleSub,
clear=removeFormat,
colour=onForeground,
changeCol=onChangeCol,
cloze=onCloze,
attach=onAddMedia,
record=onRecSound,
more=onAdvanced,
dupes=showDupes,
paste=onPaste,
cutOrCopy=onCutOrCopy,
)
2019-12-23 01:34:10 +01:00
# Pasting, drag & drop, and keyboard layouts
######################################################################
2019-12-23 01:34:10 +01:00
class EditorWebView(AnkiWebView):
def __init__(self, parent, editor):
AnkiWebView.__init__(self, title="editor")
self.editor = editor
2019-12-23 01:34:10 +01:00
self.strip = self.editor.mw.pm.profile["stripHTML"]
self.setAcceptDrops(True)
self._markInternal = False
clip = self.editor.mw.app.clipboard()
qconnect(clip.dataChanged, self._onClipboardChange)
gui_hooks.editor_web_view_did_init(self)
def _onClipboardChange(self):
if self._markInternal:
self._markInternal = False
self._flagAnkiText()
def onCut(self):
self.triggerPageAction(QWebEnginePage.Cut)
def onCopy(self):
self.triggerPageAction(QWebEnginePage.Copy)
def _onPaste(self, mode: QClipboard.Mode) -> None:
2019-12-06 04:37:50 +01:00
extended = not (self.editor.mw.app.queryKeyboardModifiers() & Qt.ShiftModifier)
if self.editor.mw.pm.profile.get("pasteInvert", False):
extended = not extended
2018-03-02 02:16:02 +01:00
mime = self.editor.mw.app.clipboard().mimeData(mode=mode)
html, internal = self._processMime(mime)
if not html:
return
self.editor.doPaste(html, internal, extended)
def onPaste(self) -> None:
2018-03-02 02:16:02 +01:00
self._onPaste(QClipboard.Clipboard)
def onMiddleClickPaste(self) -> None:
2018-03-02 02:16:02 +01:00
self._onPaste(QClipboard.Selection)
def dropEvent(self, evt):
mime = evt.mimeData()
if evt.source() and mime.hasHtml():
# don't filter html from other fields
html, internal = mime.html(), True
else:
html, internal = self._processMime(mime)
if not html:
return
self.editor.doDrop(html, internal)
# returns (html, isInternal)
def _processMime(self, mime: QMimeData) -> Tuple[str, bool]:
# print("html=%s image=%s urls=%s txt=%s" % (
# mime.hasHtml(), mime.hasImage(), mime.hasUrls(), mime.hasText()))
# print("html", mime.html())
# print("urls", mime.urls())
# print("text", mime.text())
# try various content types in turn
html, internal = self._processHtml(mime)
if html:
return html, internal
# favour url if it's a local link
if mime.hasUrls() and mime.urls()[0].toString().startswith("file://"):
types = (self._processUrls, self._processImage, self._processText)
else:
types = (self._processImage, self._processUrls, self._processText)
for fn in types:
html = fn(mime)
if html:
return html, True
return "", False
def _processUrls(self, mime: QMimeData) -> Optional[str]:
if not mime.hasUrls():
return None
buf = ""
for qurl in mime.urls():
url = qurl.toString()
# chrome likes to give us the URL twice with a \n
url = url.splitlines()[0]
buf += self.editor.urlToLink(url) or ""
return buf
def _processText(self, mime: QMimeData) -> Optional[str]:
if not mime.hasText():
return None
txt = mime.text()
2020-07-24 07:12:46 +02:00
processed = []
2020-07-24 04:51:36 +02:00
lines = txt.split("\n")
for line in lines:
2020-07-24 07:12:46 +02:00
for token in re.split("(\S+)", line):
2020-07-24 04:51:36 +02:00
# inlined data in base64?
if token.startswith("data:image/"):
2020-07-24 07:12:46 +02:00
processed.append(self.editor.inlinedImageToLink(token))
2020-07-24 04:51:36 +02:00
elif self.editor.isURL(token):
# if the user is pasting an image or sound link, convert it to local
link = self.editor.urlToLink(token)
if link:
2020-07-24 07:12:46 +02:00
processed.append(link)
2020-07-24 04:51:36 +02:00
else:
# not media; add it as a normal link
link = '<a href="{}">{}</a>'.format(token, html.escape(token))
2020-07-24 07:12:46 +02:00
processed.append(link)
2020-07-24 04:51:36 +02:00
else:
token = html.escape(token).replace("\t", " " * 4)
# if there's more than one consecutive space,
# use non-breaking spaces for the second one on
def repl(match):
return match.group(1).replace(" ", "&nbsp;") + " "
2020-07-24 08:00:34 +02:00
2020-07-24 04:51:36 +02:00
token = re.sub(" ( +)", repl, token)
2020-07-24 07:12:46 +02:00
processed.append(token)
2020-07-24 04:51:36 +02:00
2020-07-24 07:12:46 +02:00
processed.append("<br>")
# remove last <br>
processed.pop()
return "".join(processed)
def _processHtml(self, mime: QMimeData) -> Tuple[Optional[str], bool]:
if not mime.hasHtml():
return None, False
html = mime.html()
# no filtering required for internal pastes
if html.startswith("<!--anki-->"):
return html[11:], True
return html, False
def _processImage(self, mime: QMimeData) -> Optional[str]:
if not mime.hasImage():
return None
im = QImage(mime.imageData())
uname = namedtmp("paste")
if self.editor.mw.pm.profile.get("pastePNG", False):
ext = ".png"
2019-12-23 01:34:10 +01:00
im.save(uname + ext, None, 50)
else:
ext = ".jpg"
2019-12-23 01:34:10 +01:00
im.save(uname + ext, None, 80)
# invalid image?
2019-12-23 01:34:10 +01:00
path = uname + ext
if not os.path.exists(path):
return None
with open(path, "rb") as file:
data = file.read()
2018-08-08 04:45:59 +02:00
fname = self.editor._addPastedImage(data, ext)
if fname:
return self.editor.fnameToLink(fname)
return None
def flagAnkiText(self):
# be ready to adjust when clipboard event fires
self._markInternal = True
def _flagAnkiText(self):
# add a comment in the clipboard html so we can tell text is copied
# from us and doesn't need to be stripped
clip = self.editor.mw.app.clipboard()
if not isMac and not clip.ownsClipboard():
return
mime = clip.mimeData()
if not mime.hasHtml():
return
html = mime.html()
mime.setHtml("<!--anki-->" + html)
clip.setMimeData(mime)
def contextMenuEvent(self, evt: QContextMenuEvent) -> None:
m = QMenu(self)
a = m.addAction(_("Cut"))
qconnect(a.triggered, self.onCut)
a = m.addAction(_("Copy"))
qconnect(a.triggered, self.onCopy)
a = m.addAction(_("Paste"))
qconnect(a.triggered, self.onPaste)
gui_hooks.editor_will_show_context_menu(self, m)
m.popup(QCursor.pos())
2019-12-23 01:34:10 +01:00
2018-11-15 05:04:08 +01:00
# QFont returns "Kozuka Gothic Pro L" but WebEngine expects "Kozuka Gothic Pro Light"
# - there may be other cases like a trailing 'Bold' that need fixing, but will
# wait for further reports first.
def fontMungeHack(font):
2018-11-15 05:04:08 +01:00
return re.sub(" L$", " Light", font)
2019-12-23 01:34:10 +01:00
gui_hooks.editor_will_use_font_for_field.append(fontMungeHack)