Upload to TWiki Add-On

Introduction

This is a small Perl script to programmatically attach a file to any TWiki topic. The script can be executed on any computer, it does not have to be on the server where TWiki is installed. This script i useful to create mashups of TWiki and other applications.

The script is typically called from another script. As an actual use case, this script was used to attach audio voice files from voice mails to project pages in a TWiki application.

Usage

To attach a file to a TWiki topic, type this on the command line:

./uploadtotwiki.pl -l <login> -c <comment> <file(s)> <TWiki URL>

Supported command line parameters:

• -l login      - login name of TWiki account (optional)
• -p password   - password of TWiki account (optional)
• -c 'comment'  - comment of attached file (default: 'Uploaded by uploadtotwiki/2011-01-12')
• -h 1          - hide attachment, 0 or 1 (default: 0)
• -i 1          - inline attachment, e.g create link in topic text (default: 0)
• -d 60         - delay in seconds between uploads of multiple files (default: 15)
• file(s)       - one or more local files to upload (required)
• URL           - view URL of TWiki topic, http or https protocol (required, must be last)

Example:

% ./uploadtotwiki.pl -l guest ./smile.gif http://twiki.org/cgi-bin/view/Sandbox/UploadTest
Uploading ./smile.gif to http://twiki.org/cgi-bin/view/Sandbox/UploadTest
Enter password for guest at twiki.org:
... upload finished.
%

Add-On Installation Instructions

Note: This is a command line tool for administrators; regular TWiki user can ignore this.

• Download the ZIP file from the Add-on Home (see below)
• Unzip UploadToTWikiAddOn.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/UploadToTWikiAddOn.txt	Add-on topic
  tools/uploadtotwiki.pl	Add-on script

• If inclined, move uploadtotwiki.pl to a different location or server
• Run above example to test if the installation was successful
• Install CPAN:LWP if missing (see CPAN instructions)

Limitations

• At this time the script only supports ApacheLogin only; support for TemplateLogin is pending.
• Upload of files fail silently (without error message) if:
  • the file name has unsupported characters ($, @, ^, space, etc). Workaround: Rename files before upload.
  • the CSRF protection flag is set in configure. Workaround: Disable {CryptToken}{Enable} configure setting.
  • the user has no permission to update the topic.

Add-On Info

• Set SHORTDESCRIPTION = Script to programmatically attach a file to any TWiki topic

Add-on Author:	TWiki:Main.PeterThoeny
Copyright:	© 2007-2012, Peter Thoeny, TWiki.org, © 2007-2012 TWiki:TWiki.TWikiContributor
License:	GPL (GNU General Public License)
Add-on Version:	uploadtotwiki/2012-11-24
Change History:
2012-11-24:	TWikibug:Item6961: Doc improvements
2011-07-10:	TWikibug:Item6725: Adding build stuff
2011-01-12:	TWikibug:Item6530: Doc improvements
2007-02-12:	Added -l, -p, -c, -h, -i, -d parameters; support for multiple files
2007-02-11:	Initial version
TWiki Dependency:	$TWiki::Plugins::VERSION 1.1 (TWiki 4.0)
CPAN Dependencies:	LWP
Other Dependencies:	none
Perl Version:	5.005
Add-on Home:	http://TWiki.org/cgi-bin/view/Plugins/UploadToTWikiAddOn
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/UploadToTWikiAddOnDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/UploadToTWikiAddOnAppraisal

Related Topic: TWikiAddOns