Remove left-over references from comments to removed FSRepo class
[lhc/web/wiklou.git] / RELEASE-NOTES-1.29
1 == MediaWiki 1.29 ==
2
3 THIS IS NOT A RELEASE YET
4
5 MediaWiki 1.29 is an alpha-quality branch and is not recommended for use in
6 production.
7
8 === Configuration changes in 1.29 ===
9 * Default cookie expiration time has been reduced to 30 days. Login cookie expiration time is
10 kept at 180 days.
11 * A new configuration variable has been added: $wgCookieSetOnAutoblock. This
12 determines whether to set a cookie when a user is autoblocked. Doing so means
13 that a blocked user, even after logging out and moving to a new IP address,
14 will still be blocked.
15 * The resetpassword right and associated password reset capture feature has
16 been removed.
17 * The $error parameter to the EmailUser hook should be set to a Status object
18 or boolean false. This should be compatible with at least MediaWiki 1.23 if
19 not earlier. Returning a raw HTML string is now deprecated.
20 * The $message parameter to the ApiCheckCanExecute hook should be set to an
21 ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
22 code for ApiBase::parseMsg() will no longer work.
23 * ApiBase::$messageMap is no longer public. Code attempting to access it will
24 result in a PHP fatal error.
25 * $wgUserEmailUseReplyTo is now true by default to work around restrictive DMARC policies.
26 * Subpages are now enabled by default in the Template namespace. Set
27 $wgNamespacesWithSubpages[NS_TEMPLATE] to false to keep the old behavior.
28 * $wgRunJobsAsync is now false by default (T142751). This change only affects
29 wikis with $wgJobRunRate > 0.
30
31 === New features in 1.29 ===
32 * (T5233) A cookie can now be set when a user is autoblocked, to track that user if
33 they move to a new IP address. This is disabled by default.
34 * Added ILocalizedException interface to standardize the use of localized
35 exceptions, largely so the API can handle them more sensibly.
36 * Blocks created automatically by MediaWiki, such as for configured proxies or
37 dnsbls, are now indicated as such and use a new i18n message when displayed.
38 * Added new $wgHTTPImportTimeout setting. Sets timeout for
39 downloading the XML dump during a transwiki import in seconds.
40 * Parser limit report is now available in machine-readable format to JavaScript
41 via mw.config.get('wgPageParseReport').
42 * Added $wgSoftBlockRanges, to allow for automatically blocking anonymous edits
43 from certain IP ranges (e.g. private IPs).
44 * (T59603) Added new magic word {{PAGELANGUAGE}} which returns the language code
45 of the page being parsed.
46
47 === External library changes in 1.29 ===
48
49 ==== Upgraded external libraries ====
50 * Updated QUnit from v1.22.0 to v1.23.1.
51
52 ==== New external libraries ====
53
54 ==== Removed and replaced external libraries ====
55
56 === Bug fixes in 1.29 ===
57 * (T62604) Core parser functions returning a number now format the number according
58 to the page content language, not wiki content language.
59
60 === Action API changes in 1.29 ===
61 * Submitting sensitive authentication request parameters to action=clientlogin,
62 action=createaccount, action=linkaccount, and action=changeauthenticationdata
63 in the query string is now an error. They should be submitted in the POST
64 body instead.
65 * The capture option for action=resetpassword has been removed
66 * action=clearhasmsg now requires a POST.
67 * (T47843) API errors and warnings may be requested in non-English languages
68 using the new 'errorformat', 'errorlang', and 'errorsuselocal' parameters.
69 * API error codes may have changed. Most notably, errors from modules using
70 parameter prefixes (e.g. all query submodules) will no longer be prefixed.
71 * ApiPageSet-using modules will report the 'invalidreason' using the specified
72 'errorformat'.
73 * action=emailuser may return a "Warnings" status, and now returns 'warnings' and
74 'errors' subelements (as applicable) instead of 'message'.
75 * action=imagerotate returns an 'errors' subelement rather than 'errormessage'.
76 * action=move now reports errors when moving the talk page as an array under
77 key 'talkmove-errors', rather than using 'talkmove-error-code' and
78 'talkmove-error-info'. The format for subpage move errors has also changed.
79 * action=revisiondelete no longer includes a "rendered" property on warnings
80 and errors for each item. Use errorformat=wikitext if you're wanting parsed
81 output.
82 * action=rollback no longer returns a "messageHtml" property. Use
83 errorformat=html if you're wanting HTML formatting of error messages.
84 * action=upload now reports optional stash failures as an array under key
85 'stasherrors' rather than a 'stashfailed' text string.
86 * action=watch reports 'errors' and 'warnings' instead of a single 'error', and
87 no longer returns a 'message' on success.
88 * Added action=validatepassword to validate passwords for the account creation
89 and password change forms.
90
91 === Action API internal changes in 1.29 ===
92 * New methods were added to ApiBase to handle errors and warnings using i18n
93 keys. Methods for using hard-coded English messages were deprecated:
94 * ApiBase::dieUsage() was deprecated
95 * ApiBase::dieUsageMsg() was deprecated
96 * ApiBase::dieUsageMsgOrDebug() was deprecated
97 * ApiBase::getErrorFromStatus() was deprecated
98 * ApiBase::parseMsg() was deprecated
99 * ApiBase::setWarning() was deprecated
100 * ApiBase::$messageMap is no longer public. Code attempting to access it will
101 result in a PHP fatal error.
102 * The $message parameter to the ApiCheckCanExecute hook should be set to an
103 ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
104 code for ApiBase::parseMsg() will no longer work.
105 * UsageException is deprecated in favor of ApiUsageException. For the time
106 being ApiUsageException is a subclass of UsageException to allow things that
107 catch only UsageException to still function properly.
108 * If, for some strange reason, code was using an ApiErrorFormatter instead of
109 ApiErrorFormatter_BackCompat, note that the result format has changed and
110 various methods now take a module path rather than a module name.
111 * ApiMessageTrait::getApiCode() now strips 'apierror-' and 'apiwarn-' prefixes
112 from the message key, and maps some message keys for backwards compatibility.
113
114 === Languages updated in 1.29 ===
115
116 MediaWiki supports over 350 languages. Many localisations are updated
117 regularly. Below only new and removed languages are listed, as well as
118 changes to languages because of Phabricator reports.
119
120 * Based as always on linguistic studies on intelligibility and language
121 knowledge by geography, language fallbacks have been expanded. When a
122 translation is missing in the user's preferred interface language, the
123 corresponding translation for the fallback language will be used instead.
124 English will only be used as last resort when there are no translations.
125 Some configurations (such as date formats and gender namespaces) have also
126 been updated when using the fallback language's configuration was inadequate.
127 The new or reinstated language fallbacks are (after cs ↔ sk in 1.28):
128 hsb ↔ dsb, io → eo, mdf → ru, pnt → el, roa-tara → it.
129
130 ==== No fallback for Ukrainian ====
131 * (T39314) The fallback from Ukrainian to Russian was removed. The Ukrainian
132 language will now use the default fallback language: English. When a translation
133 to Ukrainian is not available, an English string will be shown.
134
135 === Other changes in 1.29 ===
136 * Database::getSearchEngine() (deprecated in 1.28) was removed. Use
137 SearchEngineFactory::getSearchEngineClass() instead.
138 * $wgSessionsInMemcached (deprecated in 1.20) was removed. No replacement is
139 required as all sessions are stored in Object Cache now.
140 * MWHttpRequest::execute() should be considered to return a StatusValue; the
141 Status return type is deprecated.
142 * User::edits() (deprecated in 1.21) was removed.
143 * Xml::escapeJsString() (deprecated in 1.21) was removed.
144 * Article::getText() and Article::prepareTextForEdit() (deprecated in 1.21)
145 were removed.
146 * Article::getAutosummary() and WikiPage::getAutosummary (deprecated in 1.21)
147 were removed.
148 * Hooks ArticleViewCustom, EditPageGetDiffText and ShowRawCssJs (deprecated in 1.21)
149 were removed.
150 * Class RevisiondeleteAction (deprecated in 1.25) was removed.
151 * WikiPage::prepareTextForEdit() (deprecated in 1.21) was removed.
152 * WikiPage::getText() (deprecated in 1.21) was removed.
153 * Article::fetchContent() (deprecated in 1.21) was removed.
154 * User::getPassword() (deprecated in 1.27) was removed.
155 * User::getTemporaryPassword() (deprecated in 1.27) was removed.
156 * User::isPasswordReminderThrottled() (deprecated in 1.27) was removed.
157 * FSRepo (deprecated in 1.19) was removed.
158 * WebRequest::checkSessionCookie() (deprecated in 1.27) was removed. Use
159 \MediaWiki\Session\SessionManager::singleton()->getPersistedSessionId() instead.
160 * Class ImageGallery (deprecated in 1.22) was removed.
161 Use ImageGalleryBase::factory instead.
162 * Title::moveNoAuth() (deprecated in 1.25) was removed. Use MovePage class instead.
163 * Hook UnknownAction (deprecated in 1.19) was actually deprecated (it will now emit warnings).
164 Create a subclass of Action, and add it to $wgActions instead.
165 * WikiRevision:getText() (deprecated since 1.21) is no longer marked deprecated.
166 * Linker:getInterwikiLinkAttributes (deprecated since 1.25) was removed.
167 * Linker:getInternalLinkAttributes (deprecated since 1.25) was removed.
168 * Linker:getInternalLinkAttributesObj (deprecated since 1.25) was removed.
169 * Linker:getLinkAttributesInternal (deprecated since 1.25) was removed.
170
171 == Compatibility ==
172
173 MediaWiki 1.29 requires PHP 5.5.9 or later. There is experimental support for
174 HHVM 3.6.5 or later.
175
176 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
177 support for them is somewhat less mature. There is experimental support for
178 Oracle and Microsoft SQL Server.
179
180 The supported versions are:
181
182 * MySQL 5.0.3 or later
183 * PostgreSQL 8.3 or later
184 * SQLite 3.3.7 or later
185 * Oracle 9.0.1 or later
186 * Microsoft SQL Server 2005 (9.00.1399)
187
188 == Upgrading ==
189
190 1.29 has several database changes since 1.28, and will not work without schema
191 updates. Note that due to changes to some very large tables like the revision
192 table, the schema update may take quite long (minutes on a medium sized site,
193 many hours on a large site).
194
195 If upgrading from before 1.11, and you are using a wiki as a commons
196 repository, make sure that it is updated as well. Otherwise, errors may arise
197 due to database schema changes.
198
199 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
200 new database fields are filled with data.
201
202 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
203 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
204 with MediaWiki 1.21.
205
206 Don't forget to always back up your database before upgrading!
207
208 See the file UPGRADE for more detailed upgrade instructions.
209
210 For notes on 1.28.x and older releases, see HISTORY.
211
212 == Online documentation ==
213
214 Documentation for both end-users and site administrators is available on
215 MediaWiki.org, and is covered under the GNU Free Documentation License (except
216 for pages that explicitly state that their contents are in the public domain):
217
218 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
219
220 == Mailing list ==
221
222 A mailing list is available for MediaWiki user support and discussion:
223
224 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
225
226 A low-traffic announcements-only list is also available:
227
228 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
229
230 It's highly recommended that you sign up for one of these lists if you're
231 going to run a public MediaWiki, so you can be notified of security fixes.
232
233 == IRC help ==
234
235 There's usually someone online in #mediawiki on irc.freenode.net.