From: Seb Bacon Date: Tue, 29 Mar 2011 10:02:06 +0000 Subject: initial commit X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=120225aa7a0fee936d1f287a0c8cfb0e92345e01 --- initial commit --- --- /dev/null +++ b/.hgignore @@ -1,1 +1,11 @@ +syntax: glob +*.egg-info +*.pyc +*.swp +*.swo +*~ +#* +.#* +build/ +dist/ --- /dev/null +++ b/README.txt @@ -1,1 +1,19 @@ +This CKAN Extension demonstrates some common patterns for customising a CKAN instance. +It comprises: + + * A CKAN Extension "plugin" at ``ckanext/exampletheme/__init__.py`` + which, when loaded, overrides various settings in the core + ``ini``-file to provide: + + * A path to local customisations of the core templates and stylesheets + * 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 custom Pylons controller for overriding some core CKAN behaviour + + * A custom Package edit form + + * Some simple template customisations + + --- /dev/null +++ b/ckanext/__init__.py @@ -1,1 +1,8 @@ +# this is a namespace package +try: + import pkg_resources + pkg_resources.declare_namespace(__name__) +except ImportError: + import pkgutil + __path__ = pkgutil.extend_path(__path__, __name__) --- /dev/null +++ b/ckanext/exampletheme/__init__.py @@ -1,1 +1,86 @@ +import os +from logging import getLogger +from genshi.filters.transform import Transformer + +from ckan.plugins import implements, SingletonPlugin +from ckan.plugins import IConfigurer +from ckan.plugins import IGenshiStreamFilter +from ckan.plugins import IRoutes + +log = getLogger(__name__) + + +class ExampleThemePlugin(SingletonPlugin): + """This plugin demonstrates how a theme packaged as a CKAN + extension might extend CKAN behaviour. + + In this case, we implement three extension interfaces: + + - ``IConfigurer`` allows us to override configuration normally + found in the ``ini``-file. Here we use it to specify the site + title, and to tell CKAN to look in this package for templates + and resources that customise the core look and feel. + - ``IGenshiStreamFilter`` allows us to filter and transform the + HTML stream just before it is rendered. In this case we use + it to rename "frob" to "foobar" + - ``IRoutes`` allows us to add new URLs, or override existing + URLs. In this example we use it to override the default + ``/register`` behaviour with a custom controller + """ + implements(IConfigurer, inherit=True) + implements(IGenshiStreamFilter, inherit=True) + implements(IRoutes, inherit=True) + + def update_config(self, config): + """This IConfigurer implementation causes CKAN to look in the + ```public``` and ```templates``` directories present in this + package for any customisations. + + It also shows how to set the site title here (rather than in + the main site .ini file), and causes CKAN to use the + customised package form defined in ``package_form.py`` in this + directory. + """ + here = os.path.dirname(__file__) + rootdir = os.path.dirname(os.path.dirname(here)) + our_public_dir = os.path.join(rootdir, 'ckanext', + 'exampletheme', 'theme', 'public') + template_dir = os.path.join(rootdir, 'ckanext', + 'exampletheme', 'theme', + 'templates') + # set our local template and resource overrides + config['extra_public_paths'] = ','.join([our_public_dir, + config.get('extra_public_paths', '')]) + config['extra_template_paths'] = ','.join([template_dir, + config.get('extra_template_paths', '')]) + # set the title + config['ckan.site_title'] = "An example CKAN theme" + # set the customised package form (see ``setup.py`` for entry point) + config['package_form'] = "example_form" + + def filter(self, stream): + """Conform to IGenshiStreamFilter interface. + + This example filter renames 'frob' to 'foobar' (this string is + found in the custom ``home/index.html`` template provided as + part of the package). + """ + stream = stream | Transformer('p[@id="examplething"]')\ + .substitute(r'frob', r'foobar') + return stream + + def before_map(self, map): + """This IRoutes implementation overrides the standard + ``/user/register`` behaviour with a custom controller. You + might instead use it to provide a completely new page, for + example. + + Note that we have also provided a custom register form + template at ``theme/templates/user/register.html``. + """ + map.connect('/user/register', + controller='ckanext.exampletheme.controller:CustomUserController', + action='custom_register') + return map + --- /dev/null +++ b/ckanext/exampletheme/controller.py @@ -1,1 +1,40 @@ +import sys +from ckan.lib.base import request +from ckan.lib.base import c, g, h +from ckan.lib.base import model +from ckan.lib.base import render +from ckan.lib.base import _ +from ckan.controllers.user import UserController + + +class CustomUserController(UserController): + """This controller is an example to show how you might extend or + override core CKAN behaviour from an extension package. + + It duplicates functionality in the core CKAN UserController's + register function, but extends it to make an email address + mandatory. + """ + 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() + --- /dev/null +++ b/ckanext/exampletheme/package_form.py @@ -1,1 +1,40 @@ +from sqlalchemy.util import OrderedDict +from pylons.i18n import _ +from ckan.forms import common +from ckan.forms import package + + +# Setup the fieldset +def build_example_form(is_admin=False, + user_editable_groups=None, + **kwargs): + """Customise the core CKAN dataset editing form by adding a new + field "temporal coverage", and changing the layout of the core + fields. + """ + # Restrict fields + builder = package.build_package_form( + user_editable_groups=user_editable_groups) + + # Extra fields + builder.add_field(common.DateRangeExtraField('temporal_coverage')) + + # Layout + field_groups = OrderedDict([ + (_('Basic information'), ['title', 'name', 'url', + 'notes', 'tags']), + (_('Details'), ['author', 'author_email', 'groups', + 'maintainer', 'maintainer_email', + 'license_id', 'temporal_coverage' ]), + (_('Resources'), ['resources']), + ]) + builder.set_displayed_fields(field_groups) + return builder + + +def get_example_fieldset(is_admin=False, user_editable_groups=None, **kwargs): + return build_example_form(is_admin=is_admin, + user_editable_groups=user_editable_groups, + **kwargs).get_fieldset() + --- /dev/null +++ b/ckanext/exampletheme/theme/public/css/extra.css @@ -1,1 +1,5 @@ +body { + background-color: pink; +} + --- /dev/null +++ b/ckanext/exampletheme/theme/templates/home/index.html @@ -1,1 +1,26 @@ + + Home + + + + + +
+

