From: Alex Sadleir Date: Tue, 24 Sep 2013 01:55:38 +0000 Subject: Remove old extras, include more RDFa markup for distributions/data resources X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=3a8739b638721780a451fbb63ed6c3be38bfa2ec --- Remove old extras, include more RDFa markup for distributions/data resources --- --- /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,8 @@ + + + + + + + --- /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,881 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + localhost + 5050 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + No facets are configured + + + + + + + + + + + + + + + + + + + + + + ckanext-datagovau + + + + + + + + + + + + + + + + + + + + + + + --- a/README.rst +++ b/README.rst @@ -1,80 +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. -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 - -Example Tags With Vocabularies -============================== - -To add example tag vocabulary data to the database, from the ckanext-example directory run: - -:: - - paster example create-example-vocabs -c - -This data can be removed with - -:: - - paster example clean -c +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`` + --- /dev/null +++ b/admin/data.gov.au @@ -1,1 +1,96 @@ + + ServerAdmin webmaster@localhost + ServerName data.gov.au + ServerAlias www.data.gov.au, opendata.linkdigital.com.au + + + #allow access to local static content eg. logos + Alias /index.html /var/www/index.html + Alias /logos /var/www/logos + Alias /tools /var/www/tools.shtml + Alias /opendata /var/www/opendata.shtml + Alias /opengov /var/www/opengov.shtml + + DocumentRoot /var/www + + + ExpiresActive On + ExpiresDefault "access plus 1 week" + + + + + Options FollowSymLinks + AllowOverride None + + + + Options -Indexes -FollowSymLinks -MultiViews +Includes + AllowOverride None + + Order allow,deny + allow from all + + AddType text/html .shtml + AddOutputFilter INCLUDES .shtml + + + ErrorLog ${APACHE_LOG_DIR}/error.log + + # Possible values include: debug, info, notice, warn, error, crit, alert, emerg. + LogLevel warn + + CustomLog ${APACHE_LOG_DIR}/access.log varnishcombined + RewriteEngine On + + RewriteMap lc int:tolower + +# RewriteRule ^/apps/antenna-mate/?$ http://antennamate.com/ [PT] +# RewriteRule ^/apps/postcode-finder/?$ http://www.aus-emaps.com/postcode_finder.php [PT] +# RewriteRule ^/apps/the-australian-cost-of-living-heatmap/?$ http://www.creditcardcompare.com.au/tools/cost-of-living-heatmap/ [PT] + RewriteRule ^/catalogues/?$ /organization [PT] + RewriteRule ^/dataset/“cycling-in-new-south-wales-what-the-data-tells-us”-and-related-data/? /dataset/2809cycling-in-new-south-wales-what-the-data-tells-us2809-and-related-data [PT] + RewriteRule ^/dataset/apvma-pubcris-dataset-for-registered-agricultural-and-veterinary-chemical-products-and-approved-actives/? /dataset/apvma-pubcris-dataset-for-registered-agricultural-and-veterinary-chemical-products-and-approved-acti [PT] + RewriteRule ^/dataset_category/business/?$ /group/business [PT] + RewriteRule ^/dataset_category/community/?$ /group/community [PT] + RewriteRule ^/dataset_category/geography/?$ /group/geography [PT] + RewriteRule ^/dataset_category/government/?$ /group/government [PT] + RewriteRule ^/dataset_category/health/?$ /group/health [PT] + RewriteRule ^/dataset_category/?$ /group [PT] + RewriteRule ^/feed/?$ /feeds/dataset.atom [PT] + RewriteRule ^/jurisdiction/australian-capital-territory/?$ /dataset?q=act [PT] + RewriteRule ^/jurisdiction/new-south-wales/?$ /dataset?q=new+south+wales [PT] + RewriteRule ^/jurisdiction/queensland/?$ /dataset?q=queensland [PT] + RewriteRule ^/jurisdiction/south-australia/?$ /dataset?q=south+australia [PT] + RewriteRule ^/jurisdiction/victoria/?$ /dataset?q=victoria [PT] + RewriteRule ^/jurisdiction/western-australia/?$ /dataset?q=western+australia [PT] + RewriteRule ^/jurisdiction/?$ /dataset [PT] + +# RewriteCond %{QUERY_STRING} ^category=([a-z]+) +# RewriteRule ^/data/?$ /group/${lc:%1}? [PT] + +# RewriteCond %{QUERY_STRING} ^format=Shapefile +# RewriteRule ^/data/?$ /dataset?res_format=shp [PT] + + RewriteRule ^/data/?$ /dataset? [PT] + + RewriteCond %{QUERY_STRING} ^s=(.*) + RewriteRule ^/ /dataset?q=%1 [PT] + + + FilterDeclare OPENDATA + FilterProvider OPENDATA SUBSTITUTE resp=Content-Type $text/ + FilterProvider OPENDATA SUBSTITUTE resp=Content-Type $/javascript + FilterProvider OPENDATA SUBSTITUTE resp=Content-Type $/json + FilterProvider OPENDATA SUBSTITUTE resp=Content-Type $/xml + FilterChain OPENDATA + Substitute "s#//opendata.linkdigital.com.au#//data.gov.au#" + + WSGIScriptAlias / /var/lib/ckan/dga/pyenv/bin/dga.py + WSGIPassAuthorization On + + ErrorLog /var/log/apache2/ckandga.error.log + CustomLog /var/log/apache2/ckandga.custom.log combined + + --- /dev/null +++ b/admin/default.vcl @@ -1,1 +1,164 @@ +# This is a basic VCL configuration file for varnish. See the vcl(7) +# man page for details on VCL syntax and semantics. +# +# Default backend definition. Set this to point to your content +# server. +# +backend default { + .host = "127.0.0.1"; + .port = "8080"; +} +sub vcl_fetch { + set beresp.grace = 1h; + + if (beresp.http.content-type ~ "(text|application)") { + set beresp.do_gzip = true; + } + if (req.url ~ "\.(png|gif|jpg|jpeg|swf|css|js|woff|eot)$") { + unset beresp.http.set-cookie; + } +} +sub vcl_recv { + if (req.url ~ "^/_tracking") { + return (pass); + } + if (req.url ~ "\.(png|gif|jpg|jpeg|swf|css|js|woff|eot)$") { + return(lookup); + } + if (req.http.Cookie) { + set req.http.Cookie = regsuball(req.http.Cookie, "(^|; ) *__utm.=[^;]+;? *", "\1"); # removes all cookies named __utm? (utma, utmb...) - tracking thing + + if (req.http.Cookie == "") { + remove req.http.Cookie; + } + } +} +sub vcl_deliver { + if (!resp.http.Vary) { + set resp.http.Vary = "Accept-Encoding"; + } else if (resp.http.Vary !~ "(?i)Accept-Encoding") { + set resp.http.Vary = resp.http.Vary + ",Accept-Encoding"; + } + if (obj.hits > 0) { + set resp.http.X-Cache = "HIT"; + } else { + set resp.http.X-Cache = "MISS"; + } +} + +# +# Below is a commented-out copy of the default VCL logic. If you +# redefine any of these subroutines, the built-in logic will be +# appended to your code. +# sub vcl_recv { +# if (req.restarts == 0) { +# if (req.http.x-forwarded-for) { +# set req.http.X-Forwarded-For = +# req.http.X-Forwarded-For + ", " + client.ip; +# } else { +# set req.http.X-Forwarded-For = client.ip; +# } +# } +# if (req.request != "GET" && +# req.request != "HEAD" && +# req.request != "PUT" && +# req.request != "POST" && +# req.request != "TRACE" && +# req.request != "OPTIONS" && +# req.request != "DELETE") { +# /* Non-RFC2616 or CONNECT which is weird. */ +# return (pipe); +# } +# if (req.request != "GET" && req.request != "HEAD") { +# /* We only deal with GET and HEAD by default */ +# return (pass); +# } +# if (req.http.Authorization || req.http.Cookie) { +# /* Not cacheable by default */ +# return (pass); +# } +# return (lookup); +# } +# +# sub vcl_pipe { +# # Note that only the first request to the backend will have +# # X-Forwarded-For set. If you use X-Forwarded-For and want to +# # have it set for all requests, make sure to have: +# # set bereq.http.connection = "close"; +# # here. It is not set by default as it might break some broken web +# # applications, like IIS with NTLM authentication. +# return (pipe); +# } +# +# sub vcl_pass { +# return (pass); +# } +# +# sub vcl_hash { +# hash_data(req.url); +# if (req.http.host) { +# hash_data(req.http.host); +# } else { +# hash_data(server.ip); +# } +# return (hash); +# } +# +# sub vcl_hit { +# return (deliver); +# } +# +# sub vcl_miss { +# return (fetch); +# } +# +# sub vcl_fetch { +# if (beresp.ttl <= 0s || +# beresp.http.Set-Cookie || +# beresp.http.Vary == "*") { +# /* +# * Mark as "Hit-For-Pass" for the next 2 minutes +# */ +# set beresp.ttl = 120 s; +# return (hit_for_pass); +# } +# return (deliver); +# } +# +# sub vcl_deliver { +# return (deliver); +# } +# +# sub vcl_error { +# set obj.http.Content-Type = "text/html; charset=utf-8"; +# set obj.http.Retry-After = "5"; +# synthetic {" +# +# +# +# +# "} + obj.status + " " + obj.response + {" +# +# +#

