Merge "Follow-up 5aea96df: Add release notes for File SHA1 display"
[lhc/web/wiklou.git] / RELEASE-NOTES-1.31
1 == MediaWiki 1.31 ==
2
3 THIS IS NOT A RELEASE YET
4
5 MediaWiki 1.31 is an alpha-quality branch and is not recommended for use in
6 production.
7
8 === Configuration changes in 1.31 ===
9 * $wgEnableAPI and $wgEnableWriteAPI are now deprecated and will be removed in
10 a future version. The API is now considered to be stable, secure and
11 essential.
12 * $wgUsejQueryThree was removed, as it is now the default. This was documented as a
13 temporary variable during the migration period, deprecated since 1.29.
14 * $wgLogoHD has been updated to support svg images and uses $wgLogo where
15 possible for fallback images such as png.
16 * (T44246) $wgFilterLogTypes will no longer ignore 'patrol' when user does
17 not have the right to mark things patrolled.
18 * Wikis that contain imported revisions or CentralAuth global blocks should run
19 maintenance/cleanupUsersWithNoId.php.
20 * $wgResourceLoaderMinifierStatementsOnOwnLine and $wgResourceLoaderMinifierMaxLineLength
21 were removed (deprecated since 1.27).
22 * (T180921) $wgReferrerPolicy now supports having fallbacks for browsers that are not
23 using the latest version of the Referrer Policy specification.
24
25 === New features in 1.31 ===
26 * Wikimedia\Rdbms\IDatabase->select() and similar methods now support
27 joins with parentheses for grouping.
28 * As a first pass in standardizing dialog boxes across the MediaWiki product,
29 Html class now provides helper methods for messageBox, successBox, errorBox and
30 warningBox generation.
31 * (T9240) Imports will now record unknown (and, optionally, known) usernames in
32 a format like "iw>Example".
33 * (T20209) Linker (used on history pages, log pages, and so on) will display
34 usernames formed like "iw>Example" as interwiki links, as if by wikitext like
35 [[iw:User:Example|iw>Example]].
36 * (T111605) The 'ImportHandleUnknownUser' hook allows extensions to auto-create
37 users during an import.
38 * Added a hook, ParserOutputPostCacheTransform, to allow extensions to affect
39 the ParserOutput::getText() post-cache transformations.
40 * Added a hook, UploadForm:getInitialPageText, to allow extensions to alter the
41 initial page text for file uploads.
42 * (T181651) The info page for File pages now displays the file's base-36 SHA1
43 hash value in the table of basic information.
44
45 === External library changes in 1.31 ===
46
47 ==== Upgraded external libraries ====
48 * Updated jquery.chosen from v0.9.14 to v1.8.2.
49 * Updated composer/spdx-licenses from 1.1.4 to
50 1.2.0 (development dependency).
51 * Updated nikic/php-parser from 2.1.0 to 3.1.3
52 (development dependency).
53 * …
54
55 ==== New external libraries ====
56 * …
57
58 ==== Removed and replaced external libraries ====
59 * (T17845) The deprecated 'jquery.badge' module was removed.
60 * The deprecated 'jquery.autoEllipsis' module was removed. Use the CSS
61 text-overflow property instead.
62 * The deprecated 'jquery.placeholder' module was removed.
63 * The deprecated 'jquery.appear' module was removed. Use the
64 'mediawiki.viewport' module instead.
65 * The deprecated 'mediawiki.widgets.CategorySelector' module alias was removed.
66 Use the 'mediawiki.widgets.CategoryMultiselectWidget' module directly instead.
67
68 === Bug fixes in 1.31 ===
69 * (T90902) Non-breaking space in header ID breaks anchor
70
71 === Action API changes in 1.31 ===
72 * (T185058) The 'name' value to tgprop for action=query&list=tags has been
73 removed. It has never made a difference in the output, the name was always
74 returned regardless.
75
76 === Action API internal changes in 1.31 ===
77 * …
78
79 === Languages updated in 1.31 ===
80 MediaWiki supports over 350 languages. Many localisations are updated
81 regularly. Below only new and removed languages are listed, as well as
82 changes to languages because of Phabricator reports.
83
84 * (T180052) Mirandese (mwl) now supports gendered NS_USER/NS_USER_TALK namespaces.
85 * (T182305) New language support: Nyungar (nys).
86
87 === Other changes in 1.31 ===
88 * Introducing multi-content-revision capability into the storage layer. For details,
89 see <https://www.mediawiki.org/wiki/Requests_for_comment/Multi-Content_Revisions>.
90 * The Revision class was deprecated in favor of RevisionStore, BlobStore, and
91 RevisionRecord and its subclasses.
92 * MessageBlobStore::insertMessageBlob() (deprecated in 1.27) was removed.
93 * The global function wfBCP47 was renamed to LanguageCode::bcp47.
94 * The global function wfBCP47 is now deprecated.
95 * The global function wfCountDown() is now deprecated in favor of
96 Maintenance::countDown()
97 * The OutputPage class constructor now requires a context parameter,
98 (instantiating without context was deprecated in 1.18)
99 * mw.page (deprecated in 1.30) was removed.
100 * Article::getLastPurgeTimestamp(), WikiPage::getLastPurgeTimestamp(), and the
101 related WikiPage::PURGE_* constants, deprecated in 1.29, were removed.
102 * The Article::selectFields(), Article::onArticleCreate(),
103 Article::onArticleDelete(), and Article::onArticleEdit() methods, deprecated
104 in 1.24, were removed.
105 * Installer::locateExecutable() and Installer::locateExecutableInDefaultPaths()
106 were removed, use ExecutableFinder::findInDefaultPaths() instead.
107 * Several methods for returning lists of fields to select from the database
108 have been deprecated in favor of similar methods that also return the tables
109 to select from and the join conditions for those tables.
110 * Block::selectFields() → Block::getQueryInfo()
111 * RecentChange::selectFields() → RecentChange::getQueryInfo()
112 * ArchivedFile::selectFields() → ArchivedFile::getQueryInfo()
113 * LocalFile::selectFields() → LocalFile::getQueryInfo()
114 * LocalFile::getCacheFields() with a prefix no longer works
115 * LocalFile::getLazyCacheFields() with a prefix no longer works
116 * OldLocalFile::selectFields() → OldLocalFile::getQueryInfo()
117 * RecentChange::selectFields() → RecentChange::getQueryInfo()
118 * Revision::userJoinCond() → Revision::getQueryInfo( [ 'user' ] )
119 * Revision::selectUserFields() → Revision::getQueryInfo( [ 'user' ] )
120 * Revision::pageJoinCond() → Revision::getQueryInfo( [ 'page' ] )
121 * Revision::selectPageFields() → Revision::getQueryInfo( [ 'page' ] )
122 * Revision::selectTextFields() → Revision::getQueryInfo( [ 'text' ] )
123 * Revision::selectFields() → Revision::getQueryInfo()
124 * Revision::selectArchiveFields() → Revision::getArchiveQueryInfo()
125 * User::selectFields() → User::getQueryInfo()
126 * WikiPage::selectFields() → WikiPage::getQueryInfo()
127 * Due to significant refactoring, method ContribsPager::getUserCond() that had
128 no access restriction has been removed.
129 * Revision::setUserIdAndName() was deprecated.
130 * Access to TitleValue class properties was deprecated, the relevant getters
131 should be used instead.
132 * DifferenceEngine::getDiffBodyCacheKey() is deprecated. Subclasses should
133 override DifferenceEngine::getDiffBodyCacheKeyParams() instead.
134 * The deprecated MW_DIFF_VERSION constant was removed.
135 DifferenceEngine::MW_DIFF_VERSION should be used instead.
136 * Use of Maintenance::error( $err, $die ) to exit script was deprecated. Use
137 Maintenance::fatalError() instead.
138 * Passing a ParserOptions object to OutputPage::parserOptions() is deprecated.
139 * Browser support for Opera 12 and older was removed.
140 Opera 15+ continues at Grade A support.
141 * The Block class will no longer accept usable-but-missing usernames for
142 'byText' or ->setBlocker(). Callers should either ensure the blocker exists
143 locally or use a new interwiki-format username like "iw>Example".
144 * The RevisionInsertComplete hook is now deprecated, use RevisionRecordInserted instead.
145 RevisionInsertComplete is still called, but the second and third parameter will always be null.
146 Hard deprecation is scheduled for 1.32.
147 * The following methods that get and set ParserOutput state are deprecated.
148 Callers should use the new stateless $options parameter to
149 ParserOutput::getText() instead.
150 * ParserOptions::getEditSection()
151 * ParserOptions::setEditSection()
152 * ParserOutput::getEditSectionTokens()
153 * ParserOutput::setEditSectionTokens()
154 * ParserOutput::getTOCEnabled()
155 * ParserOutput::setTOCEnabled()
156 * OutputPage::enableSectionEditLinks()
157 * OutputPage::sectionEditLinksEnabled()
158 * The public ParserOutput state fields $mTOCEnabled and $mEditSectionTokens are also deprecated.
159 * The following methods and constants from the WatchedItem class were deprecated in
160 1.27 have been removed.
161 * WatchedItem::getTitle()
162 * WatchedItem::fromUserTitle()
163 * WatchedItem::addWatch()
164 * WatchedItem::removeWatch()
165 * WatchedItem::isWatched()
166 * WatchedItem::duplicateEntries()
167 * WatchedItem::IGNORE_USER_RIGHTS
168 * WatchedItem::CHECK_USER_RIGHTS
169 * WatchedItem::DEPRECATED_USAGE_TIMESTAMP
170 * The $statementsOnOwnLine parameter of JavaScriptMinifier::minify was removed.
171 The corresponding configuration variable ($wgResourceLoaderMinifierStatementsOnOwnLine)
172 has been deprecated since 1.27 and was removed as well.
173 * The $maxLineLength parameter of JavaScriptMinifier::minify was removed.
174 The corresponding configuration variable ($wgResourceLoaderMinifierMaxLineLength)
175 has been deprecated since 1.27 and was removed as well.
176 * The HtmlFormatter class was removed (deprecated in 1.27). The namespaced
177 HtmlFormatter\HtmlFormatter class should be used instead.
178 * License::getLicenses has been deprecated; use License::getLines instead.
179 * The driver 'mysql' for MySQL, deprecated in MediaWiki 1.30, has been removed.
180 The driver has been deprecated since PHP 5.5 and was removed in PHP 7.0. The
181 default driver for MySQL has been 'mysqli' since MediaWiki 1.22.
182
183 == Compatibility ==
184 MediaWiki 1.31 requires PHP 5.5.9 or later. Although HHVM 3.18.5 or later is supported,
185 it is generally advised to use PHP 5.5.9 or later for long term support.
186
187 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
188 but support for them is somewhat less mature. There is experimental support for
189 Oracle and Microsoft SQL Server.
190
191 The supported versions are:
192
193 * MySQL 5.0.3 or later
194 * PostgreSQL 8.3 or later
195 * SQLite 3.3.7 or later
196 * Oracle 9.0.1 or later
197 * Microsoft SQL Server 2005 (9.00.1399)
198
199 == Upgrading ==
200 1.31 has several database changes since 1.30, and will not work without schema
201 updates. Note that due to changes to some very large tables like the revision
202 table, the schema update may take quite long (minutes on a medium sized site,
203 many hours on a large site).
204
205 Don't forget to always back up your database before upgrading!
206
207 See the file UPGRADE for more detailed upgrade instructions, including
208 important information when upgrading from versions prior to 1.11.
209
210 For notes on 1.30.x and older releases, see HISTORY.
211
212 == Online documentation ==
213 Documentation for both end-users and site administrators is available on
214 MediaWiki.org, and is covered under the GNU Free Documentation License (except
215 for pages that explicitly state that their contents are in the public domain):
216
217 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
218
219 == Mailing list ==
220 A mailing list is available for MediaWiki user support and discussion:
221
222 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
223
224 A low-traffic announcements-only list is also available:
225
226 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
227
228 It's highly recommended that you sign up for one of these lists if you're
229 going to run a public MediaWiki, so you can be notified of security fixes.
230
231 == IRC help ==
232 There's usually someone online in #mediawiki on irc.freenode.net.