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