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