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