From: John Glover Date: Tue, 07 Feb 2012 17:24:31 +0000 Subject: [1730][forms] add vocab tags to template variables X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=d66d655a9b0ddaaab6531be2e8796e82c4a076cc --- [1730][forms] add vocab tags to template variables --- --- a/README.rst +++ b/README.rst @@ -12,6 +12,11 @@ * A custom Pylons controller for overriding some core CKAN behaviour * A custom Package edit form + +* A custom Group edit form + +* A plugin that allows for custom forms to be used for datasets based on + their "type". * A custom User registration and edition form @@ -53,4 +58,9 @@ This allows you to use Xpath selectors to override snippets of HTML globally. +* The custom package edit form at ``package_form.py`` follows a deprecated + way to make a form (using FormAlchemy). This part of the Example Theme needs + updating. In the meantime, follow the instructions at: + http://readthedocs.org/docs/ckan/en/latest/forms.html + --- /dev/null +++ b/ckanext/example/forms.py @@ -1,1 +1,232 @@ - +import os, logging +from ckan.authz import Authorizer +from ckan.logic.converters import convert_to_extras,\ + convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only +from ckan.logic import get_action +from ckan.logic.schema import package_form_schema, group_form_schema +from ckan.lib.base import c, model +from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer, IConfigurable +from ckan.plugins import implements, SingletonPlugin +from ckan.lib.navl.validators import ignore_missing, not_empty, keep_extras + +log = logging.getLogger(__name__) + +class ExampleGroupForm(SingletonPlugin): + """This plugin demonstrates how a class packaged as a CKAN + extension might extend CKAN behaviour by providing custom forms + based on the type of a Group. + + In this case, we implement two extension interfaces to provide custom + forms for specific types of group. + + - ``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. + + - ``IGroupForm`` allows us to provide a custom form for a dataset + based on the 'type' that may be set for a group. Where the + 'type' matches one of the values in group_types then this + class will be used. + """ + implements(IGroupForm, 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 group_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 group_form(self): + """ + Returns a string representing the location of the template to be + rendered. e.g. "forms/group_form.html". + """ + return 'forms/group_form.html' + + def group_types(self): + """ + Returns an iterable of group type strings. + + If a request involving a group of one of those types is made, then + this plugin instance will be delegated to. + + There must only be one plugin registered to each group type. Any + attempts to register more than one plugin instance to a given group + type will raise an exception at startup. + """ + return ["testgroup"] + + def is_fallback(self): + """ + Returns true iff this provides the fallback behaviour, when no other + plugin instance matches a group'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 form_to_db_schema(self): + """ + Returns the schema for mapping group data from a form to a format + suitable for the database. + """ + return group_form_schema() + + def db_to_form_schema(self): + """ + Returns the schema for mapping group data from the database into a + format suitable for the form (optional) + """ + return {} + + def check_data_dict(self, data_dict): + """ + Check if the return data is correct. + + raise a DataError if not. + """ + + def setup_template_variables(self, context, data_dict): + """ + Add variables to c just prior to the template being rendered. + """ + + +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) + implements(IConfigurable) + + 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 configure(self, config): + """ + Adds our new vocabulary to the database if it doesn't + already exist. + """ + self.vocab_name = u'example_vocab' + v = model.Vocabulary.get(self.vocab_name) + if not v: + log.info("Adding vocab %s" % self.vocab_name) + vocab = model.Vocabulary(self.vocab_name) + model.Session.add(vocab) + model.Session.commit() + log.info("Adding example tags to vocab %s" % self.vocab_name) + vocab_tag_1 = model.Tag('vocab-tag-example-1', vocab.id) + vocab_tag_2 = model.Tag('vocab-tag-example-2', vocab.id) + model.Session.add(vocab_tag_1) + model.Session.add(vocab_tag_2) + model.Session.commit() + + def package_form(self): + """ + Returns a string representing the location of the template to be + rendered. e.g. "package/new_package_form.html". + """ + return 'forms/dataset_form.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 True + + 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_dataset_form"] + + 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() + c.vocab_tags = get_action('tag_list')(context, {'vocabulary_name': self.vocab_name}) + + ## 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 = package_form_schema() + schema.update({ + 'published_by': [not_empty, unicode, convert_to_extras], + 'vocab_tag_string': [ignore_missing, convert_to_tags(self.vocab_name)], + }) + return schema + + def db_to_form_schema(self): + """ + Returns the schema for mapping package data from the database into a + format suitable for the form (optional) + """ + schema = package_form_schema() + schema.update({ + 'tags': { + '__extras': [keep_extras, free_tags_only] + }, + 'vocab_tag_string': [convert_from_tags(self.vocab_name), ignore_missing], + 'published_by': [convert_from_extras, ignore_missing], + }) + return schema + + def check_data_dict(self, data_dict): + """ + Check if the return data is correct and raises a DataError if not. + """ + return + + --- a/ckanext/example/plugin.py +++ b/ckanext/example/plugin.py @@ -21,9 +21,11 @@ found in the ``ini``-file. Here we use it to specify the site title, and to tell CKAN to look in this package for templates and resources that customise the core look and feel. + - ``IGenshiStreamFilter`` allows us to filter and transform the HTML stream just before it is rendered. In this case we use it to rename "frob" to "foobar" + - ``IRoutes`` allows us to add new URLs, or override existing URLs. In this example we use it to override the default ``/register`` behaviour with a custom controller --- /dev/null +++ b/ckanext/example/theme/templates/forms/dataset_form.html @@ -1,1 +1,251 @@ - +
+ + +
+

