MediaWiki  1.33.0
PhpHttpRequest.php
Go to the documentation of this file.
1 <?php
22 
23  private $fopenErrors = [];
24 
29  protected function urlToTcp( $url ) {
30  $parsedUrl = parse_url( $url );
31 
32  return 'tcp://' . $parsedUrl['host'] . ':' . $parsedUrl['port'];
33  }
34 
44  protected function getCertOptions() {
45  $certOptions = [];
46  $certLocations = [];
47  if ( $this->caInfo ) {
48  $certLocations = [ 'manual' => $this->caInfo ];
49  }
50 
51  foreach ( $certLocations as $key => $cert ) {
52  if ( is_dir( $cert ) ) {
53  $certOptions['capath'] = $cert;
54  break;
55  } elseif ( is_file( $cert ) ) {
56  $certOptions['cafile'] = $cert;
57  break;
58  } elseif ( $key === 'manual' ) {
59  // fail more loudly if a cert path was manually configured and it is not valid
60  throw new DomainException( "Invalid CA info passed: $cert" );
61  }
62  }
63 
64  return $certOptions;
65  }
66 
77  public function errorHandler( $errno, $errstr ) {
78  $n = count( $this->fopenErrors ) + 1;
79  $this->fopenErrors += [ "errno$n" => $errno, "errstr$n" => $errstr ];
80  }
81 
87  public function execute() {
88  $this->prepare();
89 
90  if ( is_array( $this->postData ) ) {
91  $this->postData = wfArrayToCgi( $this->postData );
92  }
93 
94  if ( $this->parsedUrl['scheme'] != 'http'
95  && $this->parsedUrl['scheme'] != 'https' ) {
96  $this->status->fatal( 'http-invalid-scheme', $this->parsedUrl['scheme'] );
97  }
98 
99  $this->reqHeaders['Accept'] = "*/*";
100  $this->reqHeaders['Connection'] = 'Close';
101  if ( $this->method == 'POST' ) {
102  // Required for HTTP 1.0 POSTs
103  $this->reqHeaders['Content-Length'] = strlen( $this->postData );
104  if ( !isset( $this->reqHeaders['Content-Type'] ) ) {
105  $this->reqHeaders['Content-Type'] = "application/x-www-form-urlencoded";
106  }
107  }
108 
109  // Set up PHP stream context
110  $options = [
111  'http' => [
112  'method' => $this->method,
113  'header' => implode( "\r\n", $this->getHeaderList() ),
114  'protocol_version' => '1.1',
115  'max_redirects' => $this->followRedirects ? $this->maxRedirects : 0,
116  'ignore_errors' => true,
117  'timeout' => $this->timeout,
118  // Curl options in case curlwrappers are installed
119  'curl_verify_ssl_host' => $this->sslVerifyHost ? 2 : 0,
120  'curl_verify_ssl_peer' => $this->sslVerifyCert,
121  ],
122  'ssl' => [
123  'verify_peer' => $this->sslVerifyCert,
124  'SNI_enabled' => true,
125  'ciphers' => 'HIGH:!SSLv2:!SSLv3:-ADH:-kDH:-kECDH:-DSS',
126  'disable_compression' => true,
127  ],
128  ];
129 
130  if ( $this->proxy ) {
131  $options['http']['proxy'] = $this->urlToTcp( $this->proxy );
132  $options['http']['request_fulluri'] = true;
133  }
134 
135  if ( $this->postData ) {
136  $options['http']['content'] = $this->postData;
137  }
138 
139  if ( $this->sslVerifyHost ) {
140  $options['ssl']['peer_name'] = $this->parsedUrl['host'];
141  }
142 
143  $options['ssl'] += $this->getCertOptions();
144 
145  $context = stream_context_create( $options );
146 
147  $this->headerList = [];
148  $reqCount = 0;
149  $url = $this->url;
150 
151  $result = [];
152 
153  if ( $this->profiler ) {
154  $profileSection = $this->profiler->scopedProfileIn(
155  __METHOD__ . '-' . $this->profileName
156  );
157  }
158  do {
159  $reqCount++;
160  $this->fopenErrors = [];
161  set_error_handler( [ $this, 'errorHandler' ] );
162  $fh = fopen( $url, "r", false, $context );
163  restore_error_handler();
164 
165  if ( !$fh ) {
166  break;
167  }
168 
169  $result = stream_get_meta_data( $fh );
170  $this->headerList = $result['wrapper_data'];
171  $this->parseHeader();
172 
173  if ( !$this->followRedirects ) {
174  break;
175  }
176 
177  # Handle manual redirection
178  if ( !$this->isRedirect() || $reqCount > $this->maxRedirects ) {
179  break;
180  }
181  # Check security of URL
182  $url = $this->getResponseHeader( "Location" );
183 
184  if ( !Http::isValidURI( $url ) ) {
185  $this->logger->debug( __METHOD__ . ": insecure redirection\n" );
186  break;
187  }
188  } while ( true );
189  if ( $this->profiler ) {
190  $this->profiler->scopedProfileOut( $profileSection );
191  }
192 
193  $this->setStatus();
194 
195  if ( $fh === false ) {
196  if ( $this->fopenErrors ) {
197  $this->logger->warning( __CLASS__
198  . ': error opening connection: {errstr1}', $this->fopenErrors );
199  }
200  $this->status->fatal( 'http-request-error' );
201  return Status::wrap( $this->status ); // TODO B/C; move this to callers
202  }
203 
204  if ( $result['timed_out'] ) {
205  $this->status->fatal( 'http-timed-out', $this->url );
206  return Status::wrap( $this->status ); // TODO B/C; move this to callers
207  }
208 
209  // If everything went OK, or we received some error code
210  // get the response body content.
211  if ( $this->status->isOK() || (int)$this->respStatus >= 300 ) {
212  while ( !feof( $fh ) ) {
213  $buf = fread( $fh, 8192 );
214 
215  if ( $buf === false ) {
216  $this->status->fatal( 'http-read-error' );
217  break;
218  }
219 
220  if ( $buf !== '' ) {
221  call_user_func( $this->callback, $fh, $buf );
222  }
223  }
224  }
225  fclose( $fh );
226 
227  return Status::wrap( $this->status ); // TODO B/C; move this to callers
228  }
229 }
PhpHttpRequest\$fopenErrors
$fopenErrors
Definition: PhpHttpRequest.php:23
MWHttpRequest\setStatus
setStatus()
Sets HTTPRequest status member to a fatal value with the error message if the returned integer value ...
Definition: MWHttpRequest.php:429
$context
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:2636
captcha-old.count
count
Definition: captcha-old.py:249
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1983
MWHttpRequest\$sslVerifyCert
$sslVerifyCert
Definition: MWHttpRequest.php:46
PhpHttpRequest\errorHandler
errorHandler( $errno, $errstr)
Custom error handler for dealing with fopen() errors.
Definition: PhpHttpRequest.php:77
PhpHttpRequest\urlToTcp
urlToTcp( $url)
Definition: PhpHttpRequest.php:29
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:35
MWHttpRequest\parseHeader
parseHeader()
Parses the headers, including the HTTP status code and any Set-Cookie headers.
Definition: MWHttpRequest.php:398
MWHttpRequest\$postData
$postData
Definition: MWHttpRequest.php:42
Status\wrap
static wrap( $sv)
Succinct helper method to wrap a StatusValue.
Definition: Status.php:55
MWHttpRequest\isRedirect
isRedirect()
Returns true if the last status code was a redirect.
Definition: MWHttpRequest.php:463
MWHttpRequest\$timeout
int string $timeout
Definition: MWHttpRequest.php:38
PhpHttpRequest\execute
execute()
Definition: PhpHttpRequest.php:87
MWHttpRequest\$method
$method
Definition: MWHttpRequest.php:48
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\getHeaderList
getHeaderList()
Get an array of the headers.
Definition: MWHttpRequest.php:294
MWHttpRequest\$parsedUrl
$parsedUrl
Definition: MWHttpRequest.php:51
$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:1985
PhpHttpRequest\getCertOptions
getCertOptions()
Returns an array with a 'capath' or 'cafile' key that is suitable to be merged into the 'ssl' sub-arr...
Definition: PhpHttpRequest.php:44
MWHttpRequest\$caInfo
$caInfo
Definition: MWHttpRequest.php:47
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:9
MWHttpRequest\getResponseHeader
getResponseHeader( $header)
Returns the value of the given response header.
Definition: MWHttpRequest.php:500
Http\isValidURI
static isValidURI( $uri)
Check that the given URI is a valid one.
Definition: Http.php:149
PhpHttpRequest
Definition: PhpHttpRequest.php:21
MWHttpRequest\$url
$url
Definition: MWHttpRequest.php:50
wfArrayToCgi
wfArrayToCgi( $array1, $array2=null, $prefix='')
This function takes one or two arrays as input, and returns a CGI-style string, e....
Definition: GlobalFunctions.php:371
MWHttpRequest\prepare
prepare()
Definition: MWHttpRequest.php:375