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