From: CKAN data.gov.au Date: Thu, 12 Sep 2013 07:34:13 +0000 Subject: Move last active user logic to helper function X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=ddcc2681391e4a46a9bb58d4dde613fe84bdb648 --- Move last active user logic to helper function --- --- /dev/null +++ b/.idea/.name @@ -1,1 +1,1 @@ - +ckanext-datagovau --- /dev/null +++ b/.idea/compiler.xml @@ -1,1 +1,24 @@ + + + + + + --- /dev/null +++ b/.idea/encodings.xml @@ -1,1 +1,6 @@ + + + + + --- /dev/null +++ b/.idea/misc.xml @@ -1,1 +1,23 @@ + + + + + + + + + + + + + + + + + + --- /dev/null +++ b/.idea/modules.xml @@ -1,1 +1,10 @@ + + + + + + + + + --- /dev/null +++ b/.idea/other.xml @@ -1,1 +1,8 @@ + + + + + + --- /dev/null +++ b/.idea/scopes/scope_settings.xml @@ -1,1 +1,5 @@ - + + + + --- /dev/null +++ b/.idea/testrunner.xml @@ -1,1 +1,9 @@ + + + + + + --- /dev/null +++ b/.idea/vcs.xml @@ -1,1 +1,8 @@ + + + + + + + --- /dev/null +++ b/.idea/workspace.xml @@ -1,1 +1,692 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + localhost + 5050 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + --- a/README.rst +++ b/README.rst @@ -1,66 +1,27 @@ -This CKAN Extension demonstrates some common patterns for customising a CKAN instance. +This CKAN Extension customises a CKAN instance for the hosting of data.gov.au. It comprises: -* A CKAN Extension "plugin" at ``ckanext/example/plugin.py`` which, when +* A CKAN Extension "plugin" at ``ckanext/datagovau/plugin.py`` which, when loaded, overrides various settings in the core ``ini``-file to provide: + * A path to local customisations of the core templates + * A custom Package edit form that defaults to cc-by licence + * A custom n3/rdf output format - * 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 - -* A custom Group edit form - -* A plugin that allows for custom forms to be used for datasets based on - their "type". - -* A custom User registration and edition form - -* Some simple template customisations +* A cut down licenses.json file Installation ============ 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-datagovau#egg=ckanext-datagovau -Then activate it by setting ``ckan.plugins = example`` in your main ``ini``-file. +Then activate it by setting ``ckan.plugins = datagovau`` in your main ``ini``-file. + +To add the cut down licenses.json set ``licenses_group_url = http://%(ckan.site_url)/licenses.json`` +or copy ``ckanext/datagovau/theme/public/licenses.json`` to the same folder as your CKAN config ini file +and set ``licenses_group_url = file://%(here)s/licenses.json`` -Orientation -=========== -* Examine the source code, starting with ``ckanext/example/plugin.py`` - -* To understand the nuts and bolts of this file, which is a CKAN - *Extension*, read in conjunction with the "Extension - documentation": http://docs.ckan.org/en/latest/plugins.html - -* One thing the extension does is set the values of - ``extra_public_paths`` and ``extra_template_paths`` in the CKAN - config, which are "documented - here": http://docs.ckan.org/en/latest/configuration.html#extra-template-paths - -* These are set to point at directories within - ``ckanext/example/theme/`` (in this package). Here we: - * 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 - * 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. - It uses the _layout template_ pattern "described in the Genshi - documentation":http://genshi.edgewall.org/wiki/GenshiTutorial#AddingaLayoutTemplate. - This allows you to use Xpath selectors to override snippets of HTML - globally. - -* 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 - updating. In the meantime, follow the instructions at: - http://readthedocs.org/docs/ckan/en/latest/forms.html - - --- /dev/null +++ b/ckanext-datagovau.iml @@ -1,1 +1,13 @@ + + + + + + + + + + + + --- /dev/null +++ b/ckanext/datagovau/__init__.py --- /dev/null +++ b/ckanext/datagovau/plugin.py @@ -1,1 +1,163 @@ +import logging +import ckan.plugins as plugins +import ckan.lib as lib +import ckan.lib.dictization.model_dictize as model_dictize +import ckan.plugins.toolkit as tk +import ckan.model as model + +#parse the activity feed for last active non-system user +def get_last_active_user(id): + system_user = "de0ba262-83fe-45e2-adda-41bb9f0c86d8" + user_list = [x for x in lib.helpers.get_action('package_activity_list',{'id':id}) if x['user_id'] != system_user] + user = user_list[0]['user_id'] + if user is None: + return lib.helpers.get_action('user_show',{'id':system_user}) + else: + return lib.helpers.get_action('user_show',{'id':user}) + + +class ExampleIDatasetFormPlugin(plugins.SingletonPlugin, + tk.DefaultDatasetForm): + '''An example IDatasetForm CKAN plugin. + + Uses a tag vocabulary to add a custom metadata field to datasets. + + ''' + plugins.implements(plugins.IConfigurer, inherit=False) + plugins.implements(plugins.IDatasetForm, inherit=False) + plugins.implements(plugins.ITemplateHelpers, inherit=False) + + # These record how many times methods that this plugin's methods are + # called, for testing purposes. + num_times_new_template_called = 0 + num_times_read_template_called = 0 + num_times_edit_template_called = 0 + num_times_search_template_called = 0 + num_times_history_template_called = 0 + num_times_package_form_called = 0 + num_times_check_data_dict_called = 0 + num_times_setup_template_variables_called = 0 + + + def update_config(self, config): + # Add this plugin's templates dir to CKAN's extra_template_paths, so + # that CKAN will use this plugin's custom templates. + # here = os.path.dirname(__file__) + # rootdir = os.path.dirname(os.path.dirname(here)) + + tk.add_template_directory(config, 'templates') + tk.add_public_directory(config, 'theme/public') + tk.add_resource('theme/public', 'ckanext-datagovau') + # config['licenses_group_url'] = 'http://%(ckan.site_url)/licenses.json' + + def get_helpers(self): + return {'get_last_active_user': get_last_active_user} + + def is_fallback(self): + # Return True to register this plugin as the default handler for + # package types not handled by any other IDatasetForm plugin. + return True + + def package_types(self): + # This plugin doesn't handle any special package types, it just + # registers itself as the default (above). + return [] + + + def create_package_schema(self): + schema = super(ExampleIDatasetFormPlugin, self).create_package_schema() + schema = self._modify_package_schema(schema) + return schema + + def update_package_schema(self): + schema = super(ExampleIDatasetFormPlugin, self).update_package_schema() + schema = self._modify_package_schema(schema) + return schema + + def show_package_schema(self): + schema = super(ExampleIDatasetFormPlugin, self).show_package_schema() + + # Don't show vocab tags mixed in with normal 'free' tags + # (e.g. on dataset pages, or on the search page) + schema['tags']['__extras'].append(tk.get_converter('free_tags_only')) + + # Add our custom_text field to the dataset schema. + # ignore_missing == optional + # ignore_empty == mandatory but not for viewing + # !!! always convert_from_extras first + schema.update({ + 'agency_program': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_missing')], + 'contact_point': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'spatial_coverage': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'granularity': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'jurisdiction': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'temporal_coverage': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'data_state': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')], + 'update_freq': [tk.get_converter('convert_from_extras'), + tk.get_validator('ignore_empty')] + }) + return schema + + def _modify_package_schema(self, schema): + # Add our custom_test metadata field to the schema, this one will use + # convert_to_extras instead of convert_to_tags. + # ignore_missing == optional + # not_empty == mandatory, enforced here while modifying + + schema.update({ + 'agency_program': [tk.get_validator('ignore_missing'), + tk.get_converter('convert_to_extras')], + 'contact_point': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'spatial_coverage': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'granularity': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'jurisdiction': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'temporal_coverage': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'data_state': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')], + 'update_freq': [tk.get_converter('convert_to_extras'), + tk.get_validator('not_empty')] + }) + return schema + + # These methods just record how many times they're called, for testing + # purposes. + # TODO: It might be better to test that custom templates returned by + # these methods are actually used, not just that the methods get + # called. + + def setup_template_variables(self, context, data_dict): + return super(ExampleIDatasetFormPlugin, self).setup_template_variables( + context, data_dict) + + def new_template(self): + return super(ExampleIDatasetFormPlugin, self).new_template() + + def read_template(self): + return super(ExampleIDatasetFormPlugin, self).read_template() + + def edit_template(self): + return super(ExampleIDatasetFormPlugin, self).edit_template() + + def search_template(self): + return super(ExampleIDatasetFormPlugin, self).search_template() + + def history_template(self): + return super(ExampleIDatasetFormPlugin, self).history_template() + + def package_form(self): + return super(ExampleIDatasetFormPlugin, self).package_form() + + --- /dev/null +++ b/ckanext/datagovau/templates/package/read.html @@ -1,1 +1,167 @@ +{% ckan_extends %} +{% block package_additional_info %} +
+

