2008-01-08 18:10:58 +00:00
|
|
|
<?php
|
2010-02-23 18:05:46 +00:00
|
|
|
/**
|
2012-07-15 20:13:02 +00:00
|
|
|
* Copyright © 2008 Yuri Astrakhan "<Firstname><Lastname>@gmail.com",
|
2008-01-08 18:10:58 +00:00
|
|
|
*
|
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
|
* (at your option) any later version.
|
|
|
|
|
*
|
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
|
*
|
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
2010-06-21 13:13:32 +00:00
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2008-01-08 18:10:58 +00:00
|
|
|
* http://www.gnu.org/copyleft/gpl.html
|
2010-08-07 19:59:42 +00:00
|
|
|
*
|
|
|
|
|
* @file
|
2008-01-08 18:10:58 +00:00
|
|
|
*/
|
|
|
|
|
|
2016-02-29 17:12:17 +00:00
|
|
|
use MediaWiki\Session\BotPasswordSessionProvider;
|
|
|
|
|
|
2008-01-12 07:08:17 +00:00
|
|
|
/**
|
2008-04-14 07:45:50 +00:00
|
|
|
* API module to allow users to log out of the wiki. API equivalent of
|
2008-01-12 07:08:17 +00:00
|
|
|
* Special:Userlogout.
|
|
|
|
|
*
|
WARNING: HUGE COMMIT
Doxygen documentation update:
* Changed alls @addtogroup to @ingroup. @addtogroup adds the comment to the group description, but doesn't add the file, class, function, ... to the group like @ingroup does. See for example http://svn.wikimedia.org/doc/group__SpecialPage.html where it's impossible to see related files, classes, ... that should belong to that group.
* Added @file to file description, it seems that it should be explicitely decalred for file descriptions, otherwise doxygen will think that the comment document the first class, variabled, function, ... that is in that file.
* Removed some empty comments
* Removed some ?>
Added following groups:
* ExternalStorage
* JobQueue
* MaintenanceLanguage
One more thing: there are still a lot of warnings when generating the doc.
2008-05-20 17:13:28 +00:00
|
|
|
* @ingroup API
|
2008-01-12 07:08:17 +00:00
|
|
|
*/
|
2008-01-08 18:10:58 +00:00
|
|
|
class ApiLogout extends ApiBase {
|
|
|
|
|
|
|
|
|
|
public function execute() {
|
2016-02-01 20:44:03 +00:00
|
|
|
$session = MediaWiki\Session\SessionManager::getGlobalSession();
|
2016-02-29 17:12:17 +00:00
|
|
|
|
|
|
|
|
// Handle bot password logout specially
|
|
|
|
|
if ( $session->getProvider() instanceof BotPasswordSessionProvider ) {
|
|
|
|
|
$session->unpersist();
|
|
|
|
|
return;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Make sure it's possible to log out
|
2016-02-01 20:44:03 +00:00
|
|
|
if ( !$session->canSetUser() ) {
|
2016-10-19 16:54:25 +00:00
|
|
|
$this->dieWithError(
|
|
|
|
|
[
|
|
|
|
|
'cannotlogoutnow-text',
|
|
|
|
|
$session->getProvider()->describe( $this->getErrorFormatter()->getLanguage() )
|
|
|
|
|
],
|
2016-02-01 20:44:03 +00:00
|
|
|
'cannotlogout'
|
|
|
|
|
);
|
|
|
|
|
}
|
|
|
|
|
|
2011-10-26 23:27:01 +00:00
|
|
|
$user = $this->getUser();
|
|
|
|
|
$oldName = $user->getName();
|
|
|
|
|
$user->logout();
|
2010-02-23 18:05:46 +00:00
|
|
|
|
2008-05-24 20:44:49 +00:00
|
|
|
// Give extensions to do something after user logout
|
|
|
|
|
$injected_html = '';
|
Hooks::run() call site migration
Migrate all callers of Hooks::run() to use the new
HookContainer/HookRunner system.
General principles:
* Use DI if it is already used. We're not changing the way state is
managed in this patch.
* HookContainer is always injected, not HookRunner. HookContainer
is a service, it's a more generic interface, it is the only
thing that provides isRegistered() which is needed in some cases,
and a HookRunner can be efficiently constructed from it
(confirmed by benchmark). Because HookContainer is needed
for object construction, it is also needed by all factories.
* "Ask your friendly local base class". Big hierarchies like
SpecialPage and ApiBase have getHookContainer() and getHookRunner()
methods in the base class, and classes that extend that base class
are not expected to know or care where the base class gets its
HookContainer from.
* ProtectedHookAccessorTrait provides protected getHookContainer() and
getHookRunner() methods, getting them from the global service
container. The point of this is to ease migration to DI by ensuring
that call sites ask their local friendly base class rather than
getting a HookRunner from the service container directly.
* Private $this->hookRunner. In some smaller classes where accessor
methods did not seem warranted, there is a private HookRunner property
which is accessed directly. Very rarely (two cases), there is a
protected property, for consistency with code that conventionally
assumes protected=private, but in cases where the class might actually
be overridden, a protected accessor is preferred over a protected
property.
* The last resort: Hooks::runner(). Mostly for static, file-scope and
global code. In a few cases it was used for objects with broken
construction schemes, out of horror or laziness.
Constructors with new required arguments:
* AuthManager
* BadFileLookup
* BlockManager
* ClassicInterwikiLookup
* ContentHandlerFactory
* ContentSecurityPolicy
* DefaultOptionsManager
* DerivedPageDataUpdater
* FullSearchResultWidget
* HtmlCacheUpdater
* LanguageFactory
* LanguageNameUtils
* LinkRenderer
* LinkRendererFactory
* LocalisationCache
* MagicWordFactory
* MessageCache
* NamespaceInfo
* PageEditStash
* PageHandlerFactory
* PageUpdater
* ParserFactory
* PermissionManager
* RevisionStore
* RevisionStoreFactory
* SearchEngineConfig
* SearchEngineFactory
* SearchFormWidget
* SearchNearMatcher
* SessionBackend
* SpecialPageFactory
* UserNameUtils
* UserOptionsManager
* WatchedItemQueryService
* WatchedItemStore
Constructors with new optional arguments:
* DefaultPreferencesFactory
* Language
* LinkHolderArray
* MovePage
* Parser
* ParserCache
* PasswordReset
* Router
setHookContainer() now required after construction:
* AuthenticationProvider
* ResourceLoaderModule
* SearchEngine
Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
2020-03-19 02:42:09 +00:00
|
|
|
$this->getHookRunner()->onUserLogoutComplete( $user, $injected_html, $oldName );
|
2008-01-08 18:10:58 +00:00
|
|
|
}
|
|
|
|
|
|
2019-04-16 22:09:43 +00:00
|
|
|
public function mustBePosted() {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
public function needsToken() {
|
|
|
|
|
return 'csrf';
|
|
|
|
|
}
|
|
|
|
|
|
2019-04-25 13:49:01 +00:00
|
|
|
protected function getWebUITokenSalt( array $params ) {
|
|
|
|
|
return 'logoutToken';
|
|
|
|
|
}
|
|
|
|
|
|
2009-03-06 13:49:44 +00:00
|
|
|
public function isReadMode() {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2014-10-28 17:17:02 +00:00
|
|
|
protected function getExamplesMessages() {
|
2016-02-17 09:09:32 +00:00
|
|
|
return [
|
2019-04-16 22:09:43 +00:00
|
|
|
'action=logout&token=123ABC'
|
2014-09-18 17:38:23 +00:00
|
|
|
=> 'apihelp-logout-example-logout',
|
2016-02-17 09:09:32 +00:00
|
|
|
];
|
2008-01-08 18:10:58 +00:00
|
|
|
}
|
|
|
|
|
|
2011-07-17 16:23:29 +00:00
|
|
|
public function getHelpUrls() {
|
2017-04-04 22:52:57 +00:00
|
|
|
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Logout';
|
2011-07-17 16:18:09 +00:00
|
|
|
}
|
2008-01-12 07:08:17 +00:00
|
|
|
}
|