projects / ckanext-datagovau.git / commitdiff
search:
summary | shortlog | log | commit | commitdiff | tree
unified | plain
[forms, commands] move code for creating example vocab to a paster command
[forms, commands] move code for creating example vocab to a paster command

file:b/ckanext/example/commands.py (new)
  from ckan import model
  from ckan.lib.cli import CkanCommand
  from ckan.logic import get_action, NotFound
  import forms
 
  import logging
  log = logging.getLogger()
 
 
  class ExampleCommand(CkanCommand):
  '''
  CKAN Example Extension
 
  Usage::
 
  paster example create-example-vocab -c <path to config file>
 
  paster example clean -c <path to config file>
  - Remove all data created by ckanext-example
 
  The commands should be run from the ckanext-example directory.
  '''
  summary = __doc__.split('\n')[0]
  usage = __doc__
 
  def command(self):
  '''
  Parse command line arguments and call appropriate method.
  '''
  if not self.args or self.args[0] in ['--help', '-h', 'help']:
  print ExampleCommand.__doc__
  return
 
  cmd = self.args[0]
  self._load_config()
 
  if cmd == 'create-example-vocab':
  self.create_example_vocab()
  else:
  log.error('Command "%s" not recognized' % (cmd,))
 
  def create_example_vocab(self):
  '''
  Adds an example vocabulary to the database if it doesn't
  already exist.
  '''
  user = get_action('get_site_user')({'model': model, 'ignore_auth': True}, {})
  context = {'model': model, 'session': model.Session, 'user': user['name']}
  data = {'id': forms.EXAMPLE_VOCAB}
 
  try:
  get_action('vocabulary_show')(context, data)
  log.info("Example tag vocabulary already exists, skipping.")
  except NotFound:
  log.info("Creating example vocab %s" % forms.EXAMPLE_VOCAB)
  data = {'name': forms.EXAMPLE_VOCAB}
  vocab = get_action('vocabulary_create')(context, data)
 
  log.info("Adding tag %s to vocab %s" % ('vocab-tag-example-1', forms.EXAMPLE_VOCAB))
  data = {'name': 'vocab-tag-example-1', 'vocabulary_id': vocab['id']}
  get_action('tag_create')(context, data)
 
  log.info("Adding tag %s to vocab %s" % ('vocab-tag-example-2', forms.EXAMPLE_VOCAB))
  data = {'name': 'vocab-tag-example-2', 'vocabulary_id': vocab['id']}
  get_action('tag_create')(context, data)
 
file:a/ckanext/example/forms.py -> file:b/ckanext/example/forms.py
import os, logging import os
  import logging
from ckan.authz import Authorizer from ckan.authz import Authorizer
from ckan.logic.converters import convert_to_extras,\ from ckan.logic.converters import convert_to_extras,\
convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only
from ckan.logic import get_action from ckan.logic import get_action, NotFound
from ckan.logic.schema import package_form_schema, group_form_schema from ckan.logic.schema import package_form_schema, group_form_schema
from ckan.lib.base import c, model from ckan.lib.base import c, model
from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer, IConfigurable from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer
from ckan.plugins import implements, SingletonPlugin from ckan.plugins import implements, SingletonPlugin
from ckan.lib.navl.validators import ignore_missing, not_empty, keep_extras from ckan.lib.navl.validators import ignore_missing, keep_extras
   
log = logging.getLogger(__name__) log = logging.getLogger(__name__)
   
  EXAMPLE_VOCAB = u'example_vocab'
   
   
class ExampleGroupForm(SingletonPlugin): class ExampleGroupForm(SingletonPlugin):
"""This plugin demonstrates how a class packaged as a CKAN """This plugin demonstrates how a class packaged as a CKAN
extension might extend CKAN behaviour by providing custom forms extension might extend CKAN behaviour by providing custom forms
based on the type of a Group. based on the type of a Group.
   
In this case, we implement two extension interfaces to provide custom In this case, we implement two extension interfaces to provide custom
forms for specific types of group. forms for specific types of group.
   
