457 lines
11 KiB
Python
457 lines
11 KiB
Python
# Copyright (C) 2016 Alex Yatskov <alex@foosoft.net>
|
|
# Author: Alex Yatskov <alex@foosoft.net>
|
|
#
|
|
# 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 anki
|
|
import aqt
|
|
import hashlib
|
|
import json
|
|
import select
|
|
import socket
|
|
|
|
|
|
#
|
|
# Constants
|
|
#
|
|
|
|
API_VERSION = 1
|
|
URL_TIMEOUT = 10
|
|
|
|
|
|
#
|
|
# General helpers
|
|
#
|
|
|
|
try:
|
|
import urllib2
|
|
urlQuote = urllib2.quote
|
|
urlOpen = urllib2.urlopen
|
|
except ImportError:
|
|
from urllib import request
|
|
urlQuote = request.quote
|
|
urlOpen = request.urlopen
|
|
|
|
try:
|
|
import PyQt4 as PyQt
|
|
except ImportError:
|
|
import PyQt5 as PyQt
|
|
|
|
makeBytes = lambda data: data.encode('utf-8')
|
|
makeStr = lambda data: data.decode('utf-8')
|
|
|
|
|
|
#
|
|
# Audio helpers
|
|
#
|
|
|
|
def audioBuildFilename(kana, kanji):
|
|
filename = u'yomichan_{}'.format(kana)
|
|
if kanji:
|
|
filename += u'_{}'.format(kanji)
|
|
filename += u'.mp3'
|
|
return filename
|
|
|
|
|
|
def audioDownload(kana, kanji):
|
|
url = 'https://assets.languagepod101.com/dictionary/japanese/audiomp3.php?kanji={}'.format(urlQuote(kanji.encode('utf-8')))
|
|
if kana:
|
|
url += '&kana={}'.format(urlQuote(kana.encode('utf-8')))
|
|
|
|
try:
|
|
resp = urlOpen(url, timeout=URL_TIMEOUT)
|
|
except:
|
|
return None
|
|
|
|
if resp.code != 200:
|
|
return None
|
|
|
|
return resp.read()
|
|
|
|
|
|
def audioIsPlaceholder(data):
|
|
m = hashlib.md5()
|
|
m.update(data)
|
|
return m.hexdigest() == '7e2c2f954ef6051373ba916f000168dc'
|
|
|
|
|
|
def audioInject(note, fields, filename):
|
|
for field in fields:
|
|
if field in note:
|
|
note[field] += u'[sound:{}]'.format(filename)
|
|
|
|
|
|
#
|
|
# AjaxRequest
|
|
#
|
|
|
|
class AjaxRequest:
|
|
def __init__(self, headers, body):
|
|
self.headers = headers
|
|
self.body = body
|
|
|
|
|
|
#
|
|
# AjaxClient
|
|
#
|
|
|
|
class AjaxClient:
|
|
def __init__(self, sock, handler):
|
|
self.sock = sock
|
|
self.handler = handler
|
|
self.readBuff = bytes()
|
|
self.writeBuff = bytes()
|
|
|
|
|
|
def advance(self, recvSize=1024):
|
|
if self.sock is None:
|
|
return False
|
|
|
|
rlist, wlist = select.select([self.sock], [self.sock], [], 0)[:2]
|
|
|
|
if rlist:
|
|
msg = self.sock.recv(recvSize)
|
|
if not msg:
|
|
self.close()
|
|
return False
|
|
|
|
self.readBuff += msg
|
|
|
|
req, length = self.parseRequest(self.readBuff)
|
|
if req is not None:
|
|
self.readBuff = self.readBuff[length:]
|
|
self.writeBuff += self.handler(req)
|
|
|
|
if wlist and self.writeBuff:
|
|
length = self.sock.send(self.writeBuff)
|
|
self.writeBuff = self.writeBuff[length:]
|
|
if not self.writeBuff:
|
|
self.close()
|
|
return False
|
|
|
|
return True
|
|
|
|
|
|
def close(self):
|
|
if self.sock is not None:
|
|
self.sock.close()
|
|
self.sock = None
|
|
|
|
self.readBuff = bytes()
|
|
self.writeBuff = bytes()
|
|
|
|
|
|
def parseRequest(self, data):
|
|
parts = data.split(makeBytes('\r\n\r\n'), 1)
|
|
if len(parts) == 1:
|
|
return None, 0
|
|
|
|
headers = {}
|
|
for line in parts[0].split(makeBytes('\r\n')):
|
|
pair = line.split(makeBytes(': '))
|
|
headers[pair[0]] = pair[1] if len(pair) > 1 else None
|
|
|
|
headerLength = len(parts[0]) + 4
|
|
bodyLength = int(headers[makeBytes('Content-Length')])
|
|
totalLength = headerLength + bodyLength
|
|
|
|
if totalLength > len(data):
|
|
return None, 0
|
|
|
|
body = data[headerLength : totalLength]
|
|
return AjaxRequest(headers, body), totalLength
|
|
|
|
|
|
#
|
|
# AjaxServer
|
|
#
|
|
|
|
class AjaxServer:
|
|
def __init__(self, handler):
|
|
self.handler = handler
|
|
self.clients = []
|
|
self.sock = None
|
|
|
|
|
|
def advance(self):
|
|
if self.sock is not None:
|
|
self.acceptClients()
|
|
self.advanceClients()
|
|
|
|
|
|
def acceptClients(self):
|
|
rlist = select.select([self.sock], [], [], 0)[0]
|
|
if not rlist:
|
|
return
|
|
|
|
clientSock = self.sock.accept()[0]
|
|
if clientSock is not None:
|
|
clientSock.setblocking(False)
|
|
self.clients.append(AjaxClient(clientSock, self.handlerWrapper))
|
|
|
|
|
|
def advanceClients(self):
|
|
self.clients = list(filter(lambda c: c.advance(), self.clients))
|
|
|
|
|
|
def listen(self, address='127.0.0.1', port=8765, backlog=5):
|
|
self.close()
|
|
|
|
self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
|
|
self.sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
|
|
self.sock.setblocking(False)
|
|
self.sock.bind((address, port))
|
|
self.sock.listen(backlog)
|
|
|
|
|
|
def handlerWrapper(self, req):
|
|
body = makeBytes(json.dumps(self.handler(json.loads(makeStr(req.body)))))
|
|
resp = bytes()
|
|
|
|
headers = [
|
|
['HTTP/1.1 200 OK', None],
|
|
['Content-Type', 'text/json'],
|
|
['Content-Length', str(len(body))]
|
|
]
|
|
|
|
for [key, value] in headers:
|
|
if value is None:
|
|
resp += makeBytes('{}\r\n'.format(key))
|
|
else:
|
|
resp += makeBytes('{}: {}\r\n'.format(key, value))
|
|
|
|
resp += makeBytes('\r\n')
|
|
resp += body
|
|
|
|
return resp
|
|
|
|
|
|
def close(self):
|
|
if self.sock is not None:
|
|
self.sock.close()
|
|
self.sock = None
|
|
|
|
for client in self.clients:
|
|
client.close()
|
|
|
|
self.clients = []
|
|
|
|
|
|
#
|
|
# AnkiBridge
|
|
#
|
|
|
|
class AnkiBridge:
|
|
def addNote(self, deckName, modelName, fields, tags, audio):
|
|
collection = self.collection()
|
|
if collection is None:
|
|
return
|
|
|
|
note = self.createNote(deckName, modelName, fields, tags)
|
|
if note is None:
|
|
return
|
|
|
|
if audio is not None and len(audio['fields']) > 0:
|
|
data = audioDownload(audio['kana'], audio['kanji'])
|
|
if data is not None and not audioIsPlaceholder(data):
|
|
filename = audioBuildFilename(audio['kana'], audio['kanji'])
|
|
audioInject(note, audio['fields'], filename)
|
|
self.media().writeData(filename, data)
|
|
|
|
self.startEditing()
|
|
collection.addNote(note)
|
|
collection.autosave()
|
|
self.stopEditing()
|
|
|
|
return note.id
|
|
|
|
|
|
def canAddNote(self, deckName, modelName, fields):
|
|
return bool(self.createNote(deckName, modelName, fields))
|
|
|
|
|
|
def createNote(self, deckName, modelName, fields, tags=[]):
|
|
collection = self.collection()
|
|
if collection is None:
|
|
return
|
|
|
|
model = collection.models.byName(modelName)
|
|
if model is None:
|
|
return
|
|
|
|
deck = collection.decks.byName(deckName)
|
|
if deck is None:
|
|
return
|
|
|
|
note = anki.notes.Note(collection, model)
|
|
note.model()['did'] = deck['id']
|
|
note.tags = tags
|
|
|
|
for name, value in fields.items():
|
|
if name in note:
|
|
note[name] = value
|
|
|
|
if not note.dupeOrEmpty():
|
|
return note
|
|
|
|
|
|
def browseNote(self, deckName, modelName, fields):
|
|
fields = self.modelFieldNames(modelName)
|
|
if fields is None:
|
|
return
|
|
|
|
fieldName = fields[0]
|
|
fieldValue = fields.get(fieldName)
|
|
|
|
if fieldValue is None:
|
|
return
|
|
|
|
browser = aqt.dialogs.open('Browser', self.window())
|
|
browser.form.searchEdit.lineEdit().setText('deck:{} {}:{}'.format(deckName, fieldName, fieldValue))
|
|
browser.onSearch()
|
|
|
|
|
|
def startEditing(self):
|
|
self.window().requireReset()
|
|
|
|
|
|
def stopEditing(self):
|
|
if self.collection() is not None:
|
|
self.window().maybeReset()
|
|
|
|
|
|
def window(self):
|
|
return aqt.mw
|
|
|
|
|
|
def collection(self):
|
|
return self.window().col
|
|
|
|
|
|
def media(self):
|
|
collection = self.collection()
|
|
if collection is not None:
|
|
return collection.media
|
|
|
|
|
|
def modelNames(self):
|
|
collection = self.collection()
|
|
if collection is not None:
|
|
return collection.models.allNames()
|
|
|
|
|
|
def modelFieldNames(self, modelName):
|
|
collection = self.collection()
|
|
if collection is None:
|
|
return
|
|
|
|
model = collection.models.byName(modelName)
|
|
if model is not None:
|
|
return [field['name'] for field in model['flds']]
|
|
|
|
|
|
def deckNames(self):
|
|
collection = self.collection()
|
|
if collection is not None:
|
|
return collection.decks.allNames()
|
|
|
|
|
|
#
|
|
# AnkiConnect
|
|
#
|
|
|
|
class AnkiConnect:
|
|
def __init__(self, interval=25):
|
|
self.anki = AnkiBridge()
|
|
self.server = AjaxServer(self.handler)
|
|
self.server.listen()
|
|
|
|
self.timer = PyQt.QtCore.QTimer()
|
|
self.timer.timeout.connect(self.advance)
|
|
self.timer.start(interval)
|
|
|
|
|
|
def advance(self):
|
|
self.server.advance()
|
|
|
|
|
|
def handler(self, request):
|
|
action = 'api_' + (request.get('action') or '')
|
|
if hasattr(self, action):
|
|
return getattr(self, action)(**(request.get('params') or {}))
|
|
|
|
|
|
def api_deckNames(self):
|
|
return self.anki.deckNames()
|
|
|
|
|
|
def api_modelNames(self):
|
|
return self.anki.modelNames()
|
|
|
|
|
|
def api_modelFieldNames(self, modelName):
|
|
return self.anki.modelFieldNames(modelName)
|
|
|
|
|
|
def api_addNote(self, note):
|
|
return self.anki.addNote(
|
|
note['deckName'],
|
|
note['modelName'],
|
|
note['fields'],
|
|
note['tags'],
|
|
note.get('audio')
|
|
)
|
|
|
|
|
|
def api_canAddNotes(self, notes):
|
|
results = []
|
|
for note in notes:
|
|
results.append(self.anki.canAddNote(
|
|
note['deckName'],
|
|
note['modelName'],
|
|
note['fields']
|
|
))
|
|
|
|
return results
|
|
|
|
|
|
def api_browseNote(self, note):
|
|
return self.anki.browseNote(
|
|
note['deckName'],
|
|
note['modelName'],
|
|
note['fields']
|
|
)
|
|
|
|
|
|
def api_features(self):
|
|
features = {}
|
|
for name in dir(self):
|
|
method = getattr(self, name)
|
|
if name.startswith('api_') and callable(method):
|
|
features[name[4:]] = list(method.func_code.co_varnames[1:])
|
|
|
|
return features
|
|
|
|
|
|
def api_version(self):
|
|
return API_VERSION
|
|
|
|
|
|
#
|
|
# Entry
|
|
#
|
|
|
|
ac = AnkiConnect()
|