Start of topic | Skip to actions

Batch Upload Plugin

Attach multiple files at once by uploading a zip archive. All files in the zip file will be attached to the topic.

Usage

Enable this plugin - Test: BatchUploadPlugin is enabled
Attach a zip file to a topic
- If a comment is entered with the zip file, the comment will be assigned to all contained files

Plugin Settings

Debug plugin
- Set DEBUG = 0
Enabled state - if disabled, does nothing
- Set ENABLED = 1
Set SHORTDESCRIPTION = Attach multiple files at once by uploading a zip archive

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, e.g., %BATCHUPLOADPLUGIN_SHORTDESCRIPTION%

Caveats

Doesn't carry through the hide or link flags
Contents of nested zips will only be attached partially

Further Development

Support nested zips
Support hide and link attributes

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

Download the ZIP file from the Plugin web (see below)
Unzip BatchUploadPlugin.zip in your twiki installation directory. Content:

File: Description:

data/TWiki/BatchUploadPlugin.txt Documentation

lib/TWiki/Plugins/BatchUploadPlugin.pm Perl module

(Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
Flip ENABLED switch to 1
Test if the installation was successful:
- Try uploading a zip file

Conditional Batch Upload

The 20 Feb 2007 release includes the ability to choose between attaching uploaded zip files, or extracting and attaching the contents. To add this feature to TWiki, add the following lines to the skin templates files, just after the hidefile table entry:

templates/attach.pattern.tmpl (attachform section):

 <input type="checkbox" class="twikiCheckbox" id="batchupload" checked name="batchupload" %BATCHUPLOADCHECKBOX% /><label for="batchupload">%MAKETEXT{"Batch upload for zip file"}%</label> <span class="twikiGrayText">%MAKETEXT{"Extracts and uploads individual file in zip archive."}%</span>

templates/attach.tmpl and templates/attach.classic.tmpl (content section):

 <tr>
  <td align="right">
   Batch Upload:
  </td><td>
   <input type="checkbox" name="batchupload" %BATCHUPLOADCHECKBOX% />Extract Files and Attach them to the Topic
  </td>
 </tr>

Plugin Info

Plugin Author: TWiki:Main.MartinCleaver, TWiki:Main.ArthurClemens

License: GPL

Dependencies:

Name	Version	Description
Archive::Zip	Required.

Plugin Version: 23 Dec 2006 (v1.100)

Change History:

20 Feb 2007 1.2: TWiki:Main.MartinRothbaum, TWiki:Main.SopanShewale: added option to enable/disable unzip-and-attach behavior via cgi parameter.

23 Dec 2006 1.1: TWiki:Main.ArthurClemens: Cleaned up and repackaged. Zipped files are now checked against the TWiki upload filter - for instance php files will get a .txt extension; spaces in zipped filenames will be changed to underscores. If a comment is entered when uploading a zip, the comment text will be assigned to all new attachments. After successful upload you will no longer see an error screen.

31 Oct 2004 TWiki:Main.MartinCleaver - initial version as plugin

09 Apr 2004 TWiki:Main.DiabJerius

17 Nov 2003 TWiki:Main.JohannesMartin

20 Mar 2003 TWiki:Main.RonKellam

16 Aug 2002 TWiki:Main.ThomasWeigert

14 Jan 2002 TWiki:Main.RyanFreebern

30 Oct 2001 TWiki:Main.VitoMiliano

TWiki Dependency: $TWiki::Plugins::VERSION 1.024

CPAN Dependencies: CPAN:Archive::Zip

Other Dependencies: none

Perl Version: 5.008

TWiki:Plugins/Benchmark: GoodStyle nn%, FormattedSearch nn%, BatchUploadPlugin nn%

Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/BatchUploadPlugin

Feedback: http://TWiki.org/cgi-bin/view/Plugins/BatchUploadPluginDev

Related Topics: TWikiPreferences, TWikiPlugins

End of topic
Skip to actions | Back to top

TWiki