vocab tags instead of standard (free) input field
--- a/ckanext/example/forms.py
+++ b/ckanext/example/forms.py
@@ -1,31 +1,13 @@
import os, logging
from ckan.authz import Authorizer
-import ckan.logic.action.create as create
-import ckan.logic.action.update as update
-import ckan.logic.action.get as get
-from ckan.logic.converters import date_to_db, date_to_form, convert_to_extras, convert_from_extras
-from ckan.logic import NotFound, NotAuthorized, ValidationError
-from ckan.logic import tuplize_dict, clean_dict, parse_params
-import ckan.logic.schema as default_schema
-from ckan.logic.schema import group_form_schema
-from ckan.logic.schema import package_form_schema
-import ckan.logic.validators as val
-from ckan.lib.base import BaseController, render, c, model, abort, request
-from ckan.lib.base import redirect, _, config, h
-from ckan.lib.package_saver import PackageSaver
-from ckan.lib.field_types import DateType, DateConvertError
-from ckan.lib.navl.dictization_functions import Invalid
-from ckan.lib.navl.dictization_functions import validate, missing
-from ckan.lib.navl.dictization_functions import DataError, flatten_dict, unflatten
-from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer
+from ckan.logic.converters import convert_to_extras,\
+ convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only
+from ckan.logic import get_action
+from ckan.logic.schema import package_form_schema, group_form_schema
+from ckan.lib.base import c, model
+from ckan.plugins import IDatasetForm, IGroupForm, IConfigurer, IConfigurable
from ckan.plugins import implements, SingletonPlugin
-
-from ckan.lib.navl.validators import (ignore_missing,
- not_empty,
- empty,
- ignore,
- keep_extras,
- )
+from ckan.lib.navl.validators import ignore_missing, not_empty, keep_extras
log = logging.getLogger(__name__)
@@ -134,6 +116,7 @@
"""
implements(IDatasetForm, inherit=True)
implements(IConfigurer, inherit=True)
+ implements(IConfigurable)
def update_config(self, config):
"""
@@ -147,6 +130,25 @@
config['extra_template_paths'] = ','.join([template_dir,
config.get('extra_template_paths', '')])
+ def configure(self, config):
+ """
+ Adds our new vocabulary to the database if it doesn't
+ already exist.
+ """
+ self.vocab_name = u'example_vocab'
+ v = model.Vocabulary.get(self.vocab_name)
+ if not v:
+ log.info("Adding vocab %s" % self.vocab_name)
+ vocab = model.Vocabulary(self.vocab_name)
+ model.Session.add(vocab)
+ model.Session.commit()
+ log.info("Adding example tags to vocab %s" % self.vocab_name)
+ vocab_tag_1 = model.Tag('vocab-tag-example-1', vocab.id)
+ vocab_tag_2 = model.Tag('vocab-tag-example-2', vocab.id)
+ model.Session.add(vocab_tag_1)
+ model.Session.add(vocab_tag_2)
+ model.Session.commit()
+
def package_form(self):
"""
Returns a string representing the location of the template to be
@@ -162,7 +164,7 @@
As this is not the fallback controller we should return False. If
we were wanting to act as the fallback, we'd return True
"""
- return False
+ return True
def package_types(self):
"""
@@ -186,6 +188,7 @@
c.publishers = [('Example publisher', 'Example publisher 2')]
c.is_sysadmin = Authorizer().is_sysadmin(c.user)
c.resource_columns = model.Resource.get_columns()
+ c.vocab_tags = get_action('tag_list')(context, {'vocabulary_name': self.vocab_name})
## This is messy as auths take domain object not data_dict
pkg = context.get('package') or c.pkg
@@ -198,64 +201,26 @@
Returns the schema for mapping package data from a form to a format
suitable for the database.
"""
- schema = {
- 'title': [not_empty, unicode],
- 'name': [not_empty, unicode, val.name_validator, val.package_name_validator],
-
- 'date_released': [date_to_db, convert_to_extras],
- 'date_updated': [date_to_db, convert_to_extras],
- 'date_update_future': [date_to_db, convert_to_extras],
- 'url': [unicode],
- 'taxonomy_url': [unicode, convert_to_extras],
-
- 'resources': default_schema.default_resource_schema(),
-
+ schema = package_form_schema()
+ schema.update({
'published_by': [not_empty, unicode, convert_to_extras],
- 'published_via': [ignore_missing, unicode, convert_to_extras],
- 'author': [ignore_missing, unicode],
- 'author_email': [ignore_missing, unicode],
- 'mandate': [ignore_missing, unicode, convert_to_extras],
- 'license_id': [ignore_missing, unicode],
- 'tag_string': [ignore_missing, val.tag_string_convert],
- 'national_statistic': [ignore_missing, convert_to_extras],
- 'state': [val.ignore_not_admin, ignore_missing],
-
- 'log_message': [unicode, val.no_http],
-
- '__extras': [ignore],
- '__junk': [empty],
- }
+ 'vocab_tags': [ignore_missing, convert_to_tags(self.vocab_name)],
+ })
return schema
- def db_to_form_schema(data):
+ def db_to_form_schema(self):
"""
Returns the schema for mapping package data from the database into a
format suitable for the form (optional)
"""
- schema = {
- 'date_released': [convert_from_extras, ignore_missing, date_to_form],
- 'date_updated': [convert_from_extras, ignore_missing, date_to_form],
- 'date_update_future': [convert_from_extras, ignore_missing, date_to_form],
- 'precision': [convert_from_extras, ignore_missing],
- 'taxonomy_url': [convert_from_extras, ignore_missing],
-
- 'resources': default_schema.default_resource_schema(),
- 'extras': {
- 'key': [],
- 'value': [],
- '__extras': [keep_extras]
+ schema = package_form_schema()
+ schema.update({
+ 'tags': {
+ '__extras': [keep_extras, free_tags_only]
},
- 'tags': {
- '__extras': [keep_extras]
- },
-
+ 'vocab_tags_selected': [convert_from_tags(self.vocab_name), ignore_missing],
'published_by': [convert_from_extras, ignore_missing],
- 'published_via': [convert_from_extras, ignore_missing],
- 'mandate': [convert_from_extras, ignore_missing],
- 'national_statistic': [convert_from_extras, ignore_missing],
- '__extras': [keep_extras],
- '__junk': [ignore],
- }
+ })
return schema
def check_data_dict(self, data_dict):