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