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