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