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
 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
 176 === Deprecations in 1.33 ===
 177 * The configuration option $wgUseESI has been deprecated, and is expected
 178   to be removed in a future release.
 179 * The configuration option $wgSquidPurgeUseHostHeader has been deprecated,
 180   and is expected to be removed in a future release.
 181 * The configuration options $wgFixArabicUnicode and $wgFixMalayalamUnicode,
 182   introduced in MW 1.17, have been deprecated.  These fixes will always be
 183   applied for Arabic and Malayalam in the future.  Please enable these on
 184   your local wiki (if you have them explicitly set to false) and run
 185   maintenance/cleanupTitles.php to fix any existing page titles.
 186 * The LegacyHookPreAuthenticationProvider class, deprecated since its creation
 187   in 1.27 as part of the AuthManager re-write, now emits deprecation warnings.
 188   This will help identify the issue if you added it to $wgAuthManagerConfig.
 189 * wfSplitWikiId() is now deprecated. Cache key generation should have the wiki
 190   domain ID as a key component and use makeGlobalKey().
 191 * (T202094) Title::getUserCaseDBKey() is deprecated; instead, please use
 192   Title::getDBKey(), which doesn't vary case.
 193 * User::getPasswordValidity() is now deprecated. User::checkPasswordValidity()
 194   returns the same information in a more useful format.
 195 * For Linker::generateTOC() and Linker::tocList(), passing strings or booleans
 196   as the $lang parameter was deprecated. The same applies to DummyLinker.
 197 * The PasswordPolicy 'PasswordCannotBePopular' has been deprecated. To
 198   follow best practices, it is reccommended to use 'PasswordNotInLargeBlacklist'
 199   instead which blacklists 100,000 commonly used passwords.
 200 * (T208862) Action::requiresUnblock() is now called from
 201   Title::getUserPermissionsErrors() and Title::userCan(). Previously, the method
 202   was only called in Action::checkCanExecute(). Actions should ensure that their
 203   requiresUnblock() returns the proper result (the default is `true`).
 204 * …
 205
 206 === Other changes in 1.33 ===
 207 * (T208871) The hard-coded Google search form on the database error page was
 208   removed.
 209 * (T201747) Html::openElement() warns if given an element name wiht a space
 210   in it.
 211 * …
 212
 213 == Compatibility ==
 214 MediaWiki 1.33 requires PHP 7.0.0 or later. Although HHVM 3.18.5 or later is
 215 supported, it is generally advised to use PHP 7.0.0 or later for long term
 216 support.
 217
 218 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 219 but support for them is somewhat less mature. There is experimental support for
 220 Oracle and Microsoft SQL Server.
 221
 222 The supported versions are:
 223
 224 * MySQL 5.5.8 or later
 225 * PostgreSQL 9.2 or later
 226 * SQLite 3.3.7 or later
 227 * Oracle 9.0.1 or later
 228 * Microsoft SQL Server 2005 (9.00.1399)
 229
 230 == Upgrading ==
 231 1.33 has several database changes since 1.32, and will not work without schema
 232 updates. Note that due to changes to some very large tables like the revision
 233 table, the schema update may take quite long (minutes on a medium sized site,
 234 many hours on a large site).
 235
 236 Don't forget to always back up your database before upgrading!
 237
 238 See the file UPGRADE for more detailed upgrade instructions, including
 239 important information when upgrading from versions prior to 1.11.
 240
 241 For notes on 1.32.x and older releases, see HISTORY.
 242
 243 == Online documentation ==
 244 Documentation for both end-users and site administrators is available on
 245 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 246 for pages that explicitly state that their contents are in the public domain):
 247
 248        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 249
 250 == Mailing list ==
 251 A mailing list is available for MediaWiki user support and discussion:
 252
 253        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 254
 255 A low-traffic announcements-only list is also available:
 256
 257        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 258
 259 It's highly recommended that you sign up for one of these lists if you're
 260 going to run a public MediaWiki, so you can be notified of security fixes.
 261
 262 == IRC help ==
 263 There's usually someone online in #mediawiki on irc.freenode.net.