MediaWiki  master
LoginHelper.php
Go to the documentation of this file.
1 <?php
2 
8 class LoginHelper extends ContextSource {
21  public static $validErrorMessages = [
22  'exception-nologin-text',
23  'watchlistanontext',
24  'changeemail-no-info',
25  'resetpass-no-info',
26  'confirmemail_needlogin',
27  'prefsnologintext2',
28  ];
29 
36  public static function getValidErrorMessages() {
37  static $messages = null;
38  if ( !$messages ) {
39  $messages = self::$validErrorMessages;
40  Hooks::run( 'LoginFormValidErrorMessages', [ &$messages ] );
41  }
42 
43  return $messages;
44  }
45 
46  public function __construct( IContextSource $context ) {
47  $this->setContext( $context );
48  }
49 
63  public function showReturnToPage(
64  $type, $returnTo = '', $returnToQuery = '', $stickHTTPS = false
65  ) {
66  $config = $this->getConfig();
67  if ( $type !== 'error' && $config->get( 'RedirectOnLogin' ) !== null ) {
68  $returnTo = $config->get( 'RedirectOnLogin' );
69  $returnToQuery = [];
70  } elseif ( is_string( $returnToQuery ) ) {
71  $returnToQuery = wfCgiToArray( $returnToQuery );
72  }
73 
74  // Allow modification of redirect behavior
75  Hooks::run( 'PostLoginRedirect', [ &$returnTo, &$returnToQuery, &$type ] );
76 
77  $returnToTitle = Title::newFromText( $returnTo ) ?: Title::newMainPage();
78 
79  if ( $config->get( 'SecureLogin' ) && !$stickHTTPS ) {
80  $options = [ 'http' ];
81  $proto = PROTO_HTTP;
82  } elseif ( $config->get( 'SecureLogin' ) ) {
83  $options = [ 'https' ];
84  $proto = PROTO_HTTPS;
85  } else {
86  $options = [];
87  $proto = PROTO_RELATIVE;
88  }
89 
90  if ( $type === 'successredirect' ) {
91  $redirectUrl = $returnToTitle->getFullUrlForRedirect( $returnToQuery, $proto );
92  $this->getOutput()->redirect( $redirectUrl );
93  } else {
94  $this->getOutput()->addReturnTo( $returnToTitle, $returnToQuery, null, $options );
95  }
96  }
97 }
setContext(IContextSource $context)
static newMainPage(MessageLocalizer $localizer=null)
Create a new Title for the Main Page.
Definition: Title.php:653
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
IContextSource $context
const PROTO_HTTPS
Definition: Defines.php:220
wfCgiToArray( $query)
This is the logical opposite of wfArrayToCgi(): it accepts a query string as its argument and returns...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:1982
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 null
Definition: hooks.txt:780
const PROTO_RELATIVE
Definition: Defines.php:221
Helper functions for the login form that need to be shared with other special pages (such as CentralA...
Definition: LoginHelper.php:8
const PROTO_HTTP
Definition: Defines.php:219
static string [] $validErrorMessages
Valid error and warning messages.
Definition: LoginHelper.php:21
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
showReturnToPage( $type, $returnTo='', $returnToQuery='', $stickHTTPS=false)
Show a return link or redirect to it.
Definition: LoginHelper.php:63
static getValidErrorMessages()
Returns an array of all valid error messages.
Definition: LoginHelper.php:36
__construct(IContextSource $context)
Definition: LoginHelper.php:46
$messages
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319