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