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