style changes in server sorting option descriptions
[squirrelmail.git] / ReleaseNotes
index 0dbb1d3582371591a255167768ee799d6ad34b07..cb79e7af3e9b2b077a6f6ab7a7969f0da9583dd8 100644 (file)
 /*****************************************************************
- * Release Notes: SquirrelMail 1.3.0                             *
- * The "Pasta" Release                                           *
- * 17 august 2002                                                *
- *****************************************************************/
+ * Release Notes: SquirrelMail 1.5.1                             *
+ * The "Fire in the Hole" Release                                *
+ * 2006-02-19                                                    *
+*****************************************************************/
 
-In this edition of SquirrelMail Release Notes:
-   * All about this Release!!!
-   * Reporting my favorite SquirrelMail 1.3 bug
-   * Important Note about PHP 4.2.2
-   * About our Release Aliases
-
-All about this Release!!!
-=========================
+WARNING. If you can read this, then you are reading file from 1.5.1cvs and not 
+final release notes.
 
-This is the first release on our way to a new stable series.
-On our way to, that is, this is a development release, which is not
-intended for production servers. We feel that releasing development
-versions will help us making the to-be stable release more stable, and
-restricting the ability to test no longer to people who use CVS.
 
-So download it! Install it, and try to break it! We are hungry for any
-bug report you send. If stumbling over a bug is a true non-option,
-this release is not for you. In that case, download the stable version
-and enjoy that one.
 
-In general, we are planning to regularly release a 1.3.x version until
-it is stable enough to call her 1.4 or 2.0. While I'm at it, one
-comment on version numbers. Our version numbers take the form of A.B.C
- A increases with time, but only very seldomly.
- B if it is even (0, 2, 4 etc), it is a stable release
-   if it is odd (1, 3, 5 etc), it is a development release
- C indicates small changes.
-Which is to say our version numbering system is the same as that of
-the linux kernel. So 1.2.7 is a stable version, and 1.3.0 (this one)
-is a development release.
+In this edition of SquirrelMail Release Notes:
+   * All about this Release!
+   * Major updates
+   * Security updates
+   * Plugin updates
+   * Possible issues
+   * Backwards incompatible changes
+   * Data directory changes
+   * Reporting my favorite SquirrelMail bug
 
-We are excited to bring you the first fruits of a very good
-development series. Major rewrites of the back-end and the user
-interface have been happening since the 1.2 series. These rewrites
-have inspired me for the release alias (see down this document).
+All about this Release!
+=======================
 
+This is the second release of our new 1.5.x-series, which is a 
+DEVELOPMENT release. 
 
-A note on plugins
-=================
+See the Major Updates section of this file for more.
 
-There have been very severe architecture improvements. Lots of plugins
-have not yet been adapted to this. Plugins which are distributed with
-this release (eg. in the same .tar.gz file) may work. Plugins not
-distributed with this plugin most probably WILL NOT WORK.
 
-So if you have ANY problem at all, first try turning off all plugins.
+Major updates
+==============
+Rewritten IMAP functions and added extra data caching code. Internal sorting 
+functions should be faster than code used in SquirrelMail 1.5.0 and older 
+versions. Data caching should reduce number of IMAP calls in folder management 
+and mailbox status functions. 
 
+Own gettext implementation replaced with PHP Gettext classes. Update adds 
+ngettext and dgettext support.
 
-A note on PHP 4.2.2
-===================
+Templates, css and error handler. 
 
-There are certain issues with PHP 4.2.2 and session handling that have
-not yet been addresses in this release. So this release MAY NOT WORK
-when you use PHP 4.2.2. These issues will be addressed to in
-forthcoming 1.3.x releases.
+SquirrelMail started using internal cookie functions in order to have more 
+controls over cookie format. Cookies set with sqsetcookie() function use
+extra parameter that secures cookie information in browsers that follow 
+MSDN cookie specifications.
 
