MediaWiki  master
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  // Make sure it's possible to log out
53  if ( !$session->canSetUser() ) {
54  throw new ErrorPageError(
55  'cannotlogoutnow-title',
56  'cannotlogoutnow-text',
57  [
58  $session->getProvider()->describe( RequestContext::getMain()->getLanguage() )
59  ]
60  );
61  }
62 
63  $user = $this->getUser();
64  $oldName = $user->getName();
65 
66  $user->logout();
67 
68  $loginURL = SpecialPage::getTitleFor( 'Userlogin' )->getFullURL(
69  $this->getRequest()->getValues( 'returnto', 'returntoquery' ) );
70 
71  $out = $this->getOutput();
72  $out->addWikiMsg( 'logouttext', $loginURL );
73 
74  // Hook.
75  $injected_html = '';
76  Hooks::run( 'UserLogoutComplete', [ &$user, &$injected_html, $oldName ] );
77  $out->addHTML( $injected_html );
78 
79  $out->returnToMain();
80  }
81 
82  protected function getGroupName() {
83  return 'login';
84  }
85 }
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub 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:785
Shortcut to construct a special page which is unlisted by default.
getOutput()
Get the OutputPage being used for this instance.
Show an error that looks like an HTTP server error.
Definition: HttpError.php:30
static getMain()
Get the RequestContext object associated with the main request.
An error page which can definitely be safely rendered using the OutputPage.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes! ...
static getTitleFor( $name, $subpage=false, $fragment='')
Get a localised Title object for a specified special page name If you don&#39;t need a full Title object...
Definition: SpecialPage.php:82
static getGlobalSession()
Get the "global" session.
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
getUser()
Shortcut to get the User executing this instance.
getLanguage()
Shortcut to get user&#39;s language.
msg( $key)
Wrapper around wfMessage that sets the current context.
getRequest()
Get the WebRequest being used for this instance.
Implements Special:Userlogout.
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1487
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200