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