- ``IConfigurer`` allows us to override configuration normally - ``IConfigurer`` allows us to override configuration normally
found in the ``ini``-file. Here we use it to specify where the found in the ``ini``-file. Here we use it to specify where the
form templates can be found. form templates can be found.
- ``IGroupForm`` allows us to provide a custom form for a dataset - ``IGroupForm`` allows us to provide a custom form for a dataset
based on the 'type' that may be set for a group. Where the based on the 'type' that may be set for a group. Where the
'type' matches one of the values in group_types then this 'type' matches one of the values in group_types then this
class will be used. class will be used.
""" """
implements(IGroupForm, inherit=True) implements(IGroupForm, inherit=True)
implements(IConfigurer, inherit=True) implements(IConfigurer, inherit=True)
def update_config(self, config): def update_config(self, config):
""" """
This IConfigurer implementation causes CKAN to look in the This IConfigurer implementation causes CKAN to look in the
```templates``` directory when looking for the group_form() ```templates``` directory when looking for the group_form()
""" """
here = os.path.dirname(__file__) here = os.path.dirname(__file__)
rootdir = os.path.dirname(os.path.dirname(here)) rootdir = os.path.dirname(os.path.dirname(here))
template_dir = os.path.join(rootdir, 'ckanext', template_dir = os.path.join(rootdir, 'ckanext',
'example', 'theme', 'templates') 'example', 'theme', 'templates')
config['extra_template_paths'] = ','.join([template_dir, config['extra_template_paths'] = ','.join([template_dir,
config.get('extra_template_paths', '')]) config.get('extra_template_paths', '')])
def group_form(self): def group_form(self):
""" """
Returns a string representing the location of the template to be Returns a string representing the location of the template to be
rendered. e.g. "forms/group_form.html". rendered. e.g. "forms/group_form.html".
""" """
return 'forms/group_form.html' return 'forms/group_form.html'
   
def group_types(self): def group_types(self):
""" """
Returns an iterable of group type strings. Returns an iterable of group type strings.
   
If a request involving a group of one of those types is made, then If a request involving a group of one of those types is made, then
this plugin instance will be delegated to. this plugin instance will be delegated to.
   
There must only be one plugin registered to each group type. Any There must only be one plugin registered to each group type. Any
attempts to register more than one plugin instance to a given group attempts to register more than one plugin instance to a given group
type will raise an exception at startup. type will raise an exception at startup.
""" """
return ["testgroup"] return ["testgroup"]
   
def is_fallback(self): def is_fallback(self):
""" """
Returns true iff this provides the fallback behaviour, when no other Returns true iff this provides the fallback behaviour, when no other
plugin instance matches a group's type. plugin instance matches a group's type.
   
As this is not the fallback controller we should return False. If As this is not the fallback controller we should return False. If
we were wanting to act as the fallback, we'd return True we were wanting to act as the fallback, we'd return True
""" """
return False return False
def form_to_db_schema(self): def form_to_db_schema(self):
""" """
Returns the schema for mapping group data from a form to a format Returns the schema for mapping group data from a form to a format
suitable for the database. suitable for the database.
""" """
return group_form_schema() return group_form_schema()
   
def db_to_form_schema(self): def db_to_form_schema(self):
""" """
Returns the schema for mapping group data from the database into a Returns the schema for mapping group data from the database into a
format suitable for the form (optional) format suitable for the form (optional)
""" """
return {} return {}
def check_data_dict(self, data_dict): def check_data_dict(self, data_dict):
""" """
Check if the return data is correct. Check if the return data is correct.
   
raise a DataError if not. raise a DataError if not.
""" """
   
def setup_template_variables(self, context, data_dict): def setup_template_variables(self, context, data_dict):
""" """
Add variables to c just prior to the template being rendered. Add variables to c just prior to the template being rendered.
""" """
   
class ExampleDatasetForm(SingletonPlugin): class ExampleDatasetForm(SingletonPlugin):
"""This plugin demonstrates how a theme packaged as a CKAN """This plugin demonstrates how a theme packaged as a CKAN
extension might extend CKAN behaviour. extension might extend CKAN behaviour.
   
In this case, we implement three extension interfaces: In this case, we implement three extension interfaces:
   
