projects / ckanext-datagovau.git / commitdiff
search:
summary | shortlog | log | commit | commitdiff | tree
unified | plain
Fix a bug in the dataset form
Fix a bug in the dataset form

file:a/README.rst -> file:b/README.rst
This CKAN Extension demonstrates some common patterns for customising a CKAN instance. This CKAN Extension demonstrates some common patterns for customising a CKAN instance.
   
It comprises: It comprises:
   
* A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when * A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when
loaded, overrides various settings in the core ``ini``-file to provide: loaded, overrides various settings in the core ``ini``-file to provide:
   
* A path to local customisations of the core templates and stylesheets * A path to local customisations of the core templates and stylesheets
* A "stream filter" that replaces arbitrary strings in rendered templates * A "stream filter" that replaces arbitrary strings in rendered templates
* A "route" to override and extend the default behaviour of a core CKAN page * A "route" to override and extend the default behaviour of a core CKAN page
   
* A custom Pylons controller for overriding some core CKAN behaviour * A custom Pylons controller for overriding some core CKAN behaviour
   
* A custom Package edit form * A custom Package edit form
   
* A custom Group edit form * A custom Group edit form
   
* A plugin that allows for custom forms to be used for datasets based on * A plugin that allows for custom forms to be used for datasets based on
their "type". their "type".
   
* A custom User registration and edition form * A custom User registration and edition form
   
* Some simple template customisations * Some simple template customisations
   
Installation Installation
============ ============
   
To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``):: To install this package, from your CKAN virtualenv, run the following from your CKAN base folder (e.g. ``pyenv/``)::
   
pip install -e git+https://github.com/okfn/ckanext-example#egg=ckanext-example pip install -e git+https://github.com/okfn/ckanext-example#egg=ckanext-example
   
Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file. Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file.
   
   
Orientation Orientation
=========== ===========
   
* Examine the source code, starting with ``ckanext/example/plugin.py`` * Examine the source code, starting with ``ckanext/example/plugin.py``
   
* To understand the nuts and bolts of this file, which is a CKAN * To understand the nuts and bolts of this file, which is a CKAN
*Extension*, read in conjunction with the "Extension *Extension*, read in conjunction with the "Extension
documentation": http://docs.ckan.org/en/latest/plugins.html documentation": http://docs.ckan.org/en/latest/plugins.html
   
* One thing the extension does is set the values of * One thing the extension does is set the values of
``extra_public_paths`` and ``extra_template_paths`` in the CKAN ``extra_public_paths`` and ``extra_template_paths`` in the CKAN
config, which are "documented config, which are "documented
here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths
   
