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 * Updated composer/semver from v1.4.1 to v1.4.2
  69 * Updated wikimedia/php-session-serializer from v1.0.3 to v1.0.4
  70
  71 ==== New external libraries ====
  72 * Added wikimedia/scoped-callback v1.0.0
  73 * Added wikimedia/wait-condition-loop v1.0.1
  74
  75 ==== Removed and replaced external libraries ====
  76
  77 === Bug fixes in 1.28 ===
  78 * (T137264) SECURITY: XSS in unclosed internal links
  79 * (T133147) SECURITY: Escape '<' and ']]>' in inline <style> blocks
  80 * (T133147) SECURITY: Require login to preview user CSS pages
  81 * (T132926) SECURITY: Do not allow undeleting a revision deleted file if it is
  82   the top file
  83 * (T129738) SECURITY: Make $wgBlockDisablesLogin also restrict logged in
  84   permissions
  85 * (T129738) SECURITY: Make blocks log users out if $wgBlockDisablesLogin is true
  86 * (T139670) Move 'UserGetRights' call before application of
  87   Session::getAllowedUserRights()
  88
  89 === Action API changes in 1.28 ===
  90 * Added 'maxarticlesize' property to action=query&meta=siteinfo which contains
  91   the value of $wgMaxArticleSize.
  92 * Property 'modulemessages' from action=parse&prop=modules was removed
  93   (deprecated since 1.26).
  94 * The following response properties from action=login, deprecated in 1.27, are
  95   now removed: lgtoken, cookieprefix, sessionid. Clients should handle cookies
  96   to properly manage session state.
  97 * Submitting the lgtoken and lgpassword parameters in the query string to
  98   action=login is now deprecated and outputs a warning. They should be submitted
  99   in the POST body instead.
 100 * Submitting sensitive authentication request parameters to action=clientlogin,
 101   action=createaccount, action=linkaccount, and action=changeauthenticationdata
 102   in the query string is now deprecated and outputs a warning. They should be
 103   submitted in the POST body instead.
 104 * (T141960) Multi-valued parameters may now be separated using U+001F (Unit Separator)
 105   instead of the pipe character. This will be useful if some of the multiple
 106   values need to contain pipes, e.g. for action=options.
 107 * The API will now warn if input is not NFC-normalized Unicode or if it
 108   contains invalid characters.
 109 * The 'normalized' list output by action=query and other modules that use
 110   ApiPageSet may contain entries where the 'from' value is percent-encoded as
 111   the raw value cannot be represented in a valid API response. These are
 112   indicated by a 'fromencoded' boolean alongside the existing 'from' parameter.
 113 * (T28680) action=paraminfo can now return info about all submodules of a
 114   module without listing them all explicitly.
 115
 116 === Action API internal changes in 1.28 ===
 117 * Added a new hook, 'ApiMakeParserOptions', to allow extensions to better
 118   interact with ApiParse and ApiExpandTemplates.
 119 * (T139565) SECURITY: API: Generate head items in the context of the given title
 120 * (T115333) SECURITY: Check read permission when loading page content in ApiParse
 121 * ApiBase::makeHelpArrayToString() was removed (deprecated since 1.25)
 122 * ApiBase::makeHelpMsgParameters() was removed (deprecated since 1.25)
 123 * ApiBase::makeHelpMsg() was removed (deprecated since 1.25)
 124 * ApiFormatBase::formatHTML() was removed (deprecated since 1.25)
 125 * ApiFormatBase::getNeedsRawData() was removed (deprecated since 1.25)
 126 * ApiFormatBase::getWantsHelp() was removed (deprecated since 1.25)
 127 * ApiFormatBase::setBufferResult() was removed (deprecated since 1.25)
 128 * ApiFormatBase::setHelp() was removed (deprecated since 1.25)
 129 * ApiFormatBase::setUnescapeAmps() was removed (deprecated since 1.25)
 130 * ApiMain::makeHelpMsgHeader() was removed (deprecated since 1.25)
 131 * ApiMain::reallyMakeHelpMsg() was removed (deprecated since 1.25)
 132 * ApiMain::setHelp() was removed (deprecated since 1.25)
 133 * ApiResult::beginContinuation() was removed (deprecated since 1.25)
 134 * ApiResult::cleanUpUTF8() was removed (deprecated since 1.25)
 135 * ApiResult::convertStatusToArray() was removed (deprecated since 1.25)
 136 * ApiResult::disableSizeCheck() was removed (deprecated since 1.24)
 137 * ApiResult::enableSizeCheck() was removed (deprecated since 1.24)
 138 * ApiResult::endContinuation() was removed (deprecated since 1.25)
 139 * ApiResult::getData() was removed (deprecated since 1.25)
 140 * ApiResult::getIsRawMode() was removed (deprecated since 1.25)
 141 * ApiResult::setContent() was removed (deprecated since 1.25)
 142 * ApiResult::setContinueParam() was removed (deprecated since 1.25)
 143 * ApiResult::setElement() was removed (deprecated since 1.25)
 144 * ApiResult::setGeneratorContinueParam() was removed (deprecated since 1.25)
 145 * ApiResult::setIndexedTagName_internal() was removed (deprecated since 1.25)
 146 * ApiResult::setIndexedTagName_recursive() was removed (deprecated since 1.25)
 147 * ApiResult::setMainForContinuation() was removed (deprecated since 1.25)
 148 * ApiResult::setParsedLimit() was removed (deprecated since 1.25)
 149 * ApiResult::setRawMode() was removed (deprecated since 1.25)
 150 * ApiResult::size() was removed (deprecated since 1.25)
 151
 152 === Languages updated in 1.28 ===
 153
 154 MediaWiki supports over 350 languages. Many localisations are updated
 155 regularly. Below only new and removed languages are listed, as well as
 156 changes to languages because of Phabricator reports.
 157
 158 * (T137411) ban (Balinese), thanks to translators Adi Mayndra, Andru,
 159   BASAbali, M. Adiputra, Naval Scene, Nemo bis, NoiX180, and 아라.
 160 * (T135867) shn (Shan), thanks to translators Khun Sar, Piangpha,
 161   Saiddzone Saimawnkham, Saosukham, and Sengwan.
 162 * Czech (cs) and Slovak (sk) set as reciprocal fallbacks
 163
 164 === Other changes in 1.28 ===
 165 * (T128697) Improved handling of large diffs.
 166 * [BREAKING CHANGE] $wgExtendedLoginCookies has been removed. You can
 167   use or update a custom session provider if needed.
 168 * Deprecated APIEditBeforeSave hook in favor of EditFilterMergedContent.
 169 * The 'UploadVerification' hook is deprecated. Use 'UploadVerifyFile' instead.
 170 * SiteConfiguration::isLocalVHost() was removed (deprecated since 1.25).
 171 * The 'UserLoginComplete' hook has a new parameter to differentiate between actual
 172   login and visiting the login page while already logged in.
 173 * ResourceLoader::makeLoaderURL() was removed (deprecated since 1.24).
 174 * $.fn.liveAndTestAtStart was removed (deprecated since 1.24).
 175 * mw.util.tooltipAccessKeyPrefix was removed (deprecated since 1.24).
 176 * mw.util.tooltipAccessKeyRegexp was removed (deprecated since 1.24).
 177 * Linker::link() and Linker::linkKnown() were deprecated; please instead use
 178   MediaWiki\Linker\LinkRenderer. In addition, the LinkBegin and LinkEnd hooks
 179   were replaced by HtmlPageLinkRendererBegin and HtmlPageLinkRendererEnd
 180   respectively. See docs/hooks.txt for the specific changes needed for those hooks.
 181 * Linker::formatSize() was deprecated. Use Language::formatSize() directly.
 182 * Aliases for Linker methods, deprecated since 1.21, were removed from Skin:
 183   * Skin::commentBlock() (use Linker::commentBlock() instead)
 184   * Skin::generateRollback() (use Linker::generateRollback() instead)
 185   * Skin::link() (use MediaWiki\Linker\LinkRenderer instead)
 186   * Skin::linkKnown() (use MediaWiki\Linker\LinkRenderer instead)
 187   * Skin::userLink() (use Linker::userLink() instead)
 188   * Skin::userToolLinks() (use Linker::userToolLinks() instead)
 189 * The 'ParserLimitReportFormat' hook was removed.
 190 * Disabled "bug 2702" HTML tidying of parsed UI messages on wikis where Tidy is
 191   disabled.
 192 * DifferenceEngine::generateDiffBody() was removed (deprecated since 1.21).
 193 * UploadBase::stashFileGetKey() and UploadBase::stashSession() were deprecated.
 194   Use ...->stashFile()->getFileKey() instead.
 195 * "Public domain" was removed as a wiki license option from the installer, in
 196   favour of CC-0.
 197 * AuthenticationRequest::$required is now changed from REQUIRED to PRIMARY_REQUIRED
 198   on requests needed by primary providers even if all primaries need them.
 199   Primary providers are discouraged from returning multiple REQUIRED requests.
 200 * OOjs UI PHP widgets constructed with the `'infusable' => true` config option
 201   will no longer be automatically infused. You should call `OO.ui.infuse()`
 202   on them yourself from your JavaScript code.
 203 * parserTests.php has moved to tests/parser/parserTests.php
 204 * The command line options specific to parser tests have been removed from
 205   phpunit.php: --regex and --keep-uploads. Instead of --regex, use --filter.
 206   Instead of --keep-uploads, use the same option to parserTests.php, but you
 207   must specify a directory with --upload-dir.
 208 * The 'jquery.arrowSteps' ResourceLoader module is now deprecated.
 209 * IP::isConfiguredProxy() and IP::isTrustedProxy() were removed. Callers should
 210   migrate to using the same functions on a ProxyLookup instance, obtainable from
 211   MediaWikiServices.
 212
 213 == Compatibility ==
 214
 215 MediaWiki 1.28 requires PHP 5.5.9 or later. There is experimental support for
 216 HHVM 3.6.5 or later.
 217
 218 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 219 support for them is somewhat less mature. There is experimental support for
 220 Oracle and Microsoft SQL Server.
 221
 222 The supported versions are:
 223
 224 * MySQL 5.0.3 or later
 225 * PostgreSQL 8.3 or later
 226 * SQLite 3.3.7 or later
 227 * Oracle 9.0.1 or later
 228 * Microsoft SQL Server 2005 (9.00.1399)
 229
 230 == Upgrading ==
 231
 232 1.28 has several database changes since 1.27, and will not work without schema
 233 updates. Note that due to changes to some very large tables like the revision
 234 table, the schema update may take quite long (minutes on a medium sized site,
 235 many hours on a large site).
 236
 237 If upgrading from before 1.11, and you are using a wiki as a commons
 238 repository, make sure that it is updated as well. Otherwise, errors may arise
 239 due to database schema changes.
 240
 241 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 242 new database fields are filled with data.
 243
 244 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 245 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 246 with MediaWiki 1.21.
 247
 248 Don't forget to always back up your database before upgrading!
 249
 250 See the file UPGRADE for more detailed upgrade instructions.
 251
 252 For notes on 1.27.x and older releases, see HISTORY.
 253
 254 == Online documentation ==
 255
 256 Documentation for both end-users and site administrators is available on
 257 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 258 for pages that explicitly state that their contents are in the public domain):
 259
 260        https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
 261
 262 == Mailing list ==
 263
 264 A mailing list is available for MediaWiki user support and discussion:
 265
 266        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 267
 268 A low-traffic announcements-only list is also available:
 269
 270        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 271
 272 It's highly recommended that you sign up for one of these lists if you're
 273 going to run a public MediaWiki, so you can be notified of security fixes.
 274
 275 == IRC help ==
 276
 277 There's usually someone online in #mediawiki on irc.freenode.net.