CKAN: Ticket Query

#84: Revert support on versioned objects

rgrp — Thu, 23 Jul 2009 08:59:03 GMT

Basic revert in the classic wiki form is already support by purging a Revision. However may wish to support:

Cases where multiple objects changed in a revision but only want to revert 1 (low priority)
Want to revert but have reversion as a new revision of that object.

Seems low priority at present.

Cost: ?

#285: Paginate list of packages on tag read page

rgrp — Wed, 07 Apr 2010 18:23:26 GMT

Is this worth doing? On hmg.ckan.net start to have a lot of packages with a given tag ...

#301: Package discussion pages

rgrp — Mon, 26 Apr 2010 16:57:13 GMT

A package discussion page is like a wikipedia discussion page: an editable free text page for people to have discussion/post comments about a given package.

It provides a way for people to make suggestions about a package without needing access to main package.

#1069: Stub datasets (request for datasets)

rgrp — Fri, 01 Apr 2011 14:08:39 GMT

Idea is to have stubs for datasets that someone wants but don't yet exist (or haven't been discovered) in the way one has stub pages on a wiki.

We could do this within the existing model by a slight 'abuse' - create a dataset and mark it with a special tag e.g. todo.does-not-yet-exist or similar ...

(Just as we have datasets listed that exist but aren't available ...)

Alternative would be to have a request for datasets subsystem.

I prefer the stub dataset model because it's simpler, provides a simple workflow (as a dataset is found or comes into existence), and the package page provides a natural space in which to accumulate information about what is wanted and what exists.

Implementation

Agree a new dedicated tag. e.g. todo.does-not-exist

This ticket has clear links to http://getthedata.org/

#1135: Changeset model for vdm

rgrp — Thu, 12 May 2011 14:19:46 GMT

Move to Changeset model for vdm.

A changeset model is like an Audit-Log model in which we just record Changesets with Change-Objects rather than have Revision-Objects for each Object that is revisioned.

This change would also incorporate significant simplication of vdm.

#1136: Move to SessionExtension in vdm

rgrp — Thu, 12 May 2011 14:34:15 GMT

When vdm was created there was no SessionExtension so we use MapperExtension for doing revisioning. Now that SessionExtension? exists we should use it. We can also follow the existing SQLAlchemy recipe: <http://www.sqlalchemy.org/docs/orm/examples.html?highlight=versioning#versioned-objects>

#1137: Remove need for statefulness in vdm

rgrp — Thu, 12 May 2011 14:47:08 GMT

Statefulness, especially statefulness for relation (esp m2m) is cause of most of the complexity in vdm. It is required because, atm, revision objects have FKs to continuity objects.

This ticket proposes the following changes:

NB: this could be limited just to case of join tables (leaving state stuff on other tables)

Remove FKs from revision to continuity (or allow for them to be nullable).
- We could just limit this to m2m stuff
Delete of an object leads to:
- Deletion of continuity object
- Adding an entry in revision table with state set to deleted (we retain state on revision table)

If this is done we will no longer need to worry about filtering on state on relationships as join table will only contain "active" relationships.

If we do this on all tables we remove need for any state awareness in client (e.g. no need to filter tables on active state).

The only disadvantage of this change is that undeletion becomes more problematic (we have to recreate some continuity objects).

#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!)

#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)

#1458: Support previewing kml files in data viewer

rgrp — Thu, 10 Nov 2011 14:48:08 GMT

Super ticket: #1151 (viewing geo data)

E.g. preview of http://thedatahub.org/dataset/louisvillecrime should bring up a map

#1460: Improve extensions documentation

rgrp — Sat, 12 Nov 2011 16:15:23 GMT

Current extensions documentation needs some work: http://docs.ckan.org/en/latest/plugins.html

Queue extension section may now be out of date (?)
Think about how it integrates with https://github.com/okfn/ckanext-example (especially tutorial and example extension)
Document all plugin points (auto-extract from CKAN source??)

#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 ...)

#2203: Data Viewer support for PDF

rgrp — Sun, 04 Mar 2012 11:24:53 GMT

Boot viewer for format/mimetype: application/pdf, application/x-pdf, application/acrobat, applications/vnd.pdf, text/pdf, text/x-pdf
propose we use pdf.js - https://github.com/mozilla/pdf.js
We could also try iframing for browsers with native support but this seems more complex

#2294: Unauthorized action on Data API gets 302 rather than 401 or similar

rgrp — Sat, 14 Apr 2012 19:35:04 GMT

Well known issue that 401 *in API* end up with 302 redirect to login page (which makes no sense and is very confusing for clients).

Fix this by ensuring that error messsages on API get passed through correctly.

Minor because affect is annoying but not terminal

#2329: Add back in RSS/Atom links on relevant pages

rgrp — Thu, 26 Apr 2012 12:15:40 GMT

E.g. on dataset page, on revision page, on user page and on search results.

#2334: Improved data import

rgrp — Sat, 28 Apr 2012 22:21:02 GMT

Placeholder for thinking about this ...

Allow users to configure info for CSV import (e.g. separators, quotes etc)

#2404: Auto-screenshot for related items

rgrp — Mon, 21 May 2012 06:55:47 GMT

As a User I want an image generated for my related item automatically so that I do not have to take picture myself and upload it somewhere

Implementation: (?) Use phantomjs or something like http://snapito.com/ Investigate for 1.8, will be needed for TDH Oct.

#2405: Improvements to data viewer embed

rgrp — Mon, 21 May 2012 06:59:25 GMT

Decent powered by icon for the Embed for the DataHub?? (make this text customizable and allow html ...)
- Current icon and text looks really bad
Embed link uses uuid rather than dataset name (this goes to perma-url question ...)
Data viewer embed url includes all the resource info (not needed -- just url and backend info ...)
Embed extension urls do not respect original domain but instead use site_url (I'm guessing). E.g. datahub.io domain ends up with links to embed on thedatahub.org

#2535: SSL certificate for DataHub + https by default

rgrp — Fri, 15 Jun 2012 11:00:27 GMT

DataHub? is increasingly used and we should ensure it uses ssl as part of general security.

See also #1446 (Need to support https login for multiple instances as part of the CKAN package install)

#2874: Clean up bin directory

rgrp — Fri, 17 Aug 2012 08:01:48 GMT

Full of obsolete material

#2877: Bugs with datastore v2

rgrp — Sat, 18 Aug 2012 00:33:22 GMT

In progress

~~[major] q does not seem to work reliably. e.g. using the setup from this gist https://gist.github.com/1930806 and doing a ?q=DE yields no results (does not work with "q=de" either)~~
- ~~q=second does work ...~~
[major] q does not work with 2 values (see below)
Query on search with limit 0 results in total of 0 (should either be null or correct total). Queries with other limits yield correct total AFAICT
- Also weird fact that limit is returned but as as as string - should it not be an integer
Types on fields: could these not be canonical and as per recline (or is it important to allow exact sql types ...)

Multiple query values

Try a query such as: "second UK" and you will get 500 error:

http://localhost:5000/api/3/action/datastore_search?resource_id=4f1299ab-a100-4e5f-ba81-e6d234a2f3bd&q=second%20UK

ProgrammingError: (ProgrammingError) syntax error in tsquery: "second UK" 'select "_id", "id", "date", "x", "y", "z", "country", "title", "lat", "lon", count(*) over() as "_full_count"\n from "4f1299ab-a100-4e5f-ba81-e6d234a2f3bd" where _full_text @@ to_tsquery(%s) limit 100 offset 0' (u'second UK',)

Suggestions

Filter support: should think in more detail about this (may want to follow recline style)

Simple filters in query parameters would be nice too ...

#140: News section on front page

rgrp — Wed, 07 Oct 2009 08:02:21 GMT

Have a news section (suggest as a sidebar item).

News section will link to latest 3/4 blog posts on CKAN from blog.okfn.org.

Details:

Suggest pulling via rss or similar.
Will want to cache this ...

Cost: 4h?

#331: Timezone of CKAN timestamps should be configurable

rgrp — Mon, 31 May 2010 10:40:40 GMT

Revisions are timestamped using the server's clock, which may not relate to the expected timezone for the site. e.g. the Norway site has a server on GMT. No timezone info is displayed either.

Would like to set timezone for a CKAN instance to use in rendering revision timestamps. For example, use CET or EST timezone.

#837: CKAN integration with freebase gridworks / google refine

rgrp — Tue, 30 Nov 2010 18:10:09 GMT

Thread: http://lists.okfn.org/pipermail/ckan-discuss/2010-November/000718.html

Scenario 1

User installs Refine and CKAN extension for refine
On booting refine and asked to load data they can choose from any data package on CKAN.net (or any other CKAN instance)
They edit the dataset on Refine
On save (or perhaps as a separate option) they are prompted as to whether they wish to sync the dataset back to CKAN (either as a new package or as a new resource on the existing package)

NB: for the dataset sync back some form of "CKAN" storage would be required (we already have storage.ckan.net running but a closer integration would be required)

Scenario 2

User visits a package on CKAN.net (or another CKAN instance)
There is a button on the page "View and edit this dataset in Google Refine"
Click button -- ask them if they have Google refine installed
- Yes: instructions for loading dataset into refine
- No: load dataset in hosted version of google refine (we could run this)
User edits dataset and hits save. As in previous scenario they are prompted to sync the dataset.

#1009: Improvements to user accounts sytem

rgrp — Fri, 25 Feb 2011 12:13:11 GMT

Forgot password (email a new password)
Confirm email
Do not show register page if you are logged in (redirect to home page)
ticket:1010 - listing of users.
- Do not use /user for general user account home page (either user normal user page /user/{id} or /user/myaccount)

#1077: Move to simpler vdm system

rgrp — Fri, 08 Apr 2011 23:14:24 GMT

Option 1: 'Changeset' Model

See ticket:1135 for vdm ticket. This would involve a) moving to changeset in vdm b) doing the migration in ckan to support this.

