From: CKAN data.gov.au Date: Wed, 04 Dec 2013 00:44:01 +0000 Subject: Add embed hint to datapreviews X-Git-Url: https://maxious.lambdacomplex.org/git/?p=ckanext-datagovau.git&a=commitdiff&h=e2d9caa5d42d30433cd2b0da5613ca12b6971861 --- Add embed hint to datapreviews --- --- /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,9 @@ + + + + + + + + --- /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,881 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + localhost + 5050 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + No facets are configured + + + + + + + + + + + + + + + + + + + + + + ckanext-datagovau + + + + + + + + + + + + + + + + + + + + + + + --- a/README.rst +++ b/README.rst @@ -4,9 +4,13 @@ * 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 to include AGLS/Dublin Core minimum metadata + * A custom Package edit form that defaults to cc-by licence * A custom n3/rdf output format + * Replaces links with http/https protocol independent versions + * Provides HTML to users to embed data previews on their own website + +* A cut down licenses.json file Installation ============ @@ -17,5 +21,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,101 @@ + + 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" + + +AddType application/octet-stream .woff + + SetEnvIf Origin "^http(s)?://(.+\.)?(data.gov.au)$" origin_is=$0 + Header set Access-Control-Allow-Origin %{origin_is}e env=origin_is + + + + 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,178 @@ +# 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.url ~ "/(..|.._..)/") { + set req.url = regsub(req.url, "/((?!js)..|.._..)/", "/"); +} + 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_hash { + # http://serverfault.com/questions/112531/ignoring-get-parameters-in-varnish-vcl + set req.url = regsub(req.url, "(?:(.com|.au))/((?!js)..|.._..)/", "/"); + hash_data(req.url); + if (req.http.host) { + hash_data(req.http.host); + } else { + hash_data(server.ip); + } + return (hash); +} +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/admin/development.ini @@ -1,1 +1,365 @@ - +# +# ckan - Pylons configuration +# +# The %(here)s variable will be replaced with the parent directory of this file +# +[DEFAULT] + +# Change debug to true when doing CKAN development, it enables Pylons' +# interactive debugging tool, makes Fanstatic serve unminified JS and CSS +# files, and enables CKAN templates' debugging features. +# +# WARNING: *THIS SETTING MUST BE SET TO FALSE ON A PRODUCTION ENVIRONMENT* +# Debug mode will enable the interactive debugging tool, allowing ANYONE to +# execute malicious code after an exception is raised. +debug = False + +email_to = ddg@alert.links.com.au +error_email_from = data.gov@finance.gov.au + +# The SMTP server to connect to when sending emails to users, with optional +# port (default: 25). For example: lavabit.com, or smtp.gmail.com:587. To +# connect to a local sendmail process enter 'localhost'. +#smtp.server = localhost +smtp.server = smtp.gmail.com:587 + +# Whether or not to use STARTTLS when connecting to the SMTP server. +#smtp.starttls = False +smtp.starttls = True + +# The username and password to use to authenticate with the SMTP server. +# Optional, if these are left commented-out then CKAN will try to send email +# to the SMTP server without logging in first. +#smtp.user = your_username@gmail.com +#smtp.password = your_password +smtp.user = datagovau@gmail.com +smtp.password = *** +googleanalytics.id = *** +# The email address that emails sent by CKAN to users should appear to come +# from. Optional (default: None, note that the SMTP server may insert its own +# from address). +smtp.mail_from = data.gov@finance.gov.au + +[server:main] +use = egg:Paste#http +host = 0.0.0.0 +port = 5000 + +[app:main] +use = egg:ckan +ckan.tracking_enabled = true +full_stack = true +cache_dir = %(here)s/data +beaker.session.key = ckan +beaker.session.secret = *** +app_instance_uuid = *** +# Auth + +ckan.auth.anon_create_dataset = false +ckan.auth.create_unowned_dataset = false +ckan.auth.create_dataset_if_not_in_organization = false +ckan.auth.user_create_organizations = false +ckan.auth.user_delete_organizations = true +ckan.auth.user_create_groups = false +ckan.auth.user_delete_groups = true +ckan.auth.create_user_via_api = true + +# List the names of CKAN extensions to activate. +# Note: This line is required to be here for packaging, even if it is empty. +# Note: Add ``pdf_preview`` to enable the resource preview for PDFs +# Add the ``resource_proxy`` plugin to enable resorce proxying and get around the same origin policy +# Add ``datastore`` to enable the CKAN DataStore extension +ckan.plugins = qa disqus stats json_preview recline_preview datastore datastorer googleanalytics resource_proxy wms_preview kml_preview geojson_preview datagovau + +disqus.name = datagovau + +# If you'd like to fine-tune the individual locations of the cache data dirs +# for the Cache data, or the Session saves, un-comment the desired settings +# here: +#beaker.cache.data_dir = %(here)s/data/cache +#beaker.session.data_dir = %(here)s/data/sessions + +# Specify the database for SQLAlchemy to use: +# * Postgres is currently required for a production CKAN deployment +# * Sqlite (memory or file) can be used as a quick alternative for testing +#sqlalchemy.url = postgresql://ckanuser:pass@localhost/ckantest +sqlalchemy.url = *** +#sqlalchemy.url = sqlite:/// +#sqlalchemy.url = sqlite:///%(here)s/somedb.db + +# Un-comment and specify the URLs for the DataStore database. +# * Postgres is required +#ckan.datastore.write_url = postgresql://ckanuser:pass@localhost/datastore +#ckan.datastore.read_url = postgresql://readonlyuser:pass@localhost/datastore +ckan.datastore.write_url = *** +ckan.datastore.read_url = *** + +# repoze.who config +who.config_file = %(here)s/who.ini +who.log_level = warning +who.log_file = %(cache_dir)s/who_log.ini + +# Location of RDF versions of datasets +#rdf_packages = http://semantic.ckan.net/record/ + +# Location of licenses group (defaults to cached local version of ckan group) +#licenses_group_url = http://licenses.opendefinition.org/licenses/groups/ckan.json +licenses_group_url = file://%(here)s/licenses.json + +# Dataset form to use +package_form = standard + +# Hide certain extras fields from dataset read form: +# package_hide_extras = for_search_index_only + +# API configuration +#apikey_header_name = X-CKAN-API-Key + +## extra places to look for templates and public files (comma separated lists) +## any templates/files found will override correspondingly named ones in +## ckan/templates/ and ckan/public +## (e.g. to override main layout template layout.html or add extra css files) +# extra_template_paths = %(here)s/my-templates +# extra_public_paths = %(here)s/my-public + +# Dataset form integration +#package_edit_return_url = http://another.frontend/dataset/ +#package_new_return_url = http://another.frontend/dataset/ + + +# Turn on messaging with carrot, default to false +#ckan.async_notifier = true +# Messaging module used by carrot: +# * pyamqplib - AMQP (e.g. for RabbitMQ) +# * queue - native Python Queue (debugging and tests only) +#carrot_messaging_library = pyamqplib + +## Perform search just using database (rather than use e.g. solr). +## In this setup search is crude and limited .e.g no full-text search, no faceting ... +## However, very useful for getting up and running quickly with CKAN +# ckan.simple_search = 1 + +## Title of site (using in several places including templates and tag +ckan.site_title = data.gov.au + +## Logo image to use on the home page +ckan.site_logo = /base/images/ckan-logo.png + +## Site tagline / description (used on front page) +ckan.site_description = Australian Government Open Data Catalogue + +## Used in creating some absolute urls (such as rss feeds, css files) and +## dump filenames +ckan.site_url = http://data.gov.au + +## Favicon (default is the CKAN software favicon) +ckan.favicon = /images/icons/ckan.ico + +## The gravatar default to use. This can be any of the pre-defined strings +## as defined on http://en.gravatar.com/site/implement/images/ (e.g. "identicon" +## or "mm"). Or it can be a url, e.g. "http://example.com/images/avatar.jpg" +ckan.gravatar_default = identicon + +## Solr support +solr_url = http://solr.data.gov.au:8983/solr + +## Automatic indexing. Make all changes immediately available via the search +## after editing or creating a dataset. Default is true. If for some reason +## you need the indexing to occur asynchronously, set this option to 0. +# ckan.search.automatic_indexing = 1 + +## An 'id' for the site (using, for example, when creating entries in a common search index) +## If not specified derived from the site_url +ckan.site_id = data.gov.au + +## API url to use (e.g. in AJAX callbacks) +## Enable if the API is at a different domain +# ckan.api_url = http://www.ckan.net + +## html content to be inserted just before </head> tag (e.g. extra stylesheet) +## NB: can use html e.g. <strong>blah</strong> +## NB: can have multiline strings just indent following lines +# ckan.template_head_end = <link rel="stylesheet" href="http://mysite.org/css/custom.css" type="text/css"> + +## html content to be inserted just before </body> tag (e.g. google analytics code) +## NB: can use html e.g. <strong>blah</strong> +## NB: can have multiline strings just indent following lines +# ckan.template_footer_end = + +# These three settings (ckan.log_dir, ckan.dump_dir and ckan.backup_dir) are +# all used in cron jobs, not in CKAN itself. CKAN logging is configured +# in the logging configuration below +# Directory for logs (produced by cron scripts associated with ckan) +ckan.log_dir = %(here)s/log +# Directory for JSON/CSV dumps (must match setting in apache config) +ckan.dump_dir = %(here)s/dump +# Directory for SQL database backups +ckan.backup_dir = %(here)s/backup + +# Default authorizations for new domain objects +#ckan.default_roles.Package = {"visitor": ["reader"], "logged_in": ["reader"]} +#ckan.default_roles.Group = {"visitor": ["reader"], "logged_in": ["reader"]} +#ckan.default_roles.System = {"visitor": ["reader"], "logged_in": ["editor"]} +#ckan.default_roles.AuthorizationGroup = {"visitor": ["reader"], "logged_in": ["reader"]} + +## Ckan public and private recaptcha keys [localhost] +#ckan.recaptcha.publickey = 6LcL-94SAAAAAKCHKLIgCYNJczalehF4a3GHlPyR +#ckan.recaptcha.privatekey = 6LcL-94SAAAAADCsq995yBsNl7lHEgJ3Ukqf4Ykq + +# Locale/languages +ckan.locale_default = en_GB +ckan.locales_offered = en_GB +# Languages are grouped by percentage of strings in CKAN 1.8 translated +# (those with 100% first, then those with >=80%, then >=50%, then <50%) and +# within these groups roughly sorted by number of worldwide native speakers +# according to Wikipedia. +ckan.locale_order = en_GB pt_BR ja it cs_CZ ca es fr el sv sr sr@latin no sk fi ru de pl nl bg ko_KR hu sa sl lv +ckan.locales_filtered_out = en + +## Atom Feeds +# +# Settings for customising the metadata provided in +# atom feeds. +# +# These settings are used to generate the <id> tags for both feeds +# and entries. The unique <id>s are created following the method +# outlined in http://www.taguri.org/ ie - they generate tagURIs, as specified +# in http://tools.ietf.org/html/rfc4151#section-2.1 : +# +# <id>tag:thedatahub.org,2012:/feeds/group/933f3857-79fd-4beb-a835-c0349e31ce76</id> +# +# Each component has the corresponding settings: +# +# "thedatahub.org" is ckan.feeds.authority_name +# "2012" is ckan.feeds.date +# + +# Leave blank to use the ckan.site_url config value, otherwise set to a +# domain or email address that you own. e.g. thedatahub.org or +# admin@thedatahub.org +ckan.feeds.authority_name = + +# Pick a date of the form "yyyy[-mm[-dd]]" during which the above domain was +# owned by you. +ckan.feeds.date = 2012 + +# If not set, then the value in `ckan.site_id` is used. +ckan.feeds.author_name = + +# If not set, then the value in `ckan.site_url` is used. +ckan.feeds.author_link = + +## File Store +# +# CKAN allows users to upload files directly to file storage either on the local +# file system or to online ‘cloud’ storage like Amazon S3 or Google Storage. +# +# If you are using local file storage, remember to set ckan.site_url. +# +# To enable cloud storage (Google or S3), first run: pip install boto +# +# @see http://docs.ckan.org/en/latest/filestore.html + +# 'Bucket' to use for file storage +ckan.storage.bucket = ckandga + +# To enable local file storage: +ofs.impl = pairtree +ofs.storage_dir = /srv/ckan/dga + +# To enable Google cloud storage: +#ofs.impl = google +#ofs.gs_access_key_id = +#ofs.gs_secret_access_key = + +# To enable S3 cloud storage: +#ofs.impl = s3 +#ofs.aws_access_key_id = .... +#ofs.aws_secret_access_key = .... + + +## Previews +# +# Set the file types that should be previewed inline (e.g. images) or directly in an iframe. + +ckan.preview.direct = png jpg gif +ckan.preview.loadable = html htm rdf+xml owl+xml xml n3 n-triples turtle plain atom csv tsv rss txt json + + +# Activity Streams +# +# Default maximum number of activities to show in an activity stream. +# ckan.activity_list_limit = 31 + + +# Activity Streams Email Notifications +# +# Uncomment this line to enable activity streams email notifications. +# You also need to setup a cron job to send the emails, see the documentation. +#ckan.activity_streams_email_notifications = True + +# Email notifications for events older than this time delta will not be sent. +# Accepted formats: '2 days', '14 days', '4:35:00' (hours, minutes, seconds), +# '7 days, 3:23:34', etc. +# ckan.email_notifications_since = 2 days + +ckan.cache_expires = 2592000 +#ckan.page_cache_enabled = True +ckan.static_max_age = 2592000 +ckan.cache_enabled = True +# DEBUGGING + +# ckan.debug_supress_header This option can be set to suppress the debug +# information showing the controller and action recieving the request being +# shown in the header. Note: This info only shows if debug is set to true. +ckan.debug_supress_header = false + +## =================================== +## Extensions + +## Config option to enable the (1 day) cache for stats +## Default (if not defined) is True as stats computations are intensive +# ckanext.stats.cache_enabled = True + +# Logging configuration +[loggers] +keys = root, ckan, ckanext + +[handlers] +keys = console, file + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console, file + +[logger_ckan] +level = ERROR +handlers = console, file +qualname = ckan +propagate = 0 + +[logger_ckanext] +level = WARNING +handlers = console, file +qualname = ckanext +propagate = 0 + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[handler_file] +class = logging.handlers.RotatingFileHandler +formatter = generic +level = NOTSET +#args = ("ckan.log", "a", 20000000, 9) +args = ("/var/log/ckan/dga/ckan.log", "a", 20000000, 9) + +[formatter_generic] +format = %(asctime)s %(levelname)-5.5s [%(name)s] %(message)s + --- /dev/null +++ b/admin/reset.sh @@ -1,1 +1,17 @@ +paster --plugin=ckan db clean --config=development.ini +echo "drop extension postgis cascade;" | psql -d ckantest +paster --plugin=ckan db clean --config=development.ini +#to initiate for first time instead of load from dump +#paster --plugin=ckan db init --config=development.in +#paster --plugin=ckan user add maxious password=snmc email=maxious@gmail.com +#paster --plugin=ckan sysadmin add maxious +#paster --plugin=ckan db dump dump.db + +#paster --plugin=ckan db load --config=development.ini dump.db +paster --plugin=ckan db load --config=development.ini dump.harvest.db +echo "create extension postgis;" | psql -d ckantest +#sleep 2 +paster --plugin=ckan search-index rebuild --config=development.ini +#rm -r /tmp/pairtree_* + --- /dev/null +++ b/ckanext/datagovau/__init__.py --- /dev/null +++ b/ckanext/datagovau/controller.py @@ -1,1 +1,84 @@ +import urllib +import json +from pprint import pprint +import logging +import ckan.logic as logic +import hashlib +import threading +from ckan.common import _, c, request, response +from pylons import config +from webob.multidict import UnicodeMultiDict +from paste.util.multidict import MultiDict +log = logging.getLogger(__name__) + +from ckan.controllers.api import ApiController + +class DGAApiController(ApiController): + + def _post_analytics(self,user,request_obj_type,request_function,request_id): + if (config.get('googleanalytics.id') != None): + data = urllib.urlencode({ + "v":1, + "tid":config.get('googleanalytics.id'), + "cid":hashlib.md5(user).hexdigest(), + "t":"event", + "dh":c.environ['HTTP_HOST'], + "dp":c.environ['PATH_INFO'], + "dr":c.environ.get('HTTP_REFERER',''), + "ec":"CKAN API Request", + "ea":request_obj_type+request_function, + "el":request_id, + }) + log.debug("Sending API Analytics Data: "+data) + # send analytics asynchronously + threading.Thread(target=urllib.urlopen,args=("http://www.google-analytics.com/collect", data)).start() + + + def action(self, logic_function, ver=None): + try: + function = logic.get_action(logic_function) + except Exception,e: + log.debug(e) + pass + try: + side_effect_free = getattr(function, 'side_effect_free', False) + request_data = self._get_request_data(try_url_params=side_effect_free) + if isinstance(request_data, dict): + id = request_data.get('id','') + if 'q' in request_data.keys(): + id = request_data['q'] + if 'query' in request_data.keys(): + id = request_data['query'] + self._post_analytics(c.user,logic_function,'', id) + except Exception,e: + print log.debug(e) + pass + + return ApiController.action(self,logic_function, ver) + + def list(self, ver=None, register=None, subregister=None, id=None): + self._post_analytics(c.user,register+("_"+str(subregister) if subregister else ""),"list",id) + return ApiController.list(self,ver, register, subregister, id) + def show(self, ver=None, register=None, subregister=None, id=None, id2=None): + self._post_analytics(c.user,register+("_"+str(subregister) if subregister else ""),"show",id) + return ApiController.show(self,ver, register, subregister, id,id2) + def update(self, ver=None, register=None, subregister=None, id=None, id2=None): + self._post_analytics(c.user,register+("_"+str(subregister) if subregister else ""),"update",id) + return ApiController.update(self,ver, register, subregister, id,id2) + def delete(self, ver=None, register=None, subregister=None, id=None, id2=None): + self._post_analytics(c.user,register+("_"+str(subregister) if subregister else ""),"delete",id) + return ApiController.delete(self,ver, register, subregister, id,id2) + def search(self, ver=None, register=None): + id = None + try: + params = MultiDict(self._get_search_params(request.params)) + if 'q' in params.keys(): + id = params['q'] + if 'query' in params.keys(): + id = params['query'] + except ValueError, e: + print str(e) + pass + self._post_analytics(c.user,register,"search",id) + --- /dev/null +++ b/ckanext/datagovau/plugin.py @@ -1,1 +1,214 @@ - +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 +from routes.mapper import SubMapper, Mapper as _Mapper + +from sqlalchemy import orm +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}) + +# 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.IRoutes, inherit=True) + + def before_map(self, map): + + # Helpers to reduce code clutter + GET = dict(method=['GET']) + PUT = dict(method=['PUT']) + POST = dict(method=['POST']) + DELETE = dict(method=['DELETE']) + GET_POST = dict(method=['GET', 'POST']) + # intercept API calls that we want to capture analytics on + register_list = [ + 'package', + 'dataset', + 'resource', + 'tag', + 'group', + 'related', + 'revision', + 'licenses', + 'rating', + 'user', + 'activity' + ] + register_list_str = '|'.join(register_list) + # /api ver 3 or none + with SubMapper(map, controller='ckanext.datagovau.controller:DGAApiController', path_prefix='/api{ver:/3|}', + ver='/3') as m: + m.connect('/action/{logic_function}', action='action', + conditions=GET_POST) + + # /api ver 1, 2, 3 or none + with SubMapper(map, controller='ckanext.datagovau.controller:DGAApiController', path_prefix='/api{ver:/1|/2|/3|}', + ver='/1') as m: + m.connect('/search/{register}', action='search') + + # /api/rest ver 1, 2 or none + with SubMapper(map, controller='ckanext.datagovau.controller:DGAApiController', path_prefix='/api{ver:/1|/2|}', + ver='/1', requirements=dict(register=register_list_str) + ) as m: + + m.connect('/rest/{register}', action='list', conditions=GET) + m.connect('/rest/{register}', action='create', conditions=POST) + m.connect('/rest/{register}/{id}', action='show', conditions=GET) + m.connect('/rest/{register}/{id}', action='update', conditions=PUT) + m.connect('/rest/{register}/{id}', action='update', conditions=POST) + m.connect('/rest/{register}/{id}', action='delete', conditions=DELETE) + + return map + + 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(DataGovAuPlugin, self).create_package_schema() + schema = self._modify_package_schema(schema) + return schema + + def update_package_schema(self): + schema = super(DataGovAuPlugin, self).update_package_schema() + schema = self._modify_package_schema(schema) + return schema + + def show_package_schema(self): + schema = super(DataGovAuPlugin, 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(DataGovAuPlugin, self).setup_template_variables( + context, data_dict) + + def new_template(self): + return super(DataGovAuPlugin, self).new_template() + + def read_template(self): + return super(DataGovAuPlugin, self).read_template() + + def edit_template(self): + return super(DataGovAuPlugin, self).edit_template() + + def search_template(self): + return super(DataGovAuPlugin, self).search_template() + + def history_template(self): + return super(DataGovAuPlugin, self).history_template() + + def package_form(self): + return super(DataGovAuPlugin, self).package_form() + + --- /dev/null +++ b/ckanext/datagovau/templates/base.html @@ -1,1 +1,7 @@ +{% ckan_extends %} + {% block meta %} + {{ super() }} +<meta name="google-site-verification" content="B8scmW2_LMm4IW_ogXK9lojznO57GBpYlWrFjfGz3X8" /> + {% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/dataviewer/base.html @@ -1,1 +1,11 @@ +{% ckan_extends %} +{% block scripts %} + {{ super() }} + <script> + preload_resource.url = preload_resource.url.replace("https:","").replace("http:",""); + preload_resource.original_url = preload_resource.original_url.replace("https:","").replace("http:",""); + </script> +{% endblock %} + + --- /dev/null +++ b/ckanext/datagovau/templates/dataviewer/snippets/data_preview.html @@ -1,1 +1,32 @@ +<div class="module-content ckanext-datapreview"> + {% if embed %} + {# images can be embedded directly #} + <img src="{{ resource_url }}"></img> + {% else %} + <div class="data-viewer-error js-hide"> + <p class="text-error"> + <i class="icon-info-sign"></i> + {{ _('This resource can not be previewed at the moment.') }} + <a href="#" data-toggle="collapse" data-target="#data-view-error"> + {{ _('Click here for more information.') }} + </a> + </p> + <p id="data-view-error" class="collapse"></p> + <p> + <a href="{{ raw_resource_url }}" class="btn btn-large resource-url-analytics" target="_blank"> + <i class="icon-large icon-download"></i> + {{ _('Download resource') }} + </a> + </p> + </div> + <iframe src="{{ resource_url }}" frameborder="0" width="100%" data-module="data-viewer"> + <p>{{ _('Your browser does not support iframes.') }}</p> + </iframe> + {% endif %} +</div> +<div class="embedhint" style="padding-left: 15px;"> +<h4>Embed this visualisation in your own website...</h4> +Copy the HTML in the box below and you can display this visualisation on your own website.<br/> +<textarea style="width:97%"><iframe src="{{ resource_url }}" frameborder="0" width="100%" height="600px"></iframe></textarea> +</div> --- /dev/null +++ b/ckanext/datagovau/templates/package/read.html @@ -1,1 +1,139 @@ +{% ckan_extends %} +{% block primary_content_inner %} +{{ super() }} +<div class="module-content"> + {{ h.disqus_comments() }} +</div> +{% endblock %} +{% block package_additional_info %} +<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/ + aglsterms: http://www.agls.gov.au/agls/terms/ + agentterms: http://www.agls.gov.au/agls/agentterms/ + availterms: http://www.agls.gov.au/agls/availterms/ + adminterms: http://www.agls.gov.au/agls/adminterms/ + dct: http://purl.org/dc/terms/"> + <h3>{{ _('Additional Info') }}</h3> + <table class="table table-striped table-bordered table-condensed"> + <thead> + <tr> + <th scope="col">{{ _('Field') }}</th> + <th scope="col">{{ _('Value') }}</th> + </tr> + </thead> + <tbody> + + {# Add our custom field to the dataset read page. #} + {% if pkg.get('metadata_created') %} + <tr> + <th scope="row" class="dataset-label">Date Published</th> + <td class="dataset-details" property="dct:issued">{{ pkg.metadata_created.split("T")[0] }}</td> + </tr> + {% endif %} + {% if pkg.get('metadata_updated') %} + <tr> + <th scope="row" class="dataset-label">Date Updated</th> + <td class="dataset-details" property="dct:updated">{{ pkg.metadata_updated.split("T")[0] }}</td> + </tr> + {% endif %} + {% if pkg.get('agency_program') %} + <tr> + <th scope="row" class="dataset-label">Agency Program</th> + <td class="dataset-details"> {{ pkg.agency_program }}</td> + </tr> + {% endif %} + {% if pkg.get('url') %} + <tr> + <th scope="row" class="dataset-label">{{ _('Source') }}</th> + <td class="dataset-details" property="dct:source">{{ h.link_to(pkg.get('url'), + pkg.get('url'), rel='dct:source', target='_blank') }} + </td> + </tr> + {% endif %} + + {% if pkg.get('contact_point') %} + <tr> + <th scope="row" class="dataset-label">Contact Point</th> + <td class="dataset-details" property="dcat:contactPoint"> {{ h.mail_to(email_address=pkg.contact_point, + name=pkg.contact_point) }}</td> + </tr> + {% endif %} + {% if pkg.get('spatial_coverage') %} + + <tr> + <th scope="row" class="dataset-label">Geospatial Coverage</th> + <td class="dataset-details" property="dct:spatial"> {{ pkg.spatial_coverage }}</td> + </tr> + {% endif %} + {% if pkg.get('granularity') %} + + <tr> + <th scope="row" class="dataset-label">Data Granularity</th> + <td class="dataset-details"> {{ pkg.granularity }}</td> + </tr> + {% endif %} + {% if pkg.get('jurisdiction') %} + <tr> + <th scope="row" class="dataset-label">Government Jurisdiction</th> + <td class="dataset-details" property="aglsterms:AglsJuri"> {{ pkg.jurisdiction }}</td> + </tr> + {% endif %} + {% if pkg.get('temporal_coverage') %} + <tr> + <th scope="row" class="dataset-label">Temporal Coverage</th> + <td class="dataset-details" property="dct:temporal"> {{ pkg.temporal_coverage }}</td> + </tr> + {% endif %} + {% if pkg.get('data_state') %} + <tr> + <th scope="row" class="dataset-label">Data State</th> + <td class="dataset-details"> {{ pkg.data_state }}</td> + </tr> + {% endif %} + {% if pkg.get('update_freq') %} + + <tr> + <th scope="row" class="dataset-label">Update Frequency</th> + <td class="dataset-details"> {{ pkg.update_freq }}</td> + </tr> + {% 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> + <th scope="row" class="dataset-label">Publisher/Agency</th> + <td class="dataset-details" property="dc:publisher">{{ c.pkg_dict['organization']['title']}} + </td> + </tr> + <tr> + <th scope="row" class="dataset-label">Type</th> + <td class="dataset-details" property="dc:type">Dataset</td> + </tr> + <tr> + <th scope="row" class="dataset-label">Language</th> + <td class="dataset-details" property="dc:language">English</td> + </tr> + + </tbody> + </table> +</section> + + +{% endblock %} + +{% block secondary_content %} + {{ super() }} + + {% set dataset_extent = h.get_pkg_dict_extra(c.pkg_dict, 'spatial', '') %} + {% if dataset_extent %} + {% snippet "spatial/snippets/dataset_map_sidebar.html", extent=dataset_extent %} + {% endif %} + +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/package/read.n3 @@ -1,1 +1,45 @@ +@prefix : <http://www.w3.org/2000/01/rdf-schema#> . +@prefix dcat: <http://www.w3.org/ns/dcat#> . +@prefix dct: <http://purl.org/dc/terms/> . +@prefix foaf: <http://xmlns.com/foaf/0.1/> . +@prefix owl: <http://www.w3.org/2002/07/owl#> . +@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> . +<${ 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']}"; + = <urn:uuid:${c.pkg_dict['id']}>; + foaf:homepage <http://127.0.0.1:5000/dataset/testt> . --- /dev/null +++ b/ckanext/datagovau/templates/package/read.rdf @@ -1,1 +1,133 @@ +<?xml version="1.0" encoding="utf-8"?> +<rdf:RDF + xmlns:py="http://genshi.edgewall.org/" + xmlns:foaf="http://xmlns.com/foaf/0.1/" + xmlns:owl="http://www.w3.org/2002/07/owl#" + xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:dcat="http://www.w3.org/ns/dcat#" + xmlns:dcam="http://purl.org/dc/dcam/" + xmlns:aglsterms="http://www.agls.gov.au/agls/terms/" + xmlns:agentterms="http://www.agls.gov.au/agls/agentterms/" + xmlns:availterms="http://www.agls.gov.au/agls/availterms/" + xmlns:adminterms="http://www.agls.gov.au/agls/adminterms/" + 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)}"> + <dct:identifier>${c.pkg_dict['name']}</dct:identifier> + <dct:title>${c.pkg_dict['title']}</dct:title> + <dct:landingPage + rdf:resource="${ h.url_for(controller='package',action='read',id=c.pkg_dict['name'], qualified=True) }"/> + <owl:sameAs rdf:resource="urn:uuid:${c.pkg_dict['id']}"/> + <dct:type>Dataset</dct:type> + <dct:description>${c.pkg_dict['notes']}</dct:description> + <dct:issued>${c.pkg_dict['metadata_created']}</dct:issued> + <dct:modified>${c.pkg_dict['metadata_modified']}</dct:modified> +<py:choose> + <py:when test="c.pkg_dict.get('license_url',None)"> + <dct:license rdf:resource="${c.pkg_dict['license_url']}"/> + <dct:rights rdf:resource="${c.pkg_dict['license_url']}"/> + </py:when> + <py:otherwise> + <dct:license>${c.pkg_dict['license_id']}</dct:license> + <dct:rights>"${c.pkg_dict['license_id']}"</dct:rights> + </py:otherwise> +</py:choose> + <py:for each="tag_dict in c.pkg_dict.get('tags',[])"> + <dcat:keyword>${ tag_dict["name"] }</dcat:keyword> + </py:for> + + + <py:for each="rsc_dict in c.pkg_dict['resources']"> + <dcat:distribution> + <dcat:Distribution> + <dct:title>${rsc_dict.get('name')}</dct:title> + <owl:sameAs rdf:resource="urn:uuid:${rsc_dict.get('id')}"/> + <dct:description>${rsc_dict.get('description')}</dct:description> + <dcat:accessURL rdf:resource="${ rsc_dict.get('url') }"/> + <dct:created>${rsc_dict.get('created')}</dct:created> + <dct:modified>${rsc_dict.get('revision_timestamp')}</dct:modified> + <dcat:byteSize py:if="rsc_dict.get('size')">${rsc_dict.get('size')}</dcat:byteSize> + <dcat:mediaType py:if="rsc_dict.get('mimetype')">${rsc_dict.get('mimetype')}</dcat:mediaType> + <dct:extent py:if="rsc_dict.get('size')">${rsc_dict.get('size')} bytes</dct:extent> + <dct:format py:if="rsc_dict.get('format')"> + <dct:IMT> + <rdf:value>${rsc_dict.get('format')}</rdf:value> + <rdfs:label>${rsc_dict.get('format')}</rdfs:label> + </dct:IMT> + </dct:format> + <dct:title py:if="rsc_dict.get('name')">${rsc_dict.get('name')}</dct:title> + </dcat:Distribution> + </dcat:distribution> + </py:for> + + + + <dct:publisher py:if="c.pkg_dict.get('organization', None)"> + <rdf:Description> + <foaf:name>${ c.pkg_dict['organization']['title'] }</foaf:name> + </rdf:Description> + </dct:publisher> + <dct:creator py:if="c.pkg_dict.get('organization', None)"> + <rdf:Description> + <foaf:name>${ c.pkg_dict['organization']['title'] }</foaf:name> + </rdf:Description> + </dct:creator> + <dct:contributor> + <rdf:Description> + <foaf:name>${h.get_last_active_user(c.pkg_dict['id'])["display_name"]}</foaf:name> + <foaf:mbox py:if="h.get_last_active_user(c.pkg_dict['id']).get('email', None)" + rdf:resource="mailto:${h.get_last_active_user(c.pkg_dict['id'])['email']}"/> + </rdf:Description> + </dct:contributor> + + <py:for each="extra_dict in c.pkg_dict.get('extras',[])"> + <dct:relation> + <rdf:Description> + <rdfs:label>${extra_dict.get('key','')}</rdfs:label> + <rdf:value>${extra_dict.get('value','')}</rdf:value> + </rdf:Description> + </dct:relation> + </py:for> + <dct:language>en</dct:language> + <foaf:homepage + rdf:resource="${ h.url_for(controller='package',action='read',id=c.pkg_dict['name'], qualified=True)}"/> + <dcat:contactPoint py:if="c.pkg_dict.get('contact_point')">${c.pkg_dict.contact_point }</dcat:contactPoint> +<py:choose> + <py:when test="c.pkg_dict.get('spatial',None)"> + <dct:spatial py:if="c.pkg_dict.get('spatial')">${ c.pkg_dict.spatial }</dct:spatial> + </py:when> + <py:otherwise> + <dct:spatial py:if="c.pkg_dict.get('spatial_coverage')">${ c.pkg_dict.spatial_coverage }</dct:spatial> + </py:otherwise> +</py:choose> + <aglsterms:AglsJuri py:if="c.pkg_dict.get('jurisdiction')">${ c.pkg_dict.jurisdiction }</aglsterms:AglsJuri> + <dct:temporal py:if="c.pkg_dict.get('temporal_coverage')">${ c.pkg_dict.get('temporal_coverage') }</dct:temporal> + <dct:relation py:if="c.pkg_dict.get('data_state')"> + <rdf:Description> + <rdfs:label>Data State</rdfs:label> + <rdf:value>${ c.pkg_dict.get('data_state') }</rdf:value> + </rdf:Description> + </dct:relation> + <dct:relation py:if="c.pkg_dict.get('update_freq')"> + <rdf:Description> + <rdfs:label>Update Frequency</rdfs:label> + <rdf:value>${ c.pkg_dict.get('update_freq') }</rdf:value> + </rdf:Description> + </dct:relation> + <dct:relation py:if="c.pkg_dict.get('agency_program')"> + <rdf:Description> + <rdfs:label>Agency Program</rdfs:label> + <rdf:value>${ c.pkg_dict.get('agency_program') }</rdf:value> + </rdf:Description> + </dct:relation> + <dct:relation py:if="c.pkg_dict.get('granularity')"> + <rdf:Description> + <rdfs:label>Data Granularity</rdfs:label> + <rdf:value>${ c.pkg_dict.get('granularity') }</rdf:value> + </rdf:Description> + </dct:relation> + </dcat:Dataset> +</rdf:RDF> + --- a/ckanext/datagovau/templates/package/read_base.html +++ b/ckanext/datagovau/templates/package/read_base.html @@ -1,15 +1,47 @@ {% ckan_extends %} - -{% block subtitle %}{{ pkg.title or pkg.name }}{% endblock %} {% block links -%} {{ super() }} -<link rel="lol" type="test"/> +<link rel="schema.DCTERMS" href="http://purl.org/dc/terms/" /> +<link rel="schema.AGLSTERMS" href="http://www.agls.gov.au/agls/terms/" /> + {% endblock -%} {% block head_extras -%} {{ super() }} -<meta property="og:gon" content="lol"> +<meta name="DCTERMS.Language" scheme="RFC3066" content="en" /> +<meta name="DCTERMS.Type" scheme="AGLSTERMS.Document" content="dataset" /> +<meta name="DCTERMS.Creator" scheme="AGLSTERMS.AglsAgent" content="{{ pkg['organization']['title'] }}" /> +<meta name="DCTERMS.Modified" scheme="DCTERMS.ISO8601" content="{{pkg['metadata_modified']}}" /> +<meta name="DCTERMS.Published" scheme="DCTERMS.ISO8601" content="{{pkg['metadata_created']}}" /> +<meta name="DCTERMS.Source.URI" content="{{pkg.url}}" /> +<meta name="DCTERMS.License" content="{{pkg['license_url']}}" /> +<meta name="DCTERMS.Coverage.Temporal" content="{{pkg.temporal_coverage}}" /> +<meta name="DCTERMS.Coverage.Spatial" content="{{pkg.spatial_coverage}}" /> +<meta name="AGLSTERMS.Jurisdiction" scheme="AGLSTERMS.AglsJuri" content="{{pkg.jurisdiction}}" /> +<meta name="DCAT.Theme" scheme="VO" content="{% for x in pkg.groups %}{{x['title']}},{% endfor %}" /> +<meta name="DCTERMS.Identifier" content="{{h.url_for(controller='package',action='read',id=c.pkg_dict['name'], qualified=True)}}" /> +<meta name="DCTERMS.Title" content="{{pkg['title']}}" /> +<meta name="DCTERMS.Description" scheme="" content="{{pkg['notes']}}" /> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> + {% endblock -%} +{% block package_info %} +<div class="module context-info"> + <div class="module-content"> + <h1 class="heading" property="dc:title">{{ pkg.title or pkg.name }}</h1> + <div class="nums"> + <dl> + <dt>{{ _('Followers') }}</dt> + <dd>{{ h.SI_number_span(h.get_action('dataset_follower_count', {'id': pkg.id})) }}</dd> + </dl> + </div> + <div class="follow_button"> + {{ h.follow_button('dataset', pkg.name) }} + </div> + </div> +</div> +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/package/resource_read.html @@ -1,1 +1,35 @@ +{% ckan_extends %} +{% block links -%} +{{ super() }} +<link rel="schema.DCTERMS" href="http://purl.org/dc/terms/" /> +<link rel="schema.AGLSTERMS" href="http://www.agls.gov.au/agls/terms/" /> + +{% endblock -%} + +{% block head_extras -%} +{{ super() }} +<meta name="DCTERMS.Language" scheme="RFC3066" content="en" /> +<meta name="DCTERMS.Type" scheme="AGLSTERMS.Document" content="dataset" /> +<meta name="DCTERMS.Creator" scheme="AGLSTERMS.AglsAgent" content="{{ pkg['organization']['title'] }}" /> +<meta name="DCTERMS.Modified" scheme="DCTERMS.ISO8601" content="{{res['revision_timestamp']}}" /> +<meta name="DCTERMS.Published" scheme="DCTERMS.ISO8601" content="{{res['created']}}" /> +<meta name="DCTERMS.Source.URI" content="{{pkg.url}}" /> +<meta name="DCTERMS.License" content="{{pkg['license_url']}}" /> +<meta name="DCTERMS.Coverage.Temporal" content="{{pkg.temporal_coverage}}" /> +<meta name="DCTERMS.Coverage.Spatial" content="{{pkg.spatial_coverage}}" /> +<meta name="AGLSTERMS.Jurisdiction" scheme="AGLSTERMS.AglsJuri" content="{{pkg.jurisdiction}}" /> +<meta name="DCAT.Theme" scheme="VO" content="{% for x in pkg.groups %}{{x['title']}},{% endfor %}" /> +<meta name="DCAT.byteSize" content="{{res.get('size')}}" /> +<meta name="DCAT.mediaType" content="{{res.get('mimetype')}}" /> +<meta name="DCTERMS.Identifier" content="{{res.get('url')}}" /> +<meta name="DCTERMS.Title" content="{{res['name']}}" /> +<meta name="DCTERMS.Description" scheme="" content="{{res['description']}}" /> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /> +<meta name="DCTERMS.Format" content="{{res.format}}" /> +<meta name="DCTERMS.File.Size" content="{{res.size}}" /> + +{% endblock -%} + + + --- /dev/null +++ b/ckanext/datagovau/templates/package/search.html @@ -1,1 +1,7 @@ +{% ckan_extends %} +{% block secondary_content %} +{{ super() }} + {% snippet "spatial/snippets/spatial_query.html", default_extent="[[-11, 114], [-42, 154]]" %} +{% 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 %} +<div class="control-group"> + {% set error = errors.license_id %} + <label class="control-label" for="field-license">{{ _("License") }}</label> + <div class="controls"> + <select id="field-license" name="license_id" data-module="autocomplete"> + {% for license_desc, license_id in licenses|sort if license_desc %} + {# Make cc-by the default value for data.gov.au #} + <option value="{{ license_id }}" {% if data.get('license_id', 'cc-by') == license_id %}selected="selected"{% endif %}>{{ license_desc }}</option> + {% endfor %} + </select> + {% if error %}<span class="error-block">{{ error }}</span>{% endif %} + <span class="info-block info-inline"> + <i class="icon-info-sign"></i> + {% trans %} + License definitions and additional information can be found + at <a href="http://opendefinition.org/licenses/">opendefinition.org</a> + {% endtrans %} + </span> + </div> +</div> +{% 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 %} +<div class="control-group"> + <label class="control-label">Groups/Themes</label> + <div class="controls"> + {% for group in data.groups %} + <label class="checkbox" for="field-group-{{ loop.index0 }}"> + <input id="field-group-{{ loop.index0 }}" type="checkbox" name="groups__{{ loop.index0 }}__id" value="{{ group.id }}" checked="checked" /> + {{ group.title }} + </label> + {% endfor %} + </div> +</div> +{% 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) %} +<li class="resource-item" vocab="http://www.w3.org/ns/dcat#" + typeof="Distribution"> + {% block resource_item_title %} + <a class="heading" href="{{ url }}" title="{{ res.name or res.description }}" property="title"> + {{ h.resource_display_name(res) | truncate(50) }}<span class="format-label" property="dc:format" data-format="{{ res.format.lower() or 'data' }}">{{ res.format }}</span> + {{ h.popular('views', res.tracking_summary.total, min=10) }} + </a> + {% endblock %} + <p class="description" property="description"> + {% if res.description %} + {{ h.markdown_extract(res.description, extract_length=80) }} + {% else %} + <span class="empty">{{ _('No description for this resource') }}</span> + {% endif %} + </p> + {% block resource_item_explore %} + <div class="dropdown btn-group"> + <a href="#" class="btn btn-primary dropdown-toggle" data-toggle="dropdown"> + <i class="icon-share-alt"></i> + {{ _('Explore') }} + <span class="caret"></span> + </a> + <ul class="dropdown-menu"> + {% block resource_item_explore_links %} + <li> + <a href="{{ url }}" property="accessURL"> + {% if res.can_be_previewed %} + <i class="icon-bar-chart"></i> + {{ _('Preview') }} + {% else %} + <i class="icon-info-sign"></i> + {{ _('More information') }} + {% endif %} + </a> + </li> + <li> + <a href="{{ res.url }}" class="resource-url-analytics" target="_blank" property="accessURL"> + {% if res.can_be_previewed %} + <i class="icon-download"></i> + {{ _('Download') }} + {% else %} + <i class="icon-external-link"></i> + {{ _('Go to resource') }} + {% endif %} + </a> + </li> + {% endblock %} + </ul> + </div> + {% endblock %} +</li> --- /dev/null +++ b/ckanext/datagovau/templates/user/dashboard_datasets.html @@ -1,1 +1,16 @@ +{% ckan_extends %} +{% block primary_content_inner %} + <h2 class="page-heading">{{ _('My Datasets') }}</h2> + {% if h.get_user_datasets(c.user_dict) %} + {% snippet 'snippets/package_list.html', packages=h.get_user_datasets(c.user_dict) %} + {% else %} + <p class="empty"> + You haven\'t created/edited any datasets. + {% if h.check_access('package_create') %} + {% link_for _('Create one now?'), controller='package', action='new' %} + {% endif %} + </p> + {% endif %} +{% endblock %} + --- /dev/null +++ b/ckanext/datagovau/templates/user/read.html @@ -1,1 +1,29 @@ +{% ckan_extends %} + +{% block primary_content_inner %} + <h2 class="hide-heading"> + {% block page_heading %}{{ _('Datasets') }}{% endblock %} + </h2> + {% 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 %} + <p class="empty"> + {{ _('You haven\'t created any datasets.') }} + {% if h.check_access('package_create') %} + {% link_for _('Create one now?'), controller='package', action='new' %} + {% endif %} + </p> + {% else %} + <p class="empty"> + {{ _('User hasn\'t created any datasets.') }} + </p> + {% 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/setup.py +++ b/setup.py @@ -21,7 +21,7 @@ entry_points=\ """ [ckan.plugins] - datagovau=ckanext.datagovau.plugin:ExampleIDatasetFormPlugin + datagovau=ckanext.datagovau.plugin:DataGovAuPlugin """, )