Migration script from Products.Slideshow to Products.Carousel

Here is a sample migration code to transform your site from one add-on to another.

We create a migration view which you can call by typing in view name manually to web browser.

This code will

  • Scan site for folders which have Slideshow add-on enabled. In this example we check against a predefined list (scanned earlier), but the code contains example how to detect slideshow folders
  • Create Carousel for those folders
  • Create corresponds Carousel Banners for all Slideshow Image content items
  • Set some Carousel settings
  • Make sure that we invalidate cache for content items going through migration
  • Set a new default view for folders which were using slideshow


  • After inspecting the process was ok you can delete migrated images



    Migrate slideshow to carousel.


    http://yoursite/@@migrate_carousel - the process can be repeated with adjusted settings. It's non-descructive.



import logging
from StringIO import StringIO
from Products.Five.browser import BrowserView

from zope.component import getUtility, getMultiAdapter
from zope.app.component.hooks import setHooks, setSite, getSite

from zope.interface import alsoProvides
from Products.Five import BrowserView
from Products.CMFCore.utils import getToolByName
from Products.Carousel.interfaces import ICarouselFolder
from Products.Carousel.utils import addPermissionsForRole
from Products.Carousel.config import CAROUSEL_ID
from Products.Carousel.interfaces import ICarousel, ICarouselSettings

from Products.slideshowfolder.interfaces import ISlideShowSettings, ISlideShowView, IFolderSlideShowView, ISlideShowFolder, ISlideshowImage

logger = logging.getLogger("Slideshow Migrator")

('', 'site', 'folder1')
('', 'site', 'folder2')
('', 'site', 'folder2', 'subfolder')

class MigrateSlideshowToCarousel(BrowserView):
    Migrate collective.slideshow to Products.Carousel

    def startCapture(self, newLogLevel = None):
        """ Start capturing log output to a string buffer.


        @param newLogLevel: Optionally change the global logging level, e.g. logging.DEBUG
        self.buffer = StringIO()

        print >> self.buffer, "Log output"

        rootLogger = logging.getLogger()

        if newLogLevel:
            self.oldLogLevel = rootLogger.getEffectiveLevel()
            self.oldLogLevel = None

        self.logHandler = logging.StreamHandler(self.buffer)
        formatter = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")

    def stopCapture(self):
        """ Stop capturing log output.

        @return: Collected log output as string

        # Remove our handler
        rootLogger = logging.getLogger()

        # Restore logging level (if any)
        if self.oldLogLevel:



        return self.buffer.getvalue()

    def getImages(self, folder):
        """ Get all ATImages in a folder """
        for obj in folder.objectValues():
            if obj.portal_type == "Image":
                yield obj

    def getOrCreateCarousel(self, folder):
        """ Copied from Products.Carousel manager.py """

        if hasattr(folder.aq_base, CAROUSEL_ID):
            logger.info("Using existing carousel in " + str(folder))
            carousel = getattr(folder, CAROUSEL_ID)
            logger.info("Creating carousel in " + str(folder))
            pt = getToolByName(folder, 'portal_types')
            newid = pt.constructContent('Folder', folder, 'carousel', title='Carousel Banners', excludeFromNav=True)
            carousel = getattr(folder, newid)

            # mark the new folder as a Carousel folder
            alsoProvides(carousel, ICarouselFolder)

            # make sure Carousel banners are addable within the new folder
            addPermissionsForRole(carousel, 'Manager', ('Carousel: Add Carousel Banner',))

            # make sure *only* Carousel banners are addable
            carousel.setLocallyAllowedTypes(['Carousel Banner'])
            carousel.setImmediatelyAddableTypes(['Carousel Banner'])

        return carousel

    def imageToCarouselBanner(self, image, carousel):
        Convert ATImage to Carousel Banner content item.

        logger.info("Migrating slideshow image:" + str(image.getId()))

        id = image.getId()

        if not id in carousel.objectIds():
            carousel.invokeFactory("Carousel Banner", id, title=image.Title())
            logger.info("Carousel image already existed " + str(image))

        banner = carousel[id]

        # Copy over image field from ATImage content type

        # Set a hidden flag which allows us later to delete images
        image._migrated_to_carousel = True

    def setupCarousel(self, carousel_folder):
        Set-up custom carousel settings for all carousels.

        logger.info("Setting carousel settings for:" + carousel_folder.absolute_url())

        settings = ICarouselSettings(carousel_folder)

        settings.width = 640
        settings.height = 450
        settings.pager_template = u'@@pager-none'
        settings.default_page_only = False
        settings.element_id = "karuselli"
        settings.transition_delay = 5.0
        settings.banner_elements = [ u"image" ]

    def migrateFolder(self, folder):
        """ Migrate one folder from Slideshow to Products.Carousel
        logger.info("Migrating folder:" + str(folder))

        carousel = self.getOrCreateCarousel(folder)


        images = self.getImages(folder)
        for image in images:
            self.imageToCarouselBanner(image, carousel)

        # This will toggle cache refresh for the object
        # if Products.CacheSetup is used -> should invalidate template cache.
        # Not necessary if Products.CacheSetup is not installed.

        # Toggle folder away from slideshow view
        # empty_view is our custom view which does not list folder contents

        # Set a marker flag in the case we need to play around with these
        # folderes programmatically in the future
        folder._migrated_to_carousel = True

    def migrate(self):
        Run the migration process for one Plone site.

        brains = self.context.portal_catalog(portal_type="Folder")

        # Use predefined report of slideshow folder on old site
        # Alternative: detect slideshow folders as shown below
        carousel_folders  = FOLDER_PATHS_TO_MIGRATE.split("\n")

        for b in brains:

            obj = b.getObject()

            path = str(obj.getPhysicalPath())

            # Alternative: if you don't have fixed list check here if getattr(obj, "default_view", "") == "slideshow_view"
            if path in carousel_folders:

    def __call__(self):
        """ Process the form.

        Process the form, log the output and show the output to the user.

        self.logs = None


            logger.info("Starting full site migration")

            # Do the long running,
            # lots of logging stuff

            logger.info("Succesfully done")

        except Exception, e:
            # Show friendly error message

        # Put log output for the page template access
        self.logs = self.stopCapture()

        return self.logs

class DeleteMigratedImages(BrowserView):
    Delete all slideshow image files which have been migrated to carousel banners.

    By doing migration in two phases allows us to adjust the process in the case it goes wrong.

    def __call__(self):


        self.buffer = StringIO()

        print >> self.buffer, "Log output"

        brains = self.context.portal_catalog(portal_type="Image")
        for b in brains:
            obj = b.getObject()
            if getattr(obj, "_migrated_to_carousel", False) == True:
                print >> self.buffer, "Deleting migrated Image " + obj.getId()
                id = obj.getId()
                parent = obj.aq_parent

        print >> self.buffer, "All migrated images deleted"

        return self.buffer.getvalue()

ZCML bits:



\"\" Subscribe to RSS feed Follow me on Twitter Follow me on Facebook Follow me Google+

One thought on “Migration script from Products.Slideshow to Products.Carousel

  1. Mikko-

    Thanks, this looks really useful! We’ll link here from the slideshow folder and carousel docs! Note that the proper product name is “Products.SlideshowFolder” not “Products.Slideshow.” And, also that Nathan Van Gheem’s collective.easyslideshow is probably a more direct “apples-to-apples” replacement for SlideshowFolder, and also a really great product.

Leave a Reply

Your email address will not be published. Required fields are marked *