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