Warn if stateful ParserOutput transforms are used
[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
21 === New features in 1.31 ===
22 * Wikimedia\Rdbms\IDatabase->select() and similar methods now support
23 joins with parentheses for grouping.
24 * As a first pass in standardizing dialog boxes across the MediaWiki product,
25 Html class now provides helper methods for messageBox, successBox, errorBox and
26 warningBox generation.
27 * (T9240) Imports will now record unknown (and, optionally, known) usernames in
28 a format like "iw>Example".
29 * (T20209) Linker (used on history pages, log pages, and so on) will display
30 usernames formed like "iw>Example" as interwiki links, as if by wikitext like
31 [[iw:User:Example|iw>Example]].
32 * (T111605) The 'ImportHandleUnknownUser' hook allows extensions to auto-create
33 users during an import.
34 * Added a hook, ParserOutputPostCacheTransform, to allow extensions to affect
35 the ParserOutput::getText() post-cache transformations.
36
37 === External library changes in 1.31 ===
38
39 ==== Upgraded external libraries ====
40 * …
41
42 ==== New external libraries ====
43 * …
44
45 ==== Removed and replaced external libraries ====
46 * (T17845) The deprecated 'jquery.badge' module was removed.
47 * The deprecated 'jquery.autoEllipsis' module was removed. Use the CSS
48 text-overflow property instead.
49 * The deprecated 'jquery.placeholder' module was removed.
50 * The deprecated 'jquery.appear' module was removed. Use the
51 'mediawiki.viewport' module instead.
52 * The deprecated 'mediawiki.widgets.CategorySelector' module alias was removed.
53 Use the 'mediawiki.widgets.CategoryMultiselectWidget' module directly instead.
54
55 === Bug fixes in 1.31 ===
56 * (T90902) Non-breaking space in header ID breaks anchor
57
58 === Action API changes in 1.31 ===
59 * …
60
61 === Action API internal changes in 1.31 ===
62 * …
63
64 === Languages updated in 1.31 ===
65 MediaWiki supports over 350 languages. Many localisations are updated
66 regularly. Below only new and removed languages are listed, as well as
67 changes to languages because of Phabricator reports.
68
69 * (T180052) Mirandese (mwl) now supports gendered NS_USER/NS_USER_TALK namespaces.
70
71 === Other changes in 1.31 ===
72 * MessageBlobStore::insertMessageBlob() (deprecated in 1.27) was removed.
73 * The global function wfBCP47 was renamed to LanguageCode::bcp47.
74 * The global function wfBCP47 is now deprecated.
75 * The global function wfCountDown() is now deprecated in favor of
76 Maintenance::countDown()
77 * The OutputPage class constructor now requires a context parameter,
78 (instantiating without context was deprecated in 1.18)
79 * mw.page (deprecated in 1.30) was removed.
80 * Article::getLastPurgeTimestamp(), WikiPage::getLastPurgeTimestamp(), and the
81 related WikiPage::PURGE_* constants, deprecated in 1.29, were removed.
82 * The Article::selectFields(), Article::onArticleCreate(),
83 Article::onArticleDelete(), and Article::onArticleEdit() methods, deprecated
84 in 1.24, were removed.
85 * Installer::locateExecutable() and Installer::locateExecutableInDefaultPaths()
86 were removed, use ExecutableFinder::findInDefaultPaths() instead.
87 * Several methods for returning lists of fields to select from the database
88 have been deprecated in favor of similar methods that also return the tables
89 to select from and the join conditions for those tables.
90 * Block::selectFields() → Block::getQueryInfo()
91 * RecentChange::selectFields() → RecentChange::getQueryInfo()
92 * ArchivedFile::selectFields() → ArchivedFile::getQueryInfo()
93 * LocalFile::selectFields() → LocalFile::getQueryInfo()
94 * LocalFile::getCacheFields() with a prefix no longer works
95 * LocalFile::getLazyCacheFields() with a prefix no longer works
96 * OldLocalFile::selectFields() → OldLocalFile::getQueryInfo()
97 * RecentChange::selectFields() → RecentChange::getQueryInfo()
98 * Revision::userJoinCond() → Revision::getQueryInfo( [ 'user' ] )
99 * Revision::selectUserFields() → Revision::getQueryInfo( [ 'user' ] )
100 * Revision::pageJoinCond() → Revision::getQueryInfo( [ 'page' ] )
101 * Revision::selectPageFields() → Revision::getQueryInfo( [ 'page' ] )
102 * Revision::selectTextFields() → Revision::getQueryInfo( [ 'text' ] )
103 * Revision::selectFields() → Revision::getQueryInfo()
104 * Revision::selectArchiveFields() → Revision::getArchiveQueryInfo()
105 * User::selectFields() → User::getQueryInfo()
106 * WikiPage::selectFields() → WikiPage::getQueryInfo()
107 * Due to significant refactoring, method ContribsPager::getUserCond() that had
108 no access restriction has been removed.
109 * Revision::setUserIdAndName() was deprecated.
110 * Access to TitleValue class properties was deprecated, the relevant getters
111 should be used instead.
112 * DifferenceEngine::getDiffBodyCacheKey() is deprecated. Subclasses should
113 override DifferenceEngine::getDiffBodyCacheKeyParams() instead.
114 * The deprecated MW_DIFF_VERSION constant was removed.
115 DifferenceEngine::MW_DIFF_VERSION should be used instead.
116 * Use of Maintenance::error( $err, $die ) to exit script was deprecated. Use
117 Maintenance::fatalError() instead.
118 * Passing a ParserOptions object to OutputPage::parserOptions() is deprecated.
119 * Browser support for Opera 12 and older was removed.
120 Opera 15+ continues at Grade A support.
121 * The Block class will no longer accept usable-but-missing usernames for
122 'byText' or ->setBlocker(). Callers should either ensure the blocker exists
123 locally or use a new interwiki-format username like "iw>Example".
124 * The following methods that get and set ParserOutput state are deprecated.
125 Callers should use the new stateless $options parameter to
126 ParserOutput::getText() instead.
127 * ParserOptions::getEditSection()
128 * ParserOptions::setEditSection()
129 * ParserOutput::getEditSectionTokens()
130 * ParserOutput::setEditSectionTokens()
131 * ParserOutput::getTOCEnabled()
132 * ParserOutput::setTOCEnabled()
133 * OutputPage::enableSectionEditLinks()
134 * OutputPage::sectionEditLinksEnabled()
135 * The public ParserOutput state fields $mTOCEnabled and $mEditSectionTokens are also deprecated.
136
137 == Compatibility ==
138 MediaWiki 1.31 requires PHP 5.5.9 or later. There is experimental support for
139 HHVM 3.6.5 or later.
140
141 MySQL/MariaDB is the recommended DBMS. PostgreSQL or SQLite can also be used,
142 but support for them is somewhat less mature. There is experimental support for
143 Oracle and Microsoft SQL Server.
144
145 The supported versions are:
146
147 * MySQL 5.0.3 or later
148 * PostgreSQL 8.3 or later
149 * SQLite 3.3.7 or later
150 * Oracle 9.0.1 or later
151 * Microsoft SQL Server 2005 (9.00.1399)
152
153 == Upgrading ==
154 1.31 has several database changes since 1.30, and will not work without schema
155 updates. Note that due to changes to some very large tables like the revision
156 table, the schema update may take quite long (minutes on a medium sized site,
157 many hours on a large site).
158
159 Don't forget to always back up your database before upgrading!
160
161 See the file UPGRADE for more detailed upgrade instructions, including
162 important information when upgrading from versions prior to 1.11.
163
164 For notes on 1.30.x and older releases, see HISTORY.
165
166 == Online documentation ==
167 Documentation for both end-users and site administrators is available on
168 MediaWiki.org, and is covered under the GNU Free Documentation License (except
169 for pages that explicitly state that their contents are in the public domain):
170
171 https://www.mediawiki.org/wiki/Special:MyLanguage/Documentation
172
173 == Mailing list ==
174 A mailing list is available for MediaWiki user support and discussion:
175
176 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
177
178 A low-traffic announcements-only list is also available:
179
180 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
181
182 It's highly recommended that you sign up for one of these lists if you're
183 going to run a public MediaWiki, so you can be notified of security fixes.
184
185 == IRC help ==
186 There's usually someone online in #mediawiki on irc.freenode.net.