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 wikimedia/cldr-plural-rule-parser.
  57
  58 === New features in 1.27 ===
  59 * $wgDataCenterId and $wgDataCenterRoles where added, which will serve as
  60   basic configuration settings needed for multi-datacenter setups.
  61   $wgDataCenterUpdateStickTTL was also added.
  62 * Added a new hook, 'UserMailerTransformContent', to transform the contents
  63   of an email. This is similar to the EmailUser hook but applies to all mail
  64   sent via UserMailer.
  65 * Added a new hook, 'UserMailerTransformMessage', to transform the contents
  66   of an emai after MIME encoding.
  67 * Added a new hook, 'UserMailerSplitTo', to control which users have to be
  68   emailed separately (ie. there is a single address in the To: field) so
  69   user-specific changes to the email can be applied safely.
  70 * $wgCdnMaxageLagged was added, which limits the CDN cache TTL
  71   when any load balancer uses a DB that is lagged beyond the 'max lag'
  72   setting in the relevant section of $wgLBFactoryConf.
  73 * User::newSystemUser() may be used to simplify the creation of passwordless
  74   "system" users for logged actions from scripts and extensions.
  75 * Extensions can now return detailed error information via the API when
  76   preventing user actions using 'getUserPermissionsErrors' and similar hooks
  77   by using ApiMessage instances instead of strings for the $result value.
  78 * $wgAPIMaxLagThreshold was added to limit bot changes when databases lag
  79   becomes too high.
  80 * Skins and extensions can now use FlexBox mixins (.flex-display(@display: flex)
  81   and .flex(@grow: 1, @shrink: 1, @width: auto, @order: 1)) in Less to create
  82   cross-browser-compatible FlexBox rules. Users will still need to add fallback
  83   float rules or the like for compatibility with IE9- separately.
  84 * Added MWTimestamp::getTimezoneString() which returns the localized timezone
  85   string, if available. To localize this string, see the comments of
  86   $wgLocaltimezone in includes/DefaultSettings.php.
  87
  88 === External library changes in 1.27 ===
  89 ==== Upgraded external libraries ====
  90 * Updated oojs/oojs-ui from v0.12.12 to v0.13.3.
  91 * Updated composer/semver from v1.0.0 to v1.2.0.
  92 * Update liuggio/statsd-php-client to 1.0.18.
  93
  94 ==== New external libraries ====
  95 * Added wikimedia/base-convert v1.0.1.
  96 * Added wikimedia/cldr-plural-rule-parser v1.0.0.
  97 * Added wikimedia/relpath v1.0.3.
  98 * Added wikimedia/running-stat v1.1.0.
  99
 100 ==== Removed and replaced external libraries ====
 101
 102 === Bug fixes in 1.27 ===
 103 * Special:Upload will now display correct maximum allowed file size when running
 104   under HHVM (T116347).
 105
 106 === Action API changes in 1.27 ===
 107 * Added list=allrevisions.
 108 * generator=recentchanges now has the option to generate revids.
 109 * ApiPageSet::setRedirectMergePolicy() was added. This allows generator
 110   modules to define how generator data for a redirect source gets merged
 111   into the redirect destination.
 112 * prop=imageinfo&iiprop=uploadwarning will no longer include the possibility of
 113   "was-deleted" warning.
 114 * Added difftotextpst to query=revisions which preforms a pre-save transform on
 115   the text before diffing it.
 116 * Deprecated formats dbg, txt, and yaml have been removed.
 117 * (T47988) The protect log event details now use new-style formatting.
 118
 119 === Action API internal changes in 1.27 ===
 120 * ApiQueryORM removed.
 121 * The following classes have been removed:
 122 ** ApiFormatDbg
 123 ** ApiFormatTxt
 124 ** ApiFormatYaml
 125 * ApiQueryBase::getDirectionDescription is now marked as deprecated. It should
 126   have been so marked since 1.25 when ApiBase::getParamDescription was
 127   deprecated, but was overlooked at the time.
 128
 129 === Languages updated in 1.27 ===
 130
 131 MediaWiki supports over 350 languages. Many localisations are updated
 132 regularly. Below only new and removed languages are listed, as well as
 133 changes to languages because of Phabricator reports.
 134
 135 * (T113688) Change default numerals from Gurmukhi to Arabic for Punjabi locale.
 136
 137 === Other changes in 1.27 ===
 138 * ProfilerOutputUdp was removed. Note that there is a ProfilerOutputStats class.
 139 * WikiPage::doDeleteArticleReal() and WikiPage::doDeleteArticle() now
 140   ignore the 2nd and 3rd arguments (formerly $id and $commit).
 141 * Removed "loaderScripts" option from ResourceLoaderFileModule class.
 142 * Removed ORM-like wrapper added in 1.20.
 143 * LinkCache::getGoodLinks and LinkCache::getBadLinks were removed (deprecated in 1.26).
 144 * WikiPage::doQuickEdit() was removed (deprecated since 1.21).
 145 * Removed SiteObject and SiteArray classes (deprecated in 1.21).
 146 * MessageBlobStore::getInstance() was removed (deprecated since 1.25).
 147 * (T84937) Free external links ("autolinked" urls) will now be terminated
 148   by &nbsp; and HTML entity encodings of &nbsp, <, and >.
 149 * (T36948) The default file revert message's timestamp is now in $wgLocaltimezone,
 150   instead of UTC.
 151 * The default name of the 'suppress' group page has been changed from
 152   'Project:Oversight' to 'Project:Suppress'.
 153 * DatabaseBase::resultObject() is now protected (use outside Database classes
 154   not necessary since 1.11).
 155 * Calling ResourceLoaderFileModule::readStyleFiles() without a
 156   ResourceLoaderContext instance is deprecated.
 157 * ResourceLoader::getLessCompiler() now takes an optional parameter of
 158   additional LESS variables to set for the compiler.
 159 * wfBaseConvert() marked as deprecated, use Wikimedia\base_convert() directly instead.
 160
 161 == Compatibility ==
 162
 163 MediaWiki 1.27 requires PHP 5.3.3 or later. There is experimental support for
 164 HHVM 3.3.0.
 165
 166 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 167 support for them is somewhat less mature. There is experimental support for
 168 Oracle and Microsoft SQL Server.
 169
 170 The supported versions are:
 171
 172 * MySQL 5.0.3 or later
 173 * PostgreSQL 8.3 or later
 174 * SQLite 3.3.7 or later
 175 * Oracle 9.0.1 or later
 176 * Microsoft SQL Server 2005 (9.00.1399)
 177
 178 == Upgrading ==
 179
 180 1.27 has several database changes since 1.26, and will not work without schema
 181 updates. Note that due to changes to some very large tables like the revision
 182 table, the schema update may take quite long (minutes on a medium sized site,
 183 many hours on a large site).
 184
 185 If upgrading from before 1.11, and you are using a wiki as a commons
 186 repository, make sure that it is updated as well. Otherwise, errors may arise
 187 due to database schema changes.
 188
 189 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 190 new database fields are filled with data.
 191
 192 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 193 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 194 with MediaWiki 1.21.
 195
 196 Don't forget to always back up your database before upgrading!
 197
 198 See the file UPGRADE for more detailed upgrade instructions.
 199
 200 For notes on 1.26.x and older releases, see HISTORY.
 201
 202 == Online documentation ==
 203
 204 Documentation for both end-users and site administrators is available on
 205 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 206 for pages that explicitly state that their contents are in the public domain):
 207
 208        https://www.mediawiki.org/wiki/Documentation
 209
 210 == Mailing list ==
 211
 212 A mailing list is available for MediaWiki user support and discussion:
 213
 214        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 215
 216 A low-traffic announcements-only list is also available:
 217
 218        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 219
 220 It's highly recommended that you sign up for one of these lists if you're
 221 going to run a public MediaWiki, so you can be notified of security fixes.
 222
 223 == IRC help ==
 224
 225 There's usually someone online in #mediawiki on irc.freenode.net.