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