import os |
import os |
import logging |
import logging |
|
from pylons import tmpl_context as c |
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, NotFound |
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 |
from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer |
|
from ckan.plugins import IGenshiStreamFilter |
from ckan.plugins import implements, SingletonPlugin |
from ckan.plugins import implements, SingletonPlugin |
from ckan.lib.navl.validators import ignore_missing, 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' |
GENRE_VOCAB = u'genre_vocab' |
|
COMPOSER_VOCAB = u'composer_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(IGenshiStreamFilter, 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 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 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() |
try: |
try: |
c.vocab_tags = get_action('tag_list')(context, {'vocabulary_id': EXAMPLE_VOCAB}) |
c.genre_tags = get_action('tag_list')(context, {'vocabulary_id': GENRE_VOCAB}) |
|
c.composer_tags = get_action('tag_list')(context, {'vocabulary_id': COMPOSER_VOCAB}) |
except NotFound: |
except NotFound: |
c.vocab_tags = None |
c.vocab_tags = None |
|
c.composer_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': [ignore_missing, unicode, convert_to_extras], |
'published_by': [ignore_missing, unicode, convert_to_extras], |
'vocab_tags': [ignore_missing, convert_to_tags(EXAMPLE_VOCAB)], |
'genre_tags': [ignore_missing, convert_to_tags(GENRE_VOCAB)], |
|
'composer_tags': [ignore_missing, convert_to_tags(COMPOSER_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(EXAMPLE_VOCAB), ignore_missing], |
'genre_tags_selected': [ |
|
convert_from_tags(GENRE_VOCAB), ignore_missing |
|
], |
|
'composer_tags_selected': [ |
|
convert_from_tags(COMPOSER_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 |
|
|
|
def filter(self, stream): |
|
# Add vocab tags to the bottom of the sidebar. |
|
from pylons import request |
|
from genshi.filters import Transformer |
|
from genshi.input import HTML |
|
routes = request.environ.get('pylons.routes_dict') |
|
context = {'model': model} |
|
if routes.get('controller') == 'package' \ |
|
and routes.get('action') == 'read': |
|
for vocab in (GENRE_VOCAB, COMPOSER_VOCAB): |
|
try: |
|
vocab = get_action('vocabulary_show')(context, {'id': vocab}) |
|
vocab_tags = [t for t in c.pkg_dict.get('tags', []) |
|
if t.get('vocabulary_id') == vocab['id']] |
|
except NotFound: |
|
vocab_tags = None |
|
|
|
if not vocab_tags: |
|
continue |
|
|
|
html = '<li class="sidebar-section">' |
|
if vocab['name'] == GENRE_VOCAB: |
|
html = html + '<h3>Musical Genre</h3>' |
|
elif vocab['name'] == COMPOSER_VOCAB: |
|
html = html + '<h3>Composer</h3>' |
|
html = html + '<ul class="tags clearfix">' |
|
for tag in vocab_tags: |
|
html = html + '<li>%s</li>' % tag['name'] |
|
html = html + "</ul></li>" |
|
stream = stream | Transformer( |
|
"//div[@id='sidebar']//ul[@class='widget-list']" |
|
).append(HTML(html)) |
|
return stream |
|
|