RELEASE-NOTES-1.28

   1 == MediaWiki 1.28 ==
   2
   3 THIS IS NOT A RELEASE YET
   4
   5 MediaWiki 1.28 is an alpha-quality branch and is not recommended for use in
   6 production.
   7
   8 === Configuration changes in 1.28 ===
   9 * BREAKING CHANGE: $wgHTTPProxy is now *required* for all external requests
  10   made by MediaWiki via a proxy. Relying on the http_proxy environment
  11   variable is no longer supported.
  12 * The load.php entry point now enforces the existing policy of not allowing
  13   access to session data, which includes the session user and the session
  14   user's language. If such access is attempted, an exception will be thrown.
  15 * The number of internal PBKDF2 iterations used to derive the session secret
  16   is configurable via $wgSessionPbkdf2Iterations.
  17 * Upload dialog's file upload log comment can now be configured separately for
  18   local and foreign uploads.
  19 * $wgForeignUploadTargets now defaults to `[ 'local' ]`, where `'local'`
  20   signifies local uploads. A value of `[]` (empty array) now means that
  21   no upload targets are allowed, effectively disabling the upload dialog.
  22 * The deprecated $wgEditEncoding variable has been removed; it was only used
  23   for Esperanto language character conversion. You are now recommended to use
  24   input methods provided by the UniversalLanguageSelector extension.
  25 * When $wgPingback is true, MediaWiki will periodically ping
  26   https://www.mediawiki.org/beacon with basic information about the local
  27   MediaWiki installation. This data includes, for example, the type of system,
  28   PHP version, and chosen database backend. This behavior is off by default.
  29 * When $wgEditSubmitButtonLabelPublish is true, MediaWiki will label the button
  30   to store-to-database-and-show-to-others as "Publish page"/"Publish changes";
  31   if false, the default, they will be "Save page"/"Save changes".
  32 * The 'editcontentmodel' permission is now granted to all logged-in users ('user').
  33   instead of just administrators ('sysop'). Documentation for this feature is
  34   available at <https://www.mediawiki.org/wiki/Help:ChangeContentModel>.
  35 * $wgRevisionCacheExpiry is now set to one week by default instead of being disabled.
  36
  37 === New features in 1.28 ===
  38 * User::isBot() method for checking if an account is a bot role account.
  39 * Added a new 'slideshow' mode for galleries.
  40 * Added a new hook, 'UserIsBot', to aid in determining if a user is a bot.
  41 * Added a new hook, 'ApiMakeParserOptions', to allow extensions to better
  42   interact with API parsing.
  43 * Added a new hook, 'UploadVerifyUpload', which can be used to reject a file
  44   upload. Unlike 'UploadVerifyFile' it provides information about upload comment
  45   and the file description page, but does not run for uploads to stash.
  46 * (T141604) Extensions can now provide a better error message when their
  47   maintenance scripts are run without the extension being installed.
  48 * (T8948) Numeric sorting in categories is now supported by setting $wgCategoryCollation
  49   to 'uca-default-u-kn' or 'uca-<langcode>-u-kn'. If you can't use UCA collations,
  50   a 'numeric' collation is also available. If migrating from another
  51   collation, you will need to run the updateCollation.php maintenance script.
  52 * Two new codes have been added to #time parser function: "xit" for days in current
  53   month, and "xiz" for days passed in the year, both in Iranian calendar.
  54 * mw.Api has a new option, useUS, to use U+001F (Unit Separator) when
  55   appropriate for sending multi-valued parameters. This defaults to true when
  56   the mw.Api instance seems to be for the local wiki.
  57 * After a client performs an action which alters a database that has replica databases,
  58   MediaWiki will wait for the replica databases to synchronize with the master database
  59   while it renders the HTML output. However, if the output is a redirect to another wiki
  60   on the wiki farm with a different domain, MediaWiki will instead alter the redirect
  61   URL to include a ?cpPosTime parameter that triggers the database synchronization when
  62   the URL is followed by the client. The same-domain case uses a new cpPosTime cookie.
  63
  64 === External library changes in 1.28 ===
  65
  66 ==== Upgraded external libraries ====
  67 * Updated es5-shim from v4.1.5 to v4.5.8
  68
  69 ==== New external libraries ====
  70 * Added wikimedia/scoped-callback v1.0.0
  71
  72 ==== Removed and replaced external libraries ====
  73
  74 === Bug fixes in 1.28 ===
  75 * (T137264) SECURITY: XSS in unclosed internal links
  76 * (T133147) SECURITY: Escape '<' and ']]>' in inline <style> blocks
  77 * (T133147) SECURITY: Require login to preview user CSS pages
  78 * (T132926) SECURITY: Do not allow undeleting a revision deleted file if it is
  79   the top file
  80 * (T129738) SECURITY: Make $wgBlockDisablesLogin also restrict logged in
  81   permissions
  82 * (T129738) SECURITY: Make blocks log users out if $wgBlockDisablesLogin is true
  83 * (T139670) Move 'UserGetRights' call before application of
  84   Session::getAllowedUserRights()
  85
  86 === Action API changes in 1.28 ===
  87 * Added 'maxarticlesize' property to action=query&meta=siteinfo which contains
  88   the value of $wgMaxArticleSize.
  89 * Property 'modulemessages' from action=parse&prop=modules was removed
  90   (deprecated since 1.26).
  91 * The following response properties from action=login, deprecated in 1.27, are
  92   now removed: lgtoken, cookieprefix, sessionid. Clients should handle cookies
  93   to properly manage session state.
  94 * Submitting the lgtoken and lgpassword parameters in the query string to
  95   action=login is now deprecated and outputs a warning. They should be submitted
  96   in the POST body instead.
  97 * Submitting sensitive authentication request parameters to action=clientlogin,
  98   action=createaccount, action=linkaccount, and action=changeauthenticationdata
  99   in the query string is now deprecated and outputs a warning. They should be
 100   submitted in the POST body instead.
 101 * (T141960) Multi-valued parameters may now be separated using U+001F (Unit Separator)
 102   instead of the pipe character. This will be useful if some of the multiple
 103   values need to contain pipes, e.g. for action=options.
 104 * The API will now warn if input is not NFC-normalized Unicode or if it
 105   contains invalid characters.
 106 * The 'normalized' list output by action=query and other modules that use
 107   ApiPageSet may contain entries where the 'from' value is percent-encoded as
 108   the raw value cannot be represented in a valid API response. These are
 109   indicated by a 'fromencoded' boolean alongside the existing 'from' parameter.
 110 * (T28680) action=paraminfo can now return info about all submodules of a
 111   module without listing them all explicitly.
 112
 113 === Action API internal changes in 1.28 ===
 114 * Added a new hook, 'ApiMakeParserOptions', to allow extensions to better
 115   interact with ApiParse and ApiExpandTemplates.
 116 * (T139565) SECURITY: API: Generate head items in the context of the given title
 117 * (T115333) SECURITY: Check read permission when loading page content in ApiParse
 118 * ApiBase::makeHelpArrayToString() was removed (deprecated since 1.25)
 119 * ApiBase::makeHelpMsgParameters() was removed (deprecated since 1.25)
 120 * ApiBase::makeHelpMsg() was removed (deprecated since 1.25)
 121 * ApiFormatBase::formatHTML() was removed (deprecated since 1.25)
 122 * ApiFormatBase::getNeedsRawData() was removed (deprecated since 1.25)
 123 * ApiFormatBase::getWantsHelp() was removed (deprecated since 1.25)
 124 * ApiFormatBase::setBufferResult() was removed (deprecated since 1.25)
 125 * ApiFormatBase::setHelp() was removed (deprecated since 1.25)
 126 * ApiFormatBase::setUnescapeAmps() was removed (deprecated since 1.25)
 127 * ApiMain::makeHelpMsgHeader() was removed (deprecated since 1.25)
 128 * ApiMain::reallyMakeHelpMsg() was removed (deprecated since 1.25)
 129 * ApiMain::setHelp() was removed (deprecated since 1.25)
 130 * ApiResult::beginContinuation() was removed (deprecated since 1.25)
 131 * ApiResult::cleanUpUTF8() was removed (deprecated since 1.25)
 132 * ApiResult::convertStatusToArray() was removed (deprecated since 1.25)
 133 * ApiResult::disableSizeCheck() was removed (deprecated since 1.24)
 134 * ApiResult::enableSizeCheck() was removed (deprecated since 1.24)
 135 * ApiResult::endContinuation() was removed (deprecated since 1.25)
 136 * ApiResult::getData() was removed (deprecated since 1.25)
 137 * ApiResult::getIsRawMode() was removed (deprecated since 1.25)
 138 * ApiResult::setContent() was removed (deprecated since 1.25)
 139 * ApiResult::setContinueParam() was removed (deprecated since 1.25)
 140 * ApiResult::setElement() was removed (deprecated since 1.25)
 141 * ApiResult::setGeneratorContinueParam() was removed (deprecated since 1.25)
 142 * ApiResult::setIndexedTagName_internal() was removed (deprecated since 1.25)
 143 * ApiResult::setIndexedTagName_recursive() was removed (deprecated since 1.25)
 144 * ApiResult::setMainForContinuation() was removed (deprecated since 1.25)
 145 * ApiResult::setParsedLimit() was removed (deprecated since 1.25)
 146 * ApiResult::setRawMode() was removed (deprecated since 1.25)
 147 * ApiResult::size() was removed (deprecated since 1.25)
 148
 149 === Languages updated in 1.28 ===
 150
 151 MediaWiki supports over 350 languages. Many localisations are updated
 152 regularly. Below only new and removed languages are listed, as well as
 153 changes to languages because of Phabricator reports.
 154
 155 * (T137411) ban (Balinese), thanks to translators Adi Mayndra, Andru,
 156   BASAbali, M. Adiputra, Naval Scene, Nemo bis, NoiX180, and 아라.
 157 * (T135867) shn (Shan), thanks to translators Khun Sar, Piangpha,
 158   Saiddzone Saimawnkham, Saosukham, and Sengwan.
 159 * Czech (cs) and Slovak (sk) set as reciprocal fallbacks
 160
 161 === Other changes in 1.28 ===
 162 * (T128697) Improved handling of large diffs.
 163 * [BREAKING CHANGE] $wgExtendedLoginCookies has been removed. You can
 164   use or update a custom session provider if needed.
 165 * Deprecated APIEditBeforeSave hook in favor of EditFilterMergedContent.
 166 * The 'UploadVerification' hook is deprecated. Use 'UploadVerifyFile' instead.
 167 * SiteConfiguration::isLocalVHost() was removed (deprecated since 1.25).
 168 * The 'UserLoginComplete' hook has a new parameter to differentiate between actual
 169   login and visiting the login page while already logged in.
 170 * ResourceLoader::makeLoaderURL() was removed (deprecated since 1.24).
 171 * $.fn.liveAndTestAtStart was removed (deprecated since 1.24).
 172 * mw.util.tooltipAccessKeyPrefix was removed (deprecated since 1.24).
 173 * mw.util.tooltipAccessKeyRegexp was removed (deprecated since 1.24).
 174 * Linker::link() and Linker::linkKnown() were deprecated; please instead use
 175   MediaWiki\Linker\LinkRenderer. In addition, the LinkBegin and LinkEnd hooks
 176   were replaced by HtmlPageLinkRendererBegin and HtmlPageLinkRendererEnd
 177   respectively. See docs/hooks.txt for the specific changes needed for those hooks.
 178 * Linker::formatSize() was deprecated. Use Language::formatSize() directly.
 179 * Aliases for Linker methods, deprecated since 1.21, were removed from Skin:
 180   * Skin::commentBlock() (use Linker::commentBlock() instead)
 181   * Skin::generateRollback() (use Linker::generateRollback() instead)
 182   * Skin::link() (use MediaWiki\Linker\LinkRenderer instead)
 183   * Skin::linkKnown() (use MediaWiki\Linker\LinkRenderer instead)
 184   * Skin::userLink() (use Linker::userLink() instead)
 185   * Skin::userToolLinks() (use Linker::userToolLinks() instead)
 186 * The 'ParserLimitReportFormat' hook was removed.
 187 * Disabled "bug 2702" HTML tidying of parsed UI messages on wikis where Tidy is
 188   disabled.
 189 * DifferenceEngine::generateDiffBody() was removed (deprecated since 1.21).
 190 * UploadBase::stashFileGetKey() and UploadBase::stashSession() were deprecated.
 191   Use ...->stashFile()->getFileKey() instead.
 192 * "Public domain" was removed as a wiki license option from the installer, in
 193   favour of CC-0.
 194 * AuthenticationRequest::$required is now changed from REQUIRED to PRIMARY_REQUIRED
 195   on requests needed by primary providers even if all primaries need them.
 196   Primary providers are discouraged from returning multiple REQUIRED requests.
 197 * OOjs UI PHP widgets constructed with the `'infusable' => true` config option
 198   will no longer be automatically infused. You should call `OO.ui.infuse()`
 199   on them yourself from your JavaScript code.
 200 * parserTests.php has moved to tests/parser/parserTests.php
 201 * The command line options specific to parser tests have been removed from
 202   phpunit.php: --regex and --keep-uploads. Instead of --regex, use --filter.
 203   Instead of --keep-uploads, use the same option to parserTests.php, but you
 204   must specify a directory with --upload-dir.
 205 * The 'jquery.arrowSteps' ResourceLoader module is now deprecated.
 206 * IP::isConfiguredProxy() and IP::isTrustedProxy() were removed. Callers should
 207   migrate to using the same functions on a ProxyLookup instance, obtainable from
 208   MediaWikiServices.
 209
 210 == Compatibility ==
 211
 212 MediaWiki 1.28 requires PHP 5.5.9 or later. There is experimental support for
 213 HHVM 3.6.5 or later.
 214
 215 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 216 support for them is somewhat less mature. There is experimental support for
 217 Oracle and Microsoft SQL Server.
 218
 219 The supported versions are:
 220
 221 * MySQL 5.0.3 or later
 222 * PostgreSQL 8.3 or later
 223 * SQLite 3.3.7 or later
 224 * Oracle 9.0.1 or later
 225 * Microsoft SQL Server 2005 (9.00.1399)
 226
 227 == Upgrading ==
 228
 229 1.28 has several database changes since 1.27, and will not work without schema
 230 updates. Note that due to changes to some very large tables like the revision
 231 table, the schema update may take quite long (minutes on a medium sized site,
 232 many hours on a large site).
 233
 234 If upgrading from before 1.11, and you are using a wiki as a commons
 235 repository, make sure that it is updated as well. Otherwise, errors may arise
 236 due to database schema changes.
 237
 238 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 239 new database fields are filled with data.
 240
 241 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 242 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 243 with MediaWiki 1.21.
 244
 245 Don't forget to always back up your database before upgrading!
 246
 247 See the file UPGRADE for more detailed upgrade instructions.
 248
 249 For notes on 1.27.x and older releases, see HISTORY.
 250
 251 == Online documentation ==
 252
 253 Documentation for both end-users and site administrators is available on
 254 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 255 for pages that explicitly state that their contents are in the public domain):
 256
 257        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 258
 259 == Mailing list ==
 260
 261 A mailing list is available for MediaWiki user support and discussion:
 262
 263        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 264
 265 A low-traffic announcements-only list is also available:
 266
 267        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 268
 269 It's highly recommended that you sign up for one of these lists if you're
 270 going to run a public MediaWiki, so you can be notified of security fixes.
 271
 272 == IRC help ==
 273
 274 There's usually someone online in #mediawiki on irc.freenode.net.