+SquirrelMail IMAP and SMTP libraries updated to allow use of STARTTLS extension.
+Code is experimental and requires PHP 5.1.0 or newer with 
+stream_socket_enable_crypto() function support.
 
-A note on your configuration
-============================
+Updated wrapping functions in compose.
 
-For a whole bunch of reasons, it is MANDATORY that you run conf.pl
-(and then save your configuration) from the config/ directory before
-using this release.
 
-If you have problems with UID support, please do these 2 things:
+Security updates
+================
 
-1) For our comfort and the prosper of SquirrelMail:
-   send a bugreport with this information
-     * IMAP server type + version
-     * Whether you use server-side sorting
-     * Whether you use thread sorting
-     * The value of "sort" (as in conf.pl)
-   bugs can be submitted at: http://www.squirrelmail.org/bugs
-2) For your own pleasure and comfort:
-   turn of UID support in conf.pl, so you can continue to use 1.3.0
+This release contains security fixes applied to development branch after 1.5.0 
+release:
+ CVE-2004-0521 - SQL injection vulnerability in address book.
+ CVE-2004-1036 - XSS exploit in decodeHeader function.
+ CVE-2005-0075 - Potential file inclusion in preference backend selection code.
+ CVE-2005-0103 - Possible file/offsite inclusion in src/webmail.php.
+ CVE-2005-0104 - Possible XSS issues in src/webmail.php.
+ CVE-2005-1769 - Several cross site scripting (XSS) attacks.
+ CVE-2005-2095 - Extraction of all POST variables in advanced identity code.
+ CVE-2006-0188 - Possible XSS through right_frame parameter in webmail.php.
+ CVE-2006-0195 - Possible XSS in MagicHTML, IE only.
+ CVE-2006-0377 - IMAP injection in sqimap_mailbox_select mailbox parameter.
 
+If you use SquirrelMail 1.5.0, you should upgrade to 1.5.1 or downgrade to latest
+stable SquirrelMail version.
 
-A note on MIME
+Plugin updates
+==============
+Added site configuration options to filters, fortune, translate, newmail, 
+bug_report plugins. Improved newmail and change_password plugins. Fixed data 
+corruption issues in calendar plugin.
+
+SquirrelSpell plugin was updated to use generic SquirrelMail preference functions.
+User preferences and personal dictionaries that were stored in .words files are 
+moved to .pref files or other configured user data storage backend.
+
+
+Possible issues
+===============
+Internal SquirrelMail cookie implementation is experimental. If you have cookie 
+expiration or corruption issues with some browser and can reproduce them only in 
+1.5.1 version, contact SquirrelMail developers and help them to debug your issue.
+
+SquirrelMail 1.5.1 changed some functions and hooks. login_form hook requires
+different coding style. html_top, html_bottom, internal_link hooks are removed.
+src/move_messages.php code moved to main mailbox listing script. Some hooks are 
+broken after implementation of templates in mailbox listing pages. soupNazi() 
+function is replaced with checkForJavascript() function. sqimap_messages_delete, 
+sqimap_messages_copy, sqimap_messages_flag and sqimap_get_small_header() 
+functions are obsoleted. Some IMAP functions return data in different format.
+If plugins depend on changed or removed functions, they will break in this 
+SquirrelMail version.
+
+This SquirrelMail version implemented code that unregisters globals in PHP 
+register_globals=on setups. If some plugin loads main SquirrelMail functions 
+and depends on PHP register_globals, it will be broken.
+
+IMAP sorting/threading
+
+Backward incompatible changes
+=============================
+Index order options are modified in 1.5.1 version. If older options are 
+detected, interface upgrades to newer option format and deletes old options.
+
+In 1.5.1 version SquirrelSpell user dictionaries are saved with generic 
+SquirrelMail data functions. Code should copy older dictionary, if dictionary 
+version information is not present in user preferences. Once dictionary is 
+copied, <username>.words files are obsolete and no longer updated.
+
+If same data directory is used with other backwards incompatible version, older
+SquirrelMail version can lose some user preferences or work with outdated data.
+
+Data directory
 ==============
 
