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