anki-connect/plugin/util.py

132 lines
2.7 KiB
Python
Raw Normal View History

2021-01-18 06:15:48 +00:00
# Copyright 2016-2021 Alex Yatskov
2020-01-05 23:42:08 +00:00
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import anki
import anki.sync
import aqt
import enum
2020-01-05 23:42:08 +00:00
#
# Utilities
#
2021-01-18 06:13:27 +00:00
class MediaType(enum.Enum):
Audio = 1
Video = 2
Picture = 3
2021-01-18 06:13:27 +00:00
2020-01-05 23:42:08 +00:00
def download(url):
client = anki.sync.AnkiRequestsClient()
client.timeout = setting('webTimeout') / 1000
2021-01-19 04:18:57 +00:00
2020-01-05 23:42:08 +00:00
resp = client.get(url)
2021-01-19 04:18:57 +00:00
if resp.status_code != 200:
2020-01-05 23:42:08 +00:00
raise Exception('{} download failed with return code {}'.format(url, resp.status_code))
2021-02-23 03:25:12 +00:00
return client.streamContent(resp)
2021-01-19 04:18:57 +00:00
2020-01-05 23:42:08 +00:00
def api(*versions):
def decorator(func):
method = lambda *args, **kwargs: func(*args, **kwargs)
setattr(method, 'versions', versions)
setattr(method, 'api', True)
return method
return decorator
2021-01-18 06:13:27 +00:00
def cardQuestion(card):
2020-04-04 17:28:37 +00:00
if getattr(card, 'question', None) is None:
2021-01-18 06:13:27 +00:00
return card._getQA()['q']
2021-01-20 05:59:45 +00:00
return card.question()
2020-04-04 17:28:37 +00:00
2021-01-18 06:13:27 +00:00
def cardAnswer(card):
2020-04-04 17:28:37 +00:00
if getattr(card, 'answer', None) is None:
2021-01-18 06:13:27 +00:00
return card._getQA()['a']
return card.answer()
2020-04-04 17:28:37 +00:00
2020-01-05 23:42:08 +00:00
def setting(key):
defaults = {
2020-03-06 03:33:27 +00:00
'apiKey': None,
'apiLogPath': None,
2020-01-05 23:42:08 +00:00
'apiPollInterval': 25,
2020-03-06 03:33:27 +00:00
'apiVersion': 6,
'webBacklog': 5,
'webBindAddress': os.getenv('ANKICONNECT_BIND_ADDRESS', '127.0.0.1'),
'webBindPort': 8765,
'webCorsOrigin': os.getenv('ANKICONNECT_CORS_ORIGIN', None),
'webCorsOriginList': ['http://localhost'],
'ignoreOriginList': [],
2020-03-06 03:33:27 +00:00
'webTimeout': 10000,
2020-01-05 23:42:08 +00:00
}
try:
return aqt.mw.addonManager.getConfig(__name__).get(key, defaults[key])
except:
2021-07-18 23:54:45 +00:00
raise Exception(f'setting {key} not found')
2021-07-18 17:31:47 +00:00
#
# Anki Helpers
#
def window(self):
return aqt.mw
def reviewer():
return window().reviewer
def collection(self):
return window().col
def decks(self):
return collection().decks
def scheduler(self):
return collection().sched
def database(self):
return collection().db
def media(self):
return collection().media
def deckNames():
return decks().allNames()
class EditScope:
def __enter__(self):
window().requireReset()
def __exit__(self):
window().maybeReset()