* These are set to point at directories within * These are set to point at directories within
``ckanext/example/theme/`` (in this package). Here we: ``ckanext/example/theme/`` (in this package). Here we:
* override the home page HTML ``ckanext/example/theme/templates/home/index.html`` * override the home page HTML ``ckanext/example/theme/templates/home/index.html``
* provide some extra style by serving ``extra.css`` (which is loaded using the ``ckan.template_head_end`` option * provide some extra style by serving ``extra.css`` (which is loaded using the ``ckan.template_head_end`` option
* customise the navigation and header of the main template in the file ``layout.html``. * customise the navigation and header of the main template in the file ``layout.html``.
   
The latter file is a great place to make global theme alterations. The latter file is a great place to make global theme alterations.
It uses the _layout template_ pattern "described in the Genshi It uses the _layout template_ pattern "described in the Genshi
documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate. documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate.
This allows you to use Xpath selectors to override snippets of HTML This allows you to use Xpath selectors to override snippets of HTML
globally. globally.
   
* The custom package edit form at ``package_form.py`` follows a deprecated * 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 way to make a form (using FormAlchemy). This part of the Example Theme needs
updating. In the meantime, follow the instructions at: updating. In the meantime, follow the instructions at:
http://readthedocs.org/docs/ckan/en/latest/forms.html http://readthedocs.org/docs/ckan/en/latest/forms.html
   
  Example Tags With Vocabularies
  ==============================
   
  To add example tag vocabulary data to the database, from the ckanext-example directory run:
   
  ::
   
  paster example create-example-vocabs -c <path to your ckan config file>
   
  This data can be removed with
   
  ::
   
  paster example clean -c <path to your ckan config file>
   
   
file:a/ckanext/example/commands.py -> file:b/ckanext/example/commands.py
from ckan import model from ckan import model
from ckan.lib.cli import CkanCommand from ckan.lib.cli import CkanCommand
from ckan.logic import get_action, NotFound from ckan.logic import get_action, NotFound
import forms import forms
   
import logging import logging
log = logging.getLogger() log = logging.getLogger()
   
   
class ExampleCommand(CkanCommand): class ExampleCommand(CkanCommand):
''' '''
CKAN Example Extension CKAN Example Extension
   
Usage:: Usage::
   
paster example create-example-vocabs -c <path to config file> paster example create-example-vocabs -c <path to config file>
   
paster example clean -c <path to config file> paster example clean -c <path to config file>
- Remove all data created by ckanext-example - Remove all data created by ckanext-example
   
The commands should be run from the ckanext-example directory. The commands should be run from the ckanext-example directory.
''' '''
summary = __doc__.split('\n')[0] summary = __doc__.split('\n')[0]
usage = __doc__ usage = __doc__
   
def command(self): def command(self):
''' '''
Parse command line arguments and call appropriate method. Parse command line arguments and call appropriate method.
''' '''
if not self.args or self.args[0] in ['--help', '-h', 'help']: if not self.args or self.args[0] in ['--help', '-h', 'help']:
print ExampleCommand.__doc__ print ExampleCommand.__doc__
return return
   
cmd = self.args[0] cmd = self.args[0]
self._load_config() self._load_config()
   
if cmd == 'create-example-vocabs': if cmd == 'create-example-vocabs':
self.create_example_vocabs() self.create_example_vocabs()
  if cmd == 'clean':
  self.clean()
else: else:
log.error('Command "%s" not recognized' % (cmd,)) log.error('Command "%s" not recognized' % (cmd,))
   
def create_example_vocabs(self): def create_example_vocabs(self):
''' '''
Adds example vocabularies to the database if they don't already exist. Adds example vocabularies to the database if they don't already exist.
''' '''
user = get_action('get_site_user')({'model': model, 'ignore_auth': True}, {}) user = get_action('get_site_user')({'model': model, 'ignore_auth': True}, {})
context = {'model': model, 'session': model.Session, 'user': user['name']} context = {'model': model, 'session': model.Session, 'user': user['name']}
   
try: try:
data = {'id': forms.GENRE_VOCAB} data = {'id': forms.GENRE_VOCAB}
get_action('vocabulary_show')(context, data) get_action('vocabulary_show')(context, data)
log.info("Example genre vocabulary already exists, skipping.") log.info("Example genre vocabulary already exists, skipping.")
except NotFound: except NotFound:
log.info("Creating vocab %s" % forms.GENRE_VOCAB) log.info("Creating vocab %s" % forms.GENRE_VOCAB)
data = {'name': forms.GENRE_VOCAB} data = {'name': forms.GENRE_VOCAB}
vocab = get_action('vocabulary_create')(context, data) vocab = get_action('vocabulary_create')(context, data)
log.info("Adding tag %s to vocab %s" % ('jazz', forms.GENRE_VOCAB)) log.info("Adding tag %s to vocab %s" % ('jazz', forms.GENRE_VOCAB))
data = {'name': 'jazz', 'vocabulary_id': vocab['id']} data = {'name': 'jazz', 'vocabulary_id': vocab['id']}
get_action('tag_create')(context, data) get_action('tag_create')(context, data)
log.info("Adding tag %s to vocab %s" % ('soul', forms.GENRE_VOCAB)) log.info("Adding tag %s to vocab %s" % ('soul', forms.GENRE_VOCAB))
data = {'name': 'soul', 'vocabulary_id': vocab['id']} data = {'name': 'soul', 'vocabulary_id': vocab['id']}
get_action('tag_create')(context, data) get_action('tag_create')(context, data)
   
try: try:
data = {'id': forms.COMPOSER_VOCAB} data = {'id': forms.COMPOSER_VOCAB}
get_action('vocabulary_show')(context, data) get_action('vocabulary_show')(context, data)
log.info("Example composer vocabulary already exists, skipping.") log.info("Example composer vocabulary already exists, skipping.")
except NotFound: except NotFound:
log.info("Creating vocab %s" % forms.COMPOSER_VOCAB) log.info("Creating vocab %s" % forms.COMPOSER_VOCAB)
data = {'name': forms.COMPOSER_VOCAB} data = {'name': forms.COMPOSER_VOCAB}
vocab = get_action('vocabulary_create')(context, data) vocab = get_action('vocabulary_create')(context, data)
log.info("Adding tag %s to vocab %s" % ('Bob Mintzer', forms.COMPOSER_VOCAB)) log.info("Adding tag %s to vocab %s" % ('Bob Mintzer', forms.COMPOSER_VOCAB))
data = {'name': 'Bob Mintzer', 'vocabulary_id': vocab['id']} data = {'name': 'Bob Mintzer', 'vocabulary_id': vocab['id']}
get_action('tag_create')(context, data) get_action('tag_create')(context, data)
log.info("Adding tag %s to vocab %s" % ('Steve Lewis', forms.COMPOSER_VOCAB)) log.info("Adding tag %s to vocab %s" % ('Steve Lewis', forms.COMPOSER_VOCAB))
data = {'name': 'Steve Lewis', 'vocabulary_id': vocab['id']} data = {'name': 'Steve Lewis', 'vocabulary_id': vocab['id']}
get_action('tag_create')(context, data) get_action('tag_create')(context, data)
   
  def clean(self):
  log.error("Clean command not yet implemented")
   
file:a/ckanext/example/theme/templates/forms/dataset_form.html -> file:b/ckanext/example/theme/templates/forms/dataset_form.html
<form id="dataset-edit" method="post" <form id="dataset-edit" method="post"
py:attrs="{'class':'has-errors'} if errors else {}" py:attrs="{'class':'has-errors'} if errors else {}"
xmlns:i18n="http://genshi.edgewall.org/i18n" xmlns:i18n="http://genshi.edgewall.org/i18n"
xmlns:py="http://genshi.edgewall.org/" xmlns:py="http://genshi.edgewall.org/"
xmlns:xi="http://www.w3.org/2001/XInclude"> xmlns:xi="http://www.w3.org/2001/XInclude">
   
   
<div class="error-explanation" py:if="error_summary"> <div class="error-explanation" py:if="error_summary">
<h2>Errors in form</h2> <h2>Errors in form</h2>
<p>The form contains invalid entries:</p> <p>The form contains invalid entries:</p>
<ul> <ul>
<li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)} <li py:for="key, error in error_summary.items()">${"%s: %s" % (key, error)}
<py:if test="key=='Resources'"> <py:if test="key=='Resources'">
<ul> <ul>
<py:for each="idx, errordict in enumerate(errors.get('resources', []))"> <py:for each="idx, errordict in enumerate(errors.get('resources', []))">
<li py:if="errordict"> <li py:if="errordict">
Resource ${idx}: Resource ${idx}:
<ul> <ul>
<li py:for="thiskey, thiserror in errordict.items()">${thiskey}: <py:for each="errorinfo in thiserror">${errorinfo}; </py:for></li> <li py:for="thiskey, thiserror in errordict.items()">${thiskey}: <py:for each="errorinfo in thiserror">${errorinfo}; </py:for></li>
</ul> </ul>
</li> </li>
</py:for> </py:for>
</ul> </ul>
</py:if> </py:if>
</li> </li>
</ul> </ul>
</div> </div>
   
