From: Alex Sadleir Date: Mon, 23 Sep 2013 23:40:17 +0000 Subject: Move Disqus comments to package not resource page X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=829c316044b3348bf9721cc955c9ead52fdc67bf --- Move Disqus comments to package not resource page --- --- /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/scopes/scope_settings.xml @@ -1,1 +1,5 @@ - + + + + --- /dev/null +++ b/.idea/vcs.xml @@ -1,1 +1,8 @@ + + + + + + + --- /dev/null +++ b/.idea/workspace.xml @@ -1,1 +1,649 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + localhost + 5050 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + --- a/README.rst +++ b/README.rst @@ -4,9 +4,11 @@ * 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 and available licenses database - * A custom Package edit form + * 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 cut down licenses.json file Installation ============ @@ -17,5 +19,9 @@ 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`` + --- /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/__init__.py --- /dev/null +++ b/ckanext/datagovau/plugin.py @@ -1,1 +1,173 @@ +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 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, '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,173 @@ +{% 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('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" ];