Reset User Preferences plugin for SquirrelMail
============================================================
Ver 1.2, 2009/09/11


Copyright (c) 2008-2009 Paul Lesniewski <paul@squirrelmail.org>



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

This plugin allows users to back up all their
SquirrelMail preference settings, revert to any
previously saved preference sets, and reset all
preferences to default values.  This plugin
should be fully compatible with all preference
backends.



Usage
=====

Backup, revert and reset controls are placed on
the Options->Personal Information options page
in the SquirrelMail interface.



License
=======

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



Donations
=========

If you or your company make regular use of this software,
please consider supporting Open Source development by
donating to the authors or inquire about hiring them to
consult on other projects.  Donation/wish list links for
the author(s) are as follows:

Paul Lesniewski: https://sourceforge.net/donate/index.php?user_id=508228



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

  * SquirrelMail version 1.4.9.  This plugin may also
    work with earlier SquirrelMail versions if you can
    make the needed patches, but this is not officially
    supported.  Note that when used with anything less
    than version 1.4.15, you'll need to apply the patch
    that comes with the Address Book Grouping and
    Pagination plugin BEFORE you apply the patch that
    comes with this plugin.

  * Compatibility plugin version 2.0.7 or above, unless
    using SquirrelMail version 1.4.10+ or 1.5.2+



Security
========

  * Note that if other plugins store sensitive information
    or data that is intended for user tracking that the 
    user themselves should not be able to manage, control
    or override, this plugin could cause problems for those
    other plugins unless they specify a list of the
    preference settings in question by registering on the
    plugin hook named "reset_user_prefs".  For this hook,
    other plugins merely need return a comma-delimited list
    (including a trailing comma!) of preference settings to
    be preserved during a preferences reset.

  * When the threat of an intruder using a compromised account
    for mischievous purposes and then resetting the user
    preferences to cover their tracks is a concern, it may be
    advisable to turn off $rp_allow_delete and turn on
    $rp_automatic_backup.  Note, however, that this will
    result in some users having large unneeded lists of backup
    sets that the administrator may have to purge by hand.



Troubleshooting
===============

  * If changes to the configuration file don't seem to be
    having any effect, ensure that you are editing the correct
    configuration file.  If one is located in the main SquirrelMail
    config directory (named "config_reset_prefs.php"), it will
    always be used.  Otherwise, "config.php" in the reset_prefs
    plugin directory will be used.



Help Requests
=============

Before looking for help elsewhere, please try to help yourself:

  * Read the Troubleshooting section herein.

  * Look to see if others have already asked about the same issue.
    There are tips and links for the best places to do this in
    the SquirrelMail mailing list posting guidelines:
    http://squirrelmail.org/wiki/MailingListPostingGuidelines
    You should also try Google or some other search engine.
    
  * If you cannot find any information about your issue, please
    first mail your help request to the squirrelmail-plugins
    mailing list.  Information about it can be found here:
    http://lists.sourceforge.net/mailman/listinfo/squirrelmail-plugins
    You MUST read the mailing list posting guidelines (see above)
    and include as much information about your issue (and your
    system) as possible.  Including configtest output, any debug
    output, the plugin configuration settings you've made and
    anything else you can think of to make it easier to diagnose
    your problem will get you the most useful responses.  Inquiries
    that do not comply with the posting guidelines are liable to
    be ignored.
    
  * If you don't get any replies on the mailing list, you are
    welcome to send a help request to the authors' personal 
    address(es), but please be patient with the mailing list.



TODO
====

  * Ideas?



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

  v1.2  2009/09/11  Paul Lesniewski <paul@squirrelmail.org>
    * Update to work with 1.4.20-RC2 and above

  v1.1.1  2009/01/01  Paul Lesniewski <paul@squirrelmail.org>
    * Fix PHP notice upon options save
    * Fix PHP notice under 1.5.2

  v1.1  2008/06/16  Paul Lesniewski <paul@squirrelmail.org>
    * Allow other plugins to specify a list of preference settings
      that the user is not allowed to override - see security
      warning in the README file for more information
    * Added ability for the administrator to turn each of the
      reset, revert, backup and delete functions on and off.
      Please refer to the "Security" section in the README file.
    * Added ability to configure the layout scheme used for the
      backup listing in the user interface
    * Includes new patch: when upgrading, please *re-apply* the
      patch for version 1.0 FIRST, and choose "yes" when asked if
      you want to reverse it, and THEN apply the one included
      with this version

  v1.0  2008/05/10  Paul Lesniewski <paul@squirrelmail.org>
    * Initial release

