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