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