RELEASE-NOTES-1.31

   1 == MediaWiki 1.31 ==
   2
   3 THIS IS NOT A RELEASE YET
   4
   5 MediaWiki 1.31 is an alpha-quality branch and is not recommended for use in
   6 production.
   7
   8 === Configuration changes in 1.31 ===
   9 * $wgEnableAPI and $wgEnableWriteAPI are now deprecated and will be removed in
  10   a future version. The API is now considered to be stable, secure and
  11   essential.
  12 * $wgUsejQueryThree was removed, as it is now the default. This was documented as a
  13   temporary variable during the migration period, deprecated since 1.29.
  14 * $wgLogoHD has been updated to support svg images and uses $wgLogo where
  15   possible for fallback images such as png.
  16 * (T44246) $wgFilterLogTypes will no longer ignore 'patrol' when user does
  17   not have the right to mark things patrolled.
  18 * Wikis that contain imported revisions or CentralAuth global blocks should run
  19   maintenance/cleanupUsersWithNoId.php.
  20 * $wgResourceLoaderMinifierStatementsOnOwnLine and $wgResourceLoaderMinifierMaxLineLength
  21   were removed (deprecated since 1.27).
  22 * (T180921) $wgReferrerPolicy now supports having fallbacks for browsers that are not
  23   using the latest version of the Referrer Policy specification.
  24 * $wgFragmentMode is now set to [ 'legacy', 'html5' ] by default. This is a first step of
  25   migration to human-readable section IDs that will later result in 'html5' being the
  26   default mode.
  27 * CACHE_ACCEL now only supports APC(u) or WinCache. XCache support was removed
  28   as upstream is inactive and has no plans to move to PHP 7.
  29 * The old CategorizedRecentChanges feature, including its related configuration
  30   option $wgAllowCategorizedRecentChanges, has been removed.
  31 * (T188472) The 'comma' value for $wgArticleCountMethod is no longer supported for
  32   performance reasons, and installations with this setting will now work as if it
  33   was configured with 'any'.
  34 * (T185753) MediaWiki now defaults to using RemexHtml to tidy up user input, rather than
  35   being off by default. If you wish to disable HTML tidying entirely, set $wgTidyConfig
  36   to null; if you wish to use the old, deprecated Tidy external binary, both
  37   set $wgTidyConfig to null and also set $wgUseTidy to true.
  38 * $wgLogAutopatrol now defaults to false instead of true.
  39 * $wgValidateAllHtml was removed and will be ignored.
  40
  41 === New features in 1.31 ===
  42 * (T76554) User sub-pages named ….json are now protected in the same way that ….js
  43   and ….css pages are, so that configuration options can safely be placed there.
  44 * Wikimedia\Rdbms\IDatabase->select() and similar methods now support
  45   joins with parentheses for grouping.
  46 * As a first pass in standardizing dialog boxes across the MediaWiki product,
  47   Html class now provides helper methods for messageBox, successBox, errorBox and
  48   warningBox generation.
  49 * (T9240) Imports will now record unknown (and, optionally, known) usernames in
  50   a format like "iw>Example".
  51 * (T20209) Linker (used on history pages, log pages, and so on) will display
  52   usernames formed like "iw>Example" as interwiki links, as if by wikitext like
  53   [[iw:User:Example|iw>Example]].
  54 * (T111605) The 'ImportHandleUnknownUser' hook allows extensions to auto-create
  55   users during an import.
  56 * Added a hook, ParserOutputPostCacheTransform, to allow extensions to affect
  57   the ParserOutput::getText() post-cache transformations.
  58 * Added a hook, UploadForm:getInitialPageText, to allow extensions to alter the
  59   initial page text for file uploads.
  60 * (T181651) The info page for File pages now displays the file's base-16 SHA1
  61   hash value in the table of basic information.
  62 * Style tags with a 'data-mw-deduplicate' attribute will be deduplicated as a
  63   ParserOutput::getText() post-cache transformation. This may be disabled by
  64   passing 'deduplicateStyles' => false to that method.
  65 * The identity of the logged-in or IP "actor" for logged actions is being moved
  66   into a new actor table, with the rows in tables such as revision and logging
  67   referring to the actor ID instead of storing the user ID and name/IP in
  68   every row.
  69   * This is currently gated by $wgActorTableSchemaMigrationStage. Most wikis
  70     can set this to MIGRATION_NEW and run maintenance/migrateActors.php as
  71     soon as any necessary extensions are updated.
  72   * Most code accessing rows for logged actions from the database should use
  73     the relevant getQueryInfo() methods to get the information needed to build
  74     the SQL query. The ActorMigration class may also be used to get feature-flagged
  75     information needed to access actor-related fields during the migration
  76     period.
  77 * Added Wikimedia\Rdbms\IDatabase::cancelAtomic(), to roll back an atomic
  78   section without having to roll back the whole transaction.
  79 * Wikimedia\Rdbms\IDatabase::doAtomicSection(), non-native ::insertSelect(),
  80   and non-MySQL ::replace() and ::upsert() no longer roll back the whole
  81   transaction on failure.
  82 * (T189785) Added a monthly heartbeat ping to the pingback feature.
  83 * The CLI installer (maintenance/install.php) learned to detect and include
  84   extensions. Pass --with-extensions to enable that feature.
  85 * (T184791) rc_patrolled now has three states: "0" for unpatrolled,
  86   "1" for manually patrolled and "2" for autopatrolled actions.
  87 * Extensions can now set their type to "editor" if they provide an editor
  88   or enhance the editing experience.
  89
  90 === External library changes in 1.31 ===
  91
  92 ==== Upgraded external libraries ====
  93 * Updated jquery.chosen from v0.9.14 to v1.8.2.
  94 * Updated composer/spdx-licenses from 1.1.4 to
  95   1.3.0 (development dependency).
  96 * Updated nikic/php-parser from 2.1.0 to 3.1.3
  97   (development dependency).
  98 * Updated wikimedia/ip-set from 1.1.0 to 1.2.0.
  99 * Updated wikimedia/relpath from 2.0.0 to 2.1.1.
 100 * Updated wikimedia/running-stat from 1.1.0 to 1.2.0.
 101 * Updated wikimedia/wrappedstring from 2.2.0 to 2.3.0.
 102 * Updated mediawiki/at-ease from 1.1.0 to 1.2.0.
 103 * Updated wikimedia/php-session-serializer from 1.0.4 to 1.0.5.
 104 * Updated wikimedia/remex-html from 1.0.2 to 1.0.3.
 105 * …
 106
 107 ==== New external libraries ====
 108 * Added wikimedia/object-factory 1.0.0
 109 * …
 110
 111 ==== Removed and replaced external libraries ====
 112 * (T17845) The deprecated 'jquery.badge' module was removed.
 113 * The deprecated 'jquery.autoEllipsis' module was removed. Use the CSS
 114   text-overflow property instead.
 115 * The deprecated 'jquery.placeholder' module was removed.
 116 * The deprecated 'jquery.appear' module was removed. Use the
 117   'mediawiki.viewport' module instead.
 118 * The deprecated 'mediawiki.widgets.CategorySelector' module alias was removed.
 119   Use the 'mediawiki.widgets.CategoryMultiselectWidget' module directly instead.
 120
 121 === Bug fixes in 1.31 ===
 122 * (T90902) Non-breaking space in header ID breaks anchor
 123
 124 === Action API changes in 1.31 ===
 125 * (T185058) The 'name' value to tgprop for action=query&list=tags has been
 126   removed. It has never made a difference in the output, the name was always
 127   returned regardless.
 128
 129 === Action API internal changes in 1.31 ===
 130 * ApiBase::getProfileDBTime was removed (deprecated since 1.25)
 131 * ApiBase::getModuleProfileName was removed (deprecated since 1.25)
 132 * ApiBase::getProfileTime was removed (deprecated since 1.25)
 133
 134 === Languages updated in 1.31 ===
 135 MediaWiki supports over 350 languages. Many localisations are updated
 136 regularly. Below only new and removed languages are listed, as well as
 137 changes to languages because of Phabricator reports.
 138
 139 * (T180052) Mirandese (mwl) now supports gendered NS_USER/NS_USER_TALK namespaces.
 140 * (T182305) New language support: Nyungar (nys).
 141 * (T186359) New language support: Siberian Tatar [cебертатар] (sty).
 142 * (T186635) New language support: Guianan Creole (gcr).
 143 * (T186647) New language support: Kumyk [къумукъ] (kum).
 144 * (T187750) New language support: Spanish formal address (es-formal).
 145 * (T187824) New language support: Hungarian formal address (hu-formal).
 146
 147 === Breaking changes in 1.31 ===
 148 * MessageBlobStore::insertMessageBlob() (deprecated in 1.27) was removed.
 149 * The OutputPage class constructor now requires a context parameter,
 150   (instantiating without context was deprecated in 1.18)
 151 * The mw.page JavaScript singleton (deprecated in 1.30) was removed.
 152 * Article::getLastPurgeTimestamp(), WikiPage::getLastPurgeTimestamp(), and the
 153   related WikiPage::PURGE_* constants, deprecated in 1.29, were removed.
 154 * The Article::selectFields(), Article::onArticleCreate(),
 155   Article::onArticleDelete(), and Article::onArticleEdit() methods, deprecated
 156   in 1.24, were removed.
 157 * Installer::locateExecutable() and Installer::locateExecutableInDefaultPaths()
 158   were removed, use ExecutableFinder::findInDefaultPaths() instead.
 159 * The deprecated MW_DIFF_VERSION constant was removed.
 160   DifferenceEngine::MW_DIFF_VERSION should be used instead.
 161 * Due to significant refactoring, method ContribsPager::getUserCond() that had
 162   no access restriction has been removed.
 163 * The Block class will no longer accept usable-but-missing usernames for
 164   'byText' or ->setBlocker(). Callers should either ensure the blocker exists
 165   locally or use a new interwiki-format username like "iw>Example".
 166 * The following methods and constants from the WatchedItem class, which were deprecated in
 167   1.27, have been removed.
 168   * WatchedItem::getTitle()
 169   * WatchedItem::fromUserTitle()
 170   * WatchedItem::addWatch()
 171   * WatchedItem::removeWatch()
 172   * WatchedItem::isWatched()
 173   * WatchedItem::duplicateEntries()
 174   * WatchedItem::IGNORE_USER_RIGHTS
 175   * WatchedItem::CHECK_USER_RIGHTS
 176   * WatchedItem::DEPRECATED_USAGE_TIMESTAMP
 177 * The $statementsOnOwnLine parameter of JavaScriptMinifier::minify was removed.
 178   The corresponding configuration variable ($wgResourceLoaderMinifierStatementsOnOwnLine)
 179   has been deprecated since 1.27 and was removed as well.
 180 * The $maxLineLength parameter of JavaScriptMinifier::minify was removed.
 181   The corresponding configuration variable ($wgResourceLoaderMinifierMaxLineLength)
 182   has been deprecated since 1.27 and was removed as well.
 183 * The HtmlFormatter class was removed (deprecated in 1.27). The namespaced
 184   HtmlFormatter\HtmlFormatter class should be used instead.
 185 * The driver 'mysql' for MySQL, deprecated in MediaWiki 1.30, has been removed.
 186   The driver has been deprecated since PHP 5.5 and was removed in PHP 7.0. The
 187   default driver for MySQL has been 'mysqli' since MediaWiki 1.22.
 188 * The following properties of PreparedEdit were deprecated in 1.21 and have been removed:
 189   * PreparedEdit->newText
 190   * PreparedEdit->oldText
 191   * PreparedEdit->pst
 192 * ParserOutput objects generated using a non-default value for
 193   ParserOptions::setWrapOutputClass() can no longer be added to the parser cache.
 194 * The following deprecated methods from the OutputPage class have been removed:
 195   * OutputPage::addExtensionStyle(); deprecated in 1.27
 196   * OutputPage::getExtStyle(); deprecated in 1.27
 197   * OutputPage::setETag(); deprecated in 1.28 (obsolete no-op)
 198   * OutputPage::setSquidMaxage(); deprecated in 1.27
 199   * OutputPage::readOnlyPage(); deprecated in 1.25
 200   * OutputPage::rateLimited(); deprecated in 1.25
 201   * Additionally, the protected OutputPage::$mExtStyles array, only accessed through
 202     the above and with no known uses, was removed.
 203 * The no-op method Skin::showIPinHeader(), deprecated in 1.27, was removed.
 204 * The following variables and methods in EditPage, deprecated in MediaWiki 1.30, were removed:
 205   * $isCssJsSubpage — use ::isUserConfigPage()
 206   * $isCssSubpage — use ::isUserCssConfigPage()
 207   * $isJsSubpage — use ::isUserJsConfigPage()
 208   * $isWrongCaseCssJsPage – use ::isWrongCaseUserConfigPage()
 209   * ::getSummaryInput() – use ::getSummaryInputWidget()
 210   * ::getSummaryInputOOUI() – use ::getSummaryInputWidget()
 211   * ::getCheckboxes() – use ::getCheckboxesWidget() or ::getCheckboxesDefinition()
 212   * ::getCheckboxesOOUI() – use ::getCheckboxesWidget() or ::getCheckboxesDefinition()
 213 * The method ResourceLoaderModule::getPosition(), deprecated in 1.29, has been removed.
 214 * In User, the cookie-related methods which were wrappers for the functions on the response
 215   object, and were deprecated in 1.27, have been removed:
 216   * ::setCookie()
 217   * ::clearCookie()
 218   * ::setExtendedLoginCookie()
 219   Note that User::setCookies() remains, and is not deprecated.
 220 * Also in User, some auth-related methods which were deprecated in 1.27, have been removed:
 221   * ::getEditTokenTimestamp() – use MediaWiki\Session\Token::getTimestamp()
 222   * ::getPasswordFactory() – create a PasswordFactory directly
 223   * ::passwordChangeInputAttribs()
 224 * The global functions wfProfileIn and wfProfileOut, deprecated in 1.25, have been removed.
 225 * SpecialPageFactory::getList(), deprecated in 1.24, has been removed. You can
 226   use ::getNames() instead.
 227 * OpenSearch::getOpenSearchTemplate(), deprecated in 1.25, has been removed. You
 228   can use ApiOpenSearch::getOpenSearchTemplate() instead.
 229 * The global function wfBaseConvert, deprecated in 1.27, has been removed. Use
 230   Wikimedia\base_convert() directly.
 231 * Calling Database::begin() explicitly during an implicit transaction or when DBO_TRX
 232   is set results in an exception. Calling Database::commit() explicitly for an implicit
 233   transaction also results in an exception. Previously these were logged as errors.
 234   The startAtomic() and endAtomic() methods, or AtomicSectionUpdate should be used
 235   instead.
 236 * The global function wfOutputHandler() was removed, use the its replacement
 237   MediaWiki\OutputHandler::handle() instead. The global function was only sometimes defined.
 238   Its replacement is always available via the autoloader.
 239 * ChangeTags::listExtensionActivatedTags and ::listExtensionDefinedTags, deprecated
 240   in 1.28, have been removed.  Use ::listSoftwareActivatedTags() and
 241   ::listSoftwareDefinedTags() instead.
 242 * Title::getTitleInvalidRegex(), deprecated in 1.25, has been removed. You
 243   can use MediaWikiTitleCodec::getTitleInvalidRegex() instead.
 244 * HTMLForm & VFormHTMLForm::isVForm(), deprecated in 1.25, have been removed.
 245 * The ProfileSection class, deprecated in 1.25 and unused, has been removed.
 246 * The ResourceLoaderGetLessVars hook, deprecated in 1.30, has been removed.
 247   Use ResourceLoaderModule::getLessVars() to expose local variables instead
 248   of global ones.
 249 * As part of work to modernise user-generated content clean-up, a config option and some
 250   methods related to HTML validity were removed without deprecation. The public methods
 251   MWTidy::checkErrors() and its callee TidyDriverBase::validate() are removed, as are
 252   MediaWikiTestCase::assertValidHtmlSnippet() and ::assertValidHtmlDocument(). The
 253   $wgValidateAllHtml configuration option is removed and will be ignored.
 254
 255 === Deprecations in 1.31 ===
 256 * The Revision class was deprecated in favor of RevisionStore, BlobStore, and
 257   RevisionRecord and its subclasses.
 258 * The global function wfBCP47 is deprecated in favour of LanguageCode::bcp47.
 259 * The global function wfCountDown is now deprecated in favor of Maintenance::countDown.
 260 * Several methods for returning lists of fields to select from the database
 261   have been deprecated in favor of similar methods that also return the tables
 262   to select from and the join conditions for those tables.
 263   * Block::selectFields() → Block::getQueryInfo()
 264   * RecentChange::selectFields() → RecentChange::getQueryInfo()
 265   * ArchivedFile::selectFields() → ArchivedFile::getQueryInfo()
 266   * LocalFile::selectFields() → LocalFile::getQueryInfo()
 267   * LocalFile::getCacheFields() with a prefix no longer works
 268   * LocalFile::getLazyCacheFields() with a prefix no longer works
 269   * OldLocalFile::selectFields() → OldLocalFile::getQueryInfo()
 270   * RecentChange::selectFields() → RecentChange::getQueryInfo()
 271   * Revision::userJoinCond() → Revision::getQueryInfo( [ 'user' ] )
 272   * Revision::selectUserFields() → Revision::getQueryInfo( [ 'user' ] )
 273   * Revision::pageJoinCond() → Revision::getQueryInfo( [ 'page' ] )
 274   * Revision::selectPageFields() → Revision::getQueryInfo( [ 'page' ] )
 275   * Revision::selectTextFields() → Revision::getQueryInfo( [ 'text' ] )
 276   * Revision::selectFields() → Revision::getQueryInfo()
 277   * Revision::selectArchiveFields() → Revision::getArchiveQueryInfo()
 278   * User::selectFields() → User::getQueryInfo()
 279   * WikiPage::selectFields() → WikiPage::getQueryInfo()
 280 * Revision::setUserIdAndName() was deprecated.
 281 * Access to TitleValue class properties was deprecated, the relevant getters
 282   should be used instead.
 283 * DifferenceEngine::getDiffBodyCacheKey() is deprecated. Subclasses should
 284   override DifferenceEngine::getDiffBodyCacheKeyParams() instead.
 285 * Use of Maintenance::error( $err, $die ) to exit script was deprecated. Use
 286   Maintenance::fatalError() instead.
 287 * Passing a ParserOptions object to OutputPage::parserOptions() is deprecated.
 288 * The RevisionInsertComplete hook is now deprecated, use RevisionRecordInserted instead.
 289   RevisionInsertComplete is still called, but the second and third parameter will always be null.
 290   Hard deprecation is scheduled for 1.32.
 291 * The following methods that get and set ParserOutput state are deprecated.
 292   Callers should use the new stateless $options parameter to
 293   ParserOutput::getText() instead.
 294   * ParserOptions::getEditSection()
 295   * ParserOptions::setEditSection()
 296   * ParserOutput::getEditSectionTokens()
 297   * ParserOutput::setEditSectionTokens()
 298   * ParserOutput::getTOCEnabled()
 299   * ParserOutput::setTOCEnabled()
 300   * OutputPage::enableSectionEditLinks()
 301   * OutputPage::sectionEditLinksEnabled()
 302   * The public ParserOutput state fields $mTOCEnabled and $mEditSectionTokens are also deprecated.
 303 * License::getLicenses has been deprecated; use License::getLines instead.
 304 * QuickTemplate::setRef() was deprecated in favour of QuickTemplate::set().
 305   Setting template variables by reference allowed violating the principle of data being
 306   immutable once added to the skin template. In practice, this method was not being
 307   used for that. Rather, setRef() existed as memory optimisation for PHP 4.
 308 * QuickTemplate::setTranslator() was deprecated in favour of Skin::msg() parameters.
 309 * MediaWikiI18N::set() was deprecated in favour of Skin::msg() parameters.
 310 * MediaWikiI18N::translate() was deprecated in favour of Skin::msg() or wfMessage().
 311 * Passing false to ParserOptions::setWrapOutputClass() is deprecated. Use the
 312   'unwrap' transform to ParserOutput::getText() instead.
 313 * \ObjectFactory (no namespace) is deprecated, the namespaced \Wikimedia\ObjectFactory
 314   from the wikimedia/object-factory library should be used instead.
 315 * CommentStore::newKey is deprecated. Get an instance from MediaWikiServices instead.
 316 * The following CommentStore methods have had their signatures changed to introduce a $key parameter,
 317   usage of the methods on instances retrieved from CommentStore::newKey will remain unchanged but deprecated:
 318   * CommentStore::getFields
 319   * CommentStore::getJoin
 320   * CommentStore::getComment
 321   * CommentStore::getCommentLegacy
 322   * CommentStore::insert
 323   * CommentStore::insertWithTemplate
 324 * The following methods in Title have been renamed, and the old ones are deprecated:
 325   * Title::getSkinFromCssJsSubpage – use ::getSkinFromConfigSubpage
 326   * Title::isCssOrJsPage – use ::isSiteConfigPage
 327   * Title::isCssJsSubpage – use ::isUserConfigPage
 328   * Title::isCssSubpage – use ::isUserCssConfigPage
 329   * Title::isJsSubpage – use ::isUserJsConfigPage
 330 * The following methods related to caching of half-parsed HTML were deprecated:
 331   * Parser::serializeHalfParsedText()
 332   * Parser::unserializeHalfParsedText()
 333   * Parser::isValidHalfParsedText()
 334   * StripState::getSubState()
 335   * StripState::merge()
 336 * The DeferredStringifier class is deprecated, use Message::listParam() instead.
 337 * The type string for the parameter $lang of DateFormatter::getInstance is
 338   deprecated.
 339 * Wikimedia\Rdbms\SavepointPostgres is deprecated.
 340 * The DO_MAINTENANCE constant is deprecated. RUN_MAINTENANCE_IF_MAIN should be
 341   used instead.
 342
 343 === Other changes in 1.31 ===
 344 * Browser support for Internet Explorer 10 was lowered from Grade A to Grade C.
 345 * Browser support for Opera 12 and older was removed. Opera 15+ continues at Grade A.
 346 * Introducing multi-content-revision capability into the storage layer. For details,
 347   see <https://www.mediawiki.org/wiki/Requests_for_comment/Multi-Content_Revisions>.
 348 * The "free" CSS class is now only applied to unbracketed URLs in wikitext. Links
 349   written using square brackets will get the class "text" not "free".
 350 * RFC 157418: Whitespace is trimmed from wikitext headings, wikitext list items,
 351   wikitext table captions, wikitext table headings, wikitext table cells. HTML
 352   headings, HTML list items, HTML table captions, HTML table headings, HTML table cells
 353   will not have this trimming behavior.
 354
 355 == Compatibility ==
 356 MediaWiki 1.31 requires PHP 5.5.9 or later. Although HHVM 3.18.5 or later is supported,
 357 it is generally advised to use PHP 5.5.9 or later for long term support.
 358
 359 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 360 but support for them is somewhat less mature. There is experimental support for
 361 Oracle and Microsoft SQL Server.
 362
 363 The supported versions are:
 364
 365 * MySQL 5.0.3 or later
 366 * PostgreSQL 9.2 or later
 367 * SQLite 3.3.7 or later
 368 * Oracle 9.0.1 or later
 369 * Microsoft SQL Server 2005 (9.00.1399)
 370
 371 == Upgrading ==
 372 1.31 has several database changes since 1.30, and will not work without schema
 373 updates. Note that due to changes to some very large tables like the revision
 374 table, the schema update may take quite long (minutes on a medium sized site,
 375 many hours on a large site).
 376
 377 Don't forget to always back up your database before upgrading!
 378
 379 See the file UPGRADE for more detailed upgrade instructions, including
 380 important information when upgrading from versions prior to 1.11.
 381
 382 For notes on 1.30.x and older releases, see HISTORY.
 383
 384 == Online documentation ==
 385 Documentation for both end-users and site administrators is available on
 386 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 387 for pages that explicitly state that their contents are in the public domain):
 388
 389        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 390
 391 == Mailing list ==
 392 A mailing list is available for MediaWiki user support and discussion:
 393
 394        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 395
 396 A low-traffic announcements-only list is also available:
 397
 398        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 399
 400 It's highly recommended that you sign up for one of these lists if you're
 401 going to run a public MediaWiki, so you can be notified of security fixes.
 402
 403 == IRC help ==
 404 There's usually someone online in #mediawiki on irc.freenode.net.