Added reason suggestion in block/delete/protect forms
[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 * Added JavaScript that provides as-you-type suggestions for reason
47 on the block, delete and protect forms.
48
49 === External library changes in 1.29 ===
50
51 ==== Upgraded external libraries ====
52 * Updated QUnit from v1.22.0 to v1.23.1.
53
54 ==== New external libraries ====
55
56 ==== Removed and replaced external libraries ====
57
58 === Bug fixes in 1.29 ===
59 * (T62604) Core parser functions returning a number now format the number according
60 to the page content language, not wiki content language.
61
62 === Action API changes in 1.29 ===
63 * Submitting sensitive authentication request parameters to action=clientlogin,
64 action=createaccount, action=linkaccount, and action=changeauthenticationdata
65 in the query string is now an error. They should be submitted in the POST
66 body instead.
67 * The capture option for action=resetpassword has been removed
68 * action=clearhasmsg now requires a POST.
69 * (T47843) API errors and warnings may be requested in non-English languages
70 using the new 'errorformat', 'errorlang', and 'errorsuselocal' parameters.
71 * API error codes may have changed. Most notably, errors from modules using
72 parameter prefixes (e.g. all query submodules) will no longer be prefixed.
73 * ApiPageSet-using modules will report the 'invalidreason' using the specified
74 'errorformat'.
75 * action=emailuser may return a "Warnings" status, and now returns 'warnings' and
76 'errors' subelements (as applicable) instead of 'message'.
77 * action=imagerotate returns an 'errors' subelement rather than 'errormessage'.
78 * action=move now reports errors when moving the talk page as an array under
79 key 'talkmove-errors', rather than using 'talkmove-error-code' and
80 'talkmove-error-info'. The format for subpage move errors has also changed.
81 * action=revisiondelete no longer includes a "rendered" property on warnings
82 and errors for each item. Use errorformat=wikitext if you're wanting parsed
83 output.
84 * action=rollback no longer returns a "messageHtml" property. Use
85 errorformat=html if you're wanting HTML formatting of error messages.
86 * action=upload now reports optional stash failures as an array under key
87 'stasherrors' rather than a 'stashfailed' text string.
88 * action=watch reports 'errors' and 'warnings' instead of a single 'error', and
89 no longer returns a 'message' on success.
90 * Added action=validatepassword to validate passwords for the account creation
91 and password change forms.
92
93 === Action API internal changes in 1.29 ===
94 * New methods were added to ApiBase to handle errors and warnings using i18n
95 keys. Methods for using hard-coded English messages were deprecated:
96 * ApiBase::dieUsage() was deprecated
97 * ApiBase::dieUsageMsg() was deprecated
98 * ApiBase::dieUsageMsgOrDebug() was deprecated
99 * ApiBase::getErrorFromStatus() was deprecated
100 * ApiBase::parseMsg() was deprecated
101 * ApiBase::setWarning() was deprecated
102 * ApiBase::$messageMap is no longer public. Code attempting to access it will
103 result in a PHP fatal error.
104 * The $message parameter to the ApiCheckCanExecute hook should be set to an
105 ApiMessage. This is compatible with MediaWiki 1.27 and later. Returning a
106 code for ApiBase::parseMsg() will no longer work.
107 * UsageException is deprecated in favor of ApiUsageException. For the time
108 being ApiUsageException is a subclass of UsageException to allow things that
109 catch only UsageException to still function properly.
110 * If, for some strange reason, code was using an ApiErrorFormatter instead of
111 ApiErrorFormatter_BackCompat, note that the result format has changed and
112 various methods now take a module path rather than a module name.
113 * ApiMessageTrait::getApiCode() now strips 'apierror-' and 'apiwarn-' prefixes
114 from the message key, and maps some message keys for backwards compatibility.
115
116 === Languages updated in 1.29 ===
117
118 MediaWiki supports over 350 languages. Many localisations are updated
119 regularly. Below only new and removed languages are listed, as well as
120 changes to languages because of Phabricator reports.
121
122 * Based as always on linguistic studies on intelligibility and language
123 knowledge by geography, language fallbacks have been expanded. When a
124 translation is missing in the user's preferred interface language, the
125 corresponding translation for the fallback language will be used instead.
126 English will only be used as last resort when there are no translations.
127 Some configurations (such as date formats and gender namespaces) have also
128 been updated when using the fallback language's configuration was inadequate.
129 The new or reinstated language fallbacks are (after cs ↔ sk in 1.28):
130 hsb ↔ dsb, io → eo, mdf → ru, pnt → el, roa-tara → it.
131
132 ==== No fallback for Ukrainian ====
133 * (T39314) The fallback from Ukrainian to Russian was removed. The Ukrainian
134 language will now use the default fallback language: English. When a translation
135 to Ukrainian is not available, an English string will be shown.
136
137 === Other changes in 1.29 ===
138 * Database::getSearchEngine() (deprecated in 1.28) was removed. Use
139 SearchEngineFactory::getSearchEngineClass() instead.
140 * $wgSessionsInMemcached (deprecated in 1.20) was removed. No replacement is
141 required as all sessions are stored in Object Cache now.
142 * MWHttpRequest::execute() should be considered to return a StatusValue; the
143 Status return type is deprecated.
144 * User::edits() (deprecated in 1.21) was removed.
145 * Xml::escapeJsString() (deprecated in 1.21) was removed.
146 * Article::getText() and Article::prepareTextForEdit() (deprecated in 1.21)
147 were removed.
148 * Article::getAutosummary() and WikiPage::getAutosummary (deprecated in 1.21)
149 were removed.
150 * Hooks ArticleViewCustom, EditPageGetDiffText and ShowRawCssJs (deprecated in 1.21)
151 were removed.
152 * Class RevisiondeleteAction (deprecated in 1.25) was removed.
153 * WikiPage::prepareTextForEdit() (deprecated in 1.21) was removed.
154 * WikiPage::getText() (deprecated in 1.21) was removed.
155 * Article::fetchContent() (deprecated in 1.21) was removed.
156 * User::getPassword() (deprecated in 1.27) was removed.
157 * User::getTemporaryPassword() (deprecated in 1.27) was removed.
158 * User::isPasswordReminderThrottled() (deprecated in 1.27) was removed.
159 * FSRepo (deprecated in 1.19) was removed.
160 * WebRequest::checkSessionCookie() (deprecated in 1.27) was removed. Use
161 \MediaWiki\Session\SessionManager::singleton()->getPersistedSessionId() instead.
162 * Class ImageGallery (deprecated in 1.22) was removed.
163 Use ImageGalleryBase::factory instead.
164 * Title::moveNoAuth() (deprecated in 1.25) was removed. Use MovePage class instead.
165 * Hook UnknownAction (deprecated in 1.19) was actually deprecated (it will now emit warnings).
166 Create a subclass of Action, and add it to $wgActions instead.
167 * WikiRevision:getText() (deprecated since 1.21) is no longer marked deprecated.
168
169 == Compatibility ==
170
171 MediaWiki 1.29 requires PHP 5.5.9 or later. There is experimental support for
172 HHVM 3.6.5 or later.
173
174 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
175 support for them is somewhat less mature. There is experimental support for
176 Oracle and Microsoft SQL Server.
177
178 The supported versions are:
179
180 * MySQL 5.0.3 or later
181 * PostgreSQL 8.3 or later
182 * SQLite 3.3.7 or later
183 * Oracle 9.0.1 or later
184 * Microsoft SQL Server 2005 (9.00.1399)
185
186 == Upgrading ==
187
188 1.29 has several database changes since 1.28, and will not work without schema
189 updates. Note that due to changes to some very large tables like the revision
190 table, the schema update may take quite long (minutes on a medium sized site,
191 many hours on a large site).
192
193 If upgrading from before 1.11, and you are using a wiki as a commons
194 repository, make sure that it is updated as well. Otherwise, errors may arise
195 due to database schema changes.
196
197 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
198 new database fields are filled with data.
199
200 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
201 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
202 with MediaWiki 1.21.
203
204 Don't forget to always back up your database before upgrading!
205
206 See the file UPGRADE for more detailed upgrade instructions.
207
208 For notes on 1.28.x and older releases, see HISTORY.
209
210 == Online documentation ==
211
212 Documentation for both end-users and site administrators is available on
213 MediaWiki.org, and is covered under the GNU Free Documentation License (except
214 for pages that explicitly state that their contents are in the public domain):
215
216 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
217
218 == Mailing list ==
219
220 A mailing list is available for MediaWiki user support and discussion:
221
222 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
223
224 A low-traffic announcements-only list is also available:
225
226 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
227
228 It's highly recommended that you sign up for one of these lists if you're
229 going to run a public MediaWiki, so you can be notified of security fixes.
230
231 == IRC help ==
232
233 There's usually someone online in #mediawiki on irc.freenode.net.