3dfca9a44e8f4010ae145cd7eb0ed44b37cb1a42
[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 * MediaWiki now always tidies user output, and most related
30 configuration has been removed. Thus $wgUseTidy, $wgTidyBin,
31 $wgTidyConf, $wgTidyOpts, $wgTidyInternal, and $wgDebugTidy, all
32 deprecated since 1.26, have now all been removed. The $wgTidyConfig
33 setting remains only for Remex experimental features or debugging.
34 * …
35
36 === New features in 1.33 ===
37 * (T96041) __EXPECTUNUSEDCATEGORY__ on a category page causes the category
38 to be hidden on Special:UnusedCategories.
39 * Add PasswordPolicy to check the password isn't in the large blacklist.
40 * The AuthManagerLoginAuthenticateAudit hook has a new parameter for
41 additional information about the authentication event.
42 * …
43
44 === External library changes in 1.33 ===
45
46 ==== New external libraries ====
47 * Added wikimedia/password-blacklist 0.1.4.
48 * …
49 * Added guzzlehttp/guzzle 6.3.3 and dependents:
50 * guzzlehttp/promises 1.3.1
51 * guzzlehttp/psr7 1.5.0
52 * psr/http-message 1.0.1
53 * ralouphie/getallheaders 2.0.5
54
55 ==== Changed external libraries ====
56 * Updated wikimedia/xmp-reader from 0.6.0 to 0.6.1.
57 * Updated wikimedia/scoped-callback from 2.0.0 to 3.0.0.
58 * Updated wikimedia/ip-set from 1.2.0 to 2.0.0.
59 * The deprecated IPSet\IPSet alias was removed, Wikimedia\IPSet must be
60 used instead.
61 * …
62
63 ==== Removed external libraries ====
64 * …
65
66 === Bug fixes in 1.33 ===
67 * (T164211) Special:UserRights could sometimes fail with a
68 "conflict detected" error when there weren't any conflicts.
69 * …
70
71 === Action API changes in 1.33 ===
72 * (T198913) Added 'ApiOptions' hook.
73 * The JSON formatversion=2 is no longer experimental.
74 * Internal API errors (those with code beginning "internal_api_error") will
75 include the exception class name in a data field named "errorclass".
76 * Class names are not guaranteed to remain stable, and in particular database
77 exceptions will now include the "Wikimedia\Rdbms\" prefix in the class name.
78 * The code including an exception class name is deprecated. In the future,
79 all internal errors will use code "internal_api_error".
80 * (T212356) When using action=delete on pages with many revisions, the module
81 may return a boolean-true 'scheduled' and no 'logid'. This signifies that the
82 deletion will be processed via the job queue.
83
84 === Action API internal changes in 1.33 ===
85 * A number of deprecated methods for API documentation, intended for overriding
86 by extensions, are no longer called by MediaWiki, and will emit deprecation
87 notices if your extension attempts to use them:
88 * ApiBase::getDescription() (deprecated in 1.25)
89 * ApiBase::getParamDescription() (deprecated in 1.25)
90 * ApiBase::getExamples() (deprecated in 1.25)
91 * ApiBase::getDescriptionMessage() (deprecated in 1.30)
92 Additionally, the 'APIGetDescription' and 'APIGetParamDescription' hooks have
93 been removed, as their only use was to let extensions override values returned
94 by getDescription() and getParamDescription(), respectively.
95 * API error codes may only contain ASCII letters, numbers, underscore, and
96 hyphen. Methods such as ApiBase::dieWithError() and
97 ApiMessageTrait::setApiCode() will throw an InvalidArgumentException if
98 passed a bad code.
99 * …
100
101 === Languages updated in 1.33 ===
102 MediaWiki supports over 350 languages. Many localisations are updated regularly.
103 Below only new and removed languages are listed, as well as changes to languages
104 because of Phabricator reports.
105
106 * (T203908) Added language support for Eastern Pwo (kjp).
107
108 === Breaking changes in 1.33 ===
109 * The parameteter $lang in DifferenceEngine::setTextLanguage must be of type
110 Language. Other types are deprecated since 1.32.
111 * Skin::doEditSectionLink requires type Language for the parameter $lang.
112 The parameters $tooltip and $lang are mandatory. Omitting the parameters is
113 deprecated since 1.32.
114 * Language::truncate(), deprecated in 1.31, has been removed.
115 * UtfNormal, deprecated in 1.25, was removed. Use UtfNormal\Validator directly
116 instead.
117 * (T197179) In OOUI HTMLForm fields, the parameters 'notice', 'notice-messages',
118 and 'notice-message', which were deprecated in 1.32, were removed. Instead,
119 use 'help', 'help-message', and 'help-messages'.
120 * (T197179) HTMLFormField::getNotices(), deprecated in 1.32, was removed.
121 * The "Parsoid v1" compatibility mappings in ParsoidVirtualRESTService and
122 RestbaseVirtualRESTService, deprecated since 1.26, have been removed.
123 Use the RESTBase v1 or Parsoid v3 API instead.
124 * ParserOptions defaults 'tidy' to true now, since the untidy modes of the
125 parser are being deprecated and ParserOptions::getCanonicalOverrides()
126 has always been true at any rate.
127 * Support for disabling tidy and external tidy implementations has been removed.
128 This was deprecated in 1.32. The pure PHP Remex tidy implementation is now
129 used and no configuration is necessary.
130 * A number of deprecated methods for API documentation, intended for overriding
131 by extensions, are no longer called by MediaWiki, and will emit deprecation
132 notices if your extension attempts to use them:
133 * ApiBase::getDescription() (deprecated in 1.25)
134 * ApiBase::getParamDescription() (deprecated in 1.25)
135 * ApiBase::getExamples() (deprecated in 1.25)
136 * ApiBase::getDescriptionMessage() (deprecated in 1.30)
137 Additionally, the 'APIGetDescription' and 'APIGetParamDescription' hooks have
138 been removed, as their only use was to let extensions override values returned
139 by getDescription() and getParamDescription(), respectively.
140 * The authentication hooks 'AbortAutoAccount' 'AbortNewAccount', 'AbortLogin',
141 'LoginUserMigrated', 'UserCreateForm', and 'UserLoginForm', all deprecated by
142 the creation of AuthManager in 1.27, have been removed. This also means that
143 the FakeAuthTemplate and LoginForm classes are removed, that FakeAuthTemplate
144 is no longer passed into LoginSignupSpecialPage->getFieldDefinitions(), and
145 that LoginSignupSpecialPage->getBCFieldDefinitions() is removed.
146 * The 'jquery.localize' module, deprecated in 1.32, has been removed. Instead,
147 use 'jquery.i18n'.
148 * The hooks LanguageGetSpecialPageAliases and LanguageGetMagic, deprecated since
149 1.16, have now been removed. Instead, use $specialPageAliases or $magicWords
150 respectively in a $wgExtensionMessagesFiles file.
151 * The following methods of the Preferences class, deprecated in 1.31, have been
152 removed:
153 * getSaveBlacklist()
154 * loadPreferenceValues()
155 * getOptionFromUser()
156 * profilePreferences()
157 * skinPreferences()
158 * filesPreferences()
159 * datetimePreferences()
160 * renderingPreferences()
161 * editingPreferences()
162 * rcPreferences()
163 * watchlistPreferences()
164 * searchPreferences()
165 * miscPreferences()
166 * generateSkinOptions()
167 * getDateOptions()
168 * getImageSizes()
169 * getThumbSizes()
170 * validateSignature()
171 * cleanSignature()
172 * getTimezoneOptions()
173 * filterIntval()
174 * filterTimezoneInput()
175 * getTimeZoneList()
176 * mw.util.jsMessage(), deprecated in 1.20, was removed. Use mw.notify instead.
177 * (T61113) User::EDIT_TOKEN_SUFFIX was removed. It was deprecated since 1.27.
178
179 === Deprecations in 1.33 ===
180 * The configuration option $wgUseESI has been deprecated, and is expected
181 to be removed in a future release.
182 * The configuration option $wgSquidPurgeUseHostHeader has been deprecated,
183 and is expected to be removed in a future release.
184 * The configuration options $wgFixArabicUnicode and $wgFixMalayalamUnicode,
185 introduced in MW 1.17, have been deprecated. These fixes will always be
186 applied for Arabic and Malayalam in the future. Please enable these on
187 your local wiki (if you have them explicitly set to false) and run
188 maintenance/cleanupTitles.php to fix any existing page titles.
189 * The LegacyHookPreAuthenticationProvider class, deprecated since its creation
190 in 1.27 as part of the AuthManager re-write, now emits deprecation warnings.
191 This will help identify the issue if you added it to $wgAuthManagerConfig.
192 * wfSplitWikiId() is now deprecated. Cache key generation should have the wiki
193 domain ID as a key component and use makeGlobalKey().
194 * (T202094) Title::getUserCaseDBKey() is deprecated; instead, please use
195 Title::getDBKey(), which doesn't vary case.
196 * User::getPasswordValidity() is now deprecated. User::checkPasswordValidity()
197 returns the same information in a more useful format.
198 * For Linker::generateTOC() and Linker::tocList(), passing strings or booleans
199 as the $lang parameter was deprecated. The same applies to DummyLinker.
200 * The PasswordPolicy 'PasswordCannotBePopular' has been deprecated. To
201 follow best practices, it is reccommended to use 'PasswordNotInLargeBlacklist'
202 instead which blacklists 100,000 commonly used passwords.
203 * …
204
205 === Other changes in 1.33 ===
206 * (T208871) The hard-coded Google search form on the database error page was
207 removed.
208 * (T201747) Html::openElement() warns if given an element name wiht a space
209 in it.
210 * …
211
212 == Compatibility ==
213 MediaWiki 1.33 requires PHP 7.0.0 or later. Although HHVM 3.18.5 or later is
214 supported, it is generally advised to use PHP 7.0.0 or later for long term
215 support.
216
217 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
218 but support for them is somewhat less mature. There is experimental support for
219 Oracle and Microsoft SQL Server.
220
221 The supported versions are:
222
223 * MySQL 5.5.8 or later
224 * PostgreSQL 9.2 or later
225 * SQLite 3.3.7 or later
226 * Oracle 9.0.1 or later
227 * Microsoft SQL Server 2005 (9.00.1399)
228
229 == Upgrading ==
230 1.33 has several database changes since 1.32, and will not work without schema
231 updates. Note that due to changes to some very large tables like the revision
232 table, the schema update may take quite long (minutes on a medium sized site,
233 many hours on a large site).
234
235 Don't forget to always back up your database before upgrading!
236
237 See the file UPGRADE for more detailed upgrade instructions, including
238 important information when upgrading from versions prior to 1.11.
239
240 For notes on 1.32.x and older releases, see HISTORY.
241
242 == Online documentation ==
243 Documentation for both end-users and site administrators is available on
244 MediaWiki.org, and is covered under the GNU Free Documentation License (except
245 for pages that explicitly state that their contents are in the public domain):
246
247 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
248
249 == Mailing list ==
250 A mailing list is available for MediaWiki user support and discussion:
251
252 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
253
254 A low-traffic announcements-only list is also available:
255
256 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
257
258 It's highly recommended that you sign up for one of these lists if you're
259 going to run a public MediaWiki, so you can be notified of security fixes.
260
261 == IRC help ==
262 There's usually someone online in #mediawiki on irc.freenode.net.