Screenshots

An user is visiting a folder where content provide files that can be downloaded. The ZIP folder icon is in the document actions.

He clicks the ZIP icons and reads the amount of content objects that will provide files and images if he clicks the dondload.

PloneFilesZip

By the Ingeniweb team.

[rel_path "/"] content_id "/" field_id "/" file_name

[rel_path "/"] content_id ".rdf"

try:
    from Products.PloneZipFiles import HAS_PLONE_FILES_ZIP
except ImportError, e:
    HAS_PLONE_FILES_ZIP = False
...
if HAS_PLONE_FILES_ZIP:
    from Products.PloneZipFiles.interfaces import IFieldRetriever
    from Products.PloneZipFiles.registry import GlobalRegistry

    class MyFieldRetriever:

        __implements__ = Products.IFieldRetriever

        field_type = 'my_field'

        def __init__(self, field, content):
            ...

        def fileName(self):
            ...

        def mimeType(self):
            ...

        def fileBody(self):
            ...

    GlobalRegistry.register(MyFieldRetriever)

try:
    from Products.PloneZipFiles import HAS_PLONE_FILES_ZIP
except ImportError, e:
    HAS_PLONE_FILES_ZIP = False
...
if HAS_PLONE_FILES_ZIP:
    from Products.PloneZipFiles.interfaces import ITypeRetriever
    from Products.PloneZipFiles.registry import GlobalRegistry

    class MyTypeRetriever:

        __implements__ = Products.ITypeRetriever

        meta_type = 'my_type'

      def __init__(self, content):
          ...

      def getFieldRetrievers(self):
          ...

    GlobalRegistry.register(MyFieldRetriever)

from Products.PloneFilesZip.interfaces import IZipStructurePolicy
from Products.PloneFilesZip.policies import AbstractZipStructurePolicy, PolicyRegistry

class MyZipStructurePolicy(AbstractZipStructurePolicy):
    '''
        The inner structure of the zip file
        corresponds to the inner structure of the objects.
    '''

    __implements__ = (IZipStructurePolicy,)

    id = 'my_policy_id'
    label = "Policy title"
    label_msgid = 'my_policy_title_i18n_msgid'
    help = "Policy help text"
    help_msgid = "my_policy_help_i18n_msgid"


    def getZipFilePath(self,
                    container_path=None,
                    file_name=None,
                    field_path=None,):
        ...

PolicyRegistry.registerPolicy(MyZipStructurePolicy)

svn co http://svn.plone.org/svn/collective/PloneFilesZip/trunk PloneFilesZip

FAQ

Q: Why can't we see the amount of data yhat will be downloaded before

clicking the "Download" button ?

A: Because we need to build the ZIP archive before the intermediate

template for this. This might be resources expensive.

Q: I installed PloneFileZip but the icon doesn't show in the document

actions of a folder that has files and images. What's going on ?

A: You probably forgot to tweak PloneFilesZip. Go in ZMI and open

"Properties" tab of the "portal_fileszip" object. Select one or more portal types. You can do this in the configlet too.

Q: I want to show the download icon only under some conditions. I

don't want to enable any user to download content. How do I do this?

A: In ZMI, go in the "Actions" tab of the "portal_fileszip"

object. Change the "Condition" and/or "Permission" associated with the "zip" action.

Q: What about security ?

A: When building the ZIP file, PloneFilesZip includes only the files

in content objects the user is allowed to view.

Q: The structure of the zip file looks strange. Why ?

A: Please read the README.txt at the root of PloneFilesZip. This is

done intentionally to prevent potential duplicate file names in the zip file. In example, imagine you have a custom content type with two FileFields, an a user fills both fields with two files with the same name. In that case, the zip file would contain only the second. The zip inner format policy ensures you got both files even if they have the same name.

Q: I made an AT content type with a FileField an an ImageField. This

content type doesn't show in the "Properties" tab of the "portal_fileszip" object in ZMI, neither in the configlet. What's going on ?

A: Did you build a content with standard AT schema ? Did you change

the schema with ATSchemaEditorNG or such AT extension ? If the answer is "yes", you should consider to develop and register a custom type retriever. More details in the README.tx that comes with PloneFilesZip.

Q: Most of my users are Windows users, my Plone site publishes in

UTF-8, the file names have strange characters in the zip archive.

A: You should check and change the "zipCharset" property in in the

"Properties" tab of the "portal_fileszip" object in ZMI or in the configlet. Using "cp1252" may suit your needs.

Q: I made an AT based content type with a non standard file like

field. It doesn't work. What can I do ?

A: You should develop and register a dedicated field retriever. This

requires some AT skills. More details in the README.tx that comes with PloneFilesZip. You may subclass retrievers from PloneFilesZip/retrievers.py

Q: Got an IOError when downloading. What's going on ?

A: If the exception message is "No space left on device", you have not

enough room in your system TMP folder. The Zip file is built in the server using the "tempfile" packge. Please read your system documentation and the "tempfile" package doc http://docs.python.org/lib/module-tempfile.html.

1.1.0RC2 - 2007/02/02

• Fix a bug in file retrieving. Append arg (full=True) while creating BaseUnit to make sure we get the entire file and not a chunk file (clebeaupin)

• Fix a bug on DeepZipStructurePolicy:getZipFilePath (add **kwargs on method) (clebeaupin)

  System Message: WARNING/2 (<string>, line 6); backlink

  Inline strong start-string without end-string.

1.1.0RC1 - 2007/02/01

• Add policy "ContentZipStructurePolicy"
• In regards to the new policies, files are renamed if they are duplicated in the same inner archive directory
• Add policies to manage zip structure. Policy can be configured in configlet

1.0.0 - 2006/10/16

• Added a configlet

1.0.0RC1 - 2006/09/24

• First public release