Merge "Decrease the number of 'function says it should return something' errors"
[lhc/web/wiklou.git] / RELEASE-NOTES-1.29
1 == MediaWiki 1.29 ==
2
3 THIS IS NOT A RELEASE YET
4
5 MediaWiki 1.29 is an alpha-quality branch and is not recommended for use in
6 production.
7
8 === Configuration changes in 1.29 ===
9 * Default cookie expiration time has been reduced to 30 days. Login cookie expiration time is
10 kept at 180 days.
11 * A new configuration variable has been added: $wgCookieSetOnAutoblock. This
12 determines whether to set a cookie when a user is autoblocked. Doing so means
13 that a blocked user, even after logging out and moving to a new IP address,
14 will still be blocked.
15 * The resetpassword right and associated password reset capture feature has
16 been removed.
17 * The $error parameter to the EmailUser hook should be set to a Status object
18 or boolean false. This should be compatible with at least MediaWiki 1.23 if
19 not earlier. Returning a raw HTML string is now deprecated.
20 * The $message parameter to the ApiCheckCanExecute hook should be set to an
21 ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
22 code for ApiBase::parseMsg() will no longer work.
23 * ApiBase::$messageMap is no longer public. Code attempting to access it will
24 result in a PHP fatal error.
25 * $wgUserEmailUseReplyTo is now true by default to work around restrictive DMARC policies.
26 * Subpages are now enabled by default in the Template namespace. Set
27 $wgNamespacesWithSubpages[NS_TEMPLATE] to false to keep the old behavior.
28
29 === New features in 1.29 ===
30 * (T5233) A cookie can now be set when a user is autoblocked, to track that user if
31 they move to a new IP address. This is disabled by default.
32 * Added ILocalizedException interface to standardize the use of localized
33 exceptions, largely so the API can handle them more sensibly.
34
35 === External library changes in 1.29 ===
36
37 ==== Upgraded external libraries ====
38 * Updated QUnit from v1.22.0 to v1.23.1.
39
40 ==== New external libraries ====
41
42 ==== Removed and replaced external libraries ====
43
44 === Bug fixes in 1.29 ===
45
46 === Action API changes in 1.29 ===
47 * Submitting sensitive authentication request parameters to action=clientlogin,
48 action=createaccount, action=linkaccount, and action=changeauthenticationdata
49 in the query string is now an error. They should be submitted in the POST
50 body instead.
51 * The capture option for action=resetpassword has been removed
52 * action=clearhasmsg now requires a POST.
53 * (T47843) API errors and warnings may be requested in non-English languages
54 using the new 'errorformat', 'errorlang', and 'errorsuselocal' parameters.
55 * API error codes may have changed. Most notably, errors from modules using
56 parameter prefixes (e.g. all query submodules) will no longer be prefixed.
57 * ApiPageSet-using modules will report the 'invalidreason' using the specified
58 'errorformat'.
59 * action=emailuser may return a "Warnings" status, and now returns 'warnings' and
60 'errors' subelements (as applicable) instead of 'message'.
61 * action=imagerotate returns an 'errors' subelement rather than 'errormessage'.
62 * action=move now reports errors when moving the talk page as an array under
63 key 'talkmove-errors', rather than using 'talkmove-error-code' and
64 'talkmove-error-info'. The format for subpage move errors has also changed.
65 * action=revisiondelete no longer includes a "rendered" property on warnings
66 and errors for each item. Use errorformat=wikitext if you're wanting parsed
67 output.
68 * action=rollback no longer returns a "messageHtml" property. Use
69 errorformat=html if you're wanting HTML formatting of error messages.
70 * action=upload now reports optional stash failures as an array under key
71 'stasherrors' rather than a 'stashfailed' text string.
72 * action=watch reports 'errors' and 'warnings' instead of a single 'error', and
73 no longer returns a 'message' on success.
74
75 === Action API internal changes in 1.29 ===
76 * New methods were added to ApiBase to handle errors and warnings using i18n
77 keys. Methods for using hard-coded English messages were deprecated:
78 * ApiBase::dieUsage() was deprecated
79 * ApiBase::dieUsageMsg() was deprecated
80 * ApiBase::dieUsageMsgOrDebug() was deprecated
81 * ApiBase::getErrorFromStatus() was deprecated
82 * ApiBase::parseMsg() was deprecated
83 * ApiBase::setWarning() was deprecated
84 * ApiBase::$messageMap is no longer public. Code attempting to access it will
85 result in a PHP fatal error.
86 * The $message parameter to the ApiCheckCanExecute hook should be set to an
87 ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
88 code for ApiBase::parseMsg() will no longer work.
89 * UsageException is deprecated in favor of ApiUsageException. For the time
90 being ApiUsageException is a subclass of UsageException to allow things that
91 catch only UsageException to still function properly.
92 * If, for some strange reason, code was using an ApiErrorFormatter instead of
93 ApiErrorFormatter_BackCompat, note that the result format has changed and
94 various methods now take a module path rather than a module name.
95 * ApiMessageTrait::getApiCode() now strips 'apierror-' and 'apiwarn-' prefixes
96 from the message key, and maps some message keys for backwards compatibility.
97
98 === Languages updated in 1.29 ===
99
100 MediaWiki supports over 350 languages. Many localisations are updated
101 regularly. Below only new and removed languages are listed, as well as
102 changes to languages because of Phabricator reports.
103
104 ==== No fallback for Ukrainian ====
105 * (T39314) The fallback from Ukrainian to Russian was removed. The Ukrainian
106 language will now use the default fallback language: English. When a translation
107 to Ukrainian is not available, an English string will be shown.
108
109 === Other changes in 1.29 ===
110 * Database::getSearchEngine() (deprecated in 1.28) was removed. Use
111 SearchEngineFactory::getSearchEngineClass() instead.
112 * $wgSessionsInMemcached (deprecated in 1.20) was removed. No replacement is
113 required as all sessions are stored in Object Cache now.
114 * MWHttpRequest::execute() should be considered to return a StatusValue; the
115 Status return type is deprecated.
116 * User::edits() (deprecated in 1.21) was removed.
117 * Xml::escapeJsString() (deprecated in 1.21) was removed.
118 * Article::getText() and Article::prepareTextForEdit() (deprecated in 1.21)
119 were removed.
120 * Article::getAutosummary() and WikiPage::getAutosummary (deprecated in 1.21)
121 were removed.
122 * Hooks ArticleViewCustom, EditPageGetDiffText and ShowRawCssJs (deprecated in 1.21)
123 were removed.
124 * Class RevisiondeleteAction (deprecated in 1.25) was removed.
125 * WikiPage::prepareTextForEdit() (deprecated in 1.21) was removed.
126 * WikiPage::getText() (deprecated in 1.21) was removed.
127 * Article::fetchContent() (deprecated in 1.21) was removed.
128
129 == Compatibility ==
130
131 MediaWiki 1.29 requires PHP 5.5.9 or later. There is experimental support for
132 HHVM 3.6.5 or later.
133
134 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
135 support for them is somewhat less mature. There is experimental support for
136 Oracle and Microsoft SQL Server.
137
138 The supported versions are:
139
140 * MySQL 5.0.3 or later
141 * PostgreSQL 8.3 or later
142 * SQLite 3.3.7 or later
143 * Oracle 9.0.1 or later
144 * Microsoft SQL Server 2005 (9.00.1399)
145
146 == Upgrading ==
147
148 1.29 has several database changes since 1.28, and will not work without schema
149 updates. Note that due to changes to some very large tables like the revision
150 table, the schema update may take quite long (minutes on a medium sized site,
151 many hours on a large site).
152
153 If upgrading from before 1.11, and you are using a wiki as a commons
154 repository, make sure that it is updated as well. Otherwise, errors may arise
155 due to database schema changes.
156
157 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
158 new database fields are filled with data.
159
160 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
161 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
162 with MediaWiki 1.21.
163
164 Don't forget to always back up your database before upgrading!
165
166 See the file UPGRADE for more detailed upgrade instructions.
167
168 For notes on 1.28.x and older releases, see HISTORY.
169
170 == Online documentation ==
171
172 Documentation for both end-users and site administrators is available on
173 MediaWiki.org, and is covered under the GNU Free Documentation License (except
174 for pages that explicitly state that their contents are in the public domain):
175
176 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
177
178 == Mailing list ==
179
180 A mailing list is available for MediaWiki user support and discussion:
181
182 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
183
184 A low-traffic announcements-only list is also available:
185
186 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
187
188 It's highly recommended that you sign up for one of these lists if you're
189 going to run a public MediaWiki, so you can be notified of security fixes.
190
191 == IRC help ==
192
193 There's usually someone online in #mediawiki on irc.freenode.net.