Errors in form

+

The form contains invalid entries:

+
    +
  • ${"%s: %s" % (key, error)} + +
      + +
    • + Resource ${idx}: +
        +
      • ${thiskey}: ${errorinfo};
        • +
      +
      • +       +
    +     +
    • +
+
+ +
+
+
+
+ +
+
${errors.get('title', '')}
+ +
+
+ ${url(controller='package', action='index')+'/'}  + +

 

+
+ +
${errors.get('name', '')}
+ +
+
+
The URL for the web page describing the data (not the data itself).
+
e.g. http://www.example.com/growth-figures.html
+
${errors.get('url', '')}
+ +
+
+ +
+
The licence under which the dataset is released.
+ +
+
+
    +
    • +
    • +
+ + + You can use Markdown formatting here. + +
+
+
+ +
+

Resources: the files and APIs associated with this dataset

+ + + + + + + + + +
Resource
+ + +
+
    +

  • Add a resource:

    • +
    • +
    • + +
+
+
+ +
+

Groups

+
+ + + +
+ + +
+
+ + +
Group
+
+ +
+
Cannot add any groups.
+
+

Tags

+
+
+
+ +
+
Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see this wiki page.
+
e.g. pollution, rivers, water quality
+
${errors.get('tag_string', '')}
+
+

Tags with Vocabulary

+
+
+
+ +
+
Similar to standard CKAN tags, but these use a fixed vocabulary.
+
${errors.get('vocab_tag_string', '')}
+
+
+
+
+
+
+
The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.
+ +
+
+ +
+
+
If there is another important contact person (in addition to the person in the Author field) then provide details here.
+ +
+
+ +
+
+
A number representing the version (if applicable)
+
e.g. 1.2.0
+ +
+
+ +
+ +
+
+ +
+
+
+
+ +
+
The organisation credited with or associated with the publication of this data.
+ + + +
+
+ + + Delete +
+ + + +
+
+ + with value + +
+ + +
+
+ + + + + +
+ +

+ Since you have not signed in this will just be your IP address. + Click here to sign in before saving (opens in new window). +

+
+ +
+ + + + +

+ Important: By submitting content, you agree to release your contributions under the Open Database License. Please refrain from editing this page if you are not happy to do this. +

+
+
+ +
+ --- /dev/null +++ b/ckanext/example/theme/templates/forms/group_form.html @@ -1,1 +1,102 @@ +
+
+

Errors in form

+

The form contains invalid entries:

+
    +
  • ${"%s: %s" % (key, error)}
    • +
+
+ +
+
+
+
+ +
+
+ ${g.site_url+h.url_for(controller='group', action='index')+'/'}  + +

 

+
+ +
${errors.get('name', '')}
+ +
+
+
    +
    • +
    • +
+ + + You can use Markdown formatting here. +
+ + +
+
+ +
+
+
+ +
+

Extras

+
+ + +
+
+ + + Delete +
+ + + +
+
+ + with value + +
+ + +
+
+ +
+

Datasets

+
+ +
+
+ +
+ +
+

There are no datasets currently in this group.

+ +

Add datasets

+
+
+
+
+
+ +
+ + + + +
+
+ --- a/ckanext/example/theme/templates/home/index.html +++ b/ckanext/example/theme/templates/home/index.html @@ -22,6 +22,7 @@

Here is the frob

+ ${select("*")} --- a/ckanext/example/theme/templates/layout.html +++ b/ckanext/example/theme/templates/layout.html @@ -9,9 +9,10 @@
- ${h.nav_link(c, _('Home'), controller='home', action='index', id=None)} - ${h.nav_link(c, _('Data'), controller='package', action='index', id=None)} - ${h.nav_link(c, _('New dataset'), controller='package', action='new', id=None)} + ${h.nav_link(c, _('Home'), controller='home', action='index')} + ${h.nav_link(c, _('Data'), controller='package', action='index')} + ${h.nav_link(c, _('New dataset'), controller='package', action='new')} + ${h.nav_link(c, _('New group'), controller='group', action='new')}
--- a/setup.py +++ b/setup.py @@ -1,14 +1,12 @@ from setuptools import setup, find_packages -import sys, os -version = '0.1' +version = '0.2' setup( name='ckanext-example', version=version, - description="Example extension for customising CKAN", - long_description="""\ - """, + description='Example extension for customising CKAN', + long_description='', classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers keywords='', author='Seb Bacon', @@ -25,7 +23,9 @@ entry_points=\ """ [ckan.plugins] - example=ckanext.example.plugin:ExamplePlugin + example=ckanext.example.plugin:ExamplePlugin + example_datasetform=ckanext.example.forms:ExampleDatasetForm + example_groupform=ckanext.example.forms:ExampleGroupForm [ckan.forms] example_form = ckanext.example.package_form:get_example_fieldset