MediaWiki  master
MWHttpRequest.php
Go to the documentation of this file.
1 <?php
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 
93  public function __construct(
94  $url, array $options = [], $caller = __METHOD__, Profiler $profiler = null
95  ) {
97 
98  $this->url = wfExpandUrl( $url, PROTO_HTTP );
99  $this->parsedUrl = wfParseUrl( $this->url );
100 
101  $this->logger = $options['logger'] ?? new NullLogger();
102 
103  if ( !$this->parsedUrl || !Http::isValidURI( $this->url ) ) {
104  $this->status = StatusValue::newFatal( 'http-invalid-url', $url );
105  } else {
106  $this->status = StatusValue::newGood( 100 ); // continue
107  }
108 
109  if ( isset( $options['timeout'] ) && $options['timeout'] != 'default' ) {
110  $this->timeout = $options['timeout'];
111  } else {
112  $this->timeout = $wgHTTPTimeout;
113  }
114  if ( isset( $options['connectTimeout'] ) && $options['connectTimeout'] != 'default' ) {
115  $this->connectTimeout = $options['connectTimeout'];
116  } else {
117  $this->connectTimeout = $wgHTTPConnectTimeout;
118  }
119  if ( isset( $options['userAgent'] ) ) {
120  $this->setUserAgent( $options['userAgent'] );
121  }
122  if ( isset( $options['username'] ) && isset( $options['password'] ) ) {
123  $this->setHeader(
124  'Authorization',
125  'Basic ' . base64_encode( $options['username'] . ':' . $options['password'] )
126  );
127  }
128  if ( isset( $options['originalRequest'] ) ) {
129  $this->setOriginalRequest( $options['originalRequest'] );
130  }
131 
132  $this->setHeader( 'X-Request-Id', WebRequest::getRequestId() );
133 
134  $members = [ "postData", "proxy", "noProxy", "sslVerifyHost", "caInfo",
135  "method", "followRedirects", "maxRedirects", "sslVerifyCert", "callback" ];
136 
137  foreach ( $members as $o ) {
138  if ( isset( $options[$o] ) ) {
139  // ensure that MWHttpRequest::method is always
140  // uppercased. T38137
141  if ( $o == 'method' ) {
142  $options[$o] = strtoupper( $options[$o] );
143  }
144  $this->$o = $options[$o];
145  }
146  }
147 
148  if ( $this->noProxy ) {
149  $this->proxy = ''; // noProxy takes precedence
150  }
151 
152  // Profile based on what's calling us
153  $this->profiler = $profiler;
154  $this->profileName = $caller;
155  }
156 
160  public function setLogger( LoggerInterface $logger ) {
161  $this->logger = $logger;
162  }
163 
169  public static function canMakeRequests() {
170  return function_exists( 'curl_init' ) || wfIniGetBool( 'allow_url_fopen' );
171  }
172 
183  public static function factory( $url, array $options = null, $caller = __METHOD__ ) {
184  if ( $options === null ) {
185  $options = [];
186  }
187  return \MediaWiki\MediaWikiServices::getInstance()
188  ->getHttpRequestFactory()
189  ->create( $url, $options, $caller );
190  }
191 
197  public function getContent() {
198  return $this->content;
199  }
200 
207  public function setData( array $args ) {
208  $this->postData = $args;
209  }
210 
216  protected function proxySetup() {
217  // If there is an explicit proxy set and proxies are not disabled, then use it
218  if ( $this->proxy && !$this->noProxy ) {
219  return;
220  }
221 
222  // Otherwise, fallback to $wgHTTPProxy if this is not a machine
223  // local URL and proxies are not disabled
224  if ( self::isLocalURL( $this->url ) || $this->noProxy ) {
225  $this->proxy = '';
226  } else {
227  global $wgHTTPProxy;
228  $this->proxy = (string)$wgHTTPProxy;
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  return $this->doSetCallback( $callback );
333  }
334 
342  protected function doSetCallback( $callback ) {
343  if ( is_null( $callback ) ) {
344  $callback = [ $this, 'read' ];
345  } elseif ( !is_callable( $callback ) ) {
346  $this->status->fatal( 'http-internal-error' );
347  throw new InvalidArgumentException( __METHOD__ . ': invalid callback' );
348  }
349  $this->callback = $callback;
350  }
351 
361  public function read( $fh, $content ) {
362  $this->content .= $content;
363  return strlen( $content );
364  }
365 
372  public function execute() {
373  throw new LogicException( 'children must override this' );
374  }
375 
376  protected function prepare() {
377  $this->content = "";
378 
379  if ( strtoupper( $this->method ) == "HEAD" ) {
380  $this->headersOnly = true;
381  }
382 
383  $this->proxySetup(); // set up any proxy as needed
384 
385  if ( !$this->callback ) {
386  $this->doSetCallback( null );
387  }
388 
389  if ( !isset( $this->reqHeaders['User-Agent'] ) ) {
390  $this->setUserAgent( Http::userAgent() );
391  }
392  }
393 
399  protected function parseHeader() {
400  $lastname = "";
401 
402  // Failure without (valid) headers gets a response status of zero
403  if ( !$this->status->isOK() ) {
404  $this->respStatus = '0 Error';
405  }
406 
407  foreach ( $this->headerList as $header ) {
408  if ( preg_match( "#^HTTP/([0-9.]+) (.*)#", $header, $match ) ) {
409  $this->respVersion = $match[1];
410  $this->respStatus = $match[2];
411  } elseif ( preg_match( "#^[ \t]#", $header ) ) {
412  $last = count( $this->respHeaders[$lastname] ) - 1;
413  $this->respHeaders[$lastname][$last] .= "\r\n$header";
414  } elseif ( preg_match( "#^([^:]*):[\t ]*(.*)#", $header, $match ) ) {
415  $this->respHeaders[strtolower( $match[1] )][] = $match[2];
416  $lastname = strtolower( $match[1] );
417  }
418  }
419 
420  $this->parseCookies();
421  }
422 
430  protected function setStatus() {
431  if ( !$this->respHeaders ) {
432  $this->parseHeader();
433  }
434 
435  if ( ( (int)$this->respStatus > 0 && (int)$this->respStatus < 400 ) ) {
436  $this->status->setResult( true, (int)$this->respStatus );
437  } else {
438  list( $code, $message ) = explode( " ", $this->respStatus, 2 );
439  $this->status->setResult( false, (int)$this->respStatus );
440  $this->status->fatal( "http-bad-status", $code, $message );
441  }
442  }
443 
451  public function getStatus() {
452  if ( !$this->respHeaders ) {
453  $this->parseHeader();
454  }
455 
456  return (int)$this->respStatus;
457  }
458 
464  public function isRedirect() {
465  if ( !$this->respHeaders ) {
466  $this->parseHeader();
467  }
468 
469  $status = (int)$this->respStatus;
470 
471  if ( $status >= 300 && $status <= 303 ) {
472  return true;
473  }
474 
475  return false;
476  }
477 
487  public function getResponseHeaders() {
488  if ( !$this->respHeaders ) {
489  $this->parseHeader();
490  }
491 
492  return $this->respHeaders;
493  }
494 
501  public function getResponseHeader( $header ) {
502  if ( !$this->respHeaders ) {
503  $this->parseHeader();
504  }
505 
506  if ( isset( $this->respHeaders[strtolower( $header )] ) ) {
507  $v = $this->respHeaders[strtolower( $header )];
508  return $v[count( $v ) - 1];
509  }
510 
511  return null;
512  }
513 
521  public function setCookieJar( CookieJar $jar ) {
522  $this->cookieJar = $jar;
523  }
524 
530  public function getCookieJar() {
531  if ( !$this->respHeaders ) {
532  $this->parseHeader();
533  }
534 
535  return $this->cookieJar;
536  }
537 
547  public function setCookie( $name, $value, array $attr = [] ) {
548  if ( !$this->cookieJar ) {
549  $this->cookieJar = new CookieJar;
550  }
551 
552  if ( $this->parsedUrl && !isset( $attr['domain'] ) ) {
553  $attr['domain'] = $this->parsedUrl['host'];
554  }
555 
556  $this->cookieJar->setCookie( $name, $value, $attr );
557  }
558 
562  protected function parseCookies() {
563  if ( !$this->cookieJar ) {
564  $this->cookieJar = new CookieJar;
565  }
566 
567  if ( isset( $this->respHeaders['set-cookie'] ) ) {
568  $url = parse_url( $this->getFinalUrl() );
569  foreach ( $this->respHeaders['set-cookie'] as $cookie ) {
570  $this->cookieJar->parseCookieResponseHeader( $cookie, $url['host'] );
571  }
572  }
573  }
574 
591  public function getFinalUrl() {
592  $headers = $this->getResponseHeaders();
593 
594  // return full url (fix for incorrect but handled relative location)
595  if ( isset( $headers['location'] ) ) {
596  $locations = $headers['location'];
597  $domain = '';
598  $foundRelativeURI = false;
599  $countLocations = count( $locations );
600 
601  for ( $i = $countLocations - 1; $i >= 0; $i-- ) {
602  $url = parse_url( $locations[$i] );
603 
604  if ( isset( $url['host'] ) ) {
605  $domain = $url['scheme'] . '://' . $url['host'];
606  break; // found correct URI (with host)
607  } else {
608  $foundRelativeURI = true;
609  }
610  }
611 
612  if ( !$foundRelativeURI ) {
613  return $locations[$countLocations - 1];
614  }
615  if ( $domain ) {
616  return $domain . $locations[$countLocations - 1];
617  }
618  $url = parse_url( $this->url );
619  if ( isset( $url['host'] ) ) {
620  return $url['scheme'] . '://' . $url['host'] .
621  $locations[$countLocations - 1];
622  }
623  }
624 
625  return $this->url;
626  }
627 
633  public function canFollowRedirects() {
634  return true;
635  }
636 
649  public function setOriginalRequest( $originalRequest ) {
650  if ( $originalRequest instanceof WebRequest ) {
651  $originalRequest = [
652  'ip' => $originalRequest->getIP(),
653  'userAgent' => $originalRequest->getHeader( 'User-Agent' ),
654  ];
655  } elseif (
656  !is_array( $originalRequest )
657  || array_diff( [ 'ip', 'userAgent' ], array_keys( $originalRequest ) )
658  ) {
659  throw new InvalidArgumentException( __METHOD__ . ': $originalRequest must be a '
660  . "WebRequest or an array with 'ip' and 'userAgent' keys" );
661  }
662 
663  $this->reqHeaders['X-Forwarded-For'] = $originalRequest['ip'];
664  $this->reqHeaders['X-Original-User-Agent'] = $originalRequest['userAgent'];
665  }
666 
683  public static function isValidURI( $uri ) {
684  return (bool)preg_match(
685  '/^https?:\/\/[^\/\s]\S*$/D',
686  $uri
687  );
688  }
689 }
CookieJar $cookieJar
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
static factory( $url, array $options=null, $caller=__METHOD__)
Generate a new request object.
read( $fh, $content)
A generic callback to read the body of the response from a remote server.
proxySetup()
Take care of setting up the proxy (do nothing if "noProxy" is set)
static getRequestId()
Get the unique request ID.
Definition: WebRequest.php:275
static isValidURI( $uri)
Check that the given URI is a valid one.
execute()
Take care of whatever is necessary to perform the URI request.
per default it will return the text for text based content
setUserAgent( $UA)
Set the user agent.
canFollowRedirects()
Returns true if the backend can follow redirects.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
LoggerInterface $logger
callable $callback
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
__construct( $url, array $options=[], $caller=__METHOD__, Profiler $profiler=null)
isRedirect()
Returns true if the last status code was a redirect.
int $wgHTTPTimeout
Timeout for HTTP requests done internally, in seconds.
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition: hooks.txt:175
$value
static canMakeRequests()
Simple function to test if we can make any sort of requests at all, using cURL or fopen() ...
$wgHTTPProxy
Proxy to use for CURL requests.
static userAgent()
A standard user-agent we can use for external requests.
Definition: Http.php:98
parseCookies()
Parse the cookies in the response headers and store them in the cookie jar.
if( $line===false) $args
Definition: cdb.php:64
setData(array $args)
Set the parameters of the request.
$last
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
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. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header '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 '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:1263
getCookieJar()
Returns the cookie jar in use.
static isLocalURL( $url)
Check if the URL can be served by localhost.
getHeaderList()
Get an array of the headers.
getFinalUrl()
Returns the final URL after all redirections.
Profiler $profiler
setLogger(LoggerInterface $logger)
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
const SUPPORTS_FILE_POSTS
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
StatusValue $status
getResponseHeader( $header)
Returns the value of the given response header.
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
setStatus()
Sets HTTPRequest status member to a fatal value with the error message if the returned integer value ...
$header
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 modifiable & $code
Definition: hooks.txt:780
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:9
getResponseHeaders()
Returns an associative array of response headers after the request has been executed.
const PROTO_HTTP
Definition: Defines.php:215
getStatus()
Get the integer value of the HTTP status code (e.g.
string $profileName
setCookieJar(CookieJar $jar)
Tells the MWHttpRequest object to use this pre-loaded CookieJar.
$wgLocalVirtualHosts
Local virtual hosts.
parseHeader()
Parses the headers, including the HTTP status code and any Set-Cookie headers.
setCookie( $name, $value, array $attr=[])
Sets a cookie.
static isValidURI( $uri)
Check that the given URI is a valid one.
Definition: Http.php:118
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
$wgHTTPConnectTimeout
Timeout for connections done internally (in seconds) Only works for curl.
int string $timeout
setHeader( $name, $value)
Set an arbitrary header.
global $wgCommandLineMode
doSetCallback( $callback)
Worker function for setting callbacks.
setCookie( $name, $value, $attr)
Set a cookie in the cookie jar.
Definition: CookieJar.php:36
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
Cookie jar to use with MWHttpRequest.
Definition: CookieJar.php:25
getContent()
Get the body, or content, of the response to the request.
setOriginalRequest( $originalRequest)
Set information about the original request.
wfIniGetBool( $setting)
Safety wrapper around ini_get() for boolean settings.
setCallback( $callback)
Set a read callback to accept data read from the HTTP request.
$matches