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