[1720][forms] Update for change in location of vocabulary get function
[ckanext-datagovau.git] / ckanext / example / forms.py
blob:a/ckanext/example/forms.py -> blob:b/ckanext/example/forms.py
--- a/ckanext/example/forms.py
+++ b/ckanext/example/forms.py
@@ -1,55 +1,43 @@
-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, convert_to_tags, convert_from_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, NotFound
 from ckan.logic.schema import package_form_schema, group_form_schema
-import ckan.logic.validators as val
-from ckan.model import vocabulary
-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, IConfigurable
+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, not_empty
+import ckan.lib.plugins
 
 log = logging.getLogger(__name__)
+
+GENRE_VOCAB = u'genre_vocab'
+COMPOSER_VOCAB = u'composer_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
         found in the ``ini``-file.  Here we use it to specify where the
         form templates can be found.
-        
+
       - ``IGroupForm`` allows us to provide a custom form for a dataset
-        based on the 'type' that may be set for a group.  Where the 
-        'type' matches one of the values in group_types then this 
-        class will be used. 
+        based on the 'type' that may be set for a group.  Where the
+        'type' matches one of the values in group_types then this
+        class will be used.
     """
     implements(IGroupForm, inherit=True)
-    implements(IConfigurer, inherit=True)    
-    
+    implements(IConfigurer, inherit=True)
+
     def update_config(self, config):
         """
         This IConfigurer implementation causes CKAN to look in the
@@ -61,12 +49,12 @@
                                     'example', 'theme', 'templates')
         config['extra_template_paths'] = ','.join([template_dir,
                 config.get('extra_template_paths', '')])
-            
+
     def group_form(self):
         """
         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):
@@ -87,11 +75,11 @@
         Returns true iff this provides the fallback behaviour, when no other
         plugin instance matches a group'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 False
+
     def form_to_db_schema(self):
         """
         Returns the schema for mapping group data from a form to a format
@@ -105,7 +93,7 @@
         format suitable for the form (optional)
         """
         return {}
-        
+
     def check_data_dict(self, data_dict):
         """
         Check if the return data is correct.
@@ -116,10 +104,10 @@
     def setup_template_variables(self, context, data_dict):
         """
         Add variables to c just prior to the template being rendered.
-        """                
-                
-
-class ExampleDatasetForm(SingletonPlugin):
+        """
+
+
+class ExampleDatasetForm(SingletonPlugin, ckan.lib.plugins.DefaultDatasetForm):
     """This plugin demonstrates how a theme packaged as a CKAN
     extension might extend CKAN behaviour.
 
@@ -129,14 +117,14 @@
         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(IConfigurable)
-    
+    implements(IConfigurer, inherit=True)
+    implements(IGenshiStreamFilter, inherit=True)
+
     def update_config(self, config):
         """
         This IConfigurer implementation causes CKAN to look in the
@@ -149,24 +137,11 @@
         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 = 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()
-
     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):
@@ -174,7 +149,7 @@
         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 True
@@ -196,11 +171,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.genre_tags = get_action('tag_list')(context, {'vocabulary_id': GENRE_VOCAB})
+            c.composer_tags = get_action('tag_list')(context, {'vocabulary_id': COMPOSER_VOCAB})
+        except NotFound:
+            c.vocab_tags = None
+            c.composer_tags = None
 
         ## This is messy as auths take domain object not data_dict
         pkg = context.get('package') or c.pkg
@@ -215,11 +196,12 @@
         """
         schema = package_form_schema()
         schema.update({
-            'published_by': [not_empty, unicode, convert_to_extras],
-            'vocab_tag_string': [ignore_missing, convert_to_tags(self.vocab_name)],
+            'published_by': [ignore_missing, unicode, convert_to_extras],
+            'genre_tags': [ignore_missing, convert_to_tags(GENRE_VOCAB)],
+            'composer_tags': [ignore_missing, convert_to_tags(COMPOSER_VOCAB)]
         })
         return schema
-    
+
     def db_to_form_schema(self):
         """
         Returns the schema for mapping package data from the database into a
@@ -228,11 +210,20 @@
         schema = package_form_schema()
         schema.update({
             'tags': {
-                '__extras': [keep_extras]
+                '__extras': [keep_extras, free_tags_only]
             },
-            'vocab_tag_string': [convert_from_tags(self.vocab_name), ignore_missing],
+            'genre_tags_selected': [
+                convert_from_tags(GENRE_VOCAB), ignore_missing
+            ],
+            'composer_tags_selected': [
+                convert_from_tags(COMPOSER_VOCAB), ignore_missing
+            ],
             'published_by': [convert_from_extras, ignore_missing],
         })
+        schema['groups'].update({
+            'name': [not_empty, unicode],
+            'title': [ignore_missing]
+        })
         return schema
 
     def check_data_dict(self, data_dict):
@@ -241,4 +232,37 @@
         """
         return
 
-
+    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')
+        context = {'model': model}
+        if routes.get('controller') == 'package' \
+            and routes.get('action') == 'read':
+                for vocab in (GENRE_VOCAB, COMPOSER_VOCAB):
+                    try:
+                        vocab = get_action('vocabulary_show')(context, {'id': vocab})
+                        vocab_tags = [t for t in c.pkg_dict.get('tags', [])
+                                      if t.get('vocabulary_id') == vocab['id']]
+                    except NotFound:
+                        vocab_tags = None
+
+                    if not vocab_tags:
+                        continue
+
+                    html = '<li class="sidebar-section">'
+                    if vocab['name'] == GENRE_VOCAB:
+                        html = html + '<h3>Musical Genre</h3>'
+                    elif vocab['name'] == COMPOSER_VOCAB:
+                        html = html + '<h3>Composer</h3>'
+                    html = html + '<ul class="tags clearfix">'
+                    for tag in vocab_tags:
+                        html = html + '<li>%s</li>' % tag['name']
+                    html = html + "</ul></li>"
+                    stream = stream | Transformer(
+                        "//div[@id='sidebar']//ul[@class='widget-list']"
+                    ).append(HTML(html))
+        return stream
+