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