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