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 * The array of hidden options ($opts) passed to the 'SpecialSearchPowerBox' hook
  55   is now passed by reference, allowing extensions to modify or even unset it.
  56 * Added new 'OutputPageAfterGetHeadLinksArray' hook, allowing extensions to
  57   modify the return value of OutputPage#getHeadLinksArray in order to add,
  58   remove or otherwise alter the elements to be output in the page <head>.
  59
  60 === External library changes in 1.32 ===
  61 * …
  62
  63 ==== Upgraded external libraries ====
  64 * Updated QUnit from 2.4.0 to 2.6.0.
  65 * Updated wikimedia/scoped-callback from 1.0.0 to 2.0.0.
  66 ** ScopedCallback objects can no longer be serialized.
  67 * Updated wikimedia/wrappedstring from 2.3.0 to 3.0.1.
  68 * Updated mediawiki/mediawiki-codesniffer from v20.0.0 to v21.0.0.
  69 * Updated composer/spdx-licenses from 1.3.0 to 1.4.0.
  70
  71 ==== New external libraries ====
  72 * Added wikimedia/xmp-reader 0.5.1
  73 * …
  74
  75 ==== Removed and replaced external libraries ====
  76 * …
  77
  78 === Bug fixes in 1.32 ===
  79 * SpecialPage::execute() will now only call checkLoginSecurityLevel() if
  80   getLoginSecurityLevel() returns non-false.
  81
  82 === Action API changes in 1.32 ===
  83 * Added templated parameters.
  84   * A module can define a templated parameter like "{fruit}-quantity", where
  85     the actual parameters recognized correspond to the values of a multi-valued
  86     parameter. Then clients can make requests like
  87     "fruits=apples|bananas&apples-quantity=1&bananas-quantity=5".
  88   * action=paraminfo will return templated parameter definitions separately
  89     from normal parameters. All parameter definitions now include an "index"
  90     key to allow clients to maintain parameter ordering when merging normal and
  91     templated parameters.
  92 * It is now an error to submit too many values for a multi-valued parameter.
  93   This has generated a warning since MediaWiki 1.14.
  94 * Assertion failures from the 'assert' and 'assertuser' parameters will no
  95   longer use the action module's custom response format, for the few modules
  96   that use custom formatters that handle errors.
  97 * (T198935) User list preferences such as `email-blacklist` and similar
  98   extension preferences are no longer represented as arrays when returned by
  99   action=query&meta=userinfo&uiprop=options.
 100 * 'missingparam' errors will now use the prefixed parameter name in the code
 101   and error text, e.g. "noxxfoo" and "The 'xxfoo' parameter must be set" rather
 102   than "nofoo" and "The 'foo' parameter must be set".
 103 * action=query&prop=revisions now takes a 'rvslots' parameter to indicate the
 104   multi-content revision slots for which content should be returned. It also
 105   has a new rvprop, 'roles', to indicate which roles have slots. A deprecation
 106   warning will be issued if rvprop=content or rvprop=contentmodel are used
 107   without rvslots.
 108 * The rvcontentformat parameter to action=query&prop=revisions has been
 109   deprecated. Clients should be prepared to deal with the default format for
 110   relevant models.
 111 * Use of the deprecated parameters rvexpandtemplates, rvgeneratexml, rvparse,
 112   rvdiffto, rvdifftotext, rvdifftotextpst, rvcontentformat, or the deprecated
 113   rvprop=parsetree is forbidden with the new 'rvslots' parameter.
 114 * action=query&prop=deletedrevisions, action=query&list=allrevisions, and
 115   action=query&list=alldeletedrevisions are changed similarly to
 116   &prop=revisions (see the three previous items).
 117
 118 === Action API internal changes in 1.32 ===
 119 * Added 'ApiParseMakeOutputPage' hook.
 120 * Parameter names may no longer contain '{' or '}', as these are now used for
 121   templated parameters.
 122 * (T194950) Added 'ApiMaxLagInfo' hook.
 123 * Added 'ApiParseMakeOutputPage' hook.
 124 * The following methods now take a RevisionRecord rather than a Revision. No
 125   external callers are known.
 126   * ApiFeedContributions::feedItemAuthor()
 127   * ApiFeedContributions::feedItemDesc()
 128   * ApiQueryRevisionsBase::extractRevisionInfo()
 129
 130 === Languages updated in 1.32 ===
 131 MediaWiki supports over 350 languages. Many localisations are updated regularly.
 132 Below only new and removed languages are listed, as well as changes to languages
 133 because of Phabricator reports.
 134
 135 * (T193566) Added language support for Ambonese Malay (abs).
 136 * (T194047) Added language support for Shawiya, Latin script (shy-latn).
 137 * (T195940) Added language support for Batak Mandailing (btm).
 138 * (T137491) Added language support for Standard Moroccan Amazigh (zgh).
 139 * (T198132) Added language support for Manipuri (mni).
 140
 141 === Breaking changes in 1.32 ===
 142 * $wgRequestTime, deprecated in 1.25, was removed. Use
 143   $_SERVER['REQUEST_TIME_FLOAT'] or WebRequest::getElapsedTime() instead.
 144 * The MediaWikiI18N class, deprecated in 1.31, was removed.
 145 * QuickTemplate::setTranslator(), deprecated in 1.31, was removed. Use
 146   Skin::msg() instead.
 147 * wfInitShellLocale(), deprecated in 1.30, was removed.
 148 * wfShellExecDisabled(), deprecated in 1.30, was removed.
 149 * The type string for the parameter $lang of DateFormatter::getInstance,
 150   deprecated in 1.31, was removed.
 151 * The EDIT_TOKEN_SUFFIX constant deprecated in 1.27, was removed. Use
 152   MediaWiki\Session\Token::SUFFIX instead.
 153 * EditPage::isOouiEnabled() deprecated in 1.30, was removed.
 154 * mw.util.wikiGetlink(), deprecated in 1.23, was removed. Use mw.util.getUrl()
 155   instead.
 156 * (T61113) The following methods and constants from the Revision class, which
 157   were deprecated in 1.25, have now been removed:
 158   * Revision::getRawUser()
 159   * Revision::getRawUserText()
 160   * Revision::getRawComment()
 161 * window.gM() from mediawiki.jqueryMsg, deprecated in 1.23, was removed. Use
 162   mw.msg() or mw.message() instead.
 163 * mw.util.escapeId(), deprecated in 1.30, was removed. Use
 164   mw.util.escapeIdForAttribute or mw.util.escapeIdForLink instead.
 165 * mw.util.updateTooltipAccessKeys(), deprecated in 1.24, was removed. Use
 166   jquery.accessKeyLabel instead.
 167 * The SqlDataUpdate class, deprecated in 1.28, has been removed.
 168 * The Html5Internal and Html5Depurate tidy driver classes were removed, along
 169   with the Balancer tidy implementation. Both implementations were experimental,
 170   and were replaced by RemexHtml.
 171 * (T179624) Job::insert() and ::batchInsert(), deprecated in 1.21, were both
 172   removed. Use JobQueueGroup::singleton()->push() instead.
 173 * The jquery.footHovzer module, for mediawiki.debug, was removed.
 174 * The es5-shim module, empty and deprecated since 1.29, was removed.
 175 * the dom-level2-shim module, empty and deprecated since 1.29, was removed.
 176 * the json module, empty and deprecated since 1.29, was removed.
 177 * The mediawiki.widgets.visibleByteLimit module alias, deprecated in 1.32, was
 178   removed. Use mediawiki.widgets.visibleLengthLimit instead.
 179 * The jquery.farbtastic module, unused since 1.18, was removed.
 180 * (T181318) The $wgStyleVersion setting and its appendage to various script and
 181   style URLs in OutputPage, deprecated in 1.31, was removed.
 182 * The hooks 'PreferencesFormPreSave' and 'PreferencesGetLegend' may provide
 183   any HTMLForm object rather than PreferencesForm.
 184 * The non namespaced TimestampException class, deprecated in 1.29, was removed.
 185   Use Wikimedia\Timestamp\TimestampException instead.
 186 * The global functions codepointToUtf8, hexSequenceToUtf8, utf8ToHexSequence,
 187   utf8ToCodepoint, and escapeSingleString (deprecated in 1.25) were removed.
 188   The UtfNormal\Utils class from the utfnormal library should be used instead.
 189 * The deprecated UTF8_ and UNICODE_ constants were removed. The class constants
 190   from the UtfNormal\Constants class from the utfnormal library should be used
 191 * (T140807) The wgResourceLoaderLESSImportPaths configuration option was removed
 192   from ResourceLoader. Instead, use `@import` statements in LESS to import
 193   files directly from nearby directories within the same project.
 194 * The protected methods PHPSessionHandler::returnSuccess() and returnFailure(),
 195   only needed for PHP5 compatibility, have been removed. It now uses the boolean
 196   values `true` and `false` respectively.
 197 * The $parserMemc global and wfGetParserCacheStorage(), deprecated since 1.30,
 198   were removed. Use the ParserCache class instead.
 199 * ScopedCallback (deprecated in 1.28) was removed. Use Wikimedia\ScopedCallback
 200   instead.
 201 * Support for ResourceLoaderModule::getModifiedTime() and getModifiedHash(),
 202   deprecated since 1.26, was removed. Use getDefinitionSummary() instead.
 203 * (T195256) Skins are recommended not to rely on JavaScript for the "mw-jump"
 204   and "jump-to-nav" accessibility links. To this end, the "jquery.mw-jump"
 205   is no longer loaded by default. The Vector and MonoBook skins have made a
 206   minor change to implement the toggle feature with CSS instead. To restore
 207   prior functionality, either explicitly load "jquery.mw-jump" in your skin
 208   or refer to T195256 for details on how to make the same change.
 209 * Hook 'EditPageBeforeEditChecks' was removed;
 210   use 'EditPageGetCheckboxesDefinition' instead.
 211 * Linker::getLinkColour() and DummyLinker::getLinkColour(), deprecated since
 212   1.28, were removed. LinkRenderer::getLinkClasses() should be used instead.
 213 * Wikimedia\Rdbms\LoadBalancer::getLaggedSlaveMode(), deprecated in 1.28, has
 214   been removed. Use Wikimedia\Rdbms\LoadBalancer::getLaggedReplicaMode()
 215   instead.
 216 * mw.widgets.CategoryMultiselectWidget now uses TagMultiselectWidget instead of
 217   CapsuleMultiselectWidget. The following methods may no longer be used:
 218   * setItemsFromData: Use setValue instead
 219   * getItemsData: Use getItems instead and get the data property
 220
 221 === Deprecations in 1.32 ===
 222 * Use of a StartProfiler.php file is deprecated in favour of placing
 223   configuration in LocalSettings.php.
 224 * HTMLForm::setSubmitProgressive() is deprecated. No need to call it. Submit
 225   button is already marked as progressive.
 226 * Skin::setupSkinUserCss() is deprecated. Adding of modules to load
 227   has been centralised to Skin::getDefaultModules(), which is now capable
 228   of queueing style modules as well.
 229 * OutputPage::addModuleScripts() and ParserOutput::addModuleScripts are
 230   deprecated. Use addModules() instead.
 231 * Overriding SearchEngine::{searchText,searchTitle,searchArchiveTitle}
 232   in extending classes is deprecated.  Extend related doSearch* methods
 233   instead.
 234 * CollationFa has been removed completely as it's not needed anymore
 235 * The following 'mediawiki.api' plugin modules were merged into mediawiki.api
 236   and deprecated: mediawiki.api.category, mediawiki.api.edit,
 237   mediawiki.api.login, mediawiki.api.options, mediawiki.api.parse,
 238   mediawiki.api.upload, mediawiki.api.user, mediawiki.api.watch,
 239   mediawiki.api.messages, and mediawiki.api.rollback.
 240 * ApiBase::truncateArray() is deprecated. No replacement, as nothing is known
 241   to use it.
 242 * WatchAction::getUnwatchToken is deprecated. Use WatchAction::getWatchToken
 243   with the 'unwatch' action parameter instead.
 244 * IcuCollation::getICUVersion() is deprecated, as you can just use the PHP
 245   constant INTL_ICU_VERSION directly in all versions that MediaWiki supports.
 246 * Parser::fetchFile() is deprecated. Use ::fetchFileAndTitle() instead.
 247 * The ApiQueryContributions class has been renamed to ApiQueryUserContribs.
 248 * The XMPInfo, XMPReader, and XMPValidate classes have been deprecated in favor
 249   of the namespaced classes provided by the wikimedia/xmp-reader library.
 250 * SearchResultSet::{next,rewind} are deprecated. Calling code should
 251   use foreach on the SearchResultSet, or the extractResults method. Extending
 252   code should override extractResults.
 253 * Instantiating SearchResultSet directly is deprecated. SearchEngine
 254   implementations must subclass SearchResultSet for their purposes.
 255 * SearchResult::setExtensionData argument has been changed from accepting an
 256   array to accepting a Closure that returns the array when called.
 257 * Class CryptRand, everything in MWCryptRand except generateHex() and function
 258   MediaWikiServices::getCryptRand() are deprecated, use random_bytes() to
 259   generate cryptographically secure random byte sequences.
 260 * Parser::getConverterLanguage() is deprecated.  Use ::getTargetLanguage()
 261   instead.
 262 * Language::markNoConversion() is deprecated.  It confused readers because
 263   it had unexpected behavior (only marking text if it looked like a URL)
 264   and was only used in a single place in the code.  Use
 265   LanguageConverter::markNoConversion() instead.
 266 * (T197492) Language::truncate() was soft deprecated in 1.31 and is
 267   hard deprecated in this release.  It has been split into two similar
 268   methods, Language::truncateForVisual() and Language::truncateForDatabase(),
 269   which measure length in characters and bytes, respectively.  Use
 270   Language::truncateForVisual() when possible to provide equity to users
 271   of multibyte scripts.
 272 * (T176526) EditPage::getContextTitle() falling back to $wgTitle when the
 273   context title is unset is now deprecated; anything creating an EditPage
 274   instance should set the context title via ::setContextTitle().
 275 * The 'jquery.hidpi' module (polyfill for IMG srcset) is deprecated.
 276 * ResourceLoaderStartUpModule::getStartupModules() and ::getLegacyModules()
 277   are deprecated. These concepts are obsolete and have no replacement.
 278 * String type for $lang of DifferenceEngine::setTextLanguage is deprecated.
 279 * The following methods of OutputPage are now deprecated in favour
 280   of using showFatalError directly: OutputPage::showFileDeleteError()
 281   OutputPage::showFileNotFoundError(), OutputPage::showFileRenameError()
 282   OutputPage::showFileCopyError() and OutputPage::showUnexpectedValueError().
 283 * The Replacer, DoubleReplacer, HashtableReplacer, and RegexlikeReplacer
 284   classes are now deprecated. Use a Closure instead.
 285 * (T194263) ContentHandler::makeParserOptions() is deprecated. Use
 286   WikiPage::makeParserOptions() or ParserOptions::newCanonical() instead.
 287 * (T100681) Use of the Parsoid v1 API with the VirtualRESTService, deprecated in
 288   MediaWiki 1.26,  is now hard-deprecated. All known clients were converted to
 289   the Parsoid v3 API in May 2015.
 290 * $input is deprecated in hook 'LogEventsListGetExtraInputs'. Use
 291   $formDescriptor instead.
 292 * SearchEngine::transformSearchTerm( $term ) should no longer be called prior
 293   to running searchText. This method was mainly implemented to support the
 294   'prefix' URI param in SpecialSearch, but there are no reasons to expose this
 295   logic as it should be handled internally by SearchEngine implementations
 296   supporting this feature. SearchEngine implementations should no longer
 297   override this methods.
 298 * SearchEngine::replacePrefixes( $query ) should no longer be called prior
 299   to running searchText/searchTitle.
 300 * (T199657) Messages for $wgFilterLogTypes labels should be no longer be in the
 301   'log-show-hide-[type]' format. Instead use 'logeventslist-[type]-log'.
 302 * Global functions  wfArrayFilter() and wfArrayFilterByKey() are deprecated.
 303   use array_filter() directly.
 304 * The $wgShowSQLErrors global is deprecated and nonfunctional.
 305   Set $wgShowExceptionDetails and/or $wgShowHostnames instead.
 306 * The $wgShowDBErrorBacktrace global is deprecated and nonfunctional.
 307   Set $wgShowExceptionDetails instead.
 308 * Public access to the DifferenceEngine properties mOldid, mNewid, mOldPage,
 309   mNewPage, mOldContent, mNewContent, mRevisionsLoaded, mTextLoaded and
 310   mCacheHit is deprecated. Use getOldid() / getNewid() for the first two,
 311   do your own lookup for page/content. mNewRev / mOldRev remains public.
 312 * The $wgExternalDiffEngine value 'wikidiff2' is deprecated. To use wikidiff2
 313   just enable the PHP extension, and it will be autodetected.
 314
 315 === Other changes in 1.32 ===
 316 * (T198811) The following tables have had their UNIQUE indexes turned into
 317   proper PRIMARY KEYs for increased maintainability: interwiki, page_props,
 318   protected_titles and site_identifiers.
 319 * …
 320
 321 == Compatibility ==
 322 MediaWiki 1.32 requires PHP 7.0.0 or later. Although HHVM 3.18.5 or later is
 323 supported, it is generally advised to use PHP 7.0.0 or later for long term
 324 support.
 325
 326 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 327 but support for them is somewhat less mature. There is experimental support for
 328 Oracle and Microsoft SQL Server.
 329
 330 The supported versions are:
 331
 332 * MySQL 5.5.8 or later
 333 * PostgreSQL 9.2 or later
 334 * SQLite 3.3.7 or later
 335 * Oracle 9.0.1 or later
 336 * Microsoft SQL Server 2005 (9.00.1399)
 337
 338 == Upgrading ==
 339 1.32 has several database changes since 1.31, and will not work without schema
 340 updates. Note that due to changes to some very large tables like the revision
 341 table, the schema update may take quite long (minutes on a medium sized site,
 342 many hours on a large site).
 343
 344 Don't forget to always back up your database before upgrading!
 345
 346 See the file UPGRADE for more detailed upgrade instructions, including
 347 important information when upgrading from versions prior to 1.11.
 348
 349 For notes on 1.31.x and older releases, see HISTORY.
 350
 351 == Online documentation ==
 352 Documentation for both end-users and site administrators is available on
 353 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 354 for pages that explicitly state that their contents are in the public domain):
 355
 356        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 357
 358 == Mailing list ==
 359 A mailing list is available for MediaWiki user support and discussion:
 360
 361        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 362
 363 A low-traffic announcements-only list is also available:
 364
 365        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 366
 367 It's highly recommended that you sign up for one of these lists if you're
 368 going to run a public MediaWiki, so you can be notified of security fixes.
 369
 370 == IRC help ==
 371 There's usually someone online in #mediawiki on irc.freenode.net.