Ticket #14: Install.py

import string
from cStringIO import StringIO

from Products.CMFCore.utils import getToolByName
from Products.CMFCore.DirectoryView import addDirectoryViews

from Products.CMFPlone.migrations.migration_util import safeEditProperty
from Products.CMFCore.Expression import Expression, createExprContext

from Products.qPloneDropDownMenu.config import *

configlets = ({'id':PROJECT_NAME,
    'name':'Drop Down Menu',
    'action':'string:${portal_url}/prefs_dropdownmenu_edit_form',
    'condition':'',
    'category':'Products',
    'visible':1,
    'appId':PROJECT_NAME,
    'permission':VIEW_PERMISSION,
    'imageUrl':'qplonedropdownmenu.gif' },)

def registerCSS(self, out):

    qi = getToolByName(self, 'portal_quickinstaller', None)
    if qi is not None:
        try:
            if not qi.isProductInstalled('ResourceRegistries'):
                qi.installProduct('ResourceRegistries', locked=0)
            cssreg = getToolByName(self, 'portal_css', None)
            if cssreg is not None:
                stylesheet_ids = cssreg.getResourceIds()

                if 'drop_down.css' not in stylesheet_ids:
                    cssreg.registerStylesheet('drop_down.css',
                                               expression="python:portal.portal_dropdownmenu")
                    out.write('Register drop_down.css... \n')
                else:
                    out.write('drop_down.css already exists... \n')
        except:
            pass

def unregisterCSS(self, out):

    qi = getToolByName(self, 'portal_quickinstaller', None)
    if qi is not None:
        try:
            if not qi.isProductInstalled('ResourceRegistries'):
                qi.installProduct('ResourceRegistries', locked=0)
            cssreg = getToolByName(self, 'portal_css', None)
            if cssreg is not None:
                stylesheet_ids = cssreg.getResourceIds()

                if 'drop_down.css' in stylesheet_ids:
                    cssreg.unregisterResource('drop_down.css')
                    out.write('Unregister drop_down.css... \n')
        except:
            pass

def createMenuString(children, level=1, maxlevel=0, urls=None):
    """Iterates through dictionary of objects n levels down in site structure.
    Creates a HTML list to be used in drop down menu.

    Returns string.
    """
    
    retval = ''

    for child in children:
        # Test if the toplevel URL is supposed to be a tab
        if level == 1 and urls and not child['getURL'] in urls:
            continue
        if not child['no_display'] and not child['portal_type'] == 'Plone Site':
            retval += '<li id="portaltab-%s" class="plain"><a href="%s" accesskey="t">' % \
                      (child['path'], child['getURL']) + child['Title'] + '</a>'
            subchildren = child['children']
            if level <= maxlevel and len(subchildren) > 0:
                retval += '<ul>'
                retval += createMenuString(subchildren, level+1, maxlevel)
                retval += '</ul>'
            retval += '</li>\n'
    return retval

