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