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