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