RELEASE-NOTES-1.25

   1 Security reminder: If you have PHP's register_globals option set, you must
   2 turn it off. MediaWiki will not work with it enabled.
   3
   4 == MediaWiki 1.25 ==
   5
   6 THIS IS NOT A RELEASE YET
   7
   8 MediaWiki 1.25 is an alpha-quality branch and is not recommended for use in
   9 production.
  10
  11 === Configuration changes in 1.25 ===
  12 * $wgPageShowWatchingUsers was removed.
  13 * $wgLocalVirtualHosts has been added to replace $wgConf->localVHosts.
  14 * $wgAntiLockFlags was removed.
  15 * $wgJavaScriptTestConfig was removed.
  16 * Edit tokens returned from User::getEditToken may change on every call. Token
  17   validity must be checked by passing the user-supplied token to
  18   User::matchEditToken rather than by testing for equality with a
  19   newly-generated token.
  20 * (T74951) The UserGetLanguageObject hook may be passed any IContextSource
  21   for its $context parameter. Formerly it was documented as receiving a
  22   RequestContext specifically.
  23 * Profiling was restructured and $wgProfiler now requires an 'output' parameter.
  24   See StartProfiler.sample for details.
  25 * $wgMangleFlashPolicy was added to make MediaWiki's mangling of anything that
  26   might be a flash policy directive configurable.
  27 * ApiOpenSearch now supports XML output. The OpenSearchXml extension should no
  28   longer be used. If extracts and page images are desired, the TextExtracts and
  29   PageImages extensions are required.
  30 * $wgOpenSearchTemplate is deprecated in favor of $wgOpenSearchTemplates.
  31 * Edits are now prepared via AJAX as users type edit summaries. This behavior
  32   can be disabled via $wgAjaxEditStash.
  33 * (T46740) The temporary option $wgIncludejQueryMigrate was removed, along
  34   with the jQuery Migrate library, as indicated when this option was provided in
  35   MediaWiki 1.24.
  36
  37 === New features in 1.25 ===
  38 * (T64861) Updated plural rules to CLDR 26. Includes incompatible changes
  39   for plural forms in Russian, Prussian, Tagalog, Manx and several languages
  40   that fall back to Russian.
  41 * (T60139) ResourceLoaderFileModule now supports language fallback
  42   for 'languageScripts'.
  43 * Added a new hook, "ContentAlterParserOutput", to allow extensions to modify the
  44   parser output for a content object before links update.
  45 * (T37785) Enhanced recent changes and extended watchlist are now default.
  46   Documentation: https://meta.wikimedia.org/wiki/Help:Enhanced_recent_changes
  47   and https://www.mediawiki.org/wiki/Manual:$wgDefaultUserOptions.
  48 * (T69341) SVG images will no longer be base64-encoded when being embedded
  49   in CSS. This results in slight size increase before gzip compression (due to
  50   percent-encoding), but up to 20% decrease after it.
  51 * Upgrade jStorage to v0.4.12.
  52 * MediaWiki now natively supports page status indicators: icons (or short text
  53   snippets) usually displayed in the top-right corner of the page. They have
  54   been in use on Wikipedia for a long time, implemented using templates and CSS
  55   absolute positioning.
  56   - Basic wikitext syntax: <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
  57   - Usage instructions: https://www.mediawiki.org/wiki/Help:Page_status_indicators
  58   - Adjusting custom skins to support indicators:
  59     https://www.mediawiki.org/wiki/Manual:Skinning#Page_status_indicators
  60 * Edit tokens may now be time-limited: passing a maximum age to
  61   User::matchEditToken will reject any older tokens.
  62 * The debug logging internals have been overhauled, and are now using the
  63   PSR-3 interfaces.
  64 * Update CSSJanus to v1.1.1.
  65 * Update lessphp to v0.5.0.
  66 * Added a hook, "ApiOpenSearchSuggest", to allow extensions to provide extracts
  67   and images for ApiOpenSearch output. The semantics are identical to the
  68   "OpenSearchXml" hook provided by the OpenSearchXml extension.
  69 * PrefixSearchBackend hook now has an $offset parameter. Combined with $limit,
  70   this allows for pagination of prefix results. Extensions using this hook
  71   should implement supporting behavior. Not doing so can result in undefined
  72   behavior from API clients trying to continue through prefix results.
  73 * Update jQuery from v1.11.1 to v1.11.2.
  74 * External libraries installed via composer will now be displayed
  75   on Special:Version in their own section. Extensions or skins that are
  76   installed via composer will not be shown in this section as it is assumed
  77   they will add the proper credits to the skins or extensions section.
  78
  79 ==== External libraries ====
  80 * MediaWiki now requires certain external libraries to be installed. In the past
  81   these were bundled inside the Git repository of MediaWiki core, but now they
  82   need to be installed separately. For users using the tarball, this will be taken
  83   care of and no action will be required. Users using Git will either need to use
  84   composer to fetch dependencies or use the mediawiki/vendor repository which includes
  85   all dependencies for MediaWiki core and ones used in Wikimedia deployment. Detailed
  86   instructions can be found at:
  87   https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries
  88 * The following libraries are now required:
  89 ** psr/log
  90    This library provides the interfaces set by the PSR-3 standard (http://www.php-fig.org/psr/psr-3/)
  91    which are used by MediaWiki interally by the MWLogger class.
  92    See the structured logging RfC (https://www.mediawiki.org/wiki/Requests_for_comment/Structured_logging)
  93    for more background information.
  94 ** cssjanus/cssjanus
  95    This library was formerly bundled with MediaWiki core and has been removed.
  96    It automatically flips CSS for RTL support.
  97 ** leafo/lessphp
  98    This library was formerly bundled with MediaWiki core and has been removed.
  99    It compiles LESS files into CSS.
 100 ** wikimedia/cdb
 101    This library was formerly a part of MediaWiki core, and has been moved into a separate library.
 102    It provides CDB functions which are used in the Interwiki and Localization caches.
 103    More information about the library can be found at https://www.mediawiki.org/wiki/CDB.
 104
 105 === Bug fixes in 1.25 ===
 106 * (T73003) No additional code will be generated to try to load CSS-embedded
 107   SVG images in Internet Explorer 6 and 7, as they don't support them anyway.
 108 * (T69021) On Special:BookSources, corrected validation of ISBNs (both
 109   10- and 13-digit forms) containing "X".
 110 * Page moving was refactored into a MovePage class. As part of that:
 111 ** The AbortMove hook was removed.
 112 ** MovePageIsValidMove is for extensions to specify whether a page
 113    cannot be moved for technical reasons, and should not be overridden.
 114 ** MovePageCheckPermissions is for checking whether the given user is
 115    allowed to make the move.
 116 ** Title::moveNoAuth() was deprecated. Use the MovePage class instead.
 117 ** Title::moveTo() was deprecated. Use the MovePage class instead.
 118 ** Title::isValidMoveOperation() broken down into MovePage::isValidMove()
 119    and MovePage::checkPermissions().
 120 * (T18530) Multiple autocomments are now formatted in an edit summary.
 121 * (T70361) Autocomments containing "/*" are parsed correctly.
 122 * The Special:WhatLinksHere page linked from 'Number of redirects to this page'
 123   on action=info about a file page does not list file links anymore.
 124 * (T78637) Search bar is not autofocused unless it is empty so that proper scrolling using arrow keys is possible.
 125 * (T50853) Database::makeList() modified to handle 'NULL' separately when building IN clause
 126
 127 === Action API changes in 1.25 ===
 128 * (T67403) XML tag highlighting is now only performed for formats
 129   "xmlfm" and "wddxfm".
 130 * action=paraminfo supports generalized submodules (modules=query+value),
 131   querymodules and formatmodules are deprecated
 132 * action=paraminfo no longer outputs descriptions and other help text by
 133   default. If needed, it may be requested using the new 'helpformat' parameter.
 134 * action=help has been completely rewritten, and outputs help in HTML
 135   rather than plain text.
 136 * Hitting api.php without specifying an action now displays only the help for
 137   the main module, with links to submodule help.
 138 * API help is no longer displayed on errors.
 139 * 'uselang' is now a recognized API parameter; "uselang=user" may be used to
 140   explicitly select the language from the current user's preferences, and
 141   "uselang=content" may be used to select the wiki's content language.
 142 * Default output format for the API is now jsonfm.
 143 * Simplified continuation will return a "batchcomplete" property in the result
 144   when a batch of pages is complete.
 145 * Pretty-printed HTML output now has nicer formatting and (if available)
 146   better syntax highlighting.
 147 * Deprecated list=deletedrevs in favor of newly-added prop=deletedrevisions and
 148   list=alldeletedrevisions.
 149 * prop=revisions will gracefully continue when given too many revids or titles,
 150   rather than just ignoring the extras.
 151 * prop=revisions will no longer die if rvcontentformat doesn't match a
 152   revision's content model; it will instead warn and omit the content.
 153 * If the user has the 'deletedhistory' right, action=query's revids parameter
 154   will now recognize deleted revids.
 155 * prop=revisions may be used as a generator, generating revids.
 156 * (T68776) format=json results will no longer be corrupted when
 157   $wgMangleFlashPolicy is in effect. format=php results will cleanly return an
 158   error instead of returning invalid serialized data.
 159 * Generators may now return data for the generated pages when used with
 160   action=query.
 161 * Query page data for generator=search and generator=prefixsearch will now
 162   include an "index" field, which may be used by the client for sorting the
 163   search results.
 164 * ApiOpenSearch now supports XML output.
 165 * ApiOpenSearch will now output descriptions and URLs as array indexes 2 and 3
 166   in JSON format.
 167 * (T76051) list=tags will now continue correctly.
 168 * (T76052) list=tags can now indicate whether a tag is defined.
 169 * (T75522) list=prefixsearch now supports continuation
 170 * (T78737) action=expandtemplates can now return page properties.
 171 * (T78690) list=allimages now accepts multiple pipe-separated values
 172   for the 'aimime' parameter.
 173
 174 === Action API internal changes in 1.25 ===
 175 * ApiHelp has been rewritten to support i18n and paginated HTML output.
 176   Most existing modules should continue working without changes, but should do
 177   the following:
 178   * Add an i18n message "apihelp-{$moduleName}-description" to replace getDescription().
 179   * Add i18n messages "apihelp-{$moduleName}-param-{$param}" for each parameter
 180     to replace getParamDescription(). If necessary, the settings array returned
 181     by getParams() can use the new ApiBase::PARAM_HELP_MSG key to override the
 182     message.
 183   * Implement getExamplesMessages() to replace getExamples().
 184 * Modules with submodules (like action=query) must have their submodules
 185   override ApiBase::getParent() to return the correct parent object.
 186 * The 'APIGetDescription' and 'APIGetParamDescription' hooks are deprecated,
 187   and will have no effect for modules using i18n messages. Use
 188   'APIGetDescriptionMessages' and 'APIGetParamDescriptionMessages' instead.
 189 * Api formatters will no longer be asked to display the help screen on errors.
 190 * ApiMain::getCredits() was removed. The credits are available in the
 191   'api-credits' i18n message.
 192 * ApiFormatBase has been changed to support i18n and syntax highlighting via
 193   extensions with the new 'ApiFormatHighlight' hook. Core syntax highlighting
 194   has been removed.
 195 * ApiFormatBase now always buffers. Output is done when
 196   ApiFormatBase::closePrinter is called.
 197 * Much of the logic in ApiQueryRevisions has been split into ApiQueryRevisionsBase.
 198 * The 'revids' parameter supplied by ApiPageSet will now count deleted
 199   revisions as "good" if the user has the 'deletedhistory' right. New methods
 200   ApiPageSet::getLiveRevisionIDs() and ApiPageSet::getDeletedRevisionIDs() are
 201   provided to access just the live or just the deleted revids.
 202 * Added ApiPageSet::setGeneratorData() and ApiPageSet::populateGeneratorData()
 203   to allow generators to include data in the action=query result.
 204 * The following methods have been deprecated and may be removed in a future
 205   release:
 206   * ApiBase::getDescription
 207   * ApiBase::getParamDescription
 208   * ApiBase::getExamples
 209   * ApiBase::makeHelpMsg
 210   * ApiBase::makeHelpArrayToString
 211   * ApiBase::makeHelpMsgParameters
 212   * ApiFormatBase::setUnescapeAmps
 213   * ApiFormatBase::getWantsHelp
 214   * ApiFormatBase::setHelp
 215   * ApiFormatBase::formatHTML
 216   * ApiFormatBase::setBufferResult
 217   * ApiFormatBase::getDescription
 218   * ApiMain::setHelp
 219   * ApiMain::reallyMakeHelpMsg
 220   * ApiMain::makeHelpMsgHeader
 221   * ApiQueryImageInfo::getPropertyDescriptions
 222 * The following classes have been deprecated and may be removed in a future
 223   release:
 224   * ApiQueryDeletedrevs
 225
 226 === Languages updated in 1.25 ===
 227
 228 MediaWiki supports over 350 languages. Many localisations are updated
 229 regularly. Below only new and removed languages are listed, as well as
 230 changes to languages because of Bugzilla reports.
 231
 232 * (T66440) Kazakh (kk) wikis should no longer forcefully reset the user's
 233   interface language to kk where unexpected.
 234
 235 === Other changes in 1.25 ===
 236 * The skin autodiscovery mechanism, deprecated in MediaWiki 1.23, has been
 237   removed. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for
 238   migration guide for creators and users of custom skins that relied on it.
 239 * Javascript variable 'wgFileCanRotate' and 'wgFileExtensions' now only
 240   available on Special:Upload.
 241 * (T58257) Set site logo from mediawiki.skinning.interface module instead of
 242   inline styles in the HTML.
 243 * Removed ApiQueryUsers::getAutoGroups(). (deprecated since 1.20)
 244 * Removed XmlDumpWriter::schemaVersion(). (deprecated since 1.20)
 245 * Removed LogEventsList::getDisplayTitle(). (deprecated since 1.20)
 246 * Removed Preferences::trySetUserEmail(). (deprecated since 1.20)
 247 * Removed mw.user.name() and mw.user.anonymous() methods. (deprecated since 1.20)
 248 * Removed 'ok' and 'err' parameters in the mediawiki.api modules. (deprecated
 249   since 1.20)
 250 * Removed 'async' parameter from the  mw.Api#getCategories() method. (deprecated
 251   since 1.20)
 252 * Removed 'jquery.json' module. (deprecated since 1.24)
 253   Use the 'json' module and global JSON object instead.
 254 * Deprecated OutputPage::readOnlyPage() and OutputPage::rateLimited().
 255   Also, the former will now throw an MWException if called with one or more
 256   arguments.
 257 * Removed hitcounters and associated code.
 258 * The "temp" zone of the upload respository is now considered private. If it
 259   already exists (such as under the images/ directory), please make sure that
 260   the directory is not web readable (e.g. via a .htaccess file).
 261 * BREAKING CHANGE: In the XML dump format used by Special:Export and
 262   dumpBackup.php, the <model> and <format> tags now apprear before the <text>
 263   tag, instead of after the <text> and <sha1> tags.
 264   The new schema version is 0.10, the new schema URI is:
 265   https://www.mediawiki.org/xml/export-0.10.xsd
 266 * MWFunction::call() and MWFunction::callArray() were removed, having being
 267   deprecated in 1.22.
 268 * Deprecated the getInternalLinkAttributes, getInternalLinkAttributesObj,
 269   and getInternalLinkAttributes methods in Linker, and removed
 270   getExternalLinkAttributes method, which was deprecated in MediaWiki 1.18.
 271 * Removed Sites class, which was deprecated in 1.21 and replaced by SiteSQLStore.
 272 * The mw.api.getToken() method now uses action=query?meta=tokens. This will now
 273   fail for custom tokens registered only via the deprecated ApiTokensGetTokenTypes
 274   hook. The ApiQueryTokensRegisterTypes hook should be used for this to work.
 275 * Added wgRelevantArticleId to the client-side config, for use on special pages.
 276 * Deprecated the TitleIsCssOrJsPage hook. Superseded by the
 277   ContentHandlerDefaultModelFor hook since MediaWiki 1.21.
 278 * Deprecated the TitleIsWikitextPage hook. Superseded by the
 279   ContentHandlerDefaultModelFor hook since MediaWiki 1.21.
 280 * Changed parsing of variables in schema (.sql) files:
 281 ** The substituted values are no longer parsed. (Formerly, several passes
 282    were made for each variable, so depending on the order in which variables
 283    were defined, variables might have been found inside encoded values. This
 284    is no longer the case.)
 285 ** Variables are no longer string encoded when the /*$var*/ syntax is used.
 286    If string encoding is necessary, use the '{$var}' syntax instead.
 287 ** Variable names must only consist of one or more of the characters
 288    "A-Za-z0-9_".
 289 ** In source text of the form '{$A}'{$B}' or `{$A}`{$B}`, where variable A
 290    does not exist yet variable B does, the latter may not be replaced.
 291    However, this difference is unlikely to arise in practice.
 292 * (T67278) RFC, PMID, and ISBN "magic links" must be surrounded by non-word
 293   characters on both sides.
 294 * The FormatAutocomments hook will now receive $pre and $post as booleans,
 295   rather than as strings that must be prepended or appended to $comment.
 296 * (T30950, T31025) RFC, PMID, and ISBN "magic links" can no longer contain
 297   newlines; but they can contain &nbsp; and other non-newline whitespace.
 298
 299 == Compatibility ==
 300
 301 MediaWiki 1.25 requires PHP 5.3.3 or later. There is experimental support for
 302 HHVM 3.3.0.
 303
 304 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 305 support for them is somewhat less mature. There is experimental support for
 306 Oracle and Microsoft SQL Server.
 307
 308 The supported versions are:
 309
 310 * MySQL 5.0.2 or later
 311 * PostgreSQL 8.3 or later
 312 * SQLite 3.3.7 or later
 313 * Oracle 9.0.1 or later
 314 * Microsoft SQL Server 2005 (9.00.1399)
 315
 316 == Upgrading ==
 317
 318 1.25 has several database changes since 1.24, and will not work without schema
 319 updates. Note that due to changes to some very large tables like the revision
 320 table, the schema update may take quite long (minutes on a medium sized site,
 321 many hours on a large site).
 322
 323 If upgrading from before 1.11, and you are using a wiki as a commons
 324 repository, make sure that it is updated as well. Otherwise, errors may arise
 325 due to database schema changes.
 326
 327 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 328 new database fields are filled with data.
 329
 330 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 331 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 332 with MediaWiki 1.21.
 333
 334 Don't forget to always back up your database before upgrading!
 335
 336 See the file UPGRADE for more detailed upgrade instructions.
 337
 338 For notes on 1.24.x and older releases, see HISTORY.
 339
 340 == Online documentation ==
 341
 342 Documentation for both end-users and site administrators is available on
 343 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 344 for pages that explicitly state that their contents are in the public domain):
 345
 346         https://www.mediawiki.org/wiki/Documentation
 347
 348 == Mailing list ==
 349
 350 A mailing list is available for MediaWiki user support and discussion:
 351
 352         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 353
 354 A low-traffic announcements-only list is also available:
 355
 356         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 357
 358 It's highly recommended that you sign up for one of these lists if you're
 359 going to run a public MediaWiki, so you can be notified of security fixes.
 360
 361 == IRC help ==
 362
 363 There's usually someone online in #mediawiki on irc.freenode.net.