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