anki-connect/plugin/util.py

94 lines
2.4 KiB
Python
Raw Permalink 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 sys
2020-01-05 23:42:08 +00:00
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):
setattr(func, 'versions', versions)
setattr(func, 'api', True)
return func
2020-01-05 23:42:08 +00:00
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
DEFAULT_CONFIG = {
'apiKey': None,
'apiLogPath': None,
'apiPollInterval': 25,
'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': [],
'webTimeout': 10000,
}
2020-01-05 23:42:08 +00:00
def setting(key):
2020-01-05 23:42:08 +00:00
try:
return aqt.mw.addonManager.getConfig(__name__).get(key, DEFAULT_CONFIG[key])
2020-01-05 23:42:08 +00:00
except:
raise Exception('setting {} not found'.format(key))
# see https://github.com/FooSoft/anki-connect/issues/308
# fixed in https://github.com/ankitects/anki/commit/0b2a226d
def patch_anki_2_1_50_having_null_stdout_on_windows():
if sys.stdout is None:
sys.stdout = open(os.devnull, "w", encoding="utf8")