Update release notes following the refactor of Block
[lhc/web/wiklou.git] / RELEASE-NOTES-1.34
1 = MediaWiki 1.34 =
2
3 == MediaWiki 1.34.0-PRERELEASE ==
4
5 THIS IS NOT A RELEASE YET
6
7 MediaWiki 1.34 is an alpha-quality development branch, and is not recommended
8 for use in production.
9
10 == Upgrading notes for 1.34 ==
11 1.34 has several database changes since 1.33, and will not work without schema
12 updates. Note that due to changes to some very large tables like the revision
13 table, the schema update may take quite long (minutes on a medium sized site,
14 many hours on a large site).
15
16 Don't forget to always back up your database before upgrading!
17
18 See the file UPGRADE for more detailed upgrade instructions, including
19 important information when upgrading from versions prior to 1.11.
20
21 Some specific notes for MediaWiki 1.34 upgrades are below:
22
23 * …
24
25 For notes on 1.33.x and older releases, see HISTORY.
26
27 === Configuration changes for system administrators in 1.34 ===
28
29 ==== New configuration ====
30 * …
31
32 ==== Changed configuration ====
33 * …
34
35 ==== Removed configuration ====
36 * …
37
38 === New user-facing features in 1.34 ===
39 * …
40
41 === New developer features in 1.34 ===
42 * Language::formatTimePeriod now supports the new 'avoidhours' option to output
43 strings like "5 days ago" instead of "5 days 13 hours ago".
44
45 === External library changes in 1.34 ===
46
47 ==== New external libraries ====
48 * …
49
50 ==== Changed external libraries ====
51 * Updated Mustache from 1.0.0 to v3.0.1.
52 * Updated OOUI from v0.31.3 to v0.31.5.
53 * Updated composer/semver from 1.4.2 to 1.5.0.
54 * Updated composer/spdx-licenses from 1.4.0 to 1.5.1 (dev-only).
55 * Updated mediawiki/codesniffer from 25.0.0 to 26.0.0 (dev-only).
56 * Updated cssjanus/cssjanus from 1.2.1 to 1.3.0.
57 * …
58
59 ==== Removed external libraries ====
60 * …
61
62 === Bug fixes in 1.34 ===
63 * (T222529) If a log entry or page revision is recorded in the database with an
64 empty username, attempting to display it will log an error and return a "no
65 username available" to the user instead of silently displaying nothing or
66 invalid links.
67
68 === Action API changes in 1.34 ===
69 * The 'recenteditcount' response property from action=query list=allusers,
70 deprecated in 1.25, has been removed.
71
72 === Action API internal changes in 1.34 ===
73 * …
74
75 === Languages updated in 1.34 ===
76 MediaWiki supports over 350 languages. Many localisations are updated regularly.
77 Below only new and removed languages are listed, as well as changes to languages
78 because of Phabricator reports.
79
80 * (T152908) Added language support for N'Ko (nqo).
81
82 === Breaking changes in 1.34 ===
83 * Preferences class, deprecated in 1.31, has been removed.
84 * The following parts of code, deprecated in 1.32, were removed in favor of
85 built-in PHP functions:
86 * CryptRand class
87 * CryptRand service
88 * Functions of the MWCryptRand class: singleton(), wasStrong() and generate().
89 * Language::setCode, deprecated in 1.32, was removed. Use Language::factory to
90 create a new Language object with a different language code.
91 * MWNamespace::clearCaches() has been removed. So has the $rebuild parameter
92 to MWNamespace::getCanonicalNamespaces(), which was deprecated since 1.31.
93 Instead, reset services, such as by calling $this->overrideMwServices() (if
94 your test extends MediaWikiTestCase). Services will generally not pick up
95 configuration changes from after they were created, so you must reset
96 services after any configuration change. Even if your code works now, it is
97 likely to break in future versions as more code is moved to services.
98 * The ill-defined "DatabaseOraclePostInit" hook has been removed.
99 * PreferencesFormLegacy and PreferencesForm classes, deprecated in 1.32, have
100 been removed.
101 * ObjectFactory class, deprecated in 1.31, has been removed.
102 * HWLDFWordAccumudlator class, deprecated in 1.28, has been removed.
103 * XMPInfo, XMPReader and XMPValidate, deprecated in 1.32, have been removed.
104 * The RedirectSpecialPage::execute method could sometimes return a Title object.
105 This behavior was removed, and the method now matches the parent signature
106 (SpecialPage::execute) which is to return HTML string or void.
107 To obtain the destination title, use RedirectSpecialPage::getRedirect.
108 * The 'recenteditcount' response property from action API action=query
109 list=allusers, deprecated in 1.25, has been removed.
110 * SearchEngine::userNamespaces(), SearchEngine::namespacesAsText(),
111 SearchEngine::create(), SearchEngine::getSearchTypes() and
112 SearchEngine::getNearMatch(), methods deprecated in 1.27, have been removed.
113 * FileRepo::streamFile(), deprecated in 1.26, has been removed.
114 * User::randomPassword() method, deprecated in 1.27, have been removed.
115 * MWNamespace::canTalk(), deprecated in 1.30, have been removed.
116 * Parser class property $mUniqPrefix, deprecated in 1.26, has been removed.
117 * wfArrayFilter() and wfArrayFilterByKey(), deprecated in 1.32, have been
118 removed.
119 * wfMakeUrlIndexes() function, deprecated in 1.33, have been removed.
120 * Method signatures in WatchedItemQueryServiceExtension have changed from taking
121 User objects to taking UserIdentity objects. Extensions implementing this
122 interface need to be changed accordingly.
123 * User::getGroupPage() and ::makeGroupLinkHTML(), deprecated in 1.29, have been
124 removed. Use UserGroupMembership::getGroupPage and ::getLink instead.
125 * User::makeGroupLinkWiki(), deprecated in 1.29, has been removed. Use
126 UserGroupMembership::getLink() instead.
127 * SavepointPostgres, deprecated in 1.31, has been removed.
128 * Output::sectionEditLinksEnabled(), ParserOutput::getEditSectionTokens,
129 ::getTOCEnabled, ::setEditSectionTokens, ::setTOCEnabled, deprecated in 1.31,
130 have been removed.
131 * EditPage::safeUnicodeInput() and ::safeUnicodeOutput(), deprecated in 1.30,
132 have been removed.
133 * Four methods in OutputPage, deprecated in 1.32, have been removed. You should
134 use OutputPage::showFatalError or throw a FatalError instead. The methods are
135 ::showFileCopyError(), ::showFileRenameError(), ::showFileDeleteError(), and
136 ::showFileNotFoundError().
137 * ApiBase::truncateArray(), deprecated in 1.32, has been removed.
138 * IcuCollation::getICUVersion(), deprecated in 1.32, has been removed. Use PHP's
139 INTL_ICU_VERSION constant directly.
140 * HTMLForm::setSubmitProgressive(), deprecated in 1.32, has been removed.
141 * ResourceLoaderStartUpModules::getStartupModules() and ::getLegacyModules(),
142 both deprecated in 1.32, have been removed.
143 * BaseTemplate::msgHtml() and QuickTemplate::msgHtml(), deprecated in 1.32, have
144 been removed. Use ->msg() or ->getMsg() instead.
145 * WatchAction::getUnwatchToken(), deprecated in 1.32, has been removed. Instead,
146 use WatchAction::getWatchToken() with action 'unwatch' directly.
147 * Language::initEncoding(), ::recodeForEdit(), and recodeInput(), deprecated in
148 1.28, have been removed.
149 * PageArchive::getTextFromRow(), ::listAllPages(), and ::getLastRevisionText(),
150 deprecated in 1.32, have been removed.
151 * OutputPage::getModuleScripts(), ParserOutput::getModuleScripts(), deprecated
152 in 1.33, have been removed.
153 * User::getPasswordValidity(), deprecated in 1.33, has been removed.
154 * ApiQueryBase::prepareUrlQuerySearchString(), deprecated in 1.33, has been
155 removed.
156 * ChangeTags::purgeTagUsageCache(), deprecated in 1.33, has been removed.
157 * JobQueueGroup::pushLazyJobs(), deprecated in 1.33, has been removed.
158 * MediaWikiTestCase::stashMwGlobals(), deprecated in 1.32, has been removed.
159 * SearchEngine::transformSearchTerm(), deprecated in 1.32, has been removed.
160 * The Block typehint only refers to blocks stored in the database. It should be
161 updated to AbstractBlock in cases where any type of block could be expected.
162 * …
163
164 === Deprecations in 1.34 ===
165 * The MWNamespace class is deprecated. Use NamespaceInfo.
166 * ExtensionRegistry->load() is deprecated, as it breaks dependency checking.
167 Instead, use ->queue().
168 * User::isBlocked() is deprecated since it does not tell you if the user is
169 blocked from editing a particular page. Use User::getBlock() or
170 PermissionManager::isBlockedFrom() or PermissionManager::userCan() instead.
171 * User::isLocallyBlockedProxy and User::inDnsBlacklist are deprecated and moved
172 to the BlockManager as private helper methods.
173 * User::isDnsBlacklisted is deprecated. Use BlockManager::isDnsBlacklisted
174 instead.
175 * The Config argument to ChangesListSpecialPage::checkStructuredFilterUiEnabled
176 is deprecated. Pass only the User argument.
177 * WatchedItem::getUser is deprecated. Use getUserIdentity.
178 * Passing a Title as the first parameter to the getTimestampById method of
179 RevisionStore is deprecated. Omit it, passing only the remaining parameters.
180 * Title::getPreviousRevisionId and Title::getNextRevisionId are deprecated. Use
181 RevisionLookup::getPreviousRevision and RevisionLookup::getNextRevision.
182 * The Title parameter to RevisionLookup::getPreviousRevision and
183 RevisionLookup::getNextRevision is deprecated and should be omitted.
184 * MWHttpRequest::factory is deprecated. Use HttpRequestFactory.
185 * The Http class is deprecated. For the request, get, and post methods, use
186 HttpRequestFactory. For isValidURI, use MWHttpRequest::isValidURI. For
187 getProxy, use (string)$wgHTTPProxy. For createMultiClient, construct a
188 MultiHttpClient directly.
189 * Http::$httpEngine is deprecated and has no replacement. The default 'guzzle'
190 engine will eventually be made the only engine for HTTP requests.
191 * RepoGroup::singleton(), RepoGroup::destroySingleton(),
192 RepoGroup::setSingleton(), wfFindFile(), and wfLocalFile() are all
193 deprecated. Use MediaWikiServices instead.
194 * The getSubjectPage, getTalkPage, and getOtherPage of Title are deprecated.
195 Use NamespaceInfo's getSubjectPage, getTalkPage, and getAssociatedPage.
196 * MWMessagePack class, no longer used, has been deprecated in 1.34.
197 * The Block class is separated into Block (for blocks stored in the database),
198 and SystemBlock (for temporary blocks created by the system). SystemBlock
199 should be used when creating any temporary blocks.
200
201 === Other changes in 1.34 ===
202 * …
203
204 == Compatibility ==
205 MediaWiki 1.34 requires PHP 7.0.13 or later. Although HHVM 3.18.5 or later is
206 supported, it is generally advised to use PHP 7.0.13 or later for long term
207 support.
208
209 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
210 but support for them is somewhat less mature. There is experimental support for
211 Oracle and Microsoft SQL Server.
212
213 The supported versions are:
214
215 * MySQL 5.5.8 or later
216 * PostgreSQL 9.2 or later
217 * SQLite 3.8.0 or later
218 * Oracle 9.0.1 or later
219 * Microsoft SQL Server 2005 (9.00.1399)
220
221 == Online documentation ==
222 Documentation for both end-users and site administrators is available on
223 MediaWiki.org, and is covered under the GNU Free Documentation License (except
224 for pages that explicitly state that their contents are in the public domain):
225
226 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
227
228 == Mailing list ==
229 A mailing list is available for MediaWiki user support and discussion:
230
231 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
232
233 A low-traffic announcements-only list is also available:
234
235 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
236
237 It's highly recommended that you sign up for one of these lists if you're
238 going to run a public MediaWiki, so you can be notified of security fixes.
239
240 == IRC help ==
241 There's usually someone online in #mediawiki on irc.freenode.net.