- ``IConfigurer`` allows us to override configuration normally - ``IConfigurer`` allows us to override configuration normally
found in the ``ini``-file. Here we use it to specify where the found in the ``ini``-file. Here we use it to specify where the
form templates can be found. form templates can be found.
- ``IDatasetForm`` allows us to provide a custom form for a dataset - ``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 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 type_name matches one of the values in package_types then this
class will be used. class will be used.
""" """
implements(IDatasetForm, inherit=True) implements(IDatasetForm, inherit=True)
implements(IConfigurer, inherit=True) implements(IConfigurer, inherit=True)
implements(IConfigurable)  
def update_config(self, config): def update_config(self, config):
""" """
This IConfigurer implementation causes CKAN to look in the This IConfigurer implementation causes CKAN to look in the
```templates``` directory when looking for the package_form() ```templates``` directory when looking for the package_form()
""" """
here = os.path.dirname(__file__) here = os.path.dirname(__file__)
rootdir = os.path.dirname(os.path.dirname(here)) rootdir = os.path.dirname(os.path.dirname(here))
template_dir = os.path.join(rootdir, 'ckanext', template_dir = os.path.join(rootdir, 'ckanext',
'example', 'theme', 'templates') 'example', 'theme', 'templates')
config['extra_template_paths'] = ','.join([template_dir, config['extra_template_paths'] = ','.join([template_dir,
config.get('extra_template_paths', '')]) 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): def package_form(self):
""" """
Returns a string representing the location of the template to be Returns a string representing the location of the template to be
rendered. e.g. "package/new_package_form.html". rendered. e.g. "package/new_package_form.html".
""" """
return 'forms/dataset_form.html' return 'forms/dataset_form.html'
   
def is_fallback(self): def is_fallback(self):
""" """
Returns true iff this provides the fallback behaviour, when no other Returns true iff this provides the fallback behaviour, when no other
plugin instance matches a package's type. plugin instance matches a package's type.
   
As this is not the fallback controller we should return False. If As this is not the fallback controller we should return False. If
we were wanting to act as the fallback, we'd return True we were wanting to act as the fallback, we'd return True
""" """
return True return True
   
def package_types(self): def package_types(self):
""" """
Returns an iterable of package type strings. Returns an iterable of package type strings.
   
If a request involving a package of one of those types is made, then If a request involving a package of one of those types is made, then
this plugin instance will be delegated to. this plugin instance will be delegated to.
   
There must only be one plugin registered to each package type. Any There must only be one plugin registered to each package type. Any
attempts to register more than one plugin instance to a given package attempts to register more than one plugin instance to a given package
type will raise an exception at startup. type will raise an exception at startup.
""" """
return ["example_dataset_form"] return ["example_dataset_form"]
   
def setup_template_variables(self, context, data_dict=None): def setup_template_variables(self, context, data_dict=None):
""" """
Adds variables to c just prior to the template being rendered that can Adds variables to c just prior to the template being rendered that can
then be used within the form then be used within the form
""" """
c.licences = [('', '')] + model.Package.get_license_options() c.licences = [('', '')] + model.Package.get_license_options()
c.publishers = [('Example publisher', 'Example publisher 2')] c.publishers = [('Example publisher', 'Example publisher 2')]
c.is_sysadmin = Authorizer().is_sysadmin(c.user) c.is_sysadmin = Authorizer().is_sysadmin(c.user)
c.resource_columns = model.Resource.get_columns() c.resource_columns = model.Resource.get_columns()
c.vocab_tags = get_action('tag_list')(context, {'vocabulary_name': self.vocab_name}) try:
  c.vocab_tags = get_action('tag_list')(context, {'vocabulary_id': EXAMPLE_VOCAB})
  except NotFound:
  c.vocab_tags = None
   
## This is messy as auths take domain object not data_dict ## This is messy as auths take domain object not data_dict
pkg = context.get('package') or c.pkg pkg = context.get('package') or c.pkg
if pkg: if pkg:
c.auth_for_change_state = Authorizer().am_authorized( c.auth_for_change_state = Authorizer().am_authorized(
c, model.Action.CHANGE_STATE, pkg) c, model.Action.CHANGE_STATE, pkg)
   
def form_to_db_schema(self): def form_to_db_schema(self):
""" """
Returns the schema for mapping package data from a form to a format Returns the schema for mapping package data from a form to a format
suitable for the database. suitable for the database.
""" """
schema = package_form_schema() schema = package_form_schema()
schema.update({ schema.update({
'published_by': [not_empty, unicode, convert_to_extras], 'published_by': [ignore_missing, unicode, convert_to_extras],
'vocab_tags': [ignore_missing, convert_to_tags(self.vocab_name)], 'vocab_tags': [ignore_missing, convert_to_tags(EXAMPLE_VOCAB)],
}) })
return schema return schema
def db_to_form_schema(self): def db_to_form_schema(self):
""" """
Returns the schema for mapping package data from the database into a Returns the schema for mapping package data from the database into a
format suitable for the form (optional) format suitable for the form (optional)
""" """
schema = package_form_schema() schema = package_form_schema()
schema.update({ schema.update({
'tags': { 'tags': {
'__extras': [keep_extras, free_tags_only] '__extras': [keep_extras, free_tags_only]
}, },
'vocab_tags_selected': [convert_from_tags(self.vocab_name), ignore_missing], 'vocab_tags_selected': [convert_from_tags(EXAMPLE_VOCAB), ignore_missing],
'published_by': [convert_from_extras, ignore_missing], 'published_by': [convert_from_extras, ignore_missing],
}) })
return schema return schema
   
def check_data_dict(self, data_dict): def check_data_dict(self, data_dict):
""" """
Check if the return data is correct and raises a DataError if not. Check if the return data is correct and raises a DataError if not.
""" """
return return
   
   
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">${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', authorized_group['name'] if authorized_group else '')}" />
</dt> </dt>
<dd py:if="'id' in group"><label for="groups__${num}__checked">${group.get('name', authorized_group['name'] if authorized_group else '')}</label></dd> <dd py:if="'id' in group"><label for="groups__${num}__checked">${group.get('name', authorized_group['name'] if authorized_group else '')}</label></dd>
</py:for> </py:for>
   
<dt>Group</dt> <dt>Group</dt>
<dd py:if="c.groups_available"> <dd py:if="c.groups_available">
<select id="groups__${len(data.get('groups', []))}__id" name="groups__${len(data.get('groups', []))}__id"> <select id="groups__${len(data.get('groups', []))}__id" name="groups__${len(data.get('groups', []))}__id">
<option selected="selected" value="">(None)</option> <option selected="selected" value="">(None)</option>
<py:for each="group in c.groups_available"> <py:for each="group in c.groups_available">
<option value="${group['id']}" >${group['name']}</option> <option value="${group['id']}" >${group['name']}</option>
</py:for> </py:for>
</select> </select>
</dd> </dd>
<dd py:if="not c.groups_available"><em>Cannot add any groups.</em></dd> <dd py:if="not c.groups_available"><em>Cannot add any groups.</em></dd>
</dl> </dl>
<h3>Tags</h3> <h3>Tags</h3>
<dl> <dl>
<dt class="tags-label"><label class="field_opt" for="tags">Tags</label></dt> <dt class="tags-label"><label class="field_opt" for="tags">Tags</label></dt>
<dd class="tags-field"> <dd class="tags-field">
<input class="long autocomplete-tag" id="tag_string" name="tag_string" size="60" type="text" <input class="long autocomplete-tag" id="tag_string" name="tag_string" size="60" type="text"
value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', []) if not tag.get('vocabulary_id')])}" /> value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', []) if not tag.get('vocabulary_id')])}" />
</dd> </dd>
<dd class="tags-instructions instructions basic" i18n:msg="">Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="http://wiki.okfn.org/ckan/doc/faq#TagConventions">this wiki page</a>.</dd> <dd class="tags-instructions instructions basic" i18n:msg="">Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="http://wiki.okfn.org/ckan/doc/faq#TagConventions">this wiki page</a>.</dd>
<dd class="tags-instructions hints">e.g. pollution, rivers, water quality</dd> <dd class="tags-instructions hints">e.g. pollution, rivers, water quality</dd>
<dd class="tags-instructions field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd> <dd class="tags-instructions field_error" py:if="errors.get('tag_string', '')">${errors.get('tag_string', '')}</dd>
</dl> </dl>
<h3>Tags with Vocabulary</h3> <h3 py:if="c.vocab_tags">Tags With Example Vocabulary</h3>
<dl> <dl py:if="c.vocab_tags">
<dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt> <dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt>
<dd class="tags-field"> <dd class="tags-field">
<select id="vocab_tags" class="chzn-select" name="vocab_tags" size="60" multiple="multiple"> <select id="vocab_tags" class="chzn-select" name="vocab_tags" size="60" multiple="multiple">
<py:for each="tag in c.vocab_tags"> <py:for each="tag in c.vocab_tags">
<py:choose test=""> <py:choose test="">
<option py:when="tag in data.get('vocab_tags_selected', [])" selected="selected" value="${tag}">${tag}</option> <option py:when="tag in data.get('vocab_tags_selected', [])" selected="selected" value="${tag}">${tag}</option>
<option py:otherwise="" value="${tag}">${tag}</option> <option py:otherwise="" value="${tag}">${tag}</option>
</py:choose> </py:choose>
</py:for> </py:for>
</select> </select>
</dd> </dd>
<dd class="tags-instructions instructions basic" i18n:msg="">Similar to standard CKAN tags, but these use a fixed vocabulary.</dd> <dd class="tags-instructions instructions basic" i18n:msg="">Similar to standard CKAN tags, but these use a fixed vocabulary.</dd>
<dd class="tags-instructions field_error" py:if="errors.get('vocab_tag_string', '')">${errors.get('vocab_tag_string', '')}</dd> <dd class="tags-instructions field_error" py:if="errors.get('vocab_tag_string', '')">${errors.get('vocab_tag_string', '')}</dd>
</dl> </dl>
</fieldset> </fieldset>
<fieldset id='further-information'> <fieldset id='further-information'>
<dl> <dl>
<dt><label class="field_opt" for="author">Author</label></dt> <dt><label class="field_opt" for="author">Author</label></dt>
<dd><input id="author" name="author" type="text" value="${data.get('author', '')}" /></dd> <dd><input id="author" name="author" type="text" value="${data.get('author', '')}" /></dd>
<dd class="instructions basic">The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.</dd> <dd class="instructions basic">The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.</dd>
   
