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