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