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