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