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