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