"""Base class for the edition dialog.""" import json import re from collections import OrderedDict from typing import Union from qgis.core import QgsProject, QgsSettings, QgsVectorLayer from qgis.PyQt.QtCore import QLocale, Qt, QUrl from qgis.PyQt.QtGui import QBrush, QColor, QDesktopServices, QIcon from qgis.PyQt.QtWidgets import QDialog, QDialogButtonBox, QPlainTextEdit from lizmap import DEFAULT_LWC_VERSION from lizmap.definitions.base import InputType from lizmap.definitions.definitions import ( DOC_URL, ONLINE_HELP_LANGUAGES, LwcVersions, ) from lizmap.qgis_plugin_tools.tools.i18n import tr from lizmap.qt_style_sheets import NEW_FEATURE_COLOR, NEW_FEATURE_CSS __copyright__ = 'Copyright 2020, 3Liz' __license__ = 'GPL version 3' __email__ = 'info@3liz.org' class BaseEditionDialog(QDialog): def __init__(self, parent=None, unicity=None): super().__init__(parent) self.config = None self.unicity = unicity self.lwc_versions = OrderedDict() self.lwc_versions[LwcVersions.Lizmap_3_1] = [] self.lwc_versions[LwcVersions.Lizmap_3_2] = [] self.lwc_versions[LwcVersions.Lizmap_3_3] = [] self.lwc_versions[LwcVersions.Lizmap_3_4] = [] def setup_ui(self): self.button_box.button(QDialogButtonBox.Help).setToolTip( tr('Open the online documentation for this feature.')) if not self.config.help_path(): self.button_box.button(QDialogButtonBox.Help).setVisible(False) self.button_box.button(QDialogButtonBox.Help).clicked.connect(self.open_help) self.button_box.button(QDialogButtonBox.Cancel).clicked.connect(self.close) self.button_box.button(QDialogButtonBox.Ok).clicked.connect(self.accept) self.error.setVisible(False) for layer_config in self.config.layer_config.values(): widget = layer_config.get('widget') tooltip = layer_config.get('tooltip') if tooltip: label = layer_config.get('label') if label: label.setToolTip(tooltip) if widget: widget.setToolTip(tooltip) if layer_config['type'] == InputType.List: if widget is not None: items = layer_config.get('items') if items: for item in items: icon = item.value.get('icon') if icon: widget.addItem(QIcon(icon), item.value['label'], item.value['data']) else: widget.addItem(item.value['label'], item.value['data']) default = layer_config.get('default') if default: index = widget.findData(default.value['data']) widget.setCurrentIndex(index) if layer_config['type'] == InputType.CheckBox: default_value = layer_config['default'] if widget is not None and not hasattr(default_value, '__call__'): widget.setChecked(default_value) if layer_config['type'] == InputType.SpinBox: if widget is not None: unit = layer_config.get('unit') if unit: widget.setSuffix(unit) default = layer_config.get('default') if unit: widget.setValue(default) if layer_config['type'] == InputType.Color: if widget is not None: if layer_config['default'] == '': widget.setShowNull(True) widget.setToNull() else: widget.setDefaultColor(QColor(layer_config['default'])) widget.setToDefaultColor() if layer_config.get('read_only'): if widget is not None: if layer_config['type'] == InputType.Text: widget.setReadOnly(True) elif layer_config['type'] == InputType.CheckBox: # Some UX issues #338 # The disabled is not possible somehow ? # The tooltip is not showing widget.setText(tr('Read only, check the tooltip on the label')) widget.setStyleSheet("font: italic;") widget.setAttribute(Qt.WA_TransparentForMouseEvents) widget.setFocusPolicy(Qt.NoFocus) if not layer_config.get('visible', True): if widget is not None: widget.setVisible(False) label = layer_config.get('label') if label is not None: label.setVisible(False) self.version_lwc() def open_help(self): """ Open the online documentation for the panel. """ locale = QgsSettings().value("locale/userLocale", QLocale().name()) locale = locale[0:2] if locale not in ONLINE_HELP_LANGUAGES: locale = 'en' url = '{url}/{lang}/{page}'.format(url=DOC_URL, lang=locale, page=self.config.help_path()) QDesktopServices.openUrl(QUrl(url)) def version_lwc(self): current_version = QgsSettings().value('lizmap/lizmap_web_client_version', DEFAULT_LWC_VERSION.value, str) current_version = LwcVersions(current_version) # For labels in the UI files, which are not part of the definitions. found = False for lwc_version, items in self.lwc_versions.items(): if found: for item in items: item.setStyleSheet(NEW_FEATURE_CSS) else: for item in items: item.setStyleSheet('') if lwc_version == current_version: found = True # For definition properties found = False for lwc_version in self.lwc_versions.keys(): if found: for layer_config in self.config.layer_config.values(): version = layer_config.get('version') if version == lwc_version: label = layer_config.get('label') if label: label.setStyleSheet(NEW_FEATURE_CSS) if layer_config['type'] == InputType.CheckBox: layer_config.get('widget').setStyleSheet(NEW_FEATURE_CSS) else: for layer_config in self.config.layer_config.values(): version = layer_config.get('version') if version == lwc_version: label = layer_config.get('label') if label: label.setStyleSheet('') if layer_config['type'] == InputType.CheckBox: layer_config.get('widget').setStyleSheet('') if lwc_version == current_version: found = True # For items in combobox found = False for lwc_version in self.lwc_versions.keys(): if found: for layer_config in self.config.layer_config.values(): widget_type = layer_config.get('type') if not layer_config.get('items_depend_on_lwc_version'): continue if widget_type != InputType.List: continue for item in layer_config['items']: if item.value.get('version'): item_combo = layer_config['widget'].model().item( layer_config['widget'].findData(item.value.get('data')) ) brush = QBrush() brush.setStyle(Qt.SolidPattern) brush.setColor(QColor(NEW_FEATURE_COLOR)) item_combo.setBackground(brush) else: for layer_config in self.config.layer_config.values(): widget_type = layer_config.get('type') if not layer_config.get('items_depend_on_lwc_version'): continue if widget_type != InputType.List: continue for item in layer_config['items']: if item.value.get('version'): item_combo = layer_config['widget'].model().item( layer_config['widget'].findData(item.value.get('data')) ) item_combo.setBackground(QBrush()) if lwc_version == current_version: found = True @staticmethod def is_layer_in_wfs(layer: QgsVectorLayer) -> Union[None, str]: """ Check if the layer in the WFS capabilities. """ wfs_layers_list = QgsProject.instance().readListEntry('WFSLayers', '')[0] for wfs_layer in wfs_layers_list: if layer.id() == wfs_layer: return None else: msg = tr( 'The layers you have chosen for this tool must be checked in the "WFS Capabilities"\n' ' option of the QGIS Server tab in the "Project Properties" dialog.') return msg def validate(self): if self.unicity: for key in self.unicity: for k, layer_config in self.config.layer_config.items(): if key == k: if layer_config['type'] == InputType.Layer: if layer_config['widget'].currentLayer().id() in self.unicity[key]: msg = tr( 'A duplicated "{}"="{}" is already in the table.'.format( key, layer_config['widget'].currentLayer().name())) return msg else: raise Exception('InputType "{}" not implemented'.format(layer_config['type'])) for k, layer_config in self.config.layer_config.items(): if layer_config['type'] == InputType.Field: widget = layer_config.get('widget') if not widget: # Dataviz does not have widget for Y, Z continue if not widget.allowEmptyFieldName(): if widget.currentField() == '': names = re.findall('.[^A-Z]*', k) names = [n.lower().replace('_', ' ') for n in names] msg = tr('The field "{}" is mandatory.'.format(' '.join(names))) return msg return None def accept(self): message = self.validate() if message: self.error.setVisible(True) self.error.setText(message) else: super().accept() def show_error(self, message): """ Show the error bar or not. """ if message: self.error.setVisible(True) self.error.setText(message) else: self.error.setVisible(False) self.error.setText("") def load_collection(self, value): """Load a collection to JSON.""" # This function is implemented in child class. pass def save_collection(self) -> dict: """Save a collection into JSON.""" # This function is implemented in child class. pass def primary_keys_collection(self) -> list: """List of unique keys in the collection.""" # This function is implemented in child class. pass def post_load_form(self): """Function executed after the form with data has been loaded.""" # This function is implemented in child class. pass def load_form(self, data: OrderedDict) -> None: """A dictionary to load in the UI.""" layer_properties = OrderedDict() for key, definition in self.config.layer_config.items(): if definition.get('plural') is None: layer_properties[key] = definition for key, definition in layer_properties.items(): value = data.get(key) if definition['type'] == InputType.Layer: layer = QgsProject.instance().mapLayer(value) definition['widget'].setLayer(layer) elif definition['type'] == InputType.Layers: definition['widget'].set_selection(value) elif definition['type'] == InputType.Field: definition['widget'].setField(value) elif definition['type'] == InputType.Fields: definition['widget'].set_selection(value.split(',')) elif definition['type'] == InputType.CheckBox: definition['widget'].setChecked(value) elif definition['type'] == InputType.Color: color = QColor(value) if color.isValid(): definition['widget'].setDefaultColor(color) definition['widget'].setColor(color) else: definition['widget'].setToNull() elif definition['type'] == InputType.List: index = definition['widget'].findData(value) definition['widget'].setCurrentIndex(index) elif definition['type'] == InputType.SpinBox: definition['widget'].setValue(value) elif definition['type'] == InputType.Text: definition['widget'].setText(value) elif definition['type'] == InputType.Json: if value: definition['widget'].setText(json.dumps(value)) elif definition['type'] == InputType.MultiLine: widget = definition['widget'] if isinstance(widget, QPlainTextEdit): widget.setPlainText(value) else: widget.setText(value) elif definition['type'] == InputType.Collection: self.load_collection(value) else: raise Exception('InputType "{}" not implemented'.format(definition['type'])) self.post_load_form() def save_form(self) -> OrderedDict: """Save the UI in the dictionary with QGIS objects""" layer_properties = OrderedDict() for key, definition in self.config.layer_config.items(): if definition.get('plural') is None: layer_properties[key] = definition data = OrderedDict() for key, definition in layer_properties.items(): if definition['type'] == InputType.Layer: value = definition['widget'].currentLayer().id() elif definition['type'] == InputType.Layers: value = definition['widget'].selection() elif definition['type'] == InputType.Field: value = definition['widget'].currentField() elif definition['type'] == InputType.Fields: value = ','.join(definition['widget'].selection()) elif definition['type'] == InputType.Color: widget = definition['widget'] if widget.isNull(): value = '' else: value = widget.color().name() elif definition['type'] == InputType.CheckBox: value = definition['widget'].isChecked() elif definition['type'] == InputType.List: value = definition['widget'].currentData() elif definition['type'] == InputType.SpinBox: value = definition['widget'].value() elif definition['type'] == InputType.Text: value = definition['widget'].text().strip(' \t') elif definition['type'] == InputType.MultiLine: widget = definition['widget'] if isinstance(widget, QPlainTextEdit): value = definition['widget'].toPlainText() else: value = definition['widget'].text() value = value.strip(' \t') elif definition['type'] == InputType.Json: text = definition['widget'].text() if text: value = json.loads(text) else: value = '' elif definition['type'] == InputType.Collection: value = self.save_collection() else: raise Exception('InputType "{}" not implemented'.format(definition['type'])) data[key] = value return data