Files
YMS/ymsgui.py
T

362 lines
12 KiB
Python
Executable File

#!/usr/bin/python3
# SPDX-License-Identifier: WTFPL
"""
YMS native GUI.
Runs as user SYSTEM with id=0
Configuration file located at ~/.config/ymsgui.conf:
[DB]
host = localhost
db = yms
user = ymsgui
pass = topsecret
[Documents]
basepath = /var/local/lib/yms
scanner = off
[Data]
shapedir = /usr/local/share/yms/shapes
"""
import os
import sys
import locale
import gettext
import configparser
os.environ["NO_AT_BRIDGE"] = "1" # fix dbus warnings
import gi
gi.require_version("Gtk", "3.0")
gi.require_version('Rsvg', '2.0')
from gi.repository import GLib, Gtk, Gdk, Rsvg
from yms import database
from yms import gtkutils, combobox, treeview
from yms.model import user
from yms.model import vessel
from yms.lookup import Lookup, Table
from yms.view.base import BaseView
from yms.view.storage import StorageView
from yms.view.boxes import BoxesView
from yms.view.companies import CompaniesView
from yms.view.equipment import EquipmentView
from yms.view.inventory import InventoryView
from yms.view.provisions import ProvisionsView
from yms.view.maintenance import MaintenanceView
from yms.view.projects import ProjectsView
from yms.view.tasks import TasksView
from yms.view.measurement import MeasurementView
from yms.view.cables import CablesView
from yms.view.fuses import FusesView
from yms.view.documents import DocumentsView
from yms.view.status import StatusView
__author__ = "Thomas Hooge"
__copyright__ = "Copyright 2024-2026"
__version__ = "0.3"
__email__ = "thomas@hoogi.de"
__status__ = "Development"
class AppContext:
cfg = {
'cfgfile': '~/.config/ymsgui.conf',
'host': 'localhost',
'db': 'yms',
'user': 'yms',
'docpath': '/var/local/lib/yms',
'shapedir': '/usr/local/share/yms/shapes',
'scanner': False
}
# mapping between PHP and Python
# TODO week, month and quarter formats
datefmt_map = {
'Y-m-d': ('%Y-%m-%d', 'YYYY-MM-DD'), # ISO / international / technical
'd.m.Y': ('%d.%m.%Y', 'DD.MM.YYYY'), # Germany / Central & Northern Europe
'd/m/Y': ('%d/%m/%Y', 'DD/MM/YYYY'), # UK / France / Spain / Italy / Australia / NZ
'd-m-Y': ('%d-%m-%Y', 'DD-MM-YYYY'), # Netherlands / Denmark / Belgium
'd M Y': ('%d %b %Y', 'DD Mon YYYY'), # nautical documents / logbooks / unambiguous
'm.d.Y': ('%m.%d.%Y', 'MM.DD.YYYY'), # USA
'm/d/Y': ('%m/%d/%Y', 'MM/DD/YYYY'), # USA
'Y/m/d': ('%Y/%m/%d', 'YYYY/MM/DD') # Japan / China
}
# Publish / Subscribe event variants
EVENT_GENERIC = 0
EVENT_ADD = 1
EVENT_DEL = 2
EVENT_UPD = 3
def __init__(self):
self.__version__ = __version__
self.db = None
self.user = None
self.vessel = None
self.ui_path = os.path.join(self.get_sharepath(), "yms", "ui")
self.textdomain = "ymsgui" # static here for early initialization
self.localedir = "locale"
self.datefmt = 'Y-m-d' # key into map
self.scan_enabled = False
# system settings stored in database
self.curr_sym = '€'
self.img_max_width = 1024
self.img_max_height = 768
# event system
self.callbacks = {}
def set_db(self, db):
self.db = db
self.lookup = Lookup(db)
def load(self):
self.user = user.User(db, 0)
self.vessel = vessel.Vessel(db)
# load date format from db settings
sql = "SELECT valstr FROM settings WHERE userid=0 AND sno=2"
self.db.cur.execute(sql)
row = self.db.cur.fetchone()
if row and row[0]:
self.datefmt = row[0]
else:
print("No dateformat setting found")
self.lookup.load()
self.init_scanner()
def subscribe(self, event, callback):
self.callbacks.setdefault(event, []).append(callback)
def publish(self, event, eventtype, data=None):
for callback in self.callbacks.get(event, []):
callback(eventtype, data)
def init_scanner(self):
self.scan_enabled = False
if not self.cfg['scanner']:
return
try:
import sane
except ImportError:
print("Module python3-sane not found. Scanning disabled!")
return
print("Initializing sane document scanning...")
try:
version = sane.init()
print(f"Found sane version {version[1]}.{version[2]}.{version[3]}")
except sane._sane.error as e:
print("Error initializing sane")
return
devices = sane.get_devices(localOnly=True) # this will take a while
if not devices:
return
# TODO cameras may be also detected
for dev in devices:
print(f"Found scanner {dev[2]}")
self.scan_enabled = True
print("Done.")
def get_sharepath(self):
path = os.path.realpath(__file__)
if path.startswith("/usr/local/"):
return "/usr/local/share"
if path.startswith("/usr/"):
return "/usr/share"
return ""
def get_datefmt(self):
# TODO take precision into account
# day, week, month, quarter
return self.datefmt_map[self.datefmt][0]
def get_datefmt_placeholder(self):
return self.datefmt_map[self.datefmt][1]
class Frontend:
def __init__(self, context):
self.initializing = True
self.context = context
self.db = context.db
css = Gtk.CssProvider()
css.load_from_path("yms/style.css")
Gtk.StyleContext.add_provider_for_screen(
Gdk.Screen.get_default(),
css,
Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION
)
builder = Gtk.Builder()
builder.set_translation_domain(context.textdomain)
ui_path = os.path.join(context.ui_path)
builder.add_from_file(os.path.join(ui_path, "main.ui"))
builder.connect_signals(self)
self.window = builder.get_object("wnd_main")
self.notebook = builder.get_object("ntb_modules")
self.modules = {
"base": BaseView(context),
"storage": StorageView(context),
"box": BoxesView(context),
"companies": CompaniesView(context),
"equipment": EquipmentView(context),
"inventory": InventoryView(context),
"provisions": ProvisionsView(context),
"measurement": MeasurementView(context),
"cables": CablesView(context),
"fuses": FusesView(context),
"maintenance": MaintenanceView(context),
"projects": ProjectsView(context),
"tasks": TasksView(context),
"documents": DocumentsView(context),
"status": StatusView(context)
}
self.moduleindex = {}
for module in self.modules.values():
pageno = self.notebook.append_page(module.topwidget, Gtk.Label(label=module._title))
self.moduleindex[pageno] = module
self.db_poll_ts = context.db.get_timestamp()
GLib.timeout_add_seconds(30, self.db_change_poller)
self.initializing = False
def run(self):
self.window.show_all()
Gtk.main()
# cleanup code for all modules
for module in self.modules.values():
method = getattr(module, "record_unlock", None)
if callable(method):
# remove all pending record locks
method()
def db_change_poller(self):
# dynamic combobox data refresh
# look for dropdown entries newer than last check
sql = "SELECT revid FROM revision WHERE revtype='dropdown' AND changed>%s"
self.db.cur.execute(sql, (self.db_poll_ts,))
for row in self.db.cur.fetchall():
print(f"refresh dropdown list no.{row[0]}")
self.lookup.reload_dropdown(row[0])
# look for table list entries newer than last check
sql = "SELECT revid FROM revision WHERE revtype='table' AND changed>%s"
self.db.cur.execute(sql, (self.db_poll_ts,))
for row in self.db.cur.fetchall():
print(f"refresh table based list #{row[0]}")
# TODO get module name for changes in table
modulemap = {
#Table.VESSEL: "base",
#Table.USERS: "base",
Table.COMPANIES: "companies",
Table.STORAGE: "storage",
Table.BOXES: "box",
Table.EQUIPMENT: "equipment",
##Table.INVENTORY: "inventory"
Table.PROJECTS: "projects",
Table.CABLES: "cables",
Table.FUSES: "fuses",
Table.TAGS: "tags"
}
# execute method from module
if row[0] in modulemap:
self.modules[modulemap[row[0]]].load_list()
self.db_poll_ts = self.db.get_timestamp()
return True
def on_ntb_modules_switch_page(self, notebook, page, page_num):
# signal handler: call view method for e.g. list refresh
if self.initializing:
return
callback = getattr(self.moduleindex[page_num], "on_page_activated", None)
if callable(callback):
callback()
def on_destroy(self, widget, data=None):
Gtk.main_quit()
def create_config(cfg, cfgfile):
# create inital config file
with open(cfgfile, 'w') as fh:
fh.write('[DB]\n')
fh.write('host = {}\n'.format(cfg['host']))
fh.write('db = {}\n'.format(cfg['db']))
fh.write('user = {}\n'.format(cfg['user']))
fh.write('pass = changeme!\n\n')
fh.write('[Documents]\n')
fh.write('basepath = {}\n'.format(cfg['docpath']))
fh.write('scanner = {}\n\n'.format(cfg['scanner']))
fh.write('[Data]\n')
fh.write('shapedir = {}\n'.format(cfg['shapedir']))
# secure configuration
os.chmod(cfgfile, 0o600)
if __name__ == "__main__":
context = AppContext()
locale.setlocale(locale.LC_ALL, '')
gettext.bindtextdomain(context.textdomain, context.localedir)
gettext.textdomain(context.textdomain)
gettext.install(context.textdomain, context.localedir)
config = configparser.ConfigParser()
cfgfile = os.path.expanduser(context.cfg['cfgfile'])
if not config.read(cfgfile):
create_config(context.cfg, cfgfile)
gtkutils.messagebox(
_("Configuration file '{}' not found.\n"
"Default configuration has been created.\n"
"Please edit that file according to your needs.\n\n"
"Then restart this program."
).format(cfgfile), title="YMS")
else:
context.cfg['host'] = config.get('DB', 'host')
context.cfg['db'] = config.get('DB', 'db')
db = database.Database(context.cfg['host'], context.cfg['db'])
context.set_db(db)
connected = False
if context.cfg['host'] == 'socket':
connected = db.connect_local()
else:
context.cfg['user'] = config.get('DB', 'user')
context.cfg['pass'] = config.get('DB', 'pass')
connected = db.connect(context.cfg['user'], context.cfg['pass'])
if connected:
# TODO check database schema version
schema_required = 1
context.load()
context.cfg['docpath'] = config.get('Documents', 'basepath')
context.cfg['scanner'] = config.getboolean('Documents', 'scanner')
context.cfg['shapedir'] = config.get('Data', 'shapedir')
if not os.path.isdir(context.cfg['shapedir']):
gtkutils.messagebox(
_("Directory with deck plan files not found.\n\n"
"Please check your configuration file!"),
title="YMS")
sys.exit(1)
# everything seems to be fine: continue to start frontend
app = Frontend(context)
app.run()
context.db.disconnect()
else:
errno, errtxt = context.db.last_error()
gtkutils.messagebox(
_("Database connection cannot be established.\n\n"
"Server: %(host)s\nDatabase: %(db)s\n"
"Error: %(errtxt)s (%(errno)d)") % {
'host': context.cfg['host'],
'db': context.cfg['db'],
'errtxt': errtxt,
'errno': errno
},
title="YMS")
# Another fine product of the sirius cybernetics corporation