Package: collective.optimage
Table of contentsIntroductionHow it worksSupported softwareAdding your ownTips and know issuesCommand line tool positionContent typesPerformanceOn performance (again)ChangelogIntroductionThis Plone add-on perform (lossless) optimization image content types, using external processes.NoteThis software is inalpha version. Using this in a production site can hurt your performance.Read documentationcarefully.How it worksYour site users will continue to load image contents normally, but the data loaded will be taken from
external optimization software (that must live on the server) for executingimage lossless transformation.In this way the final result will be commonly an smaller image, loaded quickly by browsers.By default adding this plugin is not enough. You must include all supported software you have installed
on you server (or limiting it to what you want to use).To do this, include a proper zcml file in your buildout configuration:[instance]
...
    eggs =
        Plone
        ...
        collective.optimage

    zcml =
        ...
        collective.optimage:wantedoptimizator1.zcml
        collective.optimage:wantedoptimizator2.zcml
        ...AllwantedoptimizatorXentries must be one of the supported software below.
An example:zcml =
    collective.optimage:jpegoptim.zcml
    collective.optimage:optipng.zcmlTo include them all (excluded pngout), just include the “all.zcml”.Supported softwareRight now this product supports those command line tools:jpegoptimFor JPEG optimization -http://freecode.com/projects/jpegoptimjpegtranFor JPEG optimization -http://jpegclub.org/jpegtran/gifscicleFor GIT optimization -http://www.lcdf.org/gifsicle/optipngFor PNG optimization -http://optipng.sourceforge.net/pngcrushFor PNG optimization -http://pmt.sourceforge.net/pngcrush/pngout(slow)For PNG optimization-http://advsys.net/ken/util/pngout.htmAdding your ownIf you like to provide support for additional software, you can do it using ZCA in your own products.
You need to provide a named adapter for theIOptimageProvider interface.An example:<adapter
        name="yournewsoftware"
    for="plone.app.blob.interfaces.IATBlobImage
         zope.publisher.interfaces.browser.IHTTPRequest"
    provides="collective.optimage.interfaces.IOptimageProvider"
    factory="yout.products.module.YourSoftwareAdapter"
    />Finally, your adapter class will be something like this:from zope.interface import implements
from collective.optimage.interfaces import IOptimageProvider

class YourSoftwareAdapter(object):
    """Optimize using yournewsoftware"""
    implements(IOptimageProvider)

    for_image = 'jpeg'

    def optimize(self):
        // do stuff, calling external processNote that you must fill thefor_imageproviding the image type you want to threat with your plugin.Tips and know issuesCommand line tool positionRight now this product will try to run all of the software given above simply calling them.
If the program is not available at the user that run Zope process you could like to manually specify where
is it.
The same if the software has been manually installed (for example: if you manually downloaded
and installed it inside a buildout installation and not system wide).To do this, provide a environment var called “SOFTWARENAME_PATH”. An example:[instance]

...

environment-vars =
    ...
    JPEGOPTIM_PATH /opt/local/bin/jpegoptimContent typesRight now Plone Image content type is the only one supported. Unluckily Plone News item is still not using
Zope BLOB support so it will not gain any optimization.PerformanceOperations done by external processes are synchronous, soblocking the Zope thread.
This will lower your site performance when an editor is providing new images
(or modifying existings ones).You can make them quicker (but less efficient), playing with configuration options.On performance (again)Right now optimization are doneafterthe image has been loaded on Plone. An event is fired after
the image source change, then the image is put on a temp file and then processed.
After that the optimized image is loaded again.This is also done for all scaled image versions.This is inefficient, so probably will change in future, however is the only way I found without monkey-patch
Plone.Changelog0.1.0 (2012-06-30)Initial release