<fieldset id="basic-information"> <fieldset id="basic-information">
<dl> <dl>
<dt class="title-label"><label class="field_opt" for="title">Title</label></dt> <dt class="title-label"><label class="field_opt" for="title">Title</label></dt>
<dd class="title-field"> <dd class="title-field">
<input id="title" <input id="title"
class="js-title" class="js-title"
name="title" type="text" name="title" type="text"
value="${data.get('title', '')}" value="${data.get('title', '')}"
placeholder="${_('A short descriptive title for the dataset')}" placeholder="${_('A short descriptive title for the dataset')}"
/> />
</dd> </dd>
<dd class="title-instructions field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd> <dd class="title-instructions field_error" py:if="errors.get('title', '')">${errors.get('title', '')}</dd>
   
<dt class="name-label"><label class="field_req" for="name">Url</label></dt> <dt class="name-label"><label class="field_req" for="name">Url</label></dt>
<dd class="name-field"> <dd class="name-field">
<span class="js-url-text url-text">${url(controller='package', action='index')+'/'}<span class="js-url-viewmode js-url-suffix">&nbsp;</span><a href="#" style="display: none;" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span> <span class="js-url-text url-text">${h.url(controller='package', action='index')+'/'}<span class="js-url-viewmode js-url-suffix">&nbsp;</span><a href="#" style="display: none;" class="url-edit js-url-editlink js-url-viewmode">(edit)</a></span>
<input style="display: none;" id="name" maxlength="100" name="name" type="text" class="url-input js-url-editmode js-url-input" value="${data.get('name', '')}" /> <input style="display: none;" id="name" maxlength="100" name="name" type="text" class="url-input js-url-editmode js-url-input" value="${data.get('name', '')}" />
<p class="js-url-is-valid">&nbsp;</p> <p class="js-url-is-valid">&nbsp;</p>
</dd> </dd>
<dd style="display: none;" class="js-url-editmode name-instructions basic">2+ characters, lowercase, using only 'a-z0-9' and '-_'</dd> <dd style="display: none;" class="js-url-editmode name-instructions basic">2+ characters, lowercase, using only 'a-z0-9' and '-_'</dd>
<dd class="js-url-editmode name-instructions field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd> <dd class="js-url-editmode name-instructions field_error" py:if="errors.get('name', '')">${errors.get('name', '')}</dd>
   
