Module Gnumed.business.gmForms
GNUmed forms classes
Business layer for printing all manners of forms, letters, scripts etc.
license: GPL v2 or later
Expand source code
# -*- coding: utf-8 -*-
"""GNUmed forms classes
Business layer for printing all manners of forms, letters, scripts etc.
license: GPL v2 or later
"""
#============================================================
__author__ ="Ian Haywood <ihaywood@gnu.org>, karsten.hilbert@gmx.net"
import os
import sys
import time
import os.path
import logging
import re as regex
import shutil
import random
import platform
import subprocess
import io
import codecs
#, libxml2, libxslt
if __name__ == '__main__':
sys.path.insert(0, '../../')
_ = lambda x:x # make pyflakes happy
from Gnumed.pycommon import gmI18N
gmI18N.activate_locale()
gmI18N.install_domain(domain = 'gnumed')
from Gnumed.pycommon import gmTools
from Gnumed.pycommon import gmDispatcher
from Gnumed.pycommon import gmExceptions
from Gnumed.pycommon import gmMatchProvider
from Gnumed.pycommon import gmBorg
from Gnumed.pycommon import gmLog2
from Gnumed.pycommon import gmMimeLib
from Gnumed.pycommon import gmShellAPI
from Gnumed.pycommon import gmCfgDB
from Gnumed.pycommon import gmCfgINI
from Gnumed.pycommon import gmBusinessDBObject
from Gnumed.pycommon import gmPG2
from Gnumed.pycommon import gmDateTime
from Gnumed.business import gmPerson
from Gnumed.business import gmStaff
from Gnumed.business import gmPersonSearch
from Gnumed.business import gmPraxis
_log = logging.getLogger('gm.forms')
_cfg = gmCfgINI.gmCfgData()
#============================================================
# this order is also used in choice boxes for the engine
form_engine_abbrevs = ['O', 'L', 'I', 'G', 'P', 'A', 'X', 'T']
form_engine_names = {
'O': 'OpenOffice',
'L': 'LaTeX',
'I': 'Image editor',
'G': 'Gnuplot script',
'P': 'PDF forms',
'A': 'AbiWord',
'X': 'Xe(La)TeX',
'T': 'text export'
}
form_engine_template_wildcards = {
'O': '*.o?t',
'L': '*.tex',
'G': '*.gpl',
'P': '*.pdf',
'A': '*.abw',
'X': '*.tex',
'T': '*.ini'
}
# is filled in further below after each engine is defined
form_engines:dict = {}
#============================================================
# match providers
#============================================================
class cFormTemplateNameLong_MatchProvider(gmMatchProvider.cMatchProvider_SQL2):
def __init__(self):
query = """
SELECT
name_long AS data,
name_long AS list_label,
name_long AS field_label
FROM ref.v_paperwork_templates
WHERE name_long %(fragment_condition)s
ORDER BY list_label
"""
gmMatchProvider.cMatchProvider_SQL2.__init__(self, queries = [query])
#============================================================
class cFormTemplateNameShort_MatchProvider(gmMatchProvider.cMatchProvider_SQL2):
def __init__(self):
query = """
SELECT
name_short AS data,
name_short AS list_label,
name_short AS field_label
FROM ref.v_paperwork_templates
WHERE name_short %(fragment_condition)s
ORDER BY name_short
"""
gmMatchProvider.cMatchProvider_SQL2.__init__(self, queries = [query])
#============================================================
class cFormTemplateType_MatchProvider(gmMatchProvider.cMatchProvider_SQL2):
def __init__(self):
query = """
SELECT DISTINCT ON (list_label)
pk AS data,
_(name) || ' (' || name || ')' AS list_label,
_(name) AS field_label
FROM ref.form_types
WHERE
_(name) %(fragment_condition)s
OR
name %(fragment_condition)s
ORDER BY list_label
"""
gmMatchProvider.cMatchProvider_SQL2.__init__(self, queries = [query])
#============================================================
class cFormTemplate(gmBusinessDBObject.cBusinessDBObject):
"""Represents a template from which forms/printouts can be generated.
To create a processable document from a template call
.instantiate() and do further processing on the resulting
form instance.
"""
_cmd_fetch_payload = 'SELECT * FROM ref.v_paperwork_templates WHERE pk_paperwork_template = %s'
_cmds_store_payload = [
"""UPDATE ref.paperwork_templates SET
name_short = %(name_short)s,
name_long = %(name_long)s,
fk_template_type = %(pk_template_type)s,
instance_type = %(instance_type)s,
engine = %(engine)s,
in_use = %(in_use)s,
edit_after_substitution = %(edit_after_substitution)s,
filename = %(filename)s,
external_version = %(external_version)s
WHERE
pk = %(pk_paperwork_template)s
AND
xmin = %(xmin_paperwork_template)s
RETURNING
xmin AS xmin_paperwork_template
"""
]
_updatable_fields = [
'name_short',
'name_long',
'external_version',
'pk_template_type',
'instance_type',
'engine',
'in_use',
'filename',
'edit_after_substitution'
]
_suffix4engine = {
'O': '.ott',
'L': '.tex',
'T': '.txt',
'X': '.xslt',
'I': '.img',
'P': '.pdf',
'G': '.gpl'
}
#--------------------------------------------------------
def _get_template_data(self):
"""Return the data that makes up the actual template itself.
This is typically a text string containing markup
specific to a given document definition interspersed
with placeholders to be processed by GNUmed.
Note that the template may often not (yet) be valid for
the target document engine because it usually
contains placeholders interspersed with the layout
definition.
"""
cmd = 'SELECT data FROM ref.paperwork_templates WHERE pk = %(pk)s'
rows, idx = gmPG2.run_ro_queries (queries = [{'cmd': cmd, 'args': {'pk': self.pk_obj}}], get_col_idx = False)
if len(rows) == 0:
raise gmExceptions.NoSuchBusinessObjectError('cannot retrieve data for template pk = %s' % self.pk_obj)
return rows[0][0]
template_data = property(_get_template_data)
#--------------------------------------------------------
def save_to_file(self, filename:str=None, chunksize:int=0, use_sandbox:bool=False) -> str:
"""Export actual form template definition into a file.
Note that this file may often not (yet) be valid
for the target document engine because it usually
contains placeholders interspersed with the
layout definition.
Args:
filename: an explicit filename to save to, a suitable one is generated if None
use_sandbox: instantiate in a sandbox directory, unless a filename is given
Returns:
The name of the file that was saved into. None on failure.
"""
if not self._payload['has_template_data']:
_log.error('no template data')
return None
if filename is None:
if use_sandbox:
sandbox_dir = gmTools.mk_sandbox_dir(prefix = 'gm2%s-' % self._payload[self._idx['engine']])
else:
sandbox_dir = None
if self._payload[self._idx['filename']] is None:
suffix = self.__class__._suffix4engine[self._payload[self._idx['engine']]]
else:
suffix = os.path.splitext(self._payload[self._idx['filename']].strip())[1].strip()
if suffix in ['', '.']:
suffix = self.__class__._suffix4engine[self._payload[self._idx['engine']]]
filename = gmTools.get_unique_filename (
prefix = 'gm-%s-Template-' % self._payload[self._idx['engine']],
suffix = suffix,
tmp_dir = sandbox_dir
)
data_query = {
'cmd': 'SELECT substring(data from %(start)s for %(size)s) FROM ref.paperwork_templates WHERE pk = %(pk)s',
'args': {'pk': self.pk_obj}
}
data_size_query = {
'cmd': 'select octet_length(data) from ref.paperwork_templates where pk = %(pk)s',
'args': {'pk': self.pk_obj}
}
result = gmPG2.bytea2file (
data_query = data_query,
filename = filename,
data_size_query = data_size_query,
chunk_size = chunksize
)
if result is False:
return None
return filename
#--------------------------------------------------------
def update_template_from_file(self, filename:str=None):
"""Update the template definition in the database.
Args:
filename: the filename to read the template definition from
"""
gmPG2.file2bytea (
filename = filename,
query = 'update ref.paperwork_templates set data = %(data)s::bytea where pk = %(pk)s and xmin = %(xmin)s',
args = {'pk': self.pk_obj, 'xmin': self._payload[self._idx['xmin_paperwork_template']]}
)
# adjust for xmin change
return self.refetch_payload()
#--------------------------------------------------------
def instantiate(self, use_sandbox:bool=False):
"""Create an instance of this form template for further processing.
This saves the template data to a file, and from
that creates a form instances, specific to the
text processing engine defined for this template.
Invoke methods of the form instance for further
processing (placeholder substitution, PDF
generation, ...)
Args:
use_sandbox: instantiate in a sandbox directory
Returns:
A form instance or None on failure.
"""
fname = self.save_to_file(use_sandbox = use_sandbox)
if not fname:
return None
engine = form_engines[self._payload[self._idx['engine']]]
form = engine(template_file = fname)
form.template = self
return form
#============================================================
def get_form_template(name_long:str=None, external_version:str=None):
"""Load a form template from the backend based on name and version."""
cmd = 'select pk from ref.paperwork_templates where name_long = %(lname)s and external_version = %(ver)s'
args = {'lname': name_long, 'ver': external_version}
rows, idx = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': args}], get_col_idx = False)
if len(rows) == 0:
_log.error('cannot load form template [%s - %s]', name_long, external_version)
return None
return cFormTemplate(aPK_obj = rows[0]['pk'])
#------------------------------------------------------------
def get_form_templates(engine=None, active_only=False, template_types=None, excluded_types=None, return_pks=False):
"""Load form templates."""
args = {'eng': engine, 'in_use': active_only}
where_parts = ['1 = 1']
if engine is not None:
where_parts.append('engine = %(eng)s')
if active_only:
where_parts.append('in_use IS true')
if template_types is not None:
args['incl_types'] = template_types
where_parts.append('template_type = ANY(%(incl_types)s)')
if excluded_types is not None:
args['excl_types'] = excluded_types
where_parts.append('template_type <> ALL(%(excl_types)s)')
cmd = "SELECT * FROM ref.v_paperwork_templates WHERE %s ORDER BY in_use desc, name_long" % '\nAND '.join(where_parts)
rows, idx = gmPG2.run_ro_queries (
queries = [{'cmd': cmd, 'args': args}],
get_col_idx = True
)
if return_pks:
return [ r['pk_paperwork_template'] for r in rows ]
templates = [ cFormTemplate(row = {'pk_field': 'pk_paperwork_template', 'data': r, 'idx': idx}) for r in rows ]
return templates
#------------------------------------------------------------
def create_form_template(template_type=None, name_short=None, name_long=None):
cmd = """
INSERT INTO ref.paperwork_templates (
fk_template_type,
name_short,
name_long,
external_version
) VALUES (
%(type)s,
%(nshort)s,
%(nlong)s,
%(ext_version)s
)
RETURNING pk
"""
args = {'type': template_type, 'nshort': name_short, 'nlong': name_long, 'ext_version': 'new'}
rows, idx = gmPG2.run_rw_queries(queries = [{'cmd': cmd, 'args': args}], return_data = True)
template = cFormTemplate(aPK_obj = rows[0][0])
return template
#------------------------------------------------------------
def delete_form_template(template=None):
rows, idx = gmPG2.run_rw_queries (
queries = [{
'cmd': 'DELETE FROM ref.paperwork_templates WHERE pk = %(pk)s',
'args': {'pk': template['pk_paperwork_template']}
}]
)
return True
#============================================================
# OpenOffice/LibreOffice API
#============================================================
uno = None
cOOoDocumentCloseListener = None
writer_binary = None
# http://forum.openoffice.org/en/forum/viewtopic.php?t=36370
# http://stackoverflow.com/questions/4270962/using-pyuno-with-my-existing-python-installation
#-----------------------------------------------------------
def __configure_path_to_UNO():
try:
which = subprocess.Popen (
args = ('which', 'soffice'),
stdout = subprocess.PIPE,
stdin = subprocess.PIPE,
stderr = subprocess.PIPE,
universal_newlines = True
)
except (OSError, ValueError, subprocess.CalledProcessError):
_log.exception('there was a problem executing [which soffice]')
return
soffice_path, err = which.communicate()
soffice_path = soffice_path.strip('\n')
uno_path = os.path.abspath ( os.path.join (
os.path.dirname(os.path.realpath(soffice_path)),
'..',
'basis-link',
'program'
))
_log.info('UNO should be at [%s], appending to sys.path', uno_path)
sys.path.append(uno_path)
#-----------------------------------------------------------
def init_ooo():
"""FIXME: consider this:
try:
import uno
except Exception:
print("This Script needs to be run with the python from OpenOffice.org")
print ("Example: /opt/OpenOffice.org/program/python %s" % (
os.path.basename(sys.argv[0])))
print("Or you need to insert the right path at the top, where uno.py is.")
print("Default: %s" % default_path)
"""
global uno
if uno is not None:
return
try:
import uno
except ImportError:
__configure_path_to_UNO()
import uno
global unohelper, oooXCloseListener, oooNoConnectException, oooPropertyValue
import unohelper
from com.sun.star.util import XCloseListener as oooXCloseListener
from com.sun.star.connection import NoConnectException as oooNoConnectException
from com.sun.star.beans import PropertyValue as oooPropertyValue
#----------------------------------
class _cOOoDocumentCloseListener(unohelper.Base, oooXCloseListener):
"""Listens for events sent by OOo during the document closing
sequence and notifies the GNUmed client GUI so it can
import the closed document into the database.
"""
def __init__(self, document=None):
self.document = document
def queryClosing(self, evt, owner):
# owner is True/False whether I am the owner of the doc
pass
def notifyClosing(self, evt):
pass
def disposing(self, evt):
self.document.on_disposed_by_ooo()
self.document = None
#----------------------------------
global cOOoDocumentCloseListener
cOOoDocumentCloseListener = _cOOoDocumentCloseListener
# search for writer binary
global writer_binary
found, binary = gmShellAPI.find_first_binary(binaries = [
'lowriter',
'oowriter',
'swriter'
])
if found:
_log.debug('OOo/LO writer binary found: %s', binary)
writer_binary = binary
else:
_log.debug('OOo/LO writer binary NOT found')
raise ImportError('LibreOffice/OpenOffice (lowriter/oowriter/swriter) not found')
_log.debug('python UNO bridge successfully initialized')
#------------------------------------------------------------
class gmOOoConnector(gmBorg.cBorg):
"""This class handles the connection to OOo.
Its Singleton instance stays around once initialized.
"""
# FIXME: need to detect closure of OOo !
def __init__(self):
init_ooo()
self.__setup_connection_string()
self.resolver_uri = "com.sun.star.bridge.UnoUrlResolver"
self.desktop_uri = "com.sun.star.frame.Desktop"
self.max_connect_attempts = 5
self.local_context = uno.getComponentContext()
self.uri_resolver = self.local_context.ServiceManager.createInstanceWithContext(self.resolver_uri, self.local_context)
self.__desktop = None
#--------------------------------------------------------
# external API
#--------------------------------------------------------
def cleanup(self, force=True):
if self.__desktop is None:
_log.debug('no desktop, no cleanup')
return
try:
self.__desktop.terminate()
except Exception:
_log.exception('cannot terminate OOo desktop')
#--------------------------------------------------------
def open_document(self, filename=None):
"""<filename> must be absolute"""
if self.desktop is None:
_log.error('cannot access OOo desktop')
return None
filename = os.path.expanduser(filename)
filename = os.path.abspath(filename)
document_uri = uno.systemPathToFileUrl(filename)
_log.debug('%s -> %s', filename, document_uri)
doc = self.desktop.loadComponentFromURL(document_uri, "_blank", 0, ())
return doc
#--------------------------------------------------------
# internal helpers
#--------------------------------------------------------
def __get_startup_settle_time(self):
# later factor this out !
self.ooo_startup_settle_time = gmCfgDB.get4workplace (
option = 'external.ooo.startup_settle_time',
workplace = gmPraxis.gmCurrentPraxisBranch().active_workplace,
default = 3.0
)
#--------------------------------------------------------
def __setup_connection_string(self):
# socket:
# ooo_port = u'2002'
# #self.ooo_start_cmd = 'oowriter -invisible -norestore -nofirststartwizard -nologo -accept="socket,host=localhost,port=%s;urp;StarOffice.ServiceManager"' % ooo_port
# self.ooo_start_cmd = 'oowriter -invisible -norestore -accept="socket,host=localhost,port=%s;urp;"' % ooo_port
# self.remote_context_uri = "uno:socket,host=localhost,port=%s;urp;StarOffice.ComponentContext" % ooo_port
# pipe:
pipe_name = "uno-gm2lo-%s" % str(random.random())[2:]
_log.debug('expecting OOo/LO server on named pipe [%s]', pipe_name)
self.ooo_start_cmd = '%s --invisible --norestore --accept="pipe,name=%s;urp" &' % (
writer_binary,
pipe_name
)
_log.debug('startup command: %s', self.ooo_start_cmd)
self.remote_context_uri = "uno:pipe,name=%s;urp;StarOffice.ComponentContext" % pipe_name
_log.debug('remote context URI: %s', self.remote_context_uri)
#--------------------------------------------------------
def __startup_ooo(self):
_log.info('trying to start OOo server')
_log.debug('startup command: %s', self.ooo_start_cmd)
os.system(self.ooo_start_cmd)
self.__get_startup_settle_time()
_log.debug('waiting %s seconds for OOo to start up', self.ooo_startup_settle_time)
time.sleep(int(self.ooo_startup_settle_time))
#--------------------------------------------------------
# properties
#--------------------------------------------------------
def _get_desktop(self):
if self.__desktop is not None:
return self.__desktop
self.remote_context = None
attempts = self.max_connect_attempts
while attempts > 0:
_log.debug('attempt %s/%s', self.max_connect_attempts - attempts + 1, self.max_connect_attempts)
try:
self.remote_context = self.uri_resolver.resolve(self.remote_context_uri)
break
except oooNoConnectException:
_log.exception('cannot connect to OOo')
# first loop ?
if attempts == self.max_connect_attempts:
self.__startup_ooo()
else:
time.sleep(1)
attempts = attempts - 1
if self.remote_context is None:
raise OSError(-1, 'cannot connect to OpenOffice', self.remote_context_uri)
_log.debug('connection seems established')
self.__desktop = self.remote_context.ServiceManager.createInstanceWithContext(self.desktop_uri, self.remote_context)
_log.debug('got OOo desktop handle')
return self.__desktop
desktop = property(_get_desktop)
#------------------------------------------------------------
class cOOoLetter(object):
def __init__(self, template_file=None, instance_type=None):
self.template_file = template_file
self.instance_type = instance_type
self.ooo_doc = None
#--------------------------------------------------------
# external API
#--------------------------------------------------------
def open_in_ooo(self):
# connect to OOo
ooo_srv = gmOOoConnector()
# open doc in OOo
self.ooo_doc = ooo_srv.open_document(filename = self.template_file)
if self.ooo_doc is None:
_log.error('cannot open document in OOo')
return False
# listen for close events
pat = gmPerson.gmCurrentPatient()
pat.locked = True
listener = cOOoDocumentCloseListener(document = self)
self.ooo_doc.addCloseListener(listener)
return True
#--------------------------------------------------------
def show(self, visible=True):
self.ooo_doc.CurrentController.Frame.ContainerWindow.setVisible(visible)
#--------------------------------------------------------
def replace_placeholders(self, handler=None, old_style_too = True):
# new style embedded, implicit placeholders
searcher = self.ooo_doc.createSearchDescriptor()
searcher.SearchCaseSensitive = False
searcher.SearchRegularExpression = True
searcher.SearchWords = True
searcher.SearchString = handler.placeholder_regex
placeholder_instance = self.ooo_doc.findFirst(searcher)
while placeholder_instance is not None:
try:
val = handler[placeholder_instance.String]
except Exception:
val = _('error with placeholder [%s]') % placeholder_instance.String
_log.exception(val)
if val is None:
val = _('error with placeholder [%s]') % placeholder_instance.String
placeholder_instance.String = val
placeholder_instance = self.ooo_doc.findNext(placeholder_instance.End, searcher)
if not old_style_too:
return
# old style "explicit" placeholders
text_fields = self.ooo_doc.getTextFields().createEnumeration()
while text_fields.hasMoreElements():
text_field = text_fields.nextElement()
# placeholder ?
if not text_field.supportsService('com.sun.star.text.TextField.JumpEdit'):
continue
# placeholder of type text ?
if text_field.PlaceHolderType != 0:
continue
replacement = handler[text_field.PlaceHolder]
if replacement is None:
continue
text_field.Anchor.setString(replacement)
#--------------------------------------------------------
def save_in_ooo(self, filename=None):
if filename is not None:
target_url = uno.systemPathToFileUrl(os.path.abspath(os.path.expanduser(filename)))
save_args = (
oooPropertyValue('Overwrite', 0, True, 0),
oooPropertyValue('FormatFilter', 0, 'swriter: StarOffice XML (Writer)', 0)
)
# "store AS url" stores the doc, marks it unmodified and updates
# the internal media descriptor - as opposed to "store TO url"
self.ooo_doc.storeAsURL(target_url, save_args)
else:
self.ooo_doc.store()
#--------------------------------------------------------
def close_in_ooo(self):
self.ooo_doc.dispose()
pat = gmPerson.gmCurrentPatient()
pat.locked = False
self.ooo_doc = None
#--------------------------------------------------------
def on_disposed_by_ooo(self):
# get current file name from OOo, user may have used Save As
filename = uno.fileUrlToSystemPath(self.ooo_doc.URL)
# tell UI to import the file
gmDispatcher.send (
signal = 'import_document_from_file',
filename = filename,
document_type = self.instance_type,
unlock_patient = True,
pk_org_unit = gmPraxis.gmCurrentPraxisBranch()['pk_org_unit']
)
self.ooo_doc = None
#--------------------------------------------------------
# internal helpers
#--------------------------------------------------------
#============================================================
class cFormEngine(object):
"""Ancestor for forms."""
def __init__(self, template_file=None):
self.template = None
self.template_filename = template_file
_log.debug('working on template file [%s]', self.template_filename)
#--------------------------------------------------------
def substitute_placeholders(self, data_source=None):
"""Parse the template into an instance and replace placeholders with values."""
raise NotImplementedError
#--------------------------------------------------------
def edit(self):
"""Allow editing the instance of the template."""
raise NotImplementedError
#--------------------------------------------------------
def generate_output(self, format=None):
"""Generate output suitable for further processing outside this class, e.g. printing."""
raise NotImplementedError
#--------------------------------------------------------
#--------------------------------------------------------
# def process(self, data_source=None):
# """Merge values into the form template.
# """
# pass
# #--------------------------------------------------------
# def cleanup(self):
# """
# A sop to TeX which can't act as a true filter: to delete temporary files
# """
# pass
# #--------------------------------------------------------
# def exe(self, command):
# """
# Executes the provided command.
# If command cotains %F. it is substituted with the filename
# Otherwise, the file is fed in on stdin
# """
# pass
# #--------------------------------------------------------
# def store(self, params=None):
# """Stores the parameters in the backend.
#
# - link_obj can be a cursor, a connection or a service name
# - assigning a cursor to link_obj allows the calling code to
# group the call to store() into an enclosing transaction
# (for an example see gmReferral.send_referral()...)
# """
# # some forms may not have values ...
# if params is None:
# params = {}
# patient_clinical = self.patient.emr
# encounter = patient_clinical.active_encounter['pk_encounter']
# # FIXME: get_active_episode is no more
# #episode = patient_clinical.get_active_episode()['pk_episode']
# # generate "forever unique" name
# cmd = "select name_short || ': <' || name_long || '::' || external_version || '>' from paperwork_templates where pk=%s";
# rows = gmPG.run_ro_query('reference', cmd, None, self.pk_def)
# form_name = None
# if rows is None:
# _log.error('error retrieving form def for [%s]' % self.pk_def)
# elif len(rows) == 0:
# _log.error('no form def for [%s]' % self.pk_def)
# else:
# form_name = rows[0][0]
# # we didn't get a name but want to store the form anyhow
# if form_name is None:
# form_name=time.time() # hopefully unique enough
# # in one transaction
# queries = []
# # - store form instance in form_instance
# cmd = "insert into form_instances(fk_form_def, form_name, fk_episode, fk_encounter) values (%s, %s, %s, %s)"
# queries.append((cmd, [self.pk_def, form_name, episode, encounter]))
# # - store params in form_data
# for key in params:
# cmd = """
# insert into form_data(fk_instance, place_holder, value)
# values ((select currval('form_instances_pk_seq')), %s, %s::text)
# """
# queries.append((cmd, [key, params[key]]))
# # - get inserted PK
# queries.append(("select currval ('form_instances_pk_seq')", []))
# status, err = gmPG.run_commit('historica', queries, True)
# if status is None:
# _log.error('failed to store form [%s] (%s): %s' % (self.pk_def, form_name, err))
# return None
# return status
#================================================================
# OOo template forms
#----------------------------------------------------------------
class cOOoForm(cFormEngine):
"""A forms engine wrapping OOo."""
def __init__(self, template_file=None):
super().__init__(template_file = template_file)
path, ext = os.path.splitext(self.template_filename)
if ext in [r'', r'.']:
ext = r'.odt'
self.instance_filename = r'%s-instance%s' % (path, ext)
#================================================================
# AbiWord template forms
#----------------------------------------------------------------
class cAbiWordForm(cFormEngine):
"""A forms engine wrapping AbiWord."""
placeholder_regex = r'\$<.+?>\$'
def __init__(self, template_file=None):
super().__init__(template_file = template_file)
# detect abiword
found, self.abiword_binary = gmShellAPI.detect_external_binary(binary = r'abiword')
if not found:
raise ImportError('<abiword(.exe)> not found')
#--------------------------------------------------------
def substitute_placeholders(self, data_source=None):
# should *actually* properly parse the XML
path, ext = os.path.splitext(self.template_filename)
if ext in [r'', r'.']:
ext = r'.abw'
self.instance_filename = r'%s-instance%s' % (path, ext)
template_file = io.open(self.template_filename, mode = 'rt', encoding = 'utf-8-sig')
instance_file = io.open(self.instance_filename, mode = 'wt', encoding = 'utf8')
if self.template:
# pylint: disable=unsubscriptable-object
# inject placeholder values
data_source.set_placeholder('form_name_long', self.template['name_long'])
data_source.set_placeholder('form_name_short', self.template['name_short'])
data_source.set_placeholder('form_version', self.template['external_version'])
data_source.set_placeholder('form_version_internal', gmTools.coalesce(self.template['gnumed_revision'], '', '%s'))
data_source.set_placeholder('form_last_modified', gmDateTime.pydt_strftime(self.template['last_modified'], '%Y-%b-%d %H:%M'))
data_source.escape_style = 'xml'
data_source.escape_function = None # gmTools.xml_escape_text() ?
for line in template_file:
if line.strip() in ['', '\r', '\n', '\r\n']:
instance_file.write(line)
continue
# 1) find placeholders in this line
placeholders_in_line = regex.findall(cAbiWordForm.placeholder_regex, line, regex.IGNORECASE)
# 2) and replace them
for placeholder in placeholders_in_line:
try:
val = data_source[placeholder.replace('<', '<').replace('>', '>')]
except Exception:
val = _('error with placeholder [%s]') % gmTools.xml_escape_string(placeholder)
_log.exception(val)
if val is None:
val = _('error with placeholder [%s]') % gmTools.xml_escape_string(placeholder)
line = line.replace(placeholder, val)
instance_file.write(line)
instance_file.close()
template_file.close()
if self.template is not None:
# remove temporary placeholders
data_source.unset_placeholder('form_name_long')
data_source.unset_placeholder('form_name_short')
data_source.unset_placeholder('form_version')
data_source.unset_placeholder('form_version_internal')
data_source.unset_placeholder('form_last_modified')
return
#--------------------------------------------------------
def edit(self):
enc = sys.getfilesystemencoding()
cmd = (r'%s %s' % (self.abiword_binary, self.instance_filename.encode(enc))).encode(enc)
result = gmShellAPI.run_command_in_shell(command = cmd, blocking = True)
self.re_editable_filenames = [self.instance_filename]
return result
#--------------------------------------------------------
def generate_output(self, instance_file=None, format=None):
if instance_file is None:
instance_file = self.instance_filename
try:
open(instance_file, 'r').close()
except Exception:
_log.exception('cannot access form instance file [%s]', instance_file)
gmLog2.log_stack_trace()
return None
self.instance_filename = instance_file
_log.debug('ignoring <format> directive [%s], generating PDF', format)
pdf_name = os.path.splitext(self.instance_filename)[0] + '.pdf'
cmd = '%s --to=pdf --to-name=%s %s' % (
self.abiword_binary,
pdf_name,
self.instance_filename
)
if not gmShellAPI.run_command_in_shell(command = cmd, blocking = True):
_log.error('problem running abiword, cannot generate form output')
gmDispatcher.send(signal = 'statustext', msg = _('Error running AbiWord. Cannot generate PDF.'), beep = True)
return None
self.final_output_filenames = [pdf_name]
return pdf_name
#----------------------------------------------------------------
form_engines['A'] = cAbiWordForm
#================================================================
# text template forms
#----------------------------------------------------------------
class cTextForm(cFormEngine):
"""A forms engine outputting data as text for further processing."""
def __init__(self, template_file=None):
super().__init__(template_file = template_file)
# create sandbox to play in (and don't assume much
# of anything about the template_file except that it
# is at our disposal for reading)
self.__sandbox_dir = gmTools.mk_sandbox_dir()
_log.debug('sandbox directory: [%s]', self.__sandbox_dir)
# parse template file which is an INI style config
# file containing the actual template plus metadata
self.form_definition_filename = self.template_filename
_log.debug('form definition file: [%s]', self.form_definition_filename)
cfg_file = io.open(self.form_definition_filename, mode = 'rt', encoding = 'utf-8-sig')
self.form_definition = gmCfgINI.parse_INI_stream(stream = cfg_file)
cfg_file.close()
# extract actual template into a file
template_text = self.form_definition['form::template']
if isinstance(template_text, type([])):
template_text = '\n'.join(self.form_definition['form::template'])
self.template_filename = gmTools.get_unique_filename (
prefix = 'gm-',
suffix = '.txt',
tmp_dir = self.__sandbox_dir
)
_log.debug('template file: [%s]', self.template_filename)
f = io.open(self.template_filename, mode = 'wt', encoding = 'utf8')
f.write(template_text)
f.close()
#--------------------------------------------------------
def substitute_placeholders(self, data_source=None):
if self.template:
# pylint: disable=unsubscriptable-object
# inject placeholder values
data_source.set_placeholder('form_name_long', self.template['name_long'])
data_source.set_placeholder('form_name_short', self.template['name_short'])
data_source.set_placeholder('form_version', self.template['external_version'])
data_source.set_placeholder('form_version_internal', gmTools.coalesce(self.template['gnumed_revision'], '', '%s'))
data_source.set_placeholder('form_last_modified', gmDateTime.pydt_strftime(self.template['last_modified'], '%Y-%b-%d %H:%M'))
base = os.path.join(self.__sandbox_dir, gmTools.fname_stem(self.template_filename))
filenames = [
self.template_filename,
r'%s-result-pass-1.txt' % base,
r'%s-result-pass-2.txt' % base,
r'%s-result-pass-3.txt' % base
]
regexen = [
'dummy',
data_source.first_pass_placeholder_regex,
data_source.second_pass_placeholder_regex,
data_source.third_pass_placeholder_regex
]
current_pass = 1
while current_pass < 4:
_log.debug('placeholder substitution pass #%s', current_pass)
self.__substitute_placeholders (
input_filename = filenames[current_pass-1],
output_filename = filenames[current_pass],
data_source = data_source,
placeholder_regex = regexen[current_pass]
)
current_pass += 1
# remove temporary placeholders
data_source.unset_placeholder('form_name_long')
data_source.unset_placeholder('form_name_short')
data_source.unset_placeholder('form_version')
data_source.unset_placeholder('form_version_internal')
data_source.unset_placeholder('form_last_modified')
self.instance_filename = self.re_editable_filenames[0]
return True
#--------------------------------------------------------
def __substitute_placeholders(self, data_source=None, input_filename=None, output_filename=None, placeholder_regex=None):
_log.debug('[%s] -> [%s]', input_filename, output_filename)
_log.debug('searching for placeholders with pattern: %s', placeholder_regex)
template_file = io.open(input_filename, mode = 'rt', encoding = 'utf-8-sig')
instance_file = io.open(output_filename, mode = 'wt', encoding = 'utf8')
for line in template_file:
# empty lines
if line.strip() in ['', '\r', '\n', '\r\n']:
instance_file.write(line)
continue
# 1) find placeholders in this line
placeholders_in_line = regex.findall(placeholder_regex, line, regex.IGNORECASE)
if len(placeholders_in_line) == 0:
instance_file.write(line)
continue
# 2) replace them
_log.debug('%s placeholders found in this line', len(placeholders_in_line))
for placeholder in placeholders_in_line:
try:
val = data_source[placeholder]
except Exception:
val = _('error with placeholder [%s]') % placeholder
_log.exception(val)
if val is None:
val = _('error with placeholder [%s]') % placeholder
line = line.replace(placeholder, val)
instance_file.write(line)
instance_file.close()
self.re_editable_filenames = [output_filename]
template_file.close()
#--------------------------------------------------------
def edit(self):
editor_cmd = None
try:
editor_cmd = self.form_definition['form::editor'] % self.instance_filename
except KeyError:
_log.debug('no explicit editor defined for text template')
if editor_cmd is None:
mimetype = 'text/plain'
editor_cmd = gmMimeLib.get_editor_cmd(mimetype, self.instance_filename)
if editor_cmd is None:
# also consider text *viewers* since pretty much any of them will be an editor as well
editor_cmd = gmMimeLib.get_viewer_cmd(mimetype, self.instance_filename)
if editor_cmd is not None:
result = gmShellAPI.run_command_in_shell(command = editor_cmd, blocking = True)
self.re_editable_filenames = [self.instance_filename]
return result
#--------------------------------------------------------
def generate_output(self, format=None):
try:
post_processor = self.form_definition['form::post processor'] % {
'input_name': self.instance_filename,
'output_name': self.instance_filename + '.output'
}
except KeyError:
_log.debug('no explicit post processor defined for text template')
return True
self.final_output_filenames = [self.instance_filename + '.output']
return gmShellAPI.run_command_in_shell(command = post_processor, blocking = True)
#------------------------------------------------------------
form_engines['T'] = cTextForm
#================================================================
# LaTeX template forms
#----------------------------------------------------------------
class cLaTeXForm(cFormEngine):
"""A forms engine wrapping LaTeX (pdflatex)."""
_version_checked = False
_mimetypes = [
'application/x-latex',
'application/x-tex',
'text/latex',
'text/tex',
'text/x-tex',
'text/plain'
]
def __init__(self, template_file=None):
# create sandbox for LaTeX to play in (and don't assume
# much of anything about the template_file except that it
# is at our disposal for reading)
sandbox_dir = gmTools.mk_sandbox_dir(prefix = gmTools.fname_stem(template_file) + '_')
_log.debug('LaTeX sandbox directory: [%s]', sandbox_dir)
shutil.copy(template_file, sandbox_dir)
template_file = os.path.join(sandbox_dir, os.path.split(template_file)[1])
super().__init__(template_file = template_file)
self.__sandbox_dir = sandbox_dir
#--------------------------------------------------------
def _rst2latex_transform(self, text):
# remove extra linefeeds which the docutils ReST2LaTeX
# converter likes to add but which makes pdflatex go
# crazy when ending up inside KOMAScript variables
return gmTools.rst2latex_snippet(text).strip()
#--------------------------------------------------------
def substitute_placeholders(self, data_source=None):
# debugging
#data_source.debug = True
if self.template:
# pylint: disable=unsubscriptable-object
# inject placeholder values
data_source.set_placeholder('form_name_long', self.template['name_long'])
data_source.set_placeholder('form_name_short', self.template['name_short'])
data_source.set_placeholder('form_version', self.template['external_version'])
data_source.set_placeholder('form_version_internal', gmTools.coalesce(self.template['gnumed_revision'], '', '%s'))
data_source.set_placeholder('form_last_modified', gmDateTime.pydt_strftime(self.template['last_modified'], '%Y-%b-%d %H:%M'))
# add site-local identifying information to template for debugging
f = open(self.template_filename, 'at', encoding = 'utf8')
f.write('\n')
f.write('%------------------------------------------------------------------\n')
for line in self.template.format():
f.write('% ')
f.write(line)
f.write('\n')
f.write('%------------------------------------------------------------------\n')
f.close()
data_source.escape_function = gmTools.tex_escape_string
data_source.escape_style = 'latex'
path, ext = os.path.splitext(self.template_filename)
if ext in [r'', r'.']:
ext = r'.tex'
filenames = [
self.template_filename,
r'%s-result-pass-1%s' % (path, ext),
r'%s-result-pass-2%s' % (path, ext),
r'%s-result-pass-3%s' % (path, ext),
r'%s-result-pass-4%s' % (path, ext),
r'%s-result-pass-5%s' % (path, ext)
]
regexen = [
'dummy',
r'\$1{0,1}<[^<].+?>1{0,1}\$',
r'\$2<[^<].+?>2\$',
r'\$3<[^<].+?>3\$',
r'\$4<[^<].+?>4\$',
r'\$5<[^<].+?>5\$'
]
current_pass = 1
while current_pass < 6:
_log.debug('placeholder substitution pass #%s', current_pass)
self.__substitute_placeholders (
input_filename = filenames[current_pass-1],
output_filename = filenames[current_pass],
data_source = data_source,
placeholder_regex = regexen[current_pass]
)
current_pass += 1
# remove temporary placeholders
data_source.unset_placeholder('form_name_long')
data_source.unset_placeholder('form_name_short')
data_source.unset_placeholder('form_version')
data_source.unset_placeholder('form_version_internal')
data_source.unset_placeholder('form_last_modified')
self.instance_filename = self.re_editable_filenames[0]
return
#--------------------------------------------------------
def __substitute_placeholders(self, data_source=None, input_filename=None, output_filename=None, placeholder_regex=None):
_log.debug('[%s] -> [%s]', input_filename, output_filename)
_log.debug('searching for placeholders with pattern: %s', placeholder_regex)
template_file = io.open(input_filename, mode = 'rt', encoding = 'utf-8-sig')
instance_file = io.open(output_filename, mode = 'wt', encoding = 'utf8')
for line in template_file:
# empty lines
if line.strip() in ['', '\r', '\n', '\r\n']:
instance_file.write(line)
continue
# TeX-comment-only lines
if line.lstrip().startswith('%'):
instance_file.write(line)
continue
# 1) find placeholders in this line
placeholders_in_line = regex.findall(placeholder_regex, line, regex.IGNORECASE)
if len(placeholders_in_line) == 0:
instance_file.write(line)
continue
# 2) replace them
_log.debug('replacing in non-empty, non-comment line: >>>%s<<<', line.rstrip(u'\n'))
_log.debug('%s placeholder(s) detected', len(placeholders_in_line))
for placeholder in placeholders_in_line:
if 'free_text' in placeholder:
# enable reStructuredText processing
data_source.escape_function = self._rst2latex_transform
else:
data_source.escape_function = gmTools.tex_escape_string
original_ph_def = placeholder
_log.debug('placeholder: >>>%s<<<', original_ph_def)
# normalize start/end
if placeholder.startswith('$<'):
placeholder = '$1<' + placeholder[2:]
if placeholder.endswith('>$'):
placeholder = placeholder[:-2] + '>1$'
_log.debug('normalized : >>>%s<<<', placeholder)
# remove start/end
placeholder = placeholder[3:-3]
_log.debug('stripped : >>>%s<<<', placeholder)
try:
val = data_source[placeholder]
except Exception:
_log.exception('error with placeholder [%s]', original_ph_def)
val = gmTools.tex_escape_string(_('error with placeholder [%s]') % original_ph_def)
if val is None:
_log.debug('error with placeholder [%s]', original_ph_def)
val = gmTools.tex_escape_string(_('error with placeholder [%s]') % original_ph_def)
_log.debug('value : >>>%s<<<', val)
line = line.replace(original_ph_def, val)
instance_file.write(line)
instance_file.close()
self.re_editable_filenames = [output_filename]
template_file.close()
return
#--------------------------------------------------------
def edit(self) -> bool:
"""Call editor on generated LaTeX file.
Checks for editors on mimetypes:
%s
""" % cLaTeXForm._mimetypes
for mimetype in cLaTeXForm._mimetypes:
editor_cmd = gmMimeLib.get_editor_cmd(mimetype, self.instance_filename)
if editor_cmd is not None:
break
if editor_cmd is None:
# LaTeX code is text: also consider text *viewers*
# since pretty much any of them will be an editor as well
for mimetype in cLaTeXForm._mimetypes:
editor_cmd = gmMimeLib.get_viewer_cmd(mimetype, self.instance_filename)
if editor_cmd is not None:
break
if editor_cmd is None:
return False
result = gmShellAPI.run_command_in_shell(command = editor_cmd, blocking = True)
self.re_editable_filenames = [self.instance_filename]
return result
#--------------------------------------------------------
def generate_output(self, instance_file=None, format=None):
if instance_file is None:
instance_file = self.instance_filename
try:
open(instance_file, 'r').close()
except Exception:
_log.exception('cannot access form instance file [%s]', instance_file)
gmLog2.log_stack_trace()
return None
self.instance_filename = instance_file
_log.debug('ignoring <format> directive [%s], generating PDF', format)
sandboxed_pdf_name = gmMimeLib.convert_latex_to_pdf (
filename = self.instance_filename,
verbose = _cfg.get(option = 'debug'),
is_sandboxed = True
)
if sandboxed_pdf_name is None:
return None
target_dir = os.path.normpath(os.path.join(os.path.split(sandboxed_pdf_name)[0], '..'))
final_pdf_name = os.path.join (
target_dir,
os.path.split(sandboxed_pdf_name)[1]
)
_log.debug('copying sandboxed PDF: %s -> %s', sandboxed_pdf_name, final_pdf_name)
try:
shutil.copy2(sandboxed_pdf_name, target_dir)
except IOError:
_log.exception('cannot open/move sandboxed PDF')
gmDispatcher.send(signal = 'statustext', msg = _('PDF output file cannot be opened.'), beep = True)
return None
self.final_output_filenames = [final_pdf_name]
return final_pdf_name
#------------------------------------------------------------
form_engines['L'] = cLaTeXForm
#================================================================
# Xe(La)TeX template forms
#----------------------------------------------------------------
# Xe(La)TeX: http://www.scholarsfonts.net/xetextt.pdf
class cXeTeXForm(cFormEngine):
"""A forms engine wrapping Xe(La)TeX."""
def __init__(self, template_file=None):
# create sandbox for LaTeX to play in (and don't assume
# much of anything about the template_file except that it
# is at our disposal)
sandbox_dir = gmTools.mk_sandbox_dir(prefix = gmTools.fname_stem(template_file) + '_')
_log.debug('Xe(La)TeX sandbox directory: [%s]', sandbox_dir)
shutil.copy(template_file, sandbox_dir)
template_file = os.path.join(sandbox_dir, os.path.split(template_file)[1])
super().__init__(template_file = template_file)
self.__sandbox_dir = sandbox_dir
#--------------------------------------------------------
def substitute_placeholders(self, data_source=None):
if self.template is not None:
# pylint: disable=unsubscriptable-object
# inject placeholder values
data_source.set_placeholder('form_name_long', self.template['name_long'])
data_source.set_placeholder('form_name_short', self.template['name_short'])
data_source.set_placeholder('form_version', self.template['external_version'])
data_source.set_placeholder('form_version_internal', gmTools.coalesce(self.template['gnumed_revision'], '', '%s'))
data_source.set_placeholder('form_last_modified', gmDateTime.pydt_strftime(self.template['last_modified'], '%Y-%b-%d %H:%M'))
data_source.escape_function = gmTools.xetex_escape_string
data_source.escape_style = 'xetex'
path, ext = os.path.splitext(self.template_filename)
if ext in [r'', r'.']:
ext = r'.tex'
filenames = [
self.template_filename,
r'%s-result_run1%s' % (path, ext),
r'%s-result_run2%s' % (path, ext),
r'%s-result_run3%s' % (path, ext)
]
found_placeholders = True
current_run = 1
while found_placeholders and (current_run < 4):
_log.debug('placeholder substitution run #%s', current_run)
found_placeholders = self.__substitute_placeholders (
input_filename = filenames[current_run-1],
output_filename = filenames[current_run],
data_source = data_source
)
current_run += 1
if self.template is not None:
# remove temporary placeholders
data_source.unset_placeholder('form_name_long')
data_source.unset_placeholder('form_name_short')
data_source.unset_placeholder('form_version')
data_source.unset_placeholder('form_version_internal')
data_source.unset_placeholder('form_last_modified')
self.instance_filename = self.re_editable_filenames[0]
return
#--------------------------------------------------------
def __substitute_placeholders(self, data_source=None, input_filename=None, output_filename=None):
_log.debug('[%s] -> [%s]', input_filename, output_filename)
found_placeholders = False
template_file = io.open(input_filename, mode = 'rt', encoding = 'utf-8-sig')
instance_file = io.open(output_filename, mode = 'wt', encoding = 'utf8')
for line in template_file:
if line.strip() in ['', '\r', '\n', '\r\n']: # empty lines
instance_file.write(line)
continue
if line.startswith('%'): # TeX comment
instance_file.write(line)
continue
for placeholder_regex in [data_source.first_pass_placeholder_regex, data_source.second_pass_placeholder_regex, data_source.third_pass_placeholder_regex]:
# 1) find placeholders in this line
placeholders_in_line = regex.findall(placeholder_regex, line, regex.IGNORECASE)
if len(placeholders_in_line) == 0:
continue
_log.debug('%s placeholders found with pattern: %s', len(placeholders_in_line), placeholder_regex)
found_placeholders = True
# 2) replace them
for placeholder in placeholders_in_line:
try:
val = data_source[placeholder]
except Exception:
_log.exception('error with placeholder [%s]', placeholder)
val = gmTools.tex_escape_string(_('error with placeholder [%s]') % placeholder)
if val is None:
_log.debug('error with placeholder [%s]', placeholder)
val = _('error with placeholder [%s]') % gmTools.tex_escape_string(placeholder)
line = line.replace(placeholder, val)
instance_file.write(line)
instance_file.close()
self.re_editable_filenames = [output_filename]
template_file.close()
return found_placeholders
#--------------------------------------------------------
def edit(self):
mimetypes = [
'application/x-xetex',
'application/x-latex',
'application/x-tex',
'text/plain'
]
for mimetype in mimetypes:
editor_cmd = gmMimeLib.get_editor_cmd(mimetype, self.instance_filename)
if editor_cmd is not None:
break
if editor_cmd is None:
# Xe(La)TeX code is utf8: also consider text *viewers*
# since pretty much any of them will be an editor as well
for mimetype in mimetypes:
editor_cmd = gmMimeLib.get_viewer_cmd(mimetype, self.instance_filename)
if editor_cmd is not None:
break
if editor_cmd is None:
return False
result = gmShellAPI.run_command_in_shell(command = editor_cmd, blocking = True)
self.re_editable_filenames = [self.instance_filename]
return result
#--------------------------------------------------------
def generate_output(self, instance_file=None, format=None):
if instance_file is None:
instance_file = self.instance_filename
try:
open(instance_file, 'r').close()
except Exception:
_log.exception('cannot access form instance file [%s]', instance_file)
gmLog2.log_stack_trace()
return None
self.instance_filename = instance_file
_log.debug('ignoring <format> directive [%s], generating PDF', format)
# Xe(La)TeX can need up to three runs to get cross references et al right
if platform.system() == 'Windows':
# not yet supported: -draftmode
# does not support: -shell-escape
draft_cmd = r'xelatex.exe -interaction=nonstopmode -output-directory=%s %s' % (self.__sandbox_dir, self.instance_filename)
final_cmd = r'xelatex.exe -interaction=nonstopmode -output-directory=%s %s' % (self.__sandbox_dir, self.instance_filename)
else:
# not yet supported: -draftmode
draft_cmd = r'xelatex -interaction=nonstopmode -output-directory=%s -shell-escape %s' % (self.__sandbox_dir, self.instance_filename)
final_cmd = r'xelatex -interaction=nonstopmode -output-directory=%s -shell-escape %s' % (self.__sandbox_dir, self.instance_filename)
for run_cmd in [draft_cmd, draft_cmd, final_cmd]:
if not gmShellAPI.run_command_in_shell(command = run_cmd, blocking = True, acceptable_return_codes = [0, 1]):
_log.error('problem running xelatex, cannot generate form output')
gmDispatcher.send(signal = 'statustext', msg = _('Error running xelatex. Cannot turn Xe(La)TeX template into PDF.'), beep = True)
return None
sandboxed_pdf_name = '%s.pdf' % os.path.splitext(self.instance_filename)[0]
target_dir = os.path.normpath(os.path.join(os.path.split(sandboxed_pdf_name)[0], '..'))
final_pdf_name = os.path.join (
target_dir,
os.path.split(sandboxed_pdf_name)[1]
)
_log.debug('copying sandboxed PDF: %s -> %s', sandboxed_pdf_name, final_pdf_name)
try:
shutil.copy2(sandboxed_pdf_name, target_dir)
except IOError:
_log.exception('cannot open/move sandboxed PDF')
gmDispatcher.send(signal = 'statustext', msg = _('PDF output file cannot be opened.'), beep = True)
return None
self.final_output_filenames = [final_pdf_name]
return final_pdf_name
#------------------------------------------------------------
form_engines['X'] = cXeTeXForm
#============================================================
# Gnuplot template forms
#------------------------------------------------------------
_GNUPLOT_WRAPPER_SCRIPT = """# --------------------------------------------------------------
# GNUplot wrapper script used by GNUmed
#
# This script is used to make gnuplot
#
# - display some debugging information,
#
# - load GNUmed specific settings such as the timestamp
# format, encoding, symbol for missing values,
#
# - load data specific values such as y(2)label or plot
# title which GNUmed will have set up while exporting
# test results for plotting,
#
# - learn the datafile name from the variable <gm2gpl_datafile>
# which the user-provided plotting script can then use
# to access data like so:
#
# plot gm2gpl_datafile ...
#
# --------------------------------------------------------------
# logging verbosity, depending on GNUmed client debug state
gmd_log_verbose = %s
# -- debugging ----
show version long
if (gmd_log_verbose == 1) {
print "-- <show all> at startup ----"
show all
print "-- <show variables all> at startup ----"
show variables all
}
# -- data format setup ----
set encoding utf8
set timefmt "%%Y-%%m-%%d_%%H:%%M" # timestamp format in data (output format defined elsewhere)
# -- data file setup ----
gm2gpl_datafile = '%s'
set datafile missing "<?>"
set xdata time
set x2data time
# -- process additional definitions from GNUmed ----
gm2gpl_datafile_conf = gm2gpl_datafile.'.conf'
load gm2gpl_datafile_conf
# -- actually run the user provided plotting script ----
call '%s'
# -- debugging ----
if (gmd_log_verbose == 1) {
print "-- <show all> after running user provided plotting script ----"
show all
print "-- <show variables all> after running user provided plotting script ----"
show variables all
# PNG output:
#set terminal png enhanced transparent nointerlace truecolor #medium #crop
##set output 'test_terminal.png'
##test
#set output gm2gpl_datafile.'.dbg.png'
#replot
# ASCII art output:
#set terminal dumb size 120,45 feed enhanced ansirgb
##set output 'test_terminal.txt'
##test
#set output gm2gpl_datafile.'.dbg.txt'
#replot
#set terminal dumb size 120,45 feed enhanced mono
##set output 'test_terminal.ascii.txt'
##test
#set output gm2gpl_datafile.'.dbg.ascii.txt'
#replot
}
"""
class cGnuplotForm(cFormEngine):
"""A forms engine wrapping Gnuplot."""
#--------------------------------------------------------
def __init__(self, template_file=None):
super().__init__(template_file = template_file)
self.__data_filename = None
#--------------------------------------------------------
def substitute_placeholders(self, data_source=None):
"""Parse the template into an instance and replace placeholders with values."""
pass
#--------------------------------------------------------
def edit(self):
"""Allow editing the instance of the template."""
self.re_editable_filenames = []
return True
#--------------------------------------------------------
def generate_output(self, format=None):
"""Generate output suitable for further processing outside this class, e.g. printing.
Expects .data_filename to be set.
"""
assert self.__data_filename, '.data_filename must be set'
# append some metadata for debugging, if available
if self.template:
f = open(self.template_filename, 'at', encoding = 'utf8')
f.write('\n')
f.write('# -- metadata ----------------------------------------------------------------\n')
for line in self.template.format():
f.write('# %s\n' % line)
f.write('# ----------------------------------------------------------------------------\n')
f.close()
wrapper_filename = gmTools.get_unique_filename (
prefix = 'gm2gpl-wrapper-',
suffix = '.gpl',
tmp_dir = gmTools.fname_dir(self.__data_filename)
)
wrapper_script = io.open(wrapper_filename, mode = 'wt', encoding = 'utf8')
wrapper_script.write(_GNUPLOT_WRAPPER_SCRIPT % (
gmTools.bool2subst(_cfg.get(option = 'debug'), '1', '0', '0'),
self.__data_filename,
self.template_filename
))
wrapper_script.close()
# FIXME: cater for configurable path
if platform.system() == 'Windows':
exec_name = 'gnuplot.exe'
else:
exec_name = 'gnuplot'
cmd_line = [
exec_name,
'-p', # persist plot window after gnuplot exits (in case the wxt terminal is used)
wrapper_filename
]
success, exit_code, stdout = gmShellAPI.run_process(cmd_line = cmd_line, encoding = 'utf8', verbose = _cfg.get(option = 'debug'))
if not success:
gmDispatcher.send(signal = 'statustext', msg = _('Error running gnuplot. Cannot plot data.'), beep = True)
return False
self.final_output_filenames = [
self.__data_filename,
self.template_filename,
wrapper_filename
]
return True
#--------------------------------------------------------
# properties
#--------------------------------------------------------
def _set_data_filename(self, data_filename):
try:
open(data_filename, 'r').close()
except FileNotFoundError:
_log.error('cannot open [%s]', data_filename)
return
self.__data_filename = data_filename
data_filename = property(fset = _set_data_filename)
#------------------------------------------------------------
form_engines['G'] = cGnuplotForm
#============================================================
# fPDF form engine
#------------------------------------------------------------
class cPDFForm(cFormEngine):
"""A forms engine wrapping PDF forms.
Johann Felix Soden <johfel@gmx.de> helped with this.
http://partners.adobe.com/public/developer/en/pdf/PDFReference16.pdf
http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/fdf_data_exchange.pdf
"""
def __init__(self, template_file=None):
super(cPDFForm, self).__init__(template_file = template_file)
# detect pdftk
found, self.pdftk_binary = gmShellAPI.detect_external_binary(binary = r'pdftk')
if not found:
raise ImportError('<pdftk(.exe)> not found')
return # should be superfluous, actually
enc = sys.getfilesystemencoding()
self.pdftk_binary = self.pdftk_binary.encode(enc)
base_name, ext = os.path.splitext(self.template_filename)
self.fdf_dumped_filename = ('%s.fdf' % base_name).encode(enc)
self.fdf_replaced_filename = ('%s-replaced.fdf' % base_name).encode(enc)
self.pdf_filled_filename = ('%s-filled.pdf' % base_name).encode(enc)
self.pdf_flattened_filename = ('%s-filled-flattened.pdf' % base_name).encode(enc)
#--------------------------------------------------------
def substitute_placeholders(self, data_source=None):
# dump form fields from template
cmd_line = [
self.pdftk_binary,
self.template_filename,
r'generate_fdf',
r'output',
self.fdf_dumped_filename
]
_log.debug(' '.join(cmd_line))
try:
pdftk = subprocess.Popen(cmd_line)
except OSError:
_log.exception('cannot run <pdftk> (dump data from form)')
gmDispatcher.send(signal = 'statustext', msg = _('Error running pdftk. Cannot extract fields from PDF form template.'), beep = True)
return False
pdftk.communicate()
if pdftk.returncode != 0:
_log.error('<pdftk> returned [%s], failed to dump data from PDF form into FDF', pdftk.returncode)
return False
# parse dumped FDF file for "/V (...)" records
# and replace placeholders therein
fdf_dumped_file = io.open(self.fdf_dumped_filename, mode = 'rt', encoding = 'utf-8-sig')
fdf_replaced_file = io.open(self.fdf_replaced_filename, mode = 'wt', encoding = 'utf8')
string_value_regex = r'\s*/V\s*\(.+\)\s*$'
for line in fdf_dumped_file:
if not regex.match(string_value_regex, line):
fdf_replaced_file.write(line)
continue
# strip cruft around the string value
raw_str_val = line.strip() # remove framing whitespace
raw_str_val = raw_str_val[2:] # remove leading "/V"
raw_str_val = raw_str_val.lstrip() # remove whitespace between "/V" and "("
raw_str_val = raw_str_val[1:] # remove opening "("
raw_str_val = raw_str_val[2:] # remove BOM-16-BE
raw_str_val = raw_str_val.rstrip() # remove trailing whitespace
raw_str_val = raw_str_val[:-1] # remove closing ")"
# work on FDF escapes
raw_str_val = raw_str_val.replace('\(', '(') # remove escaping of "("
raw_str_val = raw_str_val.replace('\)', ')') # remove escaping of ")"
# by now raw_str_val should contain the actual
# string value, albeit encoded as UTF-16, so
# decode it into a unicode object,
# split multi-line fields on "\n" literal
raw_str_lines = raw_str_val.split('\x00\\n')
value_template_lines = []
for raw_str_line in raw_str_lines:
value_template_lines.append(raw_str_line.decode('utf_16_be'))
replaced_lines = []
for value_template in value_template_lines:
# find any placeholders within
placeholders_in_value = regex.findall(data_source.placeholder_regex, value_template, regex.IGNORECASE)
for placeholder in placeholders_in_value:
try:
replacement = data_source[placeholder]
except Exception:
_log.exception(replacement)
replacement = _('error with placeholder [%s]') % placeholder
if replacement is None:
replacement = _('error with placeholder [%s]') % placeholder
value_template = value_template.replace(placeholder, replacement)
value_template = value_template.encode('utf_16_be')
if len(placeholders_in_value) > 0:
value_template = value_template.replace(r'(', r'\(')
value_template = value_template.replace(r')', r'\)')
replaced_lines.append(value_template)
replaced_line = '\x00\\n'.join(replaced_lines)
fdf_replaced_file.write('/V (')
fdf_replaced_file.write(codecs.BOM_UTF16_BE)
fdf_replaced_file.write(replaced_line)
fdf_replaced_file.write(')\n')
fdf_replaced_file.close()
fdf_dumped_file.close()
# merge replaced data back into form
cmd_line = [
self.pdftk_binary,
self.template_filename,
r'fill_form',
self.fdf_replaced_filename,
r'output',
self.pdf_filled_filename
]
_log.debug(' '.join(cmd_line))
try:
pdftk = subprocess.Popen(cmd_line)
except OSError:
_log.exception('cannot run <pdftk> (merge data into form)')
gmDispatcher.send(signal = 'statustext', msg = _('Error running pdftk. Cannot fill in PDF form template.'), beep = True)
return False
pdftk.communicate()
if pdftk.returncode != 0:
_log.error('<pdftk> returned [%s], failed to merge FDF data into PDF form', pdftk.returncode)
return False
return True
#--------------------------------------------------------
def edit(self):
mimetypes = [
'application/pdf',
'application/x-pdf'
]
for mimetype in mimetypes:
editor_cmd = gmMimeLib.get_editor_cmd(mimetype, self.pdf_filled_filename)
if editor_cmd is not None:
break
if editor_cmd is None:
_log.debug('editor cmd not found, trying viewer cmd')
for mimetype in mimetypes:
editor_cmd = gmMimeLib.get_viewer_cmd(mimetype, self.pdf_filled_filename)
if editor_cmd is not None:
break
if editor_cmd is None:
return False
result = gmShellAPI.run_command_in_shell(command = editor_cmd, blocking = True)
path, fname = os.path.split(self.pdf_filled_filename)
candidate = os.path.join(gmTools.gmPaths().home_dir, fname)
if os.access(candidate, os.R_OK):
_log.debug('filled-in PDF found: %s', candidate)
os.rename(self.pdf_filled_filename, self.pdf_filled_filename + '.bak')
shutil.move(candidate, path)
else:
_log.debug('filled-in PDF not found: %s', candidate)
self.re_editable_filenames = [self.pdf_filled_filename]
return result
#--------------------------------------------------------
def generate_output(self, format=None):
"""Generate output suitable for further processing outside this class, e.g. printing."""
# eventually flatten the filled in form so we
# can keep both a flattened and an editable copy:
cmd_line = [
self.pdftk_binary,
self.pdf_filled_filename,
r'output',
self.pdf_flattened_filename,
r'flatten'
]
_log.debug(' '.join(cmd_line))
try:
pdftk = subprocess.Popen(cmd_line)
except OSError:
_log.exception('cannot run <pdftk> (flatten filled in form)')
gmDispatcher.send(signal = 'statustext', msg = _('Error running pdftk. Cannot flatten filled in PDF form.'), beep = True)
return None
pdftk.communicate()
if pdftk.returncode != 0:
_log.error('<pdftk> returned [%s], failed to flatten filled in PDF form', pdftk.returncode)
return None
self.final_output_filenames = [self.pdf_flattened_filename]
return self.pdf_flattened_filename
#------------------------------------------------------------
form_engines['P'] = cPDFForm
#============================================================
# older code
#------------------------------------------------------------
#================================================================
# define a class for HTML forms (for printing)
#================================================================
class cXSLTFormEngine(cFormEngine):
"""This class can create XML document from requested data,
then process it with XSLT template and display results
"""
# FIXME: make the path configurable ?
_preview_program = 'oowriter ' #this program must be in the system PATH
def __init__(self, template=None):
if template is None:
raise ValueError('%s: cannot create form instance without a template' % __name__)
super().__init__(template_file = template)
self._FormData = None
# here we know/can assume that the template was stored as a utf-8
# encoded string so use that conversion to create unicode:
#self._XSLTData = str(str(template.template_data), 'UTF-8')
# but in fact, str() knows how to handle buffers, so simply:
self._XSLTData = str(self.template.template_data, 'UTF-8', 'strict')
# we must still devise a method of extracting the SQL query:
# - either by retrieving it from a particular tag in the XSLT or
# - by making the stored template actually be a dict which, unpickled,
# has the keys "xslt" and "sql"
self._SQL_query = 'select 1' #this sql query must output valid xml
#--------------------------------------------------------
# external API
#--------------------------------------------------------
def process(self, sql_parameters):
"""get data from backend and process it with XSLT template to produce readable output"""
# extract SQL (this is wrong but displays what is intended)
#xslt = libxml2.parseDoc(self._XSLTData)
xslt = None
root = xslt.children
for child in root:
if child.type == 'element':
self._SQL_query = child.content
break
# retrieve data from backend
rows, idx = gmPG2.run_ro_queries(queries = [{'cmd': self._SQL_query, 'args': sql_parameters}], get_col_idx = False)
__header = '<?xml version="1.0" encoding="UTF-8"?>\n'
__body = rows[0][0]
# process XML data according to supplied XSLT, producing HTML
self._XMLData =__header + __body
#style = libxslt.parseStylesheetDoc(xslt)
style = None
#xml = libxml2.parseDoc(self._XMLData)
xml = None
html = style.applyStylesheet(xml, None)
self._FormData = html.serialize()
style.freeStylesheet()
xml.freeDoc()
html.freeDoc()
#--------------------------------------------------------
def preview(self):
if self._FormData is None:
raise ValueError('Preview request for empty form. Make sure the form is properly initialized and process() was performed')
fname = gmTools.get_unique_filename(prefix = 'gm_XSLT_form-', suffix = '.html')
#html_file = os.open(fname, 'wb')
#html_file.write(self._FormData.encode('UTF-8'))
html_file = io.open(fname, mode = 'wt', encoding = 'utf8', errors = 'strict') # or 'replace' ?
html_file.write(self._FormData)
html_file.close()
cmd = '%s %s' % (self.__class__._preview_program, fname)
if not gmShellAPI.run_command_in_shell(command = cmd, blocking = False):
_log.error('%s: cannot launch report preview program' % __name__)
return False
#os.unlink(self.filename) #delete file
#FIXME: under Windows the temp file is deleted before preview program gets it (under Linux it works OK)
return True
#--------------------------------------------------------
def print_directly(self):
#not so fast, look at it first
self.preview()
#=====================================================
#class LaTeXFilter(Cheetah.Filters.Filter):
class LaTeXFilter:
def conv_enc(self, item, table_sep= " \\\\\n", **kwds):
"""
Convience function to escape ISO-Latin-1 strings for TeX output
WARNING: not all ISO-Latin-1 characters are expressible in TeX
FIXME: nevertheless, there are a few more we could support
Also intelligently convert lists and tuples into TeX-style table lines
"""
if type(item) is str:
item = item.replace ("\\", "\\backslash") # I wonder about this, do we want users to be able to use raw TeX?
item = item.replace ("&", "\\&")
item = item.replace ("$", "\\$")
item = item.replace ('"', "") # okay, that's not right, but easiest solution for now
item = item.replace ("\n", "\\\\ ")
if len (item.strip ()) == 0:
item = "\\relax " # sometimes TeX really hates empty strings, this seems to mollify it
# FIXME: cover all of ISO-Latin-1 which can be expressed in TeX
item = item.encode ('latin-1', 'replace')
trans = {'ß':'\\ss{}', 'ä': '\\"{a}', 'Ä' :'\\"{A}', 'ö': '\\"{o}', 'Ö': '\\"{O}', 'ü': '\\"{u}', 'Ü': '\\"{U}',
'\x8a':'\\v{S}', #'\x8a':'\\OE{}',
'\x9a':'\\v{s}',
'\x9c': '\\oe{}',
'\a9f':'\\"{Y}', #Microsloth extensions
'\x86': '{\\dag}',
'\x87': '{\\ddag}',
'\xa7':'{\\S}',
'\xb6': '{\\P}',
'\xa9': '{\\copyright}',
'\xbf': '?`',
'\xc0':'\\`{A}',
'\xa1': "\\'{A}",
#'\xa1': '!`',
'\xa2': '\\^{A}',
#'\xa2':'cent'
#'\xa3':'\\~{A}',
'\xa3': '\pounds{}',
'\\xc5': '{\AA}',
'\xc7':'\\c{C}',
'\xc8':'\\`{E}',
'\xb5':'$\mu$',
}
for k, i in trans.items ():
item = item.replace (k, i)
elif type(item) is list or type(item) is tuple:
item = table_sep.join ([self.conv_enc(i, ' & ') for i in item])
elif item is None:
item = '\\relax % Python None\n'
elif type(item) is int or type(item) is float:
item = str(item)
else:
item = str(item)
_log.warning("unknown type %s, string %s" % (type(item), item))
return item
#===========================================================
class cHL7Form (cFormEngine):
pass
#============================================================
# convenience functions
#------------------------------------------------------------
class FormError (Exception):
def __init__ (self, value):
self.value = value
def __str__ (self):
return repr (self.value)
#============================================================
# main
#------------------------------------------------------------
if __name__ == '__main__':
if len(sys.argv) < 2:
sys.exit()
if sys.argv[1] != 'test':
sys.exit()
gmLog2.print_logfile_name()
gmDateTime.init()
#--------------------------------------------------------
# OOo
#--------------------------------------------------------
def test_init_ooo():
init_ooo()
#--------------------------------------------------------
def test_ooo_connect():
srv = gmOOoConnector()
print(srv)
print(srv.desktop)
#--------------------------------------------------------
def test_open_ooo_doc_from_srv():
srv = gmOOoConnector()
doc = srv.open_document(filename = sys.argv[2])
print("document:", doc)
#--------------------------------------------------------
def test_open_ooo_doc_from_letter():
doc = cOOoLetter(template_file = sys.argv[2])
doc.open_in_ooo()
print("document:", doc)
input('press <ENTER> to continue')
doc.show()
#doc.replace_placeholders()
#doc.save_in_ooo('~/test_cOOoLetter.odt')
# doc = None
# doc.close_in_ooo()
input('press <ENTER> to continue')
#--------------------------------------------------------
def play_with_ooo():
#doc = open_uri_in_ooo(filename=sys.argv[1])
doc = None
class myCloseListener(unohelper.Base, oooXCloseListener):
def disposing(self, evt):
print("disposing:")
def notifyClosing(self, evt):
print("notifyClosing:")
def queryClosing(self, evt, owner):
# owner is True/False whether I am the owner of the doc
print("queryClosing:")
l = myCloseListener()
doc.addCloseListener(l)
tfs = doc.getTextFields().createEnumeration()
print(tfs)
print(dir(tfs))
while tfs.hasMoreElements():
tf = tfs.nextElement()
if tf.supportsService('com.sun.star.text.TextField.JumpEdit'):
print(tf.getPropertyValue('PlaceHolder'))
print(" ", tf.getPropertyValue('Hint'))
# doc.close(True) # closes but leaves open the dedicated OOo window
doc.dispose() # closes and disposes of the OOo window
#--------------------------------------------------------
def test_cOOoLetter():
pat = gmPersonSearch.ask_for_patient()
if pat is None:
return
gmPerson.set_active_patient(patient = pat)
doc = cOOoLetter(template_file = sys.argv[2])
doc.open_in_ooo()
print(doc)
doc.show()
#doc.replace_placeholders()
#doc.save_in_ooo('~/test_cOOoLetter.odt')
doc = None
# doc.close_in_ooo()
input('press <ENTER> to continue')
#--------------------------------------------------------
# other
#--------------------------------------------------------
def test_cFormTemplate():
template = cFormTemplate(aPK_obj = sys.argv[2])
print(template)
print(template.save_to_file())
#--------------------------------------------------------
def set_template_from_file():
template = cFormTemplate(aPK_obj = sys.argv[2])
template.update_template_from_file(filename = sys.argv[3])
#--------------------------------------------------------
def test_latex_form():
pat = gmPersonSearch.ask_for_patient()
if pat is None:
return
gmPerson.set_active_patient(patient = pat)
gmStaff.gmCurrentProvider(provider = gmStaff.cStaff())
path = os.path.abspath(sys.argv[2])
form = cLaTeXForm(template_file = path)
from Gnumed.wxpython import gmMacro
ph = gmMacro.gmPlaceholderHandler()
ph.debug = True
form.substitute_placeholders(data_source = ph)
pdf_name = form.generate_output()
print("final PDF file is:", pdf_name)
#--------------------------------------------------------
def test_pdf_form():
pat = gmPersonSearch.ask_for_patient()
if pat is None:
return
gmPerson.set_active_patient(patient = pat)
gmStaff.gmCurrentProvider(provider = gmStaff.cStaff())
path = os.path.abspath(sys.argv[2])
form = cPDFForm(template_file = path)
from Gnumed.wxpython import gmMacro
ph = gmMacro.gmPlaceholderHandler()
ph.debug = True
form.substitute_placeholders(data_source = ph)
pdf_name = form.generate_output()
print("final PDF file is:", pdf_name)
#--------------------------------------------------------
def test_abiword_form():
pat = gmPersonSearch.ask_for_patient()
if pat is None:
return
gmPerson.set_active_patient(patient = pat)
gmStaff.gmCurrentProvider(provider = gmStaff.cStaff())
path = os.path.abspath(sys.argv[2])
form = cAbiWordForm(template_file = path)
from Gnumed.wxpython import gmMacro
ph = gmMacro.gmPlaceholderHandler()
ph.debug = True
form.substitute_placeholders(data_source = ph)
form.edit()
final_name = form.generate_output()
print("final file is:", final_name)
#--------------------------------------------------------
def test_text_form():
from Gnumed.business import gmPraxis
branches = gmPraxis.get_praxis_branches()
praxis = gmPraxis.gmCurrentPraxisBranch(branches[0])
print(praxis)
pat = gmPersonSearch.ask_for_patient()
if pat is None:
return
print(pat)
gmPerson.set_active_patient(patient = pat)
gmStaff.gmCurrentProvider(provider = gmStaff.cStaff())
path = os.path.abspath(sys.argv[2])
print(path)
form = cTextForm(template_file = path)
print(form)
from Gnumed.wxpython import gmMacro
ph = gmMacro.gmPlaceholderHandler()
ph.debug = True
print("placeholder substitution worked:", form.substitute_placeholders(data_source = ph))
print(form.re_editable_filenames)
form.edit()
form.generate_output()
#--------------------------------------------------------
#--------------------------------------------------------
#--------------------------------------------------------
# now run the tests
# OOo
#test_init_ooo()
#test_ooo_connect()
#test_open_ooo_doc_from_srv()
#test_open_ooo_doc_from_letter()
#play_with_ooo()
#test_cOOoLetter()
#test_cFormTemplate()
#set_template_from_file()
gmPG2.request_login_params(setup_pool = True)
if not gmPraxis.activate_first_praxis_branch():
print('no praxis')
#test_latex_form()
#test_pdf_form()
#test_abiword_form()
test_text_form()
#============================================================Functions
def create_form_template(template_type=None, name_short=None, name_long=None)-
Expand source code
def create_form_template(template_type=None, name_short=None, name_long=None): cmd = """ INSERT INTO ref.paperwork_templates ( fk_template_type, name_short, name_long, external_version ) VALUES ( %(type)s, %(nshort)s, %(nlong)s, %(ext_version)s ) RETURNING pk """ args = {'type': template_type, 'nshort': name_short, 'nlong': name_long, 'ext_version': 'new'} rows, idx = gmPG2.run_rw_queries(queries = [{'cmd': cmd, 'args': args}], return_data = True) template = cFormTemplate(aPK_obj = rows[0][0]) return template def delete_form_template(template=None)-
Expand source code
def delete_form_template(template=None): rows, idx = gmPG2.run_rw_queries ( queries = [{ 'cmd': 'DELETE FROM ref.paperwork_templates WHERE pk = %(pk)s', 'args': {'pk': template['pk_paperwork_template']} }] ) return True def get_form_template(name_long: str = None, external_version: str = None)-
Load a form template from the backend based on name and version.
Expand source code
def get_form_template(name_long:str=None, external_version:str=None): """Load a form template from the backend based on name and version.""" cmd = 'select pk from ref.paperwork_templates where name_long = %(lname)s and external_version = %(ver)s' args = {'lname': name_long, 'ver': external_version} rows, idx = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': args}], get_col_idx = False) if len(rows) == 0: _log.error('cannot load form template [%s - %s]', name_long, external_version) return None return cFormTemplate(aPK_obj = rows[0]['pk']) def get_form_templates(engine=None, active_only=False, template_types=None, excluded_types=None, return_pks=False)-
Load form templates.
Expand source code
def get_form_templates(engine=None, active_only=False, template_types=None, excluded_types=None, return_pks=False): """Load form templates.""" args = {'eng': engine, 'in_use': active_only} where_parts = ['1 = 1'] if engine is not None: where_parts.append('engine = %(eng)s') if active_only: where_parts.append('in_use IS true') if template_types is not None: args['incl_types'] = template_types where_parts.append('template_type = ANY(%(incl_types)s)') if excluded_types is not None: args['excl_types'] = excluded_types where_parts.append('template_type <> ALL(%(excl_types)s)') cmd = "SELECT * FROM ref.v_paperwork_templates WHERE %s ORDER BY in_use desc, name_long" % '\nAND '.join(where_parts) rows, idx = gmPG2.run_ro_queries ( queries = [{'cmd': cmd, 'args': args}], get_col_idx = True ) if return_pks: return [ r['pk_paperwork_template'] for r in rows ] templates = [ cFormTemplate(row = {'pk_field': 'pk_paperwork_template', 'data': r, 'idx': idx}) for r in rows ] return templates def init_ooo()-
FIXME: consider this:
try: import uno except Exception: print("This Script needs to be run with the python from OpenOffice.org") print ("Example: /opt/OpenOffice.org/program/python %s" % ( os.path.basename(sys.argv[0]))) print("Or you need to insert the right path at the top, where uno.py is.") print("Default: %s" % default_path)
Expand source code
def init_ooo(): """FIXME: consider this: try: import uno except Exception: print("This Script needs to be run with the python from OpenOffice.org") print ("Example: /opt/OpenOffice.org/program/python %s" % ( os.path.basename(sys.argv[0]))) print("Or you need to insert the right path at the top, where uno.py is.") print("Default: %s" % default_path) """ global uno if uno is not None: return try: import uno except ImportError: __configure_path_to_UNO() import uno global unohelper, oooXCloseListener, oooNoConnectException, oooPropertyValue import unohelper from com.sun.star.util import XCloseListener as oooXCloseListener from com.sun.star.connection import NoConnectException as oooNoConnectException from com.sun.star.beans import PropertyValue as oooPropertyValue #---------------------------------- class _cOOoDocumentCloseListener(unohelper.Base, oooXCloseListener): """Listens for events sent by OOo during the document closing sequence and notifies the GNUmed client GUI so it can import the closed document into the database. """ def __init__(self, document=None): self.document = document def queryClosing(self, evt, owner): # owner is True/False whether I am the owner of the doc pass def notifyClosing(self, evt): pass def disposing(self, evt): self.document.on_disposed_by_ooo() self.document = None #---------------------------------- global cOOoDocumentCloseListener cOOoDocumentCloseListener = _cOOoDocumentCloseListener # search for writer binary global writer_binary found, binary = gmShellAPI.find_first_binary(binaries = [ 'lowriter', 'oowriter', 'swriter' ]) if found: _log.debug('OOo/LO writer binary found: %s', binary) writer_binary = binary else: _log.debug('OOo/LO writer binary NOT found') raise ImportError('LibreOffice/OpenOffice (lowriter/oowriter/swriter) not found') _log.debug('python UNO bridge successfully initialized')
Classes
class FormError (value)-
Common base class for all non-exit exceptions.
Expand source code
class FormError (Exception): def __init__ (self, value): self.value = value def __str__ (self): return repr (self.value)Ancestors
- builtins.Exception
- builtins.BaseException
class LaTeXFilter-
Expand source code
class LaTeXFilter: def conv_enc(self, item, table_sep= " \\\\\n", **kwds): """ Convience function to escape ISO-Latin-1 strings for TeX output WARNING: not all ISO-Latin-1 characters are expressible in TeX FIXME: nevertheless, there are a few more we could support Also intelligently convert lists and tuples into TeX-style table lines """ if type(item) is str: item = item.replace ("\\", "\\backslash") # I wonder about this, do we want users to be able to use raw TeX? item = item.replace ("&", "\\&") item = item.replace ("$", "\\$") item = item.replace ('"', "") # okay, that's not right, but easiest solution for now item = item.replace ("\n", "\\\\ ") if len (item.strip ()) == 0: item = "\\relax " # sometimes TeX really hates empty strings, this seems to mollify it # FIXME: cover all of ISO-Latin-1 which can be expressed in TeX item = item.encode ('latin-1', 'replace') trans = {'ß':'\\ss{}', 'ä': '\\"{a}', 'Ä' :'\\"{A}', 'ö': '\\"{o}', 'Ö': '\\"{O}', 'ü': '\\"{u}', 'Ü': '\\"{U}', '\x8a':'\\v{S}', #'\x8a':'\\OE{}', '\x9a':'\\v{s}', '\x9c': '\\oe{}', '\a9f':'\\"{Y}', #Microsloth extensions '\x86': '{\\dag}', '\x87': '{\\ddag}', '\xa7':'{\\S}', '\xb6': '{\\P}', '\xa9': '{\\copyright}', '\xbf': '?`', '\xc0':'\\`{A}', '\xa1': "\\'{A}", #'\xa1': '!`', '\xa2': '\\^{A}', #'\xa2':'cent' #'\xa3':'\\~{A}', '\xa3': '\pounds{}', '\\xc5': '{\AA}', '\xc7':'\\c{C}', '\xc8':'\\`{E}', '\xb5':'$\mu$', } for k, i in trans.items (): item = item.replace (k, i) elif type(item) is list or type(item) is tuple: item = table_sep.join ([self.conv_enc(i, ' & ') for i in item]) elif item is None: item = '\\relax % Python None\n' elif type(item) is int or type(item) is float: item = str(item) else: item = str(item) _log.warning("unknown type %s, string %s" % (type(item), item)) return itemMethods
def conv_enc(self, item, table_sep=' \\\\\n', **kwds)-
Convience function to escape ISO-Latin-1 strings for TeX output WARNING: not all ISO-Latin-1 characters are expressible in TeX FIXME: nevertheless, there are a few more we could support
Also intelligently convert lists and tuples into TeX-style table lines
Expand source code
def conv_enc(self, item, table_sep= " \\\\\n", **kwds): """ Convience function to escape ISO-Latin-1 strings for TeX output WARNING: not all ISO-Latin-1 characters are expressible in TeX FIXME: nevertheless, there are a few more we could support Also intelligently convert lists and tuples into TeX-style table lines """ if type(item) is str: item = item.replace ("\\", "\\backslash") # I wonder about this, do we want users to be able to use raw TeX? item = item.replace ("&", "\\&") item = item.replace ("$", "\\$") item = item.replace ('"', "") # okay, that's not right, but easiest solution for now item = item.replace ("\n", "\\\\ ") if len (item.strip ()) == 0: item = "\\relax " # sometimes TeX really hates empty strings, this seems to mollify it # FIXME: cover all of ISO-Latin-1 which can be expressed in TeX item = item.encode ('latin-1', 'replace') trans = {'ß':'\\ss{}', 'ä': '\\"{a}', 'Ä' :'\\"{A}', 'ö': '\\"{o}', 'Ö': '\\"{O}', 'ü': '\\"{u}', 'Ü': '\\"{U}', '\x8a':'\\v{S}', #'\x8a':'\\OE{}', '\x9a':'\\v{s}', '\x9c': '\\oe{}', '\a9f':'\\"{Y}', #Microsloth extensions '\x86': '{\\dag}', '\x87': '{\\ddag}', '\xa7':'{\\S}', '\xb6': '{\\P}', '\xa9': '{\\copyright}', '\xbf': '?`', '\xc0':'\\`{A}', '\xa1': "\\'{A}", #'\xa1': '!`', '\xa2': '\\^{A}', #'\xa2':'cent' #'\xa3':'\\~{A}', '\xa3': '\pounds{}', '\\xc5': '{\AA}', '\xc7':'\\c{C}', '\xc8':'\\`{E}', '\xb5':'$\mu$', } for k, i in trans.items (): item = item.replace (k, i) elif type(item) is list or type(item) is tuple: item = table_sep.join ([self.conv_enc(i, ' & ') for i in item]) elif item is None: item = '\\relax % Python None\n' elif type(item) is int or type(item) is float: item = str(item) else: item = str(item) _log.warning("unknown type %s, string %s" % (type(item), item)) return item
class cAbiWordForm (template_file=None)-
A forms engine wrapping AbiWord.
Expand source code
class cAbiWordForm(cFormEngine): """A forms engine wrapping AbiWord.""" placeholder_regex = r'\$<.+?>\$' def __init__(self, template_file=None): super().__init__(template_file = template_file) # detect abiword found, self.abiword_binary = gmShellAPI.detect_external_binary(binary = r'abiword') if not found: raise ImportError('<abiword(.exe)> not found') #-------------------------------------------------------- def substitute_placeholders(self, data_source=None): # should *actually* properly parse the XML path, ext = os.path.splitext(self.template_filename) if ext in [r'', r'.']: ext = r'.abw' self.instance_filename = r'%s-instance%s' % (path, ext) template_file = io.open(self.template_filename, mode = 'rt', encoding = 'utf-8-sig') instance_file = io.open(self.instance_filename, mode = 'wt', encoding = 'utf8') if self.template: # pylint: disable=unsubscriptable-object # inject placeholder values data_source.set_placeholder('form_name_long', self.template['name_long']) data_source.set_placeholder('form_name_short', self.template['name_short']) data_source.set_placeholder('form_version', self.template['external_version']) data_source.set_placeholder('form_version_internal', gmTools.coalesce(self.template['gnumed_revision'], '', '%s')) data_source.set_placeholder('form_last_modified', gmDateTime.pydt_strftime(self.template['last_modified'], '%Y-%b-%d %H:%M')) data_source.escape_style = 'xml' data_source.escape_function = None # gmTools.xml_escape_text() ? for line in template_file: if line.strip() in ['', '\r', '\n', '\r\n']: instance_file.write(line) continue # 1) find placeholders in this line placeholders_in_line = regex.findall(cAbiWordForm.placeholder_regex, line, regex.IGNORECASE) # 2) and replace them for placeholder in placeholders_in_line: try: val = data_source[placeholder.replace('<', '<').replace('>', '>')] except Exception: val = _('error with placeholder [%s]') % gmTools.xml_escape_string(placeholder) _log.exception(val) if val is None: val = _('error with placeholder [%s]') % gmTools.xml_escape_string(placeholder) line = line.replace(placeholder, val) instance_file.write(line) instance_file.close() template_file.close() if self.template is not None: # remove temporary placeholders data_source.unset_placeholder('form_name_long') data_source.unset_placeholder('form_name_short') data_source.unset_placeholder('form_version') data_source.unset_placeholder('form_version_internal') data_source.unset_placeholder('form_last_modified') return #-------------------------------------------------------- def edit(self): enc = sys.getfilesystemencoding() cmd = (r'%s %s' % (self.abiword_binary, self.instance_filename.encode(enc))).encode(enc) result = gmShellAPI.run_command_in_shell(command = cmd, blocking = True) self.re_editable_filenames = [self.instance_filename] return result #-------------------------------------------------------- def generate_output(self, instance_file=None, format=None): if instance_file is None: instance_file = self.instance_filename try: open(instance_file, 'r').close() except Exception: _log.exception('cannot access form instance file [%s]', instance_file) gmLog2.log_stack_trace() return None self.instance_filename = instance_file _log.debug('ignoring <format> directive [%s], generating PDF', format) pdf_name = os.path.splitext(self.instance_filename)[0] + '.pdf' cmd = '%s --to=pdf --to-name=%s %s' % ( self.abiword_binary, pdf_name, self.instance_filename ) if not gmShellAPI.run_command_in_shell(command = cmd, blocking = True): _log.error('problem running abiword, cannot generate form output') gmDispatcher.send(signal = 'statustext', msg = _('Error running AbiWord. Cannot generate PDF.'), beep = True) return None self.final_output_filenames = [pdf_name] return pdf_nameAncestors
Class variables
var placeholder_regex
Inherited members
class cFormEngine (template_file=None)-
Ancestor for forms.
Expand source code
class cFormEngine(object): """Ancestor for forms.""" def __init__(self, template_file=None): self.template = None self.template_filename = template_file _log.debug('working on template file [%s]', self.template_filename) #-------------------------------------------------------- def substitute_placeholders(self, data_source=None): """Parse the template into an instance and replace placeholders with values.""" raise NotImplementedError #-------------------------------------------------------- def edit(self): """Allow editing the instance of the template.""" raise NotImplementedError #-------------------------------------------------------- def generate_output(self, format=None): """Generate output suitable for further processing outside this class, e.g. printing.""" raise NotImplementedError #-------------------------------------------------------- #--------------------------------------------------------Subclasses
- cAbiWordForm
- cGnuplotForm
- cHL7Form
- cLaTeXForm
- cOOoForm
- cPDFForm
- cTextForm
- cXSLTFormEngine
- cXeTeXForm
Methods
def edit(self)-
Allow editing the instance of the template.
Expand source code
def edit(self): """Allow editing the instance of the template.""" raise NotImplementedError def generate_output(self, format=None)-
Generate output suitable for further processing outside this class, e.g. printing.
Expand source code
def generate_output(self, format=None): """Generate output suitable for further processing outside this class, e.g. printing.""" raise NotImplementedError def substitute_placeholders(self, data_source=None)-
Parse the template into an instance and replace placeholders with values.
Expand source code
def substitute_placeholders(self, data_source=None): """Parse the template into an instance and replace placeholders with values.""" raise NotImplementedError
class cFormTemplate (aPK_obj: int | dict = None, row: dict = None, link_obj=None)-
Represents a template from which forms/printouts can be generated.
To create a processable document from a template call .instantiate() and do further processing on the resulting form instance.
Call init from child classes like so:
super().__init__(aPK_obj = aPK_obj, row = row, link_obj = link_obj)Args
aPK_obj- retrieve data from backend
- a simple value the primary key WHERE condition must be a simple column
- a dictionary of values the primary key WHERE condition must be a subselect consuming the dict and producing the single-value primary key
row- must hold the fields
- idx: a dict mapping field names to position
- data: the field values in a list (as returned by cursor.fetchone() in the DB-API)
- pk_field: the name of the primary key field OR
- pk_obj: a dictionary suitable for passed to cursor.execute and holding the primary key values, used for composite PKs
- for example:
row = { 'data': rows[0], 'idx': idx, 'pk_field': 'pk_XXX (the PK column name)', 'pk_obj': {'pk_col1': pk_col1_val, 'pk_col2': pk_col2_val} } rows, idx = gmPG2.run_ro_queries(queries = [{'cmd': cmd, 'args': args}], get_col_idx = True) objects = [ cChildClass(row = {'data': r, 'idx': idx, 'pk_field': 'the PK column name'}) for r in rows ]
Expand source code
class cFormTemplate(gmBusinessDBObject.cBusinessDBObject): """Represents a template from which forms/printouts can be generated. To create a processable document from a template call .instantiate() and do further processing on the resulting form instance. """ _cmd_fetch_payload = 'SELECT * FROM ref.v_paperwork_templates WHERE pk_paperwork_template = %s' _cmds_store_payload = [ """UPDATE ref.paperwork_templates SET name_short = %(name_short)s, name_long = %(name_long)s, fk_template_type = %(pk_template_type)s, instance_type = %(instance_type)s, engine = %(engine)s, in_use = %(in_use)s, edit_after_substitution = %(edit_after_substitution)s, filename = %(filename)s, external_version = %(external_version)s WHERE pk = %(pk_paperwork_template)s AND xmin = %(xmin_paperwork_template)s RETURNING xmin AS xmin_paperwork_template """ ] _updatable_fields = [ 'name_short', 'name_long', 'external_version', 'pk_template_type', 'instance_type', 'engine', 'in_use', 'filename', 'edit_after_substitution' ] _suffix4engine = { 'O': '.ott', 'L': '.tex', 'T': '.txt', 'X': '.xslt', 'I': '.img', 'P': '.pdf', 'G': '.gpl' } #-------------------------------------------------------- def _get_template_data(self): """Return the data that makes up the actual template itself. This is typically a text string containing markup specific to a given document definition interspersed with placeholders to be processed by GNUmed. Note that the template may often not (yet) be valid for the target document engine because it usually contains placeholders interspersed with the layout definition. """ cmd = 'SELECT data FROM ref.paperwork_templates WHERE pk = %(pk)s' rows, idx = gmPG2.run_ro_queries (queries = [{'cmd': cmd, 'args': {'pk': self.pk_obj}}], get_col_idx = False) if len(rows) == 0: raise gmExceptions.NoSuchBusinessObjectError('cannot retrieve data for template pk = %s' % self.pk_obj) return rows[0][0] template_data = property(_get_template_data) #-------------------------------------------------------- def save_to_file(self, filename:str=None, chunksize:int=0, use_sandbox:bool=False) -> str: """Export actual form template definition into a file. Note that this file may often not (yet) be valid for the target document engine because it usually contains placeholders interspersed with the layout definition. Args: filename: an explicit filename to save to, a suitable one is generated if None use_sandbox: instantiate in a sandbox directory, unless a filename is given Returns: The name of the file that was saved into. None on failure. """ if not self._payload['has_template_data']: _log.error('no template data') return None if filename is None: if use_sandbox: sandbox_dir = gmTools.mk_sandbox_dir(prefix = 'gm2%s-' % self._payload[self._idx['engine']]) else: sandbox_dir = None if self._payload[self._idx['filename']] is None: suffix = self.__class__._suffix4engine[self._payload[self._idx['engine']]] else: suffix = os.path.splitext(self._payload[self._idx['filename']].strip())[1].strip() if suffix in ['', '.']: suffix = self.__class__._suffix4engine[self._payload[self._idx['engine']]] filename = gmTools.get_unique_filename ( prefix = 'gm-%s-Template-' % self._payload[self._idx['engine']], suffix = suffix, tmp_dir = sandbox_dir ) data_query = { 'cmd': 'SELECT substring(data from %(start)s for %(size)s) FROM ref.paperwork_templates WHERE pk = %(pk)s', 'args': {'pk': self.pk_obj} } data_size_query = { 'cmd': 'select octet_length(data) from ref.paperwork_templates where pk = %(pk)s', 'args': {'pk': self.pk_obj} } result = gmPG2.bytea2file ( data_query = data_query, filename = filename, data_size_query = data_size_query, chunk_size = chunksize ) if result is False: return None return filename #-------------------------------------------------------- def update_template_from_file(self, filename:str=None): """Update the template definition in the database. Args: filename: the filename to read the template definition from """ gmPG2.file2bytea ( filename = filename, query = 'update ref.paperwork_templates set data = %(data)s::bytea where pk = %(pk)s and xmin = %(xmin)s', args = {'pk': self.pk_obj, 'xmin': self._payload[self._idx['xmin_paperwork_template']]} ) # adjust for xmin change return self.refetch_payload() #-------------------------------------------------------- def instantiate(self, use_sandbox:bool=False): """Create an instance of this form template for further processing. This saves the template data to a file, and from that creates a form instances, specific to the text processing engine defined for this template. Invoke methods of the form instance for further processing (placeholder substitution, PDF generation, ...) Args: use_sandbox: instantiate in a sandbox directory Returns: A form instance or None on failure. """ fname = self.save_to_file(use_sandbox = use_sandbox) if not fname: return None engine = form_engines[self._payload[self._idx['engine']]] form = engine(template_file = fname) form.template = self return formAncestors
Instance variables
var template_data-
Return the data that makes up the actual template itself.
This is typically a text string containing markup specific to a given document definition interspersed with placeholders to be processed by GNUmed.
Note that the template may often not (yet) be valid for the target document engine because it usually contains placeholders interspersed with the layout definition.
Expand source code
def _get_template_data(self): """Return the data that makes up the actual template itself. This is typically a text string containing markup specific to a given document definition interspersed with placeholders to be processed by GNUmed. Note that the template may often not (yet) be valid for the target document engine because it usually contains placeholders interspersed with the layout definition. """ cmd = 'SELECT data FROM ref.paperwork_templates WHERE pk = %(pk)s' rows, idx = gmPG2.run_ro_queries (queries = [{'cmd': cmd, 'args': {'pk': self.pk_obj}}], get_col_idx = False) if len(rows) == 0: raise gmExceptions.NoSuchBusinessObjectError('cannot retrieve data for template pk = %s' % self.pk_obj) return rows[0][0]
Methods
def instantiate(self, use_sandbox: bool = False)-
Create an instance of this form template for further processing.
This saves the template data to a file, and from that creates a form instances, specific to the text processing engine defined for this template. Invoke methods of the form instance for further processing (placeholder substitution, PDF generation, ...)Args
use_sandbox- instantiate in a sandbox directory
Returns
A form instance or None on failure.
Expand source code
def instantiate(self, use_sandbox:bool=False): """Create an instance of this form template for further processing. This saves the template data to a file, and from that creates a form instances, specific to the text processing engine defined for this template. Invoke methods of the form instance for further processing (placeholder substitution, PDF generation, ...) Args: use_sandbox: instantiate in a sandbox directory Returns: A form instance or None on failure. """ fname = self.save_to_file(use_sandbox = use_sandbox) if not fname: return None engine = form_engines[self._payload[self._idx['engine']]] form = engine(template_file = fname) form.template = self return form def save_to_file(self, filename: str = None, chunksize: int = 0, use_sandbox: bool = False) ‑> str-
Export actual form template definition into a file.
Note that this file may often not (yet) be valid for the target document engine because it usually contains placeholders interspersed with the layout definition.Args
filename- an explicit filename to save to, a suitable one is generated if None
use_sandbox- instantiate in a sandbox directory, unless a filename is given
Returns
The name of the file that was saved into. None on failure.
Expand source code
def save_to_file(self, filename:str=None, chunksize:int=0, use_sandbox:bool=False) -> str: """Export actual form template definition into a file. Note that this file may often not (yet) be valid for the target document engine because it usually contains placeholders interspersed with the layout definition. Args: filename: an explicit filename to save to, a suitable one is generated if None use_sandbox: instantiate in a sandbox directory, unless a filename is given Returns: The name of the file that was saved into. None on failure. """ if not self._payload['has_template_data']: _log.error('no template data') return None if filename is None: if use_sandbox: sandbox_dir = gmTools.mk_sandbox_dir(prefix = 'gm2%s-' % self._payload[self._idx['engine']]) else: sandbox_dir = None if self._payload[self._idx['filename']] is None: suffix = self.__class__._suffix4engine[self._payload[self._idx['engine']]] else: suffix = os.path.splitext(self._payload[self._idx['filename']].strip())[1].strip() if suffix in ['', '.']: suffix = self.__class__._suffix4engine[self._payload[self._idx['engine']]] filename = gmTools.get_unique_filename ( prefix = 'gm-%s-Template-' % self._payload[self._idx['engine']], suffix = suffix, tmp_dir = sandbox_dir ) data_query = { 'cmd': 'SELECT substring(data from %(start)s for %(size)s) FROM ref.paperwork_templates WHERE pk = %(pk)s', 'args': {'pk': self.pk_obj} } data_size_query = { 'cmd': 'select octet_length(data) from ref.paperwork_templates where pk = %(pk)s', 'args': {'pk': self.pk_obj} } result = gmPG2.bytea2file ( data_query = data_query, filename = filename, data_size_query = data_size_query, chunk_size = chunksize ) if result is False: return None return filename def update_template_from_file(self, filename: str = None)-
Update the template definition in the database.
Args
filename- the filename to read the template definition from
Expand source code
def update_template_from_file(self, filename:str=None): """Update the template definition in the database. Args: filename: the filename to read the template definition from """ gmPG2.file2bytea ( filename = filename, query = 'update ref.paperwork_templates set data = %(data)s::bytea where pk = %(pk)s and xmin = %(xmin)s', args = {'pk': self.pk_obj, 'xmin': self._payload[self._idx['xmin_paperwork_template']]} ) # adjust for xmin change return self.refetch_payload()
Inherited members
class cFormTemplateNameLong_MatchProvider-
Match provider which searches matches in possibly several database tables.
queries: - a list of unicode strings - each string is a query - each string must contain: "… WHERE
%(fragment_condition)s …" - each string can contain in the where clause: "… %( )s …" - each query must return (data, list_label, field_label) context definitions to be used in the queries, example: {'ctxt_key1': {'where_part': 'AND country = %(country)s', 'placeholder': 'country'}}
client code using .set_context() must use the 'placeholder':
/ .set_context('country', 'Germany') full example query:
query = u" " " SELECT DISTINCT ON (list_label) pk_encounter AS data, to_char(started, 'YYYY Mon DD (HH24:MI)') || ': ' || l10n_type || ' [#' || pk_encounter || ']' AS list_label, to_char(started, 'YYYY Mon DD') || ': ' || l10n_type AS field_label FROM clin.v_pat_encounters WHERE ( l10n_type %(fragment_condition)s OR type %(fragment_condition)s ) %(ctxt_patient)s ORDER BY list_label LIMIT 30 " " " context = {'ctxt_patient': { 'where_part': u'AND pk_patient = %(PLACEHOLDER)s', 'placeholder': u'PLACEHOLDER' }} self.mp = gmMatchProvider.cMatchProvider_SQL2(queries = query, context = context) self.set_context(context = 'PLACEHOLDER', val = '<THE VALUE>')_SQL_data2match: SQL to retrieve a match by, say, primary key wherein the only keyword argument is 'pk'
Expand source code
class cFormTemplateNameLong_MatchProvider(gmMatchProvider.cMatchProvider_SQL2): def __init__(self): query = """ SELECT name_long AS data, name_long AS list_label, name_long AS field_label FROM ref.v_paperwork_templates WHERE name_long %(fragment_condition)s ORDER BY list_label """ gmMatchProvider.cMatchProvider_SQL2.__init__(self, queries = [query])Ancestors
Inherited members
class cFormTemplateNameShort_MatchProvider-
Match provider which searches matches in possibly several database tables.
queries: - a list of unicode strings - each string is a query - each string must contain: "… WHERE
%(fragment_condition)s …" - each string can contain in the where clause: "… %( )s …" - each query must return (data, list_label, field_label) context definitions to be used in the queries, example: {'ctxt_key1': {'where_part': 'AND country = %(country)s', 'placeholder': 'country'}}
client code using .set_context() must use the 'placeholder':
/ .set_context('country', 'Germany') full example query:
query = u" " " SELECT DISTINCT ON (list_label) pk_encounter AS data, to_char(started, 'YYYY Mon DD (HH24:MI)') || ': ' || l10n_type || ' [#' || pk_encounter || ']' AS list_label, to_char(started, 'YYYY Mon DD') || ': ' || l10n_type AS field_label FROM clin.v_pat_encounters WHERE ( l10n_type %(fragment_condition)s OR type %(fragment_condition)s ) %(ctxt_patient)s ORDER BY list_label LIMIT 30 " " " context = {'ctxt_patient': { 'where_part': u'AND pk_patient = %(PLACEHOLDER)s', 'placeholder': u'PLACEHOLDER' }} self.mp = gmMatchProvider.cMatchProvider_SQL2(queries = query, context = context) self.set_context(context = 'PLACEHOLDER', val = '<THE VALUE>')_SQL_data2match: SQL to retrieve a match by, say, primary key wherein the only keyword argument is 'pk'
Expand source code
class cFormTemplateNameShort_MatchProvider(gmMatchProvider.cMatchProvider_SQL2): def __init__(self): query = """ SELECT name_short AS data, name_short AS list_label, name_short AS field_label FROM ref.v_paperwork_templates WHERE name_short %(fragment_condition)s ORDER BY name_short """ gmMatchProvider.cMatchProvider_SQL2.__init__(self, queries = [query])Ancestors
Inherited members
class cFormTemplateType_MatchProvider-
Match provider which searches matches in possibly several database tables.
queries: - a list of unicode strings - each string is a query - each string must contain: "… WHERE
%(fragment_condition)s …" - each string can contain in the where clause: "… %( )s …" - each query must return (data, list_label, field_label) context definitions to be used in the queries, example: {'ctxt_key1': {'where_part': 'AND country = %(country)s', 'placeholder': 'country'}}
client code using .set_context() must use the 'placeholder':
/ .set_context('country', 'Germany') full example query:
query = u" " " SELECT DISTINCT ON (list_label) pk_encounter AS data, to_char(started, 'YYYY Mon DD (HH24:MI)') || ': ' || l10n_type || ' [#' || pk_encounter || ']' AS list_label, to_char(started, 'YYYY Mon DD') || ': ' || l10n_type AS field_label FROM clin.v_pat_encounters WHERE ( l10n_type %(fragment_condition)s OR type %(fragment_condition)s ) %(ctxt_patient)s ORDER BY list_label LIMIT 30 " " " context = {'ctxt_patient': { 'where_part': u'AND pk_patient = %(PLACEHOLDER)s', 'placeholder': u'PLACEHOLDER' }} self.mp = gmMatchProvider.cMatchProvider_SQL2(queries = query, context = context) self.set_context(context = 'PLACEHOLDER', val = '<THE VALUE>')_SQL_data2match: SQL to retrieve a match by, say, primary key wherein the only keyword argument is 'pk'
Expand source code
class cFormTemplateType_MatchProvider(gmMatchProvider.cMatchProvider_SQL2): def __init__(self): query = """ SELECT DISTINCT ON (list_label) pk AS data, _(name) || ' (' || name || ')' AS list_label, _(name) AS field_label FROM ref.form_types WHERE _(name) %(fragment_condition)s OR name %(fragment_condition)s ORDER BY list_label """ gmMatchProvider.cMatchProvider_SQL2.__init__(self, queries = [query])Ancestors
Inherited members
class cGnuplotForm (template_file=None)-
A forms engine wrapping Gnuplot.
Expand source code
class cGnuplotForm(cFormEngine): """A forms engine wrapping Gnuplot.""" #-------------------------------------------------------- def __init__(self, template_file=None): super().__init__(template_file = template_file) self.__data_filename = None #-------------------------------------------------------- def substitute_placeholders(self, data_source=None): """Parse the template into an instance and replace placeholders with values.""" pass #-------------------------------------------------------- def edit(self): """Allow editing the instance of the template.""" self.re_editable_filenames = [] return True #-------------------------------------------------------- def generate_output(self, format=None): """Generate output suitable for further processing outside this class, e.g. printing. Expects .data_filename to be set. """ assert self.__data_filename, '.data_filename must be set' # append some metadata for debugging, if available if self.template: f = open(self.template_filename, 'at', encoding = 'utf8') f.write('\n') f.write('# -- metadata ----------------------------------------------------------------\n') for line in self.template.format(): f.write('# %s\n' % line) f.write('# ----------------------------------------------------------------------------\n') f.close() wrapper_filename = gmTools.get_unique_filename ( prefix = 'gm2gpl-wrapper-', suffix = '.gpl', tmp_dir = gmTools.fname_dir(self.__data_filename) ) wrapper_script = io.open(wrapper_filename, mode = 'wt', encoding = 'utf8') wrapper_script.write(_GNUPLOT_WRAPPER_SCRIPT % ( gmTools.bool2subst(_cfg.get(option = 'debug'), '1', '0', '0'), self.__data_filename, self.template_filename )) wrapper_script.close() # FIXME: cater for configurable path if platform.system() == 'Windows': exec_name = 'gnuplot.exe' else: exec_name = 'gnuplot' cmd_line = [ exec_name, '-p', # persist plot window after gnuplot exits (in case the wxt terminal is used) wrapper_filename ] success, exit_code, stdout = gmShellAPI.run_process(cmd_line = cmd_line, encoding = 'utf8', verbose = _cfg.get(option = 'debug')) if not success: gmDispatcher.send(signal = 'statustext', msg = _('Error running gnuplot. Cannot plot data.'), beep = True) return False self.final_output_filenames = [ self.__data_filename, self.template_filename, wrapper_filename ] return True #-------------------------------------------------------- # properties #-------------------------------------------------------- def _set_data_filename(self, data_filename): try: open(data_filename, 'r').close() except FileNotFoundError: _log.error('cannot open [%s]', data_filename) return self.__data_filename = data_filename data_filename = property(fset = _set_data_filename)Ancestors
Instance variables
var data_filename
Methods
def generate_output(self, format=None)-
Generate output suitable for further processing outside this class, e.g. printing.
Expects .data_filename to be set.
Expand source code
def generate_output(self, format=None): """Generate output suitable for further processing outside this class, e.g. printing. Expects .data_filename to be set. """ assert self.__data_filename, '.data_filename must be set' # append some metadata for debugging, if available if self.template: f = open(self.template_filename, 'at', encoding = 'utf8') f.write('\n') f.write('# -- metadata ----------------------------------------------------------------\n') for line in self.template.format(): f.write('# %s\n' % line) f.write('# ----------------------------------------------------------------------------\n') f.close() wrapper_filename = gmTools.get_unique_filename ( prefix = 'gm2gpl-wrapper-', suffix = '.gpl', tmp_dir = gmTools.fname_dir(self.__data_filename) ) wrapper_script = io.open(wrapper_filename, mode = 'wt', encoding = 'utf8') wrapper_script.write(_GNUPLOT_WRAPPER_SCRIPT % ( gmTools.bool2subst(_cfg.get(option = 'debug'), '1', '0', '0'), self.__data_filename, self.template_filename )) wrapper_script.close() # FIXME: cater for configurable path if platform.system() == 'Windows': exec_name = 'gnuplot.exe' else: exec_name = 'gnuplot' cmd_line = [ exec_name, '-p', # persist plot window after gnuplot exits (in case the wxt terminal is used) wrapper_filename ] success, exit_code, stdout = gmShellAPI.run_process(cmd_line = cmd_line, encoding = 'utf8', verbose = _cfg.get(option = 'debug')) if not success: gmDispatcher.send(signal = 'statustext', msg = _('Error running gnuplot. Cannot plot data.'), beep = True) return False self.final_output_filenames = [ self.__data_filename, self.template_filename, wrapper_filename ] return True
Inherited members
class cHL7Form (template_file=None)-
Ancestor for forms.
Expand source code
class cHL7Form (cFormEngine): passAncestors
Inherited members
class cLaTeXForm (template_file=None)-
A forms engine wrapping LaTeX (pdflatex).
Expand source code
class cLaTeXForm(cFormEngine): """A forms engine wrapping LaTeX (pdflatex).""" _version_checked = False _mimetypes = [ 'application/x-latex', 'application/x-tex', 'text/latex', 'text/tex', 'text/x-tex', 'text/plain' ] def __init__(self, template_file=None): # create sandbox for LaTeX to play in (and don't assume # much of anything about the template_file except that it # is at our disposal for reading) sandbox_dir = gmTools.mk_sandbox_dir(prefix = gmTools.fname_stem(template_file) + '_') _log.debug('LaTeX sandbox directory: [%s]', sandbox_dir) shutil.copy(template_file, sandbox_dir) template_file = os.path.join(sandbox_dir, os.path.split(template_file)[1]) super().__init__(template_file = template_file) self.__sandbox_dir = sandbox_dir #-------------------------------------------------------- def _rst2latex_transform(self, text): # remove extra linefeeds which the docutils ReST2LaTeX # converter likes to add but which makes pdflatex go # crazy when ending up inside KOMAScript variables return gmTools.rst2latex_snippet(text).strip() #-------------------------------------------------------- def substitute_placeholders(self, data_source=None): # debugging #data_source.debug = True if self.template: # pylint: disable=unsubscriptable-object # inject placeholder values data_source.set_placeholder('form_name_long', self.template['name_long']) data_source.set_placeholder('form_name_short', self.template['name_short']) data_source.set_placeholder('form_version', self.template['external_version']) data_source.set_placeholder('form_version_internal', gmTools.coalesce(self.template['gnumed_revision'], '', '%s')) data_source.set_placeholder('form_last_modified', gmDateTime.pydt_strftime(self.template['last_modified'], '%Y-%b-%d %H:%M')) # add site-local identifying information to template for debugging f = open(self.template_filename, 'at', encoding = 'utf8') f.write('\n') f.write('%------------------------------------------------------------------\n') for line in self.template.format(): f.write('% ') f.write(line) f.write('\n') f.write('%------------------------------------------------------------------\n') f.close() data_source.escape_function = gmTools.tex_escape_string data_source.escape_style = 'latex' path, ext = os.path.splitext(self.template_filename) if ext in [r'', r'.']: ext = r'.tex' filenames = [ self.template_filename, r'%s-result-pass-1%s' % (path, ext), r'%s-result-pass-2%s' % (path, ext), r'%s-result-pass-3%s' % (path, ext), r'%s-result-pass-4%s' % (path, ext), r'%s-result-pass-5%s' % (path, ext) ] regexen = [ 'dummy', r'\$1{0,1}<[^<].+?>1{0,1}\$', r'\$2<[^<].+?>2\$', r'\$3<[^<].+?>3\$', r'\$4<[^<].+?>4\$', r'\$5<[^<].+?>5\$' ] current_pass = 1 while current_pass < 6: _log.debug('placeholder substitution pass #%s', current_pass) self.__substitute_placeholders ( input_filename = filenames[current_pass-1], output_filename = filenames[current_pass], data_source = data_source, placeholder_regex = regexen[current_pass] ) current_pass += 1 # remove temporary placeholders data_source.unset_placeholder('form_name_long') data_source.unset_placeholder('form_name_short') data_source.unset_placeholder('form_version') data_source.unset_placeholder('form_version_internal') data_source.unset_placeholder('form_last_modified') self.instance_filename = self.re_editable_filenames[0] return #-------------------------------------------------------- def __substitute_placeholders(self, data_source=None, input_filename=None, output_filename=None, placeholder_regex=None): _log.debug('[%s] -> [%s]', input_filename, output_filename) _log.debug('searching for placeholders with pattern: %s', placeholder_regex) template_file = io.open(input_filename, mode = 'rt', encoding = 'utf-8-sig') instance_file = io.open(output_filename, mode = 'wt', encoding = 'utf8') for line in template_file: # empty lines if line.strip() in ['', '\r', '\n', '\r\n']: instance_file.write(line) continue # TeX-comment-only lines if line.lstrip().startswith('%'): instance_file.write(line) continue # 1) find placeholders in this line placeholders_in_line = regex.findall(placeholder_regex, line, regex.IGNORECASE) if len(placeholders_in_line) == 0: instance_file.write(line) continue # 2) replace them _log.debug('replacing in non-empty, non-comment line: >>>%s<<<', line.rstrip(u'\n')) _log.debug('%s placeholder(s) detected', len(placeholders_in_line)) for placeholder in placeholders_in_line: if 'free_text' in placeholder: # enable reStructuredText processing data_source.escape_function = self._rst2latex_transform else: data_source.escape_function = gmTools.tex_escape_string original_ph_def = placeholder _log.debug('placeholder: >>>%s<<<', original_ph_def) # normalize start/end if placeholder.startswith('$<'): placeholder = '$1<' + placeholder[2:] if placeholder.endswith('>$'): placeholder = placeholder[:-2] + '>1$' _log.debug('normalized : >>>%s<<<', placeholder) # remove start/end placeholder = placeholder[3:-3] _log.debug('stripped : >>>%s<<<', placeholder) try: val = data_source[placeholder] except Exception: _log.exception('error with placeholder [%s]', original_ph_def) val = gmTools.tex_escape_string(_('error with placeholder [%s]') % original_ph_def) if val is None: _log.debug('error with placeholder [%s]', original_ph_def) val = gmTools.tex_escape_string(_('error with placeholder [%s]') % original_ph_def) _log.debug('value : >>>%s<<<', val) line = line.replace(original_ph_def, val) instance_file.write(line) instance_file.close() self.re_editable_filenames = [output_filename] template_file.close() return #-------------------------------------------------------- def edit(self) -> bool: """Call editor on generated LaTeX file. Checks for editors on mimetypes: %s """ % cLaTeXForm._mimetypes for mimetype in cLaTeXForm._mimetypes: editor_cmd = gmMimeLib.get_editor_cmd(mimetype, self.instance_filename) if editor_cmd is not None: break if editor_cmd is None: # LaTeX code is text: also consider text *viewers* # since pretty much any of them will be an editor as well for mimetype in cLaTeXForm._mimetypes: editor_cmd = gmMimeLib.get_viewer_cmd(mimetype, self.instance_filename) if editor_cmd is not None: break if editor_cmd is None: return False result = gmShellAPI.run_command_in_shell(command = editor_cmd, blocking = True) self.re_editable_filenames = [self.instance_filename] return result #-------------------------------------------------------- def generate_output(self, instance_file=None, format=None): if instance_file is None: instance_file = self.instance_filename try: open(instance_file, 'r').close() except Exception: _log.exception('cannot access form instance file [%s]', instance_file) gmLog2.log_stack_trace() return None self.instance_filename = instance_file _log.debug('ignoring <format> directive [%s], generating PDF', format) sandboxed_pdf_name = gmMimeLib.convert_latex_to_pdf ( filename = self.instance_filename, verbose = _cfg.get(option = 'debug'), is_sandboxed = True ) if sandboxed_pdf_name is None: return None target_dir = os.path.normpath(os.path.join(os.path.split(sandboxed_pdf_name)[0], '..')) final_pdf_name = os.path.join ( target_dir, os.path.split(sandboxed_pdf_name)[1] ) _log.debug('copying sandboxed PDF: %s -> %s', sandboxed_pdf_name, final_pdf_name) try: shutil.copy2(sandboxed_pdf_name, target_dir) except IOError: _log.exception('cannot open/move sandboxed PDF') gmDispatcher.send(signal = 'statustext', msg = _('PDF output file cannot be opened.'), beep = True) return None self.final_output_filenames = [final_pdf_name] return final_pdf_nameAncestors
Inherited members
class cOOoForm (template_file=None)-
A forms engine wrapping OOo.
Expand source code
class cOOoForm(cFormEngine): """A forms engine wrapping OOo.""" def __init__(self, template_file=None): super().__init__(template_file = template_file) path, ext = os.path.splitext(self.template_filename) if ext in [r'', r'.']: ext = r'.odt' self.instance_filename = r'%s-instance%s' % (path, ext)Ancestors
Inherited members
class cOOoLetter (template_file=None, instance_type=None)-
Expand source code
class cOOoLetter(object): def __init__(self, template_file=None, instance_type=None): self.template_file = template_file self.instance_type = instance_type self.ooo_doc = None #-------------------------------------------------------- # external API #-------------------------------------------------------- def open_in_ooo(self): # connect to OOo ooo_srv = gmOOoConnector() # open doc in OOo self.ooo_doc = ooo_srv.open_document(filename = self.template_file) if self.ooo_doc is None: _log.error('cannot open document in OOo') return False # listen for close events pat = gmPerson.gmCurrentPatient() pat.locked = True listener = cOOoDocumentCloseListener(document = self) self.ooo_doc.addCloseListener(listener) return True #-------------------------------------------------------- def show(self, visible=True): self.ooo_doc.CurrentController.Frame.ContainerWindow.setVisible(visible) #-------------------------------------------------------- def replace_placeholders(self, handler=None, old_style_too = True): # new style embedded, implicit placeholders searcher = self.ooo_doc.createSearchDescriptor() searcher.SearchCaseSensitive = False searcher.SearchRegularExpression = True searcher.SearchWords = True searcher.SearchString = handler.placeholder_regex placeholder_instance = self.ooo_doc.findFirst(searcher) while placeholder_instance is not None: try: val = handler[placeholder_instance.String] except Exception: val = _('error with placeholder [%s]') % placeholder_instance.String _log.exception(val) if val is None: val = _('error with placeholder [%s]') % placeholder_instance.String placeholder_instance.String = val placeholder_instance = self.ooo_doc.findNext(placeholder_instance.End, searcher) if not old_style_too: return # old style "explicit" placeholders text_fields = self.ooo_doc.getTextFields().createEnumeration() while text_fields.hasMoreElements(): text_field = text_fields.nextElement() # placeholder ? if not text_field.supportsService('com.sun.star.text.TextField.JumpEdit'): continue # placeholder of type text ? if text_field.PlaceHolderType != 0: continue replacement = handler[text_field.PlaceHolder] if replacement is None: continue text_field.Anchor.setString(replacement) #-------------------------------------------------------- def save_in_ooo(self, filename=None): if filename is not None: target_url = uno.systemPathToFileUrl(os.path.abspath(os.path.expanduser(filename))) save_args = ( oooPropertyValue('Overwrite', 0, True, 0), oooPropertyValue('FormatFilter', 0, 'swriter: StarOffice XML (Writer)', 0) ) # "store AS url" stores the doc, marks it unmodified and updates # the internal media descriptor - as opposed to "store TO url" self.ooo_doc.storeAsURL(target_url, save_args) else: self.ooo_doc.store() #-------------------------------------------------------- def close_in_ooo(self): self.ooo_doc.dispose() pat = gmPerson.gmCurrentPatient() pat.locked = False self.ooo_doc = None #-------------------------------------------------------- def on_disposed_by_ooo(self): # get current file name from OOo, user may have used Save As filename = uno.fileUrlToSystemPath(self.ooo_doc.URL) # tell UI to import the file gmDispatcher.send ( signal = 'import_document_from_file', filename = filename, document_type = self.instance_type, unlock_patient = True, pk_org_unit = gmPraxis.gmCurrentPraxisBranch()['pk_org_unit'] ) self.ooo_doc = None #-------------------------------------------------------- # internal helpers #--------------------------------------------------------Methods
def close_in_ooo(self)-
Expand source code
def close_in_ooo(self): self.ooo_doc.dispose() pat = gmPerson.gmCurrentPatient() pat.locked = False self.ooo_doc = None def on_disposed_by_ooo(self)-
Expand source code
def on_disposed_by_ooo(self): # get current file name from OOo, user may have used Save As filename = uno.fileUrlToSystemPath(self.ooo_doc.URL) # tell UI to import the file gmDispatcher.send ( signal = 'import_document_from_file', filename = filename, document_type = self.instance_type, unlock_patient = True, pk_org_unit = gmPraxis.gmCurrentPraxisBranch()['pk_org_unit'] ) self.ooo_doc = None def open_in_ooo(self)-
Expand source code
def open_in_ooo(self): # connect to OOo ooo_srv = gmOOoConnector() # open doc in OOo self.ooo_doc = ooo_srv.open_document(filename = self.template_file) if self.ooo_doc is None: _log.error('cannot open document in OOo') return False # listen for close events pat = gmPerson.gmCurrentPatient() pat.locked = True listener = cOOoDocumentCloseListener(document = self) self.ooo_doc.addCloseListener(listener) return True def replace_placeholders(self, handler=None, old_style_too=True)-
Expand source code
def replace_placeholders(self, handler=None, old_style_too = True): # new style embedded, implicit placeholders searcher = self.ooo_doc.createSearchDescriptor() searcher.SearchCaseSensitive = False searcher.SearchRegularExpression = True searcher.SearchWords = True searcher.SearchString = handler.placeholder_regex placeholder_instance = self.ooo_doc.findFirst(searcher) while placeholder_instance is not None: try: val = handler[placeholder_instance.String] except Exception: val = _('error with placeholder [%s]') % placeholder_instance.String _log.exception(val) if val is None: val = _('error with placeholder [%s]') % placeholder_instance.String placeholder_instance.String = val placeholder_instance = self.ooo_doc.findNext(placeholder_instance.End, searcher) if not old_style_too: return # old style "explicit" placeholders text_fields = self.ooo_doc.getTextFields().createEnumeration() while text_fields.hasMoreElements(): text_field = text_fields.nextElement() # placeholder ? if not text_field.supportsService('com.sun.star.text.TextField.JumpEdit'): continue # placeholder of type text ? if text_field.PlaceHolderType != 0: continue replacement = handler[text_field.PlaceHolder] if replacement is None: continue text_field.Anchor.setString(replacement) def save_in_ooo(self, filename=None)-
Expand source code
def save_in_ooo(self, filename=None): if filename is not None: target_url = uno.systemPathToFileUrl(os.path.abspath(os.path.expanduser(filename))) save_args = ( oooPropertyValue('Overwrite', 0, True, 0), oooPropertyValue('FormatFilter', 0, 'swriter: StarOffice XML (Writer)', 0) ) # "store AS url" stores the doc, marks it unmodified and updates # the internal media descriptor - as opposed to "store TO url" self.ooo_doc.storeAsURL(target_url, save_args) else: self.ooo_doc.store() def show(self, visible=True)-
Expand source code
def show(self, visible=True): self.ooo_doc.CurrentController.Frame.ContainerWindow.setVisible(visible)
class cPDFForm (template_file=None)-
A forms engine wrapping PDF forms.
Johann Felix Soden johfel@gmx.de helped with this.
http://partners.adobe.com/public/developer/en/pdf/PDFReference16.pdf
Expand source code
class cPDFForm(cFormEngine): """A forms engine wrapping PDF forms. Johann Felix Soden <johfel@gmx.de> helped with this. http://partners.adobe.com/public/developer/en/pdf/PDFReference16.pdf http://wwwimages.adobe.com/www.adobe.com/content/dam/Adobe/en/devnet/acrobat/pdfs/fdf_data_exchange.pdf """ def __init__(self, template_file=None): super(cPDFForm, self).__init__(template_file = template_file) # detect pdftk found, self.pdftk_binary = gmShellAPI.detect_external_binary(binary = r'pdftk') if not found: raise ImportError('<pdftk(.exe)> not found') return # should be superfluous, actually enc = sys.getfilesystemencoding() self.pdftk_binary = self.pdftk_binary.encode(enc) base_name, ext = os.path.splitext(self.template_filename) self.fdf_dumped_filename = ('%s.fdf' % base_name).encode(enc) self.fdf_replaced_filename = ('%s-replaced.fdf' % base_name).encode(enc) self.pdf_filled_filename = ('%s-filled.pdf' % base_name).encode(enc) self.pdf_flattened_filename = ('%s-filled-flattened.pdf' % base_name).encode(enc) #-------------------------------------------------------- def substitute_placeholders(self, data_source=None): # dump form fields from template cmd_line = [ self.pdftk_binary, self.template_filename, r'generate_fdf', r'output', self.fdf_dumped_filename ] _log.debug(' '.join(cmd_line)) try: pdftk = subprocess.Popen(cmd_line) except OSError: _log.exception('cannot run <pdftk> (dump data from form)') gmDispatcher.send(signal = 'statustext', msg = _('Error running pdftk. Cannot extract fields from PDF form template.'), beep = True) return False pdftk.communicate() if pdftk.returncode != 0: _log.error('<pdftk> returned [%s], failed to dump data from PDF form into FDF', pdftk.returncode) return False # parse dumped FDF file for "/V (...)" records # and replace placeholders therein fdf_dumped_file = io.open(self.fdf_dumped_filename, mode = 'rt', encoding = 'utf-8-sig') fdf_replaced_file = io.open(self.fdf_replaced_filename, mode = 'wt', encoding = 'utf8') string_value_regex = r'\s*/V\s*\(.+\)\s*$' for line in fdf_dumped_file: if not regex.match(string_value_regex, line): fdf_replaced_file.write(line) continue # strip cruft around the string value raw_str_val = line.strip() # remove framing whitespace raw_str_val = raw_str_val[2:] # remove leading "/V" raw_str_val = raw_str_val.lstrip() # remove whitespace between "/V" and "(" raw_str_val = raw_str_val[1:] # remove opening "(" raw_str_val = raw_str_val[2:] # remove BOM-16-BE raw_str_val = raw_str_val.rstrip() # remove trailing whitespace raw_str_val = raw_str_val[:-1] # remove closing ")" # work on FDF escapes raw_str_val = raw_str_val.replace('\(', '(') # remove escaping of "(" raw_str_val = raw_str_val.replace('\)', ')') # remove escaping of ")" # by now raw_str_val should contain the actual # string value, albeit encoded as UTF-16, so # decode it into a unicode object, # split multi-line fields on "\n" literal raw_str_lines = raw_str_val.split('\x00\\n') value_template_lines = [] for raw_str_line in raw_str_lines: value_template_lines.append(raw_str_line.decode('utf_16_be')) replaced_lines = [] for value_template in value_template_lines: # find any placeholders within placeholders_in_value = regex.findall(data_source.placeholder_regex, value_template, regex.IGNORECASE) for placeholder in placeholders_in_value: try: replacement = data_source[placeholder] except Exception: _log.exception(replacement) replacement = _('error with placeholder [%s]') % placeholder if replacement is None: replacement = _('error with placeholder [%s]') % placeholder value_template = value_template.replace(placeholder, replacement) value_template = value_template.encode('utf_16_be') if len(placeholders_in_value) > 0: value_template = value_template.replace(r'(', r'\(') value_template = value_template.replace(r')', r'\)') replaced_lines.append(value_template) replaced_line = '\x00\\n'.join(replaced_lines) fdf_replaced_file.write('/V (') fdf_replaced_file.write(codecs.BOM_UTF16_BE) fdf_replaced_file.write(replaced_line) fdf_replaced_file.write(')\n') fdf_replaced_file.close() fdf_dumped_file.close() # merge replaced data back into form cmd_line = [ self.pdftk_binary, self.template_filename, r'fill_form', self.fdf_replaced_filename, r'output', self.pdf_filled_filename ] _log.debug(' '.join(cmd_line)) try: pdftk = subprocess.Popen(cmd_line) except OSError: _log.exception('cannot run <pdftk> (merge data into form)') gmDispatcher.send(signal = 'statustext', msg = _('Error running pdftk. Cannot fill in PDF form template.'), beep = True) return False pdftk.communicate() if pdftk.returncode != 0: _log.error('<pdftk> returned [%s], failed to merge FDF data into PDF form', pdftk.returncode) return False return True #-------------------------------------------------------- def edit(self): mimetypes = [ 'application/pdf', 'application/x-pdf' ] for mimetype in mimetypes: editor_cmd = gmMimeLib.get_editor_cmd(mimetype, self.pdf_filled_filename) if editor_cmd is not None: break if editor_cmd is None: _log.debug('editor cmd not found, trying viewer cmd') for mimetype in mimetypes: editor_cmd = gmMimeLib.get_viewer_cmd(mimetype, self.pdf_filled_filename) if editor_cmd is not None: break if editor_cmd is None: return False result = gmShellAPI.run_command_in_shell(command = editor_cmd, blocking = True) path, fname = os.path.split(self.pdf_filled_filename) candidate = os.path.join(gmTools.gmPaths().home_dir, fname) if os.access(candidate, os.R_OK): _log.debug('filled-in PDF found: %s', candidate) os.rename(self.pdf_filled_filename, self.pdf_filled_filename + '.bak') shutil.move(candidate, path) else: _log.debug('filled-in PDF not found: %s', candidate) self.re_editable_filenames = [self.pdf_filled_filename] return result #-------------------------------------------------------- def generate_output(self, format=None): """Generate output suitable for further processing outside this class, e.g. printing.""" # eventually flatten the filled in form so we # can keep both a flattened and an editable copy: cmd_line = [ self.pdftk_binary, self.pdf_filled_filename, r'output', self.pdf_flattened_filename, r'flatten' ] _log.debug(' '.join(cmd_line)) try: pdftk = subprocess.Popen(cmd_line) except OSError: _log.exception('cannot run <pdftk> (flatten filled in form)') gmDispatcher.send(signal = 'statustext', msg = _('Error running pdftk. Cannot flatten filled in PDF form.'), beep = True) return None pdftk.communicate() if pdftk.returncode != 0: _log.error('<pdftk> returned [%s], failed to flatten filled in PDF form', pdftk.returncode) return None self.final_output_filenames = [self.pdf_flattened_filename] return self.pdf_flattened_filenameAncestors
Inherited members
class cTextForm (template_file=None)-
A forms engine outputting data as text for further processing.
Expand source code
class cTextForm(cFormEngine): """A forms engine outputting data as text for further processing.""" def __init__(self, template_file=None): super().__init__(template_file = template_file) # create sandbox to play in (and don't assume much # of anything about the template_file except that it # is at our disposal for reading) self.__sandbox_dir = gmTools.mk_sandbox_dir() _log.debug('sandbox directory: [%s]', self.__sandbox_dir) # parse template file which is an INI style config # file containing the actual template plus metadata self.form_definition_filename = self.template_filename _log.debug('form definition file: [%s]', self.form_definition_filename) cfg_file = io.open(self.form_definition_filename, mode = 'rt', encoding = 'utf-8-sig') self.form_definition = gmCfgINI.parse_INI_stream(stream = cfg_file) cfg_file.close() # extract actual template into a file template_text = self.form_definition['form::template'] if isinstance(template_text, type([])): template_text = '\n'.join(self.form_definition['form::template']) self.template_filename = gmTools.get_unique_filename ( prefix = 'gm-', suffix = '.txt', tmp_dir = self.__sandbox_dir ) _log.debug('template file: [%s]', self.template_filename) f = io.open(self.template_filename, mode = 'wt', encoding = 'utf8') f.write(template_text) f.close() #-------------------------------------------------------- def substitute_placeholders(self, data_source=None): if self.template: # pylint: disable=unsubscriptable-object # inject placeholder values data_source.set_placeholder('form_name_long', self.template['name_long']) data_source.set_placeholder('form_name_short', self.template['name_short']) data_source.set_placeholder('form_version', self.template['external_version']) data_source.set_placeholder('form_version_internal', gmTools.coalesce(self.template['gnumed_revision'], '', '%s')) data_source.set_placeholder('form_last_modified', gmDateTime.pydt_strftime(self.template['last_modified'], '%Y-%b-%d %H:%M')) base = os.path.join(self.__sandbox_dir, gmTools.fname_stem(self.template_filename)) filenames = [ self.template_filename, r'%s-result-pass-1.txt' % base, r'%s-result-pass-2.txt' % base, r'%s-result-pass-3.txt' % base ] regexen = [ 'dummy', data_source.first_pass_placeholder_regex, data_source.second_pass_placeholder_regex, data_source.third_pass_placeholder_regex ] current_pass = 1 while current_pass < 4: _log.debug('placeholder substitution pass #%s', current_pass) self.__substitute_placeholders ( input_filename = filenames[current_pass-1], output_filename = filenames[current_pass], data_source = data_source, placeholder_regex = regexen[current_pass] ) current_pass += 1 # remove temporary placeholders data_source.unset_placeholder('form_name_long') data_source.unset_placeholder('form_name_short') data_source.unset_placeholder('form_version') data_source.unset_placeholder('form_version_internal') data_source.unset_placeholder('form_last_modified') self.instance_filename = self.re_editable_filenames[0] return True #-------------------------------------------------------- def __substitute_placeholders(self, data_source=None, input_filename=None, output_filename=None, placeholder_regex=None): _log.debug('[%s] -> [%s]', input_filename, output_filename) _log.debug('searching for placeholders with pattern: %s', placeholder_regex) template_file = io.open(input_filename, mode = 'rt', encoding = 'utf-8-sig') instance_file = io.open(output_filename, mode = 'wt', encoding = 'utf8') for line in template_file: # empty lines if line.strip() in ['', '\r', '\n', '\r\n']: instance_file.write(line) continue # 1) find placeholders in this line placeholders_in_line = regex.findall(placeholder_regex, line, regex.IGNORECASE) if len(placeholders_in_line) == 0: instance_file.write(line) continue # 2) replace them _log.debug('%s placeholders found in this line', len(placeholders_in_line)) for placeholder in placeholders_in_line: try: val = data_source[placeholder] except Exception: val = _('error with placeholder [%s]') % placeholder _log.exception(val) if val is None: val = _('error with placeholder [%s]') % placeholder line = line.replace(placeholder, val) instance_file.write(line) instance_file.close() self.re_editable_filenames = [output_filename] template_file.close() #-------------------------------------------------------- def edit(self): editor_cmd = None try: editor_cmd = self.form_definition['form::editor'] % self.instance_filename except KeyError: _log.debug('no explicit editor defined for text template') if editor_cmd is None: mimetype = 'text/plain' editor_cmd = gmMimeLib.get_editor_cmd(mimetype, self.instance_filename) if editor_cmd is None: # also consider text *viewers* since pretty much any of them will be an editor as well editor_cmd = gmMimeLib.get_viewer_cmd(mimetype, self.instance_filename) if editor_cmd is not None: result = gmShellAPI.run_command_in_shell(command = editor_cmd, blocking = True) self.re_editable_filenames = [self.instance_filename] return result #-------------------------------------------------------- def generate_output(self, format=None): try: post_processor = self.form_definition['form::post processor'] % { 'input_name': self.instance_filename, 'output_name': self.instance_filename + '.output' } except KeyError: _log.debug('no explicit post processor defined for text template') return True self.final_output_filenames = [self.instance_filename + '.output'] return gmShellAPI.run_command_in_shell(command = post_processor, blocking = True)Ancestors
Inherited members
class cXSLTFormEngine (template=None)-
This class can create XML document from requested data, then process it with XSLT template and display results
Expand source code
class cXSLTFormEngine(cFormEngine): """This class can create XML document from requested data, then process it with XSLT template and display results """ # FIXME: make the path configurable ? _preview_program = 'oowriter ' #this program must be in the system PATH def __init__(self, template=None): if template is None: raise ValueError('%s: cannot create form instance without a template' % __name__) super().__init__(template_file = template) self._FormData = None # here we know/can assume that the template was stored as a utf-8 # encoded string so use that conversion to create unicode: #self._XSLTData = str(str(template.template_data), 'UTF-8') # but in fact, str() knows how to handle buffers, so simply: self._XSLTData = str(self.template.template_data, 'UTF-8', 'strict') # we must still devise a method of extracting the SQL query: # - either by retrieving it from a particular tag in the XSLT or # - by making the stored template actually be a dict which, unpickled, # has the keys "xslt" and "sql" self._SQL_query = 'select 1' #this sql query must output valid xml #-------------------------------------------------------- # external API #-------------------------------------------------------- def process(self, sql_parameters): """get data from backend and process it with XSLT template to produce readable output""" # extract SQL (this is wrong but displays what is intended) #xslt = libxml2.parseDoc(self._XSLTData) xslt = None root = xslt.children for child in root: if child.type == 'element': self._SQL_query = child.content break # retrieve data from backend rows, idx = gmPG2.run_ro_queries(queries = [{'cmd': self._SQL_query, 'args': sql_parameters}], get_col_idx = False) __header = '<?xml version="1.0" encoding="UTF-8"?>\n' __body = rows[0][0] # process XML data according to supplied XSLT, producing HTML self._XMLData =__header + __body #style = libxslt.parseStylesheetDoc(xslt) style = None #xml = libxml2.parseDoc(self._XMLData) xml = None html = style.applyStylesheet(xml, None) self._FormData = html.serialize() style.freeStylesheet() xml.freeDoc() html.freeDoc() #-------------------------------------------------------- def preview(self): if self._FormData is None: raise ValueError('Preview request for empty form. Make sure the form is properly initialized and process() was performed') fname = gmTools.get_unique_filename(prefix = 'gm_XSLT_form-', suffix = '.html') #html_file = os.open(fname, 'wb') #html_file.write(self._FormData.encode('UTF-8')) html_file = io.open(fname, mode = 'wt', encoding = 'utf8', errors = 'strict') # or 'replace' ? html_file.write(self._FormData) html_file.close() cmd = '%s %s' % (self.__class__._preview_program, fname) if not gmShellAPI.run_command_in_shell(command = cmd, blocking = False): _log.error('%s: cannot launch report preview program' % __name__) return False #os.unlink(self.filename) #delete file #FIXME: under Windows the temp file is deleted before preview program gets it (under Linux it works OK) return True #-------------------------------------------------------- def print_directly(self): #not so fast, look at it first self.preview()Ancestors
Methods
def preview(self)-
Expand source code
def preview(self): if self._FormData is None: raise ValueError('Preview request for empty form. Make sure the form is properly initialized and process() was performed') fname = gmTools.get_unique_filename(prefix = 'gm_XSLT_form-', suffix = '.html') #html_file = os.open(fname, 'wb') #html_file.write(self._FormData.encode('UTF-8')) html_file = io.open(fname, mode = 'wt', encoding = 'utf8', errors = 'strict') # or 'replace' ? html_file.write(self._FormData) html_file.close() cmd = '%s %s' % (self.__class__._preview_program, fname) if not gmShellAPI.run_command_in_shell(command = cmd, blocking = False): _log.error('%s: cannot launch report preview program' % __name__) return False #os.unlink(self.filename) #delete file #FIXME: under Windows the temp file is deleted before preview program gets it (under Linux it works OK) return True def print_directly(self)-
Expand source code
def print_directly(self): #not so fast, look at it first self.preview() def process(self, sql_parameters)-
get data from backend and process it with XSLT template to produce readable output
Expand source code
def process(self, sql_parameters): """get data from backend and process it with XSLT template to produce readable output""" # extract SQL (this is wrong but displays what is intended) #xslt = libxml2.parseDoc(self._XSLTData) xslt = None root = xslt.children for child in root: if child.type == 'element': self._SQL_query = child.content break # retrieve data from backend rows, idx = gmPG2.run_ro_queries(queries = [{'cmd': self._SQL_query, 'args': sql_parameters}], get_col_idx = False) __header = '<?xml version="1.0" encoding="UTF-8"?>\n' __body = rows[0][0] # process XML data according to supplied XSLT, producing HTML self._XMLData =__header + __body #style = libxslt.parseStylesheetDoc(xslt) style = None #xml = libxml2.parseDoc(self._XMLData) xml = None html = style.applyStylesheet(xml, None) self._FormData = html.serialize() style.freeStylesheet() xml.freeDoc() html.freeDoc()
Inherited members
class cXeTeXForm (template_file=None)-
A forms engine wrapping Xe(La)TeX.
Expand source code
class cXeTeXForm(cFormEngine): """A forms engine wrapping Xe(La)TeX.""" def __init__(self, template_file=None): # create sandbox for LaTeX to play in (and don't assume # much of anything about the template_file except that it # is at our disposal) sandbox_dir = gmTools.mk_sandbox_dir(prefix = gmTools.fname_stem(template_file) + '_') _log.debug('Xe(La)TeX sandbox directory: [%s]', sandbox_dir) shutil.copy(template_file, sandbox_dir) template_file = os.path.join(sandbox_dir, os.path.split(template_file)[1]) super().__init__(template_file = template_file) self.__sandbox_dir = sandbox_dir #-------------------------------------------------------- def substitute_placeholders(self, data_source=None): if self.template is not None: # pylint: disable=unsubscriptable-object # inject placeholder values data_source.set_placeholder('form_name_long', self.template['name_long']) data_source.set_placeholder('form_name_short', self.template['name_short']) data_source.set_placeholder('form_version', self.template['external_version']) data_source.set_placeholder('form_version_internal', gmTools.coalesce(self.template['gnumed_revision'], '', '%s')) data_source.set_placeholder('form_last_modified', gmDateTime.pydt_strftime(self.template['last_modified'], '%Y-%b-%d %H:%M')) data_source.escape_function = gmTools.xetex_escape_string data_source.escape_style = 'xetex' path, ext = os.path.splitext(self.template_filename) if ext in [r'', r'.']: ext = r'.tex' filenames = [ self.template_filename, r'%s-result_run1%s' % (path, ext), r'%s-result_run2%s' % (path, ext), r'%s-result_run3%s' % (path, ext) ] found_placeholders = True current_run = 1 while found_placeholders and (current_run < 4): _log.debug('placeholder substitution run #%s', current_run) found_placeholders = self.__substitute_placeholders ( input_filename = filenames[current_run-1], output_filename = filenames[current_run], data_source = data_source ) current_run += 1 if self.template is not None: # remove temporary placeholders data_source.unset_placeholder('form_name_long') data_source.unset_placeholder('form_name_short') data_source.unset_placeholder('form_version') data_source.unset_placeholder('form_version_internal') data_source.unset_placeholder('form_last_modified') self.instance_filename = self.re_editable_filenames[0] return #-------------------------------------------------------- def __substitute_placeholders(self, data_source=None, input_filename=None, output_filename=None): _log.debug('[%s] -> [%s]', input_filename, output_filename) found_placeholders = False template_file = io.open(input_filename, mode = 'rt', encoding = 'utf-8-sig') instance_file = io.open(output_filename, mode = 'wt', encoding = 'utf8') for line in template_file: if line.strip() in ['', '\r', '\n', '\r\n']: # empty lines instance_file.write(line) continue if line.startswith('%'): # TeX comment instance_file.write(line) continue for placeholder_regex in [data_source.first_pass_placeholder_regex, data_source.second_pass_placeholder_regex, data_source.third_pass_placeholder_regex]: # 1) find placeholders in this line placeholders_in_line = regex.findall(placeholder_regex, line, regex.IGNORECASE) if len(placeholders_in_line) == 0: continue _log.debug('%s placeholders found with pattern: %s', len(placeholders_in_line), placeholder_regex) found_placeholders = True # 2) replace them for placeholder in placeholders_in_line: try: val = data_source[placeholder] except Exception: _log.exception('error with placeholder [%s]', placeholder) val = gmTools.tex_escape_string(_('error with placeholder [%s]') % placeholder) if val is None: _log.debug('error with placeholder [%s]', placeholder) val = _('error with placeholder [%s]') % gmTools.tex_escape_string(placeholder) line = line.replace(placeholder, val) instance_file.write(line) instance_file.close() self.re_editable_filenames = [output_filename] template_file.close() return found_placeholders #-------------------------------------------------------- def edit(self): mimetypes = [ 'application/x-xetex', 'application/x-latex', 'application/x-tex', 'text/plain' ] for mimetype in mimetypes: editor_cmd = gmMimeLib.get_editor_cmd(mimetype, self.instance_filename) if editor_cmd is not None: break if editor_cmd is None: # Xe(La)TeX code is utf8: also consider text *viewers* # since pretty much any of them will be an editor as well for mimetype in mimetypes: editor_cmd = gmMimeLib.get_viewer_cmd(mimetype, self.instance_filename) if editor_cmd is not None: break if editor_cmd is None: return False result = gmShellAPI.run_command_in_shell(command = editor_cmd, blocking = True) self.re_editable_filenames = [self.instance_filename] return result #-------------------------------------------------------- def generate_output(self, instance_file=None, format=None): if instance_file is None: instance_file = self.instance_filename try: open(instance_file, 'r').close() except Exception: _log.exception('cannot access form instance file [%s]', instance_file) gmLog2.log_stack_trace() return None self.instance_filename = instance_file _log.debug('ignoring <format> directive [%s], generating PDF', format) # Xe(La)TeX can need up to three runs to get cross references et al right if platform.system() == 'Windows': # not yet supported: -draftmode # does not support: -shell-escape draft_cmd = r'xelatex.exe -interaction=nonstopmode -output-directory=%s %s' % (self.__sandbox_dir, self.instance_filename) final_cmd = r'xelatex.exe -interaction=nonstopmode -output-directory=%s %s' % (self.__sandbox_dir, self.instance_filename) else: # not yet supported: -draftmode draft_cmd = r'xelatex -interaction=nonstopmode -output-directory=%s -shell-escape %s' % (self.__sandbox_dir, self.instance_filename) final_cmd = r'xelatex -interaction=nonstopmode -output-directory=%s -shell-escape %s' % (self.__sandbox_dir, self.instance_filename) for run_cmd in [draft_cmd, draft_cmd, final_cmd]: if not gmShellAPI.run_command_in_shell(command = run_cmd, blocking = True, acceptable_return_codes = [0, 1]): _log.error('problem running xelatex, cannot generate form output') gmDispatcher.send(signal = 'statustext', msg = _('Error running xelatex. Cannot turn Xe(La)TeX template into PDF.'), beep = True) return None sandboxed_pdf_name = '%s.pdf' % os.path.splitext(self.instance_filename)[0] target_dir = os.path.normpath(os.path.join(os.path.split(sandboxed_pdf_name)[0], '..')) final_pdf_name = os.path.join ( target_dir, os.path.split(sandboxed_pdf_name)[1] ) _log.debug('copying sandboxed PDF: %s -> %s', sandboxed_pdf_name, final_pdf_name) try: shutil.copy2(sandboxed_pdf_name, target_dir) except IOError: _log.exception('cannot open/move sandboxed PDF') gmDispatcher.send(signal = 'statustext', msg = _('PDF output file cannot be opened.'), beep = True) return None self.final_output_filenames = [final_pdf_name] return final_pdf_nameAncestors
Inherited members
class gmOOoConnector-
This class handles the connection to OOo.
Its Singleton instance stays around once initialized.
Expand source code
class gmOOoConnector(gmBorg.cBorg): """This class handles the connection to OOo. Its Singleton instance stays around once initialized. """ # FIXME: need to detect closure of OOo ! def __init__(self): init_ooo() self.__setup_connection_string() self.resolver_uri = "com.sun.star.bridge.UnoUrlResolver" self.desktop_uri = "com.sun.star.frame.Desktop" self.max_connect_attempts = 5 self.local_context = uno.getComponentContext() self.uri_resolver = self.local_context.ServiceManager.createInstanceWithContext(self.resolver_uri, self.local_context) self.__desktop = None #-------------------------------------------------------- # external API #-------------------------------------------------------- def cleanup(self, force=True): if self.__desktop is None: _log.debug('no desktop, no cleanup') return try: self.__desktop.terminate() except Exception: _log.exception('cannot terminate OOo desktop') #-------------------------------------------------------- def open_document(self, filename=None): """<filename> must be absolute""" if self.desktop is None: _log.error('cannot access OOo desktop') return None filename = os.path.expanduser(filename) filename = os.path.abspath(filename) document_uri = uno.systemPathToFileUrl(filename) _log.debug('%s -> %s', filename, document_uri) doc = self.desktop.loadComponentFromURL(document_uri, "_blank", 0, ()) return doc #-------------------------------------------------------- # internal helpers #-------------------------------------------------------- def __get_startup_settle_time(self): # later factor this out ! self.ooo_startup_settle_time = gmCfgDB.get4workplace ( option = 'external.ooo.startup_settle_time', workplace = gmPraxis.gmCurrentPraxisBranch().active_workplace, default = 3.0 ) #-------------------------------------------------------- def __setup_connection_string(self): # socket: # ooo_port = u'2002' # #self.ooo_start_cmd = 'oowriter -invisible -norestore -nofirststartwizard -nologo -accept="socket,host=localhost,port=%s;urp;StarOffice.ServiceManager"' % ooo_port # self.ooo_start_cmd = 'oowriter -invisible -norestore -accept="socket,host=localhost,port=%s;urp;"' % ooo_port # self.remote_context_uri = "uno:socket,host=localhost,port=%s;urp;StarOffice.ComponentContext" % ooo_port # pipe: pipe_name = "uno-gm2lo-%s" % str(random.random())[2:] _log.debug('expecting OOo/LO server on named pipe [%s]', pipe_name) self.ooo_start_cmd = '%s --invisible --norestore --accept="pipe,name=%s;urp" &' % ( writer_binary, pipe_name ) _log.debug('startup command: %s', self.ooo_start_cmd) self.remote_context_uri = "uno:pipe,name=%s;urp;StarOffice.ComponentContext" % pipe_name _log.debug('remote context URI: %s', self.remote_context_uri) #-------------------------------------------------------- def __startup_ooo(self): _log.info('trying to start OOo server') _log.debug('startup command: %s', self.ooo_start_cmd) os.system(self.ooo_start_cmd) self.__get_startup_settle_time() _log.debug('waiting %s seconds for OOo to start up', self.ooo_startup_settle_time) time.sleep(int(self.ooo_startup_settle_time)) #-------------------------------------------------------- # properties #-------------------------------------------------------- def _get_desktop(self): if self.__desktop is not None: return self.__desktop self.remote_context = None attempts = self.max_connect_attempts while attempts > 0: _log.debug('attempt %s/%s', self.max_connect_attempts - attempts + 1, self.max_connect_attempts) try: self.remote_context = self.uri_resolver.resolve(self.remote_context_uri) break except oooNoConnectException: _log.exception('cannot connect to OOo') # first loop ? if attempts == self.max_connect_attempts: self.__startup_ooo() else: time.sleep(1) attempts = attempts - 1 if self.remote_context is None: raise OSError(-1, 'cannot connect to OpenOffice', self.remote_context_uri) _log.debug('connection seems established') self.__desktop = self.remote_context.ServiceManager.createInstanceWithContext(self.desktop_uri, self.remote_context) _log.debug('got OOo desktop handle') return self.__desktop desktop = property(_get_desktop)Ancestors
Instance variables
var desktop-
Expand source code
def _get_desktop(self): if self.__desktop is not None: return self.__desktop self.remote_context = None attempts = self.max_connect_attempts while attempts > 0: _log.debug('attempt %s/%s', self.max_connect_attempts - attempts + 1, self.max_connect_attempts) try: self.remote_context = self.uri_resolver.resolve(self.remote_context_uri) break except oooNoConnectException: _log.exception('cannot connect to OOo') # first loop ? if attempts == self.max_connect_attempts: self.__startup_ooo() else: time.sleep(1) attempts = attempts - 1 if self.remote_context is None: raise OSError(-1, 'cannot connect to OpenOffice', self.remote_context_uri) _log.debug('connection seems established') self.__desktop = self.remote_context.ServiceManager.createInstanceWithContext(self.desktop_uri, self.remote_context) _log.debug('got OOo desktop handle') return self.__desktop
Methods
def cleanup(self, force=True)-
Expand source code
def cleanup(self, force=True): if self.__desktop is None: _log.debug('no desktop, no cleanup') return try: self.__desktop.terminate() except Exception: _log.exception('cannot terminate OOo desktop') def open_document(self, filename=None)-
must be absolute Expand source code
def open_document(self, filename=None): """<filename> must be absolute""" if self.desktop is None: _log.error('cannot access OOo desktop') return None filename = os.path.expanduser(filename) filename = os.path.abspath(filename) document_uri = uno.systemPathToFileUrl(filename) _log.debug('%s -> %s', filename, document_uri) doc = self.desktop.loadComponentFromURL(document_uri, "_blank", 0, ()) return doc