Improve socket handling for -x spawned fenrir instances.
This commit is contained in:
Storm Dragon
@@ -8,15 +8,22 @@ import os
|
||||
import os.path
|
||||
import select
|
||||
import socket
|
||||
import time
|
||||
|
||||
from fenrirscreenreader.core import debug
|
||||
from fenrirscreenreader.core import remoteInstanceRegistry
|
||||
from fenrirscreenreader.core.eventData import FenrirEventType
|
||||
from fenrirscreenreader.core.remoteDriver import RemoteDriver as remoteDriver
|
||||
|
||||
|
||||
MAIN_SOCKET_FILE = "/tmp/fenrirscreenreader-deamon.sock"
|
||||
|
||||
|
||||
class driver(remoteDriver):
|
||||
def __init__(self):
|
||||
remoteDriver.__init__(self)
|
||||
self.fenrirSocks = []
|
||||
self.socket_files = []
|
||||
|
||||
def initialize(self, environment):
|
||||
self.env = environment
|
||||
@@ -26,9 +33,7 @@ class driver(remoteDriver):
|
||||
self.watch_dog, multiprocess=False
|
||||
)
|
||||
|
||||
def watch_dog(self, active, event_queue):
|
||||
# echo "command say this is a test" | socat -
|
||||
# UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
def _get_configured_socket_file(self):
|
||||
socket_file = ""
|
||||
try:
|
||||
socket_file = self.env["runtime"]["SettingsManager"].get_setting(
|
||||
@@ -40,62 +45,153 @@ class driver(remoteDriver):
|
||||
+ str(e),
|
||||
debug.DebugLevel.ERROR,
|
||||
)
|
||||
if socket_file == "":
|
||||
if (
|
||||
self.env["runtime"]["SettingsManager"].get_setting(
|
||||
"screen", "driver"
|
||||
)
|
||||
== "vcsaDriver"
|
||||
):
|
||||
socket_file = "/tmp/fenrirscreenreader-deamon.sock"
|
||||
else:
|
||||
socket_file = (
|
||||
"/tmp/fenrirscreenreader-" + str(os.getppid()) + ".sock"
|
||||
)
|
||||
return socket_file
|
||||
|
||||
def _get_socket_candidates(self):
|
||||
configured_socket_file = self._get_configured_socket_file()
|
||||
if configured_socket_file:
|
||||
return [(configured_socket_file, False)]
|
||||
|
||||
screen_driver = self.env["runtime"]["SettingsManager"].get_setting(
|
||||
"screen", "driver"
|
||||
)
|
||||
if screen_driver == "vcsaDriver":
|
||||
return [(MAIN_SOCKET_FILE, False)]
|
||||
|
||||
private_socket_file = (
|
||||
"/tmp/fenrirscreenreader-" + str(os.getpid()) + ".sock"
|
||||
)
|
||||
return [(private_socket_file, False), (MAIN_SOCKET_FILE, True)]
|
||||
|
||||
def _is_socket_active(self, socket_file):
|
||||
test_sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
||||
try:
|
||||
test_sock.settimeout(0.2)
|
||||
test_sock.connect(socket_file)
|
||||
return True
|
||||
except OSError:
|
||||
return False
|
||||
finally:
|
||||
test_sock.close()
|
||||
|
||||
def _bind_socket(self, socket_file, optional):
|
||||
if os.path.exists(socket_file):
|
||||
if optional and self._is_socket_active(socket_file):
|
||||
return None
|
||||
os.unlink(socket_file)
|
||||
self.fenrirSock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
||||
self.fenrirSock.bind(socket_file)
|
||||
os.chmod(socket_file, 0o666) # Allow all users to read/write
|
||||
self.fenrirSock.listen(1)
|
||||
|
||||
fenrir_sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
|
||||
try:
|
||||
fenrir_sock.bind(socket_file)
|
||||
os.chmod(socket_file, 0o666) # Allow all users to read/write
|
||||
fenrir_sock.listen(1)
|
||||
except OSError:
|
||||
fenrir_sock.close()
|
||||
if optional:
|
||||
return None
|
||||
raise
|
||||
return fenrir_sock
|
||||
|
||||
def _register_instance(self):
|
||||
settings_manager = self.env["runtime"]["SettingsManager"]
|
||||
instance_data = {
|
||||
"pid": os.getpid(),
|
||||
"ppid": os.getppid(),
|
||||
"socket_files": self.socket_files,
|
||||
"main_socket": MAIN_SOCKET_FILE in self.socket_files,
|
||||
"screen_driver": settings_manager.get_setting("screen", "driver"),
|
||||
"keyboard_driver": settings_manager.get_setting("keyboard", "driver"),
|
||||
"x11_window_id": settings_manager.get_setting(
|
||||
"keyboard", "x11_window_id"
|
||||
),
|
||||
"created_at": time.time(),
|
||||
}
|
||||
remoteInstanceRegistry.write_instance(instance_data)
|
||||
|
||||
def _cleanup(self):
|
||||
for fenrir_sock in self.fenrirSocks:
|
||||
try:
|
||||
fenrir_sock.close()
|
||||
except OSError:
|
||||
pass
|
||||
self.fenrirSocks = []
|
||||
|
||||
for socket_file in self.socket_files:
|
||||
try:
|
||||
if os.path.exists(socket_file):
|
||||
os.unlink(socket_file)
|
||||
except OSError:
|
||||
pass
|
||||
self.socket_files = []
|
||||
remoteInstanceRegistry.remove_instance()
|
||||
|
||||
def _handle_client(self, client_sock, event_queue):
|
||||
try:
|
||||
rawdata = client_sock.recv(8129)
|
||||
except Exception as e:
|
||||
self.env["runtime"]["DebugManager"].write_debug_out(
|
||||
"unixDriver watch_dog: Error receiving data from client: "
|
||||
+ str(e),
|
||||
debug.DebugLevel.ERROR,
|
||||
)
|
||||
rawdata = b""
|
||||
|
||||
try:
|
||||
data = rawdata.decode("utf-8").rstrip().lstrip()
|
||||
upper_data = data.upper()
|
||||
if upper_data in ("LS", "LIST", "COMMAND LS", "COMMAND LIST"):
|
||||
response = self.env["runtime"][
|
||||
"RemoteManager"
|
||||
].handle_remote_incomming_with_response(data)
|
||||
client_sock.sendall((response["message"] + "\n").encode("utf-8"))
|
||||
return
|
||||
|
||||
event_queue.put(
|
||||
{
|
||||
"Type": FenrirEventType.remote_incomming,
|
||||
"data": data,
|
||||
}
|
||||
)
|
||||
except Exception as e:
|
||||
self.env["runtime"]["DebugManager"].write_debug_out(
|
||||
"unixDriver watch_dog: Error decoding/queuing data: "
|
||||
+ str(e),
|
||||
debug.DebugLevel.ERROR,
|
||||
)
|
||||
|
||||
def watch_dog(self, active, event_queue):
|
||||
# echo "command say this is a test" | socat -
|
||||
# UNIX-CLIENT:/tmp/fenrirscreenreader-deamon.sock
|
||||
for socket_file, optional in self._get_socket_candidates():
|
||||
fenrir_sock = self._bind_socket(socket_file, optional)
|
||||
if fenrir_sock is None:
|
||||
continue
|
||||
self.fenrirSocks.append(fenrir_sock)
|
||||
self.socket_files.append(socket_file)
|
||||
|
||||
if not self.fenrirSocks:
|
||||
return
|
||||
|
||||
self._register_instance()
|
||||
last_register = time.time()
|
||||
while active.value:
|
||||
if time.time() - last_register > 10.0:
|
||||
self._register_instance()
|
||||
last_register = time.time()
|
||||
|
||||
# Check if the client is still connected and if data is available:
|
||||
try:
|
||||
r, _, _ = select.select([self.fenrirSock], [], [], 0.8)
|
||||
r, _, _ = select.select(self.fenrirSocks, [], [], 0.8)
|
||||
except select.error:
|
||||
break
|
||||
if r == []:
|
||||
continue
|
||||
if self.fenrirSock in r:
|
||||
client_sock, client_addr = self.fenrirSock.accept()
|
||||
for fenrir_sock in r:
|
||||
client_sock, client_addr = fenrir_sock.accept()
|
||||
# Ensure client socket is always closed to prevent resource
|
||||
# leaks
|
||||
try:
|
||||
try:
|
||||
rawdata = client_sock.recv(8129)
|
||||
except Exception as e:
|
||||
self.env["runtime"]["DebugManager"].write_debug_out(
|
||||
"unixDriver watch_dog: Error receiving data from "
|
||||
"client: "
|
||||
+ str(e),
|
||||
debug.DebugLevel.ERROR,
|
||||
)
|
||||
rawdata = b"" # Set default empty data if recv fails
|
||||
|
||||
try:
|
||||
data = rawdata.decode("utf-8").rstrip().lstrip()
|
||||
event_queue.put(
|
||||
{
|
||||
"Type": FenrirEventType.remote_incomming,
|
||||
"data": data,
|
||||
}
|
||||
)
|
||||
except Exception as e:
|
||||
self.env["runtime"]["DebugManager"].write_debug_out(
|
||||
"unixDriver watch_dog: Error decoding/queuing data: "
|
||||
+ str(e),
|
||||
debug.DebugLevel.ERROR,
|
||||
)
|
||||
self._handle_client(client_sock, event_queue)
|
||||
finally:
|
||||
# Always close client socket, even if data processing fails
|
||||
try:
|
||||
@@ -106,8 +202,8 @@ class driver(remoteDriver):
|
||||
+ str(e),
|
||||
debug.DebugLevel.ERROR,
|
||||
)
|
||||
if self.fenrirSock:
|
||||
self.fenrirSock.close()
|
||||
self.fenrirSock = None
|
||||
if os.path.exists(socket_file):
|
||||
os.unlink(socket_file)
|
||||
self._cleanup()
|
||||
|
||||
def shutdown(self):
|
||||
self._cleanup()
|
||||
remoteDriver.shutdown(self)
|
||||
|
||||
Reference in New Issue
Block a user