<dt class="homepage-label"><label class="field_opt" for="url">Home Page</label></dt> <dt class="homepage-label"><label class="field_opt" for="url">Home Page</label></dt>
<dd class="homepage-field"><input id="url" name="url" type="text" value="${data.get('url', '')}"/></dd> <dd class="homepage-field"><input id="url" name="url" type="text" value="${data.get('url', '')}"/></dd>
<dd class="homepage-instructions instructions basic">The URL for the web page describing the data (not the data itself).</dd> <dd class="homepage-instructions instructions basic">The URL for the web page describing the data (not the data itself).</dd>
<dd class="homepage-instructions hints">e.g. http://www.example.com/growth-figures.html</dd> <dd class="homepage-instructions hints">e.g. http://www.example.com/growth-figures.html</dd>
<dd class="homepage-instructions field_error" py:if="errors.get('url', '')">${errors.get('url', '')}</dd> <dd class="homepage-instructions field_error" py:if="errors.get('url', '')">${errors.get('url', '')}</dd>
   
<dt class="license-label"><label class="field_opt" for="license_id">License</label></dt> <dt class="license-label"><label class="field_opt" for="license_id">License</label></dt>
<dd class="license-field"> <dd class="license-field">
<select id="license_id" name="license_id"> <select id="license_id" name="license_id">
<py:for each="licence_desc, licence_id in c.licences"> <py:for each="licence_desc, licence_id in c.licences">
<option value="${licence_id}" py:attrs="{'selected': 'selected' if data.get('license_id', '') == licence_id else None}" >${licence_desc}</option> <option value="${licence_id}" py:attrs="{'selected': 'selected' if data.get('license_id', '') == licence_id else None}" >${licence_desc}</option>
</py:for> </py:for>
</select> </select>
</dd> </dd>
<dd class="license-instructions instructions basic">The licence under which the dataset is released.</dd> <dd class="license-instructions instructions basic">The licence under which the dataset is released.</dd>
   
