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