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