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