CKAN: Ticket Query

#2732: New file upload functionality

ross — Mon, 23 Jul 2012 15:53:09 GMT

We should simplify upload and storage of files, initially only to local storage with archiver eventually being fixed to archive data externally. WIP pad is http://ckan.okfnpad.org/uploads

Simplifying uploads

Currently uploads are too painful/difficult/fiddly to use and/or configure. We want to simplify uploads so that they are done directly to the CKAN server, without support for remote services (S3 etc) and/or the dependencies it introduces.

We want to fix:

File uploads themselves
Storage of uploaded files
Notification of the upload to other components

File uploads

Things file upload should do:

Allow sysadmin to disable
Allow auth'ed users to upload
Store whatever they send on disk, and store DB entry linking the file to the person
When creating the resource, the user should be able to choose from all of the files they have uploaded but not yet associated with a resource. This will allow for bulk upload and then a delayed association. Whenver a user creates a resource they either upload a file now, or see previously uploaded files.

Can we do the upload asynchronously and then associate the
uploaded key with the resource before the save ? What happens
if the user tries to submit before asymc upload finishes ? Should
we delay them?

The upload workflow should look like...

File upload should be a straightforward file upload with normal auth checks and normal processing of the posted data.
1. When called via ajax then the ID of the newly created file should be returned,
2. When called via WUI then it should also be given the url to redirect to after the file upload has been handled - the id will be passed as a query param.
The resource save should check whether it has a file id and in that case updates the file object to point to the resource.

This should enable:

Separate file upload into a user's temporary store, either individually or as a batch.
Creating resources and simply choosing from previously uploaded, unassigned files
Adding files/data to a resource after the fact.

File storage

File storage should be local to the CKAN install, and not a remote service. Any archiving to remove storage providers should be outside of the main request.

File storage should:

