MediaWiki  master
SpecialPageExecutor.php
Go to the documentation of this file.
1 <?php
2 
9 
21  public function executeSpecialPage(
22  SpecialPage $page,
23  $subPage = '',
24  WebRequest $request = null,
25  $language = null,
26  User $user = null
27  ) {
28  $context = $this->newContext( $request, $language, $user );
29 
30  $output = new OutputPage( $context );
31  $context->setOutput( $output );
32 
33  $page->setContext( $context );
34  $output->setTitle( $page->getPageTitle() );
35 
36  $html = $this->getHTMLFromSpecialPage( $page, $subPage );
37  $response = $context->getRequest()->response();
38 
39  if ( $response instanceof FauxResponse ) {
40  $code = $response->getStatusCode();
41 
42  if ( $code > 0 ) {
43  $response->header( 'Status: ' . $code . ' ' . HttpStatus::getMessage( $code ) );
44  }
45  }
46 
47  return [ $html, $response ];
48  }
49 
57  private function newContext(
58  WebRequest $request = null,
59  $language = null,
60  User $user = null
61  ) {
63 
64  $context->setRequest( $request ?: new FauxRequest() );
65 
66  if ( $language !== null ) {
67  $context->setLanguage( $language );
68  }
69 
70  if ( $user !== null ) {
71  $context->setUser( $user );
72  }
73 
75 
76  // Make sure the skin context is correctly set https://phabricator.wikimedia.org/T200771
77  $context->getSkin()->setContext( $context );
78 
79  return $context;
80  }
81 
88  $request = $context->getRequest();
89 
90  // Edits via GET are a security issue and should not succeed. On the other hand, not all
91  // POST requests are edits, but should ignore unused parameters.
92  if ( !$request->getCheck( 'wpEditToken' ) && $request->wasPosted() ) {
93  $request->setVal( 'wpEditToken', $context->getUser()->getEditToken() );
94  }
95  }
96 
104  private function getHTMLFromSpecialPage( SpecialPage $page, $subPage ) {
105  ob_start();
106 
107  try {
108  $page->execute( $subPage );
109 
110  $output = $page->getOutput();
111 
112  if ( $output->getRedirect() !== '' ) {
113  $output->output();
114  $html = ob_get_contents();
115  } elseif ( $output->isDisabled() ) {
116  $html = ob_get_contents();
117  } else {
118  $html = $output->getHTML();
119  }
120  } finally {
121  ob_end_clean();
122  }
123 
124  return $html;
125  }
126 
127 }
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 noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:1996
An IContextSource implementation which will inherit context from another source but allow individual ...
getOutput()
Get the OutputPage being used for this instance.
this hook is for auditing only $response
Definition: hooks.txt:785
executeSpecialPage(SpecialPage $page, $subPage='', WebRequest $request=null, $language=null, User $user=null)
getHTMLFromSpecialPage(SpecialPage $page, $subPage)
static configuration should be added through ResourceLoaderGetConfigVars instead can be used to get the real title e g db for database replication lag or jobqueue for job queue size converted to pseudo seconds It is possible to add more fields and they will be returned to the user in the API response after the basic globals have been set but before ordinary actions take place $output
Definition: hooks.txt:2221
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:47
setContext( $context)
Sets the context this SpecialPage is executed in.
static getMain()
Get the RequestContext object associated with the main request.
static getMessage( $code)
Get the message associated with an HTTP response status code.
Definition: HttpStatus.php:34
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 modifiable & $code
Definition: hooks.txt:785
execute( $subPage)
Default execute method Checks user permissions.
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
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 and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2626
newContext(WebRequest $request=null, $language=null, User $user=null)
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:2626
getPageTitle( $subpage=false)
Get a self-referential title object.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1487
setEditTokenFromUser(DerivativeContext $context)
If we are trying to edit and no token is set, supply one.