RELEASE-NOTES-1.32

   1 == MediaWiki 1.32 ==
   2
   3 THIS IS NOT A RELEASE YET
   4
   5 MediaWiki 1.32 is an alpha-quality branch and is not recommended for use in
   6 production.
   7
   8 === Configuration changes in 1.32 ===
   9 * (T115414) The $wgEnableAPI and $wgEnableWriteAPI settings, deprecated in 1.31,
  10   have been removed.
  11 * The $wgUseAjax setting, deprecated in 1.31, is now ignored.
  12 * The $wgSiteSupportPage setting, unused since 1.5, was removed.
  13 * The default quality of JPEG thumbnails generated by GD was reduced from 95 to
  14   80. The quality of JPEG thumbnails is now configurable through the new setting
  15   $wgJpegQuality (default 80). This aligns the quality to what ImageMagick uses.
  16 * $wgExperimentalHtmlIds, deprecated since 1.30, has been removed. The
  17   'html5-legacy' value for $wgFragmentMode is no longer accepted.
  18 * The experimental Html5Internal and Html5Depurate tidy drivers were removed.
  19   RemexHtml, which is the default, should be used instead.
  20 * (T135963) You can now define a Content Security Policy for your wiki. This
  21   adds a defense-in-depth feature to stop an attacker who has found a bug in
  22   the parser allowing them to insert malicious attributes. Disabled by default,
  23   you can configure this via $wgCSPHeader and $wgCSPReportOnlyHeader.
  24 * New configuration variable has been added: $wgCookieSetOnIpBlock.
  25   This determines whether to set a cookie when an IP user is blocked. Doing so means
  26   that a blocked user, even after moving to a new IP address, will still be blocked.
  27 * The archive table's ar_rev_id field is now unique.
  28 * Special:BotPasswords now requires reauthentication.
  29
  30 === New features in 1.32 ===
  31 * (T112474) Generalized the ResourceLoader mechanism for overriding modules
  32   using a particular page during edit previews.
  33 * (T12331) You can now log page creation events by setting $wgPageCreationLog
  34   to true.
  35 * Added 'ApiParseMakeOutputPage' hook.
  36 * (T174313) Added checkbox on Special:ListUsers to display only users in
  37   temporary user groups.
  38 * (T152462) A cookie can now be set when an IP user is blocked to track that user if
  39   they move to a new IP address. This is disabled by default.
  40 * (T194950) Added 'ApiMaxLagInfo' hook.
  41 * SpecialPage::checkLoginSecurityLevel() will now preserve POST data when
  42   reauthenticating.
  43 * FormSpecialPage::execute() will now call checkLoginSecurityLevel() if
  44   getLoginSecurityLevel() returns non-false.
  45
  46 === External library changes in 1.32 ===
  47 * …
  48
  49 ==== Upgraded external libraries ====
  50 * Updated QUnit from 2.4.0 to 2.6.0.
  51 * Updated wikimedia/scoped-callback from 1.0.0 to 2.0.0.
  52 ** ScopedCallback objects can no longer be serialized.
  53 * Updated wikimedia/wrappedstring from 2.3.0 to 3.0.1.
  54
  55 ==== New external libraries ====
  56 * Added wikimedia/xmp-reader 0.5.1
  57 * …
  58
  59 ==== Removed and replaced external libraries ====
  60 * …
  61
  62 === Bug fixes in 1.32 ===
  63 * SpecialPage::execute() will now only call checkLoginSecurityLevel() if
  64   getLoginSecurityLevel() returns non-false.
  65
  66 === Action API changes in 1.32 ===
  67 * Added templated parameters.
  68   * A module can define a templated parameter like "{fruit}-quantity", where
  69     the actual parameters recognized correspond to the values of a multi-valued
  70     parameter. Then clients can make requests like
  71     "fruits=apples|bananas&apples-quantity=1&bananas-quantity=5".
  72   * action=paraminfo will return templated parameter definitions separately
  73     from normal parameters. All parameter definitions now include an "index"
  74     key to allow clients to maintain parameter ordering when merging normal and
  75     templated parameters.
  76 * It is now an error to submit too many values for a multi-valued parameter.
  77   This has generated a warning since MediaWiki 1.14.
  78
  79 === Action API internal changes in 1.32 ===
  80 * Added 'ApiParseMakeOutputPage' hook.
  81 * Parameter names may no longer contain '{' or '}', as these are now used for
  82   templated parameters.
  83 * (T194950) Added 'ApiMaxLagInfo' hook.
  84
  85 === Languages updated in 1.32 ===
  86 MediaWiki supports over 350 languages. Many localisations are updated regularly.
  87 Below only new and removed languages are listed, as well as changes to languages
  88 because of Phabricator reports.
  89
  90 * (T193566) Added language support for Ambonese Malay (abs).
  91 * (T194047) Added language support for Shawiya, Latin script (shy-latn).
  92 * (T195940) Added language support for Batak Mandailing (btm).
  93 * (T137491) Added language support for Standard Moroccan Amazigh (zgh).
  94
  95 === Breaking changes in 1.32 ===
  96 * $wgRequestTime, deprecated in 1.25, was removed. Use
  97   $_SERVER['REQUEST_TIME_FLOAT'] or WebRequest::getElapsedTime() instead.
  98 * The MediaWikiI18N class, deprecated in 1.31, was removed.
  99 * QuickTemplate::setTranslator(), deprecated in 1.31, was removed. Use
 100   Skin::msg() instead.
 101 * wfInitShellLocale(), deprecated in 1.30, was removed.
 102 * wfShellExecDisabled(), deprecated in 1.30, was removed.
 103 * The type string for the parameter $lang of DateFormatter::getInstance,
 104   deprecated in 1.31, was removed.
 105 * The EDIT_TOKEN_SUFFIX constant deprecated in 1.27, was removed. Use
 106   MediaWiki\Session\Token::SUFFIX instead.
 107 * EditPage::isOouiEnabled() deprecated in 1.30, was removed.
 108 * mw.util.wikiGetlink(), deprecated in 1.23, was removed. Use mw.util.getUrl()
 109   instead.
 110 * (T61113) The following methods and constants from the Revision class, which
 111   were deprecated in 1.25, have now been removed:
 112   * Revision::getRawUser()
 113   * Revision::getRawUserText()
 114   * Revision::getRawComment()
 115 * window.gM() from mediawiki.jqueryMsg, deprecated in 1.23, was removed. Use
 116   mw.msg() or mw.message() instead.
 117 * mw.util.escapeId(), deprecated in 1.30, was removed. Use
 118   mw.util.escapeIdForAttribute or mw.util.escapeIdForLink instead.
 119 * mw.util.updateTooltipAccessKeys(), deprecated in 1.24, was removed. Use
 120   jquery.accessKeyLabel instead.
 121 * The SqlDataUpdate class, deprecated in 1.28, has been removed.
 122 * The Html5Internal and Html5Depurate tidy driver classes were removed, along
 123   with the Balancer tidy implementation. Both implementations were experimental,
 124   and were replaced by RemexHtml.
 125 * (T179624) Job::insert() and ::batchInsert(), deprecated in 1.21, were both
 126   removed. Use JobQueueGroup::singleton()->push() instead.
 127 * The jquery.footHovzer module, for mediawiki.debug, was removed.
 128 * The es5-shim module, empty and deprecated since 1.29, was removed.
 129 * The mediawiki.widgets.visibleByteLimit module alias, deprecated in 1.32, was
 130   removed. Use mediawiki.widgets.visibleLengthLimit instead.
 131 * The jquery.farbtastic module, unused since 1.18, was removed.
 132 * (T181318) The $wgStyleVersion setting and its appendage to various script and
 133   style URLs in OutputPage, deprecated in 1.31, was removed.
 134 * The hooks 'PreferencesFormPreSave' and 'PreferencesGetLegend' may provide
 135   any HTMLForm object rather than PreferencesForm.
 136 * The non namespaced TimestampException class, deprecated in 1.29, was removed.
 137   Use Wikimedia\Timestamp\TimestampException instead.
 138 * The global functions codepointToUtf8, hexSequenceToUtf8, utf8ToHexSequence,
 139   utf8ToCodepoint, and escapeSingleString (deprecated in 1.25) were removed.
 140   The UtfNormal\Utils class from the utfnormal library should be used instead.
 141 * The deprecated UTF8_ and UNICODE_ constants were removed. The class constants
 142   from the UtfNormal\Constants class from the utfnormal library should be used
 143 * (T140807) The wgResourceLoaderLESSImportPaths configuration option was removed
 144   from ResourceLoader. Instead, use `@import` statements in LESS to import
 145   files directly from nearby directories within the same project.
 146 * The protected methods PHPSessionHandler::returnSuccess() and returnFailure(),
 147   only needed for PHP5 compatibility, have been removed. It now uses the boolean
 148   values `true` and `false` respectively.
 149 * The $parserMemc global and wfGetParserCacheStorage(), deprecated since 1.30,
 150   were removed. Use the ParserCache class instead.
 151 * ScopedCallback (deprecated in 1.28) was removed. Use Wikimedia\ScopedCallback
 152   instead.
 153 * Support for ResourceLoaderModule::getModifiedTime() and getModifiedHash(),
 154   deprecated since 1.26, was removed. Use getDefinitionSummary() instead.
 155 * (T195256) Skins are recommended not to rely on JavaScript for the "mw-jump"
 156   and "jump-to-nav" accessibility links. To this end, the "jquery.mw-jump"
 157   is no longer loaded by default. The Vector and MonoBook skins have made a
 158   minor change to implement the toggle feature with CSS instead. To restore
 159   prior functionality, either explicitly load "jquery.mw-jump" in your skin
 160   or refer to T195256 for details on how to make the same change.
 161 * Hook 'EditPageBeforeEditChecks' was removed;
 162   use 'EditPageGetCheckboxesDefinition' instead.
 163 * Linker::getLinkColour() and DummyLinker::getLinkColour(), deprecated since
 164   1.28, were removed. LinkRenderer::getLinkClasses() should be used instead.
 165
 166 === Deprecations in 1.32 ===
 167 * Use of a StartProfiler.php file is deprecated in favour of placing
 168   configuration in LocalSettings.php.
 169 * HTMLForm::setSubmitProgressive() is deprecated. No need to call it. Submit
 170   button is already marked as progressive.
 171 * Skin::setupSkinUserCss() is deprecated. Adding of modules to load
 172   has been centralised to Skin::getDefaultModules(), which is now capable
 173   of queueing style modules as well.
 174 * OutputPage::addModuleScripts() and ParserOutput::addModuleScripts are
 175   deprecated. Use addModules() instead.
 176 * Overriding SearchEngine::{searchText,searchTitle,searchArchiveTitle}
 177   in extending classes is deprecated.  Extend related doSearch* methods
 178   instead.
 179 * CollationFa has been removed completely as it's not needed anymore
 180 * The following 'mediawiki.api' plugin modules were merged into mediawiki.api
 181   and deprecated: mediawiki.api.category, mediawiki.api.edit,
 182   mediawiki.api.login, mediawiki.api.options, mediawiki.api.parse,
 183   mediawiki.api.upload, mediawiki.api.user, mediawiki.api.watch,
 184   mediawiki.api.messages, and mediawiki.api.rollback.
 185 * ApiBase::truncateArray() is deprecated. No replacement, as nothing is known
 186   to use it.
 187 * WatchAction::getUnwatchToken is deprecated. Use WatchAction::getWatchToken
 188   with the 'unwatch' action parameter instead.
 189 * IcuCollation::getICUVersion() is deprecated, as you can just use the PHP
 190   constant INTL_ICU_VERSION directly in all versions that MediaWiki supports.
 191 * Parser::fetchFile() is deprecated. Use ::fetchFileAndTitle() instead.
 192 * The ApiQueryContributions class has been renamed to ApiQueryUserContribs.
 193 * The XMPInfo, XMPReader, and XMPValidate classes have been deprecated in favor
 194   of the namespaced classes provided by the wikimedia/xmp-reader library.
 195 * SearchResultSet::{next,rewind} are deprecated. Calling code should
 196   use foreach on the SearchResultSet, or the extractResults method. Extending
 197   code should override extractResults.
 198 * Instantiating SearchResultSet directly is deprecated. SearchEngine
 199   implementations must subclass SearchResultSet for their purposes.
 200 * SearchResult::setExtensionData argument has been changed from accepting an
 201   array to accepting a Closure that returns the array when called.
 202 * Class CryptRand, everything in MWCryptRand except generateHex() and function
 203   MediaWikiServices::getCryptRand() are deprecated, use random_bytes() to
 204   generate cryptographically secure random byte sequences.
 205 * Parser::getConverterLanguage() is deprecated.  Use ::getTargetLanguage()
 206   instead.
 207
 208 === Other changes in 1.32 ===
 209 * …
 210
 211 == Compatibility ==
 212 MediaWiki 1.32 requires PHP 7.0.0 or later. Although HHVM 3.18.5 or later is
 213 supported, it is generally advised to use PHP 7.0.0 or later for long term
 214 support.
 215
 216 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 217 but support for them is somewhat less mature. There is experimental support for
 218 Oracle and Microsoft SQL Server.
 219
 220 The supported versions are:
 221
 222 * MySQL 5.5.8 or later
 223 * PostgreSQL 9.2 or later
 224 * SQLite 3.3.7 or later
 225 * Oracle 9.0.1 or later
 226 * Microsoft SQL Server 2005 (9.00.1399)
 227
 228 == Upgrading ==
 229 1.32 has several database changes since 1.31, and will not work without schema
 230 updates. Note that due to changes to some very large tables like the revision
 231 table, the schema update may take quite long (minutes on a medium sized site,
 232 many hours on a large site).
 233
 234 Don't forget to always back up your database before upgrading!
 235
 236 See the file UPGRADE for more detailed upgrade instructions, including
 237 important information when upgrading from versions prior to 1.11.
 238
 239 For notes on 1.31.x and older releases, see HISTORY.
 240
 241 == Online documentation ==
 242 Documentation for both end-users and site administrators is available on
 243 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 244 for pages that explicitly state that their contents are in the public domain):
 245
 246        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 247
 248 == Mailing list ==
 249 A mailing list is available for MediaWiki user support and discussion:
 250
 251        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 252
 253 A low-traffic announcements-only list is also available:
 254
 255        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 256
 257 It's highly recommended that you sign up for one of these lists if you're
 258 going to run a public MediaWiki, so you can be notified of security fixes.
 259
 260 == IRC help ==
 261 There's usually someone online in #mediawiki on irc.freenode.net.