remove unneeded default which had a horrible backslash in a path
[squirrelmail.git] / ReleaseNotes
CommitLineData
815d9ba0 1/*****************************************************************
f7cd8eb4 2 * Release Notes: SquirrelMail 1.5.1 *
3 * The "Fire in the Hole" Release *
4 * 2006-02-19 *
5*****************************************************************/
6
7WARNING. If you can read this, then you are reading file from 1.5.1cvs and not
8final release notes.
9
10
815d9ba0 11
a67a0f59 12In this edition of SquirrelMail Release Notes:
ef1932a4 13 * All about this Release!
3eb34ffd 14 * Major updates
f7cd8eb4 15 * Security updates
16 * Plugin updates
17 * Possible issues
18 * Backwards incompatible changes
19 * Data directory changes
20 * Reporting my favorite SquirrelMail bug
a67a0f59 21
ef1932a4 22All about this Release!
23=======================
815d9ba0 24
f7cd8eb4 25This is the second release of our new 1.5.x-series, which is a
bb91e60d 26DEVELOPMENT release.
f11c804f 27
bb91e60d 28See the Major Updates section of this file for more.
a23d0264 29
ef1932a4 30
3eb34ffd 31Major updates
32==============
f7cd8eb4 33Rewritten IMAP functions and added extra data caching code. Internal sorting
34functions should be faster than code used in SquirrelMail 1.5.0 and older
35versions. Data caching should reduce number of IMAP calls in folder management
36and mailbox status functions.
37
38Own gettext implementation replaced with PHP Gettext classes. Update adds
39ngettext and dgettext support.
40
41Templates, css and error handler.
42
53bbd9b3 43SquirrelMail started using internal cookie functions in order to have more
44controls over cookie format. Cookies set with sqsetcookie() function use
45extra parameter that secures cookie information in browsers that follow
46MSDN cookie specifications.
47
48SquirrelMail IMAP and SMTP libraries updated to allow use of STARTTLS extension.
49Code is experimental and requires PHP 5.1.0 or newer with
50stream_socket_enable_crypto() function support.
f7cd8eb4 51
52Updated wrapping functions in compose.
53
54
55Security updates
56================
57
58This release contains security fixes applied to development branch after 1.5.0
53bbd9b3 59release:
60 CVE-2004-0521 - SQL injection vulnerability in address book.
61 CVE-2004-1036 - XSS exploit in decodeHeader function.
62 CVE-2005-0075 - Potential file inclusion in preference backend selection code.
63 CVE-2005-0103 - Possible file/offsite inclusion in src/webmail.php.
64 CVE-2005-0104 - Possible XSS issues in src/webmail.php.
65 CVE-2005-1769 - Several cross site scripting (XSS) attacks.
66 CVE-2005-2095 - Extraction of all POST variables in advanced identity code.
67
68If you use SquirrelMail 1.5.0, you should upgrade to 1.5.1 or downgrade to latest
69stable SquirrelMail version.
f7cd8eb4 70
71Plugin updates
72==============
73Added site configuration options to filters, fortune, translate, newmail,
53bbd9b3 74bug_report plugins. Improved newmail and change_password plugins. Fixed data
75corruption issues in calendar plugin.
f7cd8eb4 76
53bbd9b3 77SquirrelSpell plugin was updated to use generic SquirrelMail preference functions.
78User preferences and personal dictionaries that were stored in .words files are
79moved to .pref files or other configured user data storage backend.
f7cd8eb4 80
81
82Possible issues
83===============
53bbd9b3 84Internal SquirrelMail cookie implementation is experimental. If you have cookie
85expiration or corruption issues with some browser and can reproduce them only in
861.5.1 version, contact SquirrelMail developers and help them to debug your issue.
87
f7cd8eb4 88Plugins (changes in hooks and IMAP API)
53bbd9b3 89
f7cd8eb4 90IMAP sorting/threading
91
92Backward incompatible changes
93=============================
94Index order options are modified in 1.5.1 version. If older options are
95detected, interface upgrades to newer option format and deletes old options.
3eb34ffd 96
f7cd8eb4 97In 1.5.1 version SquirrelSpell user dictionaries are saved with generic
98SquirrelMail data functions. Code should copy older dictionary, if dictionary
99version information is not present in user preferences. Once dictionary is
100copied, <username>.words files are obsolete and no longer updated.
a23d0264 101
f7cd8eb4 102If same data directory is used with other backwards incompatible version, older
103SquirrelMail version can lose some user preferences or work with outdated data.
368ab966 104
105Data directory
106==============
107
f7cd8eb4 108The directory data/ used to be included in our tarball. Since placing this dir
109under a web accessible directory is not very wise, we've decided to not pack it
110anymore; you need to create it yourself. Please choose a location that's safe,
111e.g. somewhere under /var.
368ab966 112
113
f7cd8eb4 114Reporting my favorite SquirrelMail bug
115======================================
a23d0264 116
f7cd8eb4 117We constantly aim to make SquirrelMail even better. So we need you to submit
118any bug you come across! Also, please mention that the bug is in this 1.5.1
119release, and list your IMAP server and webserver details.
a67a0f59 120
121 http://www.squirrelmail.org/bugs
122
f7cd8eb4 123Thanks for your cooperation with this. That helps us to make sure nothing slips
124through the cracks. Also, it would help if people would check existing tracker
125items for a bug before reporting it again. This would help to eliminate
126duplicate reports, and increase the time we can spend CODING by DECREASING the
127time we spend sorting through bug reports. And remember, check not only OPEN
128bug reports, but also closed ones as a bug that you report MAY have been fixed
129in CVS already.
a67a0f59 130
f7cd8eb4 131If you want to join us in coding SquirrelMail, or have other things to share
132with the developers, join the development mailing list:
a67a0f59 133
a23d0264 134 squirrelmail-devel@lists.sourceforge.net
815d9ba0 135
0ca033d5 136
ef1932a4 137About Our Release Alias
138=======================
139
f7cd8eb4 140This release is labeled the "Fire in the Hole" release. "Fire in the hole" is
141a phrase used to warn of the detonation of an explosive device. The phrase may
142have been originated by miners, who made extensive use of explosives while
143working underground.
144
145Release is created in order to get fixed package after two years of development
146in HEAD branch. Package contains many experimental changes. Changes add new
147features, that can be unstable and cause inconsistent UI. If you want to use
148stable code, you should stick to SquirrelMail 1.4.x series. If you find issues
149in this package, make sure that they are still present in latest development
150code snapshots.
ef1932a4 151
815d9ba0 152 Happy SquirrelMailing!
153 - The SquirrelMail Project Team