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