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