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, convert_to_tags
-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.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
-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.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):
"""
@@ -146,6 +129,25 @@
'example', 'theme', 'templates')
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):
"""
@@ -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
@@ -201,11 +204,11 @@
schema = package_form_schema()
schema.update({
'published_by': [not_empty, unicode, convert_to_extras],
- 'vocab_tag_string': [ignore_missing, convert_to_tags('example_vocab')],
+ '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)
@@ -213,8 +216,9 @@
schema = package_form_schema()
schema.update({
'tags': {
- '__extras': [keep_extras]
+ '__extras': [keep_extras, free_tags_only]
},
+ 'vocab_tags_selected': [convert_from_tags(self.vocab_name), ignore_missing],
'published_by': [convert_from_extras, ignore_missing],
})
return schema
--- a/ckanext/example/theme/templates/forms/dataset_form.html
+++ b/ckanext/example/theme/templates/forms/dataset_form.html
@@ -137,7 +137,7 @@
<dt class="tags-label"><label class="field_opt" for="tags">Tags</label></dt>
<dd class="tags-field">
<input class="long autocomplete-tag" id="tag_string" name="tag_string" size="60" type="text"
- value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', [])])}" />
+ value="${data.get('tag_string') or ', '.join([tag['name'] for tag in data.get('tags', []) if not tag.get('vocabulary_id')])}" />
</dd>
<dd class="tags-instructions instructions basic" i18n:msg="">Comma-separated terms that may link this dataset to similar ones. For more information on conventions, see <a href="http://wiki.okfn.org/ckan/doc/faq#TagConventions">this wiki page</a>.</dd>
<dd class="tags-instructions hints">e.g. pollution, rivers, water quality</dd>
@@ -147,8 +147,14 @@
<dl>
<dt class="tags-label"><label class="field_opt" for="tags_vocab">Tags</label></dt>
<dd class="tags-field">
- <input class="long autocomplete-tag" id="vocab_tag_string" name="vocab_tag_string" size="60" type="text"
- value="${data.get('vocab_tag_string') or ', '.join([tag['name'] for tag in data.get('vocab_tags', [])])}" />
+ <select id="vocab_tags" name="vocab_tags" size="60" multiple="multiple">
+ <py:for each="tag in c.vocab_tags">
+ <py:choose test="">
+ <option py:when="tag in data.get('vocab_tags_selected', [])" selected="selected" value="${tag}">${tag}</option>
+ <option py:otherwise="" value="${tag}">${tag}</option>
+ </py:choose>
+ </py:for>
+ </select>
</dd>
<dd class="tags-instructions instructions basic" i18n:msg="">Similar to standard CKAN tags, but these use a fixed vocabulary.</dd>
<dd class="tags-instructions field_error" py:if="errors.get('vocab_tag_string', '')">${errors.get('vocab_tag_string', '')}</dd>