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