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