Have developed a new "changeset" based model for revisioning in vdm.

Implementation

The main challenge with this change is schema and data migration

Every revisioned object has a revision_id and revision attribute.

Approximate algorithm:

Revision -> Changeset
for revtype in [PackageRevision, ...]:
    for pkgrev in package_revision:
        changeset = lookupchangeset(package_revision)
        ChangeObject(cset, (table, id), dictize(pkgrev))

Question:

does pkg include tags attributes or not? or we have to dictize, pkgrev, pkg2tagrev, and tag. Probably the latter.

Option 2: Simplify Revision Object Model

Just use a simpler vdm, see ticket:1136 (move to SessionExtension) and ticket:1137 (remove need for statefulness in vdm).

Discussion

Advantage of Option 1 versus 2:

Easier support for pending state and similar behaviour
No need to introduce new tables (and hence migrations) when making something revisioned (or not).

Disadvantages

Migration is required
More difficult to query revision history.
- Could be addressed by having ChangeObject have separate cols for table name and id but would likely be more difficult.
Performance (?)
- Have one big ChangeObject table to query when looking at changed objects rather than many revision tables.
  - Not sure this is a biggie as even with Revision model biggest revision object tables are probably on the order of the ChangeObject table

Conclusion

Implement Option 2 and leave Option 1 for present.

