Don't try to auto-create users when MW_NO_SESSION is defined
[mediawiki.git] / RELEASE-NOTES-1.27
blob5b9b2b81e0087afb8eb3a05a45020c86d87d5946
1 Security reminder: If you have PHP's register_globals option set, you must
2 turn it off. MediaWiki will not work with it enabled.
4 == MediaWiki 1.27 ==
6 THIS IS NOT A RELEASE YET
8 MediaWiki 1.27 is an alpha-quality branch and is not recommended for use in
9 production.
11 === Configuration changes in 1.27 ===
12 * $wgUseLinkNamespaceDBFields was removed.
13 * Deprecated $wgResourceLoaderMinifierStatementsOnOwnLine and
14   $wgResourceLoaderMinifierMaxLineLength, because there was little value in
15   making the behavior configurable. The default values (`false` for the former,
16   1000 for the latter) are now hard-coded.
17 * $wgDebugDumpSqlLength was removed (deprecated in 1.24).
18 * $wgDebugDBTransactions was removed (deprecated in 1.20).
19 * $wgUseXVO has been removed, as it provides functionality only used by
20   custom Wikimedia patches against Squid 2.x that probably noone uses in
21   production anymore. There is now $wgUseKeyHeader that provides similar
22   functionality but instead of the MediaWiki-specific X-Vary-Options header,
23   uses the draft Key header standard.
24 * $wgScriptExtension (and support for '.php5' entry points) was removed. See the
25   deprecation notice in the release notes for version 1.25 for advice on how to
26   preserve support for '.php5' entry points via URL rewriting.
27 * Password handling via the User object has been deprecated and partially
28   removed, pending the future introduction of AuthManager. In particular:
29 ** expirePassword(), getPasswordExpireDate(), resetPasswordExpiration(), and
30    getPasswordExpired() have been removed. They were unused outside of core.
31 ** The mPassword, mNewpassword, mNewpassTime, and mPasswordExpires fields are
32    now private and will be removed in the future.
33 ** The getPassword() and getTemporaryPassword() methods now throw
34    BadMethodCallException and will be removed in the future.
35 ** The ability to pass 'password' and 'newpassword' to createNew() has been
36    removed. The only users of it seem to have been using it to set invalid
37    passwords, and so shouldn't be greatly affected.
38 ** setPassword(), setInternalPassword(), and setNewpassword() have been
39    deprecated, pending the introduction of AuthManager.
40 ** User::randomPassword() is deprecated in favor of a new method
41    PasswordFactory::generateRandomPasswordString()
42 ** User::getPasswordFactory() is deprecated, callers should just create a
43    PasswordFactory themselves.
44 ** A new constructor, User::newSystemUser(), has been added to simplify the
45    creation of passwordless "system" users for logged actions.
46 * $wgMaxSquidPurgeTitles was removed.
47 * $wgAjaxWatch was removed. This is now enabled by default.
48 * $wgUseInstantCommons now hotlinks Commons images by default instead of
49   downloading originals and thumbnailing them locally. This allows wikis to save
50   on CPU and bandwidth while reducing time to first byte for pages, even without
51   a thumbnail handler. See $wgForeignFileRepos documentation for tweaks.
52 * (T27397) WebP is enabled by default as an uploadable filetype.
53 * (T48998) $wgArticlePath must now be either a full url, or start with a "/".
54 * $wgRateLimitLog was removed; use $wgDebugLogGroups['ratelimit'] instead.
55 * Deprecated API formats dbg, txt, and yaml have been removed.
56 * CLDRPluralRule* classes have been replaced with
57   wikimedia/cldr-plural-rule-parser.
58 * Removed $wgProfilePerHost, $wgUDPProfilerHost, $wgUDPProfilerPort,
59   $wgUDPProfilerFormatString, $wgStatsMethod, $wgAggregateStatsID,
60   $wgStatsFormatString, and $wgProfileCallTree (deprecated since 1.20).
61 * For proper operation of LocalIdLookup with shared user tables, ensure that
62   $wgSharedDB and $wgSharedTables are properly set even on the "central" wiki
63   that all others are sharing from and that $wgLocalDatabases is set to the
64   full list of sharing wikis on all those wikis.
65 * Massive overhaul to session handling:
66 ** $wgSessionsInObjectCache is no longer supported and must be true, due to
67    MediaWiki\Session\SessionManager. $wgSessionHandler is similarly no longer
68    used.
69 ** ObjectCacheSessionHandler is removed, replaced with
70    MediaWiki\Session\PhpSessionHandler.
71 ** PHP session handling in general ($_SESSION, session_id(), and so on) is
72    deprecated. Use MediaWiki\Session\SessionManager instead. A new config
73    variable, $wgPHPSessionHandling, is available to cause use of $_SESSION to
74    issue a deprecation warning or to cause most PHP session handling to throw
75    exceptions.
76 ** Deprecated UserSetCookies hook. Session-handling extensions should generally
77    be creating a custom subclass of CookieSessionProvider. Other extensions
78    messing with cookies can no longer count on user data being saved in cookies
79    versus other methods.
80 ** Deprecated UserLoadFromSession hook, extensions should create a
81    MediaWiki\Session\SessionProvider.
82 ** The User cannot be loaded from session until after Setup.php completes.
83    Attempts to do so will be ignored and the User will remain unloaded.
84 ** CSRF tokens may be fetched from the MediaWiki\Session\Session, which uses
85    the MediaWiki\Session\Token class.
86 * MediaWiki will now auto-create users as necessary, removing the need for
87   extensions to do so. An 'autocreateaccount' right is added to allow
88   auto-creation when 'createaccount' is not granted to all users.
89 * Deprecated AuthPluginAutoCreate hook in favor of LocalUserCreated.
90 * Most cookie-handling methods in User are deprecated.
91 * $wgAllowAsyncCopyUploads and $CopyUploadAsyncTimeout were removed. This was an
92   experimental feature that has never worked.
93 * Login and createaccount tokens now vary by timestamp.
94 * LoginForm::getLoginToken() and LoginForm::getCreateaccountToken()
95   return a MediaWiki\Session\Token, and tokens must be checked using that
96   class's methods.
97 * $wgEnotifUseJobQ was removed and the job queue is always used.
98 * The functionality of the ApiSandbox extension has been merged into core. The
99   extension should no longer be used.
101 === New features in 1.27 ===
102 * $wgDataCenterUpdateStickTTL was also added. This decides how long a user
103   sticks to the primary DC (via cookies) after they make changes to the site.
104 * Added a new hook, 'UserMailerTransformContent', to transform the contents
105   of an email. This is similar to the EmailUser hook but applies to all mail
106   sent via UserMailer.
107 * Added a new hook, 'UserMailerTransformMessage', to transform the contents
108   of an emai after MIME encoding.
109 * Added a new hook, 'UserMailerSplitTo', to control which users have to be
110   emailed separately (ie. there is a single address in the To: field) so
111   user-specific changes to the email can be applied safely.
112 * $wgCdnMaxageLagged was added, which limits the CDN cache TTL
113   when any load balancer uses a DB that is lagged beyond the 'max lag'
114   setting in the relevant section of $wgLBFactoryConf.
115 * User::newSystemUser() may be used to simplify the creation of passwordless
116   "system" users for logged actions from scripts and extensions.
117 * Extensions can now return detailed error information via the API when
118   preventing user actions using 'getUserPermissionsErrors' and similar hooks
119   by using ApiMessage instances instead of strings for the $result value.
120 * $wgAPIMaxLagThreshold was added to limit bot changes when databases lag
121   becomes too high.
122 * Skins and extensions can now use FlexBox mixins (.flex-display(@display: flex)
123   and .flex(@grow: 1, @shrink: 1, @width: auto, @order: 1)) in Less to create
124   cross-browser-compatible FlexBox rules. Users will still need to add fallback
125   float rules or the like for compatibility with IE9- separately.
126 * Added MWTimestamp::getTimezoneString() which returns the localized timezone
127   string, if available. To localize this string, see the comments of
128   $wgLocaltimezone in includes/DefaultSettings.php.
129 * Added CentralIdLookup, a service that allows extensions needing a concept of
130   "central" users to get that without having to know about specific central
131   authentication extensions.
132 * $wgMaxUserDBWriteDuration added to limit huge user-generated transactions.
133   Regular web request transactions that takes longer than this are aborted.
134 * Added a new hook, 'TitleMoveCompleting', which runs before a page move is
135   committed.
136 * $wgCdnReboundPurgeDelay was added to provide secondary delayed purges of URLs
137   from CDN to mitigate DB replication lag and WAN cache purge lag.
138 * (T49162) Installer will default to setting CACHE_ACCEL as the main cache type
139   if it is available.
140 * It is now possible to patrol file uploads (both for new files and new versions
141   of existing files). Special:NewFiles has gained an option to filter by patrol
142   status. This functionality can be disabled using $wgUseFilePatrol.
143 * MediaWiki\Session infrastructure allows for easier use of session mechanisms
144   other than the usual cookies.
145 ** SessionMetadata and SessionCheckInfo hooks allow for setting and checking
146    custom session metadata.
147 * Added MWGrants and associated configuration settings $wgGrantPermissions and
148   $wgGrantPermissionGroups to hold configuration for authentication features
149   such as OAuth that want to allow restricting the user rights a user may make
150   use of.
151 ** If you're already using the OAuth extension, these new variables are
152    identical to (and will replace) $wgMWOAuthGrantPermissions and
153    $wgMWOAuthGrantPermissionGroups.
154 * Added MWRestrictions as a class to check restrictions on a WebRequest, e.g.
155   to assert that the request comes from a particular IP range.
156 * Added bot passwords, a rights-restricted login mechanism for API-using bots.
157 * Whitelisted the following HTML attributes for all elements in wikitext:
158   aria-describedby, aria-flowto, aria-label, aria-labelledby, aria-owns.
159 * Removed "presentation" restriction on the HTML role attribute in wikitext.
160   All values are now allowed for the role attribute.
162 === External library changes in 1.27 ===
164 ==== Upgraded external libraries ====
165 * Updated oojs/oojs-ui from v0.12.12 to v0.13.3.
166 * Updated composer/semver from v1.0.0 to v1.2.0.
167 * Update liuggio/statsd-php-client to 1.0.18.
169 ==== New external libraries ====
170 * Added wikimedia/base-convert v1.0.1.
171 * Added wikimedia/cldr-plural-rule-parser v1.0.0.
172 * Added wikimedia/relpath v1.0.3.
173 * Added wikimedia/running-stat v1.1.0.
174 * Added wikimedia/php-session-serializer v1.0.3.
176 ==== Removed and replaced external libraries ====
178 === Bug fixes in 1.27 ===
179 * Special:Upload will now display correct maximum allowed file size when running
180   under HHVM (T116347).
182 === Action API changes in 1.27 ===
183 * Added list=allrevisions.
184 * generator=recentchanges now has the option to generate revids.
185 * ApiPageSet::setRedirectMergePolicy() was added. This allows generator
186   modules to define how generator data for a redirect source gets merged
187   into the redirect destination.
188 * prop=imageinfo&iiprop=uploadwarning will no longer include the possibility of
189   "was-deleted" warning.
190 * Added difftotextpst to query=revisions which preforms a pre-save transform on
191   the text before diffing it.
192 * Deprecated formats dbg, txt, and yaml have been removed.
193 * (T47988) The protect log event details now use new-style formatting.
194 * The following response properties from action=login are deprecated, and may
195   be removed in the future: lgtoken, cookieprefix, sessionid. Clients should
196   handle cookies to properly manage session state.
197 * action=login transparently allows login using bot passwords. Clients should
198   merely need to change the username and password used after setting up a bot
199   password.
200 * action=upload no longer understands statuskey, asyncdownload or leavemessage.
202 === Action API internal changes in 1.27 ===
203 * ApiQueryORM removed.
204 * The following classes have been removed:
205 ** ApiFormatDbg
206 ** ApiFormatTxt
207 ** ApiFormatYaml
208 * ApiQueryBase::titleToKey(), ApiQueryBase::keyToTitle() and
209   ApiQueryBase::keyPartToTitle() all removed (deprecated since 1.24).
210 * ApiQueryBase::checkRowCount() was removed (deprecated since 1.24).
211 * ApiQueryBase::getDirectionDescription() was removed (deprecated since 1.25).
212 * ApiQuery::getModules() was removed (deprecated since 1.21).
213 * ApiMain::getModules() was removed (deprecated since 1.21).
214 * ApiBase::getVersion() was removed (deprecated since 1.21).
216 === Languages updated in 1.27 ===
218 MediaWiki supports over 350 languages. Many localisations are updated
219 regularly. Below only new and removed languages are listed, as well as
220 changes to languages because of Phabricator reports.
222 * (T113688) Change default numerals from Gurmukhi to Arabic for Punjabi locale.
224 === Other changes in 1.27 ===
225 * ProfilerOutputUdp was removed. Note that there is a ProfilerOutputStats class.
226 * WikiPage::doDeleteArticleReal() and WikiPage::doDeleteArticle() now
227   ignore the 2nd and 3rd arguments (formerly $id and $commit).
228 * Removed "loaderScripts" option from ResourceLoaderFileModule class.
229 * Removed ORM-like wrapper added in 1.20.
230 * LinkCache::getGoodLinks and LinkCache::getBadLinks were removed
231   (deprecated in 1.26).
232 * WikiPage::doQuickEdit() was removed (deprecated since 1.21).
233 * Removed SiteObject and SiteArray classes (deprecated in 1.21).
234 * MessageBlobStore::getInstance() was removed (deprecated since 1.25).
235 * (T84937) Free external links ("autolinked" urls) will now be terminated
236   by &nbsp; and HTML entity encodings of &nbsp, <, and >.
237 * (T36948) The default file revert message's timestamp is now in
238   $wgLocaltimezone, instead of UTC.
239 * The default name of the 'suppress' group page has been changed from
240   'Project:Oversight' to 'Project:Suppress'.
241 * DatabaseBase::resultObject() is now protected (use outside Database classes
242   not necessary since 1.11).
243 * Calling ResourceLoaderFileModule::readStyleFiles() without a
244   ResourceLoaderContext instance is deprecated.
245 * ResourceLoader::getLessCompiler() now takes an optional parameter of
246   additional LESS variables to set for the compiler.
247 * wfBaseConvert() marked as deprecated, use Wikimedia\base_convert() directly
248   instead.
249 * Obsolete maintenance scripts clearCacheStats.php and showCacheStats.php
250   were removed. The underlying data is sent to StatsD (see $wgStatsdServer).
251 * Removed msg_resource_links database table and associated code.
252 * Removed msg_resource database table and associated code.
253 * Skin::getNamespaceNotice() was removed.
254 * wfIsConfiguredProxy() was removed (deprecated since 1.24).
255 * wfDebugTimer() was removed (deprecated since 1.25).
256 * wfIsTrustedProxy() was removed (deprecated since 1.24).
257 * wfGetIP() was removed (deprecated since 1.19).
258 * MWHookException was removed.
259 * OutputPage::appendSubtitle() was removed (deprecated since 1.19).
260 * OutputPage::loginToUse() was removed (deprecated since 1.19).
261 * Article::loadContent() was removed (deprecated since 1.19).
262 * User::editToken() was removed (deprecated since 1.19).
263 * Removed --force-normal option of dumpBackup.php, as it no longer served
264   any useful purpose since 1.22.
265 * The functions processOption() and processArgs() on the BackupDumper and
266   TextPassDumper classes have been removed.
267 * The maintenance/backupTextPass.inc file was deleted. You should include
268   maintenance/dumpTextPass.php instead.
269 * WikiPage::getUsedTemplates() was removed (deprecated since 1.19).
270 * wfEmptyMsg() was removed (deprecated since 1.18).
271 * OutputPage::permissionRequired() was removed (deprecated since 1.18).
272 * OutputPage::blockedPage() was removed (deprecated since 1.18).
273 * User::getSkin() was removed (deprecated since 1.18).
274 * OutputPage::includeJQuery() was removed (deprecated since 1.17).
275 * WikiPage::updateRestrictions() was removed (deprecated since 1.19).
276 * WikiPage::testPreSaveTransform() was removed (deprecated since 1.19).
277 * LogPage::logName() was removed (deprecated since 1.19).
278 * LogPage::logHeader() was removed (deprecated since 1.19).
279 * wfCheckLimits() was removed (deprecated since 1.24).
280 * Linker::makeKnownLinkObj() was removed (deprecated since 1.16).
281 * Linker::makeLinkObj() was removed (deprecated since 1.16).
282 * wfMsgForContentNoTrans() was removed (deprecated since 1.18).
283 * ChangesList::usePatrol was removed (deprecated since 1.22).
284 * wfMsgNoTrans() was removed (deprecated since 1.18).
285 * Linker::makeImageLink2 was removed (deprecated since 1.20).
286 * Title::userIsWatching() was removed (deprecated since 1.20).
287 * Removed WaitForSlave maintenance script; use SELECT MASTER_POS_WAIT()
288   database function directly instead.
289 * wfMsg() was removed (deprecated since 1.18).
290 * wfMsgForContent() was removed (deprecated since 1.18).
291 * wfMsgReal() was removed (deprecated since 1.18).
292 * wfMsgGetKey() was removed (deprecated since 1.18).
293 * wfMsgHtml() was removed (deprecated since 1.18).
294 * wfMsgWikiHtml() was removed (deprecated since 1.18).
295 * wfMsgExt() was removed (deprecated since 1.18).
296 * Language::armourMath() was removed (deprecated since 1.22).
297 * LanguageConverter::armourMath() was removed (deprecated since 1.22).
298 * FakeConverter::armourMath() was removed (deprecated since 1.22).
299 * The unused jquery.validate ResourceLoader module was removed.
300 * FileRepo::getRootUrl() was removed (deprecated since 1.20).
301 * User::generateToken() was removed (deprecated since 1.20).
302 * WikiPage::getRawText() was removed (deprecated since 1.21).
303 * ParserOutput::hasCustomDataUpdates() was removed (deprecated since 1.25).
304 * ParserOutput::addSecondaryDataUpdate() was removed (deprecated since 1.25).
305 * ParserOutput::getSecondaryDataUpdates() was removed (deprecated since 1.25).
306 * Gallery images with multiple caption pipes no longer concatenate them all
307   together but instead pick the final one, similar to image syntax.
308 * XML-like parser tags (such as <gallery>), when unclosed, will be left unparsed
309   rather than consume everything until the end of the page.
310 * New maintenance script resetUserEmail.php allows sysadmins to reset user emails in case
311   a user forgot password/account was stolen.
313 == Compatibility ==
315 MediaWiki 1.27 requires PHP 5.3.3 or later. There is experimental support for
316 HHVM 3.6.5 or later.
318 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
319 support for them is somewhat less mature. There is experimental support for
320 Oracle and Microsoft SQL Server.
322 The supported versions are:
324 * MySQL 5.0.3 or later
325 * PostgreSQL 8.3 or later
326 * SQLite 3.3.7 or later
327 * Oracle 9.0.1 or later
328 * Microsoft SQL Server 2005 (9.00.1399)
330 == Upgrading ==
332 1.27 has several database changes since 1.26, and will not work without schema
333 updates. Note that due to changes to some very large tables like the revision
334 table, the schema update may take quite long (minutes on a medium sized site,
335 many hours on a large site).
337 If upgrading from before 1.11, and you are using a wiki as a commons
338 repository, make sure that it is updated as well. Otherwise, errors may arise
339 due to database schema changes.
341 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
342 new database fields are filled with data.
344 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
345 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
346 with MediaWiki 1.21.
348 Don't forget to always back up your database before upgrading!
350 See the file UPGRADE for more detailed upgrade instructions.
352 For notes on 1.26.x and older releases, see HISTORY.
354 == Online documentation ==
356 Documentation for both end-users and site administrators is available on
357 MediaWiki.org, and is covered under the GNU Free Documentation License (except
358 for pages that explicitly state that their contents are in the public domain):
360        https://www.mediawiki.org/wiki/Documentation
362 == Mailing list ==
364 A mailing list is available for MediaWiki user support and discussion:
366        https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
368 A low-traffic announcements-only list is also available:
370        https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
372 It's highly recommended that you sign up for one of these lists if you're
373 going to run a public MediaWiki, so you can be notified of security fixes.
375 == IRC help ==
377 There's usually someone online in #mediawiki on irc.freenode.net.