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