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