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 * …
  82
  83 ==== Removed external libraries ====
  84 * The jquery.async module, deprecated in 1.33, was removed.
  85 * …
  86
  87 === Bug fixes in 1.34 ===
  88 * (T222529) If a log entry or page revision is recorded in the database with an
  89   empty username, attempting to display it will log an error and return a "no
  90   username available" to the user instead of silently displaying nothing or
  91   invalid links.
  92
  93 === Action API changes in 1.34 ===
  94 * The 'recenteditcount' response property from action=query list=allusers,
  95   deprecated in 1.25, has been removed.
  96
  97 === Action API internal changes in 1.34 ===
  98 * …
  99
 100 === Languages updated in 1.34 ===
 101 MediaWiki supports over 350 languages. Many localisations are updated regularly.
 102 Below only new and removed languages are listed, as well as changes to languages
 103 because of Phabricator reports.
 104
 105 * (T152908) Added language support for N'Ko (nqo).
 106
 107 === Breaking changes in 1.34 ===
 108 * The global functions wfSuppressWarnings and wfRestoreWarnings, deprecated in
 109   1.26, have been removed. Use Wikimedia\AtEase\AtEase::suppressWarnings() and
 110   Wikimedia\AtEase\AtEase::restoreWarnings() directly.
 111 * Preferences class, deprecated in 1.31, has been removed.
 112 * The following parts of code, deprecated in 1.32, were removed in favor of
 113   built-in PHP functions:
 114   * CryptRand class
 115   * CryptRand service
 116   * Functions of the MWCryptRand class: singleton(), wasStrong() and generate().
 117 * Language::setCode, deprecated in 1.32, was removed. Use Language::factory to
 118   create a new Language object with a different language code.
 119 * MWNamespace::clearCaches() has been removed.  So has the $rebuild parameter
 120   to MWNamespace::getCanonicalNamespaces(), which was deprecated since 1.31.
 121   Instead, reset services, such as by calling $this->overrideMwServices() (if
 122   your test extends MediaWikiTestCase). Services will generally not pick up
 123   configuration changes from after they were created, so you must reset
 124   services after any configuration change. Even if your code works now, it is
 125   likely to break in future versions as more code is moved to services.
 126 * The ill-defined "DatabaseOraclePostInit" hook has been removed.
 127 * PreferencesFormLegacy and PreferencesForm classes, deprecated in 1.32, have
 128   been removed.
 129 * ObjectFactory class, deprecated in 1.31, has been removed.
 130 * HWLDFWordAccumudlator class, deprecated in 1.28, has been removed.
 131 * XMPInfo, XMPReader and XMPValidate, deprecated in 1.32, have been removed.
 132 * The RedirectSpecialPage::execute method could sometimes return a Title object.
 133   This behavior was removed, and the method now matches the parent signature
 134   (SpecialPage::execute) which is to return HTML string or void.
 135   To obtain the destination title, use RedirectSpecialPage::getRedirect.
 136 * The 'recenteditcount' response property from action API action=query
 137   list=allusers, deprecated in 1.25, has been removed.
 138 * SearchEngine::userNamespaces(), SearchEngine::namespacesAsText(),
 139   SearchEngine::create(), SearchEngine::getSearchTypes() and
 140   SearchEngine::getNearMatch(), methods deprecated in 1.27, have been removed.
 141 * FileRepo::streamFile(), deprecated in 1.26, has been removed.
 142 * User::randomPassword() method, deprecated in 1.27, have been removed.
 143 * MWNamespace::canTalk(), deprecated in 1.30, have been removed.
 144 * Parser class property $mUniqPrefix, deprecated in 1.26, has been removed.
 145 * wfArrayFilter() and wfArrayFilterByKey(), deprecated in 1.32, have been
 146   removed.
 147 * wfMakeUrlIndexes() function, deprecated in 1.33, have been removed.
 148 * Method signatures in WatchedItemQueryServiceExtension have changed from taking
 149   User objects to taking UserIdentity objects. Extensions implementing this
 150   interface need to be changed accordingly.
 151 * User::getGroupPage() and ::makeGroupLinkHTML(), deprecated in 1.29, have been
 152   removed. Use UserGroupMembership::getGroupPage and ::getLink instead.
 153 * User::makeGroupLinkWiki(), deprecated in 1.29, has been removed. Use
 154   UserGroupMembership::getLink() instead.
 155 * SavepointPostgres, deprecated in 1.31, has been removed.
 156 * Output::sectionEditLinksEnabled(), ParserOutput::getEditSectionTokens,
 157   ::getTOCEnabled, ::setEditSectionTokens, ::setTOCEnabled, deprecated in 1.31,
 158   have been removed.
 159 * EditPage::safeUnicodeInput() and ::safeUnicodeOutput(), deprecated in 1.30,
 160   have been removed.
 161 * Four methods in OutputPage, deprecated in 1.32, have been removed. You should
 162   use OutputPage::showFatalError or throw a FatalError instead. The methods are
 163   ::showFileCopyError(), ::showFileRenameError(), ::showFileDeleteError(), and
 164   ::showFileNotFoundError().
 165 * ApiBase::truncateArray(), deprecated in 1.32, has been removed.
 166 * IcuCollation::getICUVersion(), deprecated in 1.32, has been removed. Use PHP's
 167   INTL_ICU_VERSION constant directly.
 168 * HTMLForm::setSubmitProgressive(), deprecated in 1.32, has been removed.
 169 * ResourceLoaderStartUpModules::getStartupModules() and ::getLegacyModules(),
 170   both deprecated in 1.32, have been removed.
 171 * BaseTemplate::msgHtml() and QuickTemplate::msgHtml(), deprecated in 1.32, have
 172   been removed. Use ->msg() or ->getMsg() instead.
 173 * WatchAction::getUnwatchToken(), deprecated in 1.32, has been removed. Instead,
 174   use WatchAction::getWatchToken() with action 'unwatch' directly.
 175 * Language::initEncoding(), ::recodeForEdit(), and recodeInput(), deprecated in
 176   1.28, have been removed.
 177 * PageArchive::getTextFromRow(), ::listAllPages(), and ::getLastRevisionText(),
 178   deprecated in 1.32, have been removed.
 179 * OutputPage::getModuleScripts(), ParserOutput::getModuleScripts(), deprecated
 180   in 1.33, have been removed.
 181 * User::getPasswordValidity(), deprecated in 1.33, has been removed.
 182 * ApiQueryBase::prepareUrlQuerySearchString(), deprecated in 1.33, has been
 183   removed.
 184 * ChangeTags::purgeTagUsageCache(), deprecated in 1.33, has been removed.
 185 * JobQueueGroup::pushLazyJobs(), deprecated in 1.33, has been removed.
 186 * MediaWikiTestCase::stashMwGlobals(), deprecated in 1.32, has been removed.
 187 * SearchEngine::transformSearchTerm(), deprecated in 1.32, has been removed.
 188 * The Block typehint only refers to blocks stored in the database. It should be
 189   updated to AbstractBlock in cases where any type of block could be expected.
 190 * FileRepoStatus, deprecated in 1.25, has been removed.
 191 * The LegacyHookPreAuthenticationProvider class, deprecated since its creation
 192   in 1.27, has been removed.
 193 * IP::isValidBlock(), deprecated in 1.30, has been removed.
 194 * WikiPage::prepareContentForEdit now doesn't accept an integer for $revision,
 195   was deprecated in 1.25.
 196 * The jquery.byteLength module, deprecated in 1.31, was removed.
 197   Use the mediawiki.String module instead.
 198 * mw.language.specialCharacters, deprecated in 1.33, has been removed.
 199   Use require( 'mediawiki.language.specialCharacters' ) instead.
 200 * EditPage::submit(), deprecated in 1.29, has been removed. Use $this->edit()
 201   directly.
 202 * HTMLForm::getErrors(), deprecated in 1.28, has been removed. Use
 203   getErrorsOrWarnings() instead.
 204 * SpecialPage::getTitle(), deprecated in 1.23, has been removed. Use
 205   SpecialPage::getPageTitle() instead.
 206 * jquery.ui.effect-bounce, jquery.ui.effect-explode, jquery.ui.effect-fold
 207   jquery.ui.effect-pulsate, jquery.ui.effect-slide, jquery.ui.effect-transfer,
 208   which are no longer used, have now been removed.
 209 * …
 210
 211 === Deprecations in 1.34 ===
 212 * The MWNamespace class is deprecated. Use NamespaceInfo.
 213 * ExtensionRegistry->load() is deprecated, as it breaks dependency checking.
 214   Instead, use ->queue().
 215 * User::isBlocked() is deprecated since it does not tell you if the user is
 216   blocked from editing a particular page. Use User::getBlock() or
 217   PermissionManager::isBlockedFrom() or PermissionManager::userCan() instead.
 218 * User::isLocallyBlockedProxy and User::inDnsBlacklist are deprecated and moved
 219   to the BlockManager as private helper methods.
 220 * User::isDnsBlacklisted is deprecated. Use BlockManager::isDnsBlacklisted
 221   instead.
 222 * The Config argument to ChangesListSpecialPage::checkStructuredFilterUiEnabled
 223   is deprecated. Pass only the User argument.
 224 * WatchedItem::getUser is deprecated. Use getUserIdentity.
 225 * Passing a Title as the first parameter to the getTimestampById method of
 226   RevisionStore is deprecated. Omit it, passing only the remaining parameters.
 227 * Title::getPreviousRevisionId and Title::getNextRevisionId are deprecated. Use
 228   RevisionLookup::getPreviousRevision and RevisionLookup::getNextRevision.
 229 * The Title parameter to RevisionLookup::getPreviousRevision and
 230   RevisionLookup::getNextRevision is deprecated and should be omitted.
 231 * MWHttpRequest::factory is deprecated. Use HttpRequestFactory.
 232 * The Http class is deprecated. For the request, get, and post methods, use
 233   HttpRequestFactory. For isValidURI, use MWHttpRequest::isValidURI.  For
 234   getProxy, use (string)$wgHTTPProxy. For createMultiClient, construct a
 235   MultiHttpClient directly.
 236 * Http::$httpEngine is deprecated and has no replacement. The default 'guzzle'
 237   engine will eventually be made the only engine for HTTP requests.
 238 * RepoGroup::singleton(), RepoGroup::destroySingleton(),
 239   RepoGroup::setSingleton(), wfFindFile(), and wfLocalFile() are all
 240   deprecated. Use MediaWikiServices instead.
 241 * The getSubjectPage, getTalkPage, and getOtherPage of Title are deprecated.
 242   Use NamespaceInfo's getSubjectPage, getTalkPage, and getAssociatedPage.
 243 * MWMessagePack class, no longer used, has been deprecated in 1.34.
 244 * The Block class is separated into DatabaseBlock (for blocks stored in the
 245   database), and SystemBlock (for temporary blocks created by the system).
 246   SystemBlock should be used when creating any temporary blocks. Block is
 247   a deprecated alias for DatabaseBlock.
 248 * Parser::$mConf is deprecated. It will be removed entirely in a later version.
 249   Some context can be found at T224165.
 250 * Constructing Parser directly is deprecated. Obtain one from ParserFactory.
 251 * Title::moveSubpages is deprecated. Use MovePage::moveSubpages or
 252   MovePage::moveSubpagesIfAllowed.
 253 * The MWNamespace class is deprecated. Use MediaWikiServices::getNamespaceInfo.
 254 * (T62260) Hard deprecate Language::getExtraUserToggles() method.
 255 * Language::viewPrevNext function is deprecated, use
 256   PrevNextNavigationRenderer::buildPrevNextNavigation instead
 257 * User::trackBlockWithCookie and DatabaseBlock::clearCookie are deprecated. Use
 258   BlockManager::trackBlockWithCookie and BlockManager::clearCookie instead.
 259 * DatabaseBlock::setCookie, DatabaseBlock::getCookieValue,
 260   DatabaseBlock::getIdFromCookieValue and AbstractBlock::shouldTrackWithCookie
 261   are moved to internal helper methods for BlockManager::trackBlockWithCookie.
 262 * ResourceLoaderContext::getConfig and ResourceLoaderContext::getLogger have
 263   been deprecated. Inside ResourceLoaderModule subclasses, use the local methods
 264   instead. Elsewhere, use the methods from the ResourceLoader class.
 265
 266 === Other changes in 1.34 ===
 267 * …
 268
 269 == Compatibility ==
 270 MediaWiki 1.34 requires PHP 7.0.13 or later. Although HHVM 3.18.5 or later is
 271 supported, it is generally advised to use PHP 7.0.13 or later for long term
 272 support.
 273
 274 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
 275 but support for them is somewhat less mature. There is experimental support for
 276 Oracle and Microsoft SQL Server.
 277
 278 The supported versions are:
 279
 280 * MySQL 5.5.8 or later
 281 * PostgreSQL 9.2 or later
 282 * SQLite 3.8.0 or later
 283 * Oracle 9.0.1 or later
 284 * Microsoft SQL Server 2005 (9.00.1399)
 285
 286 == Online documentation ==
 287 Documentation for both end-users and site administrators is available on
 288 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 289 for pages that explicitly state that their contents are in the public domain):
 290
 291        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 292
 293 == Mailing list ==
 294 A mailing list is available for MediaWiki user support and discussion:
 295
 296        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 297
 298 A low-traffic announcements-only list is also available:
 299
 300        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 301
 302 It's highly recommended that you sign up for one of these lists if you're
 303 going to run a public MediaWiki, so you can be notified of security fixes.
 304
 305 == IRC help ==
 306 There's usually someone online in #mediawiki on irc.freenode.net.