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