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
  28 === New features in 1.31 ===
  29 * Wikimedia\Rdbms\IDatabase->select() and similar methods now support
  30   joins with parentheses for grouping.
  31 * As a first pass in standardizing dialog boxes across the MediaWiki product,
  32   Html class now provides helper methods for messageBox, successBox, errorBox and
  33   warningBox generation.
  34 * (T9240) Imports will now record unknown (and, optionally, known) usernames in
  35   a format like "iw>Example".
  36 * (T20209) Linker (used on history pages, log pages, and so on) will display
  37   usernames formed like "iw>Example" as interwiki links, as if by wikitext like
  38   [[iw:User:Example|iw>Example]].
  39 * (T111605) The 'ImportHandleUnknownUser' hook allows extensions to auto-create
  40   users during an import.
  41 * Added a hook, ParserOutputPostCacheTransform, to allow extensions to affect
  42   the ParserOutput::getText() post-cache transformations.
  43 * Added a hook, UploadForm:getInitialPageText, to allow extensions to alter the
  44   initial page text for file uploads.
  45 * (T181651) The info page for File pages now displays the file's base-16 SHA1
  46   hash value in the table of basic information.
  47
  48 === External library changes in 1.31 ===
  49
  50 ==== Upgraded external libraries ====
  51 * Updated jquery.chosen from v0.9.14 to v1.8.2.
  52 * Updated composer/spdx-licenses from 1.1.4 to
  53   1.3.0 (development dependency).
  54 * Updated nikic/php-parser from 2.1.0 to 3.1.3
  55   (development dependency).
  56 * Updated wikimedia/ip-set from 1.1.0 to 1.2.0.
  57 * Updated wikimedia/relpath from 2.0.0 to 2.1.1.
  58 * Updated wikimedia/running-stat from 1.1.0 to 1.2.0.
  59 * Updated wikimedia/wrappedstring from 2.2.0 to 2.3.0.
  60 * …
  61
  62 ==== New external libraries ====
  63 * Added wikimedia/object-factory 1.0.0
  64 * …
  65
  66 ==== Removed and replaced external libraries ====
  67 * (T17845) The deprecated 'jquery.badge' module was removed.
  68 * The deprecated 'jquery.autoEllipsis' module was removed. Use the CSS
  69   text-overflow property instead.
  70 * The deprecated 'jquery.placeholder' module was removed.
  71 * The deprecated 'jquery.appear' module was removed. Use the
  72   'mediawiki.viewport' module instead.
  73 * The deprecated 'mediawiki.widgets.CategorySelector' module alias was removed.
  74   Use the 'mediawiki.widgets.CategoryMultiselectWidget' module directly instead.
  75
  76 === Bug fixes in 1.31 ===
  77 * (T90902) Non-breaking space in header ID breaks anchor
  78
  79 === Action API changes in 1.31 ===
  80 * (T185058) The 'name' value to tgprop for action=query&list=tags has been
  81   removed. It has never made a difference in the output, the name was always
  82   returned regardless.
  83
  84 === Action API internal changes in 1.31 ===
  85 * …
  86
  87 === Languages updated in 1.31 ===
  88 MediaWiki supports over 350 languages. Many localisations are updated
  89 regularly. Below only new and removed languages are listed, as well as
  90 changes to languages because of Phabricator reports.
  91
  92 * (T180052) Mirandese (mwl) now supports gendered NS_USER/NS_USER_TALK namespaces.
  93 * (T182305) New language support: Nyungar (nys).
  94 * (T186359) New language support: Siberian Tatar [cебертатар] (sty).
  95 * (T186635) New language support: Guianan Creole (gcr).
  96 * (T186647) New language support: Kumyk [къумукъ] (kum).
  97
  98 === Other changes in 1.31 ===
  99 * Introducing multi-content-revision capability into the storage layer. For details,
 100   see <https://www.mediawiki.org/wiki/Requests_for_comment/Multi-Content_Revisions>.
 101 * The Revision class was deprecated in favor of RevisionStore, BlobStore, and
 102   RevisionRecord and its subclasses.
 103 * MessageBlobStore::insertMessageBlob() (deprecated in 1.27) was removed.
 104 * The global function wfBCP47 was renamed to LanguageCode::bcp47.
 105 * The global function wfBCP47 is now deprecated.
 106 * The global function wfCountDown() is now deprecated in favor of
 107   Maintenance::countDown()
 108 * The OutputPage class constructor now requires a context parameter,
 109   (instantiating without context was deprecated in 1.18)
 110 * mw.page (deprecated in 1.30) was removed.
 111 * Article::getLastPurgeTimestamp(), WikiPage::getLastPurgeTimestamp(), and the
 112   related WikiPage::PURGE_* constants, deprecated in 1.29, were removed.
 113 * The Article::selectFields(), Article::onArticleCreate(),
 114   Article::onArticleDelete(), and Article::onArticleEdit() methods, deprecated
 115   in 1.24, were removed.
 116 * Installer::locateExecutable() and Installer::locateExecutableInDefaultPaths()
 117   were removed, use ExecutableFinder::findInDefaultPaths() instead.
 118 * Several methods for returning lists of fields to select from the database
 119   have been deprecated in favor of similar methods that also return the tables
 120   to select from and the join conditions for those tables.
 121   * Block::selectFields() → Block::getQueryInfo()
 122   * RecentChange::selectFields() → RecentChange::getQueryInfo()
 123   * ArchivedFile::selectFields() → ArchivedFile::getQueryInfo()
 124   * LocalFile::selectFields() → LocalFile::getQueryInfo()
 125   * LocalFile::getCacheFields() with a prefix no longer works
 126   * LocalFile::getLazyCacheFields() with a prefix no longer works
 127   * OldLocalFile::selectFields() → OldLocalFile::getQueryInfo()
 128   * RecentChange::selectFields() → RecentChange::getQueryInfo()
 129   * Revision::userJoinCond() → Revision::getQueryInfo( [ 'user' ] )
 130   * Revision::selectUserFields() → Revision::getQueryInfo( [ 'user' ] )
 131   * Revision::pageJoinCond() → Revision::getQueryInfo( [ 'page' ] )
 132   * Revision::selectPageFields() → Revision::getQueryInfo( [ 'page' ] )
 133   * Revision::selectTextFields() → Revision::getQueryInfo( [ 'text' ] )
 134   * Revision::selectFields() → Revision::getQueryInfo()
 135   * Revision::selectArchiveFields() → Revision::getArchiveQueryInfo()
 136   * User::selectFields() → User::getQueryInfo()
 137   * WikiPage::selectFields() → WikiPage::getQueryInfo()
 138 * Due to significant refactoring, method ContribsPager::getUserCond() that had
 139   no access restriction has been removed.
 140 * Revision::setUserIdAndName() was deprecated.
 141 * Access to TitleValue class properties was deprecated, the relevant getters
 142   should be used instead.
 143 * DifferenceEngine::getDiffBodyCacheKey() is deprecated. Subclasses should
 144   override DifferenceEngine::getDiffBodyCacheKeyParams() instead.
 145 * The deprecated MW_DIFF_VERSION constant was removed.
 146   DifferenceEngine::MW_DIFF_VERSION should be used instead.
 147 * Use of Maintenance::error( $err, $die ) to exit script was deprecated. Use
 148   Maintenance::fatalError() instead.
 149 * Passing a ParserOptions object to OutputPage::parserOptions() is deprecated.
 150 * Browser support for Opera 12 and older was removed.
 151   Opera 15+ continues at Grade A support.
 152 * The Block class will no longer accept usable-but-missing usernames for
 153   'byText' or ->setBlocker(). Callers should either ensure the blocker exists
 154   locally or use a new interwiki-format username like "iw>Example".
 155 * The RevisionInsertComplete hook is now deprecated, use RevisionRecordInserted instead.
 156   RevisionInsertComplete is still called, but the second and third parameter will always be null.
 157   Hard deprecation is scheduled for 1.32.
 158 * The following methods that get and set ParserOutput state are deprecated.
 159   Callers should use the new stateless $options parameter to
 160   ParserOutput::getText() instead.
 161   * ParserOptions::getEditSection()
 162   * ParserOptions::setEditSection()
 163   * ParserOutput::getEditSectionTokens()
 164   * ParserOutput::setEditSectionTokens()
 165   * ParserOutput::getTOCEnabled()
 166   * ParserOutput::setTOCEnabled()
 167   * OutputPage::enableSectionEditLinks()
 168   * OutputPage::sectionEditLinksEnabled()
 169   * The public ParserOutput state fields $mTOCEnabled and $mEditSectionTokens are also deprecated.
 170 * The following methods and constants from the WatchedItem class were deprecated in
 171   1.27 have been removed.
 172   * WatchedItem::getTitle()
 173   * WatchedItem::fromUserTitle()
 174   * WatchedItem::addWatch()
 175   * WatchedItem::removeWatch()
 176   * WatchedItem::isWatched()
 177   * WatchedItem::duplicateEntries()
 178   * WatchedItem::IGNORE_USER_RIGHTS
 179   * WatchedItem::CHECK_USER_RIGHTS
 180   * WatchedItem::DEPRECATED_USAGE_TIMESTAMP
 181 * The $statementsOnOwnLine parameter of JavaScriptMinifier::minify was removed.
 182   The corresponding configuration variable ($wgResourceLoaderMinifierStatementsOnOwnLine)
 183   has been deprecated since 1.27 and was removed as well.
 184 * The $maxLineLength parameter of JavaScriptMinifier::minify was removed.
 185   The corresponding configuration variable ($wgResourceLoaderMinifierMaxLineLength)
 186   has been deprecated since 1.27 and was removed as well.
 187 * The HtmlFormatter class was removed (deprecated in 1.27). The namespaced
 188   HtmlFormatter\HtmlFormatter class should be used instead.
 189 * License::getLicenses has been deprecated; use License::getLines instead.
 190 * The driver 'mysql' for MySQL, deprecated in MediaWiki 1.30, has been removed.
 191   The driver has been deprecated since PHP 5.5 and was removed in PHP 7.0. The
 192   default driver for MySQL has been 'mysqli' since MediaWiki 1.22.
 193 * The following properties of PreparedEdit were deprecated in 1.21 and have been removed:
 194   * PreparedEdit->newText
 195   * PreparedEdit->oldText
 196   * PreparedEdit->pst
 197 * QuickTemplate::setRef() was deprecated in favour of QuickTemplate::set().
 198   Setting template variables by reference allowed violating the principle of data being
 199   immutable once added to the skin template. In practice, this method was not being
 200   used for that. Rather, setRef() existed as memory optimisation for PHP 4.
 201 * QuickTemplate::setTranslator() was deprecated in favour of Skin::msg() parameters.
 202 * MediaWikiI18N::set() was deprecated in favour of Skin::msg() parameters.
 203 * MediaWikiI18N::translate() was deprecated in favour of Skin::msg() or wfMessage().
 204 * Passing false to ParserOptions::setWrapOutputClass() is deprecated. Use the
 205   'unwrap' transform to ParserOutput::getText() instead.
 206 * ParserOutput objects generated using a non-default value for
 207   ParserOptions::setWrapOutputClass() can no longer be added to the parser
 208   cache.
 209 * The following deprecated methods from the OutputPage class have been removed:
 210   * OutputPage::addExtensionStyle(); deprecated in 1.27
 211   * OutputPage::getExtStyle(); deprecated in 1.27
 212   * OutputPage::setETag(); deprecated in 1.28 (obsolete no-op)
 213   * OutputPage::setSquidMaxage(); deprecated in 1.27
 214   * OutputPage::readOnlyPage(); deprecated in 1.25
 215   * OutputPage::rateLimited(); deprecated in 1.25
 216   * Additionally, the protected OutputPage::$mExtStyles array, only accessed through
 217     the above and with no known uses, was removed.
 218 * The no-op method Skin::showIPinHeader(), deprecated in 1.27, was removed.
 219 * \ObjectFactory (no namespace) is deprecated, the namespaced \Wikimedia\ObjectFactory
 220   from the wikimedia/object-factory library should be used instead.
 221 * CommentStore::newKey is deprecated. Get an instance from MediaWikiServices instead.
 222 * The following CommentStore methods have had their signatures changed to introduce a $key parameter,
 223   usage of the methods on instances retrieved from CommentStore::newKey will remain unchanged but deprecated:
 224   * CommentStore::getFields
 225   * CommentStore::getJoin
 226   * CommentStore::getComment
 227   * CommentStore::getCommentLegacy
 228   * CommentStore::insert
 229   * CommentStore::insertWithTemplate
 230
 231 == Compatibility ==
 232 MediaWiki 1.31 requires PHP 5.5.9 or later. Although HHVM 3.18.5 or later is supported,
 233 it is generally advised to use PHP 5.5.9 or later for long term support.
 234
 235 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 236 but support for them is somewhat less mature. There is experimental support for
 237 Oracle and Microsoft SQL Server.
 238
 239 The supported versions are:
 240
 241 * MySQL 5.0.3 or later
 242 * PostgreSQL 8.3 or later
 243 * SQLite 3.3.7 or later
 244 * Oracle 9.0.1 or later
 245 * Microsoft SQL Server 2005 (9.00.1399)
 246
 247 == Upgrading ==
 248 1.31 has several database changes since 1.30, and will not work without schema
 249 updates. Note that due to changes to some very large tables like the revision
 250 table, the schema update may take quite long (minutes on a medium sized site,
 251 many hours on a large site).
 252
 253 Don't forget to always back up your database before upgrading!
 254
 255 See the file UPGRADE for more detailed upgrade instructions, including
 256 important information when upgrading from versions prior to 1.11.
 257
 258 For notes on 1.30.x and older releases, see HISTORY.
 259
 260 == Online documentation ==
 261 Documentation for both end-users and site administrators is available on
 262 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 263 for pages that explicitly state that their contents are in the public domain):
 264
 265        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 266
 267 == Mailing list ==
 268 A mailing list is available for MediaWiki user support and discussion:
 269
 270        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 271
 272 A low-traffic announcements-only list is also available:
 273
 274        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 275
 276 It's highly recommended that you sign up for one of these lists if you're
 277 going to run a public MediaWiki, so you can be notified of security fixes.
 278
 279 == IRC help ==
 280 There's usually someone online in #mediawiki on irc.freenode.net.