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