Welcome to Example Theme!

+

+ This page left intentionally ugly +

+
+ + + + --- /dev/null +++ b/ckanext/exampletheme/theme/templates/layout.html @@ -1,1 +1,33 @@ + + + +
+
    +
  • ${h.nav_link(c, _('Home'), controller='home', action='index', id=None)} +
    • +
  • ${h.nav_link(c, _('Data'), controller='package', action='index', id=None)} +
    • +
+
+ + + + +
+
+ + +
+
+ + + + + --- /dev/null +++ b/ckanext/exampletheme/theme/templates/user/register.html @@ -1,1 +1,49 @@ + + + +
  • +

    Have an OpenID?

    +

    + If you have an account with Google, Yahoo or one of many other + OpenID providers, you can log in without signing up. +

    +
      +
    • ${h.link_to(_('Log in now'), h.url_for(conroller='user', action='login'))}
      • +
    +
    • +     + + Register - User +
    +

    Join the community

    + +
    +
    + Register with CKAN + + + +
    + + +
    + + +
    + + +
    + + +
    +
    + ${h.submit('s', _('Sign up'))} +
    +
    + + + --- /dev/null +++ b/setup.py @@ -1,1 +1,34 @@ +from setuptools import setup, find_packages +import sys, os +version = '0.1' + +setup( + name='ckanext-exampletheme', + version=version, + description="Example themeb for customising CKAN", + long_description="""\ + """, + classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers + keywords='', + author='Seb Bacon', + author_email='seb.bacon@gmail.com', + url='', + license='', + packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), + namespace_packages=['ckanext', 'ckanext.exampletheme'], + include_package_data=True, + zip_safe=False, + install_requires=[ + # -*- Extra requirements: -*- + ], + entry_points=\ + """ + [ckan.plugins] + datagm=ckanext.exampletheme:ExampleThemePlugin + + [ckan.forms] + example_form = ckanext.exampletheme.package_form:get_example_fieldset + """, +) +