MediaWiki  REL1_31
MWHttpRequest.php
Go to the documentation of this file.
1 <?php
21 use Psr\Log\LoggerInterface;
22 use Psr\Log\LoggerAwareInterface;
23 use Psr\Log\NullLogger;
24 
32 abstract class MWHttpRequest implements LoggerAwareInterface {
33  const SUPPORTS_FILE_POSTS = false;
34 
38  protected $timeout = 'default';
39 
40  protected $content;
41  protected $headersOnly = null;
42  protected $postData = null;
43  protected $proxy = null;
44  protected $noProxy = false;
45  protected $sslVerifyHost = true;
46  protected $sslVerifyCert = true;
47  protected $caInfo = null;
48  protected $method = "GET";
49  protected $reqHeaders = [];
50  protected $url;
51  protected $parsedUrl;
53  protected $callback;
54  protected $maxRedirects = 5;
55  protected $followRedirects = false;
56  protected $connectTimeout;
57 
61  protected $cookieJar;
62 
63  protected $headerList = [];
64  protected $respVersion = "0.9";
65  protected $respStatus = "200 Ok";
66  protected $respHeaders = [];
67 
69  protected $status;
70 
74  protected $profiler;
75 
79  protected $profileName;
80 
84  protected $logger;
85 
92  public function __construct(
93  $url, array $options = [], $caller = __METHOD__, $profiler = null
94  ) {
96 
97  $this->url = wfExpandUrl( $url, PROTO_HTTP );
98  $this->parsedUrl = wfParseUrl( $this->url );
99 
100  if ( isset( $options['logger'] ) ) {
101  $this->logger = $options['logger'];
102  } else {
103  $this->logger = new NullLogger();
104  }
105 
106  if ( !$this->parsedUrl || !Http::isValidURI( $this->url ) ) {
107  $this->status = StatusValue::newFatal( 'http-invalid-url', $url );
108  } else {
109  $this->status = StatusValue::newGood( 100 ); // continue
110  }
111 
112  if ( isset( $options['timeout'] ) && $options['timeout'] != 'default' ) {
113  $this->timeout = $options['timeout'];
114  } else {
115  $this->timeout = $wgHTTPTimeout;
116  }
117  if ( isset( $options['connectTimeout'] ) && $options['connectTimeout'] != 'default' ) {
118  $this->connectTimeout = $options['connectTimeout'];
119  } else {
120  $this->connectTimeout = $wgHTTPConnectTimeout;
121  }
122  if ( isset( $options['userAgent'] ) ) {
123  $this->setUserAgent( $options['userAgent'] );
124  }
125  if ( isset( $options['username'] ) && isset( $options['password'] ) ) {
126  $this->setHeader(
127  'Authorization',
128  'Basic ' . base64_encode( $options['username'] . ':' . $options['password'] )
129  );
130  }
131  if ( isset( $options['originalRequest'] ) ) {
132  $this->setOriginalRequest( $options['originalRequest'] );
133  }
134 
135  $members = [ "postData", "proxy", "noProxy", "sslVerifyHost", "caInfo",
136  "method", "followRedirects", "maxRedirects", "sslVerifyCert", "callback" ];
137 
138  foreach ( $members as $o ) {
139  if ( isset( $options[$o] ) ) {
140  // ensure that MWHttpRequest::method is always
141  // uppercased. T38137
142  if ( $o == 'method' ) {
143  $options[$o] = strtoupper( $options[$o] );
144  }
145  $this->$o = $options[$o];
146  }
147  }
148 
149  if ( $this->noProxy ) {
150  $this->proxy = ''; // noProxy takes precedence
151  }
152 
153  // Profile based on what's calling us
154  $this->profiler = $profiler;
155  $this->profileName = $caller;
156  }
157 
161  public function setLogger( LoggerInterface $logger ) {
162  $this->logger = $logger;
163  }
164 
170  public static function canMakeRequests() {
171  return function_exists( 'curl_init' ) || wfIniGetBool( 'allow_url_fopen' );
172  }
173 
184  public static function factory( $url, array $options = null, $caller = __METHOD__ ) {
185  if ( $options === null ) {
186  $options = [];
187  }
188  return \MediaWiki\MediaWikiServices::getInstance()
189  ->getHttpRequestFactory()
190  ->create( $url, $options, $caller );
191  }
192 
198  public function getContent() {
199  return $this->content;
200  }
201 
208  public function setData( $args ) {
209  $this->postData = $args;
210  }
211 
217  protected function proxySetup() {
218  // If there is an explicit proxy set and proxies are not disabled, then use it
219  if ( $this->proxy && !$this->noProxy ) {
220  return;
221  }
222 
223  // Otherwise, fallback to $wgHTTPProxy if this is not a machine
224  // local URL and proxies are not disabled
225  if ( self::isLocalURL( $this->url ) || $this->noProxy ) {
226  $this->proxy = '';
227  } else {
228  $this->proxy = Http::getProxy();
229  }
230  }
231 
238  private static function isLocalURL( $url ) {
240 
241  if ( $wgCommandLineMode ) {
242  return false;
243  }
244 
245  // Extract host part
246  $matches = [];
247  if ( preg_match( '!^https?://([\w.-]+)[/:].*$!', $url, $matches ) ) {
248  $host = $matches[1];
249  // Split up dotwise
250  $domainParts = explode( '.', $host );
251  // Check if this domain or any superdomain is listed as a local virtual host
252  $domainParts = array_reverse( $domainParts );
253 
254  $domain = '';
255  $countParts = count( $domainParts );
256  for ( $i = 0; $i < $countParts; $i++ ) {
257  $domainPart = $domainParts[$i];
258  if ( $i == 0 ) {
259  $domain = $domainPart;
260  } else {
261  $domain = $domainPart . '.' . $domain;
262  }
263 
264  if ( in_array( $domain, $wgLocalVirtualHosts ) ) {
265  return true;
266  }
267  }
268  }
269 
270  return false;
271  }
272 
277  public function setUserAgent( $UA ) {
278  $this->setHeader( 'User-Agent', $UA );
279  }
280 
286  public function setHeader( $name, $value ) {
287  // I feel like I should normalize the case here...
288  $this->reqHeaders[$name] = $value;
289  }
290 
295  protected function getHeaderList() {
296  $list = [];
297 
298  if ( $this->cookieJar ) {
299  $this->reqHeaders['Cookie'] =
300  $this->cookieJar->serializeToHttpRequest(
301  $this->parsedUrl['path'],
302  $this->parsedUrl['host']
303  );
304  }
305 
306  foreach ( $this->reqHeaders as $name => $value ) {
307  $list[] = "$name: $value";
308  }
309 
310  return $list;
311  }
312 
331  public function setCallback( $callback ) {
332  if ( is_null( $callback ) ) {
333  $callback = [ $this, 'read' ];
334  } elseif ( !is_callable( $callback ) ) {
335  throw new InvalidArgumentException( __METHOD__ . ': invalid callback' );
336  }
337  $this->callback = $callback;
338  }
339 
349  public function read( $fh, $content ) {
350  $this->content .= $content;
351  return strlen( $content );
352  }
353 
360  public function execute() {
361  throw new LogicException( 'children must override this' );
362  }
363 
364  protected function prepare() {
365  $this->content = "";
366 
367  if ( strtoupper( $this->method ) == "HEAD" ) {
368  $this->headersOnly = true;
369  }
370 
371  $this->proxySetup(); // set up any proxy as needed
372 
373  if ( !$this->callback ) {
374  $this->setCallback( null );
375  }
376 
377  if ( !isset( $this->reqHeaders['User-Agent'] ) ) {
378  $this->setUserAgent( Http::userAgent() );
379  }
380  }
381 
387  protected function parseHeader() {
388  $lastname = "";
389 
390  foreach ( $this->headerList as $header ) {
391  if ( preg_match( "#^HTTP/([0-9.]+) (.*)#", $header, $match ) ) {
392  $this->respVersion = $match[1];
393  $this->respStatus = $match[2];
394  } elseif ( preg_match( "#^[ \t]#", $header ) ) {
395  $last = count( $this->respHeaders[$lastname] ) - 1;
396  $this->respHeaders[$lastname][$last] .= "\r\n$header";
397  } elseif ( preg_match( "#^([^:]*):[\t ]*(.*)#", $header, $match ) ) {
398  $this->respHeaders[strtolower( $match[1] )][] = $match[2];
399  $lastname = strtolower( $match[1] );
400  }
401  }
402 
403  $this->parseCookies();
404  }
405 
414  protected function setStatus() {
415  if ( !$this->respHeaders ) {
416  $this->parseHeader();
417  }
418 
419  if ( (int)$this->respStatus > 399 ) {
420  list( $code, $message ) = explode( " ", $this->respStatus, 2 );
421  $this->status->fatal( "http-bad-status", $code, $message );
422  }
423  }
424 
432  public function getStatus() {
433  if ( !$this->respHeaders ) {
434  $this->parseHeader();
435  }
436 
437  return (int)$this->respStatus;
438  }
439 
445  public function isRedirect() {
446  if ( !$this->respHeaders ) {
447  $this->parseHeader();
448  }
449 
450  $status = (int)$this->respStatus;
451 
452  if ( $status >= 300 && $status <= 303 ) {
453  return true;
454  }
455 
456  return false;
457  }
458 
467  public function getResponseHeaders() {
468  if ( !$this->respHeaders ) {
469  $this->parseHeader();
470  }
471 
472  return $this->respHeaders;
473  }
474 
481  public function getResponseHeader( $header ) {
482  if ( !$this->respHeaders ) {
483  $this->parseHeader();
484  }
485 
486  if ( isset( $this->respHeaders[strtolower( $header )] ) ) {
487  $v = $this->respHeaders[strtolower( $header )];
488  return $v[count( $v ) - 1];
489  }
490 
491  return null;
492  }
493 
501  public function setCookieJar( $jar ) {
502  $this->cookieJar = $jar;
503  }
504 
510  public function getCookieJar() {
511  if ( !$this->respHeaders ) {
512  $this->parseHeader();
513  }
514 
515  return $this->cookieJar;
516  }
517 
527  public function setCookie( $name, $value, $attr = [] ) {
528  if ( !$this->cookieJar ) {
529  $this->cookieJar = new CookieJar;
530  }
531 
532  if ( $this->parsedUrl && !isset( $attr['domain'] ) ) {
533  $attr['domain'] = $this->parsedUrl['host'];
534  }
535 
536  $this->cookieJar->setCookie( $name, $value, $attr );
537  }
538 
542  protected function parseCookies() {
543  if ( !$this->cookieJar ) {
544  $this->cookieJar = new CookieJar;
545  }
546 
547  if ( isset( $this->respHeaders['set-cookie'] ) ) {
548  $url = parse_url( $this->getFinalUrl() );
549  foreach ( $this->respHeaders['set-cookie'] as $cookie ) {
550  $this->cookieJar->parseCookieResponseHeader( $cookie, $url['host'] );
551  }
552  }
553  }
554 
571  public function getFinalUrl() {
572  $headers = $this->getResponseHeaders();
573 
574  // return full url (fix for incorrect but handled relative location)
575  if ( isset( $headers['location'] ) ) {
576  $locations = $headers['location'];
577  $domain = '';
578  $foundRelativeURI = false;
579  $countLocations = count( $locations );
580 
581  for ( $i = $countLocations - 1; $i >= 0; $i-- ) {
582  $url = parse_url( $locations[$i] );
583 
584  if ( isset( $url['host'] ) ) {
585  $domain = $url['scheme'] . '://' . $url['host'];
586  break; // found correct URI (with host)
587  } else {
588  $foundRelativeURI = true;
589  }
590  }
591 
592  if ( !$foundRelativeURI ) {
593  return $locations[$countLocations - 1];
594  }
595  if ( $domain ) {
596  return $domain . $locations[$countLocations - 1];
597  }
598  $url = parse_url( $this->url );
599  if ( isset( $url['host'] ) ) {
600  return $url['scheme'] . '://' . $url['host'] .
601  $locations[$countLocations - 1];
602  }
603  }
604 
605  return $this->url;
606  }
607 
613  public function canFollowRedirects() {
614  return true;
615  }
616 
629  public function setOriginalRequest( $originalRequest ) {
630  if ( $originalRequest instanceof WebRequest ) {
631  $originalRequest = [
632  'ip' => $originalRequest->getIP(),
633  'userAgent' => $originalRequest->getHeader( 'User-Agent' ),
634  ];
635  } elseif (
636  !is_array( $originalRequest )
637  || array_diff( [ 'ip', 'userAgent' ], array_keys( $originalRequest ) )
638  ) {
639  throw new InvalidArgumentException( __METHOD__ . ': $originalRequest must be a '
640  . "WebRequest or an array with 'ip' and 'userAgent' keys" );
641  }
642 
643  $this->reqHeaders['X-Forwarded-For'] = $originalRequest['ip'];
644  $this->reqHeaders['X-Original-User-Agent'] = $originalRequest['userAgent'];
645  }
646 }
MWHttpRequest\$headerList
$headerList
Definition: MWHttpRequest.php:63
$wgLocalVirtualHosts
$wgLocalVirtualHosts
Local virtual hosts.
Definition: DefaultSettings.php:8397
$wgHTTPConnectTimeout
$wgHTTPConnectTimeout
Timeout for connections done internally (in seconds) Only works for curl.
Definition: DefaultSettings.php:8403
MWHttpRequest\$headersOnly
$headersOnly
Definition: MWHttpRequest.php:41
StatusValue
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition: StatusValue.php:42
MWHttpRequest\$logger
LoggerInterface $logger
Definition: MWHttpRequest.php:84
MWHttpRequest\$callback
callable $callback
Definition: MWHttpRequest.php:53
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
content
per default it will return the text for text based content
Definition: contenthandler.txt:104
MWHttpRequest\setStatus
setStatus()
Sets HTTPRequest status member to a fatal value with the error message if the returned integer value ...
Definition: MWHttpRequest.php:414
MWHttpRequest\$respVersion
$respVersion
Definition: MWHttpRequest.php:64
array
the array() calling protocol came about after MediaWiki 1.4rc1.
MWHttpRequest\setCookie
setCookie( $name, $value, $attr=[])
Sets a cookie.
Definition: MWHttpRequest.php:527
MWHttpRequest\proxySetup
proxySetup()
Take care of setting up the proxy (do nothing if "noProxy" is set)
Definition: MWHttpRequest.php:217
$last
$last
Definition: profileinfo.php:408
MWHttpRequest\$maxRedirects
$maxRedirects
Definition: MWHttpRequest.php:54
MWHttpRequest\$sslVerifyCert
$sslVerifyCert
Definition: MWHttpRequest.php:46
Http\userAgent
static userAgent()
A standard user-agent we can use for external requests.
Definition: Http.php:129
MWHttpRequest\$followRedirects
$followRedirects
Definition: MWHttpRequest.php:55
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
MWHttpRequest\setData
setData( $args)
Set the parameters of the request.
Definition: MWHttpRequest.php:208
MWHttpRequest\$content
$content
Definition: MWHttpRequest.php:40
MWHttpRequest\$status
StatusValue $status
Definition: MWHttpRequest.php:69
$wgHTTPTimeout
int $wgHTTPTimeout
Timeout for HTTP requests done internally, in seconds.
Definition: DefaultSettings.php:8366
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:37
MWHttpRequest\$profiler
Profiler $profiler
Definition: MWHttpRequest.php:74
MWHttpRequest\getStatus
getStatus()
Get the integer value of the HTTP status code (e.g.
Definition: MWHttpRequest.php:432
MWHttpRequest\$noProxy
$noProxy
Definition: MWHttpRequest.php:44
MWHttpRequest\parseHeader
parseHeader()
Parses the headers, including the HTTP status code and any Set-Cookie headers.
Definition: MWHttpRequest.php:387
MWHttpRequest\$connectTimeout
$connectTimeout
Definition: MWHttpRequest.php:56
wfParseUrl
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:801
MWHttpRequest\$postData
$postData
Definition: MWHttpRequest.php:42
MWHttpRequest\getContent
getContent()
Get the body, or content, of the response to the request.
Definition: MWHttpRequest.php:198
MWHttpRequest\SUPPORTS_FILE_POSTS
const SUPPORTS_FILE_POSTS
Definition: MWHttpRequest.php:33
MWHttpRequest\parseCookies
parseCookies()
Parse the cookies in the response headers and store them in the cookie jar.
Definition: MWHttpRequest.php:542
MWHttpRequest\$respStatus
$respStatus
Definition: MWHttpRequest.php:65
CookieJar\setCookie
setCookie( $name, $value, $attr)
Set a cookie in the cookie jar.
Definition: CookieJar.php:36
$wgCommandLineMode
global $wgCommandLineMode
Definition: DevelopmentSettings.php:28
$matches
$matches
Definition: NoLocalSettings.php:24
MWHttpRequest\isRedirect
isRedirect()
Returns true if the last status code was a redirect.
Definition: MWHttpRequest.php:445
Http\getProxy
static getProxy()
Gets the relevant proxy from $wgHTTPProxy.
Definition: Http.php:158
Profiler
Profiler base class that defines the interface and some trivial functionality.
Definition: Profiler.php:33
MWHttpRequest\getCookieJar
getCookieJar()
Returns the cookie jar in use.
Definition: MWHttpRequest.php:510
MWHttpRequest\$timeout
int string $timeout
Definition: MWHttpRequest.php:38
MWHttpRequest\isLocalURL
static isLocalURL( $url)
Check if the URL can be served by localhost.
Definition: MWHttpRequest.php:238
MWHttpRequest\$reqHeaders
$reqHeaders
Definition: MWHttpRequest.php:49
MWHttpRequest\setCookieJar
setCookieJar( $jar)
Tells the MWHttpRequest object to use this pre-loaded CookieJar.
Definition: MWHttpRequest.php:501
MWHttpRequest\$respHeaders
$respHeaders
Definition: MWHttpRequest.php:66
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
MWHttpRequest\$cookieJar
CookieJar $cookieJar
Definition: MWHttpRequest.php:61
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
$options
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:2001
MWHttpRequest\read
read( $fh, $content)
A generic callback to read the body of the response from a remote server.
Definition: MWHttpRequest.php:349
$value
$value
Definition: styleTest.css.php:45
$header
$header
Definition: updateCredits.php:35
MWHttpRequest\$method
$method
Definition: MWHttpRequest.php:48
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
MWHttpRequest
This wrapper class will call out to curl (if available) or fallback to regular PHP if necessary for h...
Definition: MWHttpRequest.php:32
MWHttpRequest\setCallback
setCallback( $callback)
Set a read callback to accept data read from the HTTP request.
Definition: MWHttpRequest.php:331
MWHttpRequest\setHeader
setHeader( $name, $value)
Set an arbitrary header.
Definition: MWHttpRequest.php:286
PROTO_HTTP
const PROTO_HTTP
Definition: Defines.php:229
MWHttpRequest\getHeaderList
getHeaderList()
Get an array of the headers.
Definition: MWHttpRequest.php:295
MWHttpRequest\$parsedUrl
$parsedUrl
Definition: MWHttpRequest.php:51
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1255
MWHttpRequest\$profileName
string $profileName
Definition: MWHttpRequest.php:79
MWHttpRequest\getResponseHeaders
getResponseHeaders()
Returns an associative array of response headers after the request has been executed.
Definition: MWHttpRequest.php:467
wfIniGetBool
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
Definition: GlobalFunctions.php:2172
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:38
MWHttpRequest\$sslVerifyHost
$sslVerifyHost
Definition: MWHttpRequest.php:45
MWHttpRequest\__construct
__construct( $url, array $options=[], $caller=__METHOD__, $profiler=null)
Definition: MWHttpRequest.php:92
$args
if( $line===false) $args
Definition: cdb.php:64
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
$code
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:865
CookieJar
Cookie jar to use with MWHttpRequest.
Definition: CookieJar.php:25
MWHttpRequest\$caInfo
$caInfo
Definition: MWHttpRequest.php:47
MWHttpRequest\canMakeRequests
static canMakeRequests()
Simple function to test if we can make any sort of requests at all, using cURL or fopen()
Definition: MWHttpRequest.php:170
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
MWHttpRequest\getResponseHeader
getResponseHeader( $header)
Returns the value of the given response header.
Definition: MWHttpRequest.php:481
MWHttpRequest\setUserAgent
setUserAgent( $UA)
Set the user agent.
Definition: MWHttpRequest.php:277
MWHttpRequest\execute
execute()
Take care of whatever is necessary to perform the URI request.
Definition: MWHttpRequest.php:360
Http\isValidURI
static isValidURI( $uri)
Checks that the given URI is a valid one.
Definition: Http.php:146
MWHttpRequest\canFollowRedirects
canFollowRedirects()
Returns true if the backend can follow redirects.
Definition: MWHttpRequest.php:613
MWHttpRequest\$proxy
$proxy
Definition: MWHttpRequest.php:43
MWHttpRequest\setLogger
setLogger(LoggerInterface $logger)
Definition: MWHttpRequest.php:161
MWHttpRequest\getFinalUrl
getFinalUrl()
Returns the final URL after all redirections.
Definition: MWHttpRequest.php:571
MWHttpRequest\setOriginalRequest
setOriginalRequest( $originalRequest)
Set information about the original request.
Definition: MWHttpRequest.php:629
MWHttpRequest\$url
$url
Definition: MWHttpRequest.php:50
MWHttpRequest\factory
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object Deprecated:
Definition: MWHttpRequest.php:184
wfExpandUrl
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
Definition: GlobalFunctions.php:521
MWHttpRequest\prepare
prepare()
Definition: MWHttpRequest.php:364