<dt><label class="field_opt" for="author_email">Author email</label></dt> <dt><label class="field_opt" for="author_email">Author email</label></dt>
<dd><input id="author_email" name="author_email" type="text" value="${data.get('author_email', '')}" /></dd> <dd><input id="author_email" name="author_email" type="text" value="${data.get('author_email', '')}" /></dd>
   
<dt><label class="field_opt" for="maintainer">Maintainer</label></dt> <dt><label class="field_opt" for="maintainer">Maintainer</label></dt>
<dd><input id="maintainer" name="maintainer" type="text" value="${data.get('maintainer', '')}" /></dd> <dd><input id="maintainer" name="maintainer" type="text" value="${data.get('maintainer', '')}" /></dd>
<dd class="instructions basic">If there is another important contact person (in addition to the person in the Author field) then provide details here.</dd> <dd class="instructions basic">If there is another important contact person (in addition to the person in the Author field) then provide details here.</dd>
   
<dt><label class="field_opt" for="maintainer_email">Maintainer email</label></dt> <dt><label class="field_opt" for="maintainer_email">Maintainer email</label></dt>
<dd><input id="maintainer_email" name="maintainer_email" type="text" value="${data.get('maintainer_email', '')}" /></dd> <dd><input id="maintainer_email" name="maintainer_email" type="text" value="${data.get('maintainer_email', '')}" /></dd>
   
