root/communesplone/CPComarquage/tags/1.0/ConfigurationMethods.py

# -*- coding: utf-8 -*-
#
# File: ConfigurationMethods.py
#
# Copyright (c) 2006 by CommunesPlone
#
# GNU General Public License (GPL)
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
# 02110-1301, USA.
#

__author__ = """Gauthier BASTIEN <gbastien@commune.sambreville.be>"""
__docformat__ = 'plaintext'

from zLOG import INFO, ERROR

from Products.CMFPlone.setup.SetupBase import SetupWidget
from Products.CMFCore.utils import getToolByName
from Products.CMFDefault.exceptions import MetadataError

from Products.CPComarquage.config import PROJECTNAME
from Products.CPComarquage.config import MAPNAME
from Products.CPComarquage.config import MAXRSS

from Products.CPComarquage.CustomizationPolicy import CPComarquageCustomizationPolicy

def installProducts(self, portal):
    """ Install necessary products """
    qi = getToolByName(portal, 'portal_quickinstaller')
    if not qi.isProductInstalled('CMFSin'):
        qi.installProduct('CMFSin')
    if not qi.isProductInstalled('CPComarquage'):
        qi.installProduct('CPComarquage')
    get_transaction().commit(1)


def updateSubjectsMetadata(self, portal):
    """ We add the differents subject from the 'Portail de la Région Wallonne' in the lists of Subject in portal_metadata """
    #retrieve every subjects from RSS
    meta_tool = getToolByName(portal, 'portal_metadata')
    sin = getToolByName(portal, 'sin_tool')
    rows = sin.sin(map_name=MAPNAME, max_size=MAXRSS)

    rss_subjects = []
    for row in rows:
        rss_subjects.append(unicode(row.get('category'), 'latin1').encode('utf-8'))

    element = meta_tool.getElementSpec('Subject')
    existing_subjects = list(element.getPolicy('Document').allowed_vocabulary)

    try:
        meta_tool.addElementPolicy(element='Subject',
                                content_type='Document',
                                is_required=0,
                                supply_default=0,
                                default_value="",
                                enforce_vocabulary=1,
                                allowed_vocabulary=tuple(rss_subjects)
                                ) 

    except MetadataError:
        #Policy already exist, we update the allowed_vocabulary
        #we add non existing subjects
        for subj in rss_subjects:
            if subj not in existing_subjects:
                existing_subjects.append(subj)

        #we sort by alphabetical order
        existing_subjects.sort()
        #we update the Policy
        meta_tool.updateElementPolicy(element='Subject',
                                      content_type='Document',
                                      is_required=0,
                                      supply_default=0,
                                      default_value="",
                                      enforce_vocabulary=1,
                                      allowed_vocabulary=tuple(existing_subjects)
                                      ) 


functions = {
             'installProducts': installProducts,
             'updateSubjectsMetadata': updateSubjectsMetadata
            }

class CPComarquageSetup(SetupWidget):
   type = 'CPComarquage Setup'

   description = "Permet d'adapter le portail pour l'utilisation du produit CPComarquage"

   functions = functions

   single = 0

   def __init__(self,portal):
       self.portal = portal

   def setup(self):
       pass

   def delItems(self,fns):
       out = []
       out.append(('Currently, there is no way to remove a function',INFO))
       return out

   def addItems(self,fns):
       out = []
       for fn in fns:
           self.functions[fn](self, self.portal)
           out.append(('Function %s has been applied' % fn, INFO))
       return out

   def active(self):
       return 1

   def installed(self):
       return []

   def available(self):
       """ Go get the functions """
       functionList = ('installProducts', 'updateSubjectsMetadata')
       #we return a list of functions because de dictionnary is not sorted and we need some king of sorting here (installProducts first, ...)
       #return self.functions.keys()
       return functionList