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