RELEASE-NOTES-1.34

   1 = MediaWiki 1.34 =
   2
   3 == MediaWiki 1.34.0-PRERELEASE ==
   4
   5 THIS IS NOT A RELEASE YET
   6
   7 MediaWiki 1.34 is an alpha-quality development branch, and is not recommended
   8 for use in production.
   9
  10 == Upgrading notes for 1.34 ==
  11 1.34 has several database changes since 1.33, and will not work without schema
  12 updates. Note that due to changes to some very large tables like the revision
  13 table, the schema update may take quite long (minutes on a medium sized site,
  14 many hours on a large site).
  15
  16 Don't forget to always back up your database before upgrading!
  17
  18 See the file UPGRADE for more detailed upgrade instructions, including
  19 important information when upgrading from versions prior to 1.11.
  20
  21 Some specific notes for MediaWiki 1.34 upgrades are below:
  22
  23 * …
  24
  25 For notes on 1.33.x and older releases, see HISTORY.
  26
  27 === Configuration changes for system administrators in 1.34 ===
  28
  29 ==== New configuration ====
  30 * $wgAllowExternalReqID (T201409) - This configuration setting controls whether
  31   Mediawiki accepts the request ID set by the incoming request via the
  32   `X-Request-Id` header. If set to `true`, that value will be used throughout
  33   the code as the request identificator. Otherwise, the sent header will be
  34   ignored and the request ID will either be taken from Apache's mod_unique
  35   module or will be generated by Mediawiki itself (depending on the set-up).
  36 * $wgEnableSpecialMute (T218265) - This configuration controls whether
  37   Special:Mute is available and whether to include a link to it on emails
  38   originating from Special:Email.
  39
  40 ==== Changed configuration ====
  41 * $wgUseCdn, $wgCdnServers, $wgCdnServersNoPurge, and $wgCdnMaxAge – These four
  42   CDN-related config variables have been renamed from being specific to Squid –
  43   they were previously $wgUseSquid, $wgSquidServers, $wgSquidServersNoPurge, and
  44   $wgSquidMaxage respectively. This aligns them with the related existing
  45   variable $wgCdnMaxageLagged. The previous configuration variable names are
  46   deprecated, but will be used as the fall back if they are still set.
  47   Note that wgSquidPurgeUseHostHeader has not been renamed, as it is deprecated.
  48 * (T27707) File type checks for image uploads have been relaxed to allow files
  49   containing some HTML markup in metadata. As a result, the $wgAllowTitlesInSVG
  50   setting is no longer applied and is now always true. Note that MSIE 7 may
  51   still be able to misinterpret certain malformed PNG files as HTML.
  52 * Introduced $wgVerifyMimeTypeIE to allow disabling the MSIE 6/7 file type
  53   detection heuristic on upload, which is more conservative than the checks
  54   that were changed above.
  55 * …
  56
  57 ==== Removed configuration ====
  58 * $wgWikiDiff2MovedParagraphDetectionCutoff — If you still want a custom change
  59   size threshold, please specify in php.ini, using the configuration variable
  60   wikidiff2.moved_paragraph_detection_cutoff.
  61
  62 === New user-facing features in 1.34 ===
  63 * Special:Mute has been added as a quick way for users to block unwanted emails
  64   from other users originating from Special:EmailUser.
  65
  66 === New developer features in 1.34 ===
  67 * Language::formatTimePeriod now supports the new 'avoidhours' option to output
  68   strings like "5 days ago" instead of "5 days 13 hours ago".
  69
  70 === External library changes in 1.34 ===
  71
  72 ==== New external libraries ====
  73 * …
  74
  75 ==== Changed external libraries ====
  76 * Updated Mustache from 1.0.0 to v3.0.1.
  77 * Updated OOUI from v0.31.3 to v0.33.2.
  78 * Updated composer/semver from 1.4.2 to 1.5.0.
  79 * Updated composer/spdx-licenses from 1.4.0 to 1.5.1 (dev-only).
  80 * Updated mediawiki/codesniffer from 25.0.0 to 26.0.0 (dev-only).
  81 * Updated cssjanus/cssjanus from 1.2.1 to 1.3.0.
  82 * Updated wikimedia/at-ease from 1.2.0 to 2.0.0.
  83 * Updated wikimedia/remex-html from 2.0.1 to 2.0.3.
  84 * Updated monolog/monolog from 1.22.1 to 1.24.0 (dev-only).
  85 * Updated wikimedia/object-factory from 1.0.0 to 2.1.0.
  86 * Updated wikimedia/timestamp from 2.2.0 to 3.0.0.
  87 * Updated wikimedia/xmp-reader from 0.6.2 to 0.6.3.
  88 * Updated mediawiki/mediawiki-phan-config from 0.6.0 to 0.6.1 (dev-only).
  89 * …
  90
  91 ==== Removed external libraries ====
  92 * The jquery.async module, deprecated in 1.33, was removed.
  93 * …
  94
  95 === Bug fixes in 1.34 ===
  96 * (T222529) If a log entry or page revision is recorded in the database with an
  97   empty username, attempting to display it will log an error and return a "no
  98   username available" to the user instead of silently displaying nothing or
  99   invalid links.
 100
 101 === Action API changes in 1.34 ===
 102 * The 'recenteditcount' response property from action=query list=allusers,
 103   deprecated in 1.25, has been removed.
 104
 105 === Action API internal changes in 1.34 ===
 106 * …
 107
 108 === Languages updated in 1.34 ===
 109 MediaWiki supports over 350 languages. Many localisations are updated regularly.
 110 Below only new and removed languages are listed, as well as changes to languages
 111 because of Phabricator reports.
 112
 113 * (T152908) Added language support for N'Ko (nqo).
 114
 115 === Breaking changes in 1.34 ===
 116 * The global functions wfSuppressWarnings and wfRestoreWarnings, deprecated in
 117   1.26, have been removed. Use Wikimedia\AtEase\AtEase::suppressWarnings() and
 118   Wikimedia\AtEase\AtEase::restoreWarnings() directly.
 119 * Preferences class, deprecated in 1.31, has been removed.
 120 * The following parts of code, deprecated in 1.32, were removed in favor of
 121   built-in PHP functions:
 122   * CryptRand class
 123   * CryptRand service
 124   * Functions of the MWCryptRand class: singleton(), wasStrong() and generate().
 125 * Language::setCode, deprecated in 1.32, was removed. Use Language::factory to
 126   create a new Language object with a different language code.
 127 * MWNamespace::clearCaches() has been removed.  So has the $rebuild parameter
 128   to MWNamespace::getCanonicalNamespaces(), which was deprecated since 1.31.
 129   Instead, reset services, such as by calling $this->overrideMwServices() (if
 130   your test extends MediaWikiTestCase). Services will generally not pick up
 131   configuration changes from after they were created, so you must reset
 132   services after any configuration change. Even if your code works now, it is
 133   likely to break in future versions as more code is moved to services.
 134 * The ill-defined "DatabaseOraclePostInit" hook has been removed.
 135 * PreferencesFormLegacy and PreferencesForm classes, deprecated in 1.32, have
 136   been removed.
 137 * ObjectFactory class, deprecated in 1.31, has been removed.
 138 * HWLDFWordAccumudlator class, deprecated in 1.28, has been removed.
 139 * XMPInfo, XMPReader and XMPValidate, deprecated in 1.32, have been removed.
 140 * The RedirectSpecialPage::execute method could sometimes return a Title object.
 141   This behavior was removed, and the method now matches the parent signature
 142   (SpecialPage::execute) which is to return HTML string or void.
 143   To obtain the destination title, use RedirectSpecialPage::getRedirect.
 144 * The 'recenteditcount' response property from action API action=query
 145   list=allusers, deprecated in 1.25, has been removed.
 146 * SearchEngine::userNamespaces(), SearchEngine::namespacesAsText(),
 147   SearchEngine::create(), SearchEngine::getSearchTypes() and
 148   SearchEngine::getNearMatch(), methods deprecated in 1.27, have been removed.
 149 * FileRepo::streamFile(), deprecated in 1.26, has been removed.
 150 * User::randomPassword() method, deprecated in 1.27, have been removed.
 151 * MWNamespace::canTalk(), deprecated in 1.30, have been removed.
 152 * Parser class property $mUniqPrefix, deprecated in 1.26, has been removed.
 153 * wfArrayFilter() and wfArrayFilterByKey(), deprecated in 1.32, have been
 154   removed.
 155 * wfMakeUrlIndexes() function, deprecated in 1.33, have been removed.
 156 * Method signatures in WatchedItemQueryServiceExtension have changed from taking
 157   User objects to taking UserIdentity objects. Extensions implementing this
 158   interface need to be changed accordingly.
 159 * User::getGroupPage() and ::makeGroupLinkHTML(), deprecated in 1.29, have been
 160   removed. Use UserGroupMembership::getGroupPage and ::getLink instead.
 161 * User::makeGroupLinkWiki(), deprecated in 1.29, has been removed. Use
 162   UserGroupMembership::getLink() instead.
 163 * SavepointPostgres, deprecated in 1.31, has been removed.
 164 * OutputPage::enableSectionEditLinks(), OutputPage::sectionEditLinksEnabled(),
 165   ParserOptions::getEditSection(), ParserOptions::setEditSection(), and
 166   ParserOutput::getEditSectionTokens, ::getTOCEnabled, ::setEditSectionTokens,
 167   and ::setTOCEnabled, deprecated in 1.31, have been removed.
 168 * EditPage::safeUnicodeInput() and ::safeUnicodeOutput(), deprecated in 1.30,
 169   have been removed.
 170 * Four methods in OutputPage, deprecated in 1.32, have been removed. You should
 171   use OutputPage::showFatalError or throw a FatalError instead. The methods are
 172   ::showFileCopyError(), ::showFileRenameError(), ::showFileDeleteError(), and
 173   ::showFileNotFoundError().
 174 * ApiBase::truncateArray(), deprecated in 1.32, has been removed.
 175 * IcuCollation::getICUVersion(), deprecated in 1.32, has been removed. Use PHP's
 176   INTL_ICU_VERSION constant directly.
 177 * HTMLForm::setSubmitProgressive(), deprecated in 1.32, has been removed.
 178 * ResourceLoaderStartUpModules::getStartupModules() and ::getLegacyModules(),
 179   both deprecated in 1.32, have been removed.
 180 * BaseTemplate::msgHtml() and QuickTemplate::msgHtml(), deprecated in 1.32, have
 181   been removed. Use ->msg() or ->getMsg() instead.
 182 * WatchAction::getUnwatchToken(), deprecated in 1.32, has been removed. Instead,
 183   use WatchAction::getWatchToken() with action 'unwatch' directly.
 184 * Language::initEncoding(), ::recodeForEdit(), and recodeInput(), deprecated in
 185   1.28, have been removed.
 186 * PageArchive::getTextFromRow(), ::listAllPages(), and ::getLastRevisionText(),
 187   deprecated in 1.32, have been removed.
 188 * OutputPage::getModuleScripts(), ParserOutput::getModuleScripts(), deprecated
 189   in 1.33, have been removed.
 190 * User::getPasswordValidity(), deprecated in 1.33, has been removed.
 191 * ApiQueryBase::prepareUrlQuerySearchString(), deprecated in 1.33, has been
 192   removed.
 193 * ChangeTags::purgeTagUsageCache(), deprecated in 1.33, has been removed.
 194 * JobQueueGroup::pushLazyJobs(), deprecated in 1.33, has been removed.
 195 * MediaWikiTestCase::stashMwGlobals(), deprecated in 1.32, has been removed.
 196 * SearchEngine::transformSearchTerm(), deprecated in 1.32, has been removed.
 197 * The Block typehint only refers to blocks stored in the database. It should be
 198   updated to AbstractBlock in cases where any type of block could be expected.
 199 * FileRepoStatus, deprecated in 1.25, has been removed.
 200 * The LegacyHookPreAuthenticationProvider class, deprecated since its creation
 201   in 1.27, has been removed.
 202 * IP::isValidBlock(), deprecated in 1.30, has been removed.
 203 * WikiPage::prepareContentForEdit now doesn't accept an integer for $revision,
 204   was deprecated in 1.25.
 205 * The jquery.byteLength module, deprecated in 1.31, was removed.
 206   Use the mediawiki.String module instead.
 207 * mw.language.specialCharacters, deprecated in 1.33, has been removed.
 208   Use require( 'mediawiki.language.specialCharacters' ) instead.
 209 * EditPage::submit(), deprecated in 1.29, has been removed. Use $this->edit()
 210   directly.
 211 * HTMLForm::getErrors(), deprecated in 1.28, has been removed. Use
 212   getErrorsOrWarnings() instead.
 213 * SpecialPage::getTitle(), deprecated in 1.23, has been removed. Use
 214   SpecialPage::getPageTitle() instead.
 215 * jquery.ui.effect-bounce, jquery.ui.effect-explode, jquery.ui.effect-fold
 216   jquery.ui.effect-pulsate, jquery.ui.effect-slide, jquery.ui.effect-transfer,
 217   which are no longer used, have now been removed.
 218 * SpecialEmailUser::validateTarget(), ::getTarget() without a sender/user
 219   specified, deprecated in 1.30, have been removed.
 220 * BufferingStatsdDataFactory::getBuffer(), deprecated in 1.30, has been removed.
 221 * The constant DB_SLAVE, deprecated in 1.28, has been removed. Use DB_REPLICA.
 222 * Replacer, DoubleReplacer, HashtableReplacer and RegexlikeReplacer
 223   (deprecated in 1.32) have been removed. Closures should be used instead.
 224 * OutputPage::addWikiText(), ::addWikiTextWithTitle(), ::addWikiTextTitleTidy(),
 225   ::addWikiTextTidy(), ::addWikiTextTitle(), deprecated in 1.32, have been
 226   removed.
 227 * The $wgUseKeyHeader configuration option and the OutputPage::getKeyHeader()
 228   method, deprecated in 1.32, have been removed.
 229 * WebInstallerOutput::addWikiText(), deprecated in 1.32, has been removed.
 230 * Parser::fetchFile(), deprecated in 1.32, has been removed. Use the method
 231   Parser::fetchFileAndTitle() instead.
 232 * The global function wfBCP47, deprecated in 1.31, has been removed.
 233 * wfCountDown() function, deprecated in 1.31, has been removed. Use
 234   \Maintenance::countDown() method instead.
 235 * OutputPage::wrapWikiMsg() no longer accepts an options parameter. This was
 236   deprecated since 1.20.
 237 * Skin::outputPage() no longer accepts a context. This was deprecated in 1.20.
 238 * Linker::link() no longer accepts a string for the query array, as was
 239   deprecated in 1.20.
 240 * PrefixSearch::titleSearch(), deprecated in 1.23, has been removed. Use the
 241   SearchEngine::defaultPrefixSearch or ::completionSearch() methods instead.
 242 * The UserRights hook, deprecated in 1.26, has been removed. Instead, use the
 243   UserGroupsChanged hook.
 244 * Skin::getDefaultInstance(), deprecated in 1.27, has been removed. Get the
 245   instance from MediaWikiServices instead.
 246 * The UserLoadFromSession hook, deprecated in 1.27, has been removed.
 247 * The wfResetSessionID global function, deprecated in 1.27, has been removed.
 248   Use MediaWiki\Session\SessionManager instead.
 249 * The wfGetLBFactory global function, deprecated in 1.27, has been removed.
 250   Use MediaWikiServices::getInstance()->getDBLoadBalancerFactory().
 251 * The internal method OutputPage->addScriptFile() will no longer silently drop
 252   calls that use an invalid path (i.e., something other than an absolute path,
 253   protocol-relative URL, or full scheme URL), and will instead pass them to the
 254   client where they will likely 404. This usage was deprecated in 1.24.
 255 * Database::reportConnectionError, deprecated in 1.32, has been removed.
 256 * APIEditBeforeSave hook, deprecated in 1.28, has been removed. Please see
 257   EditFilterMergedContent hook for an alternative way to use this feature.
 258 * API module methods getDescription(), getParamDescription(), & getExamples(),
 259   all deprecated in 1.25 and ignored, have been removed.
 260 * The API module method getDescriptionMessage(), deprecated in 1.30, has been
 261   removed.
 262 * The JavaScript global variable wgLoadScript has been removed. Use
 263   mw.util.wikiScript( 'load' ) instead.
 264 * ResourceLoader no longer creates the 'mw.legacy' placeholder object. It has
 265   been unused since 1.16 and was deprecated in 1.22. To deprecate a property
 266   in JavaScript, use mw.log.deprecate() instead.
 267 * The 'user.groups' module, deprecated in 1.28, was removed.
 268   Use the 'user' module instead.
 269 * The ability to override User::$mRights has been removed.
 270 * Previously, when iterating ResultWrapper with foreach() or a similar
 271   construct, the range of the index was 1..numRows. This has been fixed to be
 272   0..(numRows-1).
 273 * The ChangePasswordForm hook, deprecated in 1.27, has been removed. Use the
 274   AuthChangeFormFields hook or security levels instead.
 275 * …
 276
 277 === Deprecations in 1.34 ===
 278 * The MWNamespace class is deprecated. Use NamespaceInfo.
 279 * ExtensionRegistry->load() is deprecated, as it breaks dependency checking.
 280   Instead, use ->queue().
 281 * User::isBlocked() is deprecated since it does not tell you if the user is
 282   blocked from editing a particular page. Use User::getBlock() or
 283   PermissionManager::isBlockedFrom() or PermissionManager::userCan() instead.
 284 * User::isLocallyBlockedProxy and User::inDnsBlacklist are deprecated and moved
 285   to the BlockManager as private helper methods.
 286 * User::isDnsBlacklisted is deprecated. Use BlockManager::isDnsBlacklisted
 287   instead.
 288 * The Config argument to ChangesListSpecialPage::checkStructuredFilterUiEnabled
 289   is deprecated. Pass only the User argument.
 290 * WatchedItem::getUser is deprecated. Use getUserIdentity.
 291 * Passing a Title as the first parameter to the getTimestampById method of
 292   RevisionStore is deprecated. Omit it, passing only the remaining parameters.
 293 * Title::getPreviousRevisionId and Title::getNextRevisionId are deprecated. Use
 294   RevisionLookup::getPreviousRevision and RevisionLookup::getNextRevision.
 295 * The Title parameter to RevisionLookup::getPreviousRevision and
 296   RevisionLookup::getNextRevision is deprecated and should be omitted.
 297 * MWHttpRequest::factory is deprecated. Use HttpRequestFactory.
 298 * The Http class is deprecated. For the request, get, and post methods, use
 299   HttpRequestFactory. For isValidURI, use MWHttpRequest::isValidURI.  For
 300   getProxy, use (string)$wgHTTPProxy. For createMultiClient, construct a
 301   MultiHttpClient directly.
 302 * Http::$httpEngine is deprecated and has no replacement. The default 'guzzle'
 303   engine will eventually be made the only engine for HTTP requests.
 304 * RepoGroup::singleton(), RepoGroup::destroySingleton(),
 305   RepoGroup::setSingleton(), wfFindFile(), and wfLocalFile() are all
 306   deprecated. Use MediaWikiServices instead.
 307 * The getSubjectPage, getTalkPage, and getOtherPage of Title are deprecated.
 308   Use NamespaceInfo's getSubjectPage, getTalkPage, and getAssociatedPage.
 309 * MWMessagePack class, no longer used, has been deprecated in 1.34.
 310 * The Block class is separated into DatabaseBlock (for blocks stored in the
 311   database), and SystemBlock (for temporary blocks created by the system).
 312   SystemBlock should be used when creating any temporary blocks. Block is
 313   a deprecated alias for DatabaseBlock.
 314 * Parser::$mConf is deprecated. It will be removed entirely in a later version.
 315   Some context can be found at T224165.
 316 * Constructing Parser directly is deprecated. Obtain one from ParserFactory.
 317 * Title::moveSubpages is deprecated. Use MovePage::moveSubpages or
 318   MovePage::moveSubpagesIfAllowed.
 319 * The MWNamespace class is deprecated. Use MediaWikiServices::getNamespaceInfo.
 320 * (T62260) Hard deprecate Language::getExtraUserToggles() method.
 321 * Language::viewPrevNext function is deprecated, use
 322   PrevNextNavigationRenderer::buildPrevNextNavigation instead
 323 * User::trackBlockWithCookie and DatabaseBlock::clearCookie are deprecated. Use
 324   BlockManager::trackBlockWithCookie and BlockManager::clearCookie instead.
 325 * DatabaseBlock::setCookie, DatabaseBlock::getCookieValue,
 326   DatabaseBlock::getIdFromCookieValue and AbstractBlock::shouldTrackWithCookie
 327   are moved to internal helper methods for BlockManager::trackBlockWithCookie.
 328 * ResourceLoaderContext::getConfig and ResourceLoaderContext::getLogger have
 329   been deprecated. Inside ResourceLoaderModule subclasses, use the local methods
 330   instead. Elsewhere, use the methods from the ResourceLoader class.
 331 * The Preprocessor_DOM implementation has been deprecated.  It will be
 332   removed in a future release.  Use the Preprocessor_Hash implementation
 333   instead.
 334 * Sanitizer::attributeWhitelist() and Sanitizer::setupAttributeWhitelist()
 335   have been deprecated; they will be made private in the future.
 336 * SearchResult::termMatches() method is deprecated. It was unreliable because
 337   only populated by few search engine implementations. Use
 338   SqlSearchResult::getTermMatches() if really needed.
 339 * SearchResult::getTextSnippet( $terms ) the $terms param is being deprecated
 340   and should no longer be passed. Search engine implemenations should be
 341   responsible for carrying relevant information needed for highlighting with
 342   their own SearchResultSet/SearchResult sub-classes.
 343 * SearchEngine::$searchTerms protected field is deprecated. Moved to
 344   SearchDatabase.
 345 * The use of the $terms param in the ShowSearchHit and ShowSearchHitTitle
 346   hooks is highly discouraged as it's only populated by SearchDatabase search
 347   engines.
 348 * Skin::escapeSearchLink() is deprecated. Use Skin::getSearchLink() or the skin
 349   template option 'searchaction' instead.
 350 * LoadBalancer::haveIndex() and LoadBalancer::isNonZeroLoad() have
 351   been deprecated.
 352 * User::getRights() and User::$mRights have been deprecated. Use
 353   PermissionManager::getUserPermissions() instead.
 354
 355 === Other changes in 1.34 ===
 356 * …
 357
 358 == Compatibility ==
 359 MediaWiki 1.34 requires PHP 7.0.13 or later. Although HHVM 3.18.5 or later is
 360 supported, it is generally advised to use PHP 7.0.13 or later for long term
 361 support.
 362
 363 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 364 but support for them is somewhat less mature. There is experimental support for
 365 Oracle and Microsoft SQL Server.
 366
 367 The supported versions are:
 368
 369 * MySQL 5.5.8 or later
 370 * PostgreSQL 9.2 or later
 371 * SQLite 3.8.0 or later
 372 * Oracle 9.0.1 or later
 373 * Microsoft SQL Server 2005 (9.00.1399)
 374
 375 == Online documentation ==
 376 Documentation for both end-users and site administrators is available on
 377 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 378 for pages that explicitly state that their contents are in the public domain):
 379
 380        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 381
 382 == Mailing list ==
 383 A mailing list is available for MediaWiki user support and discussion:
 384
 385        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 386
 387 A low-traffic announcements-only list is also available:
 388
 389        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 390
 391 It's highly recommended that you sign up for one of these lists if you're
 392 going to run a public MediaWiki, so you can be notified of security fixes.
 393
 394 == IRC help ==
 395 There's usually someone online in #mediawiki on irc.freenode.net.