Merge "Move Database and subclasses to Rdbms namespace"
[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 * $wgDummyLanguageCodes is deprecated. Additional language code mappings may be
37 added to $wgExtraLanguageCodes instead.
38 * (T161453) LocalisationCache will no longer use the temporary directory in it's
39 fallback chain when trying to work out where to write the cache.
40 * The user right 'editusercssjs' (deprecated in 1.16) was removed. Use
41 'editusercss' and 'edituserjs' in $wgGroupPermissions and elsewhere instead.
42
43 === New features in 1.29 ===
44 * (T5233) A cookie can now be set when a user is autoblocked, to track that user
45 if they move to a new IP address. This is disabled by default.
46 * Added ILocalizedException interface to standardize the use of localized
47 exceptions, largely so the API can handle them more sensibly.
48 * Blocks created automatically by MediaWiki, such as for configured proxies or
49 dnsbls, are now indicated as such and use a new i18n message when displayed.
50 * Added new $wgHTTPImportTimeout setting. Sets timeout for
51 downloading the XML dump during a transwiki import in seconds.
52 * Parser limit report is now available in machine-readable format to JavaScript
53 via mw.config.get('wgPageParseReport').
54 * Added $wgSoftBlockRanges, to allow for automatically blocking anonymous edits
55 from certain IP ranges (e.g. private IPs).
56 * (T59603) Added new magic word {{PAGELANGUAGE}} which returns the language code
57 of the page being parsed.
58 * HTML5 form validation attributes will no longer be suppressed. Originally
59 browsers had poor support for them, but modern browsers handle them fine.
60 This might affect some forms that used them and only worked because the
61 attributes were not actually being set.
62 * Expiry times can now be specified when users are added to user groups.
63 * Completely new user interface for the RecentChanges page, which
64 structures filters into user-friendly groups. This has corresponding
65 changes to how filters are registered by core and extensions.
66
67 === External library changes in 1.29 ===
68
69 ==== Upgraded external libraries ====
70 * Updated QUnit from v1.22.0 to v1.23.1.
71 * Updated cssjanus from v1.1.2 to v1.2.0.
72 * Updated psr/log from v1.0.0 to v1.0.2.
73 * Update Moment.js from v2.8.4 to v2.15.0.
74 * Updated oyejorge/less.php from v1.7.0.10 to v1.7.0.14.
75 * Updated monolog from v1.18.2 to 1.22.1.
76 * Updated wikimedia/composer-merge-plugin from v1.3.1 to v1.4.0.
77 * Updated OOjs from v1.1.10 to v2.0.0.
78
79 ==== New external libraries ====
80 * Added wikimedia/timestamp v1.0.0.
81 * Added wikimedia/remex-html v1.0.1.
82
83 ==== Removed and replaced external libraries ====
84
85 === Bug fixes in 1.29 ===
86 * (T62604) Core parser functions returning a number now format the number according
87 to the page content language, not wiki content language.
88 * (T27187) Search suggestions based on jquery.suggestions will now correctly only
89 highlight prefix matches in the results.
90 * (T157035) "new mw.Uri()" was ignoring options when using default URI.
91 * Special:Allpages can no longer be filtered by redirect in miser mode.
92 * (T160519) CACHE_ANYTHING will not be CACHE_ACCEL if no accelerator is installed.
93 * (T109140) (T122209) SECURITY: Special:UserLogin and Special:Search allow redirect
94 to interwiki links.
95 * (T144845) SECURITY: XSS in SearchHighlighter::highlightText() when
96 $wgAdvancedSearchHighlighting is true.
97 * (T125177) SECURITY: API parameters may now be marked as "sensitive" to keep
98 their values out of the logs.
99 * (T150044) SECURITY: "Mark all pages visited" on the watchlist now requires a CSRF
100 token.
101 * (T156184) SECURITY: Escape content model/format url parameter in message.
102 * (T151735) SECURITY: SVG filter evasion using default attribute values in DTD
103 declaration.
104 * (T161453) SECURITY: LocalisationCache will no longer use the temporary directory
105 in it's fallback chain when trying to work out where to write the cache.
106 * (T48143) SECURITY: Spam blacklist ineffective on encoded URLs inside file inclusion
107 syntax's link parameter.
108 * (T108138) SECURITY: Sysops can undelete pages, although the page is protected against
109 it.
110
111 === Action API changes in 1.29 ===
112 * Submitting sensitive authentication request parameters to action=login,
113 action=clientlogin, action=createaccount, action=linkaccount, and
114 action=changeauthenticationdata in the query string is now an error. They
115 should be submitted in the POST body instead.
116 * The capture option for action=resetpassword has been removed
117 * action=clearhasmsg now requires a POST.
118 * (T47843) API errors and warnings may be requested in non-English languages
119 using the new 'errorformat', 'errorlang', and 'errorsuselocal' parameters.
120 * API error codes may have changed. Most notably, errors from modules using
121 parameter prefixes (e.g. all query submodules) will no longer be prefixed.
122 * ApiPageSet-using modules will report the 'invalidreason' using the specified
123 'errorformat'.
124 * action=emailuser may return a "Warnings" status, and now returns 'warnings' and
125 'errors' subelements (as applicable) instead of 'message'.
126 * action=imagerotate returns an 'errors' subelement rather than 'errormessage'.
127 * action=move now reports errors when moving the talk page as an array under
128 key 'talkmove-errors', rather than using 'talkmove-error-code' and
129 'talkmove-error-info'. The format for subpage move errors has also changed.
130 * action=revisiondelete no longer includes a "rendered" property on warnings
131 and errors for each item. Use errorformat=wikitext if you're wanting parsed
132 output.
133 * action=rollback no longer returns a "messageHtml" property. Use
134 errorformat=html if you're wanting HTML formatting of error messages.
135 * action=upload now reports optional stash failures as an array under key
136 'stasherrors' rather than a 'stashfailed' text string.
137 * action=watch reports 'errors' and 'warnings' instead of a single 'error', and
138 no longer returns a 'message' on success.
139 * Added action=validatepassword to validate passwords for the account creation
140 and password change forms.
141 * action=purge now requires a POST.
142 * There is a new `languagevariants` siprop for action=query&meta=siteinfo,
143 which returns a list of languages with active LanguageConverter instances.
144 * action=query&query=allpages will no longer filter redirects using a database
145 query in miser mode. This may result in less results being returned than were
146 requested.
147
148 === Action API internal changes in 1.29 ===
149 * New methods were added to ApiBase to handle errors and warnings using i18n
150 keys. Methods for using hard-coded English messages were deprecated:
151 * ApiBase::dieUsage() was deprecated
152 * ApiBase::dieUsageMsg() was deprecated
153 * ApiBase::dieUsageMsgOrDebug() was deprecated
154 * ApiBase::getErrorFromStatus() was deprecated
155 * ApiBase::parseMsg() was deprecated
156 * ApiBase::setWarning() was deprecated
157 * ApiBase::$messageMap is no longer public. Code attempting to access it will
158 result in a PHP fatal error.
159 * The $message parameter to the ApiCheckCanExecute hook should be set to an
160 ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
161 code for ApiBase::parseMsg() will no longer work.
162 * UsageException is deprecated in favor of ApiUsageException. For the time
163 being ApiUsageException is a subclass of UsageException to allow things that
164 catch only UsageException to still function properly.
165 * If, for some strange reason, code was using an ApiErrorFormatter instead of
166 ApiErrorFormatter_BackCompat, note that the result format has changed and
167 various methods now take a module path rather than a module name.
168 * ApiMessageTrait::getApiCode() now strips 'apierror-' and 'apiwarn-' prefixes
169 from the message key, and maps some message keys for backwards compatibility.
170 * API parameters may now be marked as "sensitive" to keep their values out of
171 the logs.
172
173 === Languages updated in 1.29 ===
174
175 MediaWiki supports over 350 languages. Many localisations are updated
176 regularly. Below only new and removed languages are listed, as well as
177 changes to languages because of Phabricator reports.
178
179 * Based as always on linguistic studies on intelligibility and language
180 knowledge by geography, language fallbacks have been expanded. When a
181 translation is missing in the user's preferred interface language, the
182 corresponding translation for the fallback language will be used instead.
183 English will only be used as last resort when there are no translations.
184 Some configurations (such as date formats and gender namespaces) have also
185 been updated when using the fallback language's configuration was inadequate.
186 The new or reinstated language fallbacks are (after cs ↔ sk in 1.28):
187 ca ↔ oc; hsb ↔ dsb; io → eo; mdf → ru; pnt → el; roa-tara → it; rup → ro;
188 sh → bs, sr-el, hr.
189 * (T137376) New language support: Atikamekw (atj).
190 * (T155957) Talk Namespaces for Javanese language (jv) have been updated.
191
192 ==== No fallback for Ukrainian ====
193 * (T39314) The fallback from Ukrainian to Russian was removed. The Ukrainian
194 language will now use the default fallback language: English. When a translation
195 to Ukrainian is not available, an English string will be shown.
196
197 === Other changes in 1.29 ===
198 * Database::getSearchEngine() (deprecated in 1.28) was removed. Use
199 SearchEngineFactory::getSearchEngineClass() instead.
200 * $wgSessionsInMemcached (deprecated in 1.20) was removed. No replacement is
201 required as all sessions are stored in Object Cache now.
202 * MWHttpRequest::execute() should be considered to return a StatusValue; the
203 Status return type is deprecated.
204 * User::edits() (deprecated in 1.21) was removed.
205 * Xml::escapeJsString() (deprecated in 1.21) was removed.
206 * Article::getText() and Article::prepareTextForEdit() (deprecated in 1.21)
207 were removed.
208 * Article::getAutosummary() and WikiPage::getAutosummary() (deprecated in 1.21)
209 were removed.
210 * Hook ArticleViewCustom (deprecated in 1.21) was removed. Use ArticleContentViewCustom
211 instead.
212 * Hooks EditPageGetDiffText and ShowRawCssJs (deprecated in 1.21) were removed.
213 * Class RevisiondeleteAction (deprecated in 1.25) was removed.
214 * WikiPage::prepareTextForEdit() (deprecated in 1.21) was removed.
215 * WikiPage::getText() (deprecated in 1.21) was removed.
216 * Article::fetchContent() (deprecated in 1.21) was removed.
217 * User::getPassword() (deprecated in 1.27) was removed.
218 * User::getTemporaryPassword() (deprecated in 1.27) was removed.
219 * User::isPasswordReminderThrottled() (deprecated in 1.27) was removed.
220 * Class FSRepo (deprecated in 1.19) was removed.
221 * WebRequest::checkSessionCookie() (deprecated in 1.27) was removed. Use
222 \MediaWiki\Session\SessionManager::singleton()->getPersistedSessionId() instead.
223 * Class ImageGallery (deprecated in 1.22) was removed.
224 Use ImageGalleryBase::factory instead.
225 * Title::moveNoAuth() (deprecated in 1.25) was removed. Use MovePage class instead.
226 * Hook UnknownAction (deprecated in 1.19) was actually deprecated (it will now
227 emit warnings). Create a subclass of Action and add it to $wgActions instead.
228 * WikiRevision::getText() (deprecated since 1.21) is no longer marked deprecated.
229 * Linker::getInterwikiLinkAttributes() (deprecated since 1.25) was removed.
230 * Linker::getInternalLinkAttributes() (deprecated since 1.25) was removed.
231 * Linker::getInternalLinkAttributesObj() (deprecated since 1.25) was removed.
232 * Linker::getLinkAttributesInternal() (deprecated since 1.25) was removed.
233 * RedisConnectionPool::handleException (deprecated since 1.23) was removed.
234 * The static properties mw.Api.errors and mw.Api.warnings, containing incomplete
235 and outdated lists of errors/warnings returned by the API, are now deprecated.
236 * wiki.phtml entry point was removed. Refer to index.php instead. If you want "wiki.phtml"
237 URLs to continue to work, set up redirects. In Apache, this can be done by enabling
238 mod_rewrite and adding the following rules to your configuration:
239
240 RewriteEngine On
241 RewriteBase /
242 RewriteRule ^/w/wiki\.phtml$ /w/index.php [R=301,L]
243 * Hook ArticleAfterFetchContent (deprecated in 1.21) was removed.
244 Use ArticleAfterFetchContentObject instead.
245 * Hook ArticleInsertComplete (deprecated in 1.21) was removed.
246 Use PageContentInsertComplete instead.
247 * Hook ArticleSave (deprecated in 1.21) was removed.
248 Use PageContentSave instead.
249 * Hook ArticleSaveComplete (deprecated in 1.21) was removed.
250 Use PageContentSaveComplete instead.
251 * Hook EditFilterMerged (deprecated in 1.21) was removed.
252 Use EditFilterMergedContent instead.
253 * Hook EditPageGetPreviewText (deprecated in 1.21) was removed.
254 Use EditPageGetPreviewContent instead.
255 * Hook TitleIsCssOrJsPage (deprecated in 1.21) was removed.
256 Use ContentHandlerDefaultModelFor instead.
257 * Hook TitleIsWikitextPage (deprecated in 1.21) was removed.
258 Use ContentHandlerDefaultModelFor instead.
259 * Article::getContent() (deprecated in 1.21) was removed.
260 * Revision::getText() (deprecated in 1.21) was removed.
261 * Article::doEdit() and WikiPage::doEdit() (deprecated in 1.21) were removed.
262 * Parser::replaceUnusualEscapes() (deprecated in 1.24) was removed.
263 * Article::doEditContent() was marked as deprecated, to be removed in 1.30
264 or later.
265 * ContentHandler::runLegacyHooks() was removed.
266 * refreshLinks.php now can be limited to a particular category with --category=...
267 or a tracking category with --tracking-category=...
268 * User-like objects that are passed to SpecialUserRights and its subclasses are
269 now required to have a getGroupMemberships() method. See UserRightsProxy for
270 an example.
271 * User::$mGroups (instance variable) was marked private. Use User::getGroups()
272 instead.
273 * User::getGroupName(), User::getGroupMember(), User:getGroupPage(),
274 User::makeGroupLinkHTML(), and User::makeGroupLinkWiki() were deprecated.
275 Use equivalent methods on the UserGroupMembership class.
276 * Maintenance scripts and tests that call User::addGroup() must now ensure that
277 User objects have been added to the database prior to calling addGroup().
278 * Protected function UsersPager::getGroups() was removed, and protected function
279 UsersPager::buildGroupLink() was changed from a static to an instance method.
280 * The third parameter ($cache) to the UsersPagerDoBatchLookups hook was changed;
281 see docs/hooks.txt.
282 * User::crypt() (deprecated in 1.24) was removed.
283 * User::comparePasswords() (deprecated in 1.24) was removed.
284 * ArchivedFile::getUserText() (deprecated in 1.23) was removed.
285 * HTMLFileCache::newFromTitle() (deprecated in 1.24) was removed.
286 * BREAKING CHANGE: Internal signature changes to ChangesListSpecialPage
287 and subclasses. It should only break if you call buildMainQueryConds
288 (changed to buildQuery with new signature) or doMainQuery (new
289 signature). Subclasses are likely to call at least doMainQuery
290 (possibly both), but other classes might too, because they were
291 public.
292 Also, some related hooks were deprecated, but this is not yet a
293 breaking change.
294 * Removed 'jquery.arrowSteps' module. (deprecated since 1.28)
295 * The 'jquery.autoEllipsis' ResourceLoader module is now deprecated.
296 * WikiRevision::$fileIsTemp was deprecated.
297 * WikiRevision::$importer was deprecated.
298 * WikiRevision::$user was deprecated.
299 * Article::getLastPurgeTimestamp(), WikiPage::getLastPurgeTimestamp(), and the
300 WikiPage::PURGE_* constants are deprecated, and the functions will always
301 return false. They were a hack for an issue that has since been fixed.
302 * Hook 'EditPageBeforeEditChecks' is now deprecated. Instead use the new hook
303 'EditPageGetCheckboxesDefinition', or 'EditPage::showStandardInputs:options'
304 if you don't actually care about checkboxes and just want to add some HTML
305 to the page.
306 * Selflinks are now rendered as href-less <a> tags with the class mw-selflink
307 rather than <strong> tags. The old class name, "selflink", was deprecated
308 and will be removed in a future release. (T160480)
309 * (T156184) $wgRawHtml will no longer apply to internationalization messages.
310 * Browser support for non-ES5 JavaScript browsers, including Android 2,
311 Opera <12.10, and Internet Explorer 9, was lowered from Grade A to Grade C.
312 * Removed wikibits global methods deprecated since MediaWiki 1.17 (T122755):
313 is_gecko, is_chrome_mac, is_chrome, webkit_version, is_safari_win, is_safari,
314 webkit_match, is_ff2, ff2_bugs, is_ff2_win, is_ff2_x11, opera95_bugs,
315 opera7_bugs, opera6_bugs, is_opera_95, is_opera_preseven, is_opera,
316 ie6_bugs, clientPC, changeText, killEvt, addHandler, hookEvent,
317 addClickHandler, removeHandler, getElementsByClassName, getInnerText,
318 setupCheckboxShiftClick, addCheckboxClickHandlers, mwEditButtons,
319 mwCustomEditButtons, injectSpinner, removeSpinner, escapeQuotes,
320 escapeQuotesHTML, jsMsg, addPortletLink, appendCSS, tooltipAccessKeyPrefix,
321 tooltipAccessKeyRegexp, updateTooltipAccessKeys.
322
323 == Compatibility ==
324
325 MediaWiki 1.29 requires PHP 5.5.9 or later. There is experimental support for
326 HHVM 3.6.5 or later.
327
328 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
329 but support for them is somewhat less mature. There is experimental support for
330 Oracle and Microsoft SQL Server.
331
332 The supported versions are:
333
334 * MySQL 5.0.3 or later
335 * PostgreSQL 8.3 or later
336 * SQLite 3.3.7 or later
337 * Oracle 9.0.1 or later
338 * Microsoft SQL Server 2005 (9.00.1399)
339
340 == Upgrading ==
341
342 1.29 has several database changes since 1.28, and will not work without schema
343 updates. Note that due to changes to some very large tables like the revision
344 table, the schema update may take quite long (minutes on a medium sized site,
345 many hours on a large site).
346
347 Don't forget to always back up your database before upgrading!
348
349 See the file UPGRADE for more detailed upgrade instructions, including
350 important information when upgrading from versions prior to 1.11.
351
352 For notes on 1.28.x and older releases, see HISTORY.
353
354 == Online documentation ==
355
356 Documentation for both end-users and site administrators is available on
357 MediaWiki.org, and is covered under the GNU Free Documentation License (except
358 for pages that explicitly state that their contents are in the public domain):
359
360 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
361
362 == Mailing list ==
363
364 A mailing list is available for MediaWiki user support and discussion:
365
366 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
367
368 A low-traffic announcements-only list is also available:
369
370 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
371
372 It's highly recommended that you sign up for one of these lists if you're
373 going to run a public MediaWiki, so you can be notified of security fixes.
374
375 == IRC help ==
376
377 There's usually someone online in #mediawiki on irc.freenode.net.