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 * $wgAllowAsyncCopyUploads and $CopyUploadAsyncTimeout were removed. This was an
  66   experimental feature that has never worked.
  67 * $wgEnotifUseJobQ was removed and the job queue is always used.
  68
  69 === New features in 1.27 ===
  70 * $wgDataCenterUpdateStickTTL was also added. This decides how long a user
  71   sticks to the primary DC (via cookies) after they make changes to the site.
  72 * Added a new hook, 'UserMailerTransformContent', to transform the contents
  73   of an email. This is similar to the EmailUser hook but applies to all mail
  74   sent via UserMailer.
  75 * Added a new hook, 'UserMailerTransformMessage', to transform the contents
  76   of an emai after MIME encoding.
  77 * Added a new hook, 'UserMailerSplitTo', to control which users have to be
  78   emailed separately (ie. there is a single address in the To: field) so
  79   user-specific changes to the email can be applied safely.
  80 * $wgCdnMaxageLagged was added, which limits the CDN cache TTL
  81   when any load balancer uses a DB that is lagged beyond the 'max lag'
  82   setting in the relevant section of $wgLBFactoryConf.
  83 * User::newSystemUser() may be used to simplify the creation of passwordless
  84   "system" users for logged actions from scripts and extensions.
  85 * Extensions can now return detailed error information via the API when
  86   preventing user actions using 'getUserPermissionsErrors' and similar hooks
  87   by using ApiMessage instances instead of strings for the $result value.
  88 * $wgAPIMaxLagThreshold was added to limit bot changes when databases lag
  89   becomes too high.
  90 * Skins and extensions can now use FlexBox mixins (.flex-display(@display: flex)
  91   and .flex(@grow: 1, @shrink: 1, @width: auto, @order: 1)) in Less to create
  92   cross-browser-compatible FlexBox rules. Users will still need to add fallback
  93   float rules or the like for compatibility with IE9- separately.
  94 * Added MWTimestamp::getTimezoneString() which returns the localized timezone
  95   string, if available. To localize this string, see the comments of
  96   $wgLocaltimezone in includes/DefaultSettings.php.
  97 * Added CentralIdLookup, a service that allows extensions needing a concept of
  98   "central" users to get that without having to know about specific central
  99   authentication extensions.
 100 * $wgMaxUserDBWriteDuration added to limit huge user-generated transactions.
 101   Regular web request transactions that takes longer than this are aborted.
 102 * Added a new hook, 'TitleMoveCompleting', which runs before a page move is
 103   committed.
 104 * $wgCdnReboundPurgeDelay was added to provide secondary delayed purges of URLs
 105   from CDN to mitigate DB replication lag and WAN cache purge lag.
 106 * (T49162) Installer will default to setting CACHE_ACCEL as the main cache type
 107   if it is available.
 108 * It is now possible to patrol file uploads (both for new files and new versions
 109   of existing files). Special:NewFiles has gained an option to filter by patrol
 110   status. This functionality can be disabled using $wgUseFilePatrol.
 111 * Added MWGrants and associated configuration settings $wgGrantPermissions and
 112   $wgGrantPermissionGroups to hold configuration for authentication features
 113   such as OAuth that want to allow restricting the user rights a user may make
 114   use of.
 115 ** If you're already using the OAuth extension, these new variables are
 116    identical to (and will replace) $wgMWOAuthGrantPermissions and
 117    $wgMWOAuthGrantPermissionGroups.
 118 * Added MWRestrictions as a class to check restrictions on a WebRequest, e.g.
 119   to assert that the request comes from a particular IP range.
 120 * Whitelisted the following HTML attributes for all elements in wikitext:
 121   aria-describedby, aria-flowto, aria-label, aria-labelledby, aria-owns.
 122 * Removed "presentation" restriction on the HTML role attribute in wikitext.
 123   All values are now allowed for the role attribute.
 124
 125 === External library changes in 1.27 ===
 126
 127 ==== Upgraded external libraries ====
 128 * Updated oojs/oojs-ui from v0.12.12 to v0.13.3.
 129 * Updated composer/semver from v1.0.0 to v1.2.0.
 130 * Update liuggio/statsd-php-client to 1.0.18.
 131
 132 ==== New external libraries ====
 133 * Added wikimedia/base-convert v1.0.1.
 134 * Added wikimedia/cldr-plural-rule-parser v1.0.0.
 135 * Added wikimedia/relpath v1.0.3.
 136 * Added wikimedia/running-stat v1.1.0.
 137
 138 ==== Removed and replaced external libraries ====
 139
 140 === Bug fixes in 1.27 ===
 141 * Special:Upload will now display correct maximum allowed file size when running
 142   under HHVM (T116347).
 143
 144 === Action API changes in 1.27 ===
 145 * Added list=allrevisions.
 146 * generator=recentchanges now has the option to generate revids.
 147 * ApiPageSet::setRedirectMergePolicy() was added. This allows generator
 148   modules to define how generator data for a redirect source gets merged
 149   into the redirect destination.
 150 * prop=imageinfo&iiprop=uploadwarning will no longer include the possibility of
 151   "was-deleted" warning.
 152 * Added difftotextpst to query=revisions which preforms a pre-save transform on
 153   the text before diffing it.
 154 * Deprecated formats dbg, txt, and yaml have been removed.
 155 * (T47988) The protect log event details now use new-style formatting.
 156 * The following response properties from action=login are deprecated, and may
 157   be removed in the future: lgtoken, cookieprefix, sessionid. Clients should
 158   handle cookies to properly manage session state.
 159 * action=upload no longer understands statuskey, asyncdownload or leavemessage.
 160
 161 === Action API internal changes in 1.27 ===
 162 * ApiQueryORM removed.
 163 * The following classes have been removed:
 164 ** ApiFormatDbg
 165 ** ApiFormatTxt
 166 ** ApiFormatYaml
 167 * ApiQueryBase::titleToKey(), ApiQueryBase::keyToTitle() and
 168   ApiQueryBase::keyPartToTitle() all removed (deprecated since 1.24).
 169 * ApiQueryBase::checkRowCount() was removed (deprecated since 1.24).
 170 * ApiQueryBase::getDirectionDescription() was removed (deprecated since 1.25).
 171 * ApiQuery::getModules() was removed (deprecated since 1.21).
 172 * ApiMain::getModules() was removed (deprecated since 1.21).
 173 * ApiBase::getVersion() was removed (deprecated since 1.21).
 174
 175 === Languages updated in 1.27 ===
 176
 177 MediaWiki supports over 350 languages. Many localisations are updated
 178 regularly. Below only new and removed languages are listed, as well as
 179 changes to languages because of Phabricator reports.
 180
 181 * (T113688) Change default numerals from Gurmukhi to Arabic for Punjabi locale.
 182
 183 === Other changes in 1.27 ===
 184 * ProfilerOutputUdp was removed. Note that there is a ProfilerOutputStats class.
 185 * WikiPage::doDeleteArticleReal() and WikiPage::doDeleteArticle() now
 186   ignore the 2nd and 3rd arguments (formerly $id and $commit).
 187 * Removed "loaderScripts" option from ResourceLoaderFileModule class.
 188 * Removed ORM-like wrapper added in 1.20.
 189 * LinkCache::getGoodLinks and LinkCache::getBadLinks were removed
 190   (deprecated in 1.26).
 191 * WikiPage::doQuickEdit() was removed (deprecated since 1.21).
 192 * Removed SiteObject and SiteArray classes (deprecated in 1.21).
 193 * MessageBlobStore::getInstance() was removed (deprecated since 1.25).
 194 * (T84937) Free external links ("autolinked" urls) will now be terminated
 195   by &nbsp; and HTML entity encodings of &nbsp, <, and >.
 196 * (T36948) The default file revert message's timestamp is now in
 197   $wgLocaltimezone, instead of UTC.
 198 * The default name of the 'suppress' group page has been changed from
 199   'Project:Oversight' to 'Project:Suppress'.
 200 * DatabaseBase::resultObject() is now protected (use outside Database classes
 201   not necessary since 1.11).
 202 * Calling ResourceLoaderFileModule::readStyleFiles() without a
 203   ResourceLoaderContext instance is deprecated.
 204 * ResourceLoader::getLessCompiler() now takes an optional parameter of
 205   additional LESS variables to set for the compiler.
 206 * wfBaseConvert() marked as deprecated, use Wikimedia\base_convert() directly
 207   instead.
 208 * Obsolete maintenance scripts clearCacheStats.php and showCacheStats.php
 209   were removed. The underlying data is sent to StatsD (see $wgStatsdServer).
 210 * Removed msg_resource_links database table and associated code.
 211 * Removed msg_resource database table and associated code.
 212 * Skin::getNamespaceNotice() was removed.
 213 * wfIsConfiguredProxy() was removed (deprecated since 1.24).
 214 * wfDebugTimer() was removed (deprecated since 1.25).
 215 * wfIsTrustedProxy() was removed (deprecated since 1.24).
 216 * wfGetIP() was removed (deprecated since 1.19).
 217 * MWHookException was removed.
 218 * OutputPage::appendSubtitle() was removed (deprecated since 1.19).
 219 * OutputPage::loginToUse() was removed (deprecated since 1.19).
 220 * Article::loadContent() was removed (deprecated since 1.19).
 221 * User::editToken() was removed (deprecated since 1.19).
 222 * Removed --force-normal option of dumpBackup.php, as it no longer served
 223   any useful purpose since 1.22.
 224 * The functions processOption() and processArgs() on the BackupDumper and
 225   TextPassDumper classes have been removed.
 226 * The maintenance/backupTextPass.inc file was deleted. You should include
 227   maintenance/dumpTextPass.php instead.
 228 * WikiPage::getUsedTemplates() was removed (deprecated since 1.19).
 229 * wfEmptyMsg() was removed (deprecated since 1.18).
 230 * OutputPage::permissionRequired() was removed (deprecated since 1.18).
 231 * OutputPage::blockedPage() was removed (deprecated since 1.18).
 232 * User::getSkin() was removed (deprecated since 1.18).
 233 * OutputPage::includeJQuery() was removed (deprecated since 1.17).
 234 * WikiPage::updateRestrictions() was removed (deprecated since 1.19).
 235 * WikiPage::testPreSaveTransform() was removed (deprecated since 1.19).
 236 * LogPage::logName() was removed (deprecated since 1.19).
 237 * LogPage::logHeader() was removed (deprecated since 1.19).
 238 * wfCheckLimits() was removed (deprecated since 1.24).
 239 * Linker::makeKnownLinkObj() was removed (deprecated since 1.16).
 240 * Linker::makeLinkObj() was removed (deprecated since 1.16).
 241 * wfMsgForContentNoTrans() was removed (deprecated since 1.18).
 242 * ChangesList::usePatrol was removed (deprecated since 1.22).
 243 * wfMsgNoTrans() was removed (deprecated since 1.18).
 244 * Linker::makeImageLink2 was removed (deprecated since 1.20).
 245 * Title::userIsWatching() was removed (deprecated since 1.20).
 246 * Removed WaitForSlave maintenance script; use SELECT MASTER_POS_WAIT()
 247   database function directly instead.
 248 * wfMsg() was removed (deprecated since 1.18).
 249 * wfMsgForContent() was removed (deprecated since 1.18).
 250 * wfMsgReal() was removed (deprecated since 1.18).
 251 * wfMsgGetKey() was removed (deprecated since 1.18).
 252 * wfMsgHtml() was removed (deprecated since 1.18).
 253 * wfMsgWikiHtml() was removed (deprecated since 1.18).
 254 * wfMsgExt() was removed (deprecated since 1.18).
 255 * Language::armourMath() was removed (deprecated since 1.22).
 256 * LanguageConverter::armourMath() was removed (deprecated since 1.22).
 257 * FakeConverter::armourMath() was removed (deprecated since 1.22).
 258 * The unused jquery.validate ResourceLoader module was removed.
 259 * FileRepo::getRootUrl() was removed (deprecated since 1.20).
 260 * User::generateToken() was removed (deprecated since 1.20).
 261 * WikiPage::getRawText() was removed (deprecated since 1.21).
 262 * ParserOutput::hasCustomDataUpdates() was removed (deprecated since 1.25).
 263 * ParserOutput::addSecondaryDataUpdate() was removed (deprecated since 1.25).
 264 * ParserOutput::getSecondaryDataUpdates() was removed (deprecated since 1.25).
 265 * Gallery images with multiple caption pipes no longer concatenate them all
 266   together but instead pick the final one, similar to image syntax.
 267 * XML-like parser tags (such as <gallery>), when unclosed, will be left unparsed
 268   rather than consume everything until the end of the page.
 269 * New maintenance script resetUserEmail.php allows sysadmins to reset user emails in case
 270   a user forgot password/account was stolen.
 271
 272 == Compatibility ==
 273
 274 MediaWiki 1.27 requires PHP 5.3.3 or later. There is experimental support for
 275 HHVM 3.6.5 or later.
 276
 277 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 278 support for them is somewhat less mature. There is experimental support for
 279 Oracle and Microsoft SQL Server.
 280
 281 The supported versions are:
 282
 283 * MySQL 5.0.3 or later
 284 * PostgreSQL 8.3 or later
 285 * SQLite 3.3.7 or later
 286 * Oracle 9.0.1 or later
 287 * Microsoft SQL Server 2005 (9.00.1399)
 288
 289 == Upgrading ==
 290
 291 1.27 has several database changes since 1.26, and will not work without schema
 292 updates. Note that due to changes to some very large tables like the revision
 293 table, the schema update may take quite long (minutes on a medium sized site,
 294 many hours on a large site).
 295
 296 If upgrading from before 1.11, and you are using a wiki as a commons
 297 repository, make sure that it is updated as well. Otherwise, errors may arise
 298 due to database schema changes.
 299
 300 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 301 new database fields are filled with data.
 302
 303 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 304 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 305 with MediaWiki 1.21.
 306
 307 Don't forget to always back up your database before upgrading!
 308
 309 See the file UPGRADE for more detailed upgrade instructions.
 310
 311 For notes on 1.26.x and older releases, see HISTORY.
 312
 313 == Online documentation ==
 314
 315 Documentation for both end-users and site administrators is available on
 316 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 317 for pages that explicitly state that their contents are in the public domain):
 318
 319        https://www.mediawiki.org/wiki/Documentation
 320
 321 == Mailing list ==
 322
 323 A mailing list is available for MediaWiki user support and discussion:
 324
 325        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 326
 327 A low-traffic announcements-only list is also available:
 328
 329        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 330
 331 It's highly recommended that you sign up for one of these lists if you're
 332 going to run a public MediaWiki, so you can be notified of security fixes.
 333
 334 == IRC help ==
 335
 336 There's usually someone online in #mediawiki on irc.freenode.net.