<dt><label class="field_opt" for="version">Version</label></dt> <dt><label class="field_opt" for="version">Version</label></dt>
<dd><input id="version" maxlength="100" name="version" type="text" value="${data.get('version', '')}" /></dd> <dd><input id="version" maxlength="100" name="version" type="text" value="${data.get('version', '')}" /></dd>
<dd class="instructions basic">A number representing the version (if applicable)</dd> <dd class="instructions basic">A number representing the version (if applicable)</dd>
<dd class="hints">e.g. 1.2.0</dd> <dd class="hints">e.g. 1.2.0</dd>
   
<dt py:if="c.is_sysadmin or c.auth_for_change_state"><label class="field_opt" for="state">State</label></dt> <dt py:if="c.is_sysadmin or c.auth_for_change_state"><label class="field_opt" for="state">State</label></dt>
<dd py:if="c.is_sysadmin or c.auth_for_change_state"> <dd py:if="c.is_sysadmin or c.auth_for_change_state">
<select id="state" name="state" > <select id="state" name="state" >
<option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option> <option py:attrs="{'selected': 'selected' if data.get('state') == 'active' else None}" value="active">active</option>
<option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option> <option py:attrs="{'selected': 'selected' if data.get('state') == 'deleted' else None}" value="deleted">deleted</option>
</select> </select>
</dd> </dd>
   
