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