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 * Edit tokens returned from User::getEditToken may change on every call. Token
  16   validity must be checked by passing the user-supplied token to
  17   User::matchEditToken rather than by testing for equality with a
  18   newly-generated token.
  19 * (bug 72951) The UserGetLanguageObject hook may be passed any IContextSource
  20   for its $context parameter. Formerly it was documented as receiving a
  21   RequestContext specifically.
  22 * Profiling was restructured and $wgProfiler now requires an 'output' parameter.
  23   See StartProfiler.sample for details.
  24 * $wgMangleFlashPolicy was added to make MediaWiki's mangling of anything that
  25   might be a flash policy directive configurable.
  26 * ApiOpenSearch now supports XML output. The OpenSearchXml extension should no
  27   longer be used. If extracts and page images are desired, the TextExtracts and
  28   PageImages extensions are required.
  29 * $wgOpenSearchTemplate is deprecated in favor of $wgOpenSearchTemplates.
  30
  31 === New features in 1.25 ===
  32 * (bug 62861) Updated plural rules to CLDR 26. Includes incompatible changes
  33   for plural forms in Russian, Prussian, Tagalog, Manx and several languages
  34   that fall back to Russian.
  35 * (bug 58139) ResourceLoaderFileModule now supports language fallback
  36   for 'languageScripts'.
  37 * Added a new hook, "ContentAlterParserOutput", to allow extensions to modify the
  38   parser output for a content object before links update.
  39 * (bug 35785) Enhanced recent changes and extended watchlist are now default.
  40   Documentation: https://meta.wikimedia.org/wiki/Help:Enhanced_recent_changes
  41   and https://www.mediawiki.org/wiki/Manual:$wgDefaultUserOptions.
  42 * (bug 67341) SVG images will no longer be base64-encoded when being embedded
  43   in CSS. This results in slight size increase before gzip compression (due to
  44   percent-encoding), but up to 20% decrease after it.
  45 * Upgrade jStorage to v0.4.12.
  46 * MediaWiki now natively supports page status indicators: icons (or short text
  47   snippets) usually displayed in the top-right corner of the page. They have
  48   been in use on Wikipedia for a long time, implemented using templates and CSS
  49   absolute positioning.
  50   - Basic wikitext syntax: <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
  51   - Usage instructions: https://www.mediawiki.org/wiki/Help:Page_status_indicators
  52   - Adjusting custom skins to support indicators:
  53     https://www.mediawiki.org/wiki/Manual:Skinning#Page_status_indicators
  54 * Edit tokens may now be time-limited: passing a maximum age to
  55   User::matchEditToken will reject any older tokens.
  56 * The debug logging internals have been overhauled, and are now using the
  57   PSR-3 interfaces.
  58 * Update CSSJanus to v1.1.1.
  59 * Added a hook, "ApiOpenSearchSuggest", to allow extensions to provide extracts
  60   and images for ApiOpenSearch output. The semantics are identical to the
  61   "OpenSearchXml" hook provided by the OpenSearchXml extension.
  62
  63 === Bug fixes in 1.25 ===
  64 * (bug 71003) No additional code will be generated to try to load CSS-embedded
  65   SVG images in Internet Explorer 6 and 7, as they don't support them anyway.
  66 * (bug 67021) On Special:BookSources, corrected validation of ISBNs (both
  67   10- and 13-digit forms) containing "X".
  68 * Page moving was refactored into a MovePage class. As part of that:
  69 ** The AbortMove hook was removed.
  70 ** MovePageIsValidMove is for extensions to specify whether a page
  71    cannot be moved for technical reasons, and should not be overriden.
  72 ** MovePageCheckPermissions is for checking whether the given user is
  73    allowed to make the move.
  74 ** Title::moveNoAuth() was deprecated. Use the MovePage class instead.
  75 ** Title::moveTo() was deprecated. Use the MovePage class instead.
  76 ** Title::isValidMoveOperation() broken down into MovePage::isValidMove()
  77    and MovePage::checkPermissions().
  78
  79 === Action API changes in 1.25 ===
  80 * (bug 65403) XML tag highlighting is now only performed for formats
  81   "xmlfm" and "wddxfm".
  82 * action=paraminfo supports generalized submodules (modules=query+value),
  83   querymodules and formatmodules are deprecated
  84 * action=paraminfo no longer outputs descriptions and other help text by
  85   default. If needed, it may be requested using the new 'helpformat' parameter.
  86 * action=help has been completely rewritten, and outputs help in HTML
  87   rather than plain text.
  88 * Hitting api.php without specifying an action now displays only the help for
  89   the main module, with links to submodule help.
  90 * API help is no longer displayed on errors.
  91 * 'uselang' is now a recognized API parameter; "uselang=user" may be used to
  92   explicitly select the language from the current user's preferences, and
  93   "uselang=content" may be used to select the wiki's content language.
  94 * Default output format for the API is now jsonfm.
  95 * Simplified continuation will return a "batchcomplete" property in the result
  96   when a batch of pages is complete.
  97 * Pretty-printed HTML output now has nicer formatting and (if available)
  98   better syntax highlighting.
  99 * Deprecated list=deletedrevs in favor of newly-added prop=deletedrevisions and
 100   list=alldeletedrevisions.
 101 * prop=revisions will gracefully continue when given too many revids or titles,
 102   rather than just ignoring the extras.
 103 * prop=revisions will no longer die if rvcontentformat doesn't match a
 104   revision's content model; it will instead warn and omit the content.
 105 * If the user has the 'deletedhistory' right, action=query's revids parameter
 106   will now recognize deleted revids.
 107 * prop=revisions may be used as a generator, generating revids.
 108 * (bug 66776) format=json results will no longer be corrupted when
 109   $wgMangleFlashPolicy is in effect. format=php results will cleanly return an
 110   error instead of returning invalid serialized data.
 111 * Generators may now return data for the generated pages when used with
 112   action=query.
 113 * Query page data for generator=search and generator=prefixsearch will now
 114   include an "index" field, which may be used by the client for sorting the
 115   search results.
 116 * ApiOpenSearch now supports XML output.
 117 * ApiOpenSearch will now output descriptions and URLs as array indexes 2 and 3
 118   in JSON format.
 119 * (bug T76051) list=tags will now continue correctly.
 120 * (bug T76052) list=tags can now indicate whether a tag is defined.
 121
 122 === Action API internal changes in 1.25 ===
 123 * ApiHelp has been rewritten to support i18n and paginated HTML output.
 124   Most existing modules should continue working without changes, but should do
 125   the following:
 126   * Add an i18n message "apihelp-{$moduleName}-description" to replace getDescription().
 127   * Add i18n messages "apihelp-{$moduleName}-param-{$param}" for each parameter
 128     to replace getParamDescription(). If necessary, the settings array returned
 129     by getParams() can use the new ApiBase::PARAM_HELP_MSG key to override the
 130     message.
 131   * Implement getExamplesMessages() to replace getExamples().
 132 * Modules with submodules (like action=query) must have their submodules
 133   override ApiBase::getParent() to return the correct parent object.
 134 * The 'APIGetDescription' and 'APIGetParamDescription' hooks are deprecated,
 135   and will have no effect for modules using i18n messages. Use
 136   'APIGetDescriptionMessages' and 'APIGetParamDescriptionMessages' instead.
 137 * Api formatters will no longer be asked to display the help screen on errors.
 138 * ApiMain::getCredits() was removed. The credits are available in the
 139   'api-credits' i18n message.
 140 * ApiFormatBase has been changed to support i18n and syntax highlighting via
 141   extensions with the new 'ApiFormatHighlight' hook. Core syntax highlighting
 142   has been removed.
 143 * ApiFormatBase now always buffers. Output is done when
 144   ApiFormatBase::closePrinter is called.
 145 * Much of the logic in ApiQueryRevisions has been split into ApiQueryRevisionsBase.
 146 * The 'revids' parameter supplied by ApiPageSet will now count deleted
 147   revisions as "good" if the user has the 'deletedhistory' right. New methods
 148   ApiPageSet::getLiveRevisionIDs() and ApiPageSet::getDeletedRevisionIDs() are
 149   provided to access just the live or just the deleted revids.
 150 * Added ApiPageSet::setGeneratorData() and ApiPageSet::populateGeneratorData()
 151   to allow generators to include data in the action=query result.
 152 * The following methods have been deprecated and may be removed in a future
 153   release:
 154   * ApiBase::getDescription
 155   * ApiBase::getParamDescription
 156   * ApiBase::getExamples
 157   * ApiBase::makeHelpMsg
 158   * ApiBase::makeHelpArrayToString
 159   * ApiBase::makeHelpMsgParameters
 160   * ApiFormatBase::setUnescapeAmps
 161   * ApiFormatBase::getWantsHelp
 162   * ApiFormatBase::setHelp
 163   * ApiFormatBase::formatHTML
 164   * ApiFormatBase::setBufferResult
 165   * ApiFormatBase::getDescription
 166   * ApiMain::setHelp
 167   * ApiMain::reallyMakeHelpMsg
 168   * ApiMain::makeHelpMsgHeader
 169   * ApiQueryImageInfo::getPropertyDescriptions
 170 * The following classes have been deprecated and may be removed in a future
 171   release:
 172   * ApiQueryDeletedrevs
 173
 174 === Languages updated in 1.25 ===
 175
 176 MediaWiki supports over 350 languages. Many localisations are updated
 177 regularly. Below only new and removed languages are listed, as well as
 178 changes to languages because of Bugzilla reports.
 179
 180 * (bug 64440) Kazakh (kk) wikis should no longer forcefully reset the user's
 181   interface language to kk where unexpected.
 182
 183 === Other changes in 1.25 ===
 184 * The skin autodiscovery mechanism, deprecated in MediaWiki 1.23, has been
 185   removed. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for
 186   migration guide for creators and users of custom skins that relied on it.
 187 * Javascript variable 'wgFileCanRotate' now only available on Special:Upload.
 188 * (bug 56257) Set site logo from mediawiki.skinning.interface module instead of
 189   inline styles in the HTML.
 190 * Removed ApiQueryUsers::getAutoGroups(). (deprecated since 1.20)
 191 * Removed XmlDumpWriter::schemaVersion(). (deprecated since 1.20)
 192 * Removed LogEventsList::getDisplayTitle(). (deprecated since 1.20)
 193 * Removed Preferences::trySetUserEmail(). (deprecated since 1.20)
 194 * Removed mw.user.name() and mw.user.anonymous() methods. (deprecated since 1.20)
 195 * Removed 'ok' and 'err' parameters in the mediawiki.api modules. (deprecated
 196   since 1.20)
 197 * Removed 'async' parameter from the  mw.Api#getCategories() method. (deprecated
 198   since 1.20)
 199 * Removed 'jquery.json' module. (deprecated since 1.24)
 200   Use the 'json' module and global JSON object instead.
 201 * Deprecated OutputPage::readOnlyPage() and OutputPage::rateLimited().
 202   Also, the former will now throw an MWException if called with one or more
 203   arguments.
 204 * Removed hitcounters and associated code.
 205 * The "temp" zone of the upload respository is now considered private. If it
 206   already exists (such as under the images/ directory), please make sure that
 207   the directory is not web readable (e.g. via a .htaccess file).
 208 * BREAKING CHANGE: In the XML dump format used by Special:Export and
 209   dumpBackup.php, the <model> and <format> tags now apprear before the <text>
 210   tag, instead of after the <text> and <sha1> tags.
 211   The new schema version is 0.10, the new schema URI is
 212   <https://www.mediawiki.org/xml/export-0.10.xsd>.
 213 * MWFunction::call() and MWFunction::callArray() were removed, having being
 214   deprecated in 1.22.
 215 * Deprecated the getInternalLinkAttributes, getInternalLinkAttributesObj,
 216   and getInternalLinkAttributes methods in Linker, and removed
 217   getExternalLinkAttributes method, which was deprecated in MediaWiki 1.18.
 218 * Removed Sites class, which was deprecated in 1.21 and replaced by SiteSQLStore.
 219 * The mw.api.getToken() method now uses action=query?meta=tokens. This will now
 220   fail for custom tokens registered only via the deprecated ApiTokensGetTokenTypes
 221   hook. The ApiQueryTokensRegisterTypes hook should be used for this to work.
 222 * Added wgRelevantArticleId to the client-side config, for use on special pages.
 223
 224 == Compatibility ==
 225
 226 MediaWiki 1.25 requires PHP 5.3.3 or later. There is experimental support for
 227 HHVM 3.3.0.
 228
 229 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 230 support for them is somewhat less mature. There is experimental support for
 231 Oracle and Microsoft SQL Server.
 232
 233 The supported versions are:
 234
 235 * MySQL 5.0.2 or later
 236 * PostgreSQL 8.3 or later
 237 * SQLite 3.3.7 or later
 238 * Oracle 9.0.1 or later
 239 * Microsoft SQL Server 2005 (9.00.1399)
 240
 241 == Upgrading ==
 242
 243 1.25 has several database changes since 1.24, and will not work without schema
 244 updates. Note that due to changes to some very large tables like the revision
 245 table, the schema update may take quite long (minutes on a medium sized site,
 246 many hours on a large site).
 247
 248 If upgrading from before 1.11, and you are using a wiki as a commons
 249 repository, make sure that it is updated as well. Otherwise, errors may arise
 250 due to database schema changes.
 251
 252 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 253 new database fields are filled with data.
 254
 255 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 256 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 257 with MediaWiki 1.21.
 258
 259 Don't forget to always back up your database before upgrading!
 260
 261 See the file UPGRADE for more detailed upgrade instructions.
 262
 263 For notes on 1.23.x and older releases, see HISTORY.
 264
 265 == Online documentation ==
 266
 267 Documentation for both end-users and site administrators is available on
 268 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 269 for pages that explicitly state that their contents are in the public domain):
 270
 271         https://www.mediawiki.org/wiki/Documentation
 272
 273 == Mailing list ==
 274
 275 A mailing list is available for MediaWiki user support and discussion:
 276
 277         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 278
 279 A low-traffic announcements-only list is also available:
 280
 281         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 282
 283 It's highly recommended that you sign up for one of these lists if you're
 284 going to run a public MediaWiki, so you can be notified of security fixes.
 285
 286 == IRC help ==
 287
 288 There's usually someone online in #mediawiki on irc.freenode.net.