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