collective.upload 1.0b1

File upload widget with multiple file selection, drag&drop support, progress bars, client-side image resizing and preview images.

Table of Contents

• Overview

• Features

• Browsers supported

• Future features

• Why do we need another multiple file upload package?

• Developer’s notes

• Installation

• Contributors

• Changelog

Overview

File upload widget with multiple file selection, drag&drop support, progress bars, client-side image resizing and preview images.

• In the current state, the implementation is ONLY available like a behavior for Dexterity-based containers.

• The action to launch the overlay is located in the “Add new…” menu and is inserted using JavaScript; if JavaScript is deactivated, the plugin is not going to work.

Features

• Multiple file upload: Allows to select multiple files at once and upload them sequentially (simultaneously is not currently enabled)

• Drag & Drop support: Allows to upload files by dragging them from your desktop or file manager and dropping them on your browser window

• Upload progress bar: Shows a progress bar indicating the upload progress for individual files and for all uploads combined

• Cancelable uploads: Individual file uploads can be canceled to stop the upload progress

• Client-side image resizing: Images can be automatically resized on client-side with browsers supporting the required JS APIs

• Preview images: A preview of image files can be displayed before uploading with browsers supporting the required JS APIs

• No browser plugins required: The implementation is based on open standards like HTML5 and JavaScript and requires no additional browser plugins

• Graceful fallback for legacy browsers: Uploads files via XMLHttpRequests if supported and uses iframes as fallback for legacy browsers

Browsers supported

• Google Chrome 7.0+

• Mozilla Firefox 3.0+

• Microsoft Internet Explorer 6.0+

• Opera 10.0+

• Apple Safari 4.0+

Drag & Drop is only supported on Google Chrome, Firefox 4.0+ and Safari 5.0+.

Client-side image resizing is only supported on Google Chrome, Firefox 4.0+.

Microsoft Internet Explorer has no support for multiple file selection or upload progress.

Extended browser support information.

Future features

We want to implement these features at some point in the future:

• Smooth integration with Plone’s UI

• Refactoring of widget’s UI

• Resumable uploads: Aborted uploads can be resumed with browsers supporting the Blob API

• Chunked uploads: Large files can be uploaded in smaller chunks with browsers supporting the Blob API

• HTML file upload form fallback: Shows a standard HTML file upload form if JavaScript is disabled

• Cross-site file uploads: Supports uploading files to a different domain with Cross-site XMLHttpRequests

• Support for Archetypes-based content types

• Enable/disable automatic uploads

• Server side image resizing

• Server side file type constraint

• Asynchronous Module Definition (AMD) support

• Widget for “allowed extensions” option

Why do we need another multiple file upload package?

Because in software development, as in any natural environment, diversity is good.

By mid 2011 we tested the existing packages, collective.uploadify and collective.quickupload, because we were working on a project that required this feature.

We though collective.quickupload was good but, at that point, it had no support for Dexterity-based content types. After some research we found that jQuery File Upload was really nice, so we started this project.

Unfortunately, we hadn’t enough time to work more on this, but that has changed. We have our own vision on how the UI for this feature must behave and we want to implement it.

Also, we strongly believe Adobe Flash must die and Microsoft must stop pretending Internet Explorer can continue ignoring web standards forever.

Developer’s notes

In the folder “static” you are going to find the JavaScript used in this project; here a list with the file name and function:

applications.js

The main file; here you will find 2 important things: plugin initialization and inheritance of basic UI code with custom templates (e.g. every new file dropped in the file upload widget is going to generate a new row, here is the code for that).

media-upload-init-behavior.js

When you apply a behavior to a content type, this script is loaded in a viewlet and creates a new item in the “add new” menu.

canvas-to-blob.min.js

Converts canvas elements into Blob objects, is a polyfill for the standard HTML canvas.toBlob method.

load-image.min.js

Load Image is a function to load images provided as File or Blob objects or via URL.

jquery.1.7.1.js

The File Upload plugin is compatible with jQuery 1.7+; Plone has jQuery 1.4, sadly there is no easy way to upgrade the jquery version, so we are doing a no-conflict trick and uploading the version required just for this.

jquery.fileupload.js

The most basic version of the File Upload plugin, with no UI.

jquery.fileupload-ip.js

Extends the basic fileupload widget with image processing functionality.

jquery.fileupload-ui.js

Extends the IP version, adds complete user interface interaction.

jquery.iframe-transport.js

Used for cross-site iframe transport uploads a way of degradation for the XHR upload.

cors/jquery.xdr-transport.js

jQuery XDomainRequest Transport plugin; enables cross-domain AJAX requests (GET and POST only) (not really used, its just there if you need to implement that kind of functionality).

vendor/jquery.ui.widget.js

jQuery UI widget factory; very lightweight, flexible base for building complex, statefull plugins with a consistent API. It is designed for general consumption by developers who want to create object-oriented components without reinventing common infrastructure.

Installation

To enable this product in a buildout-based installation:

1. Edit your buildout.cfg and add collective.upload to the list of eggs to install

   [buildout]
   ...
   eggs =
       collective.upload

2. You may need to extend a five.grok known good set (KGS) to make sure that you get the right versions of the packages that make up five.grok

   [buildout]
   ...
   extends =
       http://good-py.appspot.com/release/five.grok/1.2.0-1

After updating the configuration you need to run ‘’bin/buildout’’, which will take care of updating your system.

Go to the ‘Site Setup’ page in a Plone site and click on the ‘Add-ons’ link.

Check the box next to ‘’collective.upload’’ and click the ‘Activate’ button.

Note: You may have to empty your browser cache and save your resource registries in order to see the effects of the product installation.

Contributors

• Joaquín Rosales

• Héctor Velarde

• Silvestre Huens

Development sponsored by Open Multimedia.

collective.upload is an implementation of the jQuery File Upload plugin for Plone.

Changelog

1.0b1 (2012-05-02)

• Initial release.