Merge "API: Validate API error codes"
[lhc/web/wiklou.git] / RELEASE-NOTES-1.33
1 == MediaWiki 1.33 ==
2
3 THIS IS NOT A RELEASE YET
4
5 MediaWiki 1.33 is an alpha-quality branch and is not recommended for use in
6 production.
7
8 === Configuration changes in 1.33 ===
9
10 ==== New configuration ====
11 * $wgEnablePartialBlocks – This enables the Partial Blocks feature, which gives
12 accounts with block permissions the ability to block users, IPs, and IP ranges
13 from editing specific pages, while allowing them to edit the rest of the wiki.
14 * $wgMediaInTargetLanguage – whether multilingual images should be dispalyed in
15 the current parse language where available.
16
17 ==== Changed configuration ====
18 * Some external link searches will not work correctly until update.php (or
19 refreshExternallinksIndex.php) is run. These include searches for links using
20 IP addresses, internationalized domain names, and possibly mailto links.
21 * (T193868) $wgChangeTagsSchemaMigrationStage — This temporary setting, added in
22 MediaWiki 1.32, now defaults to MIGRATION_NEW instead of MIGRATION_WRITE_BOTH.
23 * …
24
25 ==== Removed configuration ====
26 * (T199334) $wgTagStatisticsNewTable — This temporary setting, added in
27 MediaWiki 1.32, has now been removed. When loading Special:Tags, MediaWiki
28 will now always use the `change_tag_def` instead of the `change_tag` table.
29 * …
30
31 === New features in 1.33 ===
32 * The 'GetPreferences' hook now receives an additional $context parameter.
33 * (T96041) __EXPECTUNUSEDCATEGORY__ on a category page causes the category
34 to be hidden on Special:UnusedCategories.
35 * Add PasswordPolicy to check the password isn't in the large blacklist.
36 * …
37
38 === External library changes in 1.33 ===
39
40 ==== New external libraries ====
41 * Added wikimedia/password-blacklist 0.1.3
42 * …
43
44 ==== Changed external libraries ====
45 * Updated wikimedia/xmp-reader from 0.6.0 to 0.6.1.
46 * Updated wikimedia/scoped-callback from 2.0.0 to 3.0.0.
47 * …
48
49 ==== Removed external libraries ====
50 * …
51
52 === Bug fixes in 1.33 ===
53 * …
54
55 === Action API changes in 1.33 ===
56 * (T198913) Added 'ApiOptions' hook.
57 * The JSON formatversion=2 is no longer experimental.
58 * …
59
60 === Action API internal changes in 1.33 ===
61 * A number of deprecated methods for API documentation, intended for overriding
62 by extensions, are no longer called by MediaWiki, and will emit deprecation
63 notices if your extension attempts to use them:
64 * ApiBase::getDescription() (deprecated in 1.25)
65 * ApiBase::getParamDescription() (deprecated in 1.25)
66 * ApiBase::getExamples() (deprecated in 1.25)
67 * ApiBase::getDescriptionMessage() (deprecated in 1.30)
68 Additionally, the 'APIGetDescription' and 'APIGetParamDescription' hooks have
69 been removed, as their only use was to let extensions override values returned
70 by getDescription() and getParamDescription(), respectively.
71 * API error codes may only contain ASCII letters, numbers, underscore, and
72 hyphen. Methods such as ApiBase::dieWithError() and
73 ApiMessageTrait::setApiCode() will throw an InvalidArgumentException if
74 passed a bad code.
75 * …
76
77 === Languages updated in 1.33 ===
78 MediaWiki supports over 350 languages. Many localisations are updated regularly.
79 Below only new and removed languages are listed, as well as changes to languages
80 because of Phabricator reports.
81
82 * (T203908) Added language support for Eastern Pwo (kjp).
83
84 === Breaking changes in 1.33 ===
85 * The parameteter $lang in DifferenceEngine::setTextLanguage must be of type
86 Language. Other types are deprecated since 1.32.
87 * Skin::doEditSectionLink requires type Language for the parameter $lang.
88 The parameters $tooltip and $lang are mandatory. Omitting the parameters is
89 deprecated since 1.32.
90 * Language::truncate(), deprecated in 1.31, has been removed.
91 * UtfNormal, deprecated in 1.25, was removed. Use UtfNormal\Validator directly
92 instead.
93 * (T197179) In OOUI HTMLForm fields, the parameters 'notice', 'notice-messages',
94 and 'notice-message', which were deprecated in 1.32, were removed. Instead,
95 use 'help', 'help-message', and 'help-messages'.
96 * (T197179) HTMLFormField::getNotices(), deprecated in 1.32, was removed.
97 * The "Parsoid v1" compatibility mappings in ParsoidVirtualRESTService and
98 RestbaseVirtualRESTService, deprecated since 1.26, have been removed.
99 Use the RESTBase v1 or Parsoid v3 API instead.
100 * ParserOptions defaults 'tidy' to true now, since the untidy modes of the
101 parser are being deprecated and ParserOptions::getCanonicalOverrides()
102 has always been true at any rate.
103 * A number of deprecated methods for API documentation, intended for overriding
104 by extensions, are no longer called by MediaWiki, and will emit deprecation
105 notices if your extension attempts to use them:
106 * ApiBase::getDescription() (deprecated in 1.25)
107 * ApiBase::getParamDescription() (deprecated in 1.25)
108 * ApiBase::getExamples() (deprecated in 1.25)
109 * ApiBase::getDescriptionMessage() (deprecated in 1.30)
110 Additionally, the 'APIGetDescription' and 'APIGetParamDescription' hooks have
111 been removed, as their only use was to let extensions override values returned
112 by getDescription() and getParamDescription(), respectively.
113 * The authentication hooks 'AbortAutoAccount' 'AbortNewAccount', 'AbortLogin',
114 'LoginUserMigrated', 'UserCreateForm', and 'UserLoginForm', all deprecated by
115 the creation of AuthManager in 1.27, have been removed. This also means that
116 the FakeAuthTemplate and LoginForm classes are removed, that FakeAuthTemplate
117 is no longer passed into LoginSignupSpecialPage->getFieldDefinitions(), and
118 that LoginSignupSpecialPage->getBCFieldDefinitions() is removed.
119 * The 'jquery.localize' module, deprecated in 1.32, has been removed. Instead,
120 use 'jquery.i18n'.
121 * The hooks LanguageGetSpecialPageAliases and LanguageGetMagic, deprecated since
122 1.16, have now been removed. Instead, use $specialPageAliases or $magicWords
123 respectively in a $wgExtensionMessagesFiles file.
124 * The following methods of the Preferences class, deprecated in 1.31, have been
125 removed:
126 * getSaveBlacklist()
127 * loadPreferenceValues()
128 * getOptionFromUser()
129 * profilePreferences()
130 * skinPreferences()
131 * filesPreferences()
132 * datetimePreferences()
133 * renderingPreferences()
134 * editingPreferences()
135 * rcPreferences()
136 * watchlistPreferences()
137 * searchPreferences()
138 * miscPreferences()
139 * generateSkinOptions()
140 * getDateOptions()
141 * getImageSizes()
142 * getThumbSizes()
143 * validateSignature()
144 * cleanSignature()
145 * getTimezoneOptions()
146 * filterIntval()
147 * filterTimezoneInput()
148 * getTimeZoneList()
149
150 === Deprecations in 1.33 ===
151 * The configuration option $wgUseESI has been deprecated, and is expected
152 to be removed in a future release.
153 * The configuration option $wgSquidPurgeUseHostHeader has been deprecated,
154 and is expected to be removed in a future release.
155 * The configuration options $wgFixArabicUnicode and $wgFixMalayalamUnicode,
156 introduced in MW 1.17, have been deprecated. These fixes will always be
157 applied for Arabic and Malayalam in the future. Please enable these on
158 your local wiki (if you have them explicitly set to false) and run
159 maintenance/cleanupTitles.php to fix any existing page titles.
160 * The LegacyHookPreAuthenticationProvider class, deprecated since its creation
161 in 1.27 as part of the AuthManager re-write, now emits deprecation warnings.
162 This will help identify the issue if you added it to $wgAuthManagerConfig.
163 * wfSplitWikiId() is now deprecated. Cache key generation should have the wiki
164 domain ID as a key component and use makeGlobalKey().
165 * …
166
167 === Other changes in 1.33 ===
168 * (T208871) The hard-coded Google search form on the database error page was
169 removed.
170 * …
171
172 == Compatibility ==
173 MediaWiki 1.33 requires PHP 7.0.0 or later. Although HHVM 3.18.5 or later is
174 supported, it is generally advised to use PHP 7.0.0 or later for long term
175 support.
176
177 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
178 but support for them is somewhat less mature. There is experimental support for
179 Oracle and Microsoft SQL Server.
180
181 The supported versions are:
182
183 * MySQL 5.5.8 or later
184 * PostgreSQL 9.2 or later
185 * SQLite 3.3.7 or later
186 * Oracle 9.0.1 or later
187 * Microsoft SQL Server 2005 (9.00.1399)
188
189 == Upgrading ==
190 1.33 has several database changes since 1.32, 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 Don't forget to always back up your database before upgrading!
196
197 See the file UPGRADE for more detailed upgrade instructions, including
198 important information when upgrading from versions prior to 1.11.
199
200 For notes on 1.32.x and older releases, see HISTORY.
201
202 == Online documentation ==
203 Documentation for both end-users and site administrators is available on
204 MediaWiki.org, and is covered under the GNU Free Documentation License (except
205 for pages that explicitly state that their contents are in the public domain):
206
207 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
208
209 == Mailing list ==
210 A mailing list is available for MediaWiki user support and discussion:
211
212 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
213
214 A low-traffic announcements-only list is also available:
215
216 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
217
218 It's highly recommended that you sign up for one of these lists if you're
219 going to run a public MediaWiki, so you can be notified of security fixes.
220
221 == IRC help ==
222 There's usually someone online in #mediawiki on irc.freenode.net.