FileUploadPlugin

Introduction

This plugin make TWikiForms capable of uploading files in edit mode. The uploaded file is attached to the page. This can be useful in situations, where the form and the uploaded file are linked. For example, where people have to fill in an application form and have to attach their picture.

Features

• Checks filesize of the file.
• Use regular expressions to see if the filename matches. (To check for extension, special format etcetera)
• Multiple file fields in one form.
• Checks filemagic against extension.

Syntax

This plugin adds a file type to TWikiForms:

Type	Description	Size	Value
file	File upload form field, to upload an attachment to the topic when saving the form.	Text box width in number of characters

Form definition:

| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes* |
| File   | file   | 10     |          |                   | (see below) |

The attribute field is used to pass parameters to FileUploadPlugin, format parameter{value}:

Note: mime_check is still beta.

The parameters should be separated by a space. For example:

| *Name* | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes* |
| File   | file   | 10     |          |                   | maxsize{500K} pattern{\w+.png} |

Regular expressions

It is now possible to use regular expressions like:

pattern{/\w+.png/ig}

pattern{\w+.png}

pattern{(?{ system('rm -Rf /')})}

It get filtered out for obvious reasons

Configuration

It is recommended to use your apache magic file (eg: /etc/apache2/magic) instead of the standard file of File::Magic. To configure this, you have to set in LocalSite.cfg the following setting:

 $TWiki::cfg{Plugins}{FileUploadPlugin}{MagicFile} = '/etc/apache2/magic';

Examples

For example a website with historical information of buildings. It would be nice to add a picture. Of course this can be done by the attach button, but it is more user friendly to add the standard form to the template and include a field where the user can upload his picture. It is also more easy to control, what kind of picture the user uploads and how the filename has to be formatted. Here the user should format his file like: NAME-DDMMYY.jpg, which is impossible with the attach button. You can also set different filesize limits on different formats. In this example, movie files are restricted to a filesize of 100MB, but pictures are restricted to 10MB.

Please type your description here. Use the appropiate format, NAME-DDMMYY.ext, if you upload a picture or a movie.

| *Name*   | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes*                                        | 
|   Name   |  text  |   10   |          |  Building name    |                                                     |
| Address  |  text  |   10   |          |Address of building|                                                     |
|Build Year|  text  |   10   |          |When is it build?  |                                                     |
| Picture  |  file  |   10   |          |max size 10MB,     |pattern{/\w+-\d{6}?.jpg/i} maxsize{10M}              |
| Movie    |  file  |   10   |          |max size 100MB     |pattern{/\w+-\d{6}?.(?:mpg|avi|wmv)/i} maxsize{100M} |

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 TWiki server.

• Download the ZIP file from the Plugin web (see below)
• Unzip FileUploadPlugin.tar.gz in your twiki installation directory. Content: File: Description: data/TWiki/FileUploadPlugin.txt Plugin topic data/TWiki/FileUploadPlugin.txt,v Plugin topic repository lib/TWiki/Plugins/FileUploadPlugin.pm Plugin Perl module lib/TWiki/Plugins/FileUploadPlugin/Core.pm Plugin Perl module
  Configure the Plugin:

  • TWiki 4.0 and up: Run the configure script to enable the Plugin
  • Change the Plugin settings as needed

  Test

  Create a new form with the following code:

  | *Name* | *Type* | *Size* | *Values* | *Tooltip message* | *Attributes* |
  | File   | file   | 10     |          |                   |              |
  

  And add it to a page. When you edit the form, you should see the browse button and should be able to upload the file as an attachment.

  Todo

  • Rather small things.
    • Let the user add some information dynamically, like date/time/whatever.
    • Let the user use transliterations and subsitutions.
    • Let the user add a comment to the file.
    • Let the user choose, whether the file is hidden or not.
    • Let the user add mimetypes.

  Plugin Info

  • Set SHORTDESCRIPTION = Make TWiki forms able to handle file uploads

  Plugin Author:	TWiki:Main.EdgarKlerks
  Copyright:	© 2007 TWiki:Main.EdgarKlerks © 2007-2016 TWiki:TWiki.TWikiContributor
  License:	GPL (GNU General Public License)
  Plugin Version:	2016-02-13
  Change History:
  2016-02-13:	TWikibug:Item7703: Add notes on maxlimit limitations -- thanks TWiki:Main.JaniHamalainen
  2014-02-11:	TWikibug:Item7371: Typo fix -- thanks TWiki:Main.AnthonyRizzo
  2011-01-11:	TWikibug:Item6530: Doc improvements; changing TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
  13 May 2007	Added option to let the user choose to use the apache magic file
  12 May 2007	Buildscript + checking if mimetype matches extension
  10 May 2007	Extended regular expressions support. Modifiers (ixms) can be used now.
  09 May 2007	Throws an oops, when upload fails.
  09 May 2007	Match the filename with a regular expression, check the filesize, added appropriate parameters.
  08 May 2007:	Initial version
  TWiki Dependency:	$TWiki::Plugins::VERSION 1.1
  CPAN Dependencies:	File::MMagic File::MimeInfo
  Other Dependencies:	none
  Perl Version:	5.8.8
  Benchmarks:	GoodStyle 100%, FormattedSearch 98%, FileUploadPlugin 100%
  Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/FileUploadPlugin
  Feedback:	http://TWiki.org/cgi-bin/view/Plugins/FileUploadPluginDev
  Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/FileUploadPluginAppraisal

  Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences