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 * (T74951) 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 * (T64861) 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 * (T60139) 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 * (T37785) 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 * (T69341) 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 * PrefixSearchBackend hook now has an $offset parameter. Combined with $limit,
  63   this allows for pagination of prefix results. Extensions using this hook
  64   should implement supporting behavior. Not doing so can result in undefined
  65   behavior from API clients trying to continue through prefix results.
  66
  67 === Bug fixes in 1.25 ===
  68 * (T73003) No additional code will be generated to try to load CSS-embedded
  69   SVG images in Internet Explorer 6 and 7, as they don't support them anyway.
  70 * (T69021) On Special:BookSources, corrected validation of ISBNs (both
  71   10- and 13-digit forms) containing "X".
  72 * Page moving was refactored into a MovePage class. As part of that:
  73 ** The AbortMove hook was removed.
  74 ** MovePageIsValidMove is for extensions to specify whether a page
  75    cannot be moved for technical reasons, and should not be overriden.
  76 ** MovePageCheckPermissions is for checking whether the given user is
  77    allowed to make the move.
  78 ** Title::moveNoAuth() was deprecated. Use the MovePage class instead.
  79 ** Title::moveTo() was deprecated. Use the MovePage class instead.
  80 ** Title::isValidMoveOperation() broken down into MovePage::isValidMove()
  81    and MovePage::checkPermissions().
  82
  83 === Action API changes in 1.25 ===
  84 * (T67403) XML tag highlighting is now only performed for formats
  85   "xmlfm" and "wddxfm".
  86 * action=paraminfo supports generalized submodules (modules=query+value),
  87   querymodules and formatmodules are deprecated
  88 * action=paraminfo no longer outputs descriptions and other help text by
  89   default. If needed, it may be requested using the new 'helpformat' parameter.
  90 * action=help has been completely rewritten, and outputs help in HTML
  91   rather than plain text.
  92 * Hitting api.php without specifying an action now displays only the help for
  93   the main module, with links to submodule help.
  94 * API help is no longer displayed on errors.
  95 * 'uselang' is now a recognized API parameter; "uselang=user" may be used to
  96   explicitly select the language from the current user's preferences, and
  97   "uselang=content" may be used to select the wiki's content language.
  98 * Default output format for the API is now jsonfm.
  99 * Simplified continuation will return a "batchcomplete" property in the result
 100   when a batch of pages is complete.
 101 * Pretty-printed HTML output now has nicer formatting and (if available)
 102   better syntax highlighting.
 103 * Deprecated list=deletedrevs in favor of newly-added prop=deletedrevisions and
 104   list=alldeletedrevisions.
 105 * prop=revisions will gracefully continue when given too many revids or titles,
 106   rather than just ignoring the extras.
 107 * prop=revisions will no longer die if rvcontentformat doesn't match a
 108   revision's content model; it will instead warn and omit the content.
 109 * If the user has the 'deletedhistory' right, action=query's revids parameter
 110   will now recognize deleted revids.
 111 * prop=revisions may be used as a generator, generating revids.
 112 * (T68776) format=json results will no longer be corrupted when
 113   $wgMangleFlashPolicy is in effect. format=php results will cleanly return an
 114   error instead of returning invalid serialized data.
 115 * Generators may now return data for the generated pages when used with
 116   action=query.
 117 * Query page data for generator=search and generator=prefixsearch will now
 118   include an "index" field, which may be used by the client for sorting the
 119   search results.
 120 * ApiOpenSearch now supports XML output.
 121 * ApiOpenSearch will now output descriptions and URLs as array indexes 2 and 3
 122   in JSON format.
 123 * (T76051) list=tags will now continue correctly.
 124 * (T76052) list=tags can now indicate whether a tag is defined.
 125 * (T75522) list=prefixsearch now supports continuation
 126
 127 === Action API internal changes in 1.25 ===
 128 * ApiHelp has been rewritten to support i18n and paginated HTML output.
 129   Most existing modules should continue working without changes, but should do
 130   the following:
 131   * Add an i18n message "apihelp-{$moduleName}-description" to replace getDescription().
 132   * Add i18n messages "apihelp-{$moduleName}-param-{$param}" for each parameter
 133     to replace getParamDescription(). If necessary, the settings array returned
 134     by getParams() can use the new ApiBase::PARAM_HELP_MSG key to override the
 135     message.
 136   * Implement getExamplesMessages() to replace getExamples().
 137 * Modules with submodules (like action=query) must have their submodules
 138   override ApiBase::getParent() to return the correct parent object.
 139 * The 'APIGetDescription' and 'APIGetParamDescription' hooks are deprecated,
 140   and will have no effect for modules using i18n messages. Use
 141   'APIGetDescriptionMessages' and 'APIGetParamDescriptionMessages' instead.
 142 * Api formatters will no longer be asked to display the help screen on errors.
 143 * ApiMain::getCredits() was removed. The credits are available in the
 144   'api-credits' i18n message.
 145 * ApiFormatBase has been changed to support i18n and syntax highlighting via
 146   extensions with the new 'ApiFormatHighlight' hook. Core syntax highlighting
 147   has been removed.
 148 * ApiFormatBase now always buffers. Output is done when
 149   ApiFormatBase::closePrinter is called.
 150 * Much of the logic in ApiQueryRevisions has been split into ApiQueryRevisionsBase.
 151 * The 'revids' parameter supplied by ApiPageSet will now count deleted
 152   revisions as "good" if the user has the 'deletedhistory' right. New methods
 153   ApiPageSet::getLiveRevisionIDs() and ApiPageSet::getDeletedRevisionIDs() are
 154   provided to access just the live or just the deleted revids.
 155 * Added ApiPageSet::setGeneratorData() and ApiPageSet::populateGeneratorData()
 156   to allow generators to include data in the action=query result.
 157 * The following methods have been deprecated and may be removed in a future
 158   release:
 159   * ApiBase::getDescription
 160   * ApiBase::getParamDescription
 161   * ApiBase::getExamples
 162   * ApiBase::makeHelpMsg
 163   * ApiBase::makeHelpArrayToString
 164   * ApiBase::makeHelpMsgParameters
 165   * ApiFormatBase::setUnescapeAmps
 166   * ApiFormatBase::getWantsHelp
 167   * ApiFormatBase::setHelp
 168   * ApiFormatBase::formatHTML
 169   * ApiFormatBase::setBufferResult
 170   * ApiFormatBase::getDescription
 171   * ApiMain::setHelp
 172   * ApiMain::reallyMakeHelpMsg
 173   * ApiMain::makeHelpMsgHeader
 174   * ApiQueryImageInfo::getPropertyDescriptions
 175 * The following classes have been deprecated and may be removed in a future
 176   release:
 177   * ApiQueryDeletedrevs
 178
 179 === Languages updated in 1.25 ===
 180
 181 MediaWiki supports over 350 languages. Many localisations are updated
 182 regularly. Below only new and removed languages are listed, as well as
 183 changes to languages because of Bugzilla reports.
 184
 185 * (T66440) Kazakh (kk) wikis should no longer forcefully reset the user's
 186   interface language to kk where unexpected.
 187
 188 === Other changes in 1.25 ===
 189 * The skin autodiscovery mechanism, deprecated in MediaWiki 1.23, has been
 190   removed. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for
 191   migration guide for creators and users of custom skins that relied on it.
 192 * Javascript variable 'wgFileCanRotate' now only available on Special:Upload.
 193 * (T58257) Set site logo from mediawiki.skinning.interface module instead of
 194   inline styles in the HTML.
 195 * Removed ApiQueryUsers::getAutoGroups(). (deprecated since 1.20)
 196 * Removed XmlDumpWriter::schemaVersion(). (deprecated since 1.20)
 197 * Removed LogEventsList::getDisplayTitle(). (deprecated since 1.20)
 198 * Removed Preferences::trySetUserEmail(). (deprecated since 1.20)
 199 * Removed mw.user.name() and mw.user.anonymous() methods. (deprecated since 1.20)
 200 * Removed 'ok' and 'err' parameters in the mediawiki.api modules. (deprecated
 201   since 1.20)
 202 * Removed 'async' parameter from the  mw.Api#getCategories() method. (deprecated
 203   since 1.20)
 204 * Removed 'jquery.json' module. (deprecated since 1.24)
 205   Use the 'json' module and global JSON object instead.
 206 * Deprecated OutputPage::readOnlyPage() and OutputPage::rateLimited().
 207   Also, the former will now throw an MWException if called with one or more
 208   arguments.
 209 * Removed hitcounters and associated code.
 210 * The "temp" zone of the upload respository is now considered private. If it
 211   already exists (such as under the images/ directory), please make sure that
 212   the directory is not web readable (e.g. via a .htaccess file).
 213 * BREAKING CHANGE: In the XML dump format used by Special:Export and
 214   dumpBackup.php, the <model> and <format> tags now apprear before the <text>
 215   tag, instead of after the <text> and <sha1> tags.
 216   The new schema version is 0.10, the new schema URI is
 217   <https://www.mediawiki.org/xml/export-0.10.xsd>.
 218 * MWFunction::call() and MWFunction::callArray() were removed, having being
 219   deprecated in 1.22.
 220 * Deprecated the getInternalLinkAttributes, getInternalLinkAttributesObj,
 221   and getInternalLinkAttributes methods in Linker, and removed
 222   getExternalLinkAttributes method, which was deprecated in MediaWiki 1.18.
 223 * Removed Sites class, which was deprecated in 1.21 and replaced by SiteSQLStore.
 224 * The mw.api.getToken() method now uses action=query?meta=tokens. This will now
 225   fail for custom tokens registered only via the deprecated ApiTokensGetTokenTypes
 226   hook. The ApiQueryTokensRegisterTypes hook should be used for this to work.
 227 * Added wgRelevantArticleId to the client-side config, for use on special pages.
 228
 229 == Compatibility ==
 230
 231 MediaWiki 1.25 requires PHP 5.3.3 or later. There is experimental support for
 232 HHVM 3.3.0.
 233
 234 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
 235 support for them is somewhat less mature. There is experimental support for
 236 Oracle and Microsoft SQL Server.
 237
 238 The supported versions are:
 239
 240 * MySQL 5.0.2 or later
 241 * PostgreSQL 8.3 or later
 242 * SQLite 3.3.7 or later
 243 * Oracle 9.0.1 or later
 244 * Microsoft SQL Server 2005 (9.00.1399)
 245
 246 == Upgrading ==
 247
 248 1.25 has several database changes since 1.24, and will not work without schema
 249 updates. Note that due to changes to some very large tables like the revision
 250 table, the schema update may take quite long (minutes on a medium sized site,
 251 many hours on a large site).
 252
 253 If upgrading from before 1.11, and you are using a wiki as a commons
 254 repository, make sure that it is updated as well. Otherwise, errors may arise
 255 due to database schema changes.
 256
 257 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
 258 new database fields are filled with data.
 259
 260 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
 261 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
 262 with MediaWiki 1.21.
 263
 264 Don't forget to always back up your database before upgrading!
 265
 266 See the file UPGRADE for more detailed upgrade instructions.
 267
 268 For notes on 1.24.x and older releases, see HISTORY.
 269
 270 == Online documentation ==
 271
 272 Documentation for both end-users and site administrators is available on
 273 MediaWiki.org, and is covered under the GNU Free Documentation License (except
 274 for pages that explicitly state that their contents are in the public domain):
 275
 276         https://www.mediawiki.org/wiki/Documentation
 277
 278 == Mailing list ==
 279
 280 A mailing list is available for MediaWiki user support and discussion:
 281
 282         https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
 283
 284 A low-traffic announcements-only list is also available:
 285
 286         https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
 287
 288 It's highly recommended that you sign up for one of these lists if you're
 289 going to run a public MediaWiki, so you can be notified of security fixes.
 290
 291 == IRC help ==
 292
 293 There's usually someone online in #mediawiki on irc.freenode.net.