<dt class="description-label"><label class="field_opt" for="notes">Description</label></dt> <dt class="description-label"><label class="field_opt" for="notes">Description</label></dt>
<dd class="description-field"><div class="markdown-editor"> <dd class="description-field"><div class="markdown-editor">
<ul class="button-row"> <ul class="button-row">
<li><button class="pretty-button js-markdown-edit depressed">Edit</button></li> <li><button class="pretty-button js-markdown-edit depressed">Edit</button></li>
<li><button class="pretty-button js-markdown-preview">Preview</button></li> <li><button class="pretty-button js-markdown-preview">Preview</button></li>
</ul> </ul>
<textarea class="markdown-input" name="notes" id="notes" placeholder="${_('Start with a summary sentence ...')}">${data.get('notes','')}</textarea> <textarea class="markdown-input" name="notes" id="notes" placeholder="${_('Start with a summary sentence ...')}">${data.get('notes','')}</textarea>
<div class="markdown-preview" style="display: none;"></div> <div class="markdown-preview" style="display: none;"></div>
<span class="hints">You can use <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown formatting</a> here.</span> <span class="hints">You can use <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Markdown formatting</a> here.</span>
<!-- <!--
<dd class="instructions basic">The main description of the dataset</dd> <dd class="instructions basic">The main description of the dataset</dd>
<dd class="instructions further">It is often displayed with the dataset title. In particular, it should start with a short sentence that describes the dataset succinctly, because the first few words alone may be used in some views of the datasets.</dd> <dd class="instructions further">It is often displayed with the dataset title. In particular, it should start with a short sentence that describes the dataset succinctly, because the first few words alone may be used in some views of the datasets.</dd>
--> -->
</div></dd> </div></dd>
</dl> </dl>
</fieldset> </fieldset>
   
<fieldset id="resources"> <fieldset id="resources">
<div class="instructions basic"><h3>Resources: the files and APIs associated with this dataset</h3></div> <div class="instructions basic"><h3>Resources: the files and APIs associated with this dataset</h3></div>
<table class="resource-table-edit"> <table class="resource-table-edit">
<thead> <thead>
<tr> <tr>
<th class="field_req resource-url">Resource</th> <th class="field_req resource-url">Resource</th>
<th class="resource-delete-link"></th> <th class="resource-delete-link"></th>
</tr> </tr>
</thead> </thead>
<tbody class="js-resource-editor"> <tbody class="js-resource-editor">
</tbody> </tbody>
</table> </table>
   
   
<div class="resource-add"> <div class="resource-add">
<ul class="button-row"> <ul class="button-row">
<li><h4>Add a resource:</h4></li> <li><h4>Add a resource:</h4></li>
<li><button class="pretty-button js-link-file">Link to a file</button></li> <li><button class="pretty-button js-link-file">Link to a file</button></li>
<li><button class="pretty-button js-link-api">Link to an API</button></li> <li><button class="pretty-button js-link-api">Link to an API</button></li>
<li class="js-upload-file ckan-logged-in" style="display: none;"><button class="pretty-button js-upload-file">Upload a file</button></li> <li class="js-upload-file ckan-logged-in" style="display: none;"><button class="pretty-button js-upload-file">Upload a file</button></li>
</ul> </ul>
</div> </div>
</fieldset> </fieldset>
   
<fieldset id="groups"> <fieldset id="groups">
<h3>Groups</h3> <h3>Groups</h3>
<dl> <dl>
<py:for each="num, group in enumerate(data.get('groups', []))"> <py:for each="num, group in enumerate(data.get('groups', []))">
<?python <?python
authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']] authorized_group = [group_authz for group_authz in c.groups_authz if group_authz['id'] == group['id']]
authorized_group = authorized_group[0] if authorized_group else None authorized_group = authorized_group[0] if authorized_group else None
?> ?>
   
<dt py:if="'id' in group"> <dt py:if="'id' in group">
<input type="${'checkbox' if authorized_group else 'hidden'}" name="groups__${num}__id" checked="checked" value="${group['id']}" /> <input type="${'checkbox' if authorized_group else 'hidden'}" name="groups__${num}__id" checked="checked" value="${group['id']}" />
<input type="hidden" name="groups__${num}__name" value="${group.get('name', authorized_group['name'] if authorized_group else '')}" /> <input type="hidden" name="groups__${num}__name" value="${group.get('name', a