</dl> </dl>
</fieldset> </fieldset>
   
<fieldset id='extras'> <fieldset id='extras'>
<dl> <dl>
<dt><label class="field_req" for="published_by">Published by *</label></dt> <dt><label class="field_req" for="published_by">Published by *</label></dt>
<dd> <dd>
<select id="published_by" name="published_by"> <select id="published_by" name="published_by">
<py:for each="published_name, published_desc in c.publishers"> <py:for each="published_name, published_desc in c.publishers">
<option value="${published_name}" py:attrs="{'selected': 'selected' if data.get('published_by', '') == published_name else None}" > <option value="${published_name}" py:attrs="{'selected': 'selected' if data.get('published_by', '') == published_name else None}" >
${published_desc} ${published_desc}
</option> </option>
</py:for> </py:for>
</select> </select>
</dd> </dd>
<dd class="instructions basic">The organisation credited with or associated with the publication of this data.</dd> <dd class="instructions basic">The organisation credited with or associated with the publication of this data.</dd>
   
<py:with vars="extras = data.get('extras', [])"> <py:with vars="extras = data.get('extras', [])">
<py:for each="num, extra in enumerate(data.get('extras', []))"> <py:for each="num, extra in enumerate(data.get('extras', []))">
<dt><label for="extras__${num}__value">${extra.get('key')}</label></dt> <dt><label for="extras__${num}__value">${extra.get('key')}</label></dt>
<dd> <dd>
<input id="extras__${num}__key" name="extras__${num}__key" type="hidden" value="${extra.get('key')}" /> <input id="extras__${num}__key" name="extras__${num}__key" type="hidden" value="${extra.get('key')}" />
<input id="extras__${num}__value" name="extras__${num}__value" type="text" value="${extra.get('value')}" /> <input id="extras__${num}__value" name="extras__${num}__value" type="text" value="${extra.get('value')}" />
<input type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input> <input type="checkbox" name="extras__${num}__deleted" checked="${extra.get('deleted')}">Delete</input>
</dd> </dd>
</py:for> </py:for>
   
<py:for each="num in range(len(extras), len(extras) + 4)"> <py:for each="num in range(len(extras), len(extras) + 4)">
<dt><label for="extras__${num}__key">New key</label></dt> <dt><label for="extras__${num}__key">New key</label></dt>
<dd> <dd>
<input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" /> <input class="medium-width" id="extras__${num}__key" name="extras__${num}__key" type="text" />
with value with value
<input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" /> <input class="medium-width" id="extras__${num}__value" name="extras__${num}__value" type="text" />
</dd> </dd>
</py:for> </py:for>
</py:with> </py:with>
</dl> </dl>
</fieldset> </fieldset>
   
<label for="log_message" class="edit-summary">Edit summary (briefly describe the changes you have made)</label> <label for="log_message" class="edit-summary">Edit summary (briefly describe the changes you have made)</label>
<textarea id="log_message" name="log_message" class="edit-summary short wide">${data.get('log_message', '')}</textarea> <textarea id="log_message" name="log_message" class="edit-summary short wide">${data.get('log_message', '')}</textarea>
   