def updateMenu(self):
    out = ''

    # We work with the property sheet now - so we can keep existing dropdownmenu_level
    portal_props = getToolByName(self, 'portal_properties')
    if not hasattr(portal_props, PROPERTY_SHEET):
        portal_props.addPropertySheet(PROPERTY_SHEET, 'DropDown Menu Properties')
    ap = getattr(portal_props, PROPERTY_SHEET)

    dropdownmenu_level = 1
    if ap.hasProperty('dropdownmenu_level'):
        dropdownmenu_level = ap.getProperty('dropdownmenu_level')

    pu = getToolByName(self, 'plone_utils')

    # Uses createNavTree to autogenerate deeper menu structure
    if hasattr(pu, 'createNavTree'):
        
        #Translation service - used to translate homepage title
        homepage_title = 'Home'
        if hasattr(pu, 'translation_service'):
            translation_service = getToolByName(self, 'translation_service', None)
            if translation_service is not None:
                homepage_title = translation_service.utranslate( \
                    domain='plone', msgid='Home', \
                    context=self, \
                    default='Home')
                homepage_title = translation_service.encode(homepage_title, errors='replace')

        #Generates a list of toplevel URL's to test against in createMenuString()
        tl_urls = []
        if hasattr(pu, 'createTopLevelTabs'):
            pactions = getToolByName(self, 'portal_actions').listFilteredActionsFor(self)
            tl_tabs = pu.createTopLevelTabs(pactions)
            for url in tl_tabs:
                tl_urls.append(url['url'])

        # We are ready to get the navigation tree and generate an output string
        tl_nav = pu.createNavTree(self, sitemap=dropdownmenu_level)

        out += '<li id="portaltab-%s" class="plain"><a href="%s" accesskey="t">' % \
               (tl_nav['path'], tl_nav['getURL']) + homepage_title + '</a></li>\n'
        children = tl_nav.get('children', [])
        out += createMenuString(children, maxlevel=dropdownmenu_level, urls=tl_urls)
        
    else:
        portal = getToolByName(self, 'portal_url').getPortalObject()

        portal_act = getToolByName(self, 'portal_actions')
        actions=portal_act._cloneActions()

        for act in actions:
            if act.category == 'portal_tabs':
                out += '<li id="portaltab-%s" class="plain"><a href="%s" accesskey="t">%s</a></li>\n' % \
                    (act.id, \
                     Expression(act.getActionExpression())(createExprContext(portal, portal, portal)), \
                     act.title)

    safeEditProperty(ap, 'menu', out, 'text')
    safeEditProperty(ap, 'dropdownmenu_level', dropdownmenu_level, 'int')
  
def setupSkin(self, out, skinFolder):

    skinstool=getToolByName(self, 'portal_skins')

    addDirectoryViews(skinstool, SKINS_DIR, GLOBALS)

    for skin in skinstool.getSkinSelections():
        path = skinstool.getSkinPath(skin)
        path = map( string.strip, string.split( path,',' ) )

        if not skinFolder in path:
            try:
                path.insert( path.index( 'custom')+1, skinFolder )
            except ValueError:
                path.append(skinFolder)
            path = string.join( path, ', ' )
            skinstool.addSkinSelection( skin, path )
            out.write('  %s layer sucessfully installed into skin %s.\n' % (skinFolder, skin))
        else:
            out.write('  %s layer was already installed into skin %s.\n' % (skinFolder, skin))

def setupTool(self):

    portal_url = getToolByName(self, 'portal_url')
    p = portal_url.getPortalObject()
    x = p.manage_addProduct[PROJECT_NAME].manage_addTool(type='DropDownMenu Tool')

def install(self):
    out = StringIO()

    registerCSS(self, out)

    configTool = getToolByName(self, 'portal_controlpanel', None)
    if configTool:
        for conf in configlets:
            configTool.registerConfiglet(**conf)
            out.write('Added configlet %s\n' % conf['id'])

    if hasattr(self, UNIQUE_ID):
        self.manage_delObjects([UNIQUE_ID])
        out.write('Deleting old %s\n' % (UNIQUE_ID))
    setupTool(self)
    out.write('Added %s to the portal root folder\n' % (UNIQUE_ID))

    portal_props = getToolByName(self, 'portal_properties')
    if not hasattr(portal_props, PROPERTY_SHEET):
        out.write('updateMenu... \n')
        updateMenu(self)
    else:
        out.write('skipping updateMenu... \n')

    out.write('setupSkin... \n')
    setupSkin(self, out, 'qPloneDropDownMenu')

    return out.getvalue()

def uninstall(self):
    out = StringIO()

    unregisterCSS(self, out)

    configTool = getToolByName(self, 'portal_controlpanel', None)
    if configTool:
        for conf in configlets:
            configTool.unregisterConfiglet(conf['id'])
            out.write('Removed configlet %s\n' % conf['id'])

    return out.getvalue()