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