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