stylelint: drop value-keyword-case and make a pass
[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
10 expiration time is 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
26 policies.
27 * Subpages are now enabled by default in the Template namespace. Set
28 $wgNamespacesWithSubpages[NS_TEMPLATE] to false to keep the old behavior.
29 * $wgRunJobsAsync is now false by default (T142751). This change only affects
30 wikis with $wgJobRunRate > 0.
31 * A temporary feature flag, $wgDisableUserGroupExpiry, is provided to disable
32 new features that rely on the schema changes to the user_groups table. This
33 feature flag will likely be removed before 1.29 is released.
34 * (T158474) "Unknown user" has been added to $wgReservedUsernames.
35 * (T156983) $wgRateLimitsExcludedIPs now accepts CIDR ranges as well as single IPs.
36
37 === New features in 1.29 ===
38 * (T5233) A cookie can now be set when a user is autoblocked, to track that user
39 if they move to a new IP address. This is disabled by default.
40 * Added ILocalizedException interface to standardize the use of localized
41 exceptions, largely so the API can handle them more sensibly.
42 * Blocks created automatically by MediaWiki, such as for configured proxies or
43 dnsbls, are now indicated as such and use a new i18n message when displayed.
44 * Added new $wgHTTPImportTimeout setting. Sets timeout for
45 downloading the XML dump during a transwiki import in seconds.
46 * Parser limit report is now available in machine-readable format to JavaScript
47 via mw.config.get('wgPageParseReport').
48 * Added $wgSoftBlockRanges, to allow for automatically blocking anonymous edits
49 from certain IP ranges (e.g. private IPs).
50 * (T59603) Added new magic word {{PAGELANGUAGE}} which returns the language code
51 of the page being parsed.
52 * HTML5 form validation attributes will no longer be suppressed. Originally
53 browsers had poor support for them, but modern browsers handle them fine.
54 This might affect some forms that used them and only worked because the
55 attributes were not actually being set.
56 * Expiry times can now be specified when users are added to user groups.
57
58 === External library changes in 1.29 ===
59
60 ==== Upgraded external libraries ====
61 * Added wikimedia/timestamp v1.0.0.
62 * Updated QUnit from v1.22.0 to v1.23.1.
63 * Updated cssjanus from v1.1.2 to 1.1.3.
64 * Updated psr/log from v1.0.0 to v1.0.2.
65 * Update Moment.js from v2.8.4 to v2.15.0.
66
67 ==== New external libraries ====
68
69 ==== Removed and replaced external libraries ====
70
71 === Bug fixes in 1.29 ===
72 * (T62604) Core parser functions returning a number now format the number according
73 to the page content language, not wiki content language.
74 * (T27187) Search suggestions based on jquery.suggestions will now correctly only
75 highlight prefix matches in the results.
76 * (T157035) "new mw.Uri()" was ignoring options when using default URI.
77
78 === Action API changes in 1.29 ===
79 * Submitting sensitive authentication request parameters to action=login,
80 action=clientlogin, action=createaccount, action=linkaccount, and
81 action=changeauthenticationdata in the query string is now an error. They
82 should be submitted in the POST body instead.
83 * The capture option for action=resetpassword has been removed
84 * action=clearhasmsg now requires a POST.
85 * (T47843) API errors and warnings may be requested in non-English languages
86 using the new 'errorformat', 'errorlang', and 'errorsuselocal' parameters.
87 * API error codes may have changed. Most notably, errors from modules using
88 parameter prefixes (e.g. all query submodules) will no longer be prefixed.
89 * ApiPageSet-using modules will report the 'invalidreason' using the specified
90 'errorformat'.
91 * action=emailuser may return a "Warnings" status, and now returns 'warnings' and
92 'errors' subelements (as applicable) instead of 'message'.
93 * action=imagerotate returns an 'errors' subelement rather than 'errormessage'.
94 * action=move now reports errors when moving the talk page as an array under
95 key 'talkmove-errors', rather than using 'talkmove-error-code' and
96 'talkmove-error-info'. The format for subpage move errors has also changed.
97 * action=revisiondelete no longer includes a "rendered" property on warnings
98 and errors for each item. Use errorformat=wikitext if you're wanting parsed
99 output.
100 * action=rollback no longer returns a "messageHtml" property. Use
101 errorformat=html if you're wanting HTML formatting of error messages.
102 * action=upload now reports optional stash failures as an array under key
103 'stasherrors' rather than a 'stashfailed' text string.
104 * action=watch reports 'errors' and 'warnings' instead of a single 'error', and
105 no longer returns a 'message' on success.
106 * Added action=validatepassword to validate passwords for the account creation
107 and password change forms.
108 * action=purge now requires a POST.
109
110 === Action API internal changes in 1.29 ===
111 * New methods were added to ApiBase to handle errors and warnings using i18n
112 keys. Methods for using hard-coded English messages were deprecated:
113 * ApiBase::dieUsage() was deprecated
114 * ApiBase::dieUsageMsg() was deprecated
115 * ApiBase::dieUsageMsgOrDebug() was deprecated
116 * ApiBase::getErrorFromStatus() was deprecated
117 * ApiBase::parseMsg() was deprecated
118 * ApiBase::setWarning() was deprecated
119 * ApiBase::$messageMap is no longer public. Code attempting to access it will
120 result in a PHP fatal error.
121 * The $message parameter to the ApiCheckCanExecute hook should be set to an
122 ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
123 code for ApiBase::parseMsg() will no longer work.
124 * UsageException is deprecated in favor of ApiUsageException. For the time
125 being ApiUsageException is a subclass of UsageException to allow things that
126 catch only UsageException to still function properly.
127 * If, for some strange reason, code was using an ApiErrorFormatter instead of
128 ApiErrorFormatter_BackCompat, note that the result format has changed and
129 various methods now take a module path rather than a module name.
130 * ApiMessageTrait::getApiCode() now strips 'apierror-' and 'apiwarn-' prefixes
131 from the message key, and maps some message keys for backwards compatibility.
132
133 === Languages updated in 1.29 ===
134
135 MediaWiki supports over 350 languages. Many localisations are updated
136 regularly. Below only new and removed languages are listed, as well as
137 changes to languages because of Phabricator reports.
138
139 * Based as always on linguistic studies on intelligibility and language
140 knowledge by geography, language fallbacks have been expanded. When a
141 translation is missing in the user's preferred interface language, the
142 corresponding translation for the fallback language will be used instead.
143 English will only be used as last resort when there are no translations.
144 Some configurations (such as date formats and gender namespaces) have also
145 been updated when using the fallback language's configuration was inadequate.
146 The new or reinstated language fallbacks are (after cs ↔ sk in 1.28):
147 ca ↔ oc; hsb ↔ dsb; io → eo; mdf → ru; pnt → el; roa-tara → it; rup → ro;
148 sh → bs, sr-el, hr.
149 * (T155957) Talk Namespaces for Javanese language (jv) have been updated.
150
151 ==== No fallback for Ukrainian ====
152 * (T39314) The fallback from Ukrainian to Russian was removed. The Ukrainian
153 language will now use the default fallback language: English. When a translation
154 to Ukrainian is not available, an English string will be shown.
155
156 === Other changes in 1.29 ===
157 * Database::getSearchEngine() (deprecated in 1.28) was removed. Use
158 SearchEngineFactory::getSearchEngineClass() instead.
159 * $wgSessionsInMemcached (deprecated in 1.20) was removed. No replacement is
160 required as all sessions are stored in Object Cache now.
161 * MWHttpRequest::execute() should be considered to return a StatusValue; the
162 Status return type is deprecated.
163 * User::edits() (deprecated in 1.21) was removed.
164 * Xml::escapeJsString() (deprecated in 1.21) was removed.
165 * Article::getText() and Article::prepareTextForEdit() (deprecated in 1.21)
166 were removed.
167 * Article::getAutosummary() and WikiPage::getAutosummary() (deprecated in 1.21)
168 were removed.
169 * Hook ArticleViewCustom (deprecated in 1.21) was removed. Use ArticleContentViewCustom
170 instead.
171 * Hooks EditPageGetDiffText and ShowRawCssJs (deprecated in 1.21) were removed.
172 * Class RevisiondeleteAction (deprecated in 1.25) was removed.
173 * WikiPage::prepareTextForEdit() (deprecated in 1.21) was removed.
174 * WikiPage::getText() (deprecated in 1.21) was removed.
175 * Article::fetchContent() (deprecated in 1.21) was removed.
176 * User::getPassword() (deprecated in 1.27) was removed.
177 * User::getTemporaryPassword() (deprecated in 1.27) was removed.
178 * User::isPasswordReminderThrottled() (deprecated in 1.27) was removed.
179 * Class FSRepo (deprecated in 1.19) was removed.
180 * WebRequest::checkSessionCookie() (deprecated in 1.27) was removed. Use
181 \MediaWiki\Session\SessionManager::singleton()->getPersistedSessionId() instead.
182 * Class ImageGallery (deprecated in 1.22) was removed.
183 Use ImageGalleryBase::factory instead.
184 * Title::moveNoAuth() (deprecated in 1.25) was removed. Use MovePage class instead.
185 * Hook UnknownAction (deprecated in 1.19) was actually deprecated (it will now
186 emit warnings). Create a subclass of Action and add it to $wgActions instead.
187 * WikiRevision::getText() (deprecated since 1.21) is no longer marked deprecated.
188 * Linker::getInterwikiLinkAttributes() (deprecated since 1.25) was removed.
189 * Linker::getInternalLinkAttributes() (deprecated since 1.25) was removed.
190 * Linker::getInternalLinkAttributesObj() (deprecated since 1.25) was removed.
191 * Linker::getLinkAttributesInternal() (deprecated since 1.25) was removed.
192 * RedisConnectionPool::handleException (deprecated since 1.23) was removed.
193 * The static properties mw.Api.errors and mw.Api.warnings, containing incomplete
194 and outdated lists of errors/warnings returned by the API, are now deprecated.
195 * wiki.phtml entry point was removed. Refer to index.php instead. If you want "wiki.phtml"
196 URLs to continue to work, set up redirects. In Apache, this can be done by enabling
197 mod_rewrite and adding the following rules to your configuration:
198
199 RewriteEngine On
200 RewriteBase /
201 RewriteRule ^/w/wiki\.phtml$ /w/index.php [R=301,L]
202 * Hook ArticleAfterFetchContent (deprecated in 1.21) was removed.
203 Use ArticleAfterFetchContentObject instead.
204 * Hook ArticleInsertComplete (deprecated in 1.21) was removed.
205 Use PageContentInsertComplete instead.
206 * Hook ArticleSave (deprecated in 1.21) was removed.
207 Use PageContentSave instead.
208 * Hook ArticleSaveComplete (deprecated in 1.21) was removed.
209 Use PageContentSaveComplete instead.
210 * Hook EditFilterMerged (deprecated in 1.21) was removed.
211 Use EditFilterMergedContent instead.
212 * Hook EditPageGetPreviewText (deprecated in 1.21) was removed.
213 Use EditPageGetPreviewContent instead.
214 * Hook TitleIsCssOrJsPage (deprecated in 1.21) was removed.
215 Use ContentHandlerDefaultModelFor instead.
216 * Hook TitleIsWikitextPage (deprecated in 1.21) was removed.
217 Use ContentHandlerDefaultModelFor instead.
218 * Article::getContent() (deprecated in 1.21) was removed.
219 * Revision::getText() (deprecated in 1.21) was removed.
220 * Article::doEdit() and WikiPage::doEdit() (deprecated in 1.21) were removed.
221 * Parser::replaceUnusualEscapes() (deprecated in 1.24) was removed.
222 * Article::doEditContent() was marked as deprecated, to be removed in 1.30
223 or later.
224 * ContentHandler::runLegacyHooks() was removed.
225 * refreshLinks.php now can be limited to a particular category with --category=...
226 or a tracking category with --tracking-category=...
227 * User-like objects that are passed to SpecialUserRights and its subclasses are
228 now required to have a getGroupMemberships() method. See UserRightsProxy for
229 an example.
230 * User::$mGroups (instance variable) was marked private. Use User::getGroups()
231 instead.
232 * User::getGroupName(), User::getGroupMember(), User:getGroupPage(),
233 User::makeGroupLinkHTML(), and User::makeGroupLinkWiki() were deprecated.
234 Use equivalent methods on the UserGroupMembership class.
235 * Maintenance scripts and tests that call User::addGroup() must now ensure that
236 User objects have been added to the database prior to calling addGroup().
237 * Protected function UsersPager::getGroups() was removed, and protected function
238 UsersPager::buildGroupLink() was changed from a static to an instance method.
239 * The third parameter ($cache) to the UsersPagerDoBatchLookups hook was changed;
240 see docs/hooks.txt.
241 * User::crypt() (deprecated in 1.24) was removed.
242 * User::comparePasswords() (deprecated in 1.24) was removed.
243 * ArchivedFile::getUserText() (deprecated in 1.23) was removed.
244 * HTMLFileCache::newFromTitle() (deprecated in 1.24) was removed.
245
246 == Compatibility ==
247
248 MediaWiki 1.29 requires PHP 5.5.9 or later. There is experimental support for
249 HHVM 3.6.5 or later.
250
251 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
252 support for them is somewhat less mature. There is experimental support for
253 Oracle and Microsoft SQL Server.
254
255 The supported versions are:
256
257 * MySQL 5.0.3 or later
258 * PostgreSQL 8.3 or later
259 * SQLite 3.3.7 or later
260 * Oracle 9.0.1 or later
261 * Microsoft SQL Server 2005 (9.00.1399)
262
263 == Upgrading ==
264
265 1.29 has several database changes since 1.28, and will not work without schema
266 updates. Note that due to changes to some very large tables like the revision
267 table, the schema update may take quite long (minutes on a medium sized site,
268 many hours on a large site).
269
270 If upgrading from before 1.11, and you are using a wiki as a commons
271 repository, make sure that it is updated as well. Otherwise, errors may arise
272 due to database schema changes.
273
274 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
275 new database fields are filled with data.
276
277 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
278 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
279 with MediaWiki 1.21.
280
281 Don't forget to always back up your database before upgrading!
282
283 See the file UPGRADE for more detailed upgrade instructions.
284
285 For notes on 1.28.x and older releases, see HISTORY.
286
287 == Online documentation ==
288
289 Documentation for both end-users and site administrators is available on
290 MediaWiki.org, and is covered under the GNU Free Documentation License (except
291 for pages that explicitly state that their contents are in the public domain):
292
293 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
294
295 == Mailing list ==
296
297 A mailing list is available for MediaWiki user support and discussion:
298
299 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
300
301 A low-traffic announcements-only list is also available:
302
303 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
304
305 It's highly recommended that you sign up for one of these lists if you're
306 going to run a public MediaWiki, so you can be notified of security fixes.
307
308 == IRC help ==
309
310 There's usually someone online in #mediawiki on irc.freenode.net.