--- a/ckanext/example/forms.py +++ b/ckanext/example/forms.py @@ -1,40 +1,27 @@ -import os, logging +import os +import 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.logic.converters import convert_to_extras,\ + convert_from_extras, convert_to_tags, convert_from_tags, free_tags_only +from ckan.logic import get_action, NotFound +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 +from ckan.plugins import IGenshiStreamFilter 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, keep_extras log = logging.getLogger(__name__) + +EXAMPLE_VOCAB = u'example_vocab' + class ExampleGroupForm(SingletonPlugin): """This plugin demonstrates how a class packaged as a CKAN extension might extend CKAN behaviour by providing custom forms based on the type of a Group. - In this case, we implement two extension interfaces to provide custom + In this case, we implement two extension interfaces to provide custom forms for specific types of group. - ``IConfigurer`` allows us to override configuration normally @@ -47,7 +34,7 @@ class will be used. """ implements(IGroupForm, inherit=True) - implements(IConfigurer, inherit=True) + implements(IConfigurer, inherit=True) def update_config(self, config): """ @@ -65,7 +52,7 @@ """ Returns a string representing the location of the template to be rendered. e.g. "forms/group_form.html". - """ + """ return 'forms/group_form.html' def group_types(self): @@ -79,7 +66,7 @@ attempts to register more than one plugin instance to a given group type will raise an exception at startup. """ - return ["example_group_form"] + return ["testgroup"] def is_fallback(self): """ @@ -128,12 +115,13 @@ found in the ``ini``-file. Here we use it to specify where the form templates can be found. - ``IDatasetForm`` allows us to provide a custom form for a dataset - based on the type_name that may be set for a package. Where the - type_name matches one of the values in package_types then this - class will be used. + based on the type_name that may be set for a package. Where the + type_name matches one of the values in package_types then this + class will be used. """ implements(IDatasetForm, inherit=True) implements(IConfigurer, inherit=True) + implements(IGenshiStreamFilter) def update_config(self, config): """ @@ -147,11 +135,45 @@ config['extra_template_paths'] = ','.join([template_dir, config.get('extra_template_paths', '')]) + # def configure(self, config): + # ''' + # Adds some new vocabularies to the database if they don't already exist. + + # ''' + # # Add a 'genre' vocabulary with some tags. + # self.genre_vocab = model.Vocabulary.get('Genre') + # if not self.genre_vocab: + # log.info("Adding vocab Genre") + # self.genre_vocab = model.Vocabulary('Genre') + # model.Session.add(self.genre_vocab) + # model.Session.commit() + # log.info("Adding example tags to vocab %s" % self.genre_vocab.name) + # jazz_tag = model.Tag('jazz', self.genre_vocab.id) + # soul_tag = model.Tag('soul', self.genre_vocab.id) + # model.Session.add(jazz_tag) + # model.Session.add(soul_tag) + # model.Session.commit() + + # # Add a 'composer' vocabulary with some tags. + # self.composer_vocab = model.Vocabulary.get('Composer') + # if not self.composer_vocab: + # log.info("Adding vocab Composer") + # self.composer_vocab = model.Vocabulary('Composer') + # model.Session.add(self.composer_vocab) + # model.Session.commit() + # log.info("Adding example tags to vocab %s" % + # self.composer_vocab.name) + # mintzer_tag = model.Tag('Bob Mintzer', self.composer_vocab.id) + # lewis_tag = model.Tag('Steve Lewis', self.composer_vocab.id) + # model.Session.add(mintzer_tag) + # model.Session.add(lewis_tag) + # model.Session.commit() + def package_form(self): """ Returns a string representing the location of the template to be rendered. e.g. "package/new_package_form.html". - """ + """ return 'forms/dataset_form.html' def is_fallback(self): @@ -159,10 +181,10 @@ Returns true iff this provides the fallback behaviour, when no other plugin instance matches a package's type. - As this is not the fallback controller we should return False. If + 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): """ @@ -181,11 +203,17 @@ """ Adds variables to c just prior to the template being rendered that can then be used within the form - """ + """ c.licences = [('', '')] + model.Package.get_license_options() c.publishers = [('Example publisher', 'Example publisher 2')] c.is_sysadmin = Authorizer().is_sysadmin(c.user) c.resource_columns = model.Resource.get_columns() + try: + c.vocab_tags = get_action('tag_list')(context, {'vocabulary_id': EXAMPLE_VOCAB}) + # c.genre_tags = get_action('tag_list')(context, {'vocabulary_id': self.genre_vocab.name}) + # c.composer_tags = get_action('tag_list')(context, {'vocabulary_id': self.composer_vocab.name}) + except NotFound: + c.vocab_tags = None ## This is messy as auths take domain object not data_dict pkg = context.get('package') or c.pkg @@ -198,64 +226,32 @@ 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(), - - '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], - } + schema = package_form_schema() + schema.update({ + 'published_by': [ignore_missing, unicode, convert_to_extras], + 'vocab_tags': [ignore_missing, convert_to_tags(EXAMPLE_VOCAB)], + # 'genre_tags': [ignore_missing, convert_to_tags(self.genre_vocab.name)], + # 'composer_tags': [ignore_missing, convert_to_tags(self.composer_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(EXAMPLE_VOCAB), ignore_missing], + # 'genre_tags_selected': [convert_from_tags(self.genre_vocab.name), + # ignore_missing], + # 'composer_tags_selected': [ + # convert_from_tags(self.composer_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): @@ -264,4 +260,29 @@ """ return - + def filter(self, stream): + return stream + + # def filter(self, stream): + # # Add vocab tags to the bottom of the sidebar. + # from pylons import request + # from genshi.filters import Transformer + # from genshi.input import HTML + # routes = request.environ.get('pylons.routes_dict') + # if routes.get('controller') == 'package' \ + # and routes.get('action') == 'read': + # for vocab in (self.genre_vocab, self.composer_vocab): + # vocab_tags = [tag for tag in c.pkg_dict.get('tags', []) + # if tag.get('vocabulary_id') == vocab.id] + # if not vocab_tags: + # continue + # html = '
  • ' + # html = html + '

    %s

    ' % vocab.name + # html = html + '
    • " + # stream = stream | Transformer("//div[@id='sidebar']")\ + # .append(HTML(html)) + # return stream +