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
  29 === New features in 1.32 ===
  30 * (T112474) Generalized the ResourceLoader mechanism for overriding modules
  31   using a particular page during edit previews.
  32 * (T12331) You can now log page creation events by setting $wgPageCreationLog
  33   to true.
  34 * Added 'ApiParseMakeOutputPage' hook.
  35 * (T174313) Added checkbox on Special:ListUsers to display only users in
  36   temporary user groups.
  37 * (T152462) A cookie can now be set when an IP user is blocked to track that user if
  38   they move to a new IP address. This is disabled by default.
  39 * (T194950) Added 'ApiMaxLagInfo' hook.
  40
  41 === External library changes in 1.32 ===
  42 * …
  43
  44 ==== Upgraded external libraries ====
  45 * Updated QUnit from 2.4.0 to 2.6.0.
  46 * Updated wikimedia/scoped-callback from 1.0.0 to 2.0.0.
  47 ** ScopedCallback objects can no longer be serialized.
  48
  49 ==== New external libraries ====
  50 * Added wikimedia/xmp-reader 0.5.1
  51 * …
  52
  53 ==== Removed and replaced external libraries ====
  54 * …
  55
  56 === Bug fixes in 1.32 ===
  57 * …
  58
  59 === Action API changes in 1.32 ===
  60 * Added templated parameters.
  61   * A module can define a templated parameter like "{fruit}-quantity", where
  62     the actual parameters recognized correspond to the values of a multi-valued
  63     parameter. Then clients can make requests like
  64     "fruits=apples|bananas&apples-quantity=1&bananas-quantity=5".
  65   * action=paraminfo will return templated parameter definitions separately
  66     from normal parameters. All parameter definitions now include an "index"
  67     key to allow clients to maintain parameter ordering when merging normal and
  68     templated parameters.
  69 * It is now an error to submit too many values for a multi-valued parameter.
  70   This has generated a warning since MediaWiki 1.14.
  71
  72 === Action API internal changes in 1.32 ===
  73 * Added 'ApiParseMakeOutputPage' hook.
  74 * Parameter names may no longer contain '{' or '}', as these are now used for
  75   templated parameters.
  76 * (T194950) Added 'ApiMaxLagInfo' hook.
  77
  78 === Languages updated in 1.32 ===
  79 MediaWiki supports over 350 languages. Many localisations are updated regularly.
  80 Below only new and removed languages are listed, as well as changes to languages
  81 because of Phabricator reports.
  82
  83 * (T193566) Added language support for Ambonese Malay (abs).
  84 * (T194047) Added language support for Shawiya, Latin script (shy-latn).
  85 * (T195940) Added language support for Batak Mandailing (btm).
  86
  87 === Breaking changes in 1.32 ===
  88 * $wgRequestTime, deprecated in 1.25, was removed. Use
  89   $_SERVER['REQUEST_TIME_FLOAT'] or WebRequest::getElapsedTime() instead.
  90 * The MediaWikiI18N class, deprecated in 1.31, was removed.
  91 * QuickTemplate::setTranslator(), deprecated in 1.31, was removed. Use
  92   Skin::msg() instead.
  93 * wfInitShellLocale(), deprecated in 1.30, was removed.
  94 * wfShellExecDisabled(), deprecated in 1.30, was removed.
  95 * The type string for the parameter $lang of DateFormatter::getInstance,
  96   deprecated in 1.31, was removed.
  97 * The EDIT_TOKEN_SUFFIX constant deprecated in 1.27, was removed. Use
  98   MediaWiki\Session\Token::SUFFIX instead.
  99 * EditPage::isOouiEnabled() deprecated in 1.30, was removed.
 100 * mw.util.wikiGetlink(), deprecated in 1.23, was removed. Use mw.util.getUrl()
 101   instead.
 102 * (T61113) The following methods and constants from the Revision class, which
 103   were deprecated in 1.25, have now been removed:
 104   * Revision::getRawUser()
 105   * Revision::getRawUserText()
 106   * Revision::getRawComment()
 107 * window.gM() from mediawiki.jqueryMsg, deprecated in 1.23, was removed. Use
 108   mw.msg() or mw.message() instead.
 109 * mw.util.escapeId(), deprecated in 1.30, was removed. Use
 110   mw.util.escapeIdForAttribute or mw.util.escapeIdForLink instead.
 111 * mw.util.updateTooltipAccessKeys(), deprecated in 1.24, was removed. Use
 112   jquery.accessKeyLabel instead.
 113 * The SqlDataUpdate class, deprecated in 1.28, has been removed.
 114 * The Html5Internal and Html5Depurate tidy driver classes were removed, along
 115   with the Balancer tidy implementation. Both implementations were experimental,
 116   and were replaced by RemexHtml.
 117 * (T179624) Job::insert() and ::batchInsert(), deprecated in 1.21, were both
 118   removed. Use JobQueueGroup::singleton()->push() instead.
 119 * The jquery.footHovzer module, for mediawiki.debug, was removed.
 120 * The es5-shim module, empty and deprecated since 1.29, was removed.
 121 * The mediawiki.widgets.visibleByteLimit module alias, deprecated in 1.32, was
 122   removed. Use mediawiki.widgets.visibleLengthLimit instead.
 123 * The jquery.farbtastic module, unused since 1.18, was removed.
 124 * (T181318) The $wgStyleVersion setting and its appendage to various script and
 125   style URLs in OutputPage, deprecated in 1.31, was removed.
 126 * The hooks 'PreferencesFormPreSave' and 'PreferencesGetLegend' may provide
 127   any HTMLForm object rather than PreferencesForm.
 128 * The non namespaced TimestampException class, deprecated in 1.29, was removed.
 129   Use Wikimedia\Timestamp\TimestampException instead.
 130 * The global functions codepointToUtf8, hexSequenceToUtf8, utf8ToHexSequence,
 131   utf8ToCodepoint, and escapeSingleString (deprecated in 1.25) were removed.
 132   The UtfNormal\Utils class from the utfnormal library should be used instead.
 133 * The deprecated UTF8_ and UNICODE_ constants were removed. The class constants
 134   from the UtfNormal\Constants class from the utfnormal library should be used
 135 * (T140807) The wgResourceLoaderLESSImportPaths configuration option was removed
 136   from ResourceLoader. Instead, use `@import` statements in LESS to import
 137   files directly from nearby directories within the same project.
 138 * The protected methods PHPSessionHandler::returnSuccess() and returnFailure(),
 139   only needed for PHP5 compatibility, have been removed. It now uses the boolean
 140   values `true` and `false` respectively.
 141 * The $parserMemc global and wfGetParserCacheStorage(), deprecated since 1.30,
 142   were removed. Use the ParserCache class instead.
 143 * ScopedCallback (deprecated in 1.28) was removed. Use Wikimedia\ScopedCallback
 144   instead.
 145 * Support for ResourceLoaderModule::getModifiedTime() and getModifiedHash(),
 146   deprecated since 1.26, was removed. Use getDefinitionSummary() instead.
 147
 148 === Deprecations in 1.32 ===
 149 * Use of a StartProfiler.php file is deprecated in favour of placing
 150   configuration in LocalSettings.php.
 151 * HTMLForm::setSubmitProgressive() is deprecated. No need to call it. Submit
 152   button is already marked as progressive.
 153 * Skin::setupSkinUserCss() is deprecated. Adding of modules to load
 154   has been centralised to Skin::getDefaultModules(), which is now capable
 155   of queueing style modules as well.
 156 * OutputPage::addModuleScripts() and ParserOutput::addModuleScripts are
 157   deprecated. Use addModules() instead.
 158 * Overriding SearchEngine::{searchText,searchTitle,searchArchiveTitle}
 159   in extending classes is deprecated.  Extend related doSearch* methods
 160   instead.
 161 * CollationFa has been removed completely as it's not needed anymore
 162 * The following 'mediawiki.api' plugin modules were merged into mediawiki.api
 163   and deprecated: mediawiki.api.category, mediawiki.api.edit,
 164   mediawiki.api.login, mediawiki.api.options, mediawiki.api.parse,
 165   mediawiki.api.upload, mediawiki.api.user, mediawiki.api.watch,
 166   mediawiki.api.messages, and mediawiki.api.rollback.
 167 * ApiBase::truncateArray() is deprecated. No replacement, as nothing is known
 168   to use it.
 169 * WatchAction::getUnwatchToken is deprecated. Use WatchAction::getWatchToken
 170   with the 'unwatch' action parameter instead.
 171 * IcuCollation::getICUVersion() is deprecated, as you can just use the PHP
 172   constant INTL_ICU_VERSION directly in all versions that MediaWiki supports.
 173 * Parser::fetchFile() is deprecated. Use ::fetchFileAndTitle() instead.
 174 * The ApiQueryContributions class has been renamed to ApiQueryUserContribs.
 175 * The XMPInfo, XMPReader, and XMPValidate classes have been deprecated in favor
 176   of the namespaced classes provided by the wikimedia/xmp-reader library.
 177
 178 === Other changes in 1.32 ===
 179 * …
 180
 181 == Compatibility ==
 182 MediaWiki 1.32 requires PHP 7.0.0 or later. Although HHVM 3.18.5 or later is
 183 supported, it is generally advised to use PHP 7.0.0 or later for long term
 184 support.
 185
 186 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 187 but support for them is somewhat less mature. There is experimental support for
 188 Oracle and Microsoft SQL Server.
 189
 190 The supported versions are:
 191
 192 * MySQL 5.5.8 or later
 193 * PostgreSQL 9.2 or later
 194 * SQLite 3.3.7 or later
 195 * Oracle 9.0.1 or later
 196 * Microsoft SQL Server 2005 (9.00.1399)
 197
 198 == Upgrading ==
 199 1.32 has several database changes since 1.31, and will not work without schema
 200 updates. Note that due to changes to some very large tables like the revision
 201 table, the schema update may take quite long (minutes on a medium sized site,
 202 many hours on a large site).
 203
 204 Don't forget to always back up your database before upgrading!
 205
 206 See the file UPGRADE for more detailed upgrade instructions, including
 207 important information when upgrading from versions prior to 1.11.
 208
 209 For notes on 1.31.x and older releases, see HISTORY.
 210
 211 == Online documentation ==
 212 Documentation for both end-users and site administrators is available on
 213 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 214 for pages that explicitly state that their contents are in the public domain):
 215
 216        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 217
 218 == Mailing list ==
 219 A mailing list is available for MediaWiki user support and discussion:
 220
 221        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 222
 223 A low-traffic announcements-only list is also available:
 224
 225        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 226
 227 It's highly recommended that you sign up for one of these lists if you're
 228 going to run a public MediaWiki, so you can be notified of security fixes.
 229
 230 == IRC help ==
 231 There's usually someone online in #mediawiki on irc.freenode.net.