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