MediaWiki  1.33.0
SpecialUserLogout.php
Go to the documentation of this file.
1 <?php
30  function __construct() {
31  parent::__construct( 'Userlogout' );
32  }
33 
34  public function doesWrites() {
35  return true;
36  }
37 
38  function execute( $par ) {
43  if ( isset( $_SERVER['REQUEST_URI'] ) && strpos( $_SERVER['REQUEST_URI'], '&amp;' ) !== false ) {
44  wfDebug( "Special:UserLogout request {$_SERVER['REQUEST_URI']} looks suspicious, denying.\n" );
45  throw new HttpError( 400, $this->msg( 'suspicious-userlogout' ), $this->msg( 'loginerror' ) );
46  }
47 
48  $this->setHeaders();
49  $this->outputHeader();
50 
51  $out = $this->getOutput();
52  $user = $this->getUser();
53  $request = $this->getRequest();
54 
55  $logoutToken = $request->getVal( 'logoutToken' );
56  $urlParams = [
57  'logoutToken' => $user->getEditToken( 'logoutToken', $request )
58  ] + $request->getValues();
59  unset( $urlParams['title'] );
60  $continueLink = $this->getFullTitle()->getFullUrl( $urlParams );
61 
62  if ( $logoutToken === null ) {
63  $this->getOutput()->addWikiMsg( 'userlogout-continue', $continueLink );
64  return;
65  }
66  if ( !$this->getUser()->matchEditToken(
67  $logoutToken, 'logoutToken', $this->getRequest(), 24 * 60 * 60
68  ) ) {
69  $this->getOutput()->addWikiMsg( 'userlogout-sessionerror', $continueLink );
70  return;
71  }
72 
73  // Make sure it's possible to log out
75  if ( !$session->canSetUser() ) {
76  throw new ErrorPageError(
77  'cannotlogoutnow-title',
78  'cannotlogoutnow-text',
79  [
80  $session->getProvider()->describe( RequestContext::getMain()->getLanguage() )
81  ]
82  );
83  }
84 
85  $user = $this->getUser();
86  $oldName = $user->getName();
87 
88  $user->logout();
89 
90  $loginURL = SpecialPage::getTitleFor( 'Userlogin' )->getFullURL(
91  $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
92 
93  $out = $this->getOutput();
94  $out->addWikiMsg( 'logouttext', $loginURL );
95 
96  // Hook.
97  $injected_html = '';
98  Hooks::run( 'UserLogoutComplete', [ &$user, &$injected_html, $oldName ] );
99  $out->addHTML( $injected_html );
100 
101  $out->returnToMain();
102  }
103 
104  protected function getGroupName() {
105  return 'login';
106  }
107 }
$user
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1476
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:796
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:725
UnlistedSpecialPage
Shortcut to construct a special page which is unlisted by default.
Definition: UnlistedSpecialPage.php:29
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:780
SpecialPage\getTitleFor
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don't need a full Title object,...
Definition: SpecialPage.php:82
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:755
HttpError
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
SpecialPage\getFullTitle
getFullTitle()
Return the full title, including $par.
Definition: SpecialPage.php:774
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:531
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:735
SpecialUserLogout\doesWrites
doesWrites()
Indicates whether this special page may perform database writes.
Definition: SpecialUserLogout.php:34
wfDebug
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
Definition: GlobalFunctions.php:949
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2636
MediaWiki\Session\SessionManager\getGlobalSession
static getGlobalSession()
Get the "global" session.
Definition: SessionManager.php:107
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:715
RequestContext\getMain
static getMain()
Get the RequestContext object associated with the main request.
Definition: RequestContext.php:430
SpecialUserLogout
Implements Special:Userlogout.
Definition: SpecialUserLogout.php:29
SpecialUserLogout\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialUserLogout.php:104
ErrorPageError
An error page which can definitely be safely rendered using the OutputPage.
Definition: ErrorPageError.php:27
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:633
SpecialUserLogout\execute
execute( $par)
Default execute method Checks user permissions.
Definition: SpecialUserLogout.php:38
SpecialUserLogout\__construct
__construct()
Definition: SpecialUserLogout.php:30