Merge "CollationFa: Third time's the charm"
[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 * $wgRunJobsAsync is now false by default (T142751). This change only affects
29 wikis with $wgJobRunRate > 0.
30
31 === New features in 1.29 ===
32 * (T5233) A cookie can now be set when a user is autoblocked, to track that user if
33 they move to a new IP address. This is disabled by default.
34 * Added ILocalizedException interface to standardize the use of localized
35 exceptions, largely so the API can handle them more sensibly.
36 * Blocks created automatically by MediaWiki, such as for configured proxies or
37 dnsbls, are now indicated as such and use a new i18n message when displayed.
38 * Added new $wgHTTPImportTimeout setting. Sets timeout for
39 downloading the XML dump during a transwiki import in seconds.
40 * Parser limit report is now available in machine-readable format to JavaScript
41 via mw.config.get('wgPageParseReport').
42 * Added $wgSoftBlockRanges, to allow for automatically blocking anonymous edits
43 from certain IP ranges (e.g. private IPs).
44
45 === External library changes in 1.29 ===
46
47 ==== Upgraded external libraries ====
48 * Updated QUnit from v1.22.0 to v1.23.1.
49
50 ==== New external libraries ====
51
52 ==== Removed and replaced external libraries ====
53
54 === Bug fixes in 1.29 ===
55 * (T62604) Core parser functions returning a number now format the number according
56 to the page content language, not wiki content language.
57
58 === Action API changes in 1.29 ===
59 * Submitting sensitive authentication request parameters to action=clientlogin,
60 action=createaccount, action=linkaccount, and action=changeauthenticationdata
61 in the query string is now an error. They should be submitted in the POST
62 body instead.
63 * The capture option for action=resetpassword has been removed
64 * action=clearhasmsg now requires a POST.
65 * (T47843) API errors and warnings may be requested in non-English languages
66 using the new 'errorformat', 'errorlang', and 'errorsuselocal' parameters.
67 * API error codes may have changed. Most notably, errors from modules using
68 parameter prefixes (e.g. all query submodules) will no longer be prefixed.
69 * ApiPageSet-using modules will report the 'invalidreason' using the specified
70 'errorformat'.
71 * action=emailuser may return a "Warnings" status, and now returns 'warnings' and
72 'errors' subelements (as applicable) instead of 'message'.
73 * action=imagerotate returns an 'errors' subelement rather than 'errormessage'.
74 * action=move now reports errors when moving the talk page as an array under
75 key 'talkmove-errors', rather than using 'talkmove-error-code' and
76 'talkmove-error-info'. The format for subpage move errors has also changed.
77 * action=revisiondelete no longer includes a "rendered" property on warnings
78 and errors for each item. Use errorformat=wikitext if you're wanting parsed
79 output.
80 * action=rollback no longer returns a "messageHtml" property. Use
81 errorformat=html if you're wanting HTML formatting of error messages.
82 * action=upload now reports optional stash failures as an array under key
83 'stasherrors' rather than a 'stashfailed' text string.
84 * action=watch reports 'errors' and 'warnings' instead of a single 'error', and
85 no longer returns a 'message' on success.
86 * Added action=validatepassword to validate passwords for the account creation
87 and password change forms.
88
89 === Action API internal changes in 1.29 ===
90 * New methods were added to ApiBase to handle errors and warnings using i18n
91 keys. Methods for using hard-coded English messages were deprecated:
92 * ApiBase::dieUsage() was deprecated
93 * ApiBase::dieUsageMsg() was deprecated
94 * ApiBase::dieUsageMsgOrDebug() was deprecated
95 * ApiBase::getErrorFromStatus() was deprecated
96 * ApiBase::parseMsg() was deprecated
97 * ApiBase::setWarning() was deprecated
98 * ApiBase::$messageMap is no longer public. Code attempting to access it will
99 result in a PHP fatal error.
100 * The $message parameter to the ApiCheckCanExecute hook should be set to an
101 ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
102 code for ApiBase::parseMsg() will no longer work.
103 * UsageException is deprecated in favor of ApiUsageException. For the time
104 being ApiUsageException is a subclass of UsageException to allow things that
105 catch only UsageException to still function properly.
106 * If, for some strange reason, code was using an ApiErrorFormatter instead of
107 ApiErrorFormatter_BackCompat, note that the result format has changed and
108 various methods now take a module path rather than a module name.
109 * ApiMessageTrait::getApiCode() now strips 'apierror-' and 'apiwarn-' prefixes
110 from the message key, and maps some message keys for backwards compatibility.
111
112 === Languages updated in 1.29 ===
113
114 MediaWiki supports over 350 languages. Many localisations are updated
115 regularly. Below only new and removed languages are listed, as well as
116 changes to languages because of Phabricator reports.
117
118 * Based as always on linguistic studies on intelligibility and language
119 knowledge by geography, language fallbacks have been expanded. When a
120 translation is missing in the user's preferred interface language, the
121 corresponding translation for the fallback language will be used instead.
122 English will only be used as last resort when there are no translations.
123 Some configurations (such as date formats and gender namespaces) have also
124 been updated when using the fallback language's configuration was inadequate.
125 The new or reinstated language fallbacks are (after cs ↔ sk in 1.28):
126 hsb ↔ dsb, io → eo, mdf → ru, pnt → el, roa-tara → it.
127
128 ==== No fallback for Ukrainian ====
129 * (T39314) The fallback from Ukrainian to Russian was removed. The Ukrainian
130 language will now use the default fallback language: English. When a translation
131 to Ukrainian is not available, an English string will be shown.
132
133 === Other changes in 1.29 ===
134 * Database::getSearchEngine() (deprecated in 1.28) was removed. Use
135 SearchEngineFactory::getSearchEngineClass() instead.
136 * $wgSessionsInMemcached (deprecated in 1.20) was removed. No replacement is
137 required as all sessions are stored in Object Cache now.
138 * MWHttpRequest::execute() should be considered to return a StatusValue; the
139 Status return type is deprecated.
140 * User::edits() (deprecated in 1.21) was removed.
141 * Xml::escapeJsString() (deprecated in 1.21) was removed.
142 * Article::getText() and Article::prepareTextForEdit() (deprecated in 1.21)
143 were removed.
144 * Article::getAutosummary() and WikiPage::getAutosummary (deprecated in 1.21)
145 were removed.
146 * Hooks ArticleViewCustom, EditPageGetDiffText and ShowRawCssJs (deprecated in 1.21)
147 were removed.
148 * Class RevisiondeleteAction (deprecated in 1.25) was removed.
149 * WikiPage::prepareTextForEdit() (deprecated in 1.21) was removed.
150 * WikiPage::getText() (deprecated in 1.21) was removed.
151 * Article::fetchContent() (deprecated in 1.21) was removed.
152 * User::getPassword() (deprecated in 1.27) was removed.
153 * User::getTemporaryPassword() (deprecated in 1.27) was removed.
154 * User::isPasswordReminderThrottled() (deprecated in 1.27) was removed.
155 * FSRepo (deprecated in 1.19) was removed.
156 * WebRequest::checkSessionCookie() (deprecated in 1.27) was removed. Use
157 \MediaWiki\Session\SessionManager::singleton()->getPersistedSessionId() instead.
158 * Class ImageGallery (deprecated in 1.22) was removed.
159 Use ImageGalleryBase::factory instead.
160 * Title::moveNoAuth() (deprecated in 1.25) was removed. Use MovePage class instead.
161 * Hook UnknownAction (deprecated in 1.19) was actually deprecated (it will now emit warnings).
162 Create a subclass of Action, and add it to $wgActions instead.
163 * WikiRevision:getText() (deprecated since 1.21) is no longer marked deprecated.
164
165 == Compatibility ==
166
167 MediaWiki 1.29 requires PHP 5.5.9 or later. There is experimental support for
168 HHVM 3.6.5 or later.
169
170 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
171 support for them is somewhat less mature. There is experimental support for
172 Oracle and Microsoft SQL Server.
173
174 The supported versions are:
175
176 * MySQL 5.0.3 or later
177 * PostgreSQL 8.3 or later
178 * SQLite 3.3.7 or later
179 * Oracle 9.0.1 or later
180 * Microsoft SQL Server 2005 (9.00.1399)
181
182 == Upgrading ==
183
184 1.29 has several database changes since 1.28, and will not work without schema
185 updates. Note that due to changes to some very large tables like the revision
186 table, the schema update may take quite long (minutes on a medium sized site,
187 many hours on a large site).
188
189 If upgrading from before 1.11, and you are using a wiki as a commons
190 repository, make sure that it is updated as well. Otherwise, errors may arise
191 due to database schema changes.
192
193 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
194 new database fields are filled with data.
195
196 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
197 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
198 with MediaWiki 1.21.
199
200 Don't forget to always back up your database before upgrading!
201
202 See the file UPGRADE for more detailed upgrade instructions.
203
204 For notes on 1.28.x and older releases, see HISTORY.
205
206 == Online documentation ==
207
208 Documentation for both end-users and site administrators is available on
209 MediaWiki.org, and is covered under the GNU Free Documentation License (except
210 for pages that explicitly state that their contents are in the public domain):
211
212 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
213
214 == Mailing list ==
215
216 A mailing list is available for MediaWiki user support and discussion:
217
218 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
219
220 A low-traffic announcements-only list is also available:
221
222 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
223
224 It's highly recommended that you sign up for one of these lists if you're
225 going to run a public MediaWiki, so you can be notified of security fixes.
226
227 == IRC help ==
228
229 There's usually someone online in #mediawiki on irc.freenode.net.