RELEASE-NOTES-1.33

   1 == MediaWiki 1.33 ==
   2
   3 THIS IS NOT A RELEASE YET
   4
   5 MediaWiki 1.33 is an alpha-quality branch and is not recommended for use in
   6 production.
   7
   8 === Configuration changes in 1.33 ===
   9
  10 ==== New configuration ====
  11 * $wgEnablePartialBlocks – This enables the Partial Blocks feature, which gives
  12   accounts with block permissions the ability to block users, IPs, and IP ranges
  13   from editing specific pages, while allowing them to edit the rest of the wiki.
  14
  15 ==== Changed configuration ====
  16 * Some external link searches will not work correctly until update.php (or
  17   refreshExternallinksIndex.php) is run. These include searches for links using
  18   IP addresses, internationalized domain names, and possibly mailto links.
  19 * (T193868) $wgChangeTagsSchemaMigrationStage — This temporary setting, added in
  20   MediaWiki 1.32, now defaults to MIGRATION_NEW instead of MIGRATION_WRITE_BOTH.
  21 * Special:ActiveUsers will no longer filter out users who became inactive since
  22   the last time the active users query cache was updated.
  23 * If you ran migrateActors.php using an older version of MediaWiki and want to
  24   run your wiki with $wgActorTableSchemaMigrationStage SCHEMA_COMPAT_READ_OLD,
  25   note that log_search rows needed to find revision deletions by target user
  26   were incorrectly deleted. See T215464 for details.
  27
  28 ==== Removed configuration ====
  29 * (T199334) $wgTagStatisticsNewTable — This temporary setting, added in
  30   MediaWiki 1.32, has now been removed. When loading Special:Tags, MediaWiki
  31   will now always use the `change_tag_def` instead of the `change_tag` table.
  32 * MediaWiki now always tidies user output, and most related
  33   configuration has been removed. Thus $wgUseTidy, $wgTidyBin,
  34   $wgTidyConf, $wgTidyOpts, $wgTidyInternal, and $wgDebugTidy, all
  35   deprecated since 1.26, have now all been removed. The $wgTidyConfig
  36   setting remains only for Remex experimental features or debugging.
  37 * $wgEnableParserCache, deprecated since 1.26, was removed.
  38   If disabling the parser cache is still desirable,
  39   set `$wgParserCacheType = CACHE_NONE;` instead.
  40 * $wgCommentTableSchemaMigrationStage has been removed. Extension code finding
  41   it unset should treat it as being MIGRATION_NEW.
  42 * $wgAuth – This old setting, deprecated in 1.27, has been removed as part of
  43   the removal of AuthPlugin.
  44 * $wgSitesCacheFile has been removed. It was introduced in 1.25 to allow sites
  45   to configure a file in which to cache the SiteStore database table.
  46   This was never used. SiteStore already caches its information by default
  47   using BagOStuff (e.g. Memcached or APC).
  48
  49 === New features in 1.33 ===
  50 * (T96041) __EXPECTUNUSEDCATEGORY__ on a category page causes the category
  51   to be hidden on Special:UnusedCategories.
  52 * Add PasswordPolicy to check the password isn't in the large blacklist.
  53 * The AuthManagerLoginAuthenticateAudit hook has a new parameter for
  54   additional information about the authentication event.
  55 * TextContent::getText() was introduced as a replacement for
  56   Content::getNativeData() for text-based content models.
  57 * (T210814) SVGs are now by default displayed in wiki language on image
  58   pages.
  59 * (T214706) LinksUpdate::getAddedExternalLinks() and
  60   LinksUpdate::getRemovedExternalLinks() were introduced.
  61 * Argon2 password hashing is now available, can be enabled via
  62   $wgPasswordDefault = 'argon2'. It's designed to resist timing attacks
  63   (requires PHP 7.2+) and GPU hacking (7.3+).
  64 * Special:CreateAccount now warns the user if their chosen username has to be
  65   normalized.
  66 * (T205040) Multilingual images are now be displayed in the current parse
  67   language where available.
  68
  69 === External library changes in 1.33 ===
  70
  71 ==== New external libraries ====
  72 * Added wikimedia/password-blacklist 0.1.4.
  73 * Added guzzlehttp/guzzle 6.3.3.
  74 * Added jakub-onderka/php-console-highlighter 0.3.2 explicitly (dev-only).
  75
  76 ==== Changed external libraries ====
  77 * Updated OOUI from v0.29.2 to v0.31.0.
  78 * Updated OOjs Router from pre-release to v0.2.0.
  79 * Updated moment from v2.19.3 to v2.24.0.
  80 * Updated wikimedia/xmp-reader from 0.6.0 to 0.6.2.
  81 * Updated wikimedia/scoped-callback from 2.0.0 to 3.0.0.
  82 * Updated wikimedia/ip-set from 1.2.0 to 2.0.1.
  83   * The deprecated IPSet\IPSet alias was removed, Wikimedia\IPSet must be
  84     used instead.
  85 * Updated qunitjs from 2.6.2 to 2.9.1.
  86 * Updated jquery-client from 2.0.1 to 2.0.2.
  87 * Updated psy/psysh from 0.9.6 to 0.9.9 (dev-only).
  88 * Updated nikic/php-parser from 3.1.3 to 3.1.5 (dev-only).
  89 * Updated pear/net_smtp from 1.8.0 to 1.8.1.
  90 * Updated cssjanus/cssjanus from 1.2.0 to 1.2.1.
  91 * Updated wikimedia/php-session-serializer from 1.0.6 to 1.0.7.
  92
  93 ==== Removed external libraries ====
  94
  95 === Bug fixes in 1.33 ===
  96 * (T164211) Special:UserRights could sometimes fail with a
  97   "conflict detected" error when there weren't any conflicts.
  98
  99 === Action API changes in 1.33 ===
 100 * (T198913) Added 'ApiOptions' hook.
 101 * The JSON formatversion=2 is no longer experimental.
 102 * Internal API errors (those with code beginning "internal_api_error") will
 103   include the exception class name in a data field named "errorclass".
 104   * Class names are not guaranteed to remain stable, and in particular database
 105     exceptions will now include the "Wikimedia\Rdbms\" prefix in the class name.
 106   * The code including an exception class name is deprecated. In the future,
 107     all internal errors will use code "internal_api_error".
 108 * (T212356) When using action=delete on pages with many revisions, the module
 109   may return a boolean-true 'scheduled' and no 'logid'. This signifies that the
 110   deletion will be processed via the job queue.
 111 * action=setnotificationtimestamp will now update the watchlist asynchronously
 112   if entirewatchlist is set, so updates may not be visible immediately
 113 * Block info will be added to "blocked" errors from more modules.
 114 * (T216245) Autoblocks will now be spread by action=edit and action=move.
 115
 116 === Action API internal changes in 1.33 ===
 117 * A number of deprecated methods for API documentation, intended for overriding
 118   by extensions, are no longer called by MediaWiki, and will emit deprecation
 119   notices if your extension attempts to use them:
 120   * ApiBase::getDescription() (deprecated in 1.25)
 121   * ApiBase::getParamDescription() (deprecated in 1.25)
 122   * ApiBase::getExamples() (deprecated in 1.25)
 123   * ApiBase::getDescriptionMessage() (deprecated in 1.30)
 124   Additionally, the  'APIGetDescription' and 'APIGetParamDescription' hooks have
 125   been removed, as their only use was to let extensions override values returned
 126   by getDescription() and getParamDescription(), respectively.
 127 * API error codes may only contain ASCII letters, numbers, underscore, and
 128   hyphen. Methods such as ApiBase::dieWithError() and
 129   ApiMessageTrait::setApiCode() will throw an InvalidArgumentException if
 130   passed a bad code.
 131 * ApiBase::checkTitleUserPermissions() now takes an options array as its third
 132   parameter. Passing a User object or null is deprecated.
 133 * The api-feature-usage log channel now has log context. The text message is
 134   deprecated and will be removed in the future.
 135
 136 === Languages updated in 1.33 ===
 137 MediaWiki supports over 350 languages. Many localisations are updated regularly.
 138 Below only new and removed languages are listed, as well as changes to languages
 139 because of Phabricator reports.
 140
 141 * (T203908) Added language support for Eastern Pwo (kjp).
 142 * (T213717) Fixed a translation error on Goan Konkani (gom-deva) translations
 143   for NS_TEMPLATE.
 144 * (T212221) Added $digitTransformTable for Santali (sat).
 145 * (T216479) Added language support for Saisiyat (xsy).
 146
 147 === Breaking changes in 1.33 ===
 148 * The parameteter $lang in DifferenceEngine::setTextLanguage must be of type
 149   Language. Other types are deprecated since 1.32.
 150 * Skin::doEditSectionLink requires type Language for the parameter $lang.
 151   The parameters $tooltip and $lang are mandatory. Omitting the parameters is
 152   deprecated since 1.32.
 153 * Language::truncate(), deprecated in 1.31, has been removed.
 154 * UtfNormal, deprecated in 1.25, was removed. Use UtfNormal\Validator directly
 155   instead.
 156 * (T197179) In OOUI HTMLForm fields, the parameters 'notice', 'notice-messages',
 157   and 'notice-message', which were deprecated in 1.32, were removed. Instead,
 158   use 'help', 'help-message', and 'help-messages'.
 159 * (T197179) HTMLFormField::getNotices(), deprecated in 1.32, was removed.
 160 * The "Parsoid v1" compatibility mappings in ParsoidVirtualRESTService and
 161   RestbaseVirtualRESTService, deprecated since 1.26, have been removed.
 162   Use the RESTBase v1 or Parsoid v3 API instead.
 163 * ParserOptions defaults 'tidy' to true now, since the untidy modes of the
 164   parser are being deprecated and ParserOptions::getCanonicalOverrides()
 165   has always been true at any rate.
 166 * Support for disabling tidy and external tidy implementations has been removed.
 167   This was deprecated in 1.32. The pure PHP Remex tidy implementation is now
 168   used and no configuration is necessary.
 169 * A number of deprecated methods for API documentation, intended for overriding
 170   by extensions, are no longer called by MediaWiki, and will emit deprecation
 171   notices if your extension attempts to use them:
 172   * ApiBase::getDescription() (deprecated in 1.25)
 173   * ApiBase::getParamDescription() (deprecated in 1.25)
 174   * ApiBase::getExamples() (deprecated in 1.25)
 175   * ApiBase::getDescriptionMessage() (deprecated in 1.30)
 176   Additionally, the  'APIGetDescription' and 'APIGetParamDescription' hooks have
 177   been removed, as their only use was to let extensions override values returned
 178   by getDescription() and getParamDescription(), respectively.
 179 * The authentication hooks 'AbortAutoAccount' 'AbortNewAccount', 'AbortLogin',
 180   'LoginUserMigrated', 'UserCreateForm', and 'UserLoginForm', all deprecated by
 181   the creation of AuthManager in 1.27, have been removed. This also means that
 182   the FakeAuthTemplate and LoginForm classes are removed, that FakeAuthTemplate
 183   is no longer passed into LoginSignupSpecialPage->getFieldDefinitions(), and
 184   that LoginSignupSpecialPage->getBCFieldDefinitions() is removed.
 185 * The 'jquery.localize' module, deprecated in 1.32, has been removed. Instead,
 186   use 'jquery.i18n'.
 187 * The hooks LanguageGetSpecialPageAliases and LanguageGetMagic, deprecated since
 188   1.16, have now been removed. Instead, use $specialPageAliases or $magicWords
 189   respectively in a $wgExtensionMessagesFiles file.
 190 * The following methods of the Preferences class, deprecated in 1.31, have been
 191   removed:
 192   * getSaveBlacklist()
 193   * loadPreferenceValues()
 194   * getOptionFromUser()
 195   * profilePreferences()
 196   * skinPreferences()
 197   * filesPreferences()
 198   * datetimePreferences()
 199   * renderingPreferences()
 200   * editingPreferences()
 201   * rcPreferences()
 202   * watchlistPreferences()
 203   * searchPreferences()
 204   * miscPreferences()
 205   * generateSkinOptions()
 206   * getDateOptions()
 207   * getImageSizes()
 208   * getThumbSizes()
 209   * validateSignature()
 210   * cleanSignature()
 211   * getTimezoneOptions()
 212   * filterIntval()
 213   * filterTimezoneInput()
 214   * getTimeZoneList()
 215 * mw.util.jsMessage(), deprecated in 1.20, was removed. Use mw.notify instead.
 216 * (T61113) User::EDIT_TOKEN_SUFFIX was removed. It was deprecated since 1.27.
 217 * The 'mediawiki.api' module aliases, deprecated in 1.32, have been removed.
 218   Specifically: mediawiki.api.category, mediawiki.api.edit,
 219   mediawiki.api.login, mediawiki.api.options, mediawiki.api.parse,
 220   mediawiki.api.upload, mediawiki.api.user, mediawiki.api.watch,
 221   mediawiki.api.messages, and mediawiki.api.rollback.
 222 * The 'jquery.byteLimit' module alias for 'jquery.lengthLimit',
 223   deprecated in 1.31, was removed.
 224 * Revision::fetchRevision(), deprecated in 1.28, was removed.
 225 * Class SquidUpdate, deprecated in 1.27, was removed.
 226 * Title->getSquidURLs(), deprecated in 1.27, was removed. Instead, use
 227   Title->getCdnUrls().
 228 * Title::escapeFragmentForURL(), deprecated in 1.30, was removed. Use
 229   Sanitizer::escapeIdForLink() or escapeIdForExternalInterwiki() instead.
 230 * Title->canTalk(), deprecated in 1.30, was removed. Instead, use
 231   Title->canHaveTalkPage().
 232 * Title's methods for site and user page related to CSS and JS, deprecated in
 233   1.31, were removed:
 234   * Title->isCssOrJsPage() — Use Title->isSiteConfigPage()
 235   * Title->isCssJsSubpage() – Use Title->isUserConfigPage()
 236   * Title->getSkinFromCssJsSubpage() – Use Title->getSkinFromConfigSubpage()
 237   * Title->isCssSubpage() – Use Title->isUserCssConfigPage()
 238   * Title->isJsSubpage() – Use Title->isUserJsConfigPage()
 239 * SiteSQLStore, deprecated in 1.27 and whose only method, ::newInstance(),
 240   would return the global SiteStore instance, has been removed. You can get to
 241   this via MediaWiki\MediaWikiServices::getInstance()->getSiteStore() directly.
 242 * Linker::formatSize, deprecated in 1.28, has been removed (with DummyLinker's).
 243   Instead, use Language->formatSize() with the relevant Language object.
 244 * Linker::formatTemplates, deprecated in 1.28, has been removed (along with the
 245   version in DummyLinker). You can use TemplatesOnThisPageFormatter directly.
 246 * EventRelayerGroup::singleton(), deprecated in 1.27, has been removed. You can
 247   use MediaWikiServices::getInstance()->getEventRelayerGroup() directly.
 248 * LinkCache->addLink(), deprecated in 1.27, has been removed. It is thought to
 249   be unused, and is distinct from OutputPage->addLink(), which remains.
 250 * JsonContent->getJsonData(), deprecated in 1.25, has been removed. Instead, use
 251   JsonContent->getData().
 252 * MWExceptionHandler::getLogId(), deprecated in 1.27, has been removed, as the
 253   exception ID is the same as the request ID, from WebRequest::getRequestId().
 254 * SearchEngine::getNearMatchResultSet(), deprecated in 1.27, has been removed.
 255   You can use SearchEngine::getNearMatcher() instead.
 256 * EmailNotification::updateWatchlistTimestamp, deprecated in 1.27, has been
 257   removed. Instead, use WatchedItemStore::updateNotificationTimestamp directly.
 258 * User::getGroupName() and ::getGroupMember(), both deprecated in 1.29, have
 259   been removed. Instead, please use UserGroupMembership::getGroupName() and
 260   UserGroupMembership::getGroupMemberName().
 261 * Backwards compatibility for setting wgSessionsInObjectCache to false or using
 262   wgSessionHandler, both of which were deprecated in 1.27 with the introduction
 263   of SessionManager, has been removed.
 264 * SessionManager::autoCreateUser, deprecated in 1.27, has been removed. Use
 265   MediaWiki\Auth\AuthManager::autoCreateUser instead.
 266 * The mw.libs.jpegmeta property, deprecated in 1.31, was removed.
 267   Use require( 'mediawiki.libs.jpegmeta' ) instead.
 268 * The mw.user.stickyRandomId() method, deprecated in 1.32, was removed.
 269   Use mw.user.getPageviewToken() instead.
 270 * Removed deprecated class property WikiRevision::$importer.
 271 * ResourceLoaderFileModule::readStyleFiles() now requires its $context
 272   parameter.
 273 * The ChangeList::insertArticleLink() method, that was deprecated in 1.27, has
 274   been removed.
 275 * MessageBlobStore::__construct() now requires its $rl parameter.
 276 * Second parameter to Sanitizer::escapeIdReferenceList() (deprecated in 1.31)
 277   has been removed.
 278 * The 'jquery.xmldom' module has been removed.
 279 * The 'jquery.mockjax' module has been removed.
 280 * The 'jquery.hidpi' module, deprecated in 1.32, has been removed.
 281 * AuthPlugin and related code, deprecated in 1.27, has been removed. Extensions
 282   should instead use AuthManager. The following no longer exist:
 283   * The AuthPlugin class itself and the related AuthPluginUser class and i18n
 284   * The AuthPluginSetup and AuthPluginAutoCreate hooks
 285   * The transitional wrapper classes AuthPluginPrimaryAuthenticationProvider,
 286     AuthManagerAuthPlugin, and AuthManagerAuthPluginUser.
 287   * The $wgAuth configuration setting and its use in Setup.php and unit tests
 288 * (T217772) The 'wgAvailableSkins' mw.config key in JavaScript, was removed.
 289 * Language::markNoConversion, deprecated in 1.32, has been removed. Use
 290   LanguageConverter::markNoConversion instead.
 291 * BagOStuff::modifySimpleRelayEvent() method has been removed.
 292 * ParserOutput::getLegacyOptions, deprecated in 1.30, has been removed.
 293   Use ParserOutput::allCacheVaryingOptions instead.
 294 * CdnCacheUpdate::newSimplePurge, deprecated in 1.27, has been removed.
 295   Use CdnCacheUpdate::newFromTitles() instead.
 296
 297 === Deprecations in 1.33 ===
 298 * The configuration option $wgUseESI has been deprecated, and is expected
 299   to be removed in a future release.
 300 * The configuration option $wgSquidPurgeUseHostHeader has been deprecated,
 301   and is expected to be removed in a future release.
 302 * The configuration options $wgFixArabicUnicode and $wgFixMalayalamUnicode,
 303   introduced in MW 1.17, have been deprecated.  These fixes will always be
 304   applied for Arabic and Malayalam in the future.  Please enable these on
 305   your local wiki (if you have them explicitly set to false) and run
 306   maintenance/cleanupTitles.php to fix any existing page titles.
 307 * The LegacyHookPreAuthenticationProvider class, deprecated since its creation
 308   in 1.27 as part of the AuthManager re-write, now emits deprecation warnings.
 309   This will help identify the issue if you added it to $wgAuthManagerConfig.
 310 * wfSplitWikiId() is now deprecated. Cache key generation should have the wiki
 311   domain ID as a key component and use makeGlobalKey().
 312 * (T202094) Title::getUserCaseDBKey() is deprecated; instead, please use
 313   Title::getDBKey(), which doesn't vary case.
 314 * User::getPasswordValidity() is now deprecated. User::checkPasswordValidity()
 315   returns the same information in a more useful format.
 316 * For Linker::generateTOC() and Linker::tocList(), passing strings or booleans
 317   as the $lang parameter was deprecated. The same applies to DummyLinker.
 318 * The PasswordPolicy 'PasswordCannotBePopular' has been deprecated. To
 319   follow best practices, it is reccommended to use 'PasswordNotInLargeBlacklist'
 320   instead which blacklists 100,000 commonly used passwords.
 321 * (T208862) Action::requiresUnblock() is now called from
 322   Title::getUserPermissionsErrors() and Title::userCan(). Previously, the method
 323   was only called in Action::checkCanExecute(). Actions should ensure that their
 324   requiresUnblock() returns the proper result (the default is `true`).
 325 * (T211608) The MediaWiki\Services namespace has been renamed to
 326   Wikimedia\Services. The old name is still supported, but deprecated.
 327 * (T155582) Content::getNativeData has been deprecated. Please use model-
 328   specific getters, such as TextContent::getText().
 329 * The class WebInstallerOutput is now marked as @private.
 330 * (T209699) The jquery.async module has been deprecated. JavaScript code that
 331   needs asynchronous behaviour should use Promises.
 332 * Password::equals() is deprecated, use verify().
 333 * BaseTemplate::msgWiki() and QuickTemplate::msgWiki() will be removed. Use
 334   other means to fetch a properly escaped message string or Message object.
 335 * (T126091) The 'ResourceLoaderTestModules' hook, which lets you declare QUnit
 336   testing code for your JavaScript modules, is deprecated. Instead, you can now
 337   use the new extension registration key 'QUnitTestModule'.
 338 * (T213426) The jquery.throttle-debounce module has been deprecated. JavaScript
 339   code that needs this behaviour should use OO.ui.debounce/throttle.
 340 * The mw.language.specialCharacters property from the
 341   'mediawiki.language.specialCharacters' module has been deprecated.
 342   Use require( 'mediawiki.language.specialCharacters' ) instead.
 343 * ChangeTags::purgeTagUsageCache() has been deprecated, and is expected to be
 344   removed in a future release.
 345 * Passing a User object or null as the third parameter to
 346   ApiBase::checkTitleUserPermissions() has been deprecated. Pass an array
 347   [ 'user' => $user ] instead.
 348 * (T211578) Block::prevents is deprecated. Use Block::isEmailBlocked,
 349   Block::isCreateAccountBlocked and Block::isUsertalkEditAllowed to get and set
 350   block properties; use Block::appliesToRight and Block::appliesToUsertalk to
 351   check block behaviour.
 352 * The api-feature-usage log channel now has log context. The text message is
 353   deprecated and will be removed in the future.
 354 * The FileBasedSiteLookup class has been deprecated. For a cacheable SiteLookup
 355   implementation, use CachingSiteStore instead.
 356
 357 === Other changes in 1.33 ===
 358 * (T201747) Html::openElement() warns if given an element name with a space
 359   in it.
 360 * The implementation of buildStringCast() in Wikimedia\Rdbms\Database has
 361   changed to explicitly cast. Subclasses relying on the base-class
 362   implementation should check whether they need to override it now.
 363 * BagOStuff::add is now abstract and must explicitly be defined in subclasses.
 364
 365 == Compatibility ==
 366 MediaWiki 1.33 requires PHP 7.0.13 or later. Although HHVM 3.18.5 or later is
 367 supported, it is generally advised to use PHP 7.0.13 or later for long term
 368 support.
 369
 370 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 371 but support for them is somewhat less mature. There is experimental support for
 372 Oracle and Microsoft SQL Server.
 373
 374 The supported versions are:
 375
 376 * MySQL 5.5.8 or later
 377 * PostgreSQL 9.2 or later
 378 * SQLite 3.8.0 or later
 379 * Oracle 9.0.1 or later
 380 * Microsoft SQL Server 2005 (9.00.1399)
 381
 382 == Upgrading ==
 383 1.33 has several database changes since 1.32, and will not work without schema
 384 updates. Note that due to changes to some very large tables like the revision
 385 table, the schema update may take quite long (minutes on a medium sized site,
 386 many hours on a large site).
 387
 388 Don't forget to always back up your database before upgrading!
 389
 390 See the file UPGRADE for more detailed upgrade instructions, including
 391 important information when upgrading from versions prior to 1.11.
 392
 393 For notes on 1.32.x and older releases, see HISTORY.
 394
 395 == Online documentation ==
 396 Documentation for both end-users and site administrators is available on
 397 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 398 for pages that explicitly state that their contents are in the public domain):
 399
 400        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 401
 402 == Mailing list ==
 403 A mailing list is available for MediaWiki user support and discussion:
 404
 405        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 406
 407 A low-traffic announcements-only list is also available:
 408
 409        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 410
 411 It's highly recommended that you sign up for one of these lists if you're
 412 going to run a public MediaWiki, so you can be notified of security fixes.
 413
 414 == IRC help ==
 415 There's usually someone online in #mediawiki on irc.freenode.net.