def __init__(self, iface, template, layer):
"""Constructor for the Composition Report class.
:param iface: Reference to the QGIS iface object.
:type iface: QgsAppInterface
:param template: The QGIS template path.
:type template: str
"""
LOGGER.debug('InaSAFE Impact Report class initialised')
self._iface = iface
self._template = template
self._layer = layer
self._extent = self._iface.mapCanvas().extent()
self._page_dpi = 300.0
self._black_inasafe_logo = black_inasafe_logo_path()
self._white_inasafe_logo = white_inasafe_logo_path()
# User can change this path in preferences
self._organisation_logo = supporters_logo_path()
self._supporters_logo = supporters_logo_path()
self._north_arrow = default_north_arrow_path()
self._disclaimer = disclaimer()
# For QGIS < 2.4 compatibility
# QgsMapSettings is added in 2.4
if qgis_version() < 20400:
map_settings = self._iface.mapCanvas().mapRenderer()
else:
map_settings = self._iface.mapCanvas().mapSettings()
self._template_composition = TemplateComposition(
template_path=self.template, map_settings=map_settings)
self._keyword_io = KeywordIO()
def __init__(self, iface, template, layer):
"""Constructor for the Composition Report class.
:param iface: Reference to the QGIS iface object.
:type iface: QgsAppInterface
:param template: The QGIS template path.
:type template: str
"""
LOGGER.debug('InaSAFE Impact Report class initialised')
self._iface = iface
self._template = None
self.template = template
self._layer = layer
self._extent = self._iface.mapCanvas().extent()
self._page_dpi = 300.0
self._black_inasafe_logo = black_inasafe_logo_path()
self._white_inasafe_logo = white_inasafe_logo_path()
# User can change this path in preferences
self._organisation_logo = supporters_logo_path()
self._supporters_logo = supporters_logo_path()
self._north_arrow = default_north_arrow_path()
self._disclaimer = disclaimer()
# For QGIS < 2.4 compatibility
# QgsMapSettings is added in 2.4
if qgis_version() < 20400:
map_settings = self._iface.mapCanvas().mapRenderer()
else:
map_settings = self._iface.mapCanvas().mapSettings()
self._template_composition = TemplateComposition(
template_path=self.template,
map_settings=map_settings)
self._keyword_io = KeywordIO()
def __init__(self):
"""Create InaSAFE Report context."""
self._black_inasafe_logo = black_inasafe_logo_path()
self._white_inasafe_logo = white_inasafe_logo_path()
# User can change this path in preferences
self._organisation_logo = supporters_logo_path()
self._supporters_logo = supporters_logo_path()
self._north_arrow = default_north_arrow_path()
self._disclaimer = disclaimer()
def set_organisation_logo(self):
"""Auto-connect slot activated when org logo checkbox is toggled."""
settings = QtCore.QSettings()
if self.custom_org_logo_checkbox.isChecked():
# Use previous org logo path
path = settings.value('inasafe/organisation_logo_path',
supporters_logo_path(),
type=str)
else:
# Set organisation path line edit to default one
path = supporters_logo_path()
self.leOrganisationLogoPath.setText(path)
def set_organisation_logo(self):
"""Auto-connect slot activated when org logo checkbox is toggled."""
settings = QtCore.QSettings()
if self.custom_org_logo_checkbox.isChecked():
# Use previous org logo path
path = settings.value(
'inasafe/organisation_logo_path',
supporters_logo_path(),
type=str)
else:
# Set organisation path line edit to default one
path = supporters_logo_path()
self.leOrganisationLogoPath.setText(path)
def toggle_logo_path(self):
"""Set state of logo path line edit and button."""
is_checked = self.custom_organisation_logo_check_box.isChecked()
if is_checked:
# Use previous org logo path
path = setting(key='organisation_logo_path',
default=supporters_logo_path(),
expected_type=str,
qsettings=self.settings)
else:
# Set organisation path line edit to default one
path = supporters_logo_path()
self.organisation_logo_path_line_edit.setText(path)
self.organisation_logo_path_line_edit.setEnabled(is_checked)
self.open_organisation_logo_path_button.setEnabled(is_checked)
def test_setup_dialog(self):
"""Test Setup Options Dialog."""
dialog = OptionsDialog(
parent=PARENT, iface=IFACE, qsetting='InaSAFETest')
self.assertIsNotNone(dialog)
# Check default values
self.assertEqual(
dialog.cbxVisibleLayersOnly.isChecked(),
inasafe_default_settings['visibleLayersOnlyFlag'])
self.assertEqual(
dialog.cbxSetLayerNameFromTitle.isChecked(),
inasafe_default_settings['set_layer_from_title_flag'])
self.assertEqual(
dialog.cbxZoomToImpact.isChecked(),
inasafe_default_settings['setZoomToImpactFlag'])
self.assertEqual(
dialog.cbxHideExposure.isChecked(),
inasafe_default_settings['setHideExposureFlag'])
self.assertEqual(
dialog.cbxUseSelectedFeaturesOnly.isChecked(),
inasafe_default_settings['useSelectedFeaturesOnly'])
self.assertEqual(
dialog.leKeywordCachePath.text(),
inasafe_default_settings['keywordCachePath'])
self.assertEqual(
dialog.template_warning_checkbox.isChecked(),
inasafe_default_settings['template_warning_verbose'])
self.assertEqual(
dialog.organisation_on_dock_checkbox.isChecked(),
inasafe_default_settings['showOrganisationLogoInDockFlag'])
self.assertEqual(
dialog.cbxDevMode.isChecked(),
inasafe_default_settings['developer_mode'])
self.assertEqual(
dialog.leNorthArrowPath.text(), default_north_arrow_path())
self.assertEqual(
dialog.leOrganisationLogoPath.text(), supporters_logo_path())
self.assertEqual(dialog.leReportTemplatePath.text(), '')
self.assertEqual(dialog.txtDisclaimer.toPlainText(), disclaimer())
self.assertEqual(
dialog.leUserDirectoryPath.text(), temp_dir('impacts'))
self.assertEqual(
dialog.iso19115_organization_le.text(),
inasafe_default_settings['ISO19115_ORGANIZATION'])
self.assertEqual(
dialog.iso19115_url_le.text(),
inasafe_default_settings['ISO19115_URL'])
self.assertEqual(
dialog.iso19115_email_le.text(),
inasafe_default_settings['ISO19115_EMAIL'])
self.assertEqual(
dialog.iso19115_title_le.text(),
inasafe_default_settings['ISO19115_TITLE'])
self.assertEqual(
dialog.iso19115_license_le.text(),
inasafe_default_settings['ISO19115_LICENSE'])
def toggle_logo_path(self):
"""Set state of logo path line edit and button."""
is_checked = self.custom_organisation_logo_check_box.isChecked()
if is_checked:
# Use previous org logo path
path = setting(
key='organisation_logo_path',
default=supporters_logo_path(),
expected_type=str,
qsettings=self.settings)
else:
# Set organisation path line edit to default one
path = supporters_logo_path()
self.organisation_logo_path_line_edit.setText(path)
self.organisation_logo_path_line_edit.setEnabled(is_checked)
self.open_organisation_logo_path_button.setEnabled(is_checked)
def test_setup_dialog(self):
"""Test Setup Options Dialog."""
dialog = OptionsDialog(
parent=PARENT, iface=IFACE, qsetting=INASAFE_TEST)
self.assertIsNotNone(dialog)
# Check default values
self.assertEqual(
dialog.cbxVisibleLayersOnly.isChecked(),
inasafe_default_settings['visibleLayersOnlyFlag'])
self.assertEqual(
dialog.cbxSetLayerNameFromTitle.isChecked(),
inasafe_default_settings['set_layer_from_title_flag'])
self.assertEqual(
dialog.cbxZoomToImpact.isChecked(),
inasafe_default_settings['setZoomToImpactFlag'])
self.assertEqual(
dialog.cbxHideExposure.isChecked(),
inasafe_default_settings['setHideExposureFlag'])
self.assertEqual(
dialog.cbxUseSelectedFeaturesOnly.isChecked(),
inasafe_default_settings['useSelectedFeaturesOnly'])
self.assertEqual(
dialog.leKeywordCachePath.text(),
inasafe_default_settings['keywordCachePath'])
self.assertEqual(
dialog.template_warning_checkbox.isChecked(),
inasafe_default_settings['template_warning_verbose'])
self.assertEqual(
dialog.organisation_on_dock_checkbox.isChecked(),
inasafe_default_settings['showOrganisationLogoInDockFlag'])
self.assertEqual(
dialog.cbxDevMode.isChecked(),
inasafe_default_settings['developer_mode'])
self.assertEqual(
dialog.leNorthArrowPath.text(), default_north_arrow_path())
self.assertEqual(
dialog.organisation_logo_path_line_edit.text(),
supporters_logo_path())
self.assertEqual(dialog.leReportTemplatePath.text(), '')
self.assertEqual(dialog.txtDisclaimer.toPlainText(), disclaimer())
self.assertEqual(
dialog.leUserDirectoryPath.text(), temp_dir('impacts'))
self.assertEqual(
dialog.organisation_line_edit.text(),
inasafe_default_settings['ISO19115_ORGANIZATION'])
self.assertEqual(
dialog.website_line_edit.text(),
inasafe_default_settings['ISO19115_URL'])
self.assertEqual(
dialog.email_line_edit.text(),
inasafe_default_settings['ISO19115_EMAIL'])
self.assertEqual(
dialog.license_line_edit.text(),
inasafe_default_settings['ISO19115_LICENSE'])
def read_settings(self):
"""Restore settings from QSettings.
Do this on init and after changing options in the options dialog.
"""
settings = QSettings()
flag = bool(settings.value('inasafe/showRubberBands', False,
type=bool))
self.extent.show_rubber_bands = flag
try:
extent = settings.value('inasafe/analysis_extent', '', type=str)
crs = settings.value('inasafe/analysis_extent_crs', '', type=str)
except TypeError:
# Any bogus stuff in settings and we just clear them
extent = ''
crs = ''
if extent != '' and crs != '':
extent = extent_string_to_array(extent)
try:
self.extent.user_extent = QgsRectangle(*extent)
self.extent.user_extent_crs = QgsCoordinateReferenceSystem(crs)
self.extent.show_user_analysis_extent()
except TypeError:
self.extent.user_extent = None
self.extent.user_extent_crs = None
flag = settings.value('inasafe/useThreadingFlag', False, type=bool)
self.run_in_thread_flag = flag
flag = settings.value('inasafe/setZoomToImpactFlag', True, type=bool)
self.zoom_to_impact_flag = flag
# whether exposure layer should be hidden after model completes
flag = settings.value('inasafe/setHideExposureFlag', False, type=bool)
self.hide_exposure_flag = flag
# whether to 'hard clip' layers (e.g. cut buildings in half if they
# lie partially in the AOI
self.clip_hard = settings.value('inasafe/clip_hard', False, type=bool)
# whether to show or not postprocessing generated layers
self.show_intermediate_layers = settings.value(
'inasafe/show_intermediate_layers', False, type=bool)
# whether to show or not dev only options
# noinspection PyAttributeOutsideInit
self.developer_mode = settings.value('inasafe/developer_mode',
False,
type=bool)
# whether to show or not a custom Logo
# noinspection PyAttributeOutsideInit
self.organisation_logo_path = settings.value(
'inasafe/organisation_logo_path', supporters_logo_path(), type=str)
def organisation_logo(self, logo):
"""Set image that will be used as organisation logo in reports.
:param logo: Path to the organisation logo image.
:type logo: str
"""
if isinstance(logo, basestring) and os.path.exists(logo):
self._organisation_logo = logo
else:
self._organisation_logo = supporters_logo_path()
def test_supporters_logo_path(self):
"""Verify the call to default supporters logo path works.
"""
# Check if it exists
logo_path = QFile(supporters_logo_path())
self.assertTrue(QFile.exists(logo_path))
'setHideExposureFlag': False,
'useSelectedFeaturesOnly': True,
'useSentry': False,
'template_warning_verbose': True,
'showOrganisationLogoInDockFlag': False,
'developer_mode': False,
'generate_report': True,
'memory_profile': False,
'ISO19115_ORGANIZATION': 'InaSAFE.org',
'ISO19115_URL': 'http://inasafe.org',
'ISO19115_EMAIL': '*****@*****.**',
'ISO19115_LICENSE': 'Free use with accreditation',
# Welcome message
'always_show_welcome_message': True,
'previous_version': '0.0.0', # It will be set in plugin, no need to worry
'currency': idr['key'],
'keywordCachePath': join(
QgsApplication.qgisSettingsDirPath(), 'inasafe', 'metadata.db'),
# Make sure first to not have cyclic import
'organisation_logo_path': supporters_logo_path(),
'north_arrow_path': default_north_arrow_path(),
# 'defaultUserDirectory': '',
# 'reportTemplatePath': '',
'reportDisclaimer': disclaimer()
}
def __init__(self, parent=None, iface=None):
"""Constructor for dialog.
:param parent: Optional widget to use as parent
:type parent: QWidget
:param iface: An instance of QGisInterface
:type iface: QGisInterface
"""
QDialog.__init__(self, parent)
self.parent = parent
self.setupUi(self)
self.setWindowTitle(self.tr('InaSAFE Impact Layer Merge Tool'))
self.iface = iface
self.keyword_io = KeywordIO()
# Template Path for composer
self.template_path = resources_path(
'qgis-composer-templates', 'merged_report.qpt')
# Safe Logo Path
self.safe_logo_path = white_inasafe_logo_path()
# Organisation Logo Path - defaults to supporters logo, will be
# updated to user defined organisation logo path in read_settings in
# user has specified a custom logo.
self.organisation_logo_path = supporters_logo_path()
# Disclaimer text
self.disclaimer = disclaimer()
# The output directory
self.out_dir = None
# Stored information from first impact layer
self.first_impact = {
'layer': None,
'map_title': None,
'hazard_title': None,
'exposure_title': None,
'postprocessing_report': None,
}
# Stored information from second impact layer
self.second_impact = {
'layer': None,
'map_title': None,
'hazard_title': None,
'exposure_title': None,
'postprocessing_report': None,
}
# Stored information from aggregation layer
self.aggregation = {
'layer': None,
'aggregation_attribute': None
}
# Available aggregation layer
self.available_aggregation = []
# The summary report, contains report for each aggregation area
self.summary_report = OrderedDict()
# The html reports and its file path
self.html_reports = OrderedDict()
# A boolean flag whether to merge entire area or aggregated
self.entire_area_mode = False
# Get the global settings and override some variable if exist
self.read_settings()
# Get all current project layers for combo box
self.get_project_layers()
# Set up things for context help
self.help_button = self.button_box.button(QtGui.QDialogButtonBox.Help)
# Allow toggling the help button
self.help_button.setCheckable(True)
self.help_button.toggled.connect(self.help_toggled)
self.main_stacked_widget.setCurrentIndex(1)
# Show usage info
self.restore_state()
def restore_state(self):
"""Reinstate the options based on the user's stored session info."""
# Restore boolean setting as check box.
for key, check_box in self.boolean_settings.items():
self.restore_boolean_setting(key, check_box)
# Restore text setting as line edit.
for key, line_edit in self.text_settings.items():
self.restore_text_setting(key, line_edit)
# Restore Organisation Logo Path
org_logo_path = self.settings.value(
'inasafe/organisation_logo_path',
supporters_logo_path(),
type=str)
custom_org_logo_flag = (
org_logo_path != supporters_logo_path())
self.custom_org_logo_checkbox.setChecked(custom_org_logo_flag)
self.leOrganisationLogoPath.setText(org_logo_path)
# User Directory
user_directory_path = self.settings.value(
'inasafe/defaultUserDirectory',
temp_dir('impacts'), type=str)
custom_user_directory_flag = (
user_directory_path != temp_dir('impacts'))
self.custom_UseUserDirectory_checkbox.setChecked(
custom_user_directory_flag)
self.splitter_user_directory.setEnabled(custom_user_directory_flag)
self.leUserDirectoryPath.setText(user_directory_path)
# Earthquake function.
# Populate the combobox first.
for model in EARTHQUAKE_FUNCTIONS:
self.earthquake_function.addItem(model['name'], model['key'])
# Then make selected the default one.
default_earthquake_function = setting(
'earthquake_function', expected_type=str)
keys = [model['key'] for model in EARTHQUAKE_FUNCTIONS]
if default_earthquake_function not in keys:
default_earthquake_function = EARTHQUAKE_FUNCTIONS[0]['key']
index = self.earthquake_function.findData(default_earthquake_function)
self.earthquake_function.setCurrentIndex(index)
# Restore North Arrow Image Path
north_arrow_path = self.settings.value(
'inasafe/north_arrow_path', default_north_arrow_path(), type=str)
custom_north_arrow_flag = (
north_arrow_path != default_north_arrow_path())
self.custom_north_arrow_checkbox.setChecked(custom_north_arrow_flag)
self.leNorthArrowPath.setText(north_arrow_path)
# Restore Report Template Directory Path
report_template_dir = self.settings.value(
'inasafe/reportTemplatePath', '', type=str)
custom_templates_dir_flag = (report_template_dir != '')
self.custom_templates_dir_checkbox.setChecked(
custom_templates_dir_flag)
self.leReportTemplatePath.setText(report_template_dir)
# Restore Disclaimer
org_disclaimer = self.settings.value(
'inasafe/reportDisclaimer', disclaimer(), type=str)
custom_org_disclaimer_flag = (org_disclaimer != disclaimer())
self.custom_org_disclaimer_checkbox.setChecked(
custom_org_disclaimer_flag)
self.txtDisclaimer.setPlainText(org_disclaimer)
# Restore InaSAFE default values
self.restore_default_values_page()
def restore_state(self):
"""Reinstate the options based on the user's stored session info.
"""
settings = QtCore.QSettings()
# flag = settings.value(
# 'inasafe/useThreadingFlag', False)
# hack set use thread to false see #557
flag = False
self.cbxUseThread.setChecked(flag)
flag = bool(settings.value(
'inasafe/visibleLayersOnlyFlag', True, type=bool))
self.cbxVisibleLayersOnly.setChecked(flag)
flag = bool(settings.value(
'inasafe/set_layer_from_title_flag', True, type=bool))
self.cbxSetLayerNameFromTitle.setChecked(flag)
flag = bool(settings.value(
'inasafe/setZoomToImpactFlag', True, type=bool))
self.cbxZoomToImpact.setChecked(flag)
# whether exposure layer should be hidden after model completes
flag = bool(settings.value(
'inasafe/setHideExposureFlag', False, type=bool))
self.cbxHideExposure.setChecked(flag)
flag = bool(settings.value(
'inasafe/clip_hard', False, type=bool))
self.cbxClipHard.setChecked(flag)
flag = bool(settings.value(
'inasafe/useSentry', False, type=bool))
self.cbxUseSentry.setChecked(flag)
flag = bool(settings.value(
'inasafe/show_intermediate_layers', False, type=bool))
self.cbxShowPostprocessingLayers.setChecked(flag)
ratio = self.defaults['FEMALE_RATIO']
self.dsbFemaleRatioDefault.setValue(ratio)
path = settings.value(
'inasafe/keywordCachePath',
self.keyword_io.default_keyword_db_path(), type=str)
self.leKeywordCachePath.setText(path)
flag = bool(settings.value(
'inasafe/template_warning_verbose', True, type=bool))
self.template_warning_checkbox.setChecked(flag)
# Restore Organisation Logo Path
org_logo_path = settings.value(
'inasafe/organisation_logo_path',
supporters_logo_path(),
type=str)
custom_org_logo_flag = (
org_logo_path != supporters_logo_path())
self.custom_org_logo_checkbox.setChecked(custom_org_logo_flag)
self.leOrganisationLogoPath.setText(org_logo_path)
user_directory_path = settings.value(
'inasafe/defaultUserDirectory',
temp_dir('impacts'), type=str)
custom_user_directory_flag = (
user_directory_path != temp_dir('impacts'))
self.custom_UseUserDirectory_checkbox.setChecked(
custom_user_directory_flag)
self.splitter_user_directory.setEnabled(custom_user_directory_flag)
self.leUserDirectoryPath.setText(user_directory_path)
# Restore Show Organisation Logo in Dock Flag
flag = bool(settings.value(
'inasafe/showOrganisationLogoInDockFlag', False, type=bool))
self.organisation_on_dock_checkbox.setChecked(flag)
# Restore North Arrow Image Path
north_arrow_path = settings.value(
'inasafe/north_arrow_path', default_north_arrow_path(), type=str)
custom_north_arrow_flag = (
north_arrow_path != default_north_arrow_path())
self.custom_north_arrow_checkbox.setChecked(custom_north_arrow_flag)
self.leNorthArrowPath.setText(north_arrow_path)
# Restore Report Template Directory Path
report_template_dir = settings.value(
'inasafe/reportTemplatePath',
'',
type=str)
custom_templates_dir_flag = (report_template_dir != '')
self.custom_templates_dir_checkbox.setChecked(
custom_templates_dir_flag)
self.leReportTemplatePath.setText(report_template_dir)
# Restore Disclaimer
org_disclaimer = settings.value(
'inasafe/reportDisclaimer', disclaimer(), type=str)
custom_org_disclaimer_flag = (org_disclaimer != disclaimer())
self.custom_org_disclaimer_checkbox.setChecked(
custom_org_disclaimer_flag)
self.txtDisclaimer.setPlainText(org_disclaimer)
flag = bool(
settings.value('inasafe/developer_mode', False, type=bool))
self.cbxDevMode.setChecked(flag)
flag = bool(
settings.value('inasafe/use_native_zonal_stats', False, type=bool))
self.cbxNativeZonalStats.setChecked(flag)
# Restore ISO19115 metadata tab
value = self.defaults['ISO19115_ORGANIZATION']
self.iso19115_organization_le.setText(value)
value = self.defaults['ISO19115_URL']
self.iso19115_url_le.setText(value)
value = self.defaults['ISO19115_EMAIL']
self.iso19115_email_le.setText(value)
value = self.defaults['ISO19115_TITLE']
self.iso19115_title_le.setText(value)
value = self.defaults['ISO19115_LICENSE']
self.iso19115_license_le.setText(value)
def test_supporters_logo_path(self):
"""Verify the call to default supporters logo path works."""
# Check if it exists
logo_path = QFile(supporters_logo_path())
self.assertTrue(QFile.exists(logo_path))
def restore_state(self):
"""Reinstate the options based on the user's stored session info."""
# Restore boolean setting as check box.
for key, check_box in list(self.boolean_settings.items()):
self.restore_boolean_setting(key, check_box)
# Restore text setting as line edit.
for key, line_edit in list(self.text_settings.items()):
self.restore_text_setting(key, line_edit)
# User Directory
user_directory_path = setting(key='defaultUserDirectory',
default=temp_dir('impacts'),
expected_type=str,
qsettings=self.settings)
custom_user_directory_flag = (user_directory_path !=
temp_dir('impacts'))
self.custom_UseUserDirectory_checkbox.setChecked(
custom_user_directory_flag)
self.splitter_user_directory.setEnabled(custom_user_directory_flag)
self.leUserDirectoryPath.setText(user_directory_path)
# Currency
# Populate the currency list
for currency in currencies:
self.currency_combo_box.addItem(currency['name'], currency['key'])
# Then make selected the default one.
default_currency = setting('currency', expected_type=str)
keys = [currency['key'] for currency in currencies]
if default_currency not in keys:
default_currency = currencies[0]['key']
index = self.currency_combo_box.findData(default_currency)
self.currency_combo_box.setCurrentIndex(index)
# Earthquake function.
# Populate the combobox first.
for model in EARTHQUAKE_FUNCTIONS:
self.earthquake_function.addItem(model['name'], model['key'])
# Then make selected the default one.
default_earthquake_function = setting('earthquake_function',
expected_type=str)
keys = [model['key'] for model in EARTHQUAKE_FUNCTIONS]
if default_earthquake_function not in keys:
default_earthquake_function = EARTHQUAKE_FUNCTIONS[0]['key']
index = self.earthquake_function.findData(default_earthquake_function)
self.earthquake_function.setCurrentIndex(index)
self.update_earthquake_info()
# Restore North Arrow Image Path
north_arrow_path = setting(key='north_arrow_path',
default=default_north_arrow_path(),
expected_type=str,
qsettings=self.settings)
custom_north_arrow_flag = (north_arrow_path !=
default_north_arrow_path())
self.custom_north_arrow_checkbox.setChecked(custom_north_arrow_flag)
self.splitter_north_arrow.setEnabled(custom_north_arrow_flag)
self.leNorthArrowPath.setText(north_arrow_path)
# Restore Report Template Directory Path
report_template_directory = setting(key='reportTemplatePath',
default='',
expected_type=str,
qsettings=self.settings)
custom_templates_dir_flag = (report_template_directory != '')
self.custom_templates_dir_checkbox.setChecked(
custom_templates_dir_flag)
self.leReportTemplatePath.setText(report_template_directory)
# Restore Disclaimer
org_disclaimer = setting(key='reportDisclaimer',
default=disclaimer(),
expected_type=str,
qsettings=self.settings)
custom_org_disclaimer_flag = (org_disclaimer != disclaimer())
self.custom_org_disclaimer_checkbox.setChecked(
custom_org_disclaimer_flag)
self.txtDisclaimer.setPlainText(org_disclaimer)
# Restore Organisation Logo Path
org_logo_path = setting(key='organisation_logo_path',
default=supporters_logo_path(),
expected_type=str,
qsettings=self.settings)
# Check if the path is default one or not
custom_org_logo_flag = org_logo_path != supporters_logo_path()
self.organisation_logo_path_line_edit.setText(org_logo_path)
self.custom_organisation_logo_check_box.setChecked(
custom_org_logo_flag)
self.organisation_logo_path_line_edit.setEnabled(custom_org_logo_flag)
self.open_organisation_logo_path_button.setEnabled(
custom_org_logo_flag)
# Manually call here
self.update_logo_preview()
# Restore InaSAFE default values
self.restore_default_values_page()
# Restore Population Parameter
self.restore_population_parameters(global_default=False)
False,
'ISO19115_ORGANIZATION':
'InaSAFE.org',
'ISO19115_URL':
'http://inasafe.org',
'ISO19115_EMAIL':
'*****@*****.**',
'ISO19115_LICENSE':
'Free use with accreditation',
# Welcome message
'always_show_welcome_message':
True,
'previous_version':
'0.0.0', # It will be set in plugin, no need to worry
'currency':
idr['key'],
'keywordCachePath':
join(QgsApplication.qgisSettingsDirPath(), 'inasafe', 'metadata.db'),
# Make sure first to not have cyclic import
'organisation_logo_path':
supporters_logo_path(),
'north_arrow_path':
default_north_arrow_path(),
# 'defaultUserDirectory': '',
# 'reportTemplatePath': '',
'reportDisclaimer':
disclaimer()
}
"""Image elements"""
white_inasafe_logo_path = {
'id': 'inasafe-logo-white',
'path': white_inasafe_logo_path()
}
black_inasafe_logo_path = {
'id': 'inasafe-logo-black',
'path': black_inasafe_logo_path()
}
inasafe_north_arrow_path = {
'id': 'north-arrow-logo',
'path': default_north_arrow_path()
}
inasafe_organisation_logo_path = {
'id': 'organisation-logo',
# We default to the supporters logo, but an org can change to their logo
# in options ...
'path': supporters_logo_path()
}
image_variable_elements = [
black_inasafe_logo_path, white_inasafe_logo_path, inasafe_north_arrow_path,
inasafe_organisation_logo_path
]
all_variable_elements = text_variable_elements + image_variable_elements
'set_layer_from_title_flag': True,
'setZoomToImpactFlag': True,
'set_show_only_impact_on_report': False,
'print_atlas_report': False,
'setHideExposureFlag': False,
'useSelectedFeaturesOnly': True,
'useSentry': False,
'template_warning_verbose': True,
'showOrganisationLogoInDockFlag': False,
'developer_mode': False,
'generate_report': True,
'memory_profile': False,
'ISO19115_ORGANIZATION': 'InaSAFE.org',
'ISO19115_URL': 'http://inasafe.org',
'ISO19115_EMAIL': '*****@*****.**',
'ISO19115_LICENSE': 'Free use with accreditation',
'currency': idr['key'],
'keywordCachePath': join(
QgsApplication.qgisSettingsDirPath(), 'inasafe', 'metadata.db'),
# Make sure first to not have cyclic import
'organisation_logo_path': supporters_logo_path(),
'north_arrow_path': default_north_arrow_path(),
# 'defaultUserDirectory': '',
# 'reportTemplatePath': '',
'reportDisclaimer': disclaimer()
}
def restore_state(self):
"""Reinstate the options based on the user's stored session info.
"""
settings = QtCore.QSettings()
# flag = settings.value(
# 'inasafe/useThreadingFlag', False)
# hack set use thread to false see #557
flag = False
self.cbxUseThread.setChecked(flag)
flag = bool(settings.value(
'inasafe/visibleLayersOnlyFlag', True, type=bool))
self.cbxVisibleLayersOnly.setChecked(flag)
flag = bool(settings.value(
'inasafe/set_layer_from_title_flag', True, type=bool))
self.cbxSetLayerNameFromTitle.setChecked(flag)
flag = bool(settings.value(
'inasafe/setZoomToImpactFlag', True, type=bool))
self.cbxZoomToImpact.setChecked(flag)
# whether exposure layer should be hidden after model completes
flag = bool(settings.value(
'inasafe/setHideExposureFlag', False, type=bool))
self.cbxHideExposure.setChecked(flag)
flag = bool(settings.value(
'inasafe/clip_hard', False, type=bool))
self.cbxClipHard.setChecked(flag)
flag = bool(settings.value(
'inasafe/useSentry', False, type=bool))
self.cbxUseSentry.setChecked(flag)
flag = bool(settings.value(
'inasafe/show_intermediate_layers', False, type=bool))
self.cbxShowPostprocessingLayers.setChecked(flag)
ratio = self.defaults['FEMALE_RATIO']
self.dsbFemaleRatioDefault.setValue(ratio)
path = settings.value(
'inasafe/keywordCachePath',
self.keyword_io.default_keyword_db_path(), type=str)
self.leKeywordCachePath.setText(path)
flag = bool(settings.value(
'inasafe/template_warning_verbose', True, type=bool))
self.template_warning_checkbox.setChecked(flag)
# Restore Organisation Logo Path
org_logo_path = settings.value(
'inasafe/organisation_logo_path',
supporters_logo_path(),
type=str)
custom_org_logo_flag = (
org_logo_path != supporters_logo_path())
self.custom_org_logo_checkbox.setChecked(custom_org_logo_flag)
self.leOrganisationLogoPath.setText(org_logo_path)
user_directory_path = settings.value(
'inasafe/defaultUserDirectory',
temp_dir('impacts'), type=str)
custom_user_directory_flag = (
user_directory_path != temp_dir('impacts'))
self.custom_UseUserDirectory_checkbox.setChecked(
custom_user_directory_flag)
self.splitter_user_directory.setEnabled(custom_user_directory_flag)
self.leUserDirectoryPath.setText(user_directory_path)
# Restore Show Organisation Logo in Dock Flag
flag = bool(settings.value(
'inasafe/showOrganisationLogoInDockFlag', False, type=bool))
self.organisation_on_dock_checkbox.setChecked(flag)
# Restore North Arrow Image Path
north_arrow_path = settings.value(
'inasafe/north_arrow_path', default_north_arrow_path(), type=str)
custom_north_arrow_flag = (
north_arrow_path != default_north_arrow_path())
self.custom_north_arrow_checkbox.setChecked(custom_north_arrow_flag)
self.leNorthArrowPath.setText(north_arrow_path)
# Restore Report Template Directory Path
report_template_dir = settings.value(
'inasafe/reportTemplatePath',
'',
type=str)
custom_templates_dir_flag = (report_template_dir != '')
self.custom_templates_dir_checkbox.setChecked(
custom_templates_dir_flag)
self.leReportTemplatePath.setText(report_template_dir)
# Restore Disclaimer
org_disclaimer = settings.value(
'inasafe/reportDisclaimer', disclaimer(), type=str)
custom_org_disclaimer_flag = (org_disclaimer != disclaimer())
self.custom_org_disclaimer_checkbox.setChecked(
custom_org_disclaimer_flag)
self.txtDisclaimer.setPlainText(org_disclaimer)
flag = bool(
settings.value('inasafe/developer_mode', False, type=bool))
self.cbxDevMode.setChecked(flag)
flag = bool(
settings.value('inasafe/use_native_zonal_stats', False, type=bool))
self.cbxNativeZonalStats.setChecked(flag)
# Restore ISO19115 metadata tab
value = self.defaults['ISO19115_ORGANIZATION']
self.iso19115_organization_le.setText(value)
value = self.defaults['ISO19115_URL']
self.iso19115_url_le.setText(value)
value = self.defaults['ISO19115_EMAIL']
self.iso19115_email_le.setText(value)
value = self.defaults['ISO19115_TITLE']
self.iso19115_title_le.setText(value)
value = self.defaults['ISO19115_LICENSE']
self.iso19115_license_le.setText(value)
def __init__(self, parent=None, iface=None):
"""Constructor for dialog.
:param parent: Optional widget to use as parent
:type parent: QWidget
:param iface: An instance of QGisInterface
:type iface: QGisInterface
"""
QDialog.__init__(self, parent)
self.parent = parent
self.setupUi(self)
self.setWindowTitle(self.tr('InaSAFE Impact Layer Merge Tool'))
self.iface = iface
self.keyword_io = KeywordIO()
# Template Path for composer
self.template_path = resources_path('qgis-composer-templates',
'merged_report.qpt')
# Safe Logo Path
self.safe_logo_path = white_inasafe_logo_path()
# Organisation Logo Path - defaults to supporters logo, will be
# updated to user defined organisation logo path in read_settings in
# user has specified a custom logo.
self.organisation_logo_path = supporters_logo_path()
# Disclaimer text
self.disclaimer = disclaimer()
# The output directory
self.out_dir = None
# Stored information from first impact layer
self.first_impact = {
'layer': None,
'map_title': None,
'hazard_title': None,
'exposure_title': None,
'postprocessing_report': None,
}
# Stored information from second impact layer
self.second_impact = {
'layer': None,
'map_title': None,
'hazard_title': None,
'exposure_title': None,
'postprocessing_report': None,
}
# Stored information from aggregation layer
self.aggregation = {'layer': None, 'aggregation_attribute': None}
# Available aggregation layer
self.available_aggregation = []
# The summary report, contains report for each aggregation area
self.summary_report = OrderedDict()
# The html reports and its file path
self.html_reports = OrderedDict()
# A boolean flag whether to merge entire area or aggregated
self.entire_area_mode = False
# Get the global settings and override some variable if exist
self.read_settings()
# Get all current project layers for combo box
self.get_project_layers()
# Set up things for context help
self.help_button = self.button_box.button(QtGui.QDialogButtonBox.Help)
# Allow toggling the help button
self.help_button.setCheckable(True)
self.help_button.toggled.connect(self.help_toggled)
self.main_stacked_widget.setCurrentIndex(1)
# Show usage info
self.restore_state()
def read_settings(self):
"""Restore settings from QSettings.
Do this on init and after changing options in the options dialog.
"""
settings = QSettings()
flag = bool(settings.value(
'inasafe/showRubberBands', False, type=bool))
self.extent.show_rubber_bands = flag
try:
extent = settings.value('inasafe/analysis_extent', '', type=str)
crs = settings.value('inasafe/analysis_extent_crs', '', type=str)
except TypeError:
# Any bogus stuff in settings and we just clear them
extent = ''
crs = ''
if extent != '' and crs != '':
extent = extent_string_to_array(extent)
try:
self.extent.user_extent = QgsRectangle(*extent)
self.extent.user_extent_crs = QgsCoordinateReferenceSystem(crs)
self.extent.show_user_analysis_extent()
except TypeError:
self.extent.user_extent = None
self.extent.user_extent_crs = None
flag = settings.value(
'inasafe/useThreadingFlag', False, type=bool)
self.run_in_thread_flag = flag
flag = settings.value(
'inasafe/setZoomToImpactFlag', True, type=bool)
self.zoom_to_impact_flag = flag
# whether exposure layer should be hidden after model completes
flag = settings.value(
'inasafe/setHideExposureFlag', False, type=bool)
self.hide_exposure_flag = flag
# whether to 'hard clip' layers (e.g. cut buildings in half if they
# lie partially in the AOI
self.clip_hard = settings.value('inasafe/clip_hard', False, type=bool)
# whether to show or not postprocessing generated layers
self.show_intermediate_layers = settings.value(
'inasafe/show_intermediate_layers', False, type=bool)
# whether to show or not dev only options
# noinspection PyAttributeOutsideInit
self.developer_mode = settings.value(
'inasafe/developer_mode', False, type=bool)
# whether to show or not a custom Logo
# noinspection PyAttributeOutsideInit
self.organisation_logo_path = settings.value(
'inasafe/organisation_logo_path',
supporters_logo_path(),
type=str)
def restore_state(self):
"""Reinstate the options based on the user's stored session info."""
# Restore boolean setting as check box.
for key, check_box in list(self.boolean_settings.items()):
self.restore_boolean_setting(key, check_box)
# Restore text setting as line edit.
for key, line_edit in list(self.text_settings.items()):
self.restore_text_setting(key, line_edit)
# User Directory
user_directory_path = setting(
key='defaultUserDirectory',
default=temp_dir('impacts'),
expected_type=str,
qsettings=self.settings)
custom_user_directory_flag = (
user_directory_path != temp_dir('impacts'))
self.custom_UseUserDirectory_checkbox.setChecked(
custom_user_directory_flag)
self.splitter_user_directory.setEnabled(custom_user_directory_flag)
self.leUserDirectoryPath.setText(user_directory_path)
# Currency
# Populate the currency list
for currency in currencies:
self.currency_combo_box.addItem(currency['name'], currency['key'])
# Then make selected the default one.
default_currency = setting('currency', expected_type=str)
keys = [currency['key'] for currency in currencies]
if default_currency not in keys:
default_currency = currencies[0]['key']
index = self.currency_combo_box.findData(default_currency)
self.currency_combo_box.setCurrentIndex(index)
# Earthquake function.
# Populate the combobox first.
for model in EARTHQUAKE_FUNCTIONS:
self.earthquake_function.addItem(model['name'], model['key'])
# Then make selected the default one.
default_earthquake_function = setting(
'earthquake_function', expected_type=str)
keys = [model['key'] for model in EARTHQUAKE_FUNCTIONS]
if default_earthquake_function not in keys:
default_earthquake_function = EARTHQUAKE_FUNCTIONS[0]['key']
index = self.earthquake_function.findData(default_earthquake_function)
self.earthquake_function.setCurrentIndex(index)
self.update_earthquake_info()
# Restore North Arrow Image Path
north_arrow_path = setting(
key='north_arrow_path',
default=default_north_arrow_path(),
expected_type=str,
qsettings=self.settings)
custom_north_arrow_flag = (
north_arrow_path != default_north_arrow_path())
self.custom_north_arrow_checkbox.setChecked(custom_north_arrow_flag)
self.splitter_north_arrow.setEnabled(custom_north_arrow_flag)
self.leNorthArrowPath.setText(north_arrow_path)
# Restore Report Template Directory Path
report_template_directory = setting(
key='reportTemplatePath',
default='',
expected_type=str,
qsettings=self.settings)
custom_templates_dir_flag = (report_template_directory != '')
self.custom_templates_dir_checkbox.setChecked(
custom_templates_dir_flag)
self.leReportTemplatePath.setText(report_template_directory)
# Restore Disclaimer
org_disclaimer = setting(
key='reportDisclaimer',
default=disclaimer(),
expected_type=str,
qsettings=self.settings)
custom_org_disclaimer_flag = (org_disclaimer != disclaimer())
self.custom_org_disclaimer_checkbox.setChecked(
custom_org_disclaimer_flag)
self.txtDisclaimer.setPlainText(org_disclaimer)
# Restore Organisation Logo Path
org_logo_path = setting(
key='organisation_logo_path',
default=supporters_logo_path(),
expected_type=str,
qsettings=self.settings)
# Check if the path is default one or not
custom_org_logo_flag = org_logo_path != supporters_logo_path()
self.organisation_logo_path_line_edit.setText(org_logo_path)
self.custom_organisation_logo_check_box.setChecked(
custom_org_logo_flag)
self.organisation_logo_path_line_edit.setEnabled(
custom_org_logo_flag)
self.open_organisation_logo_path_button.setEnabled(
custom_org_logo_flag)
# Manually call here
self.update_logo_preview()
# Restore InaSAFE default values
self.restore_default_values_page()
# Restore Population Parameter
self.restore_population_parameters(global_default=False)
def restore_state(self):
"""Reinstate the options based on the user's stored session info."""
# Restore boolean setting as check box.
for key, check_box in self.boolean_settings.items():
self.restore_boolean_setting(key, check_box)
# Restore text setting as line edit.
for key, line_edit in self.text_settings.items():
self.restore_text_setting(key, line_edit)
# Restore Organisation Logo Path
org_logo_path = self.settings.value('inasafe/organisation_logo_path',
supporters_logo_path(),
type=str)
custom_org_logo_flag = (org_logo_path != supporters_logo_path())
self.custom_org_logo_checkbox.setChecked(custom_org_logo_flag)
self.leOrganisationLogoPath.setText(org_logo_path)
# User Directory
user_directory_path = self.settings.value(
'inasafe/defaultUserDirectory', temp_dir('impacts'), type=str)
custom_user_directory_flag = (user_directory_path !=
temp_dir('impacts'))
self.custom_UseUserDirectory_checkbox.setChecked(
custom_user_directory_flag)
self.splitter_user_directory.setEnabled(custom_user_directory_flag)
self.leUserDirectoryPath.setText(user_directory_path)
# Earthquake function.
# Populate the combobox first.
for model in EARTHQUAKE_FUNCTIONS:
self.earthquake_function.addItem(model['name'], model['key'])
# Then make selected the default one.
default_earthquake_function = setting('earthquake_function',
expected_type=str)
keys = [model['key'] for model in EARTHQUAKE_FUNCTIONS]
if default_earthquake_function not in keys:
default_earthquake_function = EARTHQUAKE_FUNCTIONS[0]['key']
index = self.earthquake_function.findData(default_earthquake_function)
self.earthquake_function.setCurrentIndex(index)
# Restore North Arrow Image Path
north_arrow_path = self.settings.value('inasafe/north_arrow_path',
default_north_arrow_path(),
type=str)
custom_north_arrow_flag = (north_arrow_path !=
default_north_arrow_path())
self.custom_north_arrow_checkbox.setChecked(custom_north_arrow_flag)
self.leNorthArrowPath.setText(north_arrow_path)
# Restore Report Template Directory Path
report_template_dir = self.settings.value('inasafe/reportTemplatePath',
'',
type=str)
custom_templates_dir_flag = (report_template_dir != '')
self.custom_templates_dir_checkbox.setChecked(
custom_templates_dir_flag)
self.leReportTemplatePath.setText(report_template_dir)
# Restore Disclaimer
org_disclaimer = self.settings.value('inasafe/reportDisclaimer',
disclaimer(),
type=str)
custom_org_disclaimer_flag = (org_disclaimer != disclaimer())
self.custom_org_disclaimer_checkbox.setChecked(
custom_org_disclaimer_flag)
self.txtDisclaimer.setPlainText(org_disclaimer)
# Restore InaSAFE default values
self.restore_default_values_page()
white_inasafe_logo_path = {
'id': 'inasafe-logo-white',
'path': white_inasafe_logo_path()
}
black_inasafe_logo_path = {
'id': 'inasafe-logo-black',
'path': black_inasafe_logo_path()
}
inasafe_north_arrow_path = {
'id': 'north-arrow-logo',
'path': default_north_arrow_path()
}
inasafe_organisation_logo_path = {
'id': 'organisation-logo',
# We default to the supporters logo, but an org can change to their logo
# in options ...
'path': supporters_logo_path()
}
image_variable_elements = [
black_inasafe_logo_path,
white_inasafe_logo_path,
inasafe_north_arrow_path,
inasafe_organisation_logo_path]
all_variable_elements = text_variable_elements + image_variable_elements