Option 1 includes Option 2 so it seems that that is required in either case (so we may as well with Option 2).

Option 1 requires significant effort (esp migration) so leave for present and then review the situation at some later date.

#1163: Improvements to Storage Extension

rgrp — Thu, 26 May 2011 11:19:38 GMT

Storage is now working but there are

Integrate with Resources (e.g. create a resource for each file upload and give option to associate with a package)
- Should we introduce rule that files *not* associated with a Resource are periodically deleted?
Allow setting of a file name/path before upload
Allow for file overwriting/deleting etc (how should this work -- do we want to allow this sort of thing)
Integrate local file upload stuff in api/auth/*

Different Backend Issues

Local file store is rather different from 'remote' storage in various ways:

For remote you don't want to use many buckets as there are bucket limits while for local you want to. Should we there have a single path that users provide which we then partition differently for different backends.

#1286: Remove remaining formalchemy stuff

rgrp — Tue, 23 Aug 2011 16:29:56 GMT

Stuff I've spotted:

forms/*
template/group/edit_form.html
template/package/edit_form.html

This can go once new DGU form is in.

#1311: Modal user register and login form

rgrp — Tue, 06 Sep 2011 08:20:27 GMT

Subticket of: #1294

Rather than having to visit a dedicated page it would be good if registration and login could be done from a modal form (separate or combined ...).

Why

It could be used from dataset creation page in situations where user needs to be registered / logged in to create a dataset (so we could allow someone to start creating a dataset and only get them to login at the end ...)
It allows for quicker and easier logging in

Implementation

See Friedrich's work on the datahub

#1343: [super] User related improvements (login, user pages etc)

rgrp — Wed, 14 Sep 2011 16:18:18 GMT

Disallow account creation via openid - #1386
Require email field - #1319
- Require email confirmation to be activated (?)
Improvements to user page (e.g. show activity and more info about user) - #1396
Modal user login - #1311

#1411: Force resource format to be lower case (also mimetype)

rgrp — Sat, 22 Oct 2011 21:40:04 GMT

Format should be lowercase. Automatically lower case (for extra points have a bit of javascript to force lower case when entering).

Even more points: do a update on thedatahub repo to make all format lower case (or script this as an update?)

#1429: Provide DOIs for datasets in a CKAN instance

rgrp — Sun, 30 Oct 2011 12:21:45 GMT

DOI = digital object identifier = http://www.doi.org/

As a Publisher I want a DOI for my dataset so that it can be cited by and linked to by others in a standard and easy way.

Details

Probably implement as extension rather than core

#1432: [super] Data processing system for CKAN and Webstore

rgrp — Tue, 01 Nov 2011 10:19:07 GMT

Super ticket: #1190

A data processing system which utilizes the Webstore. One could get a long way with simple javascript running in the browser for development with this javascript then run offline using something like nodejs. Alternatively one could allow one to specify a url to e.g. a python file which would then be run in a sandbox (with access to some specified set of python modules)

#1459: Featured Dataset feature

rgrp — Sat, 12 Nov 2011 15:50:12 GMT

Provide way to mark a dataset as featured. Featured database show up on the front page.

TODO: detail this more.

#1534: Change revisions to record userid rather than username

rgrp — Wed, 07 Dec 2011 17:26:30 GMT

The use of username is problematic because username's can change.

Change all revision creation code to use user id (simplest is to change c.author field in lib/base.py (?))
- (?) Add a field ipaddr for ip address of anonymous users? (or just keep putting this in author field on Revision and then acception that those won't match when we do a look up against user table)
Change user view page to look up against user id rather than name
Perform migration on existing Revision objects
- Match should probably be against both openid and username when searching Revisions' author field (especially true on CKAN where some people have already changed their username from being their openid)

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

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

#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 ...

#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.

#1745: Dataset search UX improvements as of Jan 2012

rgrp — Thu, 02 Feb 2012 23:22:21 GMT

Changes to make search both more exploratory and more satisfying to use

Search query build - #1603
- Ability to add new facet fields "live"
- That is add fields which then contain faceted options (a bit like data.hri.fi)
(??) Autocomplete / drop down on search (i.e. search while you type)
- Dubious about value / cost ratio here

Probably would involve to pure JS and HTML implementation.

Implementation

Probably require

API changes to expose solr style API directly #1737

#1782: Improvements to datasets page UX (Feb 2012)

rgrp — Tue, 07 Feb 2012 10:10:41 GMT

Relationships in sidebar [WONTFIX yet without some link to documentation or datastructure, something for me to render?]
~~Icons for *types* of resources in resource list~~
List of 'Owners' (administrators) at top right of sidebar (a la group page)
- Much prefer owner to administrator ...

#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.

#2235: Group drop down on dataset edit should use chosen and sort groups by name

rgrp — Fri, 16 Mar 2012 14:15:57 GMT

#2258: Customizable contributor agreement

rgrp — Mon, 26 Mar 2012 08:45:49 GMT

Customize text at bottom of forms
Also need to make clear that this does not apply to the data itself (that is covered by the license you choose on your dataset ...)

#2279: Write tutorial for our DataStore API / Data Explorer

rgrp — Tue, 03 Apr 2012 19:44:23 GMT

Unfortunately ES is a little bit complex / opaque to newcomers. Need to write a simple tutorial walking through this.

This is documentation / example only (no code!)

#2291: DataStorer incorrectly attempts to store JSON in DataStore

rgrp — Sat, 14 Apr 2012 19:19:07 GMT

See http://thedatahub.org/dataset/ecb13156-cf11-4e91-b51c-f287d154276e/resource/5db67915-40cb-467e-9d72-194ea4973670

This was marked as json format (and is JSON) but appears to have been imported as a quasi-CSV. Either this hsould not be imported at all or it should be imported as JSON ... (which is straightforward to do).

Assigning to David for triage and review.

#2320: Introduce new state: archived

rgrp — Mon, 23 Apr 2012 20:12:29 GMT

Some datasets become obsolete: e.g. http://datahub.io/dataset/uncdb Do not want to delete them but want them marked as archived or deprecated or something.

#2321: Use resource names/titles in URLs

rgrp — Tue, 24 Apr 2012 03:00:12 GMT

Would make them much nicer but requires:

Ensure uniqueness (or deal with ambiguity)
(?) Slug/names versus titles
- Aside: what is currently called name should probably be title

#2328: Link to Catalog API for each Dataset, Group and Tag

rgrp — Thu, 26 Apr 2012 12:15:01 GMT

At the moment no way for a normal user to find JSON versions of this material. Would it be worth adding back a link somewhere on the page?

#2333: Introduce new resource type datastore

rgrp — Sat, 28 Apr 2012 22:16:00 GMT

This is a resource that is *just* in the datastore. At the moment there are hacky ways to do this (create resource with meaningless URL etc) but we should do this properly:

New Option: DataStore? Table in add a resource form
URL field is disabled (or points at /api/data or something rather pointless)
Download button is disabled
- Better would be to find a way to serialize an ES table or stream it ...

#2529: DataHub (or CKAN) widgets

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

Simple widgets in pure JS. For example:

Count of datasets in a group (could generalise to a query but not sure how useful that is ...)
Embeddable list of top X (5) datasets for a given query
Embeddable list of *my* datasets

Either these live at: {site}/widgets and we have some kind of generator (form where I choose my group, or my query).

Or: we have this attached to areas of site where relevant.

Can combine the 2 so that the latter links to the former. Think first will be easier to do and possibly more useful long-term (e.g. can just link people to that page).

Cf. http://okfnlabs.org/ckanjs/

#2530: DataHub purge fails on some revisions

rgrp — Fri, 15 Jun 2012 08:54:58 GMT

See http://datahub.io/ckan-admin/trash and try to purge revisions (*not* datasets). It will fail on some of the revisions with errors like:

Problem purging revision 391db9e8-df57-4e0e-8fe6-d4e0c2318344: (IntegrityError?) update or delete on table "revision" violates foreign key constraint "group_extra_revision_revision_id_fkey" on table "group_extra_revision" DETAIL: Key (id)=(391db9e8-df57-4e0e-8fe6-d4e0c2318344) is still referenced from table "group_extra_revision". 'DELETE FROM revision WHERE revision.id = %(id)s' {'id': u'391db9e8-df57-4e0e-8fe6-d4e0c2318344'}

#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 ...

#2582: Do not hide notes / readme on dataset pages

rgrp — Thu, 21 Jun 2012 20:59:00 GMT

Current we hide most of readme and then let users reveal it. Stop doing this and if necessary add a quick link down to resources section. (Maybe also rename resources to Data and Resources ...?)

Aside: believe I have mentioned this somewhere a month + ago but could not find the ticket.

#2673: simplify set of options for resources

rgrp — Sat, 14 Jul 2012 21:15:59 GMT

Far too many resource options. Lets restrict back to data file and API. Visualizations etc can either get linked in description or in the Related items.

#2844: SQL-only (no solr) version of CKAN

rgrp — Mon, 13 Aug 2012 11:59:28 GMT

~~Search needs to run of local DB (again)~~
paster db clean attemps to connect to SOLR (still works as does db first but then excepts which is not nice UX)

#2895: QA pages (e.g. broken resource links) are not paginated

rgrp — Tue, 28 Aug 2012 17:38:05 GMT

And as a result timeout on e.g. the datahub ...

#2202: Display page view count on dataset and resource pages

rgrp — Sat, 03 Mar 2012 09:04:15 GMT

Just like we display download counts we should display view counts.

#2331: Search should AND terms not OR terms

rgrp — Sat, 28 Apr 2012 18:24:45 GMT

Appears current default search in CKAN ORs terms rather than ANDing them (i.e. adding more terms increasing number of items found rather than reducing it).

Not sure when this crept in or if it has been there for a long time.