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