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