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