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