{{ _('Additional Info') }}

+ + + + + + + + + + + {# Add our custom field to the dataset read page. #} + {% if pkg.get('metadata_created') %} + + + + + {% endif %} + {% if pkg.get('metadata_updated') %} + + + + + {% endif %} + {% if pkg.get('agency_program') %} + + + + + {% endif %} + {% if pkg.get('Agency Program') %} + + + + + {% endif %} + {% if h.get_pkg_dict_extra(pkg,'DCTERMS.Source.URI') %} + + + + + {% endif %} + + {% if pkg.get('contact_point') %} + + + + + {% endif %} + {% if pkg.get('spatial_coverage') %} + + + + + + {% endif %} + {% if h.get_pkg_dict_extra(pkg,'Geospatial Coverage') %} + + + + + + {% endif %} + {% if pkg.get('granularity') %} + + + + + + {% endif %} + {% if h.get_pkg_dict_extra(pkg,'Granularity') %} + + + + + + {% endif %} + {% if pkg.get('jurisdiction') %} + + + + + + {% endif %} + {% if h.get_pkg_dict_extra(pkg,'AGLSTERMS.Jurisdiction') %} + + + + + + {% endif %} + {% if pkg.get('temporal_coverage') %} + + + + + + {% endif %} + {% if h.get_pkg_dict_extra(pkg,'Temporal Coverage') %} + + + + + + {% endif %} + {% if pkg.get('data_state') %} + + + + + + {% endif %} + {% if pkg.get('update_freq') %} + + + + + + {% endif %} + {% if h.get_pkg_dict_extra(pkg,'Update Frequency') %} + + + + + {% endif %} + +{% set email =h.get_last_active_user(c.pkg_dict['id']).get('email','') %} + + + + + + + + + + + + + + + + + + +
{{ _('Field') }}{{ _('Value') }}
Date Published{{ pkg.metadata_created.split("T")[0] }}
Date Updated{{ pkg.metadata_updated.split("T")[0] }}
Agency Program {{ pkg.agency_program }}
Agency Program {{ pkg.get('Agency Program') }}
{{ _('Source') }}{{ h.link_to(h.get_pkg_dict_extra(pkg,'DCTERMS.Source.URI'), + h.get_pkg_dict_extra(pkg,'DCTERMS.Source.URI'), rel='dct:source', target='_blank') }} +
Contact Point {{ h.mail_to(email_address=pkg.contact_point, + name=pkg.contact_point) }}
Geospatial Coverage {{ pkg.spatial_coverage }}
Geospatial Coverage {{ h.get_pkg_dict_extra(pkg,'Geospatial Coverage') }}
Data Granularity {{ pkg.granularity }}
Data Granularity {{ h.get_pkg_dict_extra(pkg,'Granularity') }}
Government Jurisdiction {{ pkg.jurisdiction }}
Government Jurisdiction {{ h.get_pkg_dict_extra(pkg,'AGLSTERMS.Jurisdiction') }}
Temporal Coverage {{ pkg.temporal_coverage }}
Temporal Coverage {{ h.get_pkg_dict_extra(pkg,'Temporal Coverage') }}
Data State {{ pkg.data_state }}
Update Frequency {{ pkg.update_freq }}
Update Frequency {{ h.get_pkg_dict_extra(pkg,'Update Frequency') }}
{{ _('Maintainer') }}{{ + h.mail_to(email_address=(email or ' '), name=h.get_last_active_user(c.pkg_dict['id']).get("display_name",'')) }} +
Publisher/Agency{{ c.pkg_dict['organization']['title']}} +
TypeDataset
LanguageEnglish
+
+ + +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/package/read.n3 @@ -1,1 +1,45 @@ +@prefix : . +@prefix dcat: . +@prefix dct: . +@prefix foaf: . +@prefix owl: . +@prefix rdf: . +<${ h.url_for(controller='package',action='read',id=c.pkg_dict['name'], qualified=True)}> +a dcat:Dataset; + dct:description "${c.pkg_dict['notes']}"; + dct:identifier "${c.pkg_dict['name']}"; + dct:relation [ + rdf:value ""; + :label "change_note" ], + [ + rdf:value ""; + :label "definition_note" ], + [ + rdf:value ""; + :label "editorial_note" ], + [ + rdf:value ""; + :label "example_note" ], + [ + rdf:value ""; + :label "history_note" ], + [ + rdf:value ""; + :label "scope_note" ], + [ + rdf:value ""; + :label "skos_note" ], + [ + rdf:value ""; + :label "temporal_granularity" ], + [ + rdf:value ""; + :label "type_of_dataset" ], + [ + rdf:value ""; + :label "update_frequency" ]; + dct:title "${c.pkg_dict['title']}"; + :label "${c.pkg_dict['name']}"; + = ; + foaf:homepage . --- /dev/null +++ b/ckanext/datagovau/templates/package/read.rdf @@ -1,1 +1,157 @@ + + + + ${c.pkg_dict['name']} + ${c.pkg_dict['title']} + + + Dataset + ${c.pkg_dict['notes']} + ${c.pkg_dict['metadata_created']} + ${c.pkg_dict['metadata_modified']} + en + + + ${c.pkg_dict['license_url']} + + + + ${c.pkg_dict['license_id']} + + + + + ${ tag_dict["name"] } + + + ${ group_dict["title"] } + + + + ${c.pkg_dict['name']} + + + + + + ${rsc_dict.get('name')} + + ${rsc_dict.get('description')} + + ${rsc_dict.get('created')} + ${rsc_dict.get('revision_timestamp')} + ${rsc_dict.get('size')} + ${rsc_dict.get('mimetype')} + ${rsc_dict.get('size')} bytes + + + ${rsc_dict.get('format')} + ${rsc_dict.get('format')} + + + ${rsc_dict.get('name')} + + + + + + ${ c.pkg_dict['organization']['title'] } + + + + + ${ c.pkg_dict['organization']['title'] } + + + + + ${h.get_last_active_user(c.pkg_dict['id'])["display_name"]} + + + + + + ${h.get_pkg_dict_extra(c.pkg_dict,'DCTERMS.Source.URI') } + + + ${c.pkg_dict.contact_point } + ${ c.pkg_dict.spatial_coverage } + ${ h.get_pkg_dict_extra(c.pkg_dict,'Geospatial Coverage') } + ${ c.pkg_dict.jurisdiction } + ${ h.get_pkg_dict_extra(c.pkg_dict,'AGLSTERMS.Jurisdiction') } + ${ c.pkg_dict.get('temporal_coverage') } + ${ h.get_pkg_dict_extra(c.pkg_dict,'Temporal Coverage') } + + + Data State + ${ c.pkg_dict.get('data_state') } + + + + + + Update Frequency + ${ c.pkg_dict.get('update_freq') } + + + + + Update Frequency + ${ h.get_pkg_dict_extra(c.pkg_dict,'Update Frequency') } + + + + + + Agency Program + ${ h.get_pkg_dict_extra(c.pkg_dict,'Agency Program') } + + + + + Agency Program + ${ c.pkg_dict.get('agency_program') } + + + + + + Data Granularity + ${ h.get_pkg_dict_extra(c.pkg_dict,'Granularity') } + + + + + Data Granularity + ${ c.pkg_dict.get('granularity') } + + + + + + + ${extra_dict.get('key','')} + ${extra_dict.get('value','')} + + + + + + --- /dev/null +++ b/ckanext/datagovau/templates/package/read_base.html @@ -1,1 +1,47 @@ +{% ckan_extends %} +{% block links -%} +{{ super() }} + + + +{% endblock -%} + +{% block head_extras -%} +{{ super() }} + + + + + +{% if h.get_pkg_dict_extra(pkg,'DCTERMS.Source.URI') %}{% endif %} + + + + + + + + + + +{% endblock -%} + +{% block package_info %} +
+
+

{{ pkg.title or pkg.name }}

+
+
+
{{ _('Followers') }}
+
{{ h.SI_number_span(h.get_action('dataset_follower_count', {'id': pkg.id})) }}
+
+
+ +
+
+{% endblock %} + + --- /dev/null +++ b/ckanext/datagovau/templates/package/resource_read.html @@ -1,1 +1,36 @@ +{% ckan_extends %} +{% block links -%} +{{ super() }} + + + +{% endblock -%} + +{% block head_extras -%} +{{ super() }} + + + + + +{% if h.get_pkg_dict_extra(pkg,'DCTERMS.Source.URI') %}{% endif %} + + + + + + + + + + + + + + + +{% endblock -%} + + + --- /dev/null +++ b/ckanext/datagovau/templates/package/snippets/package_basic_fields.html @@ -1,1 +1,62 @@ +{% ckan_extends %} +{% block package_basic_fields_org %} + +{{ super() }} + +{{ form.input('agency_program', label=_('Agency Program'), id='field-agency_program', +placeholder=_('Name of the Agency Program that generated the data if relevant'), +value=data.agency_program, error=errors.agency_program, classes=['control-medium']) }} + +{{ form.input('contact_point', label=_('Contact Point'), id='field-contact_point', +placeholder=_('Email address for questions about content of dataset'), +value=data.contact_point, error=errors.contact_point, classes=['control-medium']) }} + +{{ form.input('spatial_coverage', label=_('Geospatial Coverage'), id='field-spatial_coverage', +placeholder=_('The geographical area covered by the data. Eg: Whole of Australia, New South Wales, Canberra'), +value=data.spatial_coverage, error=errors.spatial_coverage, classes=['control-medium']) }} + +{{ form.input('granularity', label=_('Data Granularity'), id='field-granularity', +placeholder=_('Granularity in time, place etc. Eg: incidents reports on daily basis by location.'), +value=data.granularity, error=errors.granularity, classes=['control-medium']) }} + +{{ form.input('jurisdiction', label=_('Government Jurisdiction'), id='field-jurisdiction', +placeholder=_('New South Wales, Glenorchy City Council, Federal'), +value=data.jurisdiction, error=errors.jurisdiction, classes=['control-medium']) }} + +{{ form.input('temporal_coverage', label=_('Temporal Coverage'), id='field-temporal_coverage', +placeholder=_('The timespan the dataset relates to: Current, 2008, 2008-2012, Jan 2012'), +value=data.temporal_coverage, error=errors.temporal_coverage, classes=['control-medium']) }} + +{{ form.select('data_state', label=_('Data State'), options= [{'value': 'active', 'text': 'Active'}, {'value': 'inactive', 'text': 'Inactive'}], +selected='Active', error=errors.data_state) }} + +{{ form.input('update_freq', label=_('Update Frequency'), id='field-update_freq', +placeholder=_('How often the dataset is updated. Eg: Daily, Weekly, Never'), +value=data.update_freq, error=errors.update_freq, classes=['control-medium']) }} + +{% endblock %} + + +{% block package_basic_fields_license %} +
+ {% set error = errors.license_id %} + +
+ + {% if error %}{{ error }}{% endif %} + + + {% trans %} + License definitions and additional information can be found + at opendefinition.org + {% endtrans %} + +
+
+{% endblock %} --- /dev/null +++ b/ckanext/datagovau/templates/package/snippets/package_metadata_fields.html @@ -1,1 +1,42 @@ +{% ckan_extends %} +{# Remove 'free extras' from the package form. If you're using +convert_to/from_extras() as we are with our 'custom_text' field below then +you need to remove free extras from the form, or editing your custom field +won't work. #} +{% block custom_fields %} +{% endblock %} + +{# https://github.com/okfn/ckan/blob/master/ckan/templates/macros/form.html documents the macros for fields #} + +{% block package_metadata_fields %} + + +{{ super() }} + +{% endblock %} + +{% block package_metadata_author %} +{% endblock %} + +{% block package_metadata_fields_maintainer %} +{% endblock %} + +{% block dataset_fields %} +{% if data.groups %} +
+ +
+ {% for group in data.groups %} + + {% endfor %} +
+
+{% endif %} +{% set group_name = 'groups__%s__id' % data.groups|length %} +{% set group_attrs = {'data-module': 'autocomplete', 'data-module-source': '/api/2/util/group/autocomplete?q=?', 'data-module-key': 'id', 'data-module-label': 'title'} %} +{{ form.input(group_name, label=_('Add Group/Theme'), id="field-group", value=data[group_name], classes=['control-medium'], attrs=group_attrs) }} +{% endblock %} --- /dev/null +++ b/ckanext/datagovau/theme/public/licenses.json @@ -1,1 +1,30 @@ +[ + { + "domain_content": true, + "domain_data": false, + "domain_software": false, + "family": "", + "id": "other-open", + "is_generic": true, + "is_okd_compliant": true, + "is_osi_compliant": false, + "maintainer": "", + "status": "active", + "title": "Other (Open)", + "url": "" + }, + { + "domain_content": true, + "domain_data": false, + "domain_software": false, + "family": "", + "id": "cc-by", + "is_okd_compliant": true, + "is_osi_compliant": false, + "maintainer": "", + "status": "active", + "title": "Creative Commons Attribution 3.0 Australia", + "url": "http://creativecommons.org/licenses/by/3.0/au/" + } +] --- a/ckanext/example/__init__.py +++ /dev/null @@ -1,2 +1,1 @@ -# package --- a/ckanext/example/controller.py +++ /dev/null @@ -1,53 +1,1 @@ -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.lib.navl.validators import not_empty - -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 overrides 2 method hooks which the base class uses to create the - validation schema for the creation and editing of a user; to require - that a fullname is given. - """ - - 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 - - --- a/ckanext/example/forms.py +++ /dev/null @@ -1,232 +1,1 @@ -import os, logging -from ckan.authz import Authorizer -from ckan.logic.converters import convert_to_extras,\ - convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only -from ckan.logic import get_action -from ckan.logic.schema import package_form_schema, group_form_schema -from ckan.lib.base import c, model -from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer, IConfigurable -from ckan.plugins import implements, SingletonPlugin -from ckan.lib.navl.validators import ignore_missing, not_empty, keep_extras -log = logging.getLogger(__name__) - -class ExampleGroupForm(SingletonPlugin): - """This plugin demonstrates how a class packaged as a CKAN - extension might extend CKAN behaviour by providing custom forms - based on the type of a Group. - - In this case, we implement two extension interfaces to provide custom - forms for specific types of group. - - - ``IConfigurer`` allows us to override configuration normally - found in the ``ini``-file. Here we use it to specify where the - form templates can be found. - - - ``IGroupForm`` allows us to provide a custom form for a dataset - based on the 'type' that may be set for a group. Where the - 'type' matches one of the values in group_types then this - class will be used. - """ - implements(IGroupForm, inherit=True) - implements(IConfigurer, inherit=True) - - def update_config(self, config): - """ - This IConfigurer implementation causes CKAN to look in the - ```templates``` directory when looking for the group_form() - """ - here = os.path.dirname(__file__) - rootdir = os.path.dirname(os.path.dirname(here)) - template_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', 'templates') - config['extra_template_paths'] = ','.join([template_dir, - config.get('extra_template_paths', '')]) - - def group_form(self): - """ - Returns a string representing the location of the template to be - rendered. e.g. "forms/group_form.html". - """ - return 'forms/group_form.html' - - def group_types(self): - """ - Returns an iterable of group type strings. - - If a request involving a group of one of those types is made, then - this plugin instance will be delegated to. - - There must only be one plugin registered to each group type. Any - attempts to register more than one plugin instance to a given group - type will raise an exception at startup. - """ - return ["testgroup"] - - def is_fallback(self): - """ - Returns true iff this provides the fallback behaviour, when no other - plugin instance matches a group'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 form_to_db_schema(self): - """ - Returns the schema for mapping group data from a form to a format - suitable for the database. - """ - return group_form_schema() - - def db_to_form_schema(self): - """ - Returns the schema for mapping group data from the database into a - format suitable for the form (optional) - """ - return {} - - def check_data_dict(self, data_dict): - """ - Check if the return data is correct. - - raise a DataError if not. - """ - - def setup_template_variables(self, context, data_dict): - """ - Add variables to c just prior to the template being rendered. - """ - - -class ExampleDatasetForm(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 where the - form templates can be found. - - ``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 - type_name matches one of the values in package_types then this - class will be used. - """ - implements(IDatasetForm, inherit=True) - implements(IConfigurer, inherit=True) - implements(IConfigurable) - - def update_config(self, config): - """ - This IConfigurer implementation causes CKAN to look in the - ```templates``` directory when looking for the package_form() - """ - here = os.path.dirname(__file__) - rootdir = os.path.dirname(os.path.dirname(here)) - template_dir = os.path.join(rootdir, 'ckanext', - 'example', 'theme', 'templates') - config['extra_template_paths'] = ','.join([template_dir, - 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): - """ - Returns a string representing the location of the template to be - rendered. e.g. "package/new_package_form.html". - """ - return 'forms/dataset_form.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 True - - 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_dataset_form"] - - def setup_template_variables(self, context, data_dict=None): - """ - Adds variables to c just prior to the template being rendered that can - then be used within the form - """ - c.licences = [('', '')] + model.Package.get_license_options() - c.publishers = [('Example publisher', 'Example publisher 2')] - c.is_sysadmin = Authorizer().is_sysadmin(c.user) - c.resource_columns = model.Resource.get_columns() - c.vocab_tags = get_action('tag_list')(context, {'vocabulary_name': self.vocab_name}) - - ## 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 = package_form_schema() - schema.update({ - 'published_by': [not_empty, unicode, convert_to_extras], - 'vocab_tag_string': [ignore_missing, convert_to_tags(self.vocab_name)], - }) - return schema - - def db_to_form_schema(self): - """ - Returns the schema for mapping package data from the database into a - format suitable for the form (optional) - """ - schema = package_form_schema() - schema.update({ - 'tags': { - '__extras': [keep_extras, free_tags_only] - }, - 'vocab_tag_string': [convert_from_tags(self.vocab_name), ignore_missing], - 'published_by': [convert_from_extras, ignore_missing], - }) - return schema - - def check_data_dict(self, data_dict): - """ - Check if the return data is correct and raises a DataError if not. - """ - return - - --- a/ckanext/example/package_form.py +++ /dev/null @@ -1,40 +1,1 @@ -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([ - (_('Customised 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() - --- a/ckanext/example/plugin.py +++ /dev/null @@ -1,102 +1,1 @@ -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 ExamplePlugin(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', - 'example', 'theme', 'public') - template_dir = os.path.join(rootdir, 'ckanext', - 'example', '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', '')]) - # add in the extra.css - config['ckan.template_head_end'] = config.get('ckan.template_head_end', '') +\ - ' ' - # set the title - config['ckan.site_title'] = "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"]/text()')\ - .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``. - """ - # Hook in our custom user controller at the points of creation - # and edition. - map.connect('/user/register', - controller='ckanext.example.controller:CustomUserController', - action='register') - map.connect('/user/edit', - controller='ckanext.example.controller:CustomUserController', - action='edit') - map.connect('/user/edit/{id:.*}', - controller='ckanext.example.controller:CustomUserController', - action='edit') - - map.connect('/package/new', controller='package_formalchemy', action='new') - map.connect('/package/edit/{id}', controller='package_formalchemy', action='edit') - return map - --- a/ckanext/example/theme/public/css/extra.css +++ /dev/null @@ -1,5 +1,1 @@ -body { - background-color: pink; -} - --- a/ckanext/example/theme/templates/forms/dataset_form.html +++ /dev/null @@ -1,251 +1,1 @@ -
- -
-

Errors in form

-

The form contains invalid entries:

-
    -
  • ${"%s: %s" % (key, error)} - -
      - -
    • - Resource ${idx}: -
        -
      • ${thiskey}: ${errorinfo};
        • -
      -
      • -       -
    -     -
    • -
-
- -
-
-
-
- -
-
${errors.get('title', '')}
- -
-
- ${url(controller='package', action='index')+'/'}  - -

 

-
- -
${errors.get('name', '')}
- -
-
-
The URL for the web page describing the data (not the data itself).
-
e.g. http://www.example.com/growth-figures.html
-
${errors.get('url', '')}
- -
-
- -
-
The licence under which the dataset is released.
- -
-
-
    -
    • -
    • -
- - - You can use Markdown formatting here. - -
-
-
- -
-

Resources: the files and APIs associated with this dataset

- - - - - - - - - -
Resource
- - -
-
    -

  • Add a resource:

    • -
    • -
    • - -
-
-
- -
-

Groups

-
- - - -
- - -
-
- - -
Group
-
- -
-
Cannot add any groups.
-
-

Tags

-
-
-
- -
-
Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see this wiki page.
-
e.g. pollution, rivers, water quality
-
${errors.get('tag_string', '')}
-
-

Tags with Vocabulary

-
-
-
- -
-
Similar to standard CKAN tags, but these use a fixed vocabulary.
-
${errors.get('vocab_tag_string', '')}
-
-
-
-
-
-
-
The name of the main contact, for enquiries about this particular dataset, using the e-mail address in the following field.
- -
-
- -
-
-
If there is another important contact person (in addition to the person in the Author field) then provide details here.
- -
-
- -
-
-
A number representing the version (if applicable)
-
e.g. 1.2.0
- -
-
- -
- -
-
- -
-
-
-
- -
-
The organisation credited with or associated with the publication of this data.
- - - -
-
- - - Delete -
- - - -
-
- - with value - -
- - -
-
- - - - - -
- -

- Since you have not signed in this will just be your IP address. - Click here to sign in before saving (opens in new window). -

-
- -
- - - - -

- Important: By submitting content, you agree to release your contributions under the Open Database License. Please refrain from editing this page if you are not happy to do this. -

-
-
- -
- --- a/ckanext/example/theme/templates/forms/group_form.html +++ /dev/null @@ -1,102 +1,1 @@ -
-
-

Errors in form

-

The form contains invalid entries:

-
    -
  • ${"%s: %s" % (key, error)}
    • -
-
- -
-
-
-
- -
-
- ${g.site_url+h.url_for(controller='group', action='index')+'/'}  - -

 

-
- -
${errors.get('name', '')}
- -
-
-
    -
    • -
    • -
- - - You can use Markdown formatting here. -
- - -
-
- -
-
-
- -
-

Extras

-
- - -
-
- - - Delete -
- - - -
-
- - with value - -
- - -
-
- -
-

Datasets

-
- -
-
- -
- -
-

There are no datasets currently in this group.

- -

Add datasets

-
-
-
-
-
- -
- - - - -
-
- --- a/ckanext/example/theme/templates/home/index.html +++ /dev/null @@ -1,30 +1,1 @@ - - Home - - - - - -
-

Welcome to Example Theme!

-

- This page left intentionally ugly -

-

- Here is the frob -

- ${select("*")} -
- - - - --- a/ckanext/example/theme/templates/layout.html +++ /dev/null @@ -1,31 +1,1 @@ - - - -
- ${h.nav_link(c, _('Home'), controller='home', action='index')} - ${h.nav_link(c, _('Data'), controller='package', action='index')} - ${h.nav_link(c, _('New dataset'), controller='package', action='new')} - ${h.nav_link(c, _('New group'), controller='group', action='new')} -
- - - - -
-
- - -
-
- - - - - --- a/ckanext/example/theme/templates/user/register.html +++ /dev/null @@ -1,50 +1,1 @@ -
-
-

Errors in form

-

The form contains invalid entries:

-
    -
  • ${"%s: %s" % (key, error)}
    • -
-
- -
-
-
-
3+ chars, using only 'a-z0-9' and '-_'
-
${errors.get('name', '')}
- -
-
-
${errors.get('fullname', '')}
- -
-
- -
-
-
${errors.get('password1', '')}
- -
-
- -
- - -
- -
- -
- --- a/rename.sh +++ /dev/null @@ -1,14 +1,1 @@ -if [ $# -ne 1 ]; then - echo "Usage: `basename $0` {NewExtensionName}" - exit 65 -fi -NEWNAME=$1 -NEWNAME_LOWER="`echo $NEWNAME | awk '{print tolower($0)}'`" -echo $NEWNAME_LOWER -mv ckanext/example ckanext/$NEWNAME_LOWER -grep -rl Example * | grep -v `basename $0` | xargs perl -pi -e "s/Example/$NEWNAME/g" -grep -rl example * | grep -v `basename $0` | xargs perl -pi -e "s/example/$NEWNAME_LOWER/g" -cd .. -mv ckanext-example ckanext-$NEWNAME_LOWER - --- a/setup.py +++ b/setup.py @@ -1,34 +1,27 @@ from setuptools import setup, find_packages -version = '0.2' +version = '0.1' setup( - name='ckanext-example', + name='ckanext-datagovau', version=version, - description='Example extension for customising CKAN', + description='Extension for customising CKAN for data.gov.au', long_description='', classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers keywords='', - author='Seb Bacon', - author_email='seb.bacon@gmail.com', + author='Alex Sadleir', + author_email='alex.sadleir@linkdigital.com.au', url='', license='', packages=find_packages(exclude=['ez_setup', 'examples', 'tests']), - namespace_packages=['ckanext', 'ckanext.example'], + namespace_packages=['ckanext', 'ckanext.datagovau'], include_package_data=True, zip_safe=False, - install_requires=[ - # -*- Extra requirements: -*- - ], + install_requires=[], entry_points=\ """ [ckan.plugins] - example=ckanext.example.plugin:ExamplePlugin - example_datasetform=ckanext.example.forms:ExampleDatasetForm - example_groupform=ckanext.example.forms:ExampleGroupForm - - [ckan.forms] - example_form = ckanext.example.package_form:get_example_fieldset + datagovau=ckanext.datagovau.plugin:ExampleIDatasetFormPlugin """, )