allow moving data, a sysadmin should be able to move the storage root and change configuration and have the system continue running (i.e. don't store absolute paths).
provide maintainability, it should be easy to determine which old files are not associated with resources and thus can be cleaned up.
allow for collection of information (i.e. estimate of storate space used)
check whether there is enough space and handling the conequences cleanly
ensure files to be written only underneath its own root folder, checks should be made after any path generation that the file begins with the location of the file storage.
Have a configurable maximum accepted blob size during upload.
Should store what meta-data was provided with the upload, such as mimetype.

Somewhere in the DB we should store ...

Column	Notes
id	An identifier
owner	The owning user, who uploaded the file
path	The path (from the 'storage root') to the file
size	The size in bytes of the file on disk
mimetype	The mimetype of the file, as provided by the uploader
upload_date	When the data was uploaded
resource	The ID of the resource it belongs to. A unidirectional relationship.
archived_url	The URL where this file has been archived

Generating paths should try and separate the files, perhaps based on username of the owner, or some other mechanism to avoid a single folder full of files.

Notifications

We need to make sure that it is possible to notify other components within the system that an upload has taken place, or at least make it easy for them to be notified. The primary use case for this is to notify the component that will translate/upload certain formats to the data store.

We could do this based on the post-upload update to the file model (i.e. when we record the total received size of the file).

#2686: enabling datastore & data API breaks recline

shevski — Tue, 17 Jul 2012 09:06:51 GMT

First I noticed that the gold prices dataset preview was not displaying & has data API enabled Secondly I tried enabling datastore for http://datahub.io/dataset/adur_district_spending/resource/281dffa6-ea9b-4446-be41-05dced06591f and after I saved the preview no longer worked. Unticking the datastore & data api checkbox brought it back

Is this a known issue?

#2607: 'Upload a file' appears on resource form when storage not enabled

seanh — Wed, 27 Jun 2012 13:30:08 GMT

if the user tries to upload a file they will get "Failed to get credentials for storage upload. Upload cannot proceed"

Maybe add a test for it this time, this bug has appeared and reappeared before

#2590: Publisher dashboard

ross — Mon, 25 Jun 2012 10:03:37 GMT

Need proper user stories but ...

Publisher admins/editors may need a more useful group read page showing things like:

The current search

Recent activity

People within the group

Followers

Others?

#2554: Research Virtuoso cartridges

ross — Mon, 18 Jun 2012 13:37:25 GMT

Look into writing a cartridge for importing CKAN data into a Virtuoso quadstore

http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSponger#How Does It Work?

#2546: ODS Managing homepage content

ross — Mon, 18 Jun 2012 10:54:02 GMT

Requirements

Require the ability for users to control some level of content that is visible on the home page of their ODS installation. This may be through RSS/Atom feeds (see #2234) or another mechanism but should result in admins being able to change blocks of text on their homepage.

This should not be configuration, but accessible through WUI.

Interface

None

User Stories

As a system administrator I want to have control over content displayed on the front page beyond featured/popular items.

As a system administrator I don't want to manage content through having to write an extension.

Tasks

[ ] Analysis

Estimates

#2513: Dataproxy should not default to utf8

ross — Wed, 13 Jun 2012 08:23:40 GMT

Unless explicitly told by the source web server the dataproxy should not assume that the content it has can be encoded as UTF-8. Even though the chars from 128 - 255 overlap an attempt to decode some byte array as utf8 will fail whenever a latin1 char whose bitpattern has the MSB set.

This will mean that the UTF8Recoder can be more rigid in its acceptance of data, Postel aside.

#2284: Local queries/views/viz in Related stuff.

ross — Thu, 12 Apr 2012 08:18:20 GMT

From #2204

not sure how much we have thought through using this for storing queries / views / visualizations coming from our data viewer. In particular, wonder if this necessitates some kind of support for arbitrary json data ...

### Comments

In the simplest form, right now all I need to store is store the url to the resource plus hashbang config for recline. That would be super easy ...

#2197: Storage Metadata API: add/update not working with local file storage (Pairtree)

zydio — Tue, 28 Feb 2012 09:29:37 GMT

If OFS is configured with Pairtree to use a local file storage, all POST requests to add/update metadata ( /api/storage/metadata/{label} ) will fail.

This is due to the use of BotoOFS specific private methods in StorageAPIController.set_metadata(), eg: self.ofs._require_bucket(bucket), self.ofs._get_key(b, label), self.ofs._update_key_metadata(k, metadata) ... those methods can't be found in POTFS and this causes errors. The API should use only OFSInterface methods, or should conditionally make calls based off the actual type of self.ofs.

PS: I did set "ckan" as "Component" in the ticket because storage has been integrated back into the core in CKAN 1.6

#1832: dataset purge API

dread — Fri, 24 Feb 2012 10:02:25 GMT

Purging datasets (deleting them fully, not just changing the state to 'deleted') is important for users testing dataset creation over the API on a test CKAN instance.

Without this, they need to resort to more difficult methods such as:

cleaning and reloading the database
setting the test datasets to state 'deleted' and also appending a suffix '_00' and incrementing the number until there is no clash of names.

Requested for NHSIC.

Implementation

This could slot into the Action API.
Of course we would need to ensure the user's had been given the specific right to purge.
I suggest we log the full details of the dataset being purged.

#1831: Login with email address

ross — Fri, 24 Feb 2012 08:58:26 GMT

Users should be able to log in using either their username, or their email address, both of which are unique.

Will require a change to UsernamePasswordAuthenticator? in ckan.lib.authenticator.py and possible a useful User.by_email in the user model if it doesn't already exist.

#1684: Remove all config from ckanext-archiver

ross — Thu, 19 Jan 2012 14:37:01 GMT

ckanext-archiver currently has a settings file (and a default) and it should be passed in all relevant information from the context.

Remove all settings (ARCHIVE_DIR and MAX_CONTENT_LENGTH and others) and pass them in from CKAN.

#1661: Wrong Routes version installed by CKAN package

dread — Mon, 16 Jan 2012 12:47:41 GMT

Jaakko Louhio reported that the wrong Routes version got installed during CKAN's package install.

He is using Ubuntu 10.04 and he believes it install Routes 1.12.3 instead of what we use which is 1.11.

#1652: How we intergrate with Drupal Multiligual?

ross — Mon, 16 Jan 2012 10:31:34 GMT

Analysis of how/where we can integrate with Drupal Multilingual

Is it likely to access CKAN via /en/data/... or /data/en/... (not sure, probably former) and we need to make sure that it ends up at /en/...

Check with Ian for other issues.

#1571: [super] Issues Extension

jilly mathews — Mon, 19 Dec 2011 11:30:25 GMT

"Proper" issues extension.

Etherpad: http://ckan.okfnpad.org/issues
Code: https://github.com/okfn/ckanext-issues

Overview

This would be an extension and improvement of existing todo extension - #842 (https://github.com/okfn/ckanext-issues)
- Current extension does work but lacks polish
- Should we polish or do significant improvements?
Functionality - see etherpad

Steps

~~(Rename todo(s) -> issue(s) in existing extension)~~

#1550: Allow simple auth via the API

ross — Fri, 16 Dec 2011 15:29:29 GMT

It should be possible to pass userid/username and api key and obtain a response from CKAN for external services that use CKAN auth. Those services shouldn't be talking to the DB directly.

#1507: Minor fixes to dataset add on Group edit form - 0.5d

rgrp — Mon, 05 Dec 2011 12:33:49 GMT

Group edit dataset add form needs some work

Dataset name is not cleared when you add
No way to remove item from list of datasets to be added if I make a mistake
(2nd Apr 2012) It now seems that option to add multiple datasets at once has disappeared (perhaps during the CSS/HTML refactor ...)

#1489: Updating example theme/extension

dread — Thu, 24 Nov 2011 12:32:00 GMT

ckanext-example needs updating for CKAN 1.5:

theme changes
new forms

About: 'ckanext-exampletheme' was created in Spring 2011 as an example CKAN extension that showed how to customise the look & operation of CKAN. This moved to github and renamed 'ckanext-example'.

#1447: disk space leakage

dread — Mon, 07 Nov 2011 11:54:03 GMT

Periodically we see some CKAN servers fall over because they run out of disk space. We need to find out if there is a common cause and fix it.

One problem in the past has been file handles running out when creating lots of tiny files in the data directory.

Another problem has been several enourmous backups being created every day - pdeu on eu25.

#1393: Don't skip search tests

dread — Thu, 13 Oct 2011 11:30:53 GMT

Now we don't use postgres search, all the tests involving search now don't need to be skipped when running on sqlite. Should help coders spot earlier if these tests break.

#1358: Generate configuration documentation automatically from the deployment_ini_tmpl file

rgrp — Mon, 26 Sep 2011 22:32:30 GMT

At the moment documentation of config options is duplicated between source (deployment_ini_tmpl in ckan/config which is used to generate user ini file) and the docs.

Suggest we write a script that automatedly generates reference documentation for the config from the source.

May be obsoleted by #277 (some config in db)

#1317: password reset - improve user search

dread — Wed, 07 Sep 2011 17:12:19 GMT

In password reset, it gets confused if you have two similar users. This is because with the string the user provides, it searches several fields, not just name but also fullname and email address, allowing you to search for these. But only name is unique.

Specific problem: Ira searches for "Irina" then it finds both: <User name=irina fullname=Irina email=irina.bolychevsky@okfn.org ] and <User name=shevski fullname=Ira email=> (I think)

Maybe need to choose which field it searches?

#1314: ckanclient search - generator improvements

dread — Wed, 07 Sep 2011 11:36:50 GMT

Apparently the search generator always makes two requests, even if you don't want to see the search results, which might be slow. Can this be optimised?

Maybe we should also provide a second search function that doesn't use the generator - the original simple search function (that leaves the user to deal with limit & offset).

#1287: NAVL validation errors - Junk fields should be listed explicitly

dread — Wed, 24 Aug 2011 16:25:02 GMT

When you create a package, but specify a key that is not allowed (e.g. 'relationships') then you get error message:

{"__junk": ["The input field __junk was not expected."]}

It should mention the actual key which is not expected. e.g.

{"relationships": ["The input field 'relationships' was not expected."]}

Kindly said that James' version of NAVL was better in this respect, so this might be best solved by moving to that.

#1255: Drupal consistancy checks.

kindly — Mon, 01 Aug 2011 17:32:48 GMT

Make a robust way to make sure the drupal database is consistent with the ckan data.

#1240: [super] API v4

rgrp — Sun, 24 Jul 2011 16:41:00 GMT

(Just creating this ticket as somewhere to keep notes)

Decide on REST api versus action API
- Do we want to support both?
Tidying
- Unify on /api/v{version num}/... structure (do we want a default option that points to current default? e.g. /api/default/ ...)
- extras merged into normal field list in package
- Get rid of /rest/ so just have api/v1/package
- Get rid of separation of search api from 'rest' api
  - Propose that GET on REST index is search e.g. /package/?q=...
    - This is also resolves issue whereby GET at root returns whole package set (a *bad* idea) as this would now become the matchall search query (with a default limit on items returned)
Resource read/write in API (separate from package)
- Does this need authorization work?
user/account API - read/write
Remove autocomplete -- can just use search
- Do not worry about backwards compat as should only be used in our js (if others using it too bad!)

#1168: Test system for deb packaging

dread — Thu, 26 May 2011 20:33:14 GMT

Get buildbot to:

build the deb packages
install them into a fresh virtual machine
run smoke tests on the installed ckan

#1062: Data preview encoding error

sebbacon — Tue, 29 Mar 2011 10:55:43 GMT

The preview of "Species Misc Turtle Download" at http://ckan.net/package/taxonconcept results in the following error:

Unable to Preview - Had an error from dataproxy: Data Transformation Error (Data transformation failed. Reason: 'utf8' codec can't decode byte 0x8b in position 1: unexpected code byte

#1041: Start Using the CKAN Wiki for Tutorial-style documentation

thejimmyg — Wed, 16 Mar 2011 14:11:55 GMT

For example, I will document the following:

A specific guide on using mercurial when working with our branching and merging policy
- DONE - http://wiki.ckan.net/Becoming_a_CKAN_Developer
Policy document on how we use tickets, plan sprints and make releases
- DONE - http://wiki.ckan.net/Becoming_a_CKAN_Developer
How to package software as .deb file for project deployment

I'd love if someone else would write:

An authorisation tutorial covering the core model, the command line tools and examples of every possible way of using the system
A HOWTO guide with screenshots for adding a package

#979: Edit Resource extras in the API

dread — Fri, 11 Feb 2011 13:09:37 GMT

Follows on from #826. We can now edit resource extras in the WUI (to some extent - see #978 for remaining issues) and we can view resource extras in the API, but we can't yet edit them in the API.

#765: Read-only mode - API usage

dread — Tue, 26 Oct 2010 11:18:17 GMT

All writes to the API are captured and you are returned an error explaining the reason.

Possible errors:

503 temporary maintenance
403 forbidden (if server if permanently read-only)

#277: Set some config options / settings in WUI (extension)

dread — Mon, 22 Mar 2010 16:21:01 GMT

Use case

As a ckan administrator I want to easily change options about the CKAN install.

Implementation

Settings to be in DB

Suggested:

## Title of site (using in several places including templates and <title> tag
ckan.site_title = CKAN
## Logo image to use (replaces site_title string on front page if defined)
ckan.site_logo = http://assets.okfn.org/p/ckan/img/ckan_logo_box.png
## Site tagline / description (used on front page)
ckan.site_description =
## Used in creating some absolute urls (such as rss feeds, css files) and
## dump filenames
ckan.site_url =
## Favicon (default is the CKAN software favicon)
ckan.favicon = http://assets.okfn.org/p/ckan/img/ckan.ico
## 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 = ckan.net
## 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 </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 =

NB: these will still need to be stored somewhere for loading on initialization. do this in db init function ...

Settings / Options / KeyValues? Table

Columns:

[namespace]: ? only if KeyValues? (for settings this would then always be settings)
key
label
value (json)
type (e.g. date and to specify in advance what type should be)
description
tags: ?? (for grouping ...)

Loading settings from DB

Do this in ckan/config/environment.py

WUI

/ckan-admin/settings
Show label, plus description plus text field

Depends

Would be part of ckan-admin section and hence build on ticket:833 (Administrative dashboard)

#256: Package relationships - 3. Edit in WUI

dread — Tue, 23 Feb 2010 12:36:01 GMT

WUI:

Editable as part of package or separately? (e.g. like authz)
Do we normalize to only one type name of the pair?
Do we allow create of relationship from both ends (e.g. only from dependency to dependent or either way?)

#253: Package relationships

dread — Mon, 22 Feb 2010 16:05:21 GMT

Overview

Functionality to formally associate packages. We see a need for specific parent-child, inheriting or dependency relations. Not only should this help navigation between packages in the web interface, but it also provides a mechanism to automatically pull dependencies when downloading a data package, in a similar manner as we see in software package management.

Examples

There are 27 packages in data.gov.uk to do with the Data4NR's Health Poverty Index. There is currently no common link between these, unless you search for 'HPI' (which also brings up House Price Index), or look under tag 'health' (which also has 600 other results). There should be a link on each HPI package page to navigate to the other 'sibling' HPI packages, and to a 'root' package that has info about the set. This could be partially achieved using the existing tag or group concepts, but a more explicit/official/obvious marking of their relationship could be beneficial.

In ckan.net is freedict, a collection of translation dictionaries. You could make each dictionary a child package and use this system. But it would probably be better to make each dictionary a different resource in the same package. (There are other ideas to denote a resource as the data making up a 'portion' of package, or a 'whole' of the package, to help people downloading datasets in the software package style.)

OSM has had some Naptan data imported (bus stops), with special permission - i.e. a more liberal license. It would be useful to show this link on both OSM and Naptan packages in CKAN: OSM 'derives from' Naptan with a comment about the license change. I'm not sure this is useful to an automatic download or use of these datasets, but may aid exploration on the CKAN website and understanding the provenance of the bus stop data on it.

IPCC collection of data linked / mirrored. Not sure if there are useful relationships here?

Dracos gets postbox locations from crowd sourcing and OSM. We could say Dracos 'derives from' OSM.

See more examples discussed here: http://trac.ckan.org/ticket/253

Implementation

This is split into four tickets:

Model: ticket:254
Read in WUI: ticket:255
Edit in WUI: ticket:256
API: ticket:257

No need for write access to be provided API for the moment.

This ticket also encompasses ticket:169 (Package derivations) and ticket:176 (Package dependencies).

#143: Most active users listed on homepage

dread — Thu, 08 Oct 2009 13:59:33 GMT

Display league of users' recent activity on homepage.

#2323: Auto-complete in organizations

ross — Tue, 24 Apr 2012 13:32:34 GMT

Apparently auto-complete in Organizations may not work. Check and fix.

See https://github.com/okfn/ckan/commit/5eca7d5e37c0ef392b768b8b3768b2c3f93448b5

#1801: No links to password reset

dread — Thu, 16 Feb 2012 15:14:50 GMT

You can reset your password (#1186) but you have to know the URI (/user/reset) - there is no link to this page!

#1780: Api to add translations.

kindly — Mon, 06 Feb 2012 17:21:48 GMT

Add api to translation to the term_translation table.

add to logic 2d
test 2d

#1746: Activity streams pagination

seanh — Sun, 05 Feb 2012 12:54:48 GMT

Currently user, package and group activity streams only return the most recent 15 activities, even though all activities are kept in the db. Do we want to add pagination - to both the API and the HTML pages - to support retrieving older activities?

#1685: Move archiver download function to core

ross — Thu, 19 Jan 2012 14:42:50 GMT

Archiver is included in some places just for access to download(), we should move this to lib in core.

#1648: Clarify that additional info = extra fields + add guidance

shevski — Mon, 16 Jan 2012 00:47:23 GMT

Super ticket: #1506

Need to decide which term to use and then have the same for editing as well as viewing a dataset.

In creating/editing a dataset, want more explanation about adding extra fields (probably as a tooltip or similar).. i.e. that this let's you add extra custom metadata such as 'location: uk' which is then searchable etc

#1579: Full text search in Webstore

ross — Tue, 20 Dec 2011 12:54:58 GMT

We should allow full text search within databases for individual databases, although we may want to wait for any pending ports to postgres.

#1551: CKAN auth for webstore changes

ross — Fri, 16 Dec 2011 15:39:26 GMT

Webstore should use auth api ( #1550 ) for authenticating users accessing webstore rather than talking directly to the CKAN database. We also need it to suppose /user/ urls and /userid/ for accessing databases.

#1549: [super] Short link tool

ross — Fri, 16 Dec 2011 12:03:18 GMT

It would be great to have a CKAN extension that allowed users (or CKAN itself) to generate short links to other URIs (both internal and external). Once created, shortlinks made by CKAN should be changeable. This would allow uploaded content to be moved without the user's link changing at all. The tool itself might also be of use as a general link-shortener to users other than the CKAN system itself.

Another useful feature would be for this to also collect some simple analytics such as the referrer and client IP for future reference. I'm not yet sure what we would do with the analytics other than some sort of popularity metric.

Questions:

Core, or Extension, or Self-hosted?

#1533: Make sure ckanext-wordpresser works on CKAN 1.5.1

amercader — Wed, 07 Dec 2011 17:07:40 GMT

Superceded by #2234

Super ticket: #1508

Etherpad: http://ckan.okfnpad.org/wordpresser

The wordpresser extension does not work with ckan 1.5.1. The wordpress page is not loaded.

Looks like this changeset may be involved https://github.com/okfn/ckanext-wordpresser/commit/0efa0649896a7339865f178a302be639ddc561e1

I think that even before that changeset, the page was shown without any margins.

In any case, the extension seems to be too sensible to changes in the ckan layout so perhaps it should take into account the CKAN version and have a fixed set of xpaths and templates that work for each version

#1528: Gravatar next to My Account link on all pages

zephod — Tue, 06 Dec 2011 18:58:51 GMT

Rather than the anonymous 'user' icon in the top-right corner, we could display your gravatar on all pages when you are logged in.

This was suggested by Richard Cyganiak: http://lists.okfn.org/pipermail/ckan-discuss/2011-November/001825.html

#1413: Ask users to 'add email address' when logged in

shevski — Mon, 24 Oct 2011 10:45:08 GMT

I'd like us to display a one-off banner that prompts users who log into thedatahub.org to go and update & their profile & fill in their email address (if we could do it just for those who don't have an email address, then even better) That is, once they log in, they see a banner which says: Please update your profile [here] and add your email address, so you can receive notifications, be able to reset your password and get updates

Then when we build notifications or if we decide to survey people, we can actually contact them. Email address should be required as standard

DR: Also, mention their Full Name too - v. useful for selecting correct user in group curation

#1388: etags caching on home page

dread — Wed, 12 Oct 2011 14:24:03 GMT

Needs to update on:

language - It's broken on thedatahub.org if you change to German and then click on the CKAN icon top-left to go to thedatahub.org again.

AND

whether signed in or not - #1373

BUT not latest revisions (which is what it was)

Or get rid of etag caching on this page and others?

#1339: Issues / question re navl and data conversion

rgrp — Tue, 13 Sep 2011 20:50:22 GMT

I ran into a bug with the size field on resources.

It would not accept an empty value from form (IMO this clearly equates to null/None)
This could be fixed via using ignore_empty instead of ignore_missing
However using this means there was no way to empty the field (e.g. i may just want to set the size field back to null not just change to another value)
similar issues could arise around other fields (such as last_modified ...)
- cf cset:645031d07b60

To solve this (cset:58acdcfe6d4e) i created an int_converter temporarily in logic/schema.py (this is almost certainly the wrong place). But I think it raises a bigger issue about the conversion layer and how it works.

#1330: Deprecate / Remove test_authz.py

rgrp — Tue, 13 Sep 2011 07:32:09 GMT

test_authz.py appears to test in great detail some very specific additional authz (related to total site lock-down it seems -- introduced I think for hri project).

I think there are simpler ways to get total site lockdown (use external auth!) and this test is slow and delicate (e.g. depends on specific words in templates). Suggest removing. If we don't remove we should at least refactor tests for access to certain pages to use a proper method of testing (e.g. agreed html comments in each page) rather than being depending on the presence of absence of specific wording.

#1306: Tests for the logic layer

rgrp — Sun, 04 Sep 2011 16:21:07 GMT

AFAICT there are no tests for the logic layer at the moment. I imagine this is an issue (if it is not please explain and close as wontfix).

#1305: SMTP config for thedatahub.org and IATI

amercader — Fri, 02 Sep 2011 09:44:17 GMT

The email sending functionality (e.g for password reset) does not work on thedatahub.org and IATI (and probably some other instances) when using an address which is not a okfn.org one.

Could not send reset link: SMTPRecipientsRefused({u'amercadero@…': (550, 'relay not permitted')},)

As I said, adria.mercader@… works fine. The SMTP server used mail.okfn.org

#1290: Better error when blank database

dread — Thu, 25 Aug 2011 09:24:15 GMT

When installing CKAN, when doing "paster serve development.ini", lots of users encounter the error for every request:

ProgrammingError: (ProgrammingError) relation "user" does not exist

This is because the database tables have not been created - they have forgotten or missed the "paster db init" step.

Can we provide a better error to say that the database is not initialised yet?

Implementation options

At the start of every request we reflect the database tables and check they are there. This is rather expensive!

Uncached requests to the home page start with a cheap database query. If there is an exception then return this error about database setup. I really like Drupal's page for this that has in large letters that the site is currently off-line. Below a line, in small letters, there are developer suggestions on what is wrong and where to look to fix it.

#1289: Remove 'relationships'

dread — Wed, 24 Aug 2011 17:21:42 GMT

Abstract

Package Relationships have not taken off in the 18 months we've had them in the API. There are some issues with them and we need to spend more time improving them or consider getting rid of them.

The Problem

Original use cases are expressed here: #253 Here are comments about how we could handle these specific examples better:

groups of packages - maybe better with a custom tag?
fragment resources - soon to be covered by 'kind' resource field #957

3&5. derived resource - better to have some sort of resource relationship perhaps?

linked resource - again better to have some sort of resource relationship perhaps?

Outstanding issues needing serious effort to fix:

#256 Editing them in Web UI (not done yet)
#1288 Package edit/creation can't include 'relationships' field

Specification

Remove relationships from model, API, tests, Web UI. Data migration to remove from db.

Why do it this way

Getting frustrated having problems with the code, when it's not used much. Often asked about what it's for, but rarely used. Seems an overly complicated design.

Backwards Compatibility

n/a

Implementation plan

Deliverables

See Specification

Risks and mitigations

Risk: a customer suddenly wants this, and the new ways to relate resources are not in place yet.

Mitigation: discuss this decision thoroughly to make sure we are confident the use cases are not important. Discuss with team, ckan-discuss and specifically the LOD people who have some related packages on thedatahub.org.

Participants

David Read

Progress

Not yet.

#1283: Deleted packages shouldn't be searchable or browsable

dread — Tue, 23 Aug 2011 15:14:41 GMT

A package in deleted state doesn't show to general users, but admins DO see them. The idea is that they can resurrect them if they want. But now we have the trash can that lists deleted packages. So we don't want admins to see the deleted packages anywhere else.

(But an admin should still be able to READ and EDIT a deleted package, so if he clicks on it in the trash list he can see it to decide whether to resurrect and actually be able to change its state.)

Same in the Web interface and API.

This ticket ties in with #948 highlighting a package being deleted (when viewing or editing) and follows on from the introduction of the trash can #1076.

#1280: fix sqlalchemy so that it works with postgres 9.0

kindly — Tue, 16 Aug 2011 16:44:50 GMT

After the ckan migrate process, sqlalcehmy reflect does not work and causes an error when reflecting indexes. A bug report needs to be put into sqlalchemy.

#1269: User view page shows the packages followed by viewing user not user being viewed

rgrp — Tue, 09 Aug 2011 16:16:38 GMT

This overlaps with Sean's follow support (for activity streams) and so will be dealt with there.

#1251: Rename wiki.ckan.net to wiki.ckan.org

rgrp — Fri, 29 Jul 2011 18:45:47 GMT

Inline with general naming policy going forward.

#1197: Add JavaScript guide for CKAN

timmcnamara — Thu, 23 Jun 2011 03:50:32 GMT

A new library, guiders.js, has been open sourced that seems to be great at unobtrusively introducing new users to features of websites.

The library drives Optimizely's website. The GitHub repo is here: https://github.com/jeff-optimizely/Guiders-JS

Some examples:

#1153: Update CKAN wiki front page

lucychambers — Mon, 23 May 2011 12:53:31 GMT

Update CKAN wiki front page - a la OpenSpending?: http://wiki.openspending.org/Main_Page

Sections should relate to different types of people using the site:

Developers, Users etc..

#1141: [super] Moderated Edits User Interface

johnglover — Wed, 18 May 2011 12:16:43 GMT

Proposer: John Glover
Seconder: James Gardner

Abstract

We are trying to achieve these goals:

To get people involved with making edits to CKAN metadata.
To have an ownership model as to who can moderate and validate these changes
To not put too huge a burden on these owners.

This feature allows anyone to edit a package and create a new revision, but requires an owner/moderator to approve a revision before it is are made "official".

There have been a lot of discussions around the revisioning system side of this ticket (CREP 0002) and I think these are now largely resolved. We now want to discuss the user interface.

The Problem

We require the following functionality:

Allow a group of changes to be stored as a new revision.
Allow a linear stack of "community" revisions.
Provide a way for the editor and moderator to compare previous revisions to the current one.
When a moderator approves a change it creates a new revision flagged "moderated" (this is analogous to a merge commit)
Provide a way for the editor and moderator comment on revisions if necessary.

Extra features:

Need a way to summarise the changes (as part of the preview perhaps)
Sysadmin needs to purge a revision completely

Specification

UI/UX

UI Mockup:

Revisions:

Revisions are per package rather than per field.
Internally CKAN has separate revisions for resources, extras and package metadata. From a user's point of view this could be confusing to expose, so everything that they see on a package form when they hit save is a single revision.

On the Edit page:

We have a panel on the right, listing all the revisions with the current moderated one selected. Moderated revisions are highligted in some way (red and bold?).
The values displayed in the form are by default populated from the latest revision (whether community or moderated)
Under each field is a "shadow", showing the value of the field in the revision selected in the panel, if it is different from the value in the field. By default the shadow values are populated from the latest moderated revision which is the one selected in the revision panel by default too.
When you change the value of a field, a shadow may appear or disappear accordingly. If they disappear a box saying that they are the same replaces it
If you want to edit values from a previous revision, you first select that revision to get the shadows populated. There is a button named "Replace fields with values from this revision" under the revision list. You click this, a warning pops up and then you say "Yes". You then select the moderated revision again.
We also allow package comments the same way as the todo extension works at the moment. Additionally, we need to be able to differentiate between what the moderator wrote and what a community member wrote, and so we may need to make a small change to the todo extension to facilitate this.
In addition to package comments, each revision will have a revision log (analogous to a commit message).

Technical Details

This CREP will result in a new CKAN extension.
It depends heavily on the new revisioning system (CREP0002), some of the details of which are yet to be finalised.
This CREP therefore requires working closely with David Raznick to come up with an API that the UI AJAX calls can use.
We will then use suitable test data to mimic these API calls until CREP0002 is ready.

Why do it this way

This hopefully provides a clear and consistent mechanism allowing both a community member to make new revisions and a moderator to view and approve revisions, with largely the same UI/UX.

Implementation plan

Deliverables

A new CKAN extension, consisting of:

Code: Python, HTML, CSS, Javascript
Unit tests
Localization
Documentation

Participants

John Glover to do it.

Progress

John has implemented the bulk of this UI. Just some things to tidy up before it is complete:

Genshi stream filters to be updated with CKAN 1.5 / 1.5.1 templates
history_ajax / read_ajax to be replaced with calls to Action API (or Util REST API)

I've split these two off into a new ticket #1604.

Related Progress

The Todo extension is written and available at: https://bitbucket.org/johnglover/ckanext-todo.

In the section 'The Problem', under extra features, we mention a need for the sysadmin to be able to purge a revision already. This is already done.

#1139: Create CKAN Theme Gallery

lucychambers — Tue, 17 May 2011 15:24:19 GMT

Take screenshots of existing ckan instances esp those mentioned <http://wiki.ckan.net/Theming> and put on flickr in ckan or ckan-theme group so we can create a gallery ... (both to illustrate theming but also to show ckan instances that are around -- could add to http://wiki.ckan.net/Instances)

#1132: test_authz doesn't run

johnlawrenceaspden — Mon, 09 May 2011 18:48:43 GMT

Trying to run the tests in test_authz.py with

$ nosetests --ckan ckan/tests/functional/test_authz.py results in no tests being run:

Ran 0 tests in 0.840s

OK (SKIP=3)

#1004: Group creation instructions missing

dread — Thu, 24 Feb 2011 14:52:24 GMT

Need instructions on the group page to tell people they need to login to create a group. Someone must have deleted this.

#952: CKAN should run under nginx/uswgi

pudo — Thu, 03 Feb 2011 10:54:58 GMT

second part of #908

#925: Change the search box icon to remove the down arrow

dread — Mon, 24 Jan 2011 11:13:13 GMT

Is there a good reason why the search box has a 'down arrow' icon when there is no drop-down menu? Or can this be usefully removed?

#819: Tag autocompletion widget broken

cygri — Wed, 17 Nov 2010 14:28:41 GMT

The widget for tag autocompletion is broken in various ways.

For example, if I edit a package that is tagged "music", and just tab through the form fields to get to the Author field, then the widget changes to "industrial-music" as I tab through it.

Or if the tag is "foo bar" and I hit alt-right to jump to the end of the text field (with the intent of adding a third tag), then the contents change to "foo barbecue".

#691: Package Relationships

johnbywater — Mon, 11 Oct 2010 18:45:35 GMT

#482: API Rate Limiting

johnbywater — Sat, 21 Aug 2010 20:32:36 GMT

#363: Blank revisions

dread — Mon, 12 Jul 2010 15:16:12 GMT

Occasionally we seem to get revisions that are not connected to packages. These shouldn't appear, since all revisioned objects are linked to a package aren't they?

They appear on the 'Recently changed' list on the home page with an empty 'Packages' column.

#129: Secure db access by channelling query generation through authz module

dread — Fri, 25 Sep 2009 13:42:16 GMT

Controllers and templates should not access db objects directly - they should do all access via authz module giving username. They are handed by a query that has already been filtered by the packages they are authorized to read.

(Additional idea to be discussed: When they request a package object, they are handed an copy of the db object - disconnected from the database - so it the db object can't be changed.)

A couple of tests can be reenabled when this is done: ckan.tests.functional.test_authz.TestUsage?.test_admin_list_deleted ckan.tests.functional.test_authz.TestUsage?.test_search_deleted

#2962: Search across multiple ckan instances

dominik — Mon, 08 Oct 2012 22:50:22 GMT

Could be done by:

using the solr distributed search
- difficult set up
merging result sets from apis
- make sure that results can be merged properly (score, facets, ...)

#2960: Private datasets are not private

dominik — Mon, 08 Oct 2012 11:04:15 GMT

At the moment everyone can read all resources. There is no support for hiding resources that are in private datasets.

#2729: searching for tags:[tag] works but tag:[tag] doesn't

shevski — Sun, 22 Jul 2012 09:58:29 GMT

which is confusing since you can only search for one tag like this at a time. I.e. tags:economics,cvs or tags:economics, csv or tags:economics+CSV doesn't work for example; therefore tag:economics, should also work!

http://s031.okserver.org:2375/dataset?q=tags%3Aeconomics&sort=relevance+asc

#2531: New state option: archived / deprecated

rgrp — Fri, 15 Jun 2012 08:59:47 GMT

Deleted means things will get purged at some point.

Archived means they stay around but get hidden from search results and a big warning notice gets displayed saying this is archived / deprecated.

@richard cyganiak ...

#2508: Make it possible to run CKAN tests for each language

seanh — Mon, 11 Jun 2012 10:42:15 GMT

Mistakes in translated strings can cause CKAN to crash or otherwise not work, but it's not practical to manually test every page and function of CKAN in every language that we have new translations for before a CKAN release. It'd be great if the tests could automatically be run for each language.

This is probably a big job, we would have to get the tests to respect a language setting in the ini file, check for any individual test cases that specify the language (e.g. in the URL), and also fix test cases that look for specific English words in HTML output, etc.

In the meantime, a good stop-gap solution might be a script that tests for common mistakes in the po files.

#2486: Should be able to use . in dataset names

seanh — Sat, 02 Jun 2012 16:46:23 GMT

#2395: paster db clean/init don't work when spatial extension enabled

dread — Wed, 16 May 2012 09:16:33 GMT

If you have a spatial enabled database then if you don't disable the spatial extension in the CKAN config temporarily then you get errors when you run paster db clean and paster db init.

Can't you just modify the clean and init functions to run without extensions enabled?

The wider problem is that extensions do their own inits every time you do load_environment, which seems crazy and inefficient to me, since this occurs every time a request comes into CKAN. But that is another problem/ticket.

#2310: Refactor the search-query construction in feeds.py

icmurray — Mon, 16 Apr 2012 16:01:31 GMT

The feeds controller, used to construct atom feeds, duplicates code found in the package controller's search action (in order to construct the custom feed).

Refactor this to remove duplication.

#2277: Use the new atom feeds in IATI

icmurray — Mon, 02 Apr 2012 17:10:28 GMT

Atom feeds have been implemented in core in #1593. The IATI-specific implementation can now be removed when IATI move to CKAN >= 1.6.1

#2247: Resource preview glitch in some browsers

zephod — Tue, 20 Mar 2012 12:30:14 GMT

From Ira: Preview for google spreadsheets are not displaying correctly for me in Firefox v.10.0.02, fine in Chrome. http://i.imgur.com/KJaqz.png

#1827: 'Register' link should be hidden if you not allowed to register

dread — Wed, 22 Feb 2012 15:35:39 GMT

I have just deny visitors the create-user permission:
sudo -u ckanstd paster --plugin=ckan roles deny reader create-user -c /etc/ckan/std/std.ini
sudo -u ckanstd paster --plugin=ckan roles deny anon_editor create-user -c /etc/ckan/std/std.ini
and after restarting, the register link is *not* hidden, but now when you access the register page, it shows you this message "Unauthorized to create a user" (when not logged in). But anyway that is an improvement.

#1823: Spring clean bin directory

rgrp — Mon, 20 Feb 2012 21:28:51 GMT

Huge number of accumulated (and likely unnecessary) scripts in /bin directory.

#1750: Move ckan/lib/activity.py into the model

seanh — Sun, 05 Feb 2012 18:18:08 GMT

Move ckan/lib/activity.py moved to into the model - say ckan/model/activity_extension.py, because it's so tightly knit with the model code, whereas most of the lib code is used in the controllers.

#1747: Expire old activities

seanh — Sun, 05 Feb 2012 12:56:29 GMT

Currently the activity streams database tables just get longer and longer over time. Do we want to eventually delete the oldest activities, to keep the length of the table within limits?

#1717: [super] Search UX improvements

shevski — Thu, 26 Jan 2012 18:53:01 GMT

Make it possible to search by tag (e.g. by typing tag:csv into the search bar and clicking enter, it should add the 'csv' tag facet to the search)

Rename and standardise the list of format tags, on search page this should also be called 'Format' instead of 'res_format' (in the right hand side bar on search page).

Make it possible to view full list of tags, formats and groups by clicking on the name. From here you should be table to click on a classification and go back to a search page faceted by that classification. E.g. from search page, click on 'tags', on tag page click on 'london' or whatever, and be navigated back to search page with search within 'london' tag only. Or y'know, a better way of doing it.

More standard classifications, such as 'Location' and 'Theme' - like on publicdata.eu

Blue search button should be displayed in line with the search bar, not underneath

Datasets should be displayed in order of most viewed or downloaded instead of alphabetically. For alphabetic search we could consider adding a way to facet by first letter of dataset name

#1697: A Configurable list of states for a Dataset

rgrp — Tue, 24 Jan 2012 10:23:50 GMT

Currently have 'active' and 'deleted' suggest also:

'draft'
'hidden'

(Do we need both). Also write out workflows related to these.

#1679: Default roles problem

dread — Tue, 17 Jan 2012 17:57:22 GMT

The 'editor', 'anon_editor' and 'reader' roles are intended to have immutable actions. This was designed to prevent their names being subverted - e.g. an editor should always be able to edit! It also meant that when we add Actions (e.g. DELETE-PACKAGE) then it can be added sensibly to these roles in an upgrade just by changing the defaults table (ckan/model/authz.py).

The problem is that this immutability is only enforced on 'db upgrade'. So you can happily change the editor role using the paster command and it works, right up until you do an upgrade and realise permissions are different.

We should stop the paster commands being able to edit these roles. Or get rid of the immutability completely. Views?

#1668: repoze version discrepency

dread — Tue, 17 Jan 2012 12:02:26 GMT

There's a discrepency in repoze.who versions between the source and package installs:

repoze.who - package 1.0.18 vs source 1.0.19
repoze.who-friendlyform - package 1.0b3 vs source 1.0.8

We get a test failure [1] with the 1.0b3 version (from the ubuntu 10.04 python-repoze.who-plugins package). But we've not noticed any problems on s057 instances (br, no, ie etc) which have the package versions of repoze.who.

The reason the package install uses the earlier packaged versions rather than the ones we'd like is that repoze uses all sorts of horrendous import hacks, making it too difficult to put into our 'ckan-conflict' source package.

James suggests we 'do something horrible like dynamically patch repoze on CKAN import'.

[1] http://buildbot.okfn.org/builders/builder-ckan/builds/1371/steps/shell/logs/stdio ERROR: ckan.tests.functional.test_user.TestUserController?.test_user_create_unicode

#1647: add links to ckan discuss & dev to thedatahub

shevski — Mon, 16 Jan 2012 00:30:52 GMT

In the footer as well as more clearly & directly on the About page

#1644: Order default dataset page by most downloaded resources on thedatahub

shevski — Thu, 12 Jan 2012 18:39:02 GMT

Instead of alphabetically as we do currently, alternatively by most viewed datasets

for http://thedatahub.org/dataset

#1643: Add fixed tags to thedatahub for better browsing

shevski — Thu, 12 Jan 2012 18:34:53 GMT

Similar to publicdata.eu, want to have themed areas such as finance, environment, census, etc and country tags

#1642: Extra link generators generate garbled HTML

pudo — Thu, 12 Jan 2012 15:29:31 GMT

I had a package descriptions with URLs that contain "group:foo". This produces garbled output as the system tries to generate two sets of links: the outer link and an inner link.

Need to fix the parser.

Text:

Webdienst basierende Bereitstellung von Geobasisdaten der Freien und Hansestadt Hamburg. Folgende Geobasisdaten werden als WebMapTileService? (WMT-S) für die Dauer des Wettbewerbs netzbasiert unter der Creative Commons Lizenz zur Verfügung gestellt: Digitale Orthophotos 40 cm Auflösung (Layer: apps4d_DOP40), Digitale Stadtkarte (Layer: apps4d_DISK), Digitale Regionalkarte (Layer: apps4d_DIRK), Digitale Karte 1:5000 (Layer: apps4d_DK5).

Metadateneinträge zu den Daten im PortalU:

One fix is quoting the URLs

#1635: Email notifications (e.g. for activity streams)

seanh — Wed, 11 Jan 2012 17:56:27 GMT

CKAN should be able to send email notifications to users.

Maybe have a notifications table in the db, and a server-side job that runs periodically and consumes rows from this table, mailing them to the users.

One thing that we may want to send users notifications of is activity stream events. So the activity streams code would have to add rows to the notifications table for the mailer job to consume. But remember that email notifications feature is separate from activity streams - we may want to send notifications of other things as well.

Need to implement (at least some of) #1634 before this can be implemented, in order to have something to send notifications about.

Analysis here: http://ckan.okfnpad.org/27

#1606: metadata license config option

dread — Mon, 02 Jan 2012 10:45:30 GMT

Add a config option to choose the metadata licence. Set default to Open Database License.

Currently the dataset edit form says "Important: By submitting content, you agree to release your contributions under the Open Database License." This is hard-coded, but not suitable for when DGU uses the CKAN form - they use the OGL.

#1604: Get ckanext-moderatededits working with CKAN 1.5+ templates

dread — Sat, 31 Dec 2011 17:27:09 GMT

ckanext-moderatededits requires an old and possibly development version of CKAN. It would be good to update it for later CKAN versions.

According to the README, you need CKAN from branch feature-1141-moderated-edits-ajax but the changelog suggests this branch went into version 1.4.2. So it possibly works with 1.4.2 and 1.4.3(.1). But CKAN 1.5 has revamped templates, so the genshi stream filters definitely don't work.

BTW history_ajax/read_ajax calls have been deprecated in CKAN since 1.5.2a and will need fixing up to use the Action API too as part of this.

#1598: Reinstate Ratings

rgrp — Thu, 29 Dec 2011 16:52:04 GMT

Ratings were disabled approximately a year ago because:

Unclear purpose and UX. What did ratings tell you? How useful were they?
Spamming (esp by bots: you could submit an anonymous rating via a GET request which caused problems)

Both problems are solvable and it would be nice to have this feature reinstated.

Purpose: can make this more purposable by limiting to logged in users (or at least distinguishing logged in from non-logged in users)
- Even better we could allow ratings to be made public (I'm interested in what someone else I respect finds important)
Spamming: limit to logged in users and / or use AJAX over an API to submit ...

#1589: QA - Give 5 star rating to datasets with link metadata

johnglover — Wed, 21 Dec 2011 15:16:40 GMT

Super: #1594

From Richard Cyganiak on the CKAN Discuss list:

Regarding the fifth star (is the dataset linked to others?). This cannot be automatically determined just by looking at the format. It either requires inspection of the actual data, or information about links in the metadata. As you're probably aware, we've established conventions for recording information on data links in CKAN [1], as part of the work of the lodcloud group on the Data Hub. Link information is captured for hundreds of datasets. I would claim that we have the majority of four-star datasets covered there, and hence you can determine if they should get the fifth star by checking for the presence of a links:xxx field.

#1588: QA - Give SPARQL endpoints a 4 star rating

johnglover — Wed, 21 Dec 2011 15:13:25 GMT

Super: #1594

From Richard Cyganiak on the CKAN Discuss list:

Besides considering the media type of resources, it would also make sense to check for the presence of a SPARQL endpoint. SPARQL endpoints are recorded for more than 300 datasets on the Data Hub using the pseudo-type "api/sparql". A few more are recorded with the format "SPARQL". I suggest that datasets with such resources should also be considered for the fourth star.

#1584: QA report improvements - 2.5d

johnglover — Wed, 21 Dec 2011 09:23:53 GMT

Super: #1594

qa/{username}
qa/{groupname}
paginate QA results
search / filter QA results
~~list organisation report by default, but can disable via config option~~ (done)
UX tidy up of report pages - hide border if no sidebar, etc

#1578: [super] Re-enable and refactor ratings

rgrp — Mon, 19 Dec 2011 19:20:43 GMT