import logging | import logging |
import ckan.plugins as plugins | import ckan.plugins as plugins |
import ckan.lib as lib | import ckan.lib as lib |
import ckan.lib.dictization.model_dictize as model_dictize | import ckan.lib.dictization.model_dictize as model_dictize |
import ckan.plugins.toolkit as tk | import ckan.plugins.toolkit as tk |
import ckan.model as model | import ckan.model as model |
from pylons import config | from pylons import config |
from sqlalchemy import orm | from sqlalchemy import orm |
import ckan.model | import ckan.model |
#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}) | |
class AGLSPlugin(plugins.SingletonPlugin, | class AGLSPlugin(plugins.SingletonPlugin, |
tk.DefaultDatasetForm): | tk.DefaultDatasetForm): |
'''An example IDatasetForm CKAN plugin. | '''An example IDatasetForm CKAN plugin. |
Uses a tag vocabulary to add a custom metadata field to datasets. | Uses a tag vocabulary to add a custom metadata field to datasets. |
''' | ''' |
plugins.implements(plugins.IConfigurer, inherit=False) | plugins.implements(plugins.IConfigurer, inherit=False) |
plugins.implements(plugins.IDatasetForm, inherit=False) | plugins.implements(plugins.IDatasetForm, inherit=False) |
plugins.implements(plugins.ITemplateHelpers, inherit=False) | |
def update_config(self, config): | def update_config(self, config): |
# Add this plugin's templates dir to CKAN's extra_template_paths, so | # Add this plugin's templates dir to CKAN's extra_template_paths, so |
# that CKAN will use this plugin's custom templates. | # that CKAN will use this plugin's custom templates. |
# here = os.path.dirname(__file__) | # here = os.path.dirname(__file__) |
# rootdir = os.path.dirname(os.path.dirname(here)) | # rootdir = os.path.dirname(os.path.dirname(here)) |
tk.add_template_directory(config, 'templates') | tk.add_template_directory(config, 'templates') |
tk.add_public_directory(config, 'theme/public') | tk.add_public_directory(config, 'theme/public') |
tk.add_resource('theme/public', 'ckanext-agls') | tk.add_resource('theme/public', 'ckanext-agls') |
# config['licenses_group_url'] = 'http://%(ckan.site_url)/licenses.json' | # config['licenses_group_url'] = 'http://%(ckan.site_url)/licenses.json' |
def get_helpers(self): | |
return {'get_last_active_user': get_last_active_user} | |
def is_fallback(self): | def is_fallback(self): |
# Return True to register this plugin as the default handler for | # Return True to register this plugin as the default handler for |
# package types not handled by any other IDatasetForm plugin. | # package types not handled by any other IDatasetForm plugin. |
return True | return True |
def package_types(self): | def package_types(self): |
# This plugin doesn't handle any special package types, it just | # This plugin doesn't handle any special package types, it just |
# registers itself as the default (above). | # registers itself as the default (above). |
return [] | return [] |
def create_package_schema(self): | def create_package_schema(self): |
schema = super(AGLSPlugin, self).create_package_schema() | schema = super(AGLSPlugin, self).create_package_schema() |
schema = self._modify_package_schema(schema) | schema = self._modify_package_schema(schema) |
return schema | return schema |
def update_package_schema(self): | def update_package_schema(self): |
schema = super(AGLSPlugin, self).update_package_schema() | schema = super(AGLSPlugin, self).update_package_schema() |
schema = self._modify_package_schema(schema) | schema = self._modify_package_schema(schema) |
return schema | return schema |
def show_package_schema(self): | def show_package_schema(self): |
schema = super(AGLSPlugin, self).show_package_schema() | schema = super(AGLSPlugin, self).show_package_schema() |
# Don't show vocab tags mixed in with normal 'free' tags | # Don't show vocab tags mixed in with normal 'free' tags |
# (e.g. on dataset pages, or on the search page) | # (e.g. on dataset pages, or on the search page) |
schema['tags']['__extras'].append(tk.get_converter('free_tags_only')) | schema['tags']['__extras'].append(tk.get_converter('free_tags_only')) |
# Add our custom_text field to the dataset schema. | # Add our custom_text field to the dataset schema. |
# ignore_missing == optional | # ignore_missing == optional |
# ignore_empty == mandatory but not for viewing | # ignore_empty == mandatory but not for viewing |
# !!! always convert_from_extras first | # !!! always convert_from_extras first |
schema.update({ | schema.update({ |
'agency_program': [tk.get_converter('convert_from_extras'), | 'agency_program': [tk.get_converter('convert_from_extras'), |
tk.get_validator('ignore_missing')], | tk.get_validator('ignore_missing')], |
'contact_point': [tk.get_converter('convert_from_extras'), | 'contact_point': [tk.get_converter('convert_from_extras'), |
tk.get_validator('ignore_empty')], | tk.get_validator('ignore_empty')], |
'spatial_coverage': [tk.get_converter('convert_from_extras'), | 'spatial_coverage': [tk.get_converter('convert_from_extras'), |
tk.get_validator('ignore_empty')], | tk.get_validator('ignore_empty')], |
'granularity': [tk.get_converter('convert_from_extras'), | 'granularity': [tk.get_converter('convert_from_extras'), |
tk.get_validator('ignore_empty')], | tk.get_validator('ignore_empty')], |
'jurisdiction': [tk.get_converter('convert_from_extras'), | 'jurisdiction': [tk.get_converter('convert_from_extras'), |
tk.get_validator('ignore_empty')], | tk.get_validator('ignore_empty')], |
'temporal_coverage': [tk.get_converter('convert_from_extras'), | 'temporal_coverage': [tk.get_converter('convert_from_extras'), |
tk.get_validator('ignore_empty')], | tk.get_validator('ignore_empty')], |
'data_state': [tk.get_converter('convert_from_extras'), | 'data_state': [tk.get_converter('convert_from_extras'), |
tk.get_validator('ignore_empty')], | tk.get_validator('ignore_empty')], |
'update_freq': [tk.get_converter('convert_from_extras'), | 'update_freq': [tk.get_converter('convert_from_extras'), |
tk.get_validator('ignore_empty')] | tk.get_validator('ignore_empty')], |
#harvesting fields | |
#'spatial_harvester': [tk.get_converter('convert_from_extras'), | |
# tk.get_validator('ignore_missing')], | |
#'harvest_object_id': [tk.get_converter('convert_from_extras'), | |
# tk.get_validator('ignore_missing')], | |
#'harvest_source_id': [tk.get_converter('convert_from_extras'), | |
# tk.get_validator('ignore_missing')], | |
#'harvest_source_title': [tk.get_converter('convert_from_extras'), | |
# tk.get_validator('ignore_missing')], | |
}) | }) |
return schema | return schema |
def _modify_package_schema(self, schema): | def _modify_package_schema(self, schema): |
# Add our custom_test metadata field to the schema, this one will use | # Add our custom_test metadata field to the schema, this one will use |
# convert_to_extras instead of convert_to_tags. | # convert_to_extras instead of convert_to_tags. |
# ignore_missing == optional | # ignore_missing == optional |
# not_empty == mandatory, enforced here while modifying | # not_empty == mandatory, enforced here while modifying |
schema.update({ | schema.update({ |
'agency_program': [tk.get_validator('ignore_missing'), | 'agency_program': [tk.get_validator('ignore_missing'), |
tk.get_converter('convert_to_extras')], | tk.get_converter('convert_to_extras')], |
'contact_point': [tk.get_converter('convert_to_extras'), | 'contact_point': [tk.get_converter('convert_to_extras'), |
tk.get_validator('not_empty')], | tk.get_validator('not_empty')], |
'spatial_coverage': [tk.get_converter('convert_to_extras'), | 'spatial_coverage': [tk.get_converter('convert_to_extras'), |
tk.get_validator('not_empty')], | tk.get_validator('not_empty')], |
'granularity': [tk.get_converter('convert_to_extras'), | 'granularity': [tk.get_converter('convert_to_extras'), |
tk.get_validator('not_empty')], | tk.get_validator('not_empty')], |
'jurisdiction': [tk.get_converter('convert_to_extras'), | 'jurisdiction': [tk.get_converter('convert_to_extras'), |
tk.get_validator('not_empty')], | tk.get_validator('not_empty')], |
'temporal_coverage': [tk.get_converter('convert_to_extras'), | 'temporal_coverage': [tk.get_converter('convert_to_extras'), |
tk.get_validator('not_empty')], | tk.get_validator('not_empty')], |
'data_state': [tk.get_converter('convert_to_extras'), | 'data_state': [tk.get_converter('convert_to_extras'), |
tk.get_validator('not_empty')], | tk.get_validator('not_empty')], |
'update_freq': [tk.get_converter('convert_to_extras'), | 'update_freq': [tk.get_converter('convert_to_extras'), |
tk.get_validator('not_empty')] | tk.get_validator('not_empty')], |
#harvesting fields | |
#'spatial_harvester': [tk.get_validator('ignore_missing'), | |
# tk.get_converter('convert_to_extras')], | |
#'harvest_object_id': [tk.get_validator('ignore_missing'), | |
# tk.get_converter('convert_to_extras')], | |
#'harvest_source_id': [tk.get_validator('ignore_missing'), | |
# tk.get_converter('convert_to_extras')], | |
#'harvest_source_title': [tk.get_validator('ignore_missing'), | |
# tk.get_converter('convert_to_extras')], | |
}) | }) |
return schema | return schema |
{% ckan_extends %} | {% ckan_extends %} |
{% block package_additional_info %} | {% block package_additional_info %} |
<section class="additional-info" prefix="dc: http://purl.org/dc/elements/1.1/ dcat: http://www.w3.org/ns/dcat# | <section class="additional-info" prefix="dc: http://purl.org/dc/elements/1.1/ dcat: http://www.w3.org/ns/dcat# |
dcam: http://purl.org/dc/dcam/ | dcam: http://purl.org/dc/dcam/ |
aglsterms: http://www.agls.gov.au/agls/terms/ | aglsterms: http://www.agls.gov.au/agls/terms/ |
agentterms: http://www.agls.gov.au/agls/agentterms/ | agentterms: http://www.agls.gov.au/agls/agentterms/ |
availterms: http://www.agls.gov.au/agls/availterms/ | availterms: http://www.agls.gov.au/agls/availterms/ |
adminterms: http://www.agls.gov.au/agls/adminterms/ | adminterms: http://www.agls.gov.au/agls/adminterms/ |
dct: http://purl.org/dc/terms/"> | dct: http://purl.org/dc/terms/"> |
<h3>{{ _('Additional Info') }}</h3> | <h3>{{ _('Additional Info') }}</h3> |
<table class="table table-striped table-bordered table-condensed"> | <table class="table table-striped table-bordered table-condensed"> |
<thead> | <thead> |
<tr> | <tr> |
<th scope="col">{{ _('Field') }}</th> | <th scope="col">{{ _('Field') }}</th> |
<th scope="col">{{ _('Value') }}</th> | <th scope="col">{{ _('Value') }}</th> |
</tr> | </tr> |
</thead> | </thead> |
<tbody> | <tbody> |
{# Add our custom field to the dataset read page. #} | {# Add our custom field to the dataset read page. #} |
{% if pkg.get('metadata_created') %} | {% if pkg.get('metadata_created') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Date Published</th> | <th scope="row" class="dataset-label">Date Published</th> |
<td class="dataset-details" property="dct:issued">{{ pkg.metadata_created.split("T")[0] }}</td> | <td class="dataset-details" property="dct:issued">{{ pkg.metadata_created.split("T")[0] }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('metadata_updated') %} | {% if pkg.get('metadata_updated') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Date Updated</th> | <th scope="row" class="dataset-label">Date Updated</th> |
<td class="dataset-details" property="dct:updated">{{ pkg.metadata_updated.split("T")[0] }}</td> | <td class="dataset-details" property="dct:updated">{{ pkg.metadata_updated.split("T")[0] }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('agency_program') %} | {% if pkg.get('agency_program') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Agency Program</th> | <th scope="row" class="dataset-label">Agency Program</th> |
<td class="dataset-details"> {{ pkg.agency_program }}</td> | <td class="dataset-details"> {{ pkg.agency_program }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('url') %} | {% if pkg.get('url') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">{{ _('Source') }}</th> | <th scope="row" class="dataset-label">{{ _('Source') }}</th> |
<td class="dataset-details" property="dct:source">{{ h.link_to(pkg.get('url'), | <td class="dataset-details" property="dct:source">{{ h.link_to(pkg.get('url'), |
pkg.get('url'), rel='dct:source', target='_blank') }} | pkg.get('url'), rel='dct:source', target='_blank') }} |
</td> | |
</tr> | |
{% endif %} | |
{% if h.get_pkg_dict_extra(c.pkg_dict, 'spatial_harvester','') != '' %} | |
<tr> | |
<th scope="row" class="dataset-label">XML Metadata Document</th> | |
<td class="dataset-details">{{ h.link_to("View",h.url_for(controller='HarvestMetadataApi', action='display_xml_original', id=h.get_pkg_dict_extra(c.pkg_dict, 'harvest_object_id'))) }} | |
</td> | </td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('contact_point') %} | {% if pkg.get('contact_point') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Contact Point</th> | <th scope="row" class="dataset-label">Contact Point</th> |
<td class="dataset-details" property="dcat:contactPoint"> {{ h.mail_to(email_address=pkg.contact_point, | <td class="dataset-details" property="dcat:contactPoint"> {{ h.mail_to(email_address=pkg.contact_point, |
name=pkg.contact_point) }}</td> | name=pkg.contact_point) }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('spatial_coverage') %} | {% if pkg.get('spatial_coverage') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Geospatial Coverage</th> | <th scope="row" class="dataset-label">Geospatial Coverage</th> |
<td class="dataset-details" property="dct:spatial"> {{ pkg.spatial_coverage }}</td> | <td class="dataset-details" property="dct:spatial"> {{ pkg.spatial_coverage }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('granularity') %} | {% if pkg.get('granularity') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Data Granularity</th> | <th scope="row" class="dataset-label">Data Granularity</th> |
<td class="dataset-details"> {{ pkg.granularity }}</td> | <td class="dataset-details"> {{ pkg.granularity }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('jurisdiction') %} | {% if pkg.get('jurisdiction') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Government Jurisdiction</th> | <th scope="row" class="dataset-label">Government Jurisdiction</th> |
<td class="dataset-details" property="aglsterms:AglsJuri"> {{ pkg.jurisdiction }}</td> | <td class="dataset-details" property="aglsterms:AglsJuri"> {{ pkg.jurisdiction }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('temporal_coverage') %} | {% if pkg.get('temporal_coverage') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Temporal Coverage</th> | <th scope="row" class="dataset-label">Temporal Coverage</th> |
<td class="dataset-details" property="dct:temporal"> {{ pkg.temporal_coverage }}</td> | <td class="dataset-details" property="dct:temporal"> {{ pkg.temporal_coverage }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('data_state') %} | {% if pkg.get('data_state') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Data State</th> | <th scope="row" class="dataset-label">Data State</th> |
<td class="dataset-details"> {{ pkg.data_state }}</td> | <td class="dataset-details"> {{ pkg.data_state }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% if pkg.get('update_freq') %} | {% if pkg.get('update_freq') %} |
<tr> | <tr> |
<th scope="row" class="dataset-label">Update Frequency</th> | <th scope="row" class="dataset-label">Update Frequency</th> |
<td class="dataset-details"> {{ pkg.update_freq }}</td> | <td class="dataset-details"> {{ pkg.update_freq }}</td> |
</tr> | </tr> |
{% endif %} | {% endif %} |
{% set email =h.get_last_active_user(c.pkg_dict['id']).get('email','') %} | |
<tr> | |
<th scope="row" class="dataset-label">{{ _('Maintainer') }}</th> | |
<td class="dataset-details" property="dc:contributor">{{ | |
h.mail_to(email_address=(email or ' '), name=h.get_last_active_user(c.pkg_dict['id']).get("display_name",'')) }} | |
</td> | |
</tr> | |
<tr> | <tr> |
<th scope="row" class="dataset-label">Publisher/Agency</th> | <th scope="row" class="dataset-label">Publisher/Agency</th> |
<td class="dataset-details" property="dc:publisher">{{ c.pkg_dict['organization']['title']}} | <td class="dataset-details" property="dc:publisher">{{ c.pkg_dict['organization']['title']}} |
</td> | </td> |
</tr> | </tr> |
<tr> | <tr> |
<th scope="row" class="dataset-label">Type</th> | <th scope="row" class="dataset-label">Type</th> |
<td class="dataset-details" property="dc:type">Dataset</td> | <td class="dataset-details" property="dc:type">Dataset</td> |
</tr> | </tr> |
<tr> | <tr> |
<th scope="row" class="dataset-label">Language</th> | <th scope="row" class="dataset-label">Language</th> |
<td class="dataset-details" property="dc:language">English</td> | <td class="dataset-details" property="dc:language">English</td> |
</tr> | </tr> |
</tbody> | </tbody> |
</table> | </table> |
</section> | </section> |
{% endblock %} | {% endblock %} |
<?xml version="1.0" encoding="utf-8"?> | <?xml version="1.0" encoding="utf-8"?> |
<rdf:RDF | <rdf:RDF |
xmlns:py="http://genshi.edgewall.org/" | xmlns:py="http://genshi.edgewall.org/" |
xmlns:foaf="http://xmlns.com/foaf/0.1/" | xmlns:foaf="http://xmlns.com/foaf/0.1/" |
xmlns:owl="http://www.w3.org/2002/07/owl#" | xmlns:owl="http://www.w3.org/2002/07/owl#" |
xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" | xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" |
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" | xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" |
xmlns:dcat="http://www.w3.org/ns/dcat#" | xmlns:dcat="http://www.w3.org/ns/dcat#" |
xmlns:dcam="http://purl.org/dc/dcam/" | xmlns:dcam="http://purl.org/dc/dcam/" |
xmlns:aglsterms="http://www.agls.gov.au/agls/terms/" | xmlns:aglsterms="http://www.agls.gov.au/agls/terms/" |
xmlns:agentterms="http://www.agls.gov.au/agls/agentterms/" | xmlns:agentterms="http://www.agls.gov.au/agls/agentterms/" |
xmlns:availterms="http://www.agls.gov.au/agls/availterms/" | xmlns:availterms="http://www.agls.gov.au/agls/availterms/" |
xmlns:adminterms="http://www.agls.gov.au/agls/adminterms/" | xmlns:adminterms="http://www.agls.gov.au/agls/adminterms/" |
xmlns:dct="http://purl.org/dc/terms/" | xmlns:dct="http://purl.org/dc/terms/" |
> | > |
<dcat:Dataset rdf:about="${ h.url_for(controller='package',action='read',id=c.pkg_dict['name'], qualified=True)}"> | <dcat:Dataset rdf:about=" |