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 json module, empty and deprecated since 1.29, was removed.
 137 * The mediawiki.widgets.visibleByteLimit module alias, deprecated in 1.32, was
 138   removed. Use mediawiki.widgets.visibleLengthLimit instead.
 139 * The jquery.farbtastic module, unused since 1.18, was removed.
 140 * (T181318) The $wgStyleVersion setting and its appendage to various script and
 141   style URLs in OutputPage, deprecated in 1.31, was removed.
 142 * The hooks 'PreferencesFormPreSave' and 'PreferencesGetLegend' may provide
 143   any HTMLForm object rather than PreferencesForm.
 144 * The non namespaced TimestampException class, deprecated in 1.29, was removed.
 145   Use Wikimedia\Timestamp\TimestampException instead.
 146 * The global functions codepointToUtf8, hexSequenceToUtf8, utf8ToHexSequence,
 147   utf8ToCodepoint, and escapeSingleString (deprecated in 1.25) were removed.
 148   The UtfNormal\Utils class from the utfnormal library should be used instead.
 149 * The deprecated UTF8_ and UNICODE_ constants were removed. The class constants
 150   from the UtfNormal\Constants class from the utfnormal library should be used
 151 * (T140807) The wgResourceLoaderLESSImportPaths configuration option was removed
 152   from ResourceLoader. Instead, use `@import` statements in LESS to import
 153   files directly from nearby directories within the same project.
 154 * The protected methods PHPSessionHandler::returnSuccess() and returnFailure(),
 155   only needed for PHP5 compatibility, have been removed. It now uses the boolean
 156   values `true` and `false` respectively.
 157 * The $parserMemc global and wfGetParserCacheStorage(), deprecated since 1.30,
 158   were removed. Use the ParserCache class instead.
 159 * ScopedCallback (deprecated in 1.28) was removed. Use Wikimedia\ScopedCallback
 160   instead.
 161 * Support for ResourceLoaderModule::getModifiedTime() and getModifiedHash(),
 162   deprecated since 1.26, was removed. Use getDefinitionSummary() instead.
 163 * (T195256) Skins are recommended not to rely on JavaScript for the "mw-jump"
 164   and "jump-to-nav" accessibility links. To this end, the "jquery.mw-jump"
 165   is no longer loaded by default. The Vector and MonoBook skins have made a
 166   minor change to implement the toggle feature with CSS instead. To restore
 167   prior functionality, either explicitly load "jquery.mw-jump" in your skin
 168   or refer to T195256 for details on how to make the same change.
 169 * Hook 'EditPageBeforeEditChecks' was removed;
 170   use 'EditPageGetCheckboxesDefinition' instead.
 171 * Linker::getLinkColour() and DummyLinker::getLinkColour(), deprecated since
 172   1.28, were removed. LinkRenderer::getLinkClasses() should be used instead.
 173 * mw.widgets.CategoryMultiselectWidget now uses TagMultiselectWidget instead of
 174   CapsuleMultiselectWidget. The following methods may no longer be used:
 175   * setItemsFromData: Use setValue instead
 176   * getItemsData: Use getItems instead and get the data property
 177
 178 === Deprecations in 1.32 ===
 179 * Use of a StartProfiler.php file is deprecated in favour of placing
 180   configuration in LocalSettings.php.
 181 * HTMLForm::setSubmitProgressive() is deprecated. No need to call it. Submit
 182   button is already marked as progressive.
 183 * Skin::setupSkinUserCss() is deprecated. Adding of modules to load
 184   has been centralised to Skin::getDefaultModules(), which is now capable
 185   of queueing style modules as well.
 186 * OutputPage::addModuleScripts() and ParserOutput::addModuleScripts are
 187   deprecated. Use addModules() instead.
 188 * Overriding SearchEngine::{searchText,searchTitle,searchArchiveTitle}
 189   in extending classes is deprecated.  Extend related doSearch* methods
 190   instead.
 191 * CollationFa has been removed completely as it's not needed anymore
 192 * The following 'mediawiki.api' plugin modules were merged into mediawiki.api
 193   and deprecated: mediawiki.api.category, mediawiki.api.edit,
 194   mediawiki.api.login, mediawiki.api.options, mediawiki.api.parse,
 195   mediawiki.api.upload, mediawiki.api.user, mediawiki.api.watch,
 196   mediawiki.api.messages, and mediawiki.api.rollback.
 197 * ApiBase::truncateArray() is deprecated. No replacement, as nothing is known
 198   to use it.
 199 * WatchAction::getUnwatchToken is deprecated. Use WatchAction::getWatchToken
 200   with the 'unwatch' action parameter instead.
 201 * IcuCollation::getICUVersion() is deprecated, as you can just use the PHP
 202   constant INTL_ICU_VERSION directly in all versions that MediaWiki supports.
 203 * Parser::fetchFile() is deprecated. Use ::fetchFileAndTitle() instead.
 204 * The ApiQueryContributions class has been renamed to ApiQueryUserContribs.
 205 * The XMPInfo, XMPReader, and XMPValidate classes have been deprecated in favor
 206   of the namespaced classes provided by the wikimedia/xmp-reader library.
 207 * SearchResultSet::{next,rewind} are deprecated. Calling code should
 208   use foreach on the SearchResultSet, or the extractResults method. Extending
 209   code should override extractResults.
 210 * Instantiating SearchResultSet directly is deprecated. SearchEngine
 211   implementations must subclass SearchResultSet for their purposes.
 212 * SearchResult::setExtensionData argument has been changed from accepting an
 213   array to accepting a Closure that returns the array when called.
 214 * Class CryptRand, everything in MWCryptRand except generateHex() and function
 215   MediaWikiServices::getCryptRand() are deprecated, use random_bytes() to
 216   generate cryptographically secure random byte sequences.
 217 * Parser::getConverterLanguage() is deprecated.  Use ::getTargetLanguage()
 218   instead.
 219 * Language::markNoConversion() is deprecated.  It confused readers because
 220   it had unexpected behavior (only marking text if it looked like a URL)
 221   and was only used in a single place in the code.  Use
 222   LanguageConverter::markNoConversion() instead.
 223 * (T176526) EditPage::getContextTitle() falling back to $wgTitle when the
 224   context title is unset is now deprecated; anything creating an EditPage
 225   instance should set the context title via ::setContextTitle().
 226 * The 'jquery.hidpi' module (polyfill for IMG srcset) is deprecated.
 227 * ResourceLoaderStartUpModule::getStartupModules() and ::getLegacyModules()
 228   are deprecated. These concepts are obsolete and have no replacement.
 229
 230 === Other changes in 1.32 ===
 231 * …
 232
 233 == Compatibility ==
 234 MediaWiki 1.32 requires PHP 7.0.0 or later. Although HHVM 3.18.5 or later is
 235 supported, it is generally advised to use PHP 7.0.0 or later for long term
 236 support.
 237
 238 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 239 but support for them is somewhat less mature. There is experimental support for
 240 Oracle and Microsoft SQL Server.
 241
 242 The supported versions are:
 243
 244 * MySQL 5.5.8 or later
 245 * PostgreSQL 9.2 or later
 246 * SQLite 3.3.7 or later
 247 * Oracle 9.0.1 or later
 248 * Microsoft SQL Server 2005 (9.00.1399)
 249
 250 == Upgrading ==
 251 1.32 has several database changes since 1.31, and will not work without schema
 252 updates. Note that due to changes to some very large tables like the revision
 253 table, the schema update may take quite long (minutes on a medium sized site,
 254 many hours on a large site).
 255
 256 Don't forget to always back up your database before upgrading!
 257
 258 See the file UPGRADE for more detailed upgrade instructions, including
 259 important information when upgrading from versions prior to 1.11.
 260
 261 For notes on 1.31.x and older releases, see HISTORY.
 262
 263 == Online documentation ==
 264 Documentation for both end-users and site administrators is available on
 265 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 266 for pages that explicitly state that their contents are in the public domain):
 267
 268        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 269
 270 == Mailing list ==
 271 A mailing list is available for MediaWiki user support and discussion:
 272
 273        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 274
 275 A low-traffic announcements-only list is also available:
 276
 277        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 278
 279 It's highly recommended that you sign up for one of these lists if you're
 280 going to run a public MediaWiki, so you can be notified of security fixes.
 281
 282 == IRC help ==
 283 There's usually someone online in #mediawiki on irc.freenode.net.