| import os, logging | |
| from ckan.authz import Authorizer | |
| import ckan.logic.action.create as create | |
| import ckan.logic.action.update as update | |
| import ckan.logic.action.get as get | |
| from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras, convert_from_extras | |
| from ckan.logic import NotFound, NotAuthorized, ValidationError | |
| from ckan.logic import tuplize_dict, clean_dict, parse_params | |
| import ckan.logic.schema as default_schema | |
| from ckan.logic.schema import package_form_schema | |
| import ckan.logic.validators as val | |
| from ckan.lib.base import BaseController, render, c, model, abort, request | |
| from ckan.lib.base import redirect, _, config, h | |
| from ckan.lib.package_saver import PackageSaver | |
| from ckan.lib.field_types import DateType, DateConvertError | |
| from ckan.lib.navl.dictization_functions import Invalid | |
| from ckan.lib.navl.dictization_functions import validate, missing | |
| from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten | |
| from ckan.plugins import IDatasetForm, IConfigurer | |
| from ckan.plugins import implements, SingletonPlugin | |
| from ckan.lib.navl.validators import (ignore_missing, | |
| not_empty, | |
| empty, | |
| ignore, | |
| keep_extras, | |
| ) | |
| log = logging.getLogger(__name__) | |
| class ExampleDatasetForm(SingletonPlugin): | |
| """This plugin demonstrates how a theme packaged as a CKAN | |
| extension might extend CKAN behaviour. | |
| In this case, we implement three extension interfaces: | |
| - ``IConfigurer`` allows us to override configuration normally | |
| found in the ``ini``-file. Here we use it to specify where the | |
| form templates can be found. | |
| - ``IDatasetForm`` allows us to provide a custom form for a dataset | |
| based on the type_name that may be set for a package. Where the | |
| type_name matches one of the values in package_types then this | |
| class will be used. | |
| """ | |
| implements(IDatasetForm, inherit=True) | |
| implements(IConfigurer, inherit=True) | |
| def update_config(self, config): | |
| """ | |
| This IConfigurer implementation causes CKAN to look in the | |
| ```templates``` directory when looking for the package_form() | |
| """ | |
| here = os.path.dirname(__file__) | |
| rootdir = os.path.dirname(os.path.dirname(here)) | |
| template_dir = os.path.join(rootdir, 'ckanext', | |
| 'example', 'theme', 'templates') | |
| config['extra_template_paths'] = ','.join([template_dir, | |
| config.get('extra_template_paths', '')]) | |
| def package_form(self): | |
| """ | |
| Returns a string representing the location of the template to be | |
| rendered. e.g. "package/new_package_form.html". | |
| """ | |
| return 'controller/package_plugin.html' | |
| def is_fallback(self): | |
| """ | |
| Returns true iff this provides the fallback behaviour, when no other | |
| plugin instance matches a package's type. | |
| As this is not the fallback controller we should return False. If | |
| we were wanting to act as the fallback, we'd return True | |
| """ | |
| return False | |
| def package_types(self): | |
| """ | |
| Returns an iterable of package type strings. | |
| If a request involving a package of one of those types is made, then | |
| this plugin instance will be delegated to. | |
| There must only be one plugin registered to each package type. Any | |
| attempts to register more than one plugin instance to a given package | |
| type will raise an exception at startup. | |
| """ | |
| return ["example"] | |
| def setup_template_variables(self, context, data_dict=None): | |
| """ | |
| Adds variables to c just prior to the template being rendered that can | |
| then be used within the form | |
| """ | |
| c.licences = [('', '')] + model.Package.get_license_options() | |
| c.publishers = [('Example publisher', 'Example publisher 2')] | |
| c.is_sysadmin = Authorizer().is_sysadmin(c.user) | |
| c.resource_columns = model.Resource.get_columns() | |
| ## This is messy as auths take domain object not data_dict | |
| pkg = context.get('package') or c.pkg | |
| if pkg: | |
| c.auth_for_change_state = Authorizer().am_authorized( | |
| c, model.Action.CHANGE_STATE, pkg) | |
| def form_to_db_schema(self): | |
| """ | |
| Returns the schema for mapping package data from a form to a format | |
| suitable for the database. | |
| """ | |
| schema = { | |
| 'title': [not_empty, unicode], | |
| 'name': [not_empty, unicode, val.name_validator, val.package_name_validator], | |
| 'notes': [not_empty, unicode], | |
| 'date_released': [date_to_db, convert_to_extras], | |
| 'date_updated': [date_to_db, convert_to_extras], | |
| 'date_update_future': [date_to_db, convert_to_extras], | |
| 'url': [unicode], | |
| 'taxonomy_url': [unicode, convert_to_extras], | |
| 'resources': default_schema.default_resource_schema(), | |
| 'published_by': [not_empty, unicode, convert_to_extras], | |
| 'published_via': [ignore_missing, unicode, convert_to_extras], | |
| 'author': [ignore_missing, unicode], | |
| 'author_email': [ignore_missing, unicode], | |
| 'mandate': [ignore_missing, unicode, convert_to_extras], | |
| 'license_id': [ignore_missing, unicode], | |
| 'tag_string': [ignore_missing, val.tag_string_convert], | |
| 'national_statistic': [ignore_missing, convert_to_extras], | |
| 'state': [val.ignore_not_admin, ignore_missing], | |
| 'log_message': [unicode, val.no_http], | |
| '__extras': [ignore], | |
| '__junk': [empty], | |
| } | |
| return schema | |
| def db_to_form_schema(data): | |
| """ | |
| Returns the schema for mapping package data from the database into a | |
| format suitable for the form (optional) | |
| """ | |
| schema = { | |
| 'date_released': [convert_from_extras, ignore_missing, date_to_form], | |
| 'date_updated': [convert_from_extras, ignore_missing, date_to_form], | |
| 'date_update_future': [convert_from_extras, ignore_missing, date_to_form], | |
| 'precision': [convert_from_extras, ignore_missing], | |
| 'taxonomy_url': [convert_from_extras, ignore_missing], | |
| 'resources': default_schema.default_resource_schema(), | |
| 'extras': { | |
| 'key': [], | |
| 'value': [], | |
| '__extras': [keep_extras] | |
| }, | |
| 'tags': { | |
| '__extras': [keep_extras] | |
| }, | |
| 'published_by': [convert_from_extras, ignore_missing], | |
| 'published_via': [convert_from_extras, ignore_missing], | |
| 'mandate': [convert_from_extras, ignore_missing], | |
| 'national_statistic': [convert_from_extras, ignore_missing], | |
| '__extras': [keep_extras], | |
| '__junk': [ignore], | |
| } | |
| return schema | |
| def check_data_dict(self, data_dict): | |
| """ | |
| Check if the return data is correct and raises a DataError if not. | |
| """ | |
| return | |
| import os, logging | |
| from ckan.authz import Authorizer | |
| import ckan.logic.action.create as create | |
| import ckan.logic.action.update as update | |
| import ckan.logic.action.get as get | |
| from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras, convert_from_extras | |
| from ckan.logic import NotFound, NotAuthorized, ValidationError | |
| from ckan.logic import tuplize_dict, clean_dict, parse_params | |
| import ckan.logic.schema as default_schema | |
| from ckan.logic.schema import package_form_schema | |
| import ckan.logic.validators as val | |
| from ckan.lib.base import BaseController, render, c, model, abort, request | |
| from ckan.lib.base import redirect, _, config, h | |
| from ckan.lib.package_saver import PackageSaver | |
| from ckan.lib.field_types import DateType, DateConvertError | |
| from ckan.lib.navl.dictization_functions import Invalid | |
| from ckan.lib.navl.dictization_functions import validate, missing | |
| from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten | |
| from ckan.plugins import IDatasetForm, IConfigurer | |
| from ckan.plugins import implements, SingletonPlugin | |
| from ckan.lib.navl.validators import (ignore_missing, | |
| not_empty, | |
| empty, | |
| ignore, | |
| keep_extras, | |
| ) | |
| log = logging.getLogger(__name__) | |
| class ExampleDatasetForm(SingletonPlugin): | |
| """This plugin demonstrates how a theme packaged as a CKAN | |
| extension might extend CKAN behaviour. | |
| In this case, we implement three extension interfaces: | |
| - ``IConfigurer`` allows us to override configuration normally | |
| found in the ``ini``-file. Here we use it to specify where the | |
| form templates can be found. | |
| - ``IDatasetForm`` allows us to provide a custom form for a dataset | |
| based on the type_name that may be set for a package. Where the | |
| type_name matches one of the values in package_types then this | |
| class will be used. | |
| """ | |
| implements(IDatasetForm, inherit=True) | |
| implements(IConfigurer, inherit=True) | |
| def update_config(self, config): | |
| """ | |
| This IConfigurer implementation causes CKAN to look in the | |
| ```templates``` directory when looking for the package_form() | |
| """ | |
| here = os.path.dirname(__file__) | |
| rootdir = os.path.dirname(os.path.dirname(here)) | |
| template_dir = os.path.join(rootdir, 'ckanext', | |
| 'example', 'theme', 'templates') | |
| config['extra_template_paths'] = ','.join([template_dir, | |
| config.get('extra_template_paths', '')]) | |
| def package_form(self): | |
| """ | |
| Returns a string representing the location of the template to be | |
| rendered. e.g. "package/new_package_form.html". | |
| """ | |
| return 'controller/package_plugin.html' | |
| def is_fallback(self): | |
| """ | |
| Returns true iff this provides the fallback behaviour, when no other | |
| plugin instance matches a package's type. | |
| As this is not the fallback controller we should return False. If | |
| we were wanting to act as the fallback, we'd return True | |
| """ | |
| return False | |
| def package_types(self): | |
| """ | |
| Returns an iterable of package type strings. | |
| If a request involving a package of one of those types is made, then | |
| this plugin instance will be delegated to. | |
| There must only be one plugin registered to each package type. Any | |
| attempts to register more than one plugin instance to a given package | |
| type will raise an exception at startup. | |
| """ | |
| return ["example"] | |
| def setup_template_variables(self, context, data_dict=None): | |
| """ | |
| Adds variables to c just prior to the template being rendered that can | |
| then be used within the form | |
| """ | |
| c.licences = [('', '')] + model.Package.get_license_options() | |
| c.publishers = [('Example publisher', 'Example publisher 2')] | |
| c.is_sysadmin = Authorizer().is_sysadmin(c.user) | |
| c.resource_columns = model.Resource.get_columns() | |
| ## This is messy as auths take domain object not data_dict | |
| pkg = context.get('package') or c.pkg | |
| if pkg: | |
| c.auth_for_change_state = Authorizer().am_authorized( | |
| c, model.Action.CHANGE_STATE, pkg) | |
| def form_to_db_schema(self): | |
| """ | |
| Returns the schema for mapping package data from a form to a format | |
| suitable for the database. | |
| """ | |
| schema = { | |
| 'title': [not_empty, unicode], | |
| 'name': [not_empty, unicode, val.name_validator, val.package_name_validator], | |
| 'notes': [not_empty, unicode], | |
| 'date_released': [date_to_db, convert_to_extras], | |
| 'date_updated': [date_to_db, convert_to_extras], | |
| 'date_update_future': [date_to_db, convert_to_extras], | |
| 'url': [unicode], | |
| 'taxonomy_url': [unicode, convert_to_extras], | |
| 'resources': default_schema.default_resource_schema(), | |
| 'published_by': [not_empty, unicode, convert_to_extras], | |
| 'published_via': [ignore_missing, unicode, convert_to_extras], | |
| 'author': [ignore_missing, unicode], | |
| 'author_email': [ignore_missing, unicode], | |
| 'mandate': [ignore_missing, unicode, convert_to_extras], | |
| 'license_id': [ignore_missing, unicode], | |
| 'tag_string': [ignore_missing, val.tag_string_convert], | |
| 'national_statistic': [ignore_missing, convert_to_extras], | |
| 'state': [val.ignore_not_admin, ignore_missing], | |
| 'log_message': [unicode, val.no_http], | |
| '__extras': [ignore], | |
| '__junk': [empty], | |
| } | |
| return schema | |
| def db_to_form_schema(data): | |
| """ | |
| Returns the schema for mapping package data from the database into a | |
| format suitable for the form (optional) | |
| """ | |
| schema = { | |
| 'date_released': [convert_from_extras, ignore_missing, date_to_form], | |
| 'date_updated': [convert_from_extras, ignore_missing, date_to_form], | |
| 'date_update_future': [convert_from_extras, ignore_missing, date_to_form], | |
| 'precision': [convert_from_extras, ignore_missing], | |
| 'taxonomy_url': [convert_from_extras, ignore_missing], | |
| 'resources': default_schema.default_resource_schema(), | |
| 'extras': { | |
| 'key': [], | |
| 'value': [], | |
| '__extras': [keep_extras] | |
| }, | |
| 'tags': { | |
| '__extras': [keep_extras] | |
| }, | |
| 'published_by': [convert_from_extras, ignore_missing], | |
| 'published_via': [convert_from_extras, ignore_missing], | |
| 'mandate': [convert_from_extras, ignore_missing], | |
| 'national_statistic': [convert_from_extras, ignore_missing], | |
| '__extras': [keep_extras], | |
| '__junk': [ignore], | |
| } | |
| return schema | |
| def check_data_dict(self, data_dict): | |
| """ | |
| Check if the return data is correct and raises a DataError if not. | |
| """ | |
| return | |
| <form id="package-edit" class="package_create_form ckan" method="post" | |
| py:attrs="{'class':'has-errors'} if errors else {}" | |
| xmlns:i18n="http://genshi.edgewall.org/i18n" | |
| xmlns:py="http://genshi.edgewall.org/" | |
| xmlns:xi="http://www.w3.org/2001/XInclude"> | |
| <div class="error-explanation" py:if="error_summary"> | |
| <h2>Errors in form</h2> | |
| <p>The form contains invalid entries:</p> | |
| <ul> | |
| <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}</li> | |
| </ul> | |
| </div> | |
| <fieldset> | |
| <legend>Example Basic information</legend> | |
| <dl> | |
| <dt><label class="field_req" for="title">Title *</label></dt> | |
| <dd><input id="title" name="title" type="text" value="${data.get('title', '')}"/></dd> | |
| <dd class="instructions basic">The title of the data set.</dd> | |
| <dd class="instructions further">The main subject of the data should be clear. For cross-government data requirements, such as spend data, specify the public body the data belongs to or its geographical coverage, in order to distinguish your data from other similar datasets in data.gov.uk. If the data relates to a period of time, include that in the name, although this would not be appropriate for data which is updated over time. It is not a description - save that for the Abstract element. Do not give a trailing full stop.</dd> | |
| <dd class="hints">e.g. Payments to suppliers with a value over £500 from Harlow Council</dd> | |
| <dd class="field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd> | |
| <dt><label class="field_req" for="name">Identifier *</label></dt> | |
| <dd><input id="name" maxlength="100" name="name" type="text" value="${data.get('name', '')}" /></dd> | |
| <dd class="instructions basic">A public unique identifier for the dataset</dd> | |
| <dd class="instructions further">It sh |