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