Remove getSecondaryDataUpdates and friends from ParserOutput.
[lhc/web/wiklou.git] / 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 * ProfilerStandard and ProfilerSimpleTrace were removed. Make sure that any
37 StartProfiler.php config is updated to reflect this. Xhprof is available
38 for zend/hhvm. Also, for hhvm, one can consider using its xenon profiler.
39 * Default value of $wgSVGConverters['rsvg'] now uses the 'rsvg-convert' binary
40 rather than 'rsvg'.
41 * Default value of $wgSVGConverters['ImageMagick'] now uses transparent
42 background with white fallback color, rather than just white background.
43 * MediaWikiBagOStuff class removed, make sure any object cache config
44 uses SqlBagOStuff instead.
45 * The 'daemonized' flag must be set to true in $wgJobTypeConf for any redis
46 job queues. This means that mediawiki/services/jobrunner service has to
47 be installed and running for any such queues to work.
48
49 === New features in 1.25 ===
50 * (T64861) Updated plural rules to CLDR 26. Includes incompatible changes
51 for plural forms in Russian, Prussian, Tagalog, Manx and several languages
52 that fall back to Russian.
53 * (T60139) ResourceLoaderFileModule now supports language fallback
54 for 'languageScripts'.
55 * Added a new hook, "ContentAlterParserOutput", to allow extensions to modify the
56 parser output for a content object before links update.
57 * (T37785) Enhanced recent changes and extended watchlist are now default.
58 Documentation: https://meta.wikimedia.org/wiki/Help:Enhanced_recent_changes
59 and https://www.mediawiki.org/wiki/Manual:$wgDefaultUserOptions.
60 * (T69341) SVG images will no longer be base64-encoded when being embedded
61 in CSS. This results in slight size increase before gzip compression (due to
62 percent-encoding), but up to 20% decrease after it.
63 * Update jStorage to v0.4.12.
64 * MediaWiki now natively supports page status indicators: icons (or short text
65 snippets) usually displayed in the top-right corner of the page. They have
66 been in use on Wikipedia for a long time, implemented using templates and CSS
67 absolute positioning.
68 - Basic wikitext syntax: <indicator name="foo">[[File:Foo.svg|20px]]</indicator>
69 - Usage instructions: https://www.mediawiki.org/wiki/Help:Page_status_indicators
70 - Adjusting custom skins to support indicators:
71 https://www.mediawiki.org/wiki/Manual:Skinning#Page_status_indicators
72 * Edit tokens may now be time-limited: passing a maximum age to
73 User::matchEditToken will reject any older tokens.
74 * The debug logging internals have been overhauled, and are now using the
75 PSR-3 interfaces.
76 * Update CSSJanus to v1.1.1.
77 * Update lessphp to v0.5.0.
78 * Added a hook, "ApiOpenSearchSuggest", to allow extensions to provide extracts
79 and images for ApiOpenSearch output. The semantics are identical to the
80 "OpenSearchXml" hook provided by the OpenSearchXml extension.
81 * PrefixSearchBackend hook now has an $offset parameter. Combined with $limit,
82 this allows for pagination of prefix results. Extensions using this hook
83 should implement supporting behavior. Not doing so can result in undefined
84 behavior from API clients trying to continue through prefix results.
85 * Update jQuery from v1.11.1 to v1.11.2.
86 * External libraries installed via composer will now be displayed
87 on Special:Version in their own section. Extensions or skins that are
88 installed via composer will not be shown in this section as it is assumed
89 they will add the proper credits to the skins or extensions section. They
90 can also be accessed through the API via the new siprop=libraries to
91 ApiQuerySiteInfo.
92 * Update QUnit from v1.14.0 to v1.16.0.
93 * Update Moment.js from v2.8.3 to v2.8.4.
94 * Special:Tags now allows for manipulating the list of user-modifiable change
95 tags. Actually modifying the tagging of a revision or log entry is not
96 implemented yet.
97 * Added 'managetags' user right and 'ChangeTagCanCreate', 'ChangeTagCanDelete',
98 and 'ChangeTagCanCreate' hooks to allow for managing user-modifiable change
99 tags.
100 * Added 'ChangeTagsListActive' hook, to separate the concepts of "defined" and
101 "active" formerly conflated by the 'ListDefinedTags' hook.
102 * Added TemplateParser class that provides a server-side interface to cachable
103 dynamically-compiled Mustache templates (currently uses lightncandy library).
104 * Clickable anchors for each section heading in the content are now generated
105 and appear in the gutter on hovering over the heading.
106 * Added 'CategoryViewer::doCategoryQuery' and 'CategoryViewer::generateLink' hooks
107 to allow extensions to override how links to pages are rendered within NS_CATEGORY
108 * (T19665) Special:WantedPages only lists page which having at least one red link
109 pointing to it.
110 * New hooks 'ApiMain::moduleManager' and 'ApiQuery::moduleManager', can be
111 used for conditional registration of API modules.
112
113 ==== External libraries ====
114 * MediaWiki now requires certain external libraries to be installed. In the past
115 these were bundled inside the Git repository of MediaWiki core, but now they
116 need to be installed separately. For users using the tarball, this will be taken
117 care of and no action will be required. Users using Git will either need to use
118 composer to fetch dependencies or use the mediawiki/vendor repository which includes
119 all dependencies for MediaWiki core and ones used in Wikimedia deployment. Detailed
120 instructions can be found at:
121 https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries
122 * The following libraries are now required:
123 ** psr/log
124 This library provides the interfaces set by the PSR-3 standard (http://www.php-fig.org/psr/psr-3/)
125 which are used by MediaWiki internally via the MWLoggerFactory class.
126 See the structured logging RfC (https://www.mediawiki.org/wiki/Requests_for_comment/Structured_logging)
127 for more background information.
128 ** cssjanus/cssjanus
129 This library was formerly bundled with MediaWiki core and has been removed.
130 It automatically flips CSS for RTL support.
131 ** leafo/lessphp
132 This library was formerly bundled with MediaWiki core and has been removed.
133 It compiles LESS files into CSS.
134 ** wikimedia/cdb
135 This library was formerly a part of MediaWiki core, and has been moved into a separate library.
136 It provides CDB functions which are used in the Interwiki and Localization caches.
137 More information about the library can be found at https://www.mediawiki.org/wiki/CDB.
138
139 === Bug fixes in 1.25 ===
140 * (T73003) No additional code will be generated to try to load CSS-embedded
141 SVG images in Internet Explorer 6 and 7, as they don't support them anyway.
142 * (T69021) On Special:BookSources, corrected validation of ISBNs (both
143 10- and 13-digit forms) containing "X".
144 * Page moving was refactored into a MovePage class. As part of that:
145 ** The AbortMove hook was removed.
146 ** MovePageIsValidMove is for extensions to specify whether a page
147 cannot be moved for technical reasons, and should not be overridden.
148 ** MovePageCheckPermissions is for checking whether the given user is
149 allowed to make the move.
150 ** Title::moveNoAuth() was deprecated. Use the MovePage class instead.
151 ** Title::moveTo() was deprecated. Use the MovePage class instead.
152 ** Title::isValidMoveOperation() broken down into MovePage::isValidMove()
153 and MovePage::checkPermissions().
154 * (T18530) Multiple autocomments are now formatted in an edit summary.
155 * (T70361) Autocomments containing "/*" are parsed correctly.
156 * The Special:WhatLinksHere page linked from 'Number of redirects to this page'
157 on action=info about a file page does not list file links anymore.
158 * (T78637) Search bar is not autofocused unless it is empty so that proper scrolling using arrow keys is possible.
159 * (T50853) Database::makeList() modified to handle 'NULL' separately when building IN clause
160 * (T85192) Captcha position modified in Usercreate template. As a result:
161 ** extrafields parameter added to Usercreate.php to insert additional data
162 ** 'extend' method added to QuickTemplate to append additional values to any field of data array
163 * (T86974) Several Title methods now load from the database when necessary
164 (instead of returning incorrect results) even when the page ID is known.
165 * (T74070) Duplicate search for archived files on file upload now omits the extension.
166 This requires the fa_sha1 field being populated.
167
168 === Action API changes in 1.25 ===
169 * (T67403) XML tag highlighting is now only performed for formats
170 "xmlfm" and "wddxfm".
171 * action=paraminfo supports generalized submodules (modules=query+value),
172 querymodules and formatmodules are deprecated
173 * action=paraminfo no longer outputs descriptions and other help text by
174 default. If needed, it may be requested using the new 'helpformat' parameter.
175 * action=help has been completely rewritten, and outputs help in HTML
176 rather than plain text.
177 * Hitting api.php without specifying an action now displays only the help for
178 the main module, with links to submodule help.
179 * API help is no longer displayed on errors.
180 * 'uselang' is now a recognized API parameter; "uselang=user" may be used to
181 explicitly select the language from the current user's preferences, and
182 "uselang=content" may be used to select the wiki's content language.
183 * Default output format for the API is now jsonfm.
184 * Simplified continuation will return a "batchcomplete" property in the result
185 when a batch of pages is complete.
186 * Pretty-printed HTML output now has nicer formatting and (if available)
187 better syntax highlighting.
188 * Deprecated list=deletedrevs in favor of newly-added prop=deletedrevisions and
189 list=alldeletedrevisions.
190 * prop=revisions will gracefully continue when given too many revids or titles,
191 rather than just ignoring the extras.
192 * prop=revisions will no longer die if rvcontentformat doesn't match a
193 revision's content model; it will instead warn and omit the content.
194 * If the user has the 'deletedhistory' right, action=query's revids parameter
195 will now recognize deleted revids.
196 * prop=revisions may be used as a generator, generating revids.
197 * (T68776) format=json results will no longer be corrupted when
198 $wgMangleFlashPolicy is in effect. format=php results will cleanly return an
199 error instead of returning invalid serialized data.
200 * Generators may now return data for the generated pages when used with
201 action=query.
202 * Query page data for generator=search and generator=prefixsearch will now
203 include an "index" field, which may be used by the client for sorting the
204 search results.
205 * ApiOpenSearch now supports XML output.
206 * ApiOpenSearch will now output descriptions and URLs as array indexes 2 and 3
207 in JSON format.
208 * (T76051) list=tags will now continue correctly.
209 * (T76052) list=tags can now indicate whether a tag is defined.
210 * (T75522) list=prefixsearch now supports continuation
211 * (T78737) action=expandtemplates can now return page properties.
212 * (T78690) list=allimages now accepts multiple pipe-separated values
213 for the 'aimime' parameter.
214 * prop=info with inprop=protections will now return applicable protection types
215 with the 'restrictiontypes' key.
216 * (T85417) When resolving redirects, ApiPageSet will now add the targets of
217 interwiki redirects to the list of interwiki titles.
218 * (T85417) When outputting the list of redirect titles, a 'tointerwiki'
219 property (like the existing 'tofragment' property) will be set.
220 * Added action=managetags to allow for managing the list of
221 user-modifiable change tags. Actually modifying the tagging of a revision or
222 log entry is not implemented yet.
223 * list=tags has additional properties to indicate 'active' status and tag
224 sources.
225 * siprop=libraries was added to ApiQuerySiteInfo to list installed external libraries.
226 * (T88010) Added action=checktoken, to test a CSRF token's validity.
227 * (T88010) Added intestactions to prop=info, to allow querying of
228 Title::userCan() via the API.
229 * Default type param for query list=watchlist and list=recentchanges has
230 been changed from all types (e.g. including 'external') to 'edit|new|log'.
231
232 === Action API internal changes in 1.25 ===
233 * ApiHelp has been rewritten to support i18n and paginated HTML output.
234 Most existing modules should continue working without changes, but should do
235 the following:
236 * Add an i18n message "apihelp-{$moduleName}-description" to replace getDescription().
237 * Add i18n messages "apihelp-{$moduleName}-param-{$param}" for each parameter
238 to replace getParamDescription(). If necessary, the settings array returned
239 by getParams() can use the new ApiBase::PARAM_HELP_MSG key to override the
240 message.
241 * Implement getExamplesMessages() to replace getExamples().
242 * Modules with submodules (like action=query) must have their submodules
243 override ApiBase::getParent() to return the correct parent object.
244 * The 'APIGetDescription' and 'APIGetParamDescription' hooks are deprecated,
245 and will have no effect for modules using i18n messages. Use
246 'APIGetDescriptionMessages' and 'APIGetParamDescriptionMessages' instead.
247 * Api formatters will no longer be asked to display the help screen on errors.
248 * ApiMain::getCredits() was removed. The credits are available in the
249 'api-credits' i18n message.
250 * ApiFormatBase has been changed to support i18n and syntax highlighting via
251 extensions with the new 'ApiFormatHighlight' hook. Core syntax highlighting
252 has been removed.
253 * ApiFormatBase now always buffers. Output is done when
254 ApiFormatBase::closePrinter is called.
255 * Much of the logic in ApiQueryRevisions has been split into ApiQueryRevisionsBase.
256 * The 'revids' parameter supplied by ApiPageSet will now count deleted
257 revisions as "good" if the user has the 'deletedhistory' right. New methods
258 ApiPageSet::getLiveRevisionIDs() and ApiPageSet::getDeletedRevisionIDs() are
259 provided to access just the live or just the deleted revids.
260 * Added ApiPageSet::setGeneratorData() and ApiPageSet::populateGeneratorData()
261 to allow generators to include data in the action=query result.
262 * New hooks 'ApiMain::moduleManager' and 'ApiQuery::moduleManager', can be
263 used for conditional registration of API modules.
264 * The following methods have been deprecated and may be removed in a future
265 release:
266 * ApiBase::getDescription
267 * ApiBase::getParamDescription
268 * ApiBase::getExamples
269 * ApiBase::makeHelpMsg
270 * ApiBase::makeHelpArrayToString
271 * ApiBase::makeHelpMsgParameters
272 * ApiFormatBase::setUnescapeAmps
273 * ApiFormatBase::getWantsHelp
274 * ApiFormatBase::setHelp
275 * ApiFormatBase::formatHTML
276 * ApiFormatBase::setBufferResult
277 * ApiFormatBase::getDescription
278 * ApiMain::setHelp
279 * ApiMain::reallyMakeHelpMsg
280 * ApiMain::makeHelpMsgHeader
281 * ApiQueryImageInfo::getPropertyDescriptions
282 * The following classes have been deprecated and may be removed in a future
283 release:
284 * ApiQueryDeletedrevs
285
286 === Languages updated in 1.25 ===
287
288 MediaWiki supports over 350 languages. Many localisations are updated
289 regularly. Below only new and removed languages are listed, as well as
290 changes to languages because of Bugzilla reports.
291
292 * (T66440) Kazakh (kk) wikis should no longer forcefully reset the user's
293 interface language to kk where unexpected.
294
295 === Other changes in 1.25 ===
296 * The skin autodiscovery mechanism, deprecated in MediaWiki 1.23, has been
297 removed. See https://www.mediawiki.org/wiki/Manual:Skin_autodiscovery for
298 migration guide for creators and users of custom skins that relied on it.
299 * Javascript variables 'wgFileCanRotate' and 'wgFileExtensions' now only
300 available on Special:Upload.
301 * (T58257) Set site logo from mediawiki.skinning.interface module instead of
302 inline styles in the HTML.
303 * Removed ApiQueryUsers::getAutoGroups(). (deprecated since 1.20)
304 * Removed XmlDumpWriter::schemaVersion(). (deprecated since 1.20)
305 * Removed LogEventsList::getDisplayTitle(). (deprecated since 1.20)
306 * Removed Preferences::trySetUserEmail(). (deprecated since 1.20)
307 * Removed mw.user.name() and mw.user.anonymous() methods. (deprecated since 1.20)
308 * Removed 'ok' and 'err' parameters in the mediawiki.api modules. (deprecated
309 since 1.20)
310 * Removed 'async' parameter from the mw.Api#getCategories() method. (deprecated
311 since 1.20)
312 * Removed 'jquery.json' module. (deprecated since 1.24)
313 Use the 'json' module and global JSON object instead.
314 * Deprecated OutputPage::readOnlyPage() and OutputPage::rateLimited().
315 Also, the former will now throw an MWException if called with one or more
316 arguments.
317 * Removed hitcounters and associated code.
318 * The "temp" zone of the upload respository is now considered private. If it
319 already exists (such as under the images/ directory), please make sure that
320 the directory is not web readable (e.g. via a .htaccess file).
321 * BREAKING CHANGE: In the XML dump format used by Special:Export and
322 dumpBackup.php, the <model> and <format> tags now apprear before the <text>
323 tag, instead of after the <text> and <sha1> tags.
324 The new schema version is 0.10, the new schema URI is:
325 https://www.mediawiki.org/xml/export-0.10.xsd
326 * MWFunction::call() and MWFunction::callArray() were removed, having being
327 deprecated in 1.22.
328 * Deprecated the getInternalLinkAttributes, getInternalLinkAttributesObj,
329 and getInternalLinkAttributes methods in Linker, and removed
330 getExternalLinkAttributes method, which was deprecated in MediaWiki 1.18.
331 * Removed Sites class, which was deprecated in 1.21 and replaced by SiteSQLStore.
332 * The mw.api.getToken() method now uses action=query?meta=tokens. This will now
333 fail for custom tokens registered only via the deprecated ApiTokensGetTokenTypes
334 hook. The ApiQueryTokensRegisterTypes hook should be used for this to work.
335 * Added wgRelevantArticleId to the client-side config, for use on special pages.
336 * Deprecated the TitleIsCssOrJsPage hook. Superseded by the
337 ContentHandlerDefaultModelFor hook since MediaWiki 1.21.
338 * Deprecated the TitleIsWikitextPage hook. Superseded by the
339 ContentHandlerDefaultModelFor hook since MediaWiki 1.21.
340 * Changed parsing of variables in schema (.sql) files:
341 ** The substituted values are no longer parsed. (Formerly, several passes
342 were made for each variable, so depending on the order in which variables
343 were defined, variables might have been found inside encoded values. This
344 is no longer the case.)
345 ** Variables are no longer string encoded when the /*$var*/ syntax is used.
346 If string encoding is necessary, use the '{$var}' syntax instead.
347 ** Variable names must only consist of one or more of the characters
348 "A-Za-z0-9_".
349 ** In source text of the form '{$A}'{$B}' or `{$A}`{$B}`, where variable A
350 does not exist yet variable B does, the latter may not be replaced.
351 However, this difference is unlikely to arise in practice.
352 * (T67278) RFC, PMID, and ISBN "magic links" must be surrounded by non-word
353 characters on both sides.
354 * The FormatAutocomments hook will now receive $pre and $post as booleans,
355 rather than as strings that must be prepended or appended to $comment.
356 * (T30950, T31025) RFC, PMID, and ISBN "magic links" can no longer contain
357 newlines; but they can contain &nbsp; and other non-newline whitespace.
358 * The 'mediawiki.action.edit' ResourceLoader module no longer generates the edit
359 toolbar, which has been moved to a separate 'mediawiki.toolbar' module. If you
360 relied on this behavior, update your scripts' dependencies.
361 * HTMLForm's 'vform' display style has been separated to a subclass. Therefore:
362 * HTMLForm::isVForm() is now deprecated.
363 * You can no longer do this:
364 $form = new HTMLForm( … );
365 $form->setDisplayFormat( 'vform' ); // throws exception
366 Instead, do this:
367 $form = HTMLForm::factory( 'vform', … );
368 * Deprecated Revision methods getRawUser(), getRawUserText() and getRawComment().
369 * BREAKING CHANGE: mediawiki.user.generateRandomSessionId:
370 The alphabet of the prior string returned was A-Za-z0-9 and now it is 0-9A-F
371 * (T87504) Avoid serving SVG background-images in CSS for Opera 12, which
372 renders them incorrectly when combined with border-radius or background-size.
373 * Removed maintenance script dumpSisterSites.php.
374 * DatabaseBase class constructors must be called using the array argument style.
375 Ideally, DatabaseBase:factory() should be used instead in most cases.
376 * Deprecated ParserOutput::addSecondaryDataUpdate and ParserOutput::getSecondaryDataUpdates.
377 This is a hard deprecation, with getSecondaryDataUpdates returning an empty array and
378 addSecondaryDataUpdate throwing an exception. These functions will be removed in 1.26,
379 since they interfere with caching of ParserOutput objects.
380 * Introduced new hook 'SecondaryDataUpdates' that allows extensions to inject custom updates.
381
382 == Compatibility ==
383
384 MediaWiki 1.25 requires PHP 5.3.3 or later. There is experimental support for
385 HHVM 3.3.0.
386
387 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
388 support for them is somewhat less mature. There is experimental support for
389 Oracle and Microsoft SQL Server.
390
391 The supported versions are:
392
393 * MySQL 5.0.2 or later
394 * PostgreSQL 8.3 or later
395 * SQLite 3.3.7 or later
396 * Oracle 9.0.1 or later
397 * Microsoft SQL Server 2005 (9.00.1399)
398
399 == Upgrading ==
400
401 1.25 has several database changes since 1.24, and will not work without schema
402 updates. Note that due to changes to some very large tables like the revision
403 table, the schema update may take quite long (minutes on a medium sized site,
404 many hours on a large site).
405
406 If upgrading from before 1.11, and you are using a wiki as a commons
407 repository, make sure that it is updated as well. Otherwise, errors may arise
408 due to database schema changes.
409
410 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
411 new database fields are filled with data.
412
413 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
414 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
415 with MediaWiki 1.21.
416
417 Don't forget to always back up your database before upgrading!
418
419 See the file UPGRADE for more detailed upgrade instructions.
420
421 For notes on 1.24.x and older releases, see HISTORY.
422
423 == Online documentation ==
424
425 Documentation for both end-users and site administrators is available on
426 MediaWiki.org, and is covered under the GNU Free Documentation License (except
427 for pages that explicitly state that their contents are in the public domain):
428
429 https://www.mediawiki.org/wiki/Documentation
430
431 == Mailing list ==
432
433 A mailing list is available for MediaWiki user support and discussion:
434
435 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
436
437 A low-traffic announcements-only list is also available:
438
439 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
440
441 It's highly recommended that you sign up for one of these lists if you're
442 going to run a public MediaWiki, so you can be notified of security fixes.
443
444 == IRC help ==
445
446 There's usually someone online in #mediawiki on irc.freenode.net.