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