-In case you stumble over a message of which something goes wrong with
-MIME (it does not display some of its parts all right, etc. etc.),
-please forward the message AS AN ATTACHMENT to
-squirrelmail-devel@lists.sourceforge.net. However, AVOID
-forwarding emails over 20k of size. Please not as well that messages
-which are NOT forwarded AS AN ATTACHMENT are COMPLETEY USELESS for our
-testing purposes.
+The directory data/ used to be included in our tarball. Since placing this dir 
+under a web accessible directory is not very wise, we've decided to not pack it
+anymore; you need to create it yourself. Please choose a location that's safe, 
+e.g. somewhere under /var.
 
 
-Reporting my favorite SquirrelMail 1.3 bug
-==========================================
+Reporting my favorite SquirrelMail bug
+======================================
 
-It is not unlikely you will experience some bugs while using this
-development version. Please submit these bugs. Also, please mention
-that the bug is in this 1.3.0 release.
+We constantly aim to make SquirrelMail even better. So we need you to submit 
+any bug you come across! Also, please mention that the bug is in this 1.5.1 
+release, and list your IMAP server and webserver details.
 
    http://www.squirrelmail.org/bugs
 
-Thank you for your cooperation in that issue. That helps us to make
-sure that nothing slips through the cracks. Also, it would help if
-people would check existing tracker items for a bug before reporting
-it again. This would help to eliminate duplicate reports, and
-increase the time we can spend CODING by DECREASING the time we
-spend sorting through bug reports. And remember, check not only OPEN
-bug reports, but also closed ones as a bug that you report MAY have
-been fixed in CVS already.
+Thanks for your cooperation with this. That helps us to make sure nothing slips
+through the cracks. Also, it would help if people would check existing tracker 
+items for a bug before reporting it again. This would help to eliminate 
+duplicate reports, and increase the time we can spend CODING by DECREASING the 
+time we spend sorting through bug reports. And remember, check not only OPEN 
+bug reports, but also closed ones as a bug that you report MAY have been fixed 
+in CVS already.
 
-In case you want to join us on coding SquirrelMail, or have other
-things to share with the developers, join the development mailinglist:
+If you want to join us in coding SquirrelMail, or have other things to share 
+with the developers, join the development mailing list:
 
    squirrelmail-devel@lists.sourceforge.net
 
 
-About our Release Aliases - By Wouter Teepe
-=========================
-
-Pasta is, as we all know, a group of Italian dishes. As most of us
-know, several types of pasta exist, two of which are:
-
-* Spaghetti: Tastes good, but is very hard to untangle. Its structure
-  is unneccecarily complex, but it is relatively easy to cook.
-* Lasagne: Tastes excellent, and its structure is very elegant: it is
-  layered. Cooking it takes quite a bit more patience and design.
-
-I will not bore you with Italian cooking more except for this: The
-difference between spaghetti and lasagne applies to SquirrelMail as
-well. Where 1.2 is good, its inside is unneccecarily complex. Opposed
-to this, 1.3 is quite well structured from the inside. Its potential
-is true excellence. Its flavor is already excellent. Expect 1.4/2.0 to
-be, well...
+About Our Release Alias
+=======================
 
-With the slicing up the internals of SquirrelMail, whole new
-possibilities will emerge. Listen on the development mailinglist to
-hear which!
+This release is labeled the "Fire in the Hole" release. "Fire in the hole" is 
+a phrase used to warn of the detonation of an explosive device. The phrase may 
+have been originated by miners, who made extensive use of explosives while 
+working underground.
 
+Release is created in order to get fixed package after two years of development
+in HEAD branch. Package contains many experimental changes. Changes add new 
+features, that can be unstable and cause inconsistent UI. If you want to use 
+stable code, you should stick to SquirrelMail 1.4.x series. If you find issues 
+in this package, make sure that they are still present in latest development 
+code snapshots. 
 
                   Happy SquirrelMailing!
                     - The SquirrelMail Project Team