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