Merge "Fix AbstractBlock param types in documentation"
[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 * The jquery.async module, deprecated in 1.33, was removed.
61 * …
62
63 === Bug fixes in 1.34 ===
64 * (T222529) If a log entry or page revision is recorded in the database with an
65 empty username, attempting to display it will log an error and return a "no
66 username available" to the user instead of silently displaying nothing or
67 invalid links.
68
69 === Action API changes in 1.34 ===
70 * The 'recenteditcount' response property from action=query list=allusers,
71 deprecated in 1.25, has been removed.
72
73 === Action API internal changes in 1.34 ===
74 * …
75
76 === Languages updated in 1.34 ===
77 MediaWiki supports over 350 languages. Many localisations are updated regularly.
78 Below only new and removed languages are listed, as well as changes to languages
79 because of Phabricator reports.
80
81 * (T152908) Added language support for N'Ko (nqo).
82
83 === Breaking changes in 1.34 ===
84 * Preferences class, deprecated in 1.31, has been removed.
85 * The following parts of code, deprecated in 1.32, were removed in favor of
86 built-in PHP functions:
87 * CryptRand class
88 * CryptRand service
89 * Functions of the MWCryptRand class: singleton(), wasStrong() and generate().
90 * Language::setCode, deprecated in 1.32, was removed. Use Language::factory to
91 create a new Language object with a different language code.
92 * MWNamespace::clearCaches() has been removed. So has the $rebuild parameter
93 to MWNamespace::getCanonicalNamespaces(), which was deprecated since 1.31.
94 Instead, reset services, such as by calling $this->overrideMwServices() (if
95 your test extends MediaWikiTestCase). Services will generally not pick up
96 configuration changes from after they were created, so you must reset
97 services after any configuration change. Even if your code works now, it is
98 likely to break in future versions as more code is moved to services.
99 * The ill-defined "DatabaseOraclePostInit" hook has been removed.
100 * PreferencesFormLegacy and PreferencesForm classes, deprecated in 1.32, have
101 been removed.
102 * ObjectFactory class, deprecated in 1.31, has been removed.
103 * HWLDFWordAccumudlator class, deprecated in 1.28, has been removed.
104 * XMPInfo, XMPReader and XMPValidate, deprecated in 1.32, have been removed.
105 * The RedirectSpecialPage::execute method could sometimes return a Title object.
106 This behavior was removed, and the method now matches the parent signature
107 (SpecialPage::execute) which is to return HTML string or void.
108 To obtain the destination title, use RedirectSpecialPage::getRedirect.
109 * The 'recenteditcount' response property from action API action=query
110 list=allusers, deprecated in 1.25, has been removed.
111 * SearchEngine::userNamespaces(), SearchEngine::namespacesAsText(),
112 SearchEngine::create(), SearchEngine::getSearchTypes() and
113 SearchEngine::getNearMatch(), methods deprecated in 1.27, have been removed.
114 * FileRepo::streamFile(), deprecated in 1.26, has been removed.
115 * User::randomPassword() method, deprecated in 1.27, have been removed.
116 * MWNamespace::canTalk(), deprecated in 1.30, have been removed.
117 * Parser class property $mUniqPrefix, deprecated in 1.26, has been removed.
118 * wfArrayFilter() and wfArrayFilterByKey(), deprecated in 1.32, have been
119 removed.
120 * wfMakeUrlIndexes() function, deprecated in 1.33, have been removed.
121 * Method signatures in WatchedItemQueryServiceExtension have changed from taking
122 User objects to taking UserIdentity objects. Extensions implementing this
123 interface need to be changed accordingly.
124 * User::getGroupPage() and ::makeGroupLinkHTML(), deprecated in 1.29, have been
125 removed. Use UserGroupMembership::getGroupPage and ::getLink instead.
126 * User::makeGroupLinkWiki(), deprecated in 1.29, has been removed. Use
127 UserGroupMembership::getLink() instead.
128 * SavepointPostgres, deprecated in 1.31, has been removed.
129 * Output::sectionEditLinksEnabled(), ParserOutput::getEditSectionTokens,
130 ::getTOCEnabled, ::setEditSectionTokens, ::setTOCEnabled, deprecated in 1.31,
131 have been removed.
132 * EditPage::safeUnicodeInput() and ::safeUnicodeOutput(), deprecated in 1.30,
133 have been removed.
134 * Four methods in OutputPage, deprecated in 1.32, have been removed. You should
135 use OutputPage::showFatalError or throw a FatalError instead. The methods are
136 ::showFileCopyError(), ::showFileRenameError(), ::showFileDeleteError(), and
137 ::showFileNotFoundError().
138 * ApiBase::truncateArray(), deprecated in 1.32, has been removed.
139 * IcuCollation::getICUVersion(), deprecated in 1.32, has been removed. Use PHP's
140 INTL_ICU_VERSION constant directly.
141 * HTMLForm::setSubmitProgressive(), deprecated in 1.32, has been removed.
142 * ResourceLoaderStartUpModules::getStartupModules() and ::getLegacyModules(),
143 both deprecated in 1.32, have been removed.
144 * BaseTemplate::msgHtml() and QuickTemplate::msgHtml(), deprecated in 1.32, have
145 been removed. Use ->msg() or ->getMsg() instead.
146 * WatchAction::getUnwatchToken(), deprecated in 1.32, has been removed. Instead,
147 use WatchAction::getWatchToken() with action 'unwatch' directly.
148 * Language::initEncoding(), ::recodeForEdit(), and recodeInput(), deprecated in
149 1.28, have been removed.
150 * PageArchive::getTextFromRow(), ::listAllPages(), and ::getLastRevisionText(),
151 deprecated in 1.32, have been removed.
152 * OutputPage::getModuleScripts(), ParserOutput::getModuleScripts(), deprecated
153 in 1.33, have been removed.
154 * User::getPasswordValidity(), deprecated in 1.33, has been removed.
155 * ApiQueryBase::prepareUrlQuerySearchString(), deprecated in 1.33, has been
156 removed.
157 * ChangeTags::purgeTagUsageCache(), deprecated in 1.33, has been removed.
158 * JobQueueGroup::pushLazyJobs(), deprecated in 1.33, has been removed.
159 * MediaWikiTestCase::stashMwGlobals(), deprecated in 1.32, has been removed.
160 * SearchEngine::transformSearchTerm(), deprecated in 1.32, has been removed.
161 * The Block typehint only refers to blocks stored in the database. It should be
162 updated to AbstractBlock in cases where any type of block could be expected.
163 * …
164
165 === Deprecations in 1.34 ===
166 * The MWNamespace class is deprecated. Use NamespaceInfo.
167 * ExtensionRegistry->load() is deprecated, as it breaks dependency checking.
168 Instead, use ->queue().
169 * User::isBlocked() is deprecated since it does not tell you if the user is
170 blocked from editing a particular page. Use User::getBlock() or
171 PermissionManager::isBlockedFrom() or PermissionManager::userCan() instead.
172 * User::isLocallyBlockedProxy and User::inDnsBlacklist are deprecated and moved
173 to the BlockManager as private helper methods.
174 * User::isDnsBlacklisted is deprecated. Use BlockManager::isDnsBlacklisted
175 instead.
176 * The Config argument to ChangesListSpecialPage::checkStructuredFilterUiEnabled
177 is deprecated. Pass only the User argument.
178 * WatchedItem::getUser is deprecated. Use getUserIdentity.
179 * Passing a Title as the first parameter to the getTimestampById method of
180 RevisionStore is deprecated. Omit it, passing only the remaining parameters.
181 * Title::getPreviousRevisionId and Title::getNextRevisionId are deprecated. Use
182 RevisionLookup::getPreviousRevision and RevisionLookup::getNextRevision.
183 * The Title parameter to RevisionLookup::getPreviousRevision and
184 RevisionLookup::getNextRevision is deprecated and should be omitted.
185 * MWHttpRequest::factory is deprecated. Use HttpRequestFactory.
186 * The Http class is deprecated. For the request, get, and post methods, use
187 HttpRequestFactory. For isValidURI, use MWHttpRequest::isValidURI. For
188 getProxy, use (string)$wgHTTPProxy. For createMultiClient, construct a
189 MultiHttpClient directly.
190 * Http::$httpEngine is deprecated and has no replacement. The default 'guzzle'
191 engine will eventually be made the only engine for HTTP requests.
192 * RepoGroup::singleton(), RepoGroup::destroySingleton(),
193 RepoGroup::setSingleton(), wfFindFile(), and wfLocalFile() are all
194 deprecated. Use MediaWikiServices instead.
195 * The getSubjectPage, getTalkPage, and getOtherPage of Title are deprecated.
196 Use NamespaceInfo's getSubjectPage, getTalkPage, and getAssociatedPage.
197 * MWMessagePack class, no longer used, has been deprecated in 1.34.
198 * The Block class is separated into Block (for blocks stored in the database),
199 and SystemBlock (for temporary blocks created by the system). SystemBlock
200 should be used when creating any temporary blocks.
201
202 === Other changes in 1.34 ===
203 * …
204
205 == Compatibility ==
206 MediaWiki 1.34 requires PHP 7.0.13 or later. Although HHVM 3.18.5 or later is
207 supported, it is generally advised to use PHP 7.0.13 or later for long term
208 support.
209
210 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
211 but support for them is somewhat less mature. There is experimental support for
212 Oracle and Microsoft SQL Server.
213
214 The supported versions are:
215
216 * MySQL 5.5.8 or later
217 * PostgreSQL 9.2 or later
218 * SQLite 3.8.0 or later
219 * Oracle 9.0.1 or later
220 * Microsoft SQL Server 2005 (9.00.1399)
221
222 == Online documentation ==
223 Documentation for both end-users and site administrators is available on
224 MediaWiki.org, and is covered under the GNU Free Documentation License (except
225 for pages that explicitly state that their contents are in the public domain):
226
227 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
228
229 == Mailing list ==
230 A mailing list is available for MediaWiki user support and discussion:
231
232 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
233
234 A low-traffic announcements-only list is also available:
235
236 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
237
238 It's highly recommended that you sign up for one of these lists if you're
239 going to run a public MediaWiki, so you can be notified of security fixes.
240
241 == IRC help ==
242 There's usually someone online in #mediawiki on irc.freenode.net.