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