Error "} + obj.status + " " + obj.response + {"

+#

"} + obj.response + {"

+#

Guru Meditation:

+#

XID: "} + req.xid + {"

+#
+#

Varnish cache server

+# +# +# "}; +# return (deliver); +# } +# +# sub vcl_init { +# return (ok); +# } +# +# sub vcl_fini { +# return (ok); +# } + --- /dev/null +++ b/admin/deflate.conf @@ -1,1 +1,12 @@ + + AddOutputFilterByType DEFLATE text/html application/xhtml+xml text/plain text/xml text/css application/json text/javascript application/javascript application/x-javascript + BrowserMatch ^Mozilla/4 gzip-only-text/html + BrowserMatch ^Mozilla/4\.0[678] no-gzip + BrowserMatch \bMSIE !no-gzip !gzip-only-text/htm + # Don't compress images + SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary + + # DeflateCompressionLevel 9 + + --- /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,169 @@ +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 +from pylons import config + +#parse the activity feed for last active non-system user +def get_last_active_user(id): + system_user = lib.helpers.get_action('user_show',{'id': config.get('ckan.site_id', 'ckan_site_user')}) + user_list = [x for x in lib.helpers.get_action('package_activity_list',{'id':id}) if x['user_id'] != system_user['id']] + user = None + if len(user_list) > 0: + user = user_list[0].get('user_id', None) + if user is None: + return system_user + else: + return lib.helpers.get_action('user_show',{'id':user}) + +# get user created datasets and those they have edited +def get_user_datasets(user_dict): + created_datasets_list = user_dict['datasets'] + active_datasets_list = [x['data']['package'] for x in + lib.helpers.get_action('user_activity_list',{'id':user_dict['id']}) if x['data'].get('package')] + return created_datasets_list + active_datasets_list + + +class DataGovAuPlugin(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) + plugins.implements(plugins.IAuthFunctions) + + def datastore_search(context, data_dict): + return {'success': True} # allow all + + def get_auth_functions(self): + return {'datastore_search': datastore_search} + + + 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, 'get_user_datasets': get_user_datasets} + + 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,130 @@ +{% ckan_extends %} +{% block primary_content_inner %} +{{ super() }} +
+ {{ h.disqus_comments() }} +
+{% endblock %} +{% 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('url') %} + + + + + {% endif %} + + {% if pkg.get('contact_point') %} + + + + + {% endif %} + {% if pkg.get('spatial_coverage') %} + + + + + + {% endif %} + {% if pkg.get('granularity') %} + + + + + + {% endif %} + {% if pkg.get('jurisdiction') %} + + + + + {% endif %} + {% if pkg.get('temporal_coverage') %} + + + + + {% endif %} + {% if pkg.get('data_state') %} + + + + + {% endif %} + {% if pkg.get('update_freq') %} + + + + + + {% 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 }}
{{ _('Source') }}{{ h.link_to(pkg.get('url'), + pkg.get('url'), rel='dct:source', target='_blank') }} +
Contact Point {{ h.mail_to(email_address=pkg.contact_point, + name=pkg.contact_point) }}
Geospatial Coverage {{ pkg.spatial_coverage }}
Data Granularity {{ pkg.granularity }}
Government Jurisdiction {{ pkg.jurisdiction }}
Temporal Coverage {{ pkg.temporal_coverage }}
Data State {{ pkg.data_state }}
Update Frequency {{ pkg.update_freq }}
{{ _('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,130 @@ + + + + ${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"]} + + + + + + ${c.pkg_dict.get('url')} + ${c.pkg_dict.contact_point } + ${ c.pkg_dict.spatial_coverage } + ${ c.pkg_dict.jurisdiction } + ${ c.pkg_dict.get('temporal_coverage') } + + + Data State + ${ c.pkg_dict.get('data_state') } + + + + + Update Frequency + ${ c.pkg_dict.get('update_freq') } + + + + + Agency Program + ${ c.pkg_dict.get('agency_program') } + + + + + 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() }} + + + + + + + + + + + + + + + + +{% 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,35 @@ +{% ckan_extends %} +{% block links -%} +{{ super() }} + + + +{% endblock -%} + +{% block head_extras -%} +{{ super() }} + + + + + +{% endif %} + + + + + + + + + + + + + + +{% endblock -%} + + + --- /dev/null +++ b/ckanext/datagovau/templates/package/snippets/package_basic_fields.html @@ -1,1 +1,63 @@ +{% 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,43 @@ +{% 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 %} +{{ form.input('url', label=_('Source URL'), id='field-url', +placeholder=_('URL where dataset came from or more information can be obtained'), +value=data.url, error=errors.url, classes=['control-medium']) }} +{{ 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/templates/package/snippets/resource_item.html @@ -1,1 +1,54 @@ +{% ckan_extends %} +{% set url = h.url_for(controller='package', action='resource_read', id=pkg.name, resource_id=res.id) %} +
  • + {% block resource_item_title %} + + {{ h.resource_display_name(res) | truncate(50) }}{{ res.format }} + {{ h.popular('views', res.tracking_summary.total, min=10) }} + + {% endblock %} +

    + {% if res.description %} + {{ h.markdown_extract(res.description, extract_length=80) }} + {% else %} + {{ _('No description for this resource') }} + {% endif %} +

    + {% block resource_item_explore %} +
    + + + {{ _('Explore') }} + + + +
    + {% endblock %} +
    • --- /dev/null +++ b/ckanext/datagovau/templates/user/dashboard_datasets.html @@ -1,1 +1,16 @@ +{% ckan_extends %} +{% block primary_content_inner %} +

    {{ _('My Datasets') }}

    + {% if h.get_user_datasets(c.user_dict) %} + {% snippet 'snippets/package_list.html', packages=h.get_user_datasets(c.user_dict) %} + {% else %} +

    + You haven\'t created/edited any datasets. + {% if h.check_access('package_create') %} + {% link_for _('Create one now?'), controller='package', action='new' %} + {% endif %} +

    + {% endif %} +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/user/read.html @@ -1,1 +1,29 @@ +{% ckan_extends %} + +{% block primary_content_inner %} +

    + {% block page_heading %}{{ _('Datasets') }}{% endblock %} +

    + {% block package_list %} + {% if h.get_user_datasets(c.user_dict) %} + {% snippet 'snippets/package_list.html', packages=h.get_user_datasets(c.user_dict) %} + {% else %} + + {% if c.is_myself %} +

    + {{ _('You haven\'t created any datasets.') }} + {% if h.check_access('package_create') %} + {% link_for _('Create one now?'), controller='package', action='new' %} + {% endif %} +

    + {% else %} +

    + {{ _('User hasn\'t created any datasets.') }} +

    + {% endif %} + {% endif %} + {% endblock %} +{% 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/commands.py +++ /dev/null @@ -1,83 +1,1 @@ -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-vocabs -c - - paster example clean -c - - 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-vocabs': - self.create_example_vocabs() - if cmd == 'clean': - self.clean() - else: - log.error('Command "%s" not recognized' % (cmd,)) - - def create_example_vocabs(self): - ''' - Adds example vocabularies to the database if they don't already exist. - ''' - user = get_action('get_site_user')({'model': model, 'ignore_auth': True}, {}) - context = {'model': model, 'session': model.Session, 'user': user['name']} - - try: - data = {'id': forms.GENRE_VOCAB} - get_action('vocabulary_show')(context, data) - log.info("Example genre vocabulary already exists, skipping.") - except NotFound: - log.info("Creating vocab %s" % forms.GENRE_VOCAB) - data = {'name': forms.GENRE_VOCAB} - vocab = get_action('vocabulary_create')(context, data) - log.info("Adding tag %s to vocab %s" % ('jazz', forms.GENRE_VOCAB)) - data = {'name': 'jazz', 'vocabulary_id': vocab['id']} - get_action('tag_create')(context, data) - log.info("Adding tag %s to vocab %s" % ('soul', forms.GENRE_VOCAB)) - data = {'name': 'soul', 'vocabulary_id': vocab['id']} - get_action('tag_create')(context, data) - - try: - data = {'id': forms.COMPOSER_VOCAB} - get_action('vocabulary_show')(context, data) - log.info("Example composer vocabulary already exists, skipping.") - except NotFound: - log.info("Creating vocab %s" % forms.COMPOSER_VOCAB) - data = {'name': forms.COMPOSER_VOCAB} - vocab = get_action('vocabulary_create')(context, data) - log.info("Adding tag %s to vocab %s" % ('Bob Mintzer', forms.COMPOSER_VOCAB)) - data = {'name': 'Bob Mintzer', 'vocabulary_id': vocab['id']} - get_action('tag_create')(context, data) - log.info("Adding tag %s to vocab %s" % ('Steve Lewis', forms.COMPOSER_VOCAB)) - data = {'name': 'Steve Lewis', 'vocabulary_id': vocab['id']} - get_action('tag_create')(context, data) - - def clean(self): - log.error("Clean command not yet implemented") - --- 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,264 +1,1 @@ -import os -import logging -from pylons import tmpl_context as c -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, NotFound -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 -from ckan.plugins import IGenshiStreamFilter -from ckan.plugins import implements, SingletonPlugin -from ckan.lib.navl.validators import ignore_missing, keep_extras -log = logging.getLogger(__name__) - -GENRE_VOCAB = u'genre_vocab' -COMPOSER_VOCAB = u'composer_vocab' - - -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(IGenshiStreamFilter, inherit=True) - - 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 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() - try: - 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: - c.vocab_tags = None - c.composer_tags = None - - ## 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': [ignore_missing, unicode, convert_to_extras], - 'genre_tags': [ignore_missing, convert_to_tags(GENRE_VOCAB)], - 'composer_tags': [ignore_missing, convert_to_tags(COMPOSER_VOCAB)] - }) - 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] - }, - '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], - }) - return schema - - def check_data_dict(self, data_dict): - """ - Check if the return data is correct and raises a DataError if not. - """ - 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 = '
  • ' - if vocab['name'] == GENRE_VOCAB: - html = html + '

    Musical Genre

    ' - elif vocab['name'] == COMPOSER_VOCAB: - html = html + '

    Composer

    ' - html = html + '
      ' - for tag in vocab_tags: - html = html + '
    • %s
      • ' % tag['name'] - html = html + "
    • " - stream = stream | Transformer( - "//div[@id='sidebar']//ul[@class='widget-list']" - ).append(HTML(html)) - return stream - --- 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,121 +1,1 @@ -import os -from logging import getLogger -from pylons import request -from genshi.input import HTML -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). - - It also adds the chosen JQuery plugin to the page if viewing the - dataset edit page (provides a better UX for working with tags with vocabularies) - """ - stream = stream | Transformer('//p[@id="examplething"]/text()')\ - .substitute(r'frob', r'foobar') - - routes = request.environ.get('pylons.routes_dict') - if routes.get('controller') == 'package' \ - and routes.get('action') == 'edit': - stream = stream | Transformer('head').append(HTML( - '' - )) - stream = stream | Transformer('body').append(HTML( - ''' - ' - - ''' - )) - - 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/chosen.css +++ /dev/null @@ -1,390 +1,1 @@ -/* @group Base */ -.chzn-container { - font-size: 13px; - position: relative; - display: inline-block; - zoom: 1; - *display: inline; -} -.chzn-container .chzn-drop { - background: #fff; - border: 1px solid #aaa; - border-top: 0; - position: absolute; - top: 29px; - left: 0; - -webkit-box-shadow: 0 4px 5px rgba(0,0,0,.15); - -moz-box-shadow : 0 4px 5px rgba(0,0,0,.15); - -o-box-shadow : 0 4px 5px rgba(0,0,0,.15); - box-shadow : 0 4px 5px rgba(0,0,0,.15); - z-index: 999; -} -/* @end */ -/* @group Single Chosen */ -.chzn-container-single .chzn-single { - background-color: #ffffff; - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#ffffff', endColorstr='#eeeeee', GradientType=0 ); - background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #ffffff), color-stop(50%, #f6f6f6), color-stop(52%, #eeeeee), color-stop(100%, #f4f4f4)); - background-image: -webkit-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%); - background-image: -moz-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%); - background-image: -o-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%); - background-image: -ms-linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%); - background-image: linear-gradient(top, #ffffff 20%, #f6f6f6 50%, #eeeeee 52%, #f4f4f4 100%); - -webkit-border-radius: 5px; - -moz-border-radius : 5px; - border-radius : 5px; - -moz-background-clip : padding; - -webkit-background-clip: padding-box; - background-clip : padding-box; - border: 1px solid #aaaaaa; - -webkit-box-shadow: 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1); - -moz-box-shadow : 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1); - box-shadow : 0 0 3px #ffffff inset, 0 1px 1px rgba(0,0,0,0.1); - display: block; - overflow: hidden; - white-space: nowrap; - position: relative; - height: 23px; - line-height: 24px; - padding: 0 0 0 8px; - color: #444444; - text-decoration: none; -} -.chzn-container-single .chzn-single span { - margin-right: 26px; - display: block; - overflow: hidden; - white-space: nowrap; - -o-text-overflow: ellipsis; - -ms-text-overflow: ellipsis; - text-overflow: ellipsis; -} -.chzn-container-single .chzn-single abbr { - display: block; - position: absolute; - right: 26px; - top: 6px; - width: 12px; - height: 13px; - font-size: 1px; - background: url(chosen-sprite.png) right top no-repeat; -} -.chzn-container-single .chzn-single abbr:hover { - background-position: right -11px; -} -.chzn-container-single .chzn-single div { - position: absolute; - right: 0; - top: 0; - display: block; - height: 100%; - width: 18px; -} -.chzn-container-single .chzn-single div b { - background: url('chosen-sprite.png') no-repeat 0 0; - display: block; - width: 100%; - height: 100%; -} -.chzn-container-single .chzn-search { - padding: 3px 4px; - position: relative; - margin: 0; - white-space: nowrap; - z-index: 1010; -} -.chzn-container-single .chzn-search input { - background: #fff url('chosen-sprite.png') no-repeat 100% -22px; - background: url('chosen-sprite.png') no-repeat 100% -22px, -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff)); - background: url('chosen-sprite.png') no-repeat 100% -22px, -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background: url('chosen-sprite.png') no-repeat 100% -22px, -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background: url('chosen-sprite.png') no-repeat 100% -22px, -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background: url('chosen-sprite.png') no-repeat 100% -22px, -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background: url('chosen-sprite.png') no-repeat 100% -22px, linear-gradient(top, #eeeeee 1%, #ffffff 15%); - margin: 1px 0; - padding: 4px 20px 4px 5px; - outline: 0; - border: 1px solid #aaa; - font-family: sans-serif; - font-size: 1em; -} -.chzn-container-single .chzn-drop { - -webkit-border-radius: 0 0 4px 4px; - -moz-border-radius : 0 0 4px 4px; - border-radius : 0 0 4px 4px; - -moz-background-clip : padding; - -webkit-background-clip: padding-box; - background-clip : padding-box; -} -/* @end */ - -.chzn-container-single-nosearch .chzn-search input { - position: absolute; - left: -9000px; -} - -/* @group Multi Chosen */ -.chzn-container-multi .chzn-choices { - background-color: #fff; - background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff)); - background-image: -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background-image: -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background-image: -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background-image: -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background-image: linear-gradient(top, #eeeeee 1%, #ffffff 15%); - border: 1px solid #aaa; - margin: 0; - padding: 0; - cursor: text; - overflow: hidden; - height: auto !important; - height: 1%; - position: relative; -} -.chzn-container-multi .chzn-choices li { - float: left; - list-style: none; -} -.chzn-container-multi .chzn-choices .search-field { - white-space: nowrap; - margin: 0; - padding: 0; -} -.chzn-container-multi .chzn-choices .search-field input { - color: #666; - background: transparent !important; - border: 0 !important; - font-family: sans-serif; - font-size: 100%; - height: 15px; - padding: 5px; - margin: 1px 0; - outline: 0; - -webkit-box-shadow: none; - -moz-box-shadow : none; - -o-box-shadow : none; - box-shadow : none; -} -.chzn-container-multi .chzn-choices .search-field .default { - color: #999; -} -.chzn-container-multi .chzn-choices .search-choice { - -webkit-border-radius: 3px; - -moz-border-radius : 3px; - border-radius : 3px; - -moz-background-clip : padding; - -webkit-background-clip: padding-box; - background-clip : padding-box; - background-color: #e4e4e4; - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f4f4f4', endColorstr='#eeeeee', GradientType=0 ); - background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #f4f4f4), color-stop(50%, #f0f0f0), color-stop(52%, #e8e8e8), color-stop(100%, #eeeeee)); - background-image: -webkit-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%); - background-image: -moz-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%); - background-image: -o-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%); - background-image: -ms-linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%); - background-image: linear-gradient(top, #f4f4f4 20%, #f0f0f0 50%, #e8e8e8 52%, #eeeeee 100%); - -webkit-box-shadow: 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05); - -moz-box-shadow : 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05); - box-shadow : 0 0 2px #ffffff inset, 0 1px 0 rgba(0,0,0,0.05); - color: #333; - border: 1px solid #aaaaaa; - line-height: 13px; - padding: 3px 20px 3px 5px; - margin: 3px 0 3px 5px; - position: relative; - cursor: default; -} -.chzn-container-multi .chzn-choices .search-choice-focus { - background: #d4d4d4; -} -.chzn-container-multi .chzn-choices .search-choice .search-choice-close { - display: block; - position: absolute; - right: 3px; - top: 4px; - width: 12px; - height: 13px; - font-size: 1px; - background: url(chosen-sprite.png) right top no-repeat; -} -.chzn-container-multi .chzn-choices .search-choice .search-choice-close:hover { - background-position: right -11px; -} -.chzn-container-multi .chzn-choices .search-choice-focus .search-choice-close { - background-position: right -11px; -} -/* @end */ - -/* @group Results */ -.chzn-container .chzn-results { - margin: 0 4px 4px 0; - max-height: 240px; - padding: 0 0 0 4px; - position: relative; - overflow-x: hidden; - overflow-y: auto; -} -.chzn-container-multi .chzn-results { - margin: -1px 0 0; - padding: 0; -} -.chzn-container .chzn-results li { - display: none; - line-height: 15px; - padding: 5px 6px; - margin: 0; - list-style: none; -} -.chzn-container .chzn-results .active-result { - cursor: pointer; - display: list-item; -} -.chzn-container .chzn-results .highlighted { - background-color: #3875d7; - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#3875d7', endColorstr='#2a62bc', GradientType=0 ); - background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #3875d7), color-stop(90%, #2a62bc)); - background-image: -webkit-linear-gradient(top, #3875d7 20%, #2a62bc 90%); - background-image: -moz-linear-gradient(top, #3875d7 20%, #2a62bc 90%); - background-image: -o-linear-gradient(top, #3875d7 20%, #2a62bc 90%); - background-image: -ms-linear-gradient(top, #3875d7 20%, #2a62bc 90%); - background-image: linear-gradient(top, #3875d7 20%, #2a62bc 90%); - color: #fff; -} -.chzn-container .chzn-results li em { - background: #feffde; - font-style: normal; -} -.chzn-container .chzn-results .highlighted em { - background: transparent; -} -.chzn-container .chzn-results .no-results { - background: #f4f4f4; - display: list-item; -} -.chzn-container .chzn-results .group-result { - cursor: default; - color: #999; - font-weight: bold; -} -.chzn-container .chzn-results .group-option { - padding-left: 15px; -} -.chzn-container-multi .chzn-drop .result-selected { - display: none; -} -.chzn-container .chzn-results-scroll { - background: white; - margin: 0 4px; - position: absolute; - text-align: center; - width: 321px; /* This should by dynamic with js */ - z-index: 1; -} -.chzn-container .chzn-results-scroll span { - display: inline-block; - height: 17px; - text-indent: -5000px; - width: 9px; -} -.chzn-container .chzn-results-scroll-down { - bottom: 0; -} -.chzn-container .chzn-results-scroll-down span { - background: url('chosen-sprite.png') no-repeat -4px -3px; -} -.chzn-container .chzn-results-scroll-up span { - background: url('chosen-sprite.png') no-repeat -22px -3px; -} -/* @end */ - -/* @group Active */ -.chzn-container-active .chzn-single { - -webkit-box-shadow: 0 0 5px rgba(0,0,0,.3); - -moz-box-shadow : 0 0 5px rgba(0,0,0,.3); - -o-box-shadow : 0 0 5px rgba(0,0,0,.3); - box-shadow : 0 0 5px rgba(0,0,0,.3); - border: 1px solid #5897fb; -} -.chzn-container-active .chzn-single-with-drop { - border: 1px solid #aaa; - -webkit-box-shadow: 0 1px 0 #fff inset; - -moz-box-shadow : 0 1px 0 #fff inset; - -o-box-shadow : 0 1px 0 #fff inset; - box-shadow : 0 1px 0 #fff inset; - background-color: #eee; - filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#eeeeee', endColorstr='#ffffff', GradientType=0 ); - background-image: -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(20%, #eeeeee), color-stop(80%, #ffffff)); - background-image: -webkit-linear-gradient(top, #eeeeee 20%, #ffffff 80%); - background-image: -moz-linear-gradient(top, #eeeeee 20%, #ffffff 80%); - background-image: -o-linear-gradient(top, #eeeeee 20%, #ffffff 80%); - background-image: -ms-linear-gradient(top, #eeeeee 20%, #ffffff 80%); - background-image: linear-gradient(top, #eeeeee 20%, #ffffff 80%); - -webkit-border-bottom-left-radius : 0; - -webkit-border-bottom-right-radius: 0; - -moz-border-radius-bottomleft : 0; - -moz-border-radius-bottomright: 0; - border-bottom-left-radius : 0; - border-bottom-right-radius: 0; -} -.chzn-container-active .chzn-single-with-drop div { - background: transparent; - border-left: none; -} -.chzn-container-active .chzn-single-with-drop div b { - background-position: -18px 1px; -} -.chzn-container-active .chzn-choices { - -webkit-box-shadow: 0 0 5px rgba(0,0,0,.3); - -moz-box-shadow : 0 0 5px rgba(0,0,0,.3); - -o-box-shadow : 0 0 5px rgba(0,0,0,.3); - box-shadow : 0 0 5px rgba(0,0,0,.3); - border: 1px solid #5897fb; -} -.chzn-container-active .chzn-choices .search-field input { - color: #111 !important; -} -/* @end */ - -/* @group Disabled Support */ -.chzn-disabled { - cursor: default; - opacity:0.5 !important; -} -.chzn-disabled .chzn-single { - cursor: default; -} -.chzn-disabled .chzn-choices .search-choice .search-choice-close { - cursor: default; -} - -/* @group Right to Left */ -.chzn-rtl { text-align: right; } -.chzn-rtl .chzn-single { padding: 0 8px 0 0; overflow: visible; } -.chzn-rtl .chzn-single span { margin-left: 26px; margin-right: 0; direction: rtl; } - -.chzn-rtl .chzn-single div { left: 3px; right: auto; } -.chzn-rtl .chzn-single abbr { - left: 26px; - right: auto; -} -.chzn-rtl .chzn-choices .search-field input { direction: rtl; } -.chzn-rtl .chzn-choices li { float: right; } -.chzn-rtl .chzn-choices .search-choice { padding: 3px 5px 3px 19px; margin: 3px 5px 3px 0; } -.chzn-rtl .chzn-choices .search-choice .search-choice-close { left: 4px; right: auto; background-position: right top;} -.chzn-rtl.chzn-container-single .chzn-results { margin: 0 0 4px 4px; padding: 0 4px 0 0; } -.chzn-rtl .chzn-results .group-option { padding-left: 0; padding-right: 15px; } -.chzn-rtl.chzn-container-active .chzn-single-with-drop div { border-right: none; } -.chzn-rtl .chzn-search input { - background: #fff url('chosen-sprite.png') no-repeat -38px -22px; - background: url('chosen-sprite.png') no-repeat -38px -22px, -webkit-gradient(linear, 0% 0%, 0% 100%, color-stop(1%, #eeeeee), color-stop(15%, #ffffff)); - background: url('chosen-sprite.png') no-repeat -38px -22px, -webkit-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background: url('chosen-sprite.png') no-repeat -38px -22px, -moz-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background: url('chosen-sprite.png') no-repeat -38px -22px, -o-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background: url('chosen-sprite.png') no-repeat -38px -22px, -ms-linear-gradient(top, #eeeeee 1%, #ffffff 15%); - background: url('chosen-sprite.png') no-repeat -38px -22px, linear-gradient(top, #eeeeee 1%, #ffffff 15%); - padding: 4px 5px 4px 20px; - direction: rtl; -} -/* @end */ - --- a/ckanext/example/theme/public/css/extra.css +++ /dev/null @@ -1,5 +1,1 @@ -body { - background-color: pink; -} - --- a/ckanext/example/theme/public/scripts/chosen.jquery.min.js +++ /dev/null @@ -1,10 +1,1 @@ -// Chosen, a Select Box Enhancer for jQuery and Protoype -// by Patrick Filler for Harvest, http://getharvest.com -// -// Version 0.9.7 -// Full source at https://github.com/harvesthq/chosen -// Copyright (c) 2011 Harvest http://getharvest.com -// MIT License, https://github.com/harvesthq/chosen/blob/master/LICENSE.md -// This file is generated by `cake build`, do not edit it by hand. -((function(){var a;a=function(){function a(){this.options_index=0,this.parsed=[]}return a.prototype.add_node=function(a){return a.nodeName==="OPTGROUP"?this.add_group(a):this.add_option(a)},a.prototype.add_group=function(a){var b,c,d,e,f,g;b=this.parsed.length,this.parsed.push({array_index:b,group:!0,label:a.label,children:0,disabled:a.disabled}),f=a.childNodes,g=[];for(d=0,e=f.length;d"+a.html+"")},a.prototype.results_update_field=function(){return this.result_clear_highlight(),this.result_single_selected=null,this.results_build()},a.prototype.results_toggle=function(){return this.results_showing?this.results_hide():this.results_show()},a.prototype.results_search=function(a){return this.results_showing?this.winnow_results():this.results_show()},a.prototype.keyup_checker=function(a){var b,c;b=(c=a.which)!=null?c:a.keyCode,this.search_field_scale();switch(b){case 8:if(this.is_multiple&&this.backstroke_length<1&&this.choices>0)return this.keydown_backstroke();if(!this.pending_backstroke)return this.result_clear_highlight(),this.results_search();break;case 13:a.preventDefault();if(this.results_showing)return this.result_select(a);break;case 27:return this.results_showing&&this.results_hide(),!0;case 9:case 38:case 40:case 16:case 91:case 17:break;default:return this.results_search()}},a.prototype.generate_field_id=function(){var a;return a=this.generate_random_id(),this.form_field.id=a,a},a.prototype.generate_random_char=function(){var a,b,c;return a="0123456789ABCDEFGHIJKLMNOPQRSTUVWXTZ",c=Math.floor(Math.random()*a.length),b=a.substring(c,c+1)},a}(),b.AbstractChosen=a}.call(this),function(){var a,b,c,d,e=Object.prototype.hasOwnProperty,f=function(a,b){function d(){this.constructor=a}for(var c in b)e.call(b,c)&&(a[c]=b[c]);return d.prototype=b.prototype,a.prototype=new d,a.__super__=b.prototype,a};d=this,a=jQuery,a.fn.extend({chosen:function(c){return!a.browser.msie||a.browser.version!=="6.0"&&a.browser.version!=="7.0"?a(this).each(function(d){if(!a(this).hasClass("chzn-done"))return new b(this,c)}):this}}),b=function(b){function e(){e.__super__.constructor.apply(this,arguments)}return f(e,b),e.prototype.setup=function(){return this.form_field_jq=a(this.form_field),this.is_rtl=this.form_field_jq.hasClass("chzn-rtl")},e.prototype.finish_setup=function(){return this.form_field_jq.addClass("chzn-done")},e.prototype.set_up_html=function(){var b,d,e,f;return this.container_id=this.form_field.id.length?this.form_field.id.replace(/(:|\.)/g,"_"):this.generate_field_id(),this.container_id+="_chzn",this.f_width=this.form_field_jq.outerWidth(),this.default_text=this.form_field_jq.data("placeholder")?this.form_field_jq.data("placeholder"):this.default_text_default,b=a("
    ",{id:this.container_id,"class":"chzn-container"+(this.is_rtl?" chzn-rtl":""),style:"width: "+this.f_width+"px;"}),this.is_multiple?b.html('
      '):b.html(''+this.default_text+'
        '),this.form_field_jq.hide().after(b),this.container=a("#"+this.container_id),this.container.addClass("chzn-container-"+(this.is_multiple?"multi":"single")),this.dropdown=this.container.find("div.chzn-drop").first(),d=this.container.height(),e=this.f_width-c(this.dropdown),this.dropdown.css({width:e+"px",top:d+"px"}),this.search_field=this.container.find("input").first(),this.search_results=this.container.find("ul.chzn-results").first(),this.search_field_scale(),this.search_no_results=this.container.find("li.no-results").first(),this.is_multiple?(this.search_choices=this.container.find("ul.chzn-choices").first(),this.search_container=this.container.find("li.search-field").first()):(this.search_container=this.container.find("div.chzn-search").first(),this.selected_item=this.container.find(".chzn-single").first(),f=e-c(this.search_container)-c(this.search_field),this.search_field.css({width:f+"px"})),this.results_build(),this.set_tab_index(),this.form_field_jq.trigger("liszt:ready",{chosen:this})},e.prototype.register_observers=function(){var a=this;return this.container.mousedown(function(b){return a.container_mousedown(b)}),this.container.mouseup(function(b){return a.container_mouseup(b)}),this.container.mouseenter(function(b){return a.mouse_enter(b)}),this.container.mouseleave(function(b){return a.mouse_leave(b)}),this.search_results.mouseup(function(b){return a.search_results_mouseup(b)}),this.search_results.mouseover(function(b){return a.search_results_mouseover(b)}),this.search_results.mouseout(function(b){return a.search_results_mouseout(b)}),this.form_field_jq.bind("liszt:updated",function(b){return a.results_update_field(b)}),this.search_field.blur(function(b){return a.input_blur(b)}),this.search_field.keyup(function(b){return a.keyup_checker(b)}),this.search_field.keydown(function(b){return a.keydown_checker(b)}),this.is_multiple?(this.search_choices.click(function(b){return a.choices_click(b)}),this.search_field.focus(function(b){return a.input_focus(b)})):this.container.click(function(a){return a.preventDefault()})},e.prototype.search_field_disabled=function(){this.is_disabled=this.form_field_jq[0].disabled;if(this.is_disabled)return this.container.addClass("chzn-disabled"),this.search_field[0].disabled=!0,this.is_multiple||this.selected_item.unbind("focus",this.activate_action),this.close_field();this.container.removeClass("chzn-disabled"),this.search_field[0].disabled=!1;if(!this.is_multiple)return this.selected_item.bind("focus",this.activate_action)},e.prototype.container_mousedown=function(b){var c;if(!this.is_disabled)return c=b!=null?a(b.target).hasClass("search-choice-close"):!1,b&&b.type==="mousedown"&&b.stopPropagation(),!this.pending_destroy_click&&!c?(this.active_field?!this.is_multiple&&b&&(a(b.target)[0]===this.selected_item[0]||a(b.target).parents("a.chzn-single").length)&&(b.preventDefault(),this.results_toggle()):(this.is_multiple&&this.search_field.val(""),a(document).click(this.click_test_action),this.results_show()),this.activate_field()):this.pending_destroy_click=!1},e.prototype.container_mouseup=function(a){if(a.target.nodeName==="ABBR")return this.results_reset(a)},e.prototype.blur_test=function(a){if(!this.active_field&&this.container.hasClass("chzn-container-active"))return this.close_field()},e.prototype.close_field=function(){return a(document).unbind("click",this.click_test_action),this.is_multiple||(this.selected_item.attr("tabindex",this.search_field.attr("tabindex")),this.search_field.attr("tabindex",-1)),this.active_field=!1,this.results_hide(),this.container.removeClass("chzn-container-active"),this.winnow_results_clear(),this.clear_backstroke(),this.show_search_field_default(),this.search_field_scale()},e.prototype.activate_field=function(){return!this.is_multiple&&!this.active_field&&(this.search_field.attr("tabindex",this.selected_item.attr("tabindex")),this.selected_item.attr("tabindex",-1)),this.container.addClass("chzn-container-active"),this.active_field=!0,this.search_field.val(this.search_field.val()),this.search_field.focus()},e.prototype.test_active_click=function(b){return a(b.target).parents("#"+this.container_id).length?this.active_field=!0:this.close_field()},e.prototype.results_build=function(){var a,b,c,e,f;this.parsing=!0,this.results_data=d.SelectParser.select_to_array(this.form_field),this.is_multiple&&this.choices>0?(this.search_choices.find("li.search-choice").remove(),this.choices=0):this.is_multiple||(this.selected_item.find("span").text(this.default_text),this.form_field.options.length<=this.disable_search_threshold?this.container.addClass("chzn-container-single-nosearch"):this.container.removeClass("chzn-container-single-nosearch")),a="",f=this.results_data;for(c=0,e=f.length;c'+a("
        ").text(b.label).html()+"")},e.prototype.result_do_highlight=function(a){var b,c,d,e,f;if(a.length){this.result_clear_highlight(),this.result_highlight=a,this.result_highlight.addClass("highlighted"),d=parseInt(this.search_results.css("maxHeight"),10),f=this.search_results.scrollTop(),e=d+f,c=this.result_highlight.position().top+this.search_results.scrollTop(),b=c+this.result_highlight.outerHeight();if(b>=e)return this.search_results.scrollTop(b-d>0?b-d:0);if(c'+b.html+''),d=a("#"+c).find("a").first(),d.click(function(a){return e.choice_destroy_link_click(a)})},e.prototype.choice_destroy_link_click=function(b){return b.preventDefault(),this.is_disabled?b.stopPropagation:(this.pending_destroy_click=!0,this.choice_destroy(a(b.target)))},e.prototype.choice_destroy=function(a){return this.choices-=1,this.show_search_field_default(),this.is_multiple&&this.choices>0&&this.search_field.val().length<1&&this.results_hide(),this.result_deselect(a.attr("rel")),a.parents("li").first().remove()},e.prototype.results_reset=function(b){this.form_field.options[0].selected=!0,this.selected_item.find("span").text(this.default_text),this.show_search_field_default(),a(b.target).remove(),this.form_field_jq.trigger("change");if(this.active_field)return this.results_hide()},e.prototype.result_select=function(a){var b,c,d,e;if(this.result_highlight)return b=this.result_highlight,c=b.attr("id"),this.result_clear_highlight(),this.is_multiple?this.result_deactivate(b):(this.search_results.find(".result-selected").removeClass("result-selected"),this.result_single_selected=b),b.addClass("result-selected"),e=c.substr(c.lastIndexOf("_")+1),d=this.results_data[e],d.selected=!0,this.form_field.options[d.options_index].selected=!0,this.is_multiple?this.choice_build(d):(this.selected_item.find("span").first().text(d.text),this.allow_single_deselect&&this.single_deselect_control_build()),(!a.metaKey||!this.is_multiple)&&this.results_hide(),this.search_field.val(""),this.form_field_jq.trigger("change"),this.search_field_scale()},e.prototype.result_activate=function(a){return a.addClass("active-result")},e.prototype.result_deactivate=function(a){return a.removeClass("active-result")},e.prototype.result_deselect=function(b){var c,d;return d=this.results_data[b],d.selected=!1,this.form_field.options[d.options_index].selected=!1,c=a("#"+this.container_id+"_o_"+b),c.removeClass("result-selected").addClass("active-result").show(),this.result_clear_highlight(),this.winnow_results(),this.form_field_jq.trigger("change"),this.search_field_scale()},e.prototype.single_deselect_control_build=function(){if(this.allow_single_deselect&&this.selected_item.find("abbr").length<1)return this.selected_item.find("span").first().after('')},e.prototype.winnow_results=function(){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r;this.no_results_clear(),i=0,j=this.search_field.val()===this.default_text?"":a("
        ").text(a.trim(this.search_field.val())).html(),f=new RegExp("^"+j.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&"),"i"),m=new RegExp(j.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&"),"i"),r=this.results_data;for(n=0,p=r.length;n=0||c.html.indexOf("[")===0){e=c.html.replace(/\[|\]/g,"").split(" ");if(e.length)for(o=0,q=e.length;o"+c.html.substr(k+j.length),l=l.substr(0,k)+""+l.substr(k)):l=c.html,g.html(l),this.result_activate(g),c.group_array_index!=null&&a("#"+this.results_data[c.group_array_index].dom_id).css("display","list-item")):(this.result_highlight&&h===this.result_highlight.attr("id")&&this.result_clear_highlight(),this.result_deactivate(g))}}return i<1&&j.length?this.no_results(j):this.winnow_results_set_highlight()},e.prototype.winnow_results_clear=function(){var b,c,d,e,f;this.search_field.val(""),c=this.search_results.find("li"),f=[];for(d=0,e=c.length;d'+this.results_none_found+' ""'),c.find("span").first().html(b),this.search_results.append(c)},e.prototype.no_results_clear=function(){return this.search_results.find(".no-results").remove()},e.prototype.keydown_arrow=function(){var b,c;this.result_highlight?this.results_showing&&(c=this.result_highlight.nextAll("li.active-result").first(),c&&this.result_do_highlight(c)):(b=this.search_results.find("li.active-result").first(),b&&this.result_do_highlight(a(b)));if(!this.results_showing)return this.results_show()},e.prototype.keyup_arrow=function(){var a;if(!this.results_showing&&!this.is_multiple)return this.results_show();if(this.result_highlight)return a=this.result_highlight.prevAll("li.active-result"),a.length?this.result_do_highlight(a.first()):(this.choices>0&&this.results_hide(),this.result_clear_highlight())},e.prototype.keydown_backstroke=function(){return this.pending_backstroke?(this.choice_destroy(this.pending_backstroke.find("a").first()),this.clear_backstroke()):(this.pending_backstroke=this.search_container.siblings("li.search-choice").last(),this.pending_backstroke.addClass("search-choice-focus"))},e.prototype.clear_backstroke=function(){return this.pending_backstroke&&this.pending_backstroke.removeClass("search-choice-focus"),this.pending_backstroke=null},e.prototype.keydown_checker=function(a){var b,c;b=(c=a.which)!=null?c:a.keyCode,this.search_field_scale(),b!==8&&this.pending_backstroke&&this.clear_backstroke();switch(b){case 8:this.backstroke_length=this.search_field.val().length;break;case 9:this.results_showing&&!this.is_multiple&&this.result_select(a),this.mouse_on_container=!1;break;case 13:a.preventDefault();break;case 38:a.preventDefault(),this.keyup_arrow();break;case 40:this.keydown_arrow()}},e.prototype.search_field_scale=function(){var b,c,d,e,f,g,h,i,j;if(this.is_multiple){d=0,h=0,f="position:absolute; left: -1000px; top: -1000px; display:none;",g=["font-size","font-style","font-weight","font-family","line-height","text-transform","letter-spacing"];for(i=0,j=g.length;i",{style:f}),c.text(this.search_field.val()),a("body").append(c),h=c.width()+25,c.remove(),h>this.f_width-10&&(h=this.f_width-10),this.search_field.css({width:h+"px"}),b=this.container.height(),this.dropdown.css({top:b+"px"})}},e.prototype.generate_random_id=function(){var b;b="sel"+this.generate_random_char()+this.generate_random_char()+this.generate_random_char();while(a("#"+b).length>0)b+=this.generate_random_char();return b},e}(AbstractChosen),c=function(a){var b;return b=a.outerWidth()-a.width()},d.get_side_border_padding=c}.call(this) --- a/ckanext/example/theme/templates/forms/dataset_form.html +++ /dev/null @@ -1,274 +1,1 @@ -
        - -
        -

        Errors in form

        -

        The form contains invalid entries:

        -
          -
        • ${"%s: %s" % (key, error)} - -
            - -
          • - Resource ${idx}: -
              -
            • ${thiskey}: ${errorinfo};
              • -
            -
            • -             -
          -           -
          • -
        -
        - -
        -
        -
        -
        - -
        -
        ${errors.get('title', '')}
        - -
        -
        - ${h.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', '')}
        -
        - -

        Musical Genre

        -
        -
        -
        - -
        -
        ${errors.get('genre_tag_string', '')}
        -
        - -

        Composer

        -
        -
        -
        - -
        -
        ${errors.get('composer_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,35 +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=[], 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 - - [paste.paster_command] - example=ckanext.example.commands:ExampleCommand + datagovau=ckanext.datagovau.plugin:DataGovAuPlugin """, )