1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194
|
# This file is part of ReText
# Copyright: 2016 Maurice van der Pot
#
# 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 2 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 multiprocessing as mp
import os
import pickle
import signal
import struct
import traceback
import weakref
from socket import socketpair
import markups
from PyQt6.QtCore import QObject, QSocketNotifier, pyqtSignal
def recvall(sock, remaining):
alldata = bytearray()
while remaining > 0:
data = sock.recv(remaining)
if len(data) == 0:
raise EOFError(
'Received 0 bytes from socket while more bytes were expected.'
' Did the sender process exit unexpectedly?'
)
alldata.extend(data)
remaining -= len(data)
return alldata
def receiveObject(sock):
sizeBuf = recvall(sock, 4)
size = struct.unpack('I', sizeBuf)[0]
message = recvall(sock, size)
obj = pickle.loads(message)
return obj
def sendObject(sock, obj):
message = pickle.dumps(obj)
sizeBuf = struct.pack('I', len(message))
sock.sendall(sizeBuf)
sock.sendall(message)
class ConversionError(Exception):
pass
class MarkupNotAvailableError(Exception):
pass
def _indent(text, prefix):
return ''.join(f'{prefix}{line}\n' for line in text.splitlines())
def _converter_process_func(conn_parent, conn_child):
conn_parent.close()
# Ignore ctrl-C. The main application will also receive the signal and
# determine if the application should be stopped or not.
signal.signal(signal.SIGINT, signal.SIG_IGN)
current_markup = None
while True:
job = receiveObject(conn_child)
if job['command'] == 'quit':
break
elif job['command'] == 'convert':
try:
os.chdir(job['current_dir'])
if (not current_markup or
current_markup.name != job['markup_name'] or
current_markup.filename != job['filename']):
markup_class = markups.find_markup_class_by_name(job['markup_name'])
if not markup_class.available():
raise MarkupNotAvailableError('The specified markup was not available')
current_markup = markup_class(job['filename'])
current_markup.requested_extensions = job['requested_extensions']
converted = current_markup.convert(job['text'])
result = ('ok', converted)
except MarkupNotAvailableError as e:
result = ('markupnotavailableerror', e.args)
except Exception:
result = ('conversionerror',
'The background markup conversion process received this exception:\n' +
_indent(traceback.format_exc(), ' '))
try:
sendObject(conn_child, result)
except BrokenPipeError:
# Continue despite the broken pipe because we expect that a
# 'quit' command will have been sent. If it has been then we
# should terminate without any error messages. If no command
# was queued we will get an EOFError from the read, giving us a
# second chance to show that something went wrong by exiting
# with a traceback.
continue
class ConverterProcess(QObject):
conversionDone = pyqtSignal()
def __init__(self):
super().__init__()
conn_parent, conn_child = socketpair()
# TODO: figure out which of the two sockets should be set to
# inheritable and which should be passed to the child
conn_child.set_inheritable(True)
# Use a local variable for child so that we can talk to the child in
# on_finalize without needing a reference to self
child = mp.Process(target=_converter_process_func, args=(conn_parent, conn_child))
child.daemon = True
child.start()
self.child = child
conn_child.close()
self.conn = conn_parent
self.busy = False
self.notificationPending = False
self.conversionNotifier = QSocketNotifier(self.conn.fileno(),
QSocketNotifier.Type.Read)
self.conversionNotifier.activated.connect(self._conversionNotifierActivated)
def on_finalize(conn):
sendObject(conn_parent, {'command':'quit'})
conn_parent.close()
child.join()
weakref.finalize(self, on_finalize, conn_parent)
def _conversionNotifierActivated(self):
# The ready-for-read signal on the socket may be triggered multiple
# times, but we only send a single notification to the client as soon
# as the results of the conversion are starting to come in. This makes
# it easy for clients to avoid multiple calls to get_result for the
# same conversion.
if self.notificationPending:
self.notificationPending = False
# Set the socket to blocking before waking up any interested parties,
# because it has been set to unblocking by QSocketNotifier
self.conn.setblocking(True)
self.conversionDone.emit()
def start_conversion(self, markup_name, filename, requested_extensions, text, current_dir):
if self.busy:
raise RuntimeError('Already converting')
sendObject(self.conn, {'command': 'convert',
'markup_name' : markup_name,
'filename' : filename,
'current_dir': current_dir,
'requested_extensions' : requested_extensions,
'text' : text})
self.busy = True
self.notificationPending = True
def get_result(self):
if not self.busy:
raise RuntimeError('No ongoing conversion')
self.busy = False
status, result = receiveObject(self.conn)
if status == 'markupnotavailableerror':
raise MarkupNotAvailableError(result)
elif status == 'conversionerror':
raise ConversionError(result)
return result
def stop(self):
sendObject(self.conn, {'command': 'quit'})
self.conn.close()
|