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