407 lines
17 KiB
Python
407 lines
17 KiB
Python
# w.c.s. - web application for online forms
|
|
# Copyright (C) 2005-2015 Entr'ouvert
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import xml.etree.ElementTree as ET
|
|
|
|
from quixote import get_publisher, redirect
|
|
from quixote.directory import Directory
|
|
from quixote.html import TemplateIO, htmltext
|
|
|
|
from wcs.qommon import _, force_str
|
|
from wcs.qommon import errors, template
|
|
from wcs.qommon.form import *
|
|
from wcs.qommon.form import FileWidget
|
|
from wcs.qommon.form import Form
|
|
from wcs.qommon.form import UrlWidget
|
|
from wcs.qommon.form import get_response
|
|
from wcs.qommon.form import get_session
|
|
from wcs.qommon import misc
|
|
from wcs.qommon.backoffice.menu import html_top
|
|
from wcs.data_sources import (NamedDataSource, DataSourceSelectionWidget,
|
|
get_structured_items)
|
|
from wcs.formdef import FormDef, get_formdefs_of_all_kinds
|
|
from wcs.backoffice.snapshots import SnapshotsDirectory
|
|
|
|
|
|
class NamedDataSourceUI(object):
|
|
def __init__(self, datasource):
|
|
self.datasource = datasource
|
|
if self.datasource is None:
|
|
self.datasource = NamedDataSource()
|
|
|
|
def is_used(self):
|
|
for formdef in get_formdefs_of_all_kinds():
|
|
if self.datasource.is_used_in_formdef(formdef):
|
|
return True
|
|
return False
|
|
|
|
def get_form(self):
|
|
form = Form(enctype='multipart/form-data',
|
|
advanced_label=_('Additional options'))
|
|
form.add(StringWidget, 'name', title=_('Name'), required=True, size=30,
|
|
value=self.datasource.name)
|
|
form.add(TextWidget, 'description', title=_('Description'),
|
|
cols=40, rows=5,
|
|
value=self.datasource.description)
|
|
form.add(DataSourceSelectionWidget, 'data_source',
|
|
value=self.datasource.data_source,
|
|
title=_('Data Source'),
|
|
allow_geojson=True,
|
|
allow_named_sources=False,
|
|
required=True)
|
|
form.add(DurationWidget, 'cache_duration',
|
|
value=self.datasource.cache_duration,
|
|
title=_('Cache Duration'),
|
|
hint=_('Caching data will improve performances but will keep changes '
|
|
'from being visible immediately. You should keep this duration '
|
|
'reasonably short.'),
|
|
required=False,
|
|
advanced=False,
|
|
attrs={
|
|
'data-dynamic-display-child-of': 'data_source$type',
|
|
'data-dynamic-display-value-in': 'json|geojson',
|
|
})
|
|
form.add(StringWidget, 'query_parameter',
|
|
value=self.datasource.query_parameter,
|
|
title=_('Query Parameter'),
|
|
hint=_('Name of the parameter to use for querying source (typically, q)'),
|
|
required=False,
|
|
advanced=False,
|
|
attrs={
|
|
'data-dynamic-display-child-of': 'data_source$type',
|
|
'data-dynamic-display-value': 'json',
|
|
})
|
|
form.add(StringWidget, 'id_parameter',
|
|
value=self.datasource.id_parameter,
|
|
title=_('Id Parameter'),
|
|
hint=_('Name of the parameter to use to get a given entry from data source (typically, id)'),
|
|
required=False,
|
|
advanced=False,
|
|
attrs={
|
|
'data-dynamic-display-child-of': 'data_source$type',
|
|
'data-dynamic-display-value': 'json',
|
|
})
|
|
form.add(StringWidget, 'id_property',
|
|
value=self.datasource.id_property,
|
|
title=_('Id Property'),
|
|
hint=_('Name of the property to use to get a given entry from data source (default: id)'),
|
|
required=False,
|
|
advanced=False,
|
|
attrs={
|
|
'data-dynamic-display-child-of': 'data_source$type',
|
|
'data-dynamic-display-value': 'geojson',
|
|
})
|
|
form.add(StringWidget, 'data_attribute',
|
|
value=self.datasource.data_attribute,
|
|
title=_('Data Attribute'),
|
|
hint=_('Name of the attribute containing the list of results (default: data)'),
|
|
required=False,
|
|
advanced=False,
|
|
attrs={
|
|
'data-dynamic-display-child-of': 'data_source$type',
|
|
'data-dynamic-display-value': 'json',
|
|
})
|
|
form.add(StringWidget, 'id_attribute',
|
|
value=self.datasource.id_attribute,
|
|
title=_('Id Attribute'),
|
|
hint=_('Name of the attribute containing the identifier of an entry (default: id)'),
|
|
required=False,
|
|
advanced=False,
|
|
attrs={
|
|
'data-dynamic-display-child-of': 'data_source$type',
|
|
'data-dynamic-display-value': 'json',
|
|
})
|
|
form.add(StringWidget, 'text_attribute',
|
|
value=self.datasource.text_attribute,
|
|
title=_('Text Attribute'),
|
|
hint=_('Name of the attribute containing the label of an entry (default: text)'),
|
|
required=False,
|
|
advanced=False,
|
|
attrs={
|
|
'data-dynamic-display-child-of': 'data_source$type',
|
|
'data-dynamic-display-value': 'json',
|
|
})
|
|
form.add(StringWidget, 'label_template_property',
|
|
value=self.datasource.label_template_property,
|
|
title=_('Label template'),
|
|
hint=_('Django expression to build label of each value (default: {{ text }})'),
|
|
required=False,
|
|
advanced=False,
|
|
size=80,
|
|
attrs={
|
|
'data-dynamic-display-child-of': 'data_source$type',
|
|
'data-dynamic-display-value': 'geojson',
|
|
})
|
|
if self.datasource.slug and not self.is_used():
|
|
form.add(StringWidget, 'slug',
|
|
value=self.datasource.slug,
|
|
title=_('Identifier'),
|
|
required=True, advanced=True,
|
|
)
|
|
if not self.datasource.is_readonly():
|
|
form.add_submit('submit', _('Submit'))
|
|
form.add_submit('cancel', _('Cancel'))
|
|
return form
|
|
|
|
def submit_form(self, form):
|
|
name = form.get_widget('name').parse()
|
|
slug_widget = form.get_widget('slug')
|
|
if slug_widget:
|
|
slug = form.get_widget('slug').parse()
|
|
|
|
for nds in NamedDataSource.select():
|
|
if nds.id == self.datasource.id:
|
|
continue
|
|
if name == nds.name:
|
|
form.get_widget('name').set_error(_('This name is already used.'))
|
|
if slug_widget and slug == nds.slug:
|
|
slug_widget.set_error(_('This value is already used.'))
|
|
if form.has_errors():
|
|
raise ValueError()
|
|
|
|
self.datasource.name = name
|
|
self.datasource.description = form.get_widget('description').parse()
|
|
self.datasource.data_source = form.get_widget('data_source')
|
|
self.datasource.cache_duration = form.get_widget('cache_duration').parse()
|
|
self.datasource.query_parameter = form.get_widget('query_parameter').parse()
|
|
self.datasource.id_parameter = form.get_widget('id_parameter').parse()
|
|
self.datasource.data_attribute = form.get_widget('data_attribute').parse()
|
|
self.datasource.id_attribute = form.get_widget('id_attribute').parse()
|
|
self.datasource.text_attribute = form.get_widget('text_attribute').parse()
|
|
self.datasource.id_property = form.get_widget('id_property').parse()
|
|
self.datasource.label_template_property = form.get_widget('label_template_property').parse()
|
|
if slug_widget:
|
|
self.datasource.slug = slug
|
|
self.datasource.store()
|
|
|
|
|
|
class NamedDataSourcePage(Directory):
|
|
_q_exports = ['', 'edit', 'delete', 'export',
|
|
('history', 'snapshots_dir'),]
|
|
do_not_call_in_templates = True
|
|
|
|
def __init__(self, component=None, instance=None):
|
|
try:
|
|
self.datasource = instance or NamedDataSource.get(component)
|
|
except KeyError:
|
|
raise errors.TraversalError()
|
|
self.datasource_ui = NamedDataSourceUI(self.datasource)
|
|
get_response().breadcrumb.append((component + '/', self.datasource.name))
|
|
self.snapshots_dir = SnapshotsDirectory(self.datasource)
|
|
|
|
def get_sidebar(self):
|
|
r = TemplateIO(html=True)
|
|
if self.datasource.is_readonly():
|
|
r += htmltext('<div class="infonotice"><p>%s</p></div>') % _('This data source is readonly.')
|
|
r += htmltext('<ul id="sidebar-actions">')
|
|
if not self.datasource.is_readonly():
|
|
r += htmltext('<li><a href="delete" rel="popup">%s</a></li>') % _('Delete')
|
|
r += htmltext('<li><a href="export">%s</a></li>') % _('Export')
|
|
if get_publisher().snapshot_class:
|
|
r += htmltext('<li><a rel="popup" href="history/save">%s</a></li>') % _('Save snapshot')
|
|
r += htmltext('<li><a href="history/">%s</a></li>') % _('History')
|
|
r += htmltext('</ul>')
|
|
return r.getvalue()
|
|
|
|
def _q_index(self):
|
|
html_top('datasources', title=self.datasource.name)
|
|
get_response().filter['sidebar'] = self.get_sidebar()
|
|
return template.QommonTemplateResponse(
|
|
templates=['wcs/backoffice/data-source.html'],
|
|
context={'view': self, 'datasource': self.datasource})
|
|
|
|
def usage_in_formdefs(self):
|
|
formdefs = []
|
|
for formdef in get_formdefs_of_all_kinds():
|
|
if self.datasource.is_used_in_formdef(formdef):
|
|
formdefs.append(formdef)
|
|
formdefs.sort(key=lambda x: x.name.lower())
|
|
return formdefs
|
|
|
|
def preview_block(self):
|
|
data_source = self.datasource.extended_data_source
|
|
if data_source.get('type') not in ('json', 'geojson', 'formula'):
|
|
return ''
|
|
items = get_structured_items(data_source)
|
|
if not items:
|
|
return ''
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<ul>')
|
|
additional_keys = set()
|
|
for item in items[:10]:
|
|
if not isinstance(item.get('text'), str):
|
|
r += htmltext('<li><tt>%s</tt>: <i>%s (%r)</i></li>') % (
|
|
item.get('id'),
|
|
_('error: not a string'),
|
|
item.get('text'))
|
|
else:
|
|
r += htmltext('<li><tt>%s</tt>: %s</li>') % (
|
|
item.get('id'), item.get('text'))
|
|
if data_source.get('type') == 'geojson':
|
|
additional_keys |= set(item.get('properties', {}).keys())
|
|
else:
|
|
additional_keys |= set(item.keys())
|
|
if len(items) > 10:
|
|
r += htmltext('<li>...</li>')
|
|
r += htmltext('</ul>')
|
|
additional_keys -= set(['id', 'text'])
|
|
if additional_keys:
|
|
r += htmltext('<p>%s %s</p>') % (_('Additional keys are available:'),
|
|
', '.join(sorted(additional_keys)))
|
|
return r.getvalue()
|
|
|
|
def edit(self):
|
|
form = self.datasource_ui.get_form()
|
|
if form.get_submit() == 'cancel':
|
|
return redirect('.')
|
|
|
|
if form.get_submit() == 'submit' and not form.has_errors():
|
|
try:
|
|
self.datasource_ui.submit_form(form)
|
|
except ValueError:
|
|
pass
|
|
else:
|
|
return redirect('.')
|
|
|
|
get_response().breadcrumb.append( ('edit', _('Edit')) )
|
|
html_top('datasources', title = _('Edit Data Source'))
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s</h2>') % _('Edit Data Source')
|
|
r += form.render()
|
|
return r.getvalue()
|
|
|
|
def delete(self):
|
|
form = Form(enctype='multipart/form-data')
|
|
if not self.datasource_ui.is_used():
|
|
form.widgets.append(HtmlWidget('<p>%s</p>' % _(
|
|
'You are about to irrevocably delete this data source.')))
|
|
form.add_submit('delete', _('Submit'))
|
|
else:
|
|
form.widgets.append(HtmlWidget('<p>%s</p>' % _(
|
|
'This datasource is still used, it cannot be deleted.')))
|
|
form.add_submit('cancel', _('Cancel'))
|
|
if form.get_widget('cancel').parse():
|
|
return redirect('..')
|
|
if not form.is_submitted() or form.has_errors():
|
|
get_response().breadcrumb.append(('delete', _('Delete')))
|
|
html_top('datasources', title = _('Delete Data Source'))
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s %s</h2>') % (_('Deleting Data Source:'), self.datasource.name)
|
|
r += form.render()
|
|
return r.getvalue()
|
|
else:
|
|
self.datasource.remove_self()
|
|
return redirect('..')
|
|
|
|
def export(self):
|
|
x = self.datasource.export_to_xml(include_id=True)
|
|
misc.indent_xml(x)
|
|
response = get_response()
|
|
response.set_content_type('application/x-wcs-datasource')
|
|
response.set_header(
|
|
'content-disposition',
|
|
'attachment; filename=datasource-%s.wcs' % self.datasource.slug)
|
|
return '<?xml version="1.0"?>\n' + force_str(ET.tostring(x))
|
|
|
|
|
|
class NamedDataSourcesDirectory(Directory):
|
|
_q_exports = ['', 'new', ('import', 'p_import')]
|
|
|
|
def _q_traverse(self, path):
|
|
get_response().breadcrumb.append( ('data-sources/', _('Data Sources')) )
|
|
return super(NamedDataSourcesDirectory, self)._q_traverse(path)
|
|
|
|
def _q_index(self):
|
|
html_top('datasources', title=_('Data Sources'))
|
|
return template.QommonTemplateResponse(
|
|
templates=['wcs/backoffice/data-sources.html'],
|
|
context={'data_sources': NamedDataSource.select(order_by='name')})
|
|
|
|
def new(self):
|
|
get_response().breadcrumb.append( ('new', _('New')) )
|
|
datasource_ui = NamedDataSourceUI(None)
|
|
form = datasource_ui.get_form()
|
|
if form.get_widget('cancel').parse():
|
|
return redirect('.')
|
|
|
|
if form.get_submit() == 'submit' and not form.has_errors():
|
|
try:
|
|
datasource_ui.submit_form(form)
|
|
except ValueError:
|
|
pass
|
|
else:
|
|
return redirect('.')
|
|
|
|
html_top('datasources', title = _('New Data Source'))
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s</h2>') % _('New Data Source')
|
|
r += form.render()
|
|
return r.getvalue()
|
|
|
|
def _q_lookup(self, component):
|
|
return NamedDataSourcePage(component)
|
|
|
|
def p_import(self):
|
|
form = Form(enctype='multipart/form-data')
|
|
import_title = _('Import Data Source')
|
|
|
|
form.add(FileWidget, 'file', title=_('File'), required=True)
|
|
form.add_submit('submit', import_title)
|
|
form.add_submit('cancel', _('Cancel'))
|
|
|
|
if form.get_submit() == 'cancel':
|
|
return redirect('.')
|
|
|
|
if form.is_submitted() and not form.has_errors():
|
|
try:
|
|
return self.import_submit(form)
|
|
except ValueError:
|
|
pass
|
|
|
|
get_response().breadcrumb.append(('import', _('Import')))
|
|
html_top('datasources', title=import_title)
|
|
r = TemplateIO(html=True)
|
|
r += htmltext('<h2>%s</h2>') % import_title
|
|
r += htmltext('<p>%s</p>') % _(
|
|
'You can install a new data source by uploading a file.')
|
|
r += form.render()
|
|
return r.getvalue()
|
|
|
|
def import_submit(self, form):
|
|
fp = form.get_widget('file').parse().fp
|
|
|
|
error = False
|
|
try:
|
|
datasource = NamedDataSource.import_from_xml(fp)
|
|
get_session().message = (
|
|
'info', _('This datasource has been successfully imported.'))
|
|
except ValueError:
|
|
error = True
|
|
|
|
if error:
|
|
form.set_error('file', _('Invalid File'))
|
|
raise ValueError()
|
|
|
|
try:
|
|
# check slug unicity
|
|
NamedDataSource.get_on_index(datasource.slug, 'slug', ignore_migration=True)
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
datasource.slug = None # a new one will be set in .store()
|
|
datasource.store()
|
|
return redirect('%s/' % datasource.id)
|