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