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