| *.egg-info | *.egg-info |
| *.pyc | *.pyc |
| *.swp | *.swp |
| *.swo | *.swo |
| *~ | *~ |
| #* | #* |
| .#* | .#* |
| build/ | build/ |
| dist/ | dist/ |
| distribute-* |
| 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 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://packages.python.org/ckan/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://packages.python.org/ckan/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 override | ``ckanext/example/theme/`` (in this package). Here we: |
| the home page, provide some extra style with an ``extra.css``, and | * override the home page HTML ``ckanext/example/theme/templates/home/index.html`` |
| customise the navigation and header of the main template in the file ``layout.html``. | * 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``. | |
| 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 the | * The custom package edit form at ``package_form.py`` follows a deprecated |
| conventions in the "main CKAN | way to make a form (using FormAlchemy). This part of the Example Theme needs |
| documentation":http://packages.python.org/ckan/forms.html | updating. In the meantime, follow the instructions at: |
| http://readthedocs.org/docs/ckan/en/latest/forms.html | |
| import sys | import sys |
| from ckan.lib.base import request | from ckan.lib.base import request |
| from ckan.lib.base import c, g, h | from ckan.lib.base import c, g, h |
| from ckan.lib.base import model | from ckan.lib.base import model |
| from ckan.lib.base import render | from ckan.lib.base import render |
| from ckan.lib.base import _ | from ckan.lib.base import _ |
| from ckan.lib.navl.validators import not_empty | |
| from ckan.controllers.user import UserController | from ckan.controllers.user import UserController |
| class CustomUserController(UserController): | class CustomUserController(UserController): |
| """This controller is an example to show how you might extend or | """This controller is an example to show how you might extend or |
| override core CKAN behaviour from an extension package. | override core CKAN behaviour from an extension package. |
| It duplicates functionality in the core CKAN UserController's | It overrides 2 method hooks which the base class uses to create the |
| register function, but extends it to make an email address | validation schema for the creation and editing of a user; to require |
| mandatory. | that a fullname is given. |
| """ | """ |
| def custom_register(self): | |
| if request.method == 'POST': | |
| # custom validation that requires an email address | |
| error = False | |
| c.email = request.params.getone('email') | |
| c.login = request.params.getone('login') | |
| if not model.User.check_name_available(c.login): | |
| error = True | |
| h.flash_error(_("That username is not available.")) | |
| if not c.email: | |
| error = True | |
| h.flash_error(_("You must supply an email address.")) | |
| try: | |
| self._get_form_password() | |
| except ValueError, ve: | |
| h.flash_error(ve) | |
| error = True | |
| if error: | |
| return render('user/register.html') | |
| # now delegate to core CKAN register method | |
| return self.register() | |
| new_user_form = 'user/register.html' | |
| def _add_requires_full_name_to_schema(self, schema): | |
| """ | |
| Helper function that modifies the fullname validation on an existing schema | |
| """ | |
| schema['fullname'] = [not_empty, unicode] | |
| def _new_form_to_db_schema(self): | |
| """ | |
| Defines a custom schema that requires a full name to be supplied | |
| This method is a hook that the base class calls for the validation | |
| schema to use when creating a new user. | |
| """ | |
| schema = super(CustomUserController, self)._new_form_to_db_schema() | |
| self._add_requires_full_name_to_schema(schema) | |
| return schema | |
| def _edit_form_to_db_schema(self): | |
| """ | |
| Defines a custom schema that requires a full name cannot be removed | |
| when editing the user. | |
| This method is a hook that the base class calls for the validation | |
| schema to use when editing an exiting user. | |
| """ | |
| schema = super(CustomUserController, self)._edit_form_to_db_schema() | |
| self._add_requires_full_name_to_schema(schema) | |
| return schema | |
| import logging | |
| from ckan.lib.base import BaseController, render, c, model, abort, request | |
| from ckan.lib.base import redirect, _, config, h | |
| import ckan.logic.action.create as create | |
| import ckan.logic.action.update as update | |
| import ckan.logic.action.get as get | |
| from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras, convert_from_extras | |
| from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten | |
| from ckan.logic import NotFound, NotAuthorized, ValidationError | |
| from ckan.logic import tuplize_dict, clean_dict, parse_params | |
| from ckan.logic.schema import package_form_schema | |
| from ckan.plugins import IDatasetForm | |
| from ckan.plugins import implements, SingletonPlugin | |
| from ckan.lib.package_saver import PackageSaver | |
| from ckan.lib.field_types import DateType, DateConvertError | |
| from ckan.authz import Authorizer | |
| from ckan.lib.navl.dictization_functions import Invalid | |
| from ckan.lib.navl.dictization_functions import validate, missing | |
| import ckan.logic.validators as val | |
| import ckan.logic.schema as default_schema | |
| from ckan.lib.navl.validators import (ignore_missing, | |
| not_empty, | |
| empty, | |
| ignore, | |
| keep_extras, | |
| ) | |
| log = logging.getLogger(__name__) | |
| class ExampleDatasetForm(SingletonPlugin): | |
| """ | |
| """ | |
| implements(IDatasetForm, inherit=True) | |
| def package_form(self): | |
| """ | |
| Returns a string representing the location of the template to be | |
| rendered. e.g. "package/new_package_form.html". | |
| """ | |
| return 'controller/package_plugin.html' | |
| def is_fallback(self): | |
| """ | |
| Returns true iff this provides the fallback behaviour, when no other | |
| plugin instance matches a package's type. | |
| As this is not the fallback controller we should return False. If | |
| we were wanting to act as the fallback, we'd return True | |
| """ | |
| return False | |
| def package_types(self): | |
| """ | |
| Returns an iterable of package type strings. | |
| If a request involving a package of one of those types is made, then | |
| this plugin instance will be delegated to. | |
| There must only be one plugin registered to each package type. Any | |
| attempts to register more than one plugin instance to a given package | |
| type will raise an exception at startup. | |
| """ | |
| return ["example"] | |
| def setup_template_variables(self, context, data_dict=None): | |
| """ | |
| Add variables to c just prior to the template being rendered. | |
| """ | |
| c.licences = [('', '')] + model.Package.get_license_options() | |
| c.publishers = self.get_publishers() | |
| c.is_sysadmin = Authorizer().is_sysadmin(c.user) | |
| c.resource_columns = model.Resource.get_columns() | |
| ## This is messy as auths take domain object not data_dict | |
| pkg = context.get('package') or c.pkg | |
| if pkg: | |
| c.auth_for_change_state = Authorizer().am_authorized( | |
| c, model.Action.CHANGE_STATE, pkg) | |
| def form_to_db_schema(self): | |
| """ | |
| Returns the schema for mapping package data from a form to a format | |
| suitable for the database. | |
| """ | |
| schema = { | |
| 'title': [not_empty, unicode], | |
| 'name': [not_empty, unicode, val.name_validator, val.package_name_validator], | |
| 'notes': [not_empty, unicode], | |
| 'date_released': [date_to_db, convert_to_extras], | |
| 'date_updated': [date_to_db, convert_to_extras], | |
| 'date_update_future': [date_to_db, convert_to_extras], | |
| 'url': [unicode], | |
| 'taxonomy_url': [unicode, convert_to_extras], | |
| 'resources': default_schema.default_resource_schema(), | |
| 'published_by': [not_empty, unicode, convert_to_extras], | |
| 'published_via': [ignore_missing, unicode, convert_to_extras], | |
| 'author': [ignore_missing, unicode], | |
| 'author_email': [ignore_missing, unicode], | |
| 'mandate': [ignore_missing, unicode, convert_to_extras], | |
| 'license_id': [ignore_missing, unicode], | |
| 'tag_string': [ignore_missing, val.tag_string_convert], | |
| 'national_statistic': [ignore_missing, convert_to_extras], | |
| 'state': [val.ignore_not_admin, ignore_missing], | |
| 'log_message': [unicode, val.no_http], | |
| '__extras': [ignore], | |
| '__junk': [empty], | |
| } | |
| return schema | |
| def db_to_form_schema(data): | |
| """ | |
| Returns the schema for mapping package data from the database into a | |
| format suitable for the form (optional) | |
| """ | |
| schema = { | |
| 'date_released': [convert_from_extras, ignore_missing, date_to_form], | |
| 'date_updated': [convert_from_extras, ignore_missing, date_to_form], | |
| 'date_update_future': [convert_from_extras, ignore_missing, date_to_form], | |
| 'precision': [convert_from_extras, ignore_missing], | |
| 'taxonomy_url': [convert_from_extras, ignore_missing], | |
| 'resources': default_schema.default_resource_schema(), | |
| 'extras': { | |
| 'key': [], | |
| 'value': [], | |
| '__extras': [keep_extras] | |
| }, | |
| 'tags': { | |
| '__extras': [keep_extras] | |
| }, | |
| 'published_by': [convert_from_extras, ignore_missing], | |
| 'published_via': [convert_from_extras, ignore_missing], | |
| 'mandate': [convert_from_extras, ignore_missing], | |
| 'national_statistic': [convert_from_extras, ignore_missing], | |
| '__extras': [keep_extras], | |
| '__junk': [ignore], | |
| } | |
| return schema | |
| def check_data_dict(self, data_dict): | |
| """ | |
| Check if the return data is correct. | |
| raise a DataError if not. | |
| """ | |
| return | |
| def get_publishers(self): | |
| """ | |
| """ | |
| return [('pub1', 'pub2')] | |
| import os | import os |
| from logging import getLogger | from logging import getLogger |
| from genshi.filters.transform import Transformer | from genshi.filters.transform import Transformer |
| from ckan.plugins import implements, SingletonPlugin | from ckan.plugins import implements, SingletonPlugin |
| from ckan.plugins import IConfigurer | from ckan.plugins import IConfigurer |
| from ckan.plugins import IGenshiStreamFilter | from ckan.plugins import IGenshiStreamFilter |
| from ckan.plugins import IRoutes | from ckan.plugins import IRoutes |
| log = getLogger(__name__) | log = getLogger(__name__) |
| class ExamplePlugin(SingletonPlugin): | class ExamplePlugin(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 the site | 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 | title, and to tell CKAN to look in this package for templates |
| and resources that customise the core look and feel. | and resources that customise the core look and feel. |
| - ``IGenshiStreamFilter`` allows us to filter and transform the | - ``IGenshiStreamFilter`` allows us to filter and transform the |
| HTML stream just before it is rendered. In this case we use | HTML stream just before it is rendered. In this case we use |
| it to rename "frob" to "foobar" | it to rename "frob" to "foobar" |
| - ``IRoutes`` allows us to add new URLs, or override existing | - ``IRoutes`` allows us to add new URLs, or override existing |
| URLs. In this example we use it to override the default | URLs. In this example we use it to override the default |
| ``/register`` behaviour with a custom controller | ``/register`` behaviour with a custom controller |
| """ | """ |
| implements(IConfigurer, inherit=True) | implements(IConfigurer, inherit=True) |
| implements(IGenshiStreamFilter, inherit=True) | implements(IGenshiStreamFilter, inherit=True) |
| implements(IRoutes, inherit=True) | implements(IRoutes, 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 |
| ```public``` and ```templates``` directories present in this | ```public``` and ```templates``` directories present in this |
| package for any customisations. | package for any customisations. |
| It also shows how to set the site title here (rather than in | It also shows how to set the site title here (rather than in |
| the main site .ini file), and causes CKAN to use the | the main site .ini file), and causes CKAN to use the |
| customised package form defined in ``package_form.py`` in this | customised package form defined in ``package_form.py`` in this |
| directory. | directory. |
| """ | """ |
| here = |