<div class="ckan-logged-in" style="display: none;"> <div class="ckan-logged-in" style="display: none;">
<p>Author: ${c.author}</p> <p>Author: ${c.author}</p>
</div> </div>
<div class="ckan-logged-out"> <div class="ckan-logged-out">
<label>Author: ${c.author}</label> <label>Author: ${c.author}</label>
<p i18n:msg="" class="hints"> <p i18n:msg="" class="hints">
Since you have not signed in this will just be your IP address. Since you have not signed in this will just be your IP address.
<a href="${h.url_for(controller='user', action='login', id=None)}" target="_blank">Click here to sign in</a> before saving (opens in new window). <a href="${h.url_for(controller='user', action='login', id=None)}" target="_blank">Click here to sign in</a> before saving (opens in new window).
</p> </p>
</div> </div>
   
<div class="form-submit"> <div class="form-submit">
<input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" /> <input id="save" class="pretty-button primary" name="save" type="submit" value="${_('Save Changes')}" />
<py:if test="c.pkg"> <py:if test="c.pkg">
<input id="cancel" class="pretty-button href-action" name="cancel" type="reset" value="${_('Cancel')}" action="${h.url_for(controller='package', action='read', id=c.pkg.name)}" /> <input id="cancel" class="pretty-button href-action" name="cancel" type="reset" value="${_('Cancel')}" action="${h.url_for(controller='package', action='read', id=c.pkg.name)}" />
</py:if> </py:if>
<p i18n:msg="" class="hints"> <p i18n:msg="" class="hints">
<strong>Important:</strong> By submitting content, you agree to release your contributions under the <a href="http://opendatacommons.org/licenses/odbl/1.0/">Open Database License</a>. Please <strong>refrain</strong> from editing this page if you are <strong>not</strong> happy to do this. <strong>Important:</strong> By submitting content, you agree to release your contributions under the <a href="http://opendatacommons.org/licenses/odbl/1.0/">Open Database License</a>. Please <strong>refrain</strong> from editing this page if you are <strong>not</strong> happy to do this.
</p> </p>
<div class="clear"></div> <div class="clear"></div>
</div> </div>
   
</form> </form>
   
file:a/setup.py -> file:b/setup.py
from setuptools import setup, find_packages from setuptools import setup, find_packages
   
version = '0.2' version = '0.2'
   
setup( setup(
name='ckanext-example', name='ckanext-example',
version=version, version=version,
description='Example extension for customising CKAN', description='Example extension for customising CKAN',
long_description='', long_description='',
classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
keywords='', keywords='',
author='Seb Bacon', author='Seb Bacon',
author_email='seb.bacon@gmail.com', author_email='seb.bacon@gmail.com',
url='', url='',
license='', license='',
packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), packages=find_packages(exclude=['ez_setup', 'examples', 'tests']),
namespace_packages=['ckanext', 'ckanext.example'], namespace_packages=['ckanext', 'ckanext.example'],
include_package_data=True, include_package_data=True,
zip_safe=False, zip_safe=False,
install_requires=[ install_requires=[],
# -*- Extra requirements: -*-  
],  
entry_points=\ entry_points=\
""" """
[ckan.plugins] [ckan.plugins]
example=ckanext.example.plugin:ExamplePlugin example=ckanext.example.plugin:ExamplePlugin
example_datasetform=ckanext.example.forms:ExampleDatasetForm example_datasetform=ckanext.example.forms:ExampleDatasetForm
example_groupform=ckanext.example.forms:ExampleGroupForm example_groupform=ckanext.example.forms:ExampleGroupForm
   
[ckan.forms] [ckan.forms]
example_form = ckanext.example.package_form:get_example_fieldset example_form = ckanext.example.package_form:get_example_fieldset
   
  [paste.paster_command]
  example=ckanext.example.commands:ExampleCommand
""", """,
) )
   
Unnamed repository; edit this file 'description' to name the repository.
GitPHP by Chris Han