RELEASE-NOTES-1.27

   1 Security reminder: If you have PHP's register_globals option set, you must
   2 turn it off. MediaWiki will not work with it enabled.
   3
   4 == MediaWiki 1.27 ==
   5
   6 THIS IS NOT A RELEASE YET
   7
   8 MediaWiki 1.27 is an alpha-quality branch and is not recommended for use in
   9 production.
  10
  11 === Configuration changes in 1.27 ===
  12 * $wgUseLinkNamespaceDBFields was removed.
  13 * Deprecated $wgResourceLoaderMinifierStatementsOnOwnLine and
  14   $wgResourceLoaderMinifierMaxLineLength, because there was little value in
  15   making the behavior configurable. The default values (`false` for the former,
  16   1000 for the latter) are now hard-coded.
  17 * $wgDebugDumpSqlLength was removed (deprecated in 1.24).
  18 * $wgDebugDBTransactions was removed (deprecated in 1.20).
  19 * $wgUseXVO has been removed, as it provides functionality only used by
  20   custom Wikimedia patches against Squid 2.x that probably noone uses in
  21   production anymore. There is now $wgUseKeyHeader that provides similar
  22   functionality but instead of the MediaWiki-specific X-Vary-Options header,
  23   uses the draft Key header standard.
  24 * $wgScriptExtension (and support for '.php5' entry points) was removed. See the
  25   deprecation notice in the release notes for version 1.25 for advice on how to
  26   preserve support for '.php5' entry points via URL rewriting.
  27 * Password handling via the User object has been deprecated and partially
  28   removed, pending the future introduction of AuthManager. In particular:
  29 ** expirePassword(), getPasswordExpireDate(), resetPasswordExpiration(), and
  30    getPasswordExpired() have been removed. They were unused outside of core.
  31 ** The mPassword, mNewpassword, mNewpassTime, and mPasswordExpires fields are
  32    now private and will be removed in the future.
  33 ** The getPassword() and getTemporaryPassword() methods now throw
  34    BadMethodCallException and will be removed in the future.
  35 ** The ability to pass 'password' and 'newpassword' to createNew() has been
  36    removed. The only users of it seem to have been using it to set invalid
  37    passwords, and so shouldn't be greatly affected.
  38 ** setPassword(), setInternalPassword(), and setNewpassword() have been
  39    deprecated, pending the introduction of AuthManager.
  40 ** User::randomPassword() is deprecated in favor of a new method
  41    PasswordFactory::generateRandomPasswordString()
  42 ** User::getPasswordFactory() is deprecated, callers should just create a
  43    PasswordFactory themselves.
  44 ** A new constructor, User::newSystemUser(), has been added to simplify the
  45    creation of passwordless "system" users for logged actions.
  46 * $wgMaxSquidPurgeTitles was removed.
  47 * $wgAjaxWatch was removed. This is now enabled by default.
  48 * $wgUseInstantCommons now hotlinks Commons images by default instead of
  49   downloading originals and thumbnailing them locally. This allows wikis to save
  50   on CPU and bandwidth while reducing time to first byte for pages, even without
  51   a thumbnail handler. See $wgForeignFileRepos documentation for tweaks.
  52 * (T27397) WebP is enabled by default as an uploadable filetype.
  53 * (T48998) $wgArticlePath must now be either a full url, or start with a "/".
  54 * $wgRateLimitLog was removed; use $wgDebugLogGroups['ratelimit'] instead.
  55 * Deprecated API formats dbg, txt, and yaml have been removed.
  56 * CLDRPluralRule* classes have been replaced with
  57   wikimedia/cldr-plural-rule-parser.
  58 * Removed $wgProfilePerHost, $wgUDPProfilerHost, $wgUDPProfilerPort,
  59   $wgUDPProfilerFormatString, $wgStatsMethod, $wgAggregateStatsID,
  60   $wgStatsFormatString, and $wgProfileCallTree (deprecated since 1.20).
  61 * For proper operation of LocalIdLookup with shared user tables, ensure that
  62   $wgSharedDB and $wgSharedTables are properly set even on the "central" wiki
  63   that all others are sharing from and that $wgLocalDatabases is set to the
  64   full list of sharing wikis on all those wikis.
  65
  66 === New features in 1.27 ===
  67 * $wgDataCenterId and $wgDataCenterRoles where added, which will serve as
  68   basic configuration settings needed for multi-datacenter setups.
  69   $wgDataCenterUpdateStickTTL was also added.
  70 * Added a new hook, 'UserMailerTransformContent', to transform the contents
  71   of an email. This is similar to the EmailUser hook but applies to all mail
  72   sent via UserMailer.
  73 * Added a new hook, 'UserMailerTransformMessage', to transform the contents
  74   of an emai after MIME encoding.
  75 * Added a new hook, 'UserMailerSplitTo', to control which users have to be
  76   emailed separately (ie. there is a single address in the To: field) so
  77   user-specific changes to the email can be applied safely.
  78 * $wgCdnMaxageLagged was added, which limits the CDN cache TTL
  79   when any load balancer uses a DB that is lagged beyond the 'max lag'
  80   setting in the relevant section of $wgLBFactoryConf.
  81 * User::newSystemUser() may be used to simplify the creation of passwordless
  82   "system" users for logged actions from scripts and extensions.
  83 * Extensions can now return detailed error information via the API when
  84   preventing user actions using 'getUserPermissionsErrors' and similar hooks
  85   by using ApiMessage instances instead of strings for the $result value.
  86 * $wgAPIMaxLagThreshold was added to limit bot changes when databases lag
  87   becomes too high.
  88 * Skins and extensions can now use FlexBox mixins (.flex-display(@display: flex)
  89   and .flex(@grow: 1, @shrink: 1, @width: auto, @order: 1)) in Less to create
  90   cross-browser-compatible FlexBox rules. Users will still need to add fallback
  91   float rules or the like for compatibility with IE9- separately.
  92 * Added MWTimestamp::getTimezoneString() which returns the localized timezone
  93   string, if available. To localize this string, see the comments of
  94   $wgLocaltimezone in includes/DefaultSettings.php.
  95 * Added CentralIdLookup, a service that allows extensions needing a concept of
  96   "central" users to get that without having to know about specific central
  97   authentication extensions.
  98 * $wgMaxUserDBWriteDuration added to limit huge user-generated transactions.
  99   Regular web request transactions that takes longer than this are aborted.
 100 * Added a new hook, 'TitleMoveCompleting', which runs before a page move is
 101   committed.
 102 * $wgCdnReboundPurgeDelay was added to provide secondary delayed purges of URLs
 103   from CDN to mitigate DB replication lag and WAN cache purge lag.
 104 * (T49162) Installer will default to setting CACHE_ACCEL as the main cache type
 105   if it is available.
 106 * It is now possible to patrol file uploads (both for new files and new versions
 107   of existing files). Special:NewFiles has gained an option to filter by patrol
 108   status. This functionality can be disabled using $wgUseFilePatrol.
 109
 110 === External library changes in 1.27 ===
 111
 112 ==== Upgraded external libraries ====
 113 * Updated oojs/oojs-ui from v0.12.12 to v0.13.3.
 114 * Updated composer/semver from v1.0.0 to v1.2.0.
 115 * Update liuggio/statsd-php-client to 1.0.18.
 116
 117 ==== New external libraries ====
 118 * Added wikimedia/base-convert v1.0.1.
 119 * Added wikimedia/cldr-plural-rule-parser v1.0.0.
 120 * Added wikimedia/relpath v1.0.3.
 121 * Added wikimedia/running-stat v1.1.0.
 122
 123 ==== Removed and replaced external libraries ====
 124
 125 === Bug fixes in 1.27 ===
 126 * Special:Upload will now display correct maximum allowed file size when running
 127   under HHVM (T116347).
 128
 129 === Action API changes in 1.27 ===
 130 * Added list=allrevisions.
 131 * generator=recentchanges now has the option to generate revids.
 132 * ApiPageSet::setRedirectMergePolicy() was added. This allows generator
 133   modules to define how generator data for a redirect source gets merged
 134   into the redirect destination.
 135 * prop=imageinfo&iiprop=uploadwarning will no longer include the possibility of
 136   "was-deleted" warning.
 137 * Added difftotextpst to query=revisions which preforms a pre-save transform on
 138   the text before diffing it.
 139 * Deprecated formats dbg, txt, and yaml have been removed.
 140 * (T47988) The protect log event details now use new-style formatting.
 141 * The following response properties from action=login are deprecated, and may
 142   be removed in the future: lgtoken, cookieprefix, sessionid. Clients should
 143   handle cookies to properly manage session state.
 144
 145 === Action API internal changes in 1.27 ===
 146 * ApiQueryORM removed.
 147 * The following classes have been removed:
 148 ** ApiFormatDbg
 149 ** ApiFormatTxt
 150 ** ApiFormatYaml
 151 * ApiQueryBase::titleToKey(), ApiQueryBase::keyToTitle() and
 152   ApiQueryBase::keyPartToTitle() all removed (deprecated since 1.24).
 153 * ApiQueryBase::checkRowCount() was removed (deprecated since 1.24).
 154 * ApiQueryBase::getDirectionDescription() was removed (deprecated since 1.25).
 155 * ApiQuery::getModules() was removed (deprecated since 1.21).
 156 * ApiMain::getModules() was removed (deprecated since 1.21).
 157
 158 === Languages updated in 1.27 ===
 159
 160 MediaWiki supports over 350 languages. Many localisations are updated
 161 regularly. Below only new and removed languages are listed, as well as
 162 changes to languages because of Phabricator reports.
 163
 164 * (T113688) Change default numerals from Gurmukhi to Arabic for Punjabi locale.
 165
 166 === Other changes in 1.27 ===
 167 * ProfilerOutputUdp was removed. Note that there is a ProfilerOutputStats class.
 168 * WikiPage::doDeleteArticleReal() and WikiPage::doDeleteArticle() now
 169   ignore the 2nd and 3rd arguments (formerly $id and $commit).
 170 * Removed "loaderScripts" option from ResourceLoaderFileModule class.
 171 * Removed ORM-like wrapper added in 1.20.
 172 * LinkCache::getGoodLinks and LinkCache::getBadLinks were removed
 173   (deprecated in 1.26).
 174 * WikiPage::doQuickEdit() was removed (deprecated since 1.21).
 175 * Removed SiteObject and SiteArray classes (deprecated in 1.21).
 176 * MessageBlobStore::getInstance() was removed (deprecated since 1.25).
 177 * (T84937) Free external links ("autolinked" urls) will now be terminated
 178   by &nbsp; and HTML entity encodings of &nbsp, <, and >.
 179 * (T36948) The default file revert message's timestamp is now in
 180   $wgLocaltimezone, instead of UTC.
 181 * The default name of the 'suppress' group page has been changed from
 182   'Project:Oversight' to 'Project:Suppress'.
 183 * DatabaseBase::resultObject() is now protected (use outside Database classes
 184   not necessary since 1.11).
 185 * Calling ResourceLoaderFileModule::readStyleFiles() without a
 186   ResourceLoaderContext instance is deprecated.
 187 * ResourceLoader::getLessCompiler() now takes an optional parameter of
 188   additional LESS variables to set for the compiler.
 189 * wfBaseConvert() marked as deprecated, use Wikimedia\base_convert() directly
 190   instead.
 191 * Obsolete maintenance scripts clearCacheStats.php and showCacheStats.php
 192   were removed. The underlying data is sent to StatsD (see $wgStatsdServer).
 193 * Removed msg_resource_links database table and associated code.
 194 * Removed msg_resource database table and associated code.
 195 * Skin::getNamespaceNotice() was removed.
 196 * wfIsConfiguredProxy() was removed (deprecated since 1.24).
 197 * wfDebugTimer() was removed (deprecated since 1.25).
 198 * wfIsTrustedProxy() was removed (deprecated since 1.24).
 199 * wfGetIP() was removed (deprecated since 1.19).
 200 * MWHookException was removed.
 201 * OutputPage::appendSubtitle() was removed (deprecated since 1.19).
 202 * OutputPage::loginToUse() was removed (deprecated since 1.19).
 203 * Article::loadContent() was removed (deprecated since 1.19).
 204 * User::editToken() was removed (deprecated since 1.19).
 205 * Removed --force-normal option of dumpBackup.php, as it no longer served
 206   any useful purpose since 1.22.
 207 * The functions processOption() and processArgs() on the BackupDumper and
 208   TextPassDumper classes have been removed.
 209 * The maintenance/backupTextPass.inc file was deleted. You should include
 210   maintenance/dumpTextPass.php instead.
 211 * WikiPage::getUsedTemplates() was removed (deprecated since 1.19).
 212 * wfEmptyMsg() was removed (deprecated since 1.18).
 213 * OutputPage::permissionRequired() was removed (deprecated since 1.18).
 214 * OutputPage::blockedPage() was removed (deprecated since 1.18).
 215 * User::getSkin() was removed (deprecated since 1.18).
 216 * OutputPage::includeJQuery() was removed (deprecated since 1.17).
 217 * WikiPage::updateRestrictions() was removed (deprecated since 1.19).
 218 * WikiPage::testPreSaveTransform() was removed (deprecated since 1.19).
 219 * LogPage::logName() was removed (deprecated since 1.19).
 220 * LogPage::logHeader() was removed (deprecated since 1.19).
 221 * wfCheckLimits() was removed (deprecated since 1.24).
 222 * Linker::makeKnownLinkObj() was removed (deprecated since 1.16).
 223 * Linker::makeLinkObj() was removed (deprecated since 1.16).
 224 * wfMsgForContentNoTrans() was removed (deprecated since 1.18).
 225 * ChangesList::usePatrol was removed (deprecated since 1.22).
 226 * wfMsgNoTrans() was removed (deprecated since 1.18).
 227 * Linker::makeImageLink2 was removed (deprecated since 1.20).
 228 * Title::userIsWatching() was removed (deprecated since 1.20).
 229 * Removed WaitForSlave maintenance script; use SELECT MASTER_POS_WAIT()
 230   database function directly instead.
 231 * wfMsg() was removed (deprecated since 1.18).
 232 * wfMsgForContent() was removed (deprecated since 1.18).
 233 * wfMsgReal() was removed (deprecated since 1.18).
 234 * wfMsgGetKey() was removed (deprecated since 1.18).
 235 * wfMsgHtml() was removed (deprecated since 1.18).
 236 * wfMsgWikiHtml() was removed (deprecated since 1.18).
 237 * wfMsgExt() was removed (deprecated since 1.18).
 238 * Language::armourMath() was removed (deprecated since 1.22).
 239 * LanguageConverter::armourMath() was removed (deprecated since 1.22).
 240 * FakeConverter::armourMath() was removed (deprecated since 1.22).
 241 * The unused jquery.validate ResourceLoader module was removed.
 242
 243 == Compatibility ==
 244
 245 MediaWiki 1.27 requires PHP 5.3.3 or later. There is experimental support for
 246 HHVM 3.3.0.
 247
 248 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 249 support for them is somewhat less mature. There is experimental support for
 250 Oracle and Microsoft SQL Server.
 251
 252 The supported versions are:
 253
 254 * MySQL 5.0.3 or later
 255 * PostgreSQL 8.3 or later
 256 * SQLite 3.3.7 or later
 257 * Oracle 9.0.1 or later
 258 * Microsoft SQL Server 2005 (9.00.1399)
 259
 260 == Upgrading ==
 261
 262 1.27 has several database changes since 1.26, and will not work without schema
 263 updates. Note that due to changes to some very large tables like the revision
 264 table, the schema update may take quite long (minutes on a medium sized site,
 265 many hours on a large site).
 266
 267 If upgrading from before 1.11, and you are using a wiki as a commons
 268 repository, make sure that it is updated as well. Otherwise, errors may arise
 269 due to database schema changes.
 270
 271 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 272 new database fields are filled with data.
 273
 274 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 275 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 276 with MediaWiki 1.21.
 277
 278 Don't forget to always back up your database before upgrading!
 279
 280 See the file UPGRADE for more detailed upgrade instructions.
 281
 282 For notes on 1.26.x and older releases, see HISTORY.
 283
 284 == Online documentation ==
 285
 286 Documentation for both end-users and site administrators is available on
 287 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 288 for pages that explicitly state that their contents are in the public domain):
 289
 290        https://www.mediawiki.org/wiki/Documentation
 291
 292 == Mailing list ==
 293
 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
 307 There's usually someone online in #mediawiki on irc.freenode.net.