Vacation Local plugin for SquirrelMail
======================================
Ver 1.0, 31/01/05


Authors: Jonathan Bayer <jbayer@spamcop.net>
         Paul Lesneiwski <pdontthink@angrynerds.com>



Description
===========

This plugin allows users to set an auto-reply message to 
incoming email, which is most commenly used to notify the 
sender of one's absence.  This plugin specifically uses 
the vacation program, and as such is limited to use with
mail systems where mail users have real local accounts.

This version uses a local SUID program to copy the files.  
Since it does, it only works on a local system.  This has 
been developed and tested on RedHat Linux 7.1 (as well as
Fedora Core 1) with a standard Apache configuration.  

This plugin is based on the vacation plugin written by 
Ronald Luten <r.luten@oad.nl>, which was itself based upon 
a plugin called "Mail Configuration" that was available back 
when Squirrels were still living in caves.  That plugin was 
written by Chris Wakelin <c.d.wakelin@rdg.ac.uk> and was
also based losely on the "Forward File Editor" add-on for 
TWIG (see http://twig.screwdriver.net/addons.php3) by 
<monica-k@usa.net>.  No one can say credit isn't given 
where credit is due.

See the INSTALL file for setup instructions.



License
=======

This plugin is released under the GNU General Public 
License (see COPYING for details).



Requirements
============

  * The configuration (vacation) files need to reside in 
    the top level of the users' home directories.

  * The vacation program needs to be installed.  For most 
    sendmail configurations it also means you need to put 
    a symbolic link in /etc/smrsh to the vacation program. 
    The RPM for RedHat can be found here:
    ftp://ftp.redhat.com/pub/contrib/libc6/i386/vacation-1.2.2-2.i386.rpm



Troubleshooting
=============== 
      
If you get "Directory traversal not allowed" errors when you
click on the Vacation Message option, please first look at 
your main SquirrelMail configuration: is your attachments 
directory using a relative path such as "../../data"?  Please
change it to be the FULL path to your attachments directory
and this error will go away.



Help Requests
============= 
      
Help requests are welcome at my personal email address, but I
request that you first post to the SquirrelMail Plugins mailing
list, where you'll get faster help from more people and other
people with the same problem will be able to see how your issue
was resolved.  If you don't get good answers that way, you may
try emailing me directly.

Info about the SquirrelMail Plugins mailing list can be found
on the SquirrelMail web site.  It is currently located at:

http://lists.sourceforge.net/mailman/listinfo/squirrelmail-plugins
squirrelmail-plugins@lists.sourceforge.net



TODO
====

Add forwarding functionality?



Change Log
==========


  v1.0 31/01/05
    * Fixed security exploit that allowed arbitrary suid command 
      execution as well as retrieval of any system file whatsoever.
      The name of the binary has changed, so please be sure to 
      remove all traces of the ftpfile executable from /usr/local/sbin
      or wherever else you may have installed it!
    * Changed plugin name to reduce confusion.  This means you need to 
      manually remove older versions of this plugin under the vacation 
      directory, as this version will install into the vacation_local 
      directory.
    * Lots of code cleanup.  No more register_globals=On code, no more
      one-off internationalization, no more non-standard HTML.  Whew.

  v0.15
    * Updated to work with SquirrelMail 1.4, updated for faster performance 
      model, updated for new version reporting API, internationalized most 
      of the output, cleaned up a bunch of code (it still is somewhat messy), etc.

  v0.14
    * Fixed bug in ftpfile program which would fail when an 
      absolute path was specified for the data directory

  v0.13
    * Fixed problem with program not setting the owner/group/permissions properly.

  v0.11
    * Function sqStripSlashes was removed from Squirrelmail. So 
      I inserted it into the plugin itself.

