class DatabaseConfig(object):
"""
Reads and writes database settings in the registry.
"""
def __init__(self):
self.host = "Host"
self.port = "Port"
self.db_name = "Database"
self.reg_config = RegistryConfig()
def read(self):
'''
Get the database connection properties
'''
db_props = self.reg_config.read([self.host, self.port, self.db_name])
if len(db_props) < 3:
return None
else:
return DatabaseConnection(db_props[self.host], db_props[self.port],
db_props[self.db_name])
def write(self, db_connection):
'''
Writes the database connection settings to the registry
'''
db_settings = {}
db_settings[self.host] = db_connection.Host
db_settings[self.port] = db_connection.Port
db_settings[self.db_name] = db_connection.Database
self.reg_config.write(db_settings)
class DatabaseConfig(object):
"""
Reads and writes database settings in the registry.
"""
def __init__(self):
self.host = "Host"
self.port = "Port"
self.db_name = "Database"
self.reg_config = RegistryConfig()
def read(self):
'''
Get the database connection properties
'''
db_props = self.reg_config.read([self.host, self.port, self.db_name])
if len(db_props) < 3:
return None
else:
return DatabaseConnection(db_props[self.host], db_props[self.port],
db_props[self.db_name])
def write(self, db_connection):
'''
Writes the database connection settings to the registry
'''
db_settings = {}
db_settings[self.host] = db_connection.Host
db_settings[self.port] = db_connection.Port
db_settings[self.db_name] = db_connection.Database
self.reg_config.write(db_settings)
def save_current_profile(name):
"""
Save the profile with the given name as the current profile.
:param name: Name of the current profile.
:type name: unicode
"""
if not name:
return
# Save profile in the registry/settings
reg_config = RegistryConfig()
reg_config.write({CURRENT_PROFILE: name})
def save_current_profile(name):
"""
Save the profile with the given name as the current profile.
:param name: Name of the current profile.
:type name: unicode
"""
if not name:
return
#Save profile in the registry/settings
reg_config = RegistryConfig()
reg_config.write({CURRENT_PROFILE: name})
def loadLookups():
for k,v in stdm_lookups.iteritems():
modelName = k
Values = v
model = globals()[modelName]
modelInstance = model()
queryObj = modelInstance.queryObject()
#Ensure item does not exist before being inserted
for lk in v:
#Convert QString to Python string
lk = unicode(lk)
lkObj = queryObj.filter(model.name == lk).first()
if lkObj == None:
lkInst = model()
lkInst.name = lk
lkInst.save()
#Update registry
regConfig = RegistryConfig()
regConfig.write({DATABASE_LOOKUP:str(True)})
def _load_column_mapping(self):
"""
Imports the current column mapping from a JSON definition file
"""
config = RegistryConfig()
prev_folder = config.read(["LastImportConfigFolder"]).get("LastImportConfigFolder")
if not prev_folder:
prev_folder = QDir.homePath()
source_path, _ = QFileDialog.getOpenFileName(self, self.tr("Load Configuration"),
prev_folder,
"{0} (*.json)".format(self.tr('Configuration files')))
if not source_path:
return
config.write({"LastImportConfigFolder": QFileInfo(source_path).path()})
with open(source_path, 'rt') as f:
imported_config = json.loads(''.join(f.readlines()))
self._restore_column_config(imported_config)
def set_source_document_location(doc_path):
"""
Set the latest source directory of uploaded source documents.
:param doc_path: Directory path or file path. The system will
attempt to extract the directory path from the file name.
"""
doc_dir_path = ""
#Check if it is a file or directory
doc_dir = QDir(doc_path)
if not doc_dir.exists():
doc_file_info = QFileInfo(doc_path)
if doc_file_info.exists():
doc_dir_path = doc_file_info.dir().path()
else:
doc_dir_path = doc_path
if len(doc_dir_path) > 0:
reg_config = RegistryConfig()
reg_config.write({LOCAL_SOURCE_DOC:doc_dir_path})
def _save_column_mapping(self):
"""
Exports the current column mapping to a JSON definition file
"""
config = RegistryConfig()
prev_folder = config.read(["LastImportConfigFolder"]).get("LastImportConfigFolder")
if not prev_folder:
prev_folder = QDir.homePath()
dest_path, _ = QFileDialog.getSaveFileName(self, self.tr("Save Configuration"),
prev_folder,
"{0} (*.json)".format(self.tr('Configuration files')))
if not dest_path:
return
dest_path = QgsFileUtils.ensureFileNameHasExtension(dest_path, ['.json'])
config.write({"LastImportConfigFolder": QFileInfo(dest_path).path()})
with open(dest_path, 'wt') as f:
f.write(json.dumps(self._get_column_config(), indent=4))
def set_source_document_location(doc_path):
"""
Set the latest source directory of uploaded source documents.
:param doc_path: Directory path or file path. The system will
attempt to extract the directory path from the file name.
"""
doc_dir_path = ""
#Check if it is a file or directory
doc_dir = QDir(doc_path)
if not doc_dir.exists():
doc_file_info = QFileInfo(doc_path)
if doc_file_info.exists():
doc_dir_path = doc_file_info.dir().path()
else:
doc_dir_path = doc_path
if len(doc_dir_path) > 0:
reg_config = RegistryConfig()
reg_config.write({LOCAL_SOURCE_DOC:doc_dir_path})
class DatabaseConfig:
"""
Reads and writes database settings in the registry.
"""
HOST = "Host"
PORT = "Port"
DB_NAME = "Database"
def __init__(self):
self.reg_config = RegistryConfig()
def read(self) -> Optional[DatabaseConnection]:
"""
Get the database connection properties
"""
db_props = self.reg_config.read(
[DatabaseConfig.HOST, DatabaseConfig.PORT, DatabaseConfig.DB_NAME])
if len(db_props) < 3:
return None
else:
return DatabaseConnection(db_props[DatabaseConfig.HOST],
db_props[DatabaseConfig.PORT],
db_props[DatabaseConfig.DB_NAME])
def write(self, db_connection):
"""
Writes the database connection settings to the registry
"""
db_settings = {
DatabaseConfig.HOST: db_connection.Host,
DatabaseConfig.PORT: db_connection.Port,
DatabaseConfig.DB_NAME: db_connection.Database
}
self.reg_config.write(db_settings)
class OptionsDialog(QDialog, Ui_DlgOptions):
"""
Dialog for editing STDM settings.
"""
def __init__(self, iface):
QDialog.__init__(self, iface.mainWindow())
self.setupUi(self)
self.iface = iface
self.notif_bar = NotificationBar(self.vlNotification, 6000)
self._apply_btn = self.buttonBox.button(QDialogButtonBox.Apply)
self._reg_config = RegistryConfig()
self._db_config = DatabaseConfig()
# Connect signals
self._apply_btn.clicked.connect(self.apply_settings)
self.buttonBox.accepted.connect(self.on_accept)
self.chk_pg_connections.toggled.connect(self._on_use_pg_connections)
self.cbo_pg_connections.currentIndexChanged.connect(
self._on_pg_profile_changed)
self.btn_db_conn_clear.clicked.connect(self.clear_properties)
self.btn_test_db_connection.clicked.connect(
self._on_test_db_connection)
self.btn_template_folder.clicked.connect(
self._on_choose_doc_designer_template_path)
self.btn_composer_out_folder.clicked.connect(
self._on_choose_doc_generator_output_path)
self.btn_test_docs_repo_conn.clicked.connect(
self._on_test_cmis_connection)
self.txt_atom_pub_url.textChanged.connect(self._on_cmis_url_changed)
self.btn_holders_conf_file.clicked.connect(
self._on_choose_holders_config_file)
self._config = StdmConfiguration.instance()
self.init_gui()
def init_gui(self):
# Set integer validator for the port number
int_validator = QIntValidator(1024, 49151)
self.txtPort.setValidator(int_validator)
# Load profiles
self.load_profiles()
# Set current profile in the combobox
curr_profile = current_profile()
if not curr_profile is None:
setComboCurrentIndexWithText(self.cbo_profiles, curr_profile.name)
# Load current database connection properties
self._load_db_conn_properties()
# Load existing PostgreSQL connections
self._load_qgis_pg_connections()
# Load directory paths
self._load_directory_paths()
# Load document repository-related settings
self._load_cmis_config()
# Load holders configuration file path
self._load_holders_configuration_file()
# Debug logging
lvl = debug_logging()
if lvl:
self.chk_logging.setCheckState(Qt.Checked)
else:
self.chk_logging.setCheckState(Qt.Unchecked)
# Shortcut dialog
self._check_shortcuts_settings()
self.chk_shortcut_dlg.toggled.connect(self._on_check_shortcut_checkbox)
def _load_cmis_config(self):
"""
Load configuration names and IDs in the combobox then select
the user specified ID.
"""
# Load CMIS atom pub URL
self.txt_atom_pub_url.setText(cmis_atom_pub_url())
self.cbo_auth_config_name.clear()
self.cbo_auth_config_name.addItem('')
config_ids = config_entries()
for ci in config_ids:
id = ci[0]
name = ci[1]
display = u'{0} ({1})'.format(name, id)
self.cbo_auth_config_name.addItem(display, id)
# Then select the user specific config ID if specified
conf_id = cmis_auth_config_id()
if conf_id:
id_idx = self.cbo_auth_config_name.findData(conf_id)
if id_idx != -1:
self.cbo_auth_config_name.setCurrentIndex(id_idx)
def _load_holders_configuration_file(self):
# Load the path of the holders configuration file.
holders_config = holders_config_path()
if not holders_config:
# Use the default path
holders_config = DEF_HOLDERS_CONFIG_PATH
self.txt_holders_config.setText(holders_config)
def _on_choose_holders_config_file(self):
# Slot raised to browse the holders config file
holders_config = self.txt_holders_config.text()
if not holders_config:
holders_config = QDir.home().path()
conf_file = QFileDialog.getOpenFileName(
self, self.tr('Browse Holders Configuration File'), holders_config,
'Holders INI file (*.ini)')
if conf_file:
self.txt_holders_config.setText(conf_file)
def _on_cmis_url_changed(self, new_text):
# Slot raised when text for CMIS URL changes. Basically updates
# the tooltip so as to display long URLs
self.txt_atom_pub_url.setToolTip(new_text)
def _check_shortcuts_settings(self):
"""
Checks the state of the show dialog checkbox
:return: Bool
"""
# Check registry values for shortcut dialog
show_dlg = 1
dlg_key = self._reg_config.read([SHOW_SHORTCUT_DIALOG])
if len(dlg_key) > 0:
show_dlg = dlg_key[SHOW_SHORTCUT_DIALOG]
if show_dlg == 1 or show_dlg == unicode(1):
self.chk_shortcut_dlg.setChecked(True)
elif show_dlg == 0 or show_dlg == unicode(0):
self.chk_shortcut_dlg.setChecked(False)
def _on_check_shortcut_checkbox(self, toggled):
"""
Slot raised when the checkbox for showing shortcut window
is checked/unchecked.
:param toggled: Toggle status
:type toggled: bool
"""
if toggled:
self._reg_config.write({SHOW_SHORTCUT_DIALOG: 1})
self.notif_bar.clear()
msg = self.tr(u"Shortcuts window will show after login")
self.notif_bar.insertWarningNotification(msg)
else:
self._reg_config.write({SHOW_SHORTCUT_DIALOG: 0})
self.notif_bar.clear()
msg = self.tr(u"Shortcuts window will not show after login")
self.notif_bar.insertWarningNotification(msg)
def load_profiles(self):
"""
Load existing profiles into the combobox.
"""
profile_names = self._config.profiles.keys()
self.cbo_profiles.clear()
self.cbo_profiles.addItem('')
self.cbo_profiles.addItems(profile_names)
def _load_db_conn_properties(self):
# Load database connection properties from the registry.
db_conn = self._db_config.read()
if not db_conn is None:
self.txtHost.setText(db_conn.Host)
self.txtPort.setText(db_conn.Port)
self.txtDatabase.setText(db_conn.Database)
def _load_qgis_pg_connections(self):
"""
Load QGIS postgres connections.
"""
self.cbo_pg_connections.addItem('')
profiles = pg_profile_names()
for profile in profiles:
self.cbo_pg_connections.addItem(profile[0], profile[1])
def _load_directory_paths(self):
# Load paths to various directory settings.
comp_out_path = composer_output_path()
comp_temp_path = composer_template_path()
if not comp_out_path is None:
self.txt_output_dir.setText(comp_out_path)
if not comp_temp_path is None:
self.txt_template_dir.setText(comp_temp_path)
def _on_use_pg_connections(self, state):
# Slot raised when to (not) use existing pg connections
if not state:
self.cbo_pg_connections.setCurrentIndex(0)
self.cbo_pg_connections.setEnabled(False)
# Restore current connection in registry
self._load_db_conn_properties()
else:
self.cbo_pg_connections.setEnabled(True)
def _on_pg_profile_changed(self, index):
"""
Slot raised when the index of the pg profile changes. If the
selection is valid then the system will attempt to extract
the database connection properties of the selected profile
stored in the registry.
"""
if index == 0:
return
profile_path = self.cbo_pg_connections.itemData(index)
q_config = QGISRegistryConfig(profile_path)
db_items = q_config.read(['Database', 'Host', 'Port'])
if len(db_items) > 0:
self.txtDatabase.setText(db_items['Database'])
self.txtHost.setText(db_items['Host'])
self.txtPort.setText(db_items['Port'])
def clear_properties(self):
"""
Clears the host, database name and port number values from the
respective controls.
"""
self.txtDatabase.clear()
self.txtHost.clear()
self.txtPort.clear()
def _on_choose_doc_designer_template_path(self):
# Slot raised to select directory for document designer templates.
self._set_selected_directory(
self.txt_template_dir,
self.tr('Document Designer Templates Directory'))
def _on_choose_doc_generator_output_path(self):
# Slot raised to select directory for doc generator outputs.
self._set_selected_directory(
self.txt_output_dir,
self.tr('Document Generator Output Directory'))
def _set_selected_directory(self, txt_box, title):
def_path = txt_box.text()
sel_doc_path = QFileDialog.getExistingDirectory(self, title, def_path)
if sel_doc_path:
normalized_path = QDir.fromNativeSeparators(sel_doc_path)
txt_box.clear()
txt_box.setText(normalized_path)
def _validate_db_props(self):
# Test if all properties have been specified
status = True
self.notif_bar.clear()
if not self.txtHost.text():
msg = self.tr('Please specify the database host address.')
self.notif_bar.insertErrorNotification(msg)
status = False
if not self.txtPort.text():
msg = self.tr('Please specify the port number.')
self.notif_bar.insertErrorNotification(msg)
status = False
if not self.txtDatabase.text():
msg = self.tr('Please specify the database name.')
self.notif_bar.insertErrorNotification(msg)
status = False
return status
def _database_connection(self):
# Creates a databaase connection object from the specified args
host = self.txtHost.text()
port = self.txtPort.text()
database = self.txtDatabase.text()
# Create database connection object
db_conn = DatabaseConnection(host, port, database)
return db_conn
def _on_test_db_connection(self):
"""
Slot raised to test database connection.
"""
status = self._validate_db_props()
if not status:
return
login_dlg = loginDlg(self, True)
db_conn = self._database_connection()
login_dlg.set_database_connection(db_conn)
res = login_dlg.exec_()
if res == QDialog.Accepted:
msg = self.tr(u"Connection to '{0}' database was "
"successful.".format(db_conn.Database))
self.notif_bar.insertSuccessNotification(msg)
def _on_test_cmis_connection(self):
# Slot raised to test connection to CMIS service
status = self._validate_cmis_properties()
if not status:
return
self.notif_bar.clear()
atom_pub_url = self.txt_atom_pub_url.text()
auth_conf_id = self.cbo_auth_config_name.itemData(
self.cbo_auth_config_name.currentIndex())
cmis_mgr = CmisManager(url=atom_pub_url, auth_config_id=auth_conf_id)
QgsApplication.setOverrideCursor(QCursor(Qt.WaitCursor))
status = cmis_mgr.connect()
QgsApplication.restoreOverrideCursor()
if status:
msg = self.tr('Connection to the CMIS server succeeded.')
self.notif_bar.insertSuccessNotification(msg)
else:
msg = self.tr(
'Failed to connect to the CMIS server. Check URL and/or '
'credentials.')
self.notif_bar.insertErrorNotification(msg)
def set_current_profile(self):
"""
Saves the given profile name as the current profile.
"""
profile_name = self.cbo_profiles.currentText()
if not profile_name:
self.notif_bar.clear()
msg = self.tr('Profile name is empty, current profile will not '
'be set.')
self.notif_bar.insertErrorNotification(msg)
return False
save_current_profile(profile_name)
return True
def set_cmis_properties(self):
"""
Saves the CMIS atom pub URL and authentication configuration ID.
"""
if not self._validate_cmis_properties():
return False
atom_pub_url = self.txt_atom_pub_url.text()
set_cmis_atom_pub_url(atom_pub_url)
curr_idx = self.cbo_auth_config_name.currentIndex()
config_id = self.cbo_auth_config_name.itemData(curr_idx)
set_cmis_auth_config_id(config_id)
return True
def _validate_cmis_properties(self):
# Assert if user has specified URL and authentication config ID.
atom_pub_url = self.txt_atom_pub_url.text()
config_name_id = self.cbo_auth_config_name.currentText()
status = True
if not atom_pub_url:
msg = self.tr(
'Please specify the URL of the CMIS atom pub service.')
self.notif_bar.insertErrorNotification(msg)
status = False
if not config_name_id:
msg = self.tr(
'Please select the configuration ID containing the CMIS authentication.'
)
self.notif_bar.insertErrorNotification(msg)
status = False
return status
def set_holders_config_file(self):
# Save the path to the holders configuration file
holders_config_file = self.txt_holders_config.text()
if not holders_config_file:
msg = self.tr(
'Please set the path to the holders configuration file.')
self.notif_bar.insertErrorNotification(msg)
return False
set_holders_config_path(holders_config_file)
return True
def save_database_properties(self):
"""
Saves the specified database connection properties to the registry.
:return: True if the connection properties were successfully saved.
:rtype: bool
"""
if not self._validate_db_props():
return False
# Create a database object and write it to the registry
db_conn = self._database_connection()
self._db_config.write(db_conn)
return True
def set_document_templates_path(self):
"""
Set the directory of document designer templates.
:return: True if the directory was set in the registry, otherwise
False.
:rtype: bool
"""
path = self.txt_template_dir.text()
if not path:
msg = self.tr('Please set the document designer templates '
'directory.')
self.notif_bar.insertErrorNotification(msg)
return False
# Validate path
if not self._check_path_exists(path, self.txt_template_dir):
return False
# Commit to registry
self._reg_config.write({COMPOSER_TEMPLATE: path})
return True
def set_document_output_path(self):
"""
Set the directory of document generator outputs.
:return: True if the directory was set in the registry, otherwise
False.
:rtype: bool
"""
path = self.txt_output_dir.text()
if not path:
msg = self.tr('Please set the document generator output directory'
'.')
self.notif_bar.insertErrorNotification(msg)
return False
# Validate path
if not self._check_path_exists(path, self.txt_output_dir):
return False
# Commit to registry
self._reg_config.write({COMPOSER_OUTPUT: path})
return True
def _check_path_exists(self, path, text_box):
# Validates if the specified folder exists
dir = QDir()
if not dir.exists(path):
msg = self.tr(u"'{0}' directory does not exist.".format(path))
self.notif_bar.insertErrorNotification(msg)
# Highlight textbox control
text_box.setStyleSheet(INVALIDATESTYLESHEET)
timer = QTimer(self)
# Sync interval with that of the notification bar
timer.setInterval(self.notif_bar.interval)
timer.setSingleShot(True)
# Remove previous connected slots (if any)
receivers = timer.receivers(SIGNAL('timeout()'))
if receivers > 0:
self._timer.timeout.disconnect()
timer.start()
timer.timeout.connect(lambda: self._restore_stylesheet(text_box))
return False
return True
def _restore_stylesheet(self, textbox):
# Slot raised to restore the original stylesheet of the textbox control
textbox.setStyleSheet(self._default_style_sheet)
# Get reference to timer and delete
sender = self.sender()
if not sender is None:
sender.deleteLater()
def apply_debug_logging(self):
# Save debug logging
logger = logging.getLogger('stdm')
if self.chk_logging.checkState() == Qt.Checked:
logger.setLevel(logging.DEBUG)
set_debug_logging(True)
else:
logger.setLevel(logging.ERROR)
set_debug_logging(False)
def apply_settings(self):
"""
Save settings.
:return: True if the settings were successfully applied, otherwise
False.
:rtype: bool
"""
# Set current profile
if not self.set_current_profile():
return False
# Set db connection properties
if not self.save_database_properties():
return False
# Set CMIS properties
if not self.set_cmis_properties():
return False
# Set holders configuration file path
if not self.set_holders_config_file():
return False
# Set document designer templates path
if not self.set_document_templates_path():
return False
# Set document generator output path
if not self.set_document_output_path():
return False
self.apply_debug_logging()
msg = self.tr('Settings successfully saved.')
self.notif_bar.insertSuccessNotification(msg)
return True
def on_accept(self):
"""
Slot raised to save the settings of the current widget and close the
widget.
"""
if not self.apply_settings():
return
self.accept()
class LicenseAgreement(WIDGET, BASE):
def __init__(self, parent=None):
"""
This class checks if the user has accepted the
license terms and conditions or not . It shows the
terms and conditions if not.
:param parent: The container of the dialog
:type parent: QMainWindow or None
:return: None
:rtype: NoneType
"""
QDialog.__init__(self, parent)
self.setupUi(self)
self.reg_config = RegistryConfig()
self.notice_bar = NotificationBar(self.notifBar)
self.accepted = False
self.btnAccept.clicked.connect(self.accept_action)
self.btnDecline.clicked.connect(self.decline_action)
self.label.setStyleSheet('''
QLabel {
font: bold;
}
''')
def check_show_license(self):
"""
Checks if you need to show the license page.
Checks if the flag in the registry has been set.
Returns True to show license. If registry key
is not yet set, show the license page.
:rtype: boolean
"""
show_lic = 1
license_key = self.reg_config.read([SHOW_LICENSE])
if len(license_key) > 0:
show_lic = license_key[SHOW_LICENSE]
if show_lic == 1 or show_lic == str(1):
return True
elif show_lic == 0 or show_lic == str(0):
self.accepted = True
return False
def show_license(self):
"""
Show STDM license window if the user have never
accepted the license terms and conditions.
:return: None
:rtype: NoneType
"""
# validate if to show license
show_lic = self.check_show_license()
# THe user didn't accept license
if show_lic:
license = LicenseDocument()
self.termsCondArea.setText(license.read_license_info())
self.exec_()
def accept_action(self):
"""
A slot raised when the user clicks on the Accept button.
:return: None
:rtype: NoneType
"""
if not self.checkBoxAgree.isChecked():
msg = QApplication.translate(
'LicenseAgreement', 'To use STDM, please accept the terms '
'and conditions by selecting'
' the checkbox "I have read and agree ..."')
self.notice_bar.clear()
self.notice_bar.insertNotification(msg, ERROR)
return
else:
self.reg_config.write({SHOW_LICENSE: 0})
self.accepted = True
self.close()
def decline_action(self):
"""
A slot raised when the user clicks on
the decline button.
:return: None
:rtype: NoneType
"""
self.accepted = False
self.close()
def save_entity_browser_record_limit(limit):
"""
type limit:int
"""
reg_config = RegistryConfig()
reg_config.write({ENTITY_BROWSER_RECORD_LIMIT:limit})
class OptionsDialog(QDialog, Ui_DlgOptions):
"""
Dialog for editing STDM settings.
"""
def __init__(self, iface):
QDialog.__init__(self, iface.mainWindow())
self.setupUi(self)
self.iface = iface
self.notif_bar = NotificationBar(self.vlNotification, 6000)
self._apply_btn = self.buttonBox.button(QDialogButtonBox.Apply)
self._reg_config = RegistryConfig()
self._db_config = DatabaseConfig()
version = version_from_metadata()
upgrade_label_text = self.label_9.text().replace('1.4', version)
self.label_9.setText(upgrade_label_text)
#Connect signals
self._apply_btn.clicked.connect(self.apply_settings)
self.buttonBox.accepted.connect(self.on_accept)
self.chk_pg_connections.toggled.connect(self._on_use_pg_connections)
self.cbo_pg_connections.currentIndexChanged.connect(
self._on_pg_profile_changed)
self.btn_db_conn_clear.clicked.connect(self.clear_properties)
self.btn_test_db_connection.clicked.connect(self._on_test_connection)
self.btn_supporting_docs.clicked.connect(
self._on_choose_supporting_docs_path
)
self.btn_template_folder.clicked.connect(
self._on_choose_doc_designer_template_path
)
self.btn_composer_out_folder.clicked.connect(
self._on_choose_doc_generator_output_path
)
self.upgradeButton.toggled.connect(
self.manage_upgrade
)
self._config = StdmConfiguration.instance()
self._default_style_sheet = self.txtRepoLocation.styleSheet()
self.manage_upgrade()
self.init_gui()
def init_gui(self):
#Set integer validator for the port number
int_validator = QIntValidator(1024, 49151)
self.txtPort.setValidator(int_validator)
#Load profiles
self.load_profiles()
#Set current profile in the combobox
curr_profile = current_profile()
if not curr_profile is None:
setComboCurrentIndexWithText(self.cbo_profiles, curr_profile.name)
#Load current database connection properties
self._load_db_conn_properties()
#Load existing PostgreSQL connections
self._load_qgis_pg_connections()
#Load directory paths
self._load_directory_paths()
self.edtEntityRecords.setMaximum(MAX_LIMIT)
self.edtEntityRecords.setValue(get_entity_browser_record_limit())
# Debug logging
lvl = debug_logging()
if lvl:
self.chk_logging.setCheckState(Qt.Checked)
else:
self.chk_logging.setCheckState(Qt.Unchecked)
def load_profiles(self):
"""
Load existing profiles into the combobox.
"""
profile_names = self._config.profiles.keys()
self.cbo_profiles.clear()
self.cbo_profiles.addItem('')
self.cbo_profiles.addItems(profile_names)
def _load_db_conn_properties(self):
#Load database connection properties from the registry.
db_conn = self._db_config.read()
if not db_conn is None:
self.txtHost.setText(db_conn.Host)
self.txtPort.setText(db_conn.Port)
self.txtDatabase.setText(db_conn.Database)
def _load_qgis_pg_connections(self):
"""
Load QGIS postgres connections.
"""
self.cbo_pg_connections.addItem('')
profiles = pg_profile_names()
for profile in profiles:
self.cbo_pg_connections.addItem(profile[0], profile[1])
def _load_directory_paths(self):
#Load paths to various directory settings.
comp_out_path = composer_output_path()
comp_temp_path = composer_template_path()
source_doc_path = source_documents_path()
if not source_doc_path is None:
self.txtRepoLocation.setText(source_doc_path)
if not comp_out_path is None:
self.txt_output_dir.setText(comp_out_path)
if not comp_temp_path is None:
self.txt_template_dir.setText(comp_temp_path)
def _on_use_pg_connections(self, state):
#Slot raised when to (not) use existing pg connections
if not state:
self.cbo_pg_connections.setCurrentIndex(0)
self.cbo_pg_connections.setEnabled(False)
#Restore current connection in registry
self._load_db_conn_properties()
else:
self.cbo_pg_connections.setEnabled(True)
def _on_pg_profile_changed(self, index):
"""
Slot raised when the index of the pg profile changes. If the
selection is valid then the system will attempt to extract
the database connection properties of the selected profile
stored in the registry.
"""
if index == 0:
return
profile_path = self.cbo_pg_connections.itemData(index)
q_config = QGISRegistryConfig(profile_path)
db_items = q_config.read(['Database', 'Host', 'Port'])
if len(db_items) > 0:
self.txtDatabase.setText(db_items['Database'])
self.txtHost.setText(db_items['Host'])
self.txtPort.setText(db_items['Port'])
def clear_properties(self):
"""
Clears the host, database name and port number values from the
respective controls.
"""
self.txtDatabase.clear()
self.txtHost.clear()
self.txtPort.clear()
def _on_choose_supporting_docs_path(self):
#Slot raised to select directory for supporting documents.
self._set_selected_directory(self.txtRepoLocation, self.tr(
'Supporting Documents Directory')
)
def _on_choose_doc_designer_template_path(self):
#Slot raised to select directory for document designer templates.
self._set_selected_directory(self.txt_template_dir, self.tr(
'Document Designer Templates Directory')
)
def _on_choose_doc_generator_output_path(self):
#Slot raised to select directory for doc generator outputs.
self._set_selected_directory(self.txt_output_dir, self.tr(
'Document Generator Output Directory')
)
def _set_selected_directory(self, txt_box, title):
def_path= txt_box.text()
sel_doc_path = QFileDialog.getExistingDirectory(self, title, def_path)
if sel_doc_path:
normalized_path = QDir.fromNativeSeparators(sel_doc_path)
txt_box.clear()
txt_box.setText(normalized_path)
def _validate_db_props(self):
#Test if all properties have been specified
status = True
self.notif_bar.clear()
if not self.txtHost.text():
msg = self.tr('Please specify the database host address.')
self.notif_bar.insertErrorNotification(msg)
status = False
if not self.txtPort.text():
msg = self.tr('Please specify the port number.')
self.notif_bar.insertErrorNotification(msg)
status = False
if not self.txtDatabase.text():
msg = self.tr('Please specify the database name.')
self.notif_bar.insertErrorNotification(msg)
status = False
return status
def _database_connection(self):
#Creates a databaase connection object from the specified args
host = self.txtHost.text()
port = self.txtPort.text()
database = self.txtDatabase.text()
#Create database connection object
db_conn = DatabaseConnection(host, port, database)
return db_conn
def _on_test_connection(self):
"""
Slot raised to test database connection.
"""
status = self._validate_db_props()
if not status:
return
login_dlg = loginDlg(self, True)
db_conn = self._database_connection()
login_dlg.set_database_connection(db_conn)
res = login_dlg.exec_()
if res == QDialog.Accepted:
msg = self.tr(u"Connection to '{0}' database was "
"successful.".format(db_conn.Database))
QMessageBox.information(self, self.tr('Database Connection'), msg)
def set_current_profile(self):
"""
Saves the given profile name as the current profile.
"""
profile_name = self.cbo_profiles.currentText()
if not profile_name:
self.notif_bar.clear()
msg = self.tr('Profile name is empty, current profile will not '
'be set.')
self.notif_bar.insertErrorNotification(msg)
return False
save_current_profile(profile_name)
return True
def save_database_properties(self):
"""
Saves the specified database connection properties to the registry.
:return: True if the connection properties were successfully saved.
:rtype: bool
"""
if not self._validate_db_props():
return False
#Create a database object and write it to the registry
db_conn = self._database_connection()
self._db_config.write(db_conn)
return True
def set_supporting_documents_path(self):
"""
Set the directory of supporting documents.
:return: True if the directory was set in the registry, otherwise
False.
:rtype: bool
"""
path = self.txtRepoLocation.text()
if not path:
msg = self.tr('Please set the supporting documents directory.')
self.notif_bar.insertErrorNotification(msg)
return False
#Validate path
if not self._check_path_exists(path, self.txtRepoLocation):
return False
#Commit to registry
self._reg_config.write({NETWORK_DOC_RESOURCE: path})
return True
def set_document_templates_path(self):
"""
Set the directory of document designer templates.
:return: True if the directory was set in the registry, otherwise
False.
:rtype: bool
"""
path = self.txt_template_dir.text()
if not path:
msg = self.tr('Please set the document designer templates '
'directory.')
self.notif_bar.insertErrorNotification(msg)
return False
#Validate path
if not self._check_path_exists(path, self.txt_template_dir):
return False
#Commit to registry
self._reg_config.write({COMPOSER_TEMPLATE: path})
return True
def set_document_output_path(self):
"""
Set the directory of document generator outputs.
:return: True if the directory was set in the registry, otherwise
False.
:rtype: bool
"""
path = self.txt_output_dir.text()
if not path:
msg = self.tr('Please set the document generator output directory'
'.')
self.notif_bar.insertErrorNotification(msg)
return False
#Validate path
if not self._check_path_exists(path, self.txt_output_dir):
return False
#Commit to registry
self._reg_config.write({COMPOSER_OUTPUT: path})
return True
def _check_path_exists(self, path, text_box):
#Validates if the specified folder exists
dir = QDir()
if not dir.exists(path):
msg = self.tr(u"'{0}' directory does not exist.".format(path))
self.notif_bar.insertErrorNotification(msg)
#Highlight textbox control
text_box.setStyleSheet(INVALIDATESTYLESHEET)
timer = QTimer(self)
#Sync interval with that of the notification bar
timer.setInterval(self.notif_bar.interval)
timer.setSingleShot(True)
#Remove previous connected slots (if any)
receivers = timer.receivers(SIGNAL('timeout()'))
if receivers > 0:
self._timer.timeout.disconnect()
timer.start()
timer.timeout.connect(lambda:self._restore_stylesheet(
text_box)
)
return False
return True
def _restore_stylesheet(self, textbox):
# Slot raised to restore the original stylesheet of the textbox control
textbox.setStyleSheet(self._default_style_sheet)
# Get reference to timer and delete
sender = self.sender()
if not sender is None:
sender.deleteLater()
def apply_debug_logging(self):
# Save debug logging
logger = logging.getLogger('stdm')
if self.chk_logging.checkState() == Qt.Checked:
logger.setLevel(logging.DEBUG)
set_debug_logging(True)
else:
logger.setLevel(logging.ERROR)
set_debug_logging(False)
def apply_settings(self):
"""
Save settings.
:return: True if the settings were successfully applied, otherwise
False.
:rtype: bool
"""
#Set current profile
if not self.set_current_profile():
return False
#Set db connection properties
if not self.save_database_properties():
return False
#Set supporting documents directory
if not self.set_supporting_documents_path():
return False
#Set document designer templates path
if not self.set_document_templates_path():
return False
#Set document generator output path
if not self.set_document_output_path():
return False
self.apply_debug_logging()
# Set Entity browser record limit
save_entity_browser_record_limit(self.edtEntityRecords.value())
msg = self.tr('Settings successfully saved.')
self.notif_bar.insertSuccessNotification(msg)
return True
def on_accept(self):
"""
Slot raised to save the settings of the current widget and close the
widget.
"""
if not self.apply_settings():
return
self.accept()
def manage_upgrade(self):
"""
A slot raised when the upgrade button is clicked.
It disables or enables the upgrade
button based on the ConfigUpdated registry value.
"""
self.config_updated_dic = self._reg_config.read(
[CONFIG_UPDATED]
)
# if config file exists, check if registry key exists
if len(self.config_updated_dic) > 0:
config_updated_val = self.config_updated_dic[
CONFIG_UPDATED
]
# If failed to upgrade, enable the upgrade button
if config_updated_val == '0' or config_updated_val == '-1':
self.upgradeButton.setEnabled(True)
# disable the button if any other value.
else:
self.upgradeButton.setEnabled(False)
else:
self.upgradeButton.setEnabled(False)
def save_entity_browser_record_limit(limit):
"""
type limit:int
"""
reg_config = RegistryConfig()
reg_config.write({ENTITY_BROWSER_RECORD_LIMIT: limit})
class UserShortcutDialog(QDialog, Ui_UserShortcutDialog):
"""
Dialog that provides shortcut actions upon successful login.
"""
def __init__(self, parent=None):
QDialog.__init__(self, parent)
self.setupUi(self)
self.reg_config = RegistryConfig()
self.accepted = True
# Scale widget sizes in the splitter
self.splitter.setSizes([250, 400])
self.load_categories()
# Connect signals
# On tree item changed
self.tr_title_category.itemSelectionChanged.connect(
self.on_category_item_changed)
self.lsw_category_action.itemDoubleClicked.connect(
self.on_category_list_item_db_clicked)
self.buttonBox.accepted.connect(self.accept_dlg)
# Select scheme item in the tree widget
self.tr_title_category.setCurrentItem(self.lht_scheme_item)
# Configure notification bar
self.notif_bar = NotificationBar(self.vlNotification)
# User selected action code upon accept
self._action_code = ''
def check_show_dialog(self):
"""
Checks if flag in the registry has been set.
Returns True to show shortcut dialog. If registry key
is not yet set, show the dialog.
:rtype: boolean
"""
show_dlg = 1
dialog_key = self.reg_config.read([SHOW_SHORTCUT_DIALOG])
if len(dialog_key) > 0:
show_dlg = dialog_key[SHOW_SHORTCUT_DIALOG]
if show_dlg == 1 or show_dlg == unicode(1):
return True
elif show_dlg == 0 or show_dlg == unicode(0):
self.accepted = True
return False
@property
def search_item_prefix(self):
"""
:return: Returns a prefix code to be appended in search-related
QListWidgetItems.
:rtype: str
"""
return 'SRCH_'
def show_dialog(self):
"""
Show shortcut dialog after login if the user has never
selected to hide dialog.
:return: None
:rtype: NoneType
"""
# validate if to show dialog
show_dlg = self.check_show_dialog()
# THe user didn't accept license
if show_dlg:
self.exec_()
@property
def action_code(self):
"""
:return:Returns the code representing the user action
:type: str
"""
return self._action_code
def module_icons(self):
"""
Accessing the module icon file display.
"""
# Container of list items based on category
self._scheme_items = []
self._certificate_items = []
self._report_items = []
self._search_items = []
self.lsi_lodge_scheme = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_lodgement.png'),
self.tr('Lodgement'))
self.lsi_establish_scheme = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_scheme_establishment.png'),
self.tr('Establishment'))
self.lsi_first_examination = QListWidgetItem(
QIcon(
':/plugins/stdm/images/icons/flts_scheme_management_assessment1.png'
), self.tr('First Examination'))
self.lsi_second_examination = QListWidgetItem(
QIcon(
':/plugins/stdm/images/icons/flts_scheme_management_assessment2.png'
), self.tr('Second Examination'))
self.lsi_third_examination = QListWidgetItem(
QIcon(
':/plugins/stdm/images/icons/flts_scheme_management_assessment3.png'
), self.tr('Third Examination'))
self.lsi_revision = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_revision.png'),
self.tr('Revision'))
self.lsi_import_plots = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_scheme_import_plot.png'),
self.tr('Import Plots'))
self.lsi_design_certificate = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_document_designer.png'),
self.tr('Design Certificate'))
self.lsi_print_certificate = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_document_generator.png'),
self.tr('Generate Certificate'))
self.lsi_scan_certificate = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_certificate_scan.png'),
self.tr('Upload Certificate'))
self.lsi_search = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_search.png'),
self.tr('Search'))
self.lsi_search_holder = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_search_holder.png'),
self.tr('Holder'))
self.lsi_search_plot = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_search_plot.png'),
self.tr('Plot'))
self.lsi_design_report = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_document_designer.png'),
self.tr('Design Report'))
self.lsi_report = QListWidgetItem(
QIcon(':/plugins/stdm/images/icons/flts_report.png'),
self.tr('Generate Report'))
# Assign unique identifier to the list item
self.lsi_lodge_scheme.setData(Qt.UserRole, 'LDG_SCM')
self.lsi_establish_scheme.setData(Qt.UserRole, 'EST_SCM')
self.lsi_first_examination.setData(Qt.UserRole, 'EXM_SCM')
self.lsi_second_examination.setData(Qt.UserRole, 'EXM2_SCM')
self.lsi_third_examination.setData(Qt.UserRole, 'EXM3_SCM')
self.lsi_import_plots.setData(Qt.UserRole, 'PLT_SCM')
self.lsi_design_certificate.setData(Qt.UserRole, 'D_CRT')
self.lsi_design_report.setData(Qt.UserRole, 'D_CRT')
self.lsi_scan_certificate.setData(Qt.UserRole, 'S_CRT')
self.lsi_report.setData(Qt.UserRole, 'G_RPT')
self.lsi_search.setData(Qt.UserRole, 'SRC')
# Assigning items to the scheme items
self._scheme_items.append(self.lsi_lodge_scheme)
self._scheme_items.append(self.lsi_establish_scheme)
self._scheme_items.append(self.lsi_first_examination)
self._scheme_items.append(self.lsi_second_examination)
self._scheme_items.append(self.lsi_third_examination)
self._scheme_items.append(self.lsi_import_plots)
# Certificate items
self._certificate_items.append(self.lsi_design_certificate)
self._certificate_items.append(self.lsi_scan_certificate)
# Search items adapted from items in the registry
self._search_items = self._search_list_items()
# Report items
self._report_items.append(self.lsi_design_report)
self._report_items.append(self.lsi_report)
def _search_list_items(self):
# Creates a list of QListWidgetItems based on the search
# configuration items in the search registry.
search_items = []
for act in SearchConfigurationRegistry.instance().actions():
si = QListWidgetItem(act.icon(), act.text())
# Code based on search prefix and data source name
code = self.search_item_prefix + act.data()
si.setData(Qt.UserRole, code)
search_items.append(si)
return search_items
def load_categories(self):
# Load items based on category selection
self.lht_tr_item = QTreeWidgetItem(['Land Hold Title', 'LHT'])
self.lht_scheme_item = QTreeWidgetItem(['Scheme', 'SCM'])
self.lht_certificate_item = QTreeWidgetItem(['Certificate', 'CRT'])
self.lht_search_item = QTreeWidgetItem(['Search', 'SRC'])
self.lht_report_item = QTreeWidgetItem(['Report', 'RPT'])
self.tr_title_category.addTopLevelItem(self.lht_tr_item)
# Hide code column
self.tr_title_category.hideColumn(1)
self.lht_tr_item.addChild(self.lht_scheme_item)
self.lht_tr_item.addChild(self.lht_search_item)
self.lht_tr_item.addChild(self.lht_certificate_item)
self.lht_tr_item.addChild(self.lht_report_item)
# Expand base categories
self.tr_title_category.expandItem(self.lht_tr_item)
def _clear_category_items(self):
# Remove all items without deleting them
for i in range(self.lsw_category_action.count()):
row_item = self.lsw_category_action.item(i)
if row_item != 0:
self.lsw_category_action.takeItem(i)
def _load_category_items(self, lst_items):
for it in lst_items:
self.lsw_category_action.addItem(it)
def on_category_item_changed(self):
# Load list items based on selected category
# Clear list first
self.lsw_category_action.clear()
sel_tr_items = self.tr_title_category.selectedItems()
if len(sel_tr_items) == 0:
return
self.module_icons()
# Get selected items
tr_cat_item = sel_tr_items[0]
cat_code = tr_cat_item.data(1, Qt.DisplayRole)
if cat_code == 'SCM':
self._load_category_items(self._scheme_items)
elif cat_code == 'CRT':
self._load_category_items(self._certificate_items)
elif cat_code == 'RPT':
self._load_category_items(self._report_items)
elif cat_code == 'SRC':
self._load_category_items(self._search_items)
def on_category_list_item_db_clicked(self, item):
# Load dialog based on specified action
# get selected items
data = item.data(Qt.UserRole)
self._action_code = data
self.accept_dlg()
def accept_dlg(self):
# Check if the user has selected an action from the list widget
self.notif_bar.clear()
selected_items = self.lsw_category_action.selectedItems()
if len(selected_items) == 0:
self.notif_bar.insertWarningNotification(
self.tr("Please select an operation to perform"))
return
self._action_code = selected_items[0].data(Qt.UserRole)
if self.chb_donotshow.isChecked():
self.reg_config.write({SHOW_SHORTCUT_DIALOG: 0})
self.accepted = True
self.accept()
def save_entity_sort_order(sort_order):
"""
:type sort_order: str
"""
reg_config = RegistryConfig()
reg_config.write({ENTITY_SORT_ORDER: sort_order})
class OptionsDialog(QDialog, Ui_DlgOptions):
"""
Dialog for editing STDM settings.
"""
def __init__(self, iface):
QDialog.__init__(self, iface.mainWindow())
self.setupUi(self)
self.iface = iface
self.notif_bar = NotificationBar(self.vlNotification, 6000)
self._apply_btn = self.buttonBox.button(QDialogButtonBox.Apply)
self._reg_config = RegistryConfig()
self._db_config = DatabaseConfig()
#Connect signals
self._apply_btn.clicked.connect(self.apply_settings)
self.buttonBox.accepted.connect(self.on_accept)
self.chk_pg_connections.toggled.connect(self._on_use_pg_connections)
self.cbo_pg_connections.currentIndexChanged.connect(
self._on_pg_profile_changed)
self.btn_db_conn_clear.clicked.connect(self.clear_properties)
self.btn_test_db_connection.clicked.connect(self._on_test_connection)
self.btn_supporting_docs.clicked.connect(
self._on_choose_supporting_docs_path)
self.btn_template_folder.clicked.connect(
self._on_choose_doc_designer_template_path)
self.btn_composer_out_folder.clicked.connect(
self._on_choose_doc_generator_output_path)
self.upgradeButton.toggled.connect(self.manage_upgrade)
self._config = StdmConfiguration.instance()
self._default_style_sheet = self.txtRepoLocation.styleSheet()
self.manage_upgrade()
self.init_gui()
def init_gui(self):
#Set integer validator for the port number
int_validator = QIntValidator(1024, 49151)
self.txtPort.setValidator(int_validator)
#Load profiles
self.load_profiles()
#Set current profile in the combobox
curr_profile = current_profile()
if not curr_profile is None:
setComboCurrentIndexWithText(self.cbo_profiles, curr_profile.name)
#Load current database connection properties
self._load_db_conn_properties()
#Load existing PostgreSQL connections
self._load_qgis_pg_connections()
#Load directory paths
self._load_directory_paths()
# Debug logging
lvl = debug_logging()
if lvl:
self.chk_logging.setCheckState(Qt.Checked)
else:
self.chk_logging.setCheckState(Qt.Unchecked)
def load_profiles(self):
"""
Load existing profiles into the combobox.
"""
profile_names = self._config.profiles.keys()
self.cbo_profiles.clear()
self.cbo_profiles.addItem('')
self.cbo_profiles.addItems(profile_names)
def _load_db_conn_properties(self):
#Load database connection properties from the registry.
db_conn = self._db_config.read()
if not db_conn is None:
self.txtHost.setText(db_conn.Host)
self.txtPort.setText(db_conn.Port)
self.txtDatabase.setText(db_conn.Database)
def _load_qgis_pg_connections(self):
"""
Load QGIS postgres connections.
"""
self.cbo_pg_connections.addItem('')
profiles = pg_profile_names()
for profile in profiles:
self.cbo_pg_connections.addItem(profile[0], profile[1])
def _load_directory_paths(self):
#Load paths to various directory settings.
comp_out_path = composer_output_path()
comp_temp_path = composer_template_path()
source_doc_path = source_documents_path()
if not source_doc_path is None:
self.txtRepoLocation.setText(source_doc_path)
if not comp_out_path is None:
self.txt_output_dir.setText(comp_out_path)
if not comp_temp_path is None:
self.txt_template_dir.setText(comp_temp_path)
def _on_use_pg_connections(self, state):
#Slot raised when to (not) use existing pg connections
if not state:
self.cbo_pg_connections.setCurrentIndex(0)
self.cbo_pg_connections.setEnabled(False)
#Restore current connection in registry
self._load_db_conn_properties()
else:
self.cbo_pg_connections.setEnabled(True)
def _on_pg_profile_changed(self, index):
"""
Slot raised when the index of the pg profile changes. If the
selection is valid then the system will attempt to extract
the database connection properties of the selected profile
stored in the registry.
"""
if index == 0:
return
profile_path = self.cbo_pg_connections.itemData(index)
q_config = QGISRegistryConfig(profile_path)
db_items = q_config.read(['Database', 'Host', 'Port'])
if len(db_items) > 0:
self.txtDatabase.setText(db_items['Database'])
self.txtHost.setText(db_items['Host'])
self.txtPort.setText(db_items['Port'])
def clear_properties(self):
"""
Clears the host, database name and port number values from the
respective controls.
"""
self.txtDatabase.clear()
self.txtHost.clear()
self.txtPort.clear()
def _on_choose_supporting_docs_path(self):
#Slot raised to select directory for supporting documents.
self._set_selected_directory(self.txtRepoLocation,
self.tr('Supporting Documents Directory'))
def _on_choose_doc_designer_template_path(self):
#Slot raised to select directory for document designer templates.
self._set_selected_directory(
self.txt_template_dir,
self.tr('Document Designer Templates Directory'))
def _on_choose_doc_generator_output_path(self):
#Slot raised to select directory for doc generator outputs.
self._set_selected_directory(
self.txt_output_dir,
self.tr('Document Generator Output Directory'))
def _set_selected_directory(self, txt_box, title):
def_path = txt_box.text()
sel_doc_path = QFileDialog.getExistingDirectory(self, title, def_path)
if sel_doc_path:
normalized_path = QDir.fromNativeSeparators(sel_doc_path)
txt_box.clear()
txt_box.setText(normalized_path)
def _validate_db_props(self):
#Test if all properties have been specified
status = True
self.notif_bar.clear()
if not self.txtHost.text():
msg = self.tr('Please specify the database host address.')
self.notif_bar.insertErrorNotification(msg)
status = False
if not self.txtPort.text():
msg = self.tr('Please specify the port number.')
self.notif_bar.insertErrorNotification(msg)
status = False
if not self.txtDatabase.text():
msg = self.tr('Please specify the database name.')
self.notif_bar.insertErrorNotification(msg)
status = False
return status
def _database_connection(self):
#Creates a databaase connection object from the specified args
host = self.txtHost.text()
port = self.txtPort.text()
database = self.txtDatabase.text()
#Create database connection object
db_conn = DatabaseConnection(host, port, database)
return db_conn
def _on_test_connection(self):
"""
Slot raised to test database connection.
"""
status = self._validate_db_props()
if not status:
return
login_dlg = loginDlg(self, True)
db_conn = self._database_connection()
login_dlg.set_database_connection(db_conn)
res = login_dlg.exec_()
if res == QDialog.Accepted:
msg = self.tr(u"Connection to '{0}' database was "
"successful.".format(db_conn.Database))
QMessageBox.information(self, self.tr('Database Connection'), msg)
def set_current_profile(self):
"""
Saves the given profile name as the current profile.
"""
profile_name = self.cbo_profiles.currentText()
if not profile_name:
self.notif_bar.clear()
msg = self.tr('Profile name is empty, current profile will not '
'be set.')
self.notif_bar.insertErrorNotification(msg)
return False
save_current_profile(profile_name)
return True
def save_database_properties(self):
"""
Saves the specified database connection properties to the registry.
:return: True if the connection properties were successfully saved.
:rtype: bool
"""
if not self._validate_db_props():
return False
#Create a database object and write it to the registry
db_conn = self._database_connection()
self._db_config.write(db_conn)
return True
def set_supporting_documents_path(self):
"""
Set the directory of supporting documents.
:return: True if the directory was set in the registry, otherwise
False.
:rtype: bool
"""
path = self.txtRepoLocation.text()
if not path:
msg = self.tr('Please set the supporting documents directory.')
self.notif_bar.insertErrorNotification(msg)
return False
#Validate path
if not self._check_path_exists(path, self.txtRepoLocation):
return False
#Commit to registry
self._reg_config.write({NETWORK_DOC_RESOURCE: path})
return True
def set_document_templates_path(self):
"""
Set the directory of document designer templates.
:return: True if the directory was set in the registry, otherwise
False.
:rtype: bool
"""
path = self.txt_template_dir.text()
if not path:
msg = self.tr('Please set the document designer templates '
'directory.')
self.notif_bar.insertErrorNotification(msg)
return False
#Validate path
if not self._check_path_exists(path, self.txt_template_dir):
return False
#Commit to registry
self._reg_config.write({COMPOSER_TEMPLATE: path})
return True
def set_document_output_path(self):
"""
Set the directory of document generator outputs.
:return: True if the directory was set in the registry, otherwise
False.
:rtype: bool
"""
path = self.txt_output_dir.text()
if not path:
msg = self.tr('Please set the document generator output directory'
'.')
self.notif_bar.insertErrorNotification(msg)
return False
#Validate path
if not self._check_path_exists(path, self.txt_output_dir):
return False
#Commit to registry
self._reg_config.write({COMPOSER_OUTPUT: path})
return True
def _check_path_exists(self, path, text_box):
#Validates if the specified folder exists
dir = QDir()
if not dir.exists(path):
msg = self.tr(u"'{0}' directory does not exist.".format(path))
self.notif_bar.insertErrorNotification(msg)
#Highlight textbox control
text_box.setStyleSheet(INVALIDATESTYLESHEET)
timer = QTimer(self)
#Sync interval with that of the notification bar
timer.setInterval(self.notif_bar.interval)
timer.setSingleShot(True)
#Remove previous connected slots (if any)
receivers = timer.receivers(SIGNAL('timeout()'))
if receivers > 0:
self._timer.timeout.disconnect()
timer.start()
timer.timeout.connect(lambda: self._restore_stylesheet(text_box))
return False
return True
def _restore_stylesheet(self, textbox):
# Slot raised to restore the original stylesheet of the textbox control
textbox.setStyleSheet(self._default_style_sheet)
# Get reference to timer and delete
sender = self.sender()
if not sender is None:
sender.deleteLater()
def apply_debug_logging(self):
# Save debug logging
logger = logging.getLogger('stdm')
if self.chk_logging.checkState() == Qt.Checked:
logger.setLevel(logging.DEBUG)
set_debug_logging(True)
else:
logger.setLevel(logging.ERROR)
set_debug_logging(False)
def apply_settings(self):
"""
Save settings.
:return: True if the settings were successfully applied, otherwise
False.
:rtype: bool
"""
#Set current profile
if not self.set_current_profile():
return False
#Set db connection properties
if not self.save_database_properties():
return False
#Set supporting documents directory
if not self.set_supporting_documents_path():
return False
#Set document designer templates path
if not self.set_document_templates_path():
return False
#Set document generator output path
if not self.set_document_output_path():
return False
self.apply_debug_logging()
msg = self.tr('Settings successfully saved.')
self.notif_bar.insertSuccessNotification(msg)
return True
def on_accept(self):
"""
Slot raised to save the settings of the current widget and close the
widget.
"""
if not self.apply_settings():
return
self.accept()
def manage_upgrade(self):
"""
A slot raised when the upgrade button is clicked.
It disables or enables the upgrade
button based on the ConfigUpdated registry value.
"""
self.config_updated_dic = self._reg_config.read([CONFIG_UPDATED])
# if config file exists, check if registry key exists
if len(self.config_updated_dic) > 0:
config_updated_val = self.config_updated_dic[CONFIG_UPDATED]
# If failed to upgrade, enable the upgrade button
if config_updated_val == '0' or config_updated_val == '-1':
self.upgradeButton.setEnabled(True)
# disable the button if any other value.
else:
self.upgradeButton.setEnabled(False)
else:
self.upgradeButton.setEnabled(False)
class ConfigTableReader(object):
def __init__(self, parent=None, args=None):
self._doc = ''
self.args = args
self.fileHandler = FilePaths()
self.config = RegistryConfig()
def tableListModel(self, profile):
'''pass the table list to a listview model'''
tData = self.tableNames(profile)
if not tData is None:
model = listEntityViewer(tData)
return model
else:
return None
def profile_tables(self, profile):
table_desc = tableFullDescription(profile)
if table_desc:
headers = table_desc[0].keys()
rowData = [row.values() for row in table_desc]
table_desc_model = EntityColumnModel(headers, rowData)
return table_desc_model
def tableNames(self, profile):
tbl_data = XMLTableElement(profile)
if tbl_data is not None:
# if "social_tenure" in tData:
# tData.remove('social_tenure')
return tbl_data
def current_profile_tables(self):
"""
:return: Returns a list containing table names in the current
profile.
:rtype: list
"""
try:
curr_profile = activeProfile()
return self.tableNames(curr_profile)
except ProfileException:
raise
def table_columns(self, table):
"""
:param table: Name of the table.
:type table: str
:return: Returns a list of the columns of the specified in order in
which they were created.
:rtype: list
"""
return tableCols(table)
def fulltableList(self):
tbList = tableLookUpCollection()
if not tbList is None:
return tbList
def on_main_table_selection(self):
"""
Method required by the wizard for loading all the table in a model
to a combo box
:return:
"""
tbl_list = self.fulltableList()
tbl_model = listEntityViewer(tbl_list)
return tbl_model
def STDMProfiles(self):
pfList = profiles()
return pfList
def lookupTableModel(self):
model = listEntityViewer(self.lookupTable())
return model
def lookupTable(self):
return lookupTable()
def lookupColumns(self, lookupName):
columnModel = None
tableAttrib = lookupColumn(lookupName)
if len(tableAttrib) > 0:
colHeaders = tableAttrib[0].keys()
colVals = []
# [item.values for item in tableAttrib]
for item in tableAttrib:
colVals.append(item.values())
columnModel = EntityColumnModel(colHeaders, colVals)
return columnModel
else:
return None
def columns(self, profile, tableName):
'''Functions to read columns details from the config for the given table'''
columnModel = None
tableAttrib = tableColumns(profile, tableName)
if len(tableAttrib) > 0:
colHeaders = tableAttrib[0].keys()
colVals = [item.values() for item in tableAttrib]
#for item in tableAttrib:
# colVals.append(item.values())
columnModel = EntityColumnModel(colHeaders, colVals)
return columnModel
else:
return None
def column_labels(self, col_list):
"""
Method to read and return the defined column labels for the table as a model
:param list:
:return:Listmodel
"""
return listEntityViewer(col_list, icon=dataIcon)
def table_searchable_columns(self, table):
"""
Method to read all searchable field from the config for the table
:param table:
:return:cols: List
"""
return table_searchable_cols(table)
def social_tenure_tables(self):
"""
Method to read all tables participating in STR
:return:tables: List
"""
if not social_tenure_tables(activeProfile()):
return []
else:
return social_tenure_tables(activeProfile())
def tableRelation(self, tableName):
'''Method to read all defined table relationship in the config file'''
relationModel = None
tableAttrib = tableRelations(tableName, "relations")
if tableAttrib is None:
return tableAttrib
if len(tableAttrib) > 0:
colHeaders = tableAttrib[0].keys()
colVals = []
for item in tableAttrib:
colVals.append(item.values())
relationModel = EntityColumnModel(colHeaders, colVals)
return relationModel
def geometry_collection(self, tableName):
'''Method to read all defined table relationship in the config file'''
geometryModel = None
geomAttrib = geometryColumns(tableName, 'geometryz')
if geomAttrib == None:
return geomAttrib
if len(geomAttrib) > 0:
colHeaders = geomAttrib[0].keys()
colVals = []
for item in geomAttrib:
colVals.append(item.values())
geometryModel = EntityColumnModel(colHeaders, colVals)
return geometryModel
def sqlTableDefinition(self):
'''load the table definition info in html file'''
docfile = self.fileHandler.SQLFile()
return docfile
def htmlTableDefinition(self):
'''load the table definition info in html file'''
docfile = self.fileHandler.HtmlFile()
return docfile
def userProfileDir(self):
return self.fileHandler.STDMSettingsPath()
def updateDir(self, path):
return self.fileHandler.userConfigPath(path)
def saveXMLchanges(self):
writeSQLFile()
writeHTML()
def upDateSQLSchema(self):
#To be implemented to allow updating of schema
updateSQL()
def setProfileSettings(self, profileData):
'''write the current profile in Qsettings'''
self.config.write(profileData)
def settingsKeys(self):
'''
Keys used to store directory paths in the database
'''
return PATHKEYS
def pathSettings(self):
pathKeys = self.settingsKeys()
pathSetting = self.config.read(pathKeys)
return pathKeys, pathSetting
def createDir(self, paths):
if paths != None:
for fPath in paths:
self.fileHandler.createDir(fPath)
def addLookupValue(self, table, valueText):
setLookupValue(table, valueText)
def readLookupList(self, table):
lookupList = []
try:
lookupList = lookupData(table)
except:
pass
lookupModel = listEntityViewer(lookupList, icon=dataIcon)
return lookupModel
def setDocumentationPath(self):
'''get the help contents available to user'''
helpFile = self.fileHandler.HelpContents()
return helpFile
def trackXMLChanges(self):
self.fileHandler.createBackup()
def check_config_version(self, path):
self.fileHandler.compare_config_version(path)
def active_profile(self):
return activeProfile()
def selected_table_columns(self, table):
"""
Method to return the selected table colums as alist
:param table name STR:
:return: List
"""
return tableCols(table)
def update_str_tables(self, table, level):
set_str_tables(activeProfile(), table, level)
def set_str_type_collection(self, table, optiontype):
"""
Method to update the config to show the str type of individual str table
:param table:
:return:
"""
str_type_tables(activeProfile(), table, optiontype)
def set_table_str_columns(self, table, collist):
"""
Method to set all the tables column participating in STR
:param table:
:return:
"""
str_col_collection(activeProfile(), table, collist)
def social_tenure_col(self, table):
"""
Method to read str columns from config
:param table:
:return:
"""
return read_social_relation_cols(table)
def social_tenure_table_types(self):
"""
Method to read and return the party and spatial unit str tables
respectively
:return:String
"""
return social_tenure_tables_type(activeProfile())
def read_config_version(self):
"""
Method to read and return the config version to avoid obsolete method
returning none
:return:
"""
return config_version()
def update_config_file(self):
"""
Try and update the config file if old one is detected
:return:
"""
self.fileHandler.change_config()
def chect_table_exist(self, table):
"""
If the table is already defined in config
:return:
"""
if current_table_exist(table):
return True
else:
return False
class LicenseAgreement(QDialog, Ui_LicenseAgreement):
def __init__(self, parent=None):
"""
This class checks if the user has accepted the
license terms and conditions or not . It shows the
terms and conditions if not.
:param parent: The container of the dialog
:type parent: QMainWindow or None
:return: None
:rtype: NoneType
"""
QDialog.__init__(self, parent)
self.setupUi(self)
self.reg_config = RegistryConfig()
self.notice_bar = NotificationBar(self.notifBar)
self.accepted = False
self.btnAccept.clicked.connect(self.accept_action)
self.btnDecline.clicked.connect(self.decline_action)
self.label.setStyleSheet(
'''
QLabel {
font: bold;
}
'''
)
def check_show_license(self):
"""
Checks if you need to show the license page.
Checks if the flag in the registry has been set.
Returns True to show license. If registry key
is not yet set, show the license page.
:rtype: boolean
"""
show_lic = 1
license_key = self.reg_config.read(
[SHOW_LICENSE]
)
if len(license_key) > 0:
show_lic = license_key[SHOW_LICENSE]
if show_lic == 1 or show_lic == unicode(1):
return True
elif show_lic == 0 or show_lic == unicode(0):
self.accepted = True
return False
def show_license(self):
"""
Show STDM license window if the user have never
accepted the license terms and conditions.
:return: None
:rtype: NoneType
"""
# validate if to show license
show_lic = self.check_show_license()
# THe user didn't accept license
if show_lic:
license = LicenseDocument()
self.termsCondArea.setText(
license.read_license_info()
)
self.exec_()
def accept_action(self):
"""
A slot raised when the user clicks on the Accept button.
:return: None
:rtype: NoneType
"""
if not self.checkBoxAgree.isChecked():
msg = QApplication.translate(
'LicenseAgreement',
'To use STDM, please accept the terms '
'and conditions by selecting'
' the checkbox "I have read and agree ..."'
)
self.notice_bar.clear()
self.notice_bar.insertNotification(msg, ERROR)
return
else:
self.reg_config.write({SHOW_LICENSE: 0})
self.accepted = True
self.close()
def decline_action(self):
"""
A slot raised when the user clicks on
the decline button.
:return: None
:rtype: NoneType
"""
self.accepted = False
self.close()