506 lines
21 KiB
Python
506 lines
21 KiB
Python
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
|
|
# Fenrir TTY screen reader
|
|
# By Chrys, Storm Dragon, and contributers.
|
|
# attrib:
|
|
# http://rampex.ihep.su/Linux/linux_howto/html/tutorials/mini/Colour-ls-6.html
|
|
# 0 = black, 1 = blue, 2 = green, 3 = cyan, 4 = red, 5 = purple, 6 = brown/yellow, 7 = white.
|
|
# https://github.com/jwilk/vcsapeek/blob/master/linuxvt.py
|
|
# blink = 5 if attr & 1 else 0
|
|
# bold = 1 if attr & 16 else 0
|
|
|
|
import subprocess
|
|
import glob
|
|
import os
|
|
import termios
|
|
import time
|
|
import select
|
|
import dbus
|
|
import fcntl
|
|
from array import array
|
|
from fcntl import ioctl
|
|
from struct import unpack_from, unpack, pack
|
|
from fenrirscreenreader.core import debug
|
|
from fenrirscreenreader.core.eventData import fenrirEventType
|
|
from fenrirscreenreader.core.screenDriver import screenDriver
|
|
from fenrirscreenreader.utils import screen_utils
|
|
|
|
|
|
class driver(screenDriver):
|
|
def __init__(self):
|
|
screenDriver.__init__(self)
|
|
self.ListSessions = None
|
|
self.sysBus = None
|
|
self.charmap = {}
|
|
self.bgColorValues = {
|
|
0: 'black',
|
|
1: 'blue',
|
|
2: 'green',
|
|
3: 'cyan',
|
|
4: 'red',
|
|
5: 'magenta',
|
|
6: 'brown/yellow',
|
|
7: 'white'}
|
|
self.fgColorValues = {
|
|
0: 'black',
|
|
1: 'blue',
|
|
2: 'green',
|
|
3: 'cyan',
|
|
4: 'red',
|
|
5: 'magenta',
|
|
6: 'brown/yellow',
|
|
7: 'light gray',
|
|
8: 'dark gray',
|
|
9: 'light blue',
|
|
10: 'light green',
|
|
11: 'light cyan',
|
|
12: 'light red',
|
|
13: 'light magenta',
|
|
14: 'light yellow',
|
|
15: 'white'}
|
|
self.hichar = None
|
|
try:
|
|
# set workaround for paste clipboard -> injectTextToScreen
|
|
subprocess.run(['sysctl', 'dev.tty.legacy_tiocsti=1'],
|
|
check=False, capture_output=True, timeout=5)
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver shutdown: Error running fgconsole: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
|
|
def initialize(self, environment):
|
|
self.env = environment
|
|
self.env['runtime']['attributeManager'].appendDefaultAttributes([
|
|
self.fgColorValues[7], # fg
|
|
self.bgColorValues[0], # bg
|
|
False, # bold
|
|
False, # italics
|
|
False, # underscore
|
|
False, # strikethrough
|
|
False, # reverse
|
|
False, # blink
|
|
'default', # fontsize
|
|
'default' # fontfamily
|
|
]) # end attribute )
|
|
self.env['runtime']['processManager'].addCustomEventThread(
|
|
self.updateWatchdog, multiprocess=True)
|
|
|
|
def getCurrScreen(self):
|
|
self.env['screen']['oldTTY'] = self.env['screen']['newTTY']
|
|
try:
|
|
with open('/sys/devices/virtual/tty/tty0/active', 'r') as currScreenFile:
|
|
self.env['screen']['newTTY'] = str(currScreenFile.read()[3:-1])
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
str(e), debug.debugLevel.ERROR)
|
|
|
|
def injectTextToScreen(self, text, screen=None):
|
|
useScreen = "/dev/tty" + self.env['screen']['newTTY']
|
|
if screen is not None:
|
|
useScreen = screen
|
|
with open(useScreen, 'w') as fd:
|
|
for c in text:
|
|
fcntl.ioctl(fd, termios.TIOCSTI, c)
|
|
|
|
def getSessionInformation(self):
|
|
self.env['screen']['autoIgnoreScreens'] = []
|
|
try:
|
|
if not self.sysBus:
|
|
self.sysBus = dbus.SystemBus()
|
|
obj = self.sysBus.get_object(
|
|
'org.freedesktop.login1', '/org/freedesktop/login1')
|
|
inf = dbus.Interface(obj, 'org.freedesktop.login1.Manager')
|
|
self.ListSessions = inf.get_dbus_method('ListSessions')
|
|
sessions = self.ListSessions()
|
|
|
|
for session in sessions:
|
|
obj = self.sysBus.get_object(
|
|
'org.freedesktop.login1', session[4])
|
|
inf = dbus.Interface(obj, 'org.freedesktop.DBus.Properties')
|
|
sessionType = inf.Get('org.freedesktop.login1.Session', 'Type')
|
|
screen = str(inf.Get('org.freedesktop.login1.Session', 'VTNr'))
|
|
if screen == '':
|
|
screen = str(
|
|
inf.Get(
|
|
'org.freedesktop.login1.Session',
|
|
'TTY'))
|
|
screen = screen[screen.upper().find('TTY') + 3:]
|
|
if screen == '':
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'No TTY found for session:' + session[4], debug.debugLevel.ERROR)
|
|
return
|
|
if sessionType.upper() != 'TTY':
|
|
self.env['screen']['autoIgnoreScreens'] += [screen]
|
|
if screen == self.env['screen']['newTTY']:
|
|
if self.env['general']['currUser'] != session[2]:
|
|
self.env['general']['prevUser'] = self.env['general']['currUser']
|
|
self.env['general']['currUser'] = session[2]
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'getSessionInformation: Maybe no LoginD:' + str(e), debug.debugLevel.ERROR)
|
|
# self.env['runtime']['debug'].writeDebugOut('getSessionInformation:' + str(self.env['screen']['autoIgnoreScreens']) + ' ' + str(self.env['general']) ,debug.debugLevel.INFO)
|
|
|
|
def readFile(self, file):
|
|
d = b''
|
|
file.seek(0)
|
|
try:
|
|
d = file.read()
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver getScreenText: Error reading file: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
file.seek(0)
|
|
while True:
|
|
# Read from file
|
|
try:
|
|
d += file.readline(1)
|
|
if not d:
|
|
break
|
|
except Exception as e:
|
|
break
|
|
return d
|
|
|
|
def updateWatchdog(self, active, eventQueue):
|
|
vcsa = {}
|
|
vcsu = {}
|
|
tty = None
|
|
watchdog = None
|
|
try:
|
|
useVCSU = os.access('/dev/vcsu', os.R_OK)
|
|
vcsaDevices = glob.glob('/dev/vcsa*')
|
|
vcsuDevices = None
|
|
lastScreenContent = b''
|
|
|
|
# Open TTY file with proper cleanup
|
|
tty = open('/sys/devices/virtual/tty/tty0/active', 'r')
|
|
currScreen = str(tty.read()[3:-1])
|
|
oldScreen = currScreen
|
|
|
|
# Open VCSA devices with proper cleanup tracking
|
|
for vcsaDev in vcsaDevices:
|
|
index = str(vcsaDev[9:])
|
|
vcsa[index] = open(vcsaDev, 'rb')
|
|
if index == currScreen:
|
|
lastScreenContent = self.readFile(vcsa[index])
|
|
|
|
# Open VCSU devices if available
|
|
if useVCSU:
|
|
vcsuDevices = glob.glob('/dev/vcsu*')
|
|
for vcsuDev in vcsuDevices:
|
|
index = str(vcsuDev[9:])
|
|
vcsu[index] = open(vcsuDev, 'rb')
|
|
|
|
self.updateCharMap(currScreen)
|
|
watchdog = select.epoll()
|
|
watchdog.register(
|
|
vcsa[currScreen],
|
|
select.POLLPRI | select.POLLERR)
|
|
watchdog.register(tty, select.POLLPRI | select.POLLERR)
|
|
while active.value:
|
|
changes = watchdog.poll(1)
|
|
for change in changes:
|
|
fileno = change[0]
|
|
event = change[1]
|
|
if fileno == tty.fileno():
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'ScreenChange', debug.debugLevel.INFO)
|
|
tty.seek(0)
|
|
currScreen = str(tty.read()[3:-1])
|
|
if currScreen != oldScreen:
|
|
try:
|
|
watchdog.unregister(vcsa[oldScreen])
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver updateWatchdog: Error unregistering watchdog: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
try:
|
|
watchdog.register(
|
|
vcsa[currScreen], select.POLLPRI | select.POLLERR)
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver updateWatchdog: Error registering watchdog: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
self.updateCharMap(currScreen)
|
|
oldScreen = currScreen
|
|
try:
|
|
vcsa[currScreen].seek(0)
|
|
lastScreenContent = self.readFile(
|
|
vcsa[currScreen])
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver updateWatchdog: Error reading screen content: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
vcsuContent = None
|
|
if useVCSU:
|
|
vcsu[currScreen].seek(0)
|
|
vcsuContent = self.readFile(vcsu[currScreen])
|
|
eventQueue.put({"Type": fenrirEventType.ScreenChanged, "Data": self.createScreenEventData(
|
|
currScreen, lastScreenContent, vcsuContent)})
|
|
else:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'ScreenUpdate', debug.debugLevel.INFO)
|
|
vcsa[currScreen].seek(0)
|
|
time.sleep(0.01)
|
|
dirtyContent = self.readFile(vcsa[currScreen])
|
|
screenContent = dirtyContent
|
|
vcsuContent = None
|
|
timeout = time.time()
|
|
# error case
|
|
if screenContent == b'':
|
|
continue
|
|
if lastScreenContent == b'':
|
|
lastScreenContent = screenContent
|
|
if (abs(int(screenContent[2]) - int(lastScreenContent[2])) in [1, 2]) and (
|
|
int(screenContent[3]) == int(lastScreenContent[3])):
|
|
# Skip X Movement
|
|
pass
|
|
elif (abs(int(screenContent[3]) - int(lastScreenContent[3])) in [1]) and \
|
|
(int(screenContent[2]) == int(lastScreenContent[2])):
|
|
# Skip Y Movement
|
|
pass
|
|
else:
|
|
# anything else? wait for completion
|
|
while True:
|
|
screenContent = dirtyContent
|
|
time.sleep(0.02)
|
|
# r,_,_ = select.select([vcsa[currScreen]], [], [], 0.07)
|
|
# if not vcsa[currScreen] in r:
|
|
# break
|
|
vcsa[currScreen].seek(0)
|
|
dirtyContent = self.readFile(vcsa[currScreen])
|
|
if screenContent == dirtyContent:
|
|
break
|
|
if time.time() - timeout >= 0.1:
|
|
screenContent = dirtyContent
|
|
break
|
|
if useVCSU:
|
|
vcsu[currScreen].seek(0)
|
|
vcsuContent = self.readFile(vcsu[currScreen])
|
|
lastScreenContent = screenContent
|
|
eventQueue.put({"Type": fenrirEventType.ScreenUpdate, "Data": self.createScreenEventData(
|
|
currScreen, screenContent, vcsuContent)})
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'VCSA:updateWatchdog:' + str(e), debug.debugLevel.ERROR)
|
|
time.sleep(0.2)
|
|
finally:
|
|
# Clean up all file handles
|
|
try:
|
|
if watchdog:
|
|
watchdog.close()
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver updateWatchdog: Error closing watchdog: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
try:
|
|
if tty:
|
|
tty.close()
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver shutdown: Error closing TTY: ' + str(e), debug.debugLevel.ERROR)
|
|
for handle in vcsa.values():
|
|
try:
|
|
handle.close()
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver shutdown: Error closing VCSA handle: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
for handle in vcsu.values():
|
|
try:
|
|
handle.close()
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver shutdown: Error closing VCSU handle: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
|
|
def createScreenEventData(self, screen, vcsaContent, vcsuContent=None):
|
|
eventData = {
|
|
'bytes': vcsaContent,
|
|
'lines': int(vcsaContent[0]),
|
|
'columns': int(vcsaContent[1]),
|
|
'textCursor':
|
|
{
|
|
'x': int(vcsaContent[2]),
|
|
'y': int(vcsaContent[3])
|
|
},
|
|
'screen': screen,
|
|
'screenUpdateTime': time.time(),
|
|
'text': '',
|
|
'attributes': [],
|
|
}
|
|
try:
|
|
eventData['text'], eventData['attributes'] = self.autoDecodeVCSA(
|
|
vcsaContent[4:], eventData['lines'], eventData['columns'])
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver createScreenEventData: Error decoding VCSA content: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
# VCSU seems to give b' ' instead of b'\x00\x00\x00' (tsp),
|
|
# deactivated until its fixed
|
|
if vcsuContent is not None:
|
|
try:
|
|
vcsuContentAsText = vcsuContent.decode('UTF-32')
|
|
eventData['text'] = screen_utils.insertNewlines(
|
|
vcsuContentAsText, eventData['columns'])
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver createScreenEventData: Error decoding VCSU content: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
return eventData.copy()
|
|
|
|
def updateCharMap(self, screen):
|
|
self.charmap = {}
|
|
try:
|
|
with open('/dev/tty' + screen, 'rb') as tty:
|
|
GIO_UNIMAP = 0x4B66
|
|
VT_GETHIFONTMASK = 0x560D
|
|
himask = array("H", (0,))
|
|
ioctl(tty, VT_GETHIFONTMASK, himask)
|
|
self.hichar, = unpack_from("@H", himask)
|
|
sz = 512
|
|
line = ''
|
|
while True:
|
|
try:
|
|
unipairs = array("H", [0] * (2 * sz))
|
|
unimapdesc = array(
|
|
"B", pack(
|
|
"@HP", sz, unipairs.buffer_info()[0]))
|
|
ioctl(tty.fileno(), GIO_UNIMAP, unimapdesc)
|
|
break
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'VCSA:updateCharMap:scaling up sz=' + str(sz) + ' ' + str(e),
|
|
debug.debugLevel.WARNING)
|
|
sz *= 2
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'VCSA:updateCharMap:' + str(e), debug.debugLevel.ERROR)
|
|
return
|
|
ncodes, = unpack_from("@H", unimapdesc)
|
|
utable = unpack_from("@%dH" % (2 * ncodes), unipairs)
|
|
for u, b in zip(utable[::2], utable[1::2]):
|
|
if self.charmap.get(b) is None:
|
|
self.charmap[b] = chr(u)
|
|
|
|
def autoDecodeVCSA(self, allData, rows, cols):
|
|
allText = ''
|
|
allAttrib = []
|
|
i = 0
|
|
for y in range(rows):
|
|
lineText = ''
|
|
lineAttrib = []
|
|
blink = 0
|
|
bold = 0
|
|
ink = 7
|
|
paper = 0
|
|
for x in range(cols):
|
|
data = allData[i: i + 2]
|
|
i += 2
|
|
if data == b' \x07':
|
|
# attr = 7
|
|
# ink = 7
|
|
# paper = 0
|
|
# ch = ' '
|
|
charAttrib = [
|
|
self.fgColorValues[7], # fg
|
|
self.bgColorValues[0], # bg
|
|
False, # bold
|
|
False, # italics
|
|
False, # underscore
|
|
False, # strikethrough
|
|
False, # reverse
|
|
False, # blink
|
|
'default', # fontsize
|
|
'default'] # fontfamily
|
|
lineAttrib.append(charAttrib)
|
|
lineText += ' '
|
|
continue
|
|
ch = None
|
|
try:
|
|
(sh,) = unpack("=H", data)
|
|
attr = (sh >> 8) & 0xFF
|
|
ch = sh & 0xFF
|
|
try:
|
|
if sh & self.hichar:
|
|
ch |= 0x100
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver autoDecodeVCSA: Error processing character: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
ch = None
|
|
if self.hichar == 0x100:
|
|
attr >>= 1
|
|
ink = attr & 0x0F
|
|
paper = (attr >> 4) & 0x0F
|
|
if attr & 1:
|
|
blink = 1
|
|
# blink seems to be set always, ignore for now
|
|
blink = 0
|
|
bold = 0
|
|
if attr & 16:
|
|
bold = 1
|
|
# if (ink != 7) or (paper != 0):
|
|
# print(ink,paper)
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
'vcsaDriver autoDecodeVCSA: Error processing attributes: ' + str(e),
|
|
debug.debugLevel.ERROR)
|
|
try:
|
|
lineText += self.charmap[ch]
|
|
except KeyError:
|
|
lineText += '?'
|
|
|
|
charAttrib = [
|
|
self.fgColorValues[ink],
|
|
self.bgColorValues[paper],
|
|
bold == 1, # bold
|
|
False, # italics
|
|
False, # underscore
|
|
False, # strikethrough
|
|
False, # reverse
|
|
blink == 1, # blink
|
|
'default', # fontsize
|
|
'default'] # fontfamily
|
|
lineAttrib.append(charAttrib)
|
|
allText += lineText
|
|
if y + 1 < rows:
|
|
allText += '\n'
|
|
allAttrib.append(lineAttrib)
|
|
return str(allText), allAttrib
|
|
|
|
def getCurrApplication(self):
|
|
apps = []
|
|
try:
|
|
currScreen = self.env['screen']['newTTY']
|
|
apps = subprocess.Popen(
|
|
'ps -t tty' +
|
|
currScreen +
|
|
' -o comm,tty,stat',
|
|
shell=True,
|
|
stdout=subprocess.PIPE).stdout.read().decode()[
|
|
:-
|
|
1].split('\n')
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
str(e), debug.debugLevel.ERROR)
|
|
return
|
|
try:
|
|
for i in apps:
|
|
i = i.upper()
|
|
i = i.split()
|
|
i[0] = i[0]
|
|
i[1] = i[1]
|
|
if '+' in i[2]:
|
|
if i[0] != '':
|
|
if not "GREP" == i[0] and \
|
|
not "SH" == i[0] and \
|
|
not "PS" == i[0]:
|
|
if "TTY" + currScreen in i[1]:
|
|
if self.env['screen']['newApplication'] != i[0]:
|
|
self.env['screen']['newApplication'] = i[0]
|
|
return
|
|
except Exception as e:
|
|
self.env['runtime']['debug'].writeDebugOut(
|
|
str(e), debug.debugLevel.ERROR)
|