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