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