MediaWiki  1.30.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  } elseif ( version_compare( PHP_VERSION, '5.6.0', '<' ) ) {
50  // @codingStandardsIgnoreStart Generic.Files.LineLength
51  // Default locations, based on
52  // https://www.happyassassin.net/2015/01/12/a-note-about-ssltls-trusted-certificate-stores-and-platforms/
53  // PHP 5.5 and older doesn't have any defaults, so we try to guess ourselves.
54  // PHP 5.6+ gets the CA location from OpenSSL as long as it is not set manually,
55  // so we should leave capath/cafile empty there.
56  // @codingStandardsIgnoreEnd
57  $certLocations = array_filter( [
58  getenv( 'SSL_CERT_DIR' ),
59  getenv( 'SSL_CERT_PATH' ),
60  '/etc/pki/tls/certs/ca-bundle.crt', # Fedora et al
61  '/etc/ssl/certs', # Debian et al
62  '/etc/pki/tls/certs/ca-bundle.trust.crt',
63  '/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem',
64  '/System/Library/OpenSSL', # OSX
65  ] );
66  }
67 
68  foreach ( $certLocations as $key => $cert ) {
69  if ( is_dir( $cert ) ) {
70  $certOptions['capath'] = $cert;
71  break;
72  } elseif ( is_file( $cert ) ) {
73  $certOptions['cafile'] = $cert;
74  break;
75  } elseif ( $key === 'manual' ) {
76  // fail more loudly if a cert path was manually configured and it is not valid
77  throw new DomainException( "Invalid CA info passed: $cert" );
78  }
79  }
80 
81  return $certOptions;
82  }
83 
94  public function errorHandler( $errno, $errstr ) {
95  $n = count( $this->fopenErrors ) + 1;
96  $this->fopenErrors += [ "errno$n" => $errno, "errstr$n" => $errstr ];
97  }
98 
104  public function execute() {
105  $this->prepare();
106 
107  if ( is_array( $this->postData ) ) {
108  $this->postData = wfArrayToCgi( $this->postData );
109  }
110 
111  if ( $this->parsedUrl['scheme'] != 'http'
112  && $this->parsedUrl['scheme'] != 'https' ) {
113  $this->status->fatal( 'http-invalid-scheme', $this->parsedUrl['scheme'] );
114  }
115 
116  $this->reqHeaders['Accept'] = "*/*";
117  $this->reqHeaders['Connection'] = 'Close';
118  if ( $this->method == 'POST' ) {
119  // Required for HTTP 1.0 POSTs
120  $this->reqHeaders['Content-Length'] = strlen( $this->postData );
121  if ( !isset( $this->reqHeaders['Content-Type'] ) ) {
122  $this->reqHeaders['Content-Type'] = "application/x-www-form-urlencoded";
123  }
124  }
125 
126  // Set up PHP stream context
127  $options = [
128  'http' => [
129  'method' => $this->method,
130  'header' => implode( "\r\n", $this->getHeaderList() ),
131  'protocol_version' => '1.1',
132  'max_redirects' => $this->followRedirects ? $this->maxRedirects : 0,
133  'ignore_errors' => true,
134  'timeout' => $this->timeout,
135  // Curl options in case curlwrappers are installed
136  'curl_verify_ssl_host' => $this->sslVerifyHost ? 2 : 0,
137  'curl_verify_ssl_peer' => $this->sslVerifyCert,
138  ],
139  'ssl' => [
140  'verify_peer' => $this->sslVerifyCert,
141  'SNI_enabled' => true,
142  'ciphers' => 'HIGH:!SSLv2:!SSLv3:-ADH:-kDH:-kECDH:-DSS',
143  'disable_compression' => true,
144  ],
145  ];
146 
147  if ( $this->proxy ) {
148  $options['http']['proxy'] = $this->urlToTcp( $this->proxy );
149  $options['http']['request_fulluri'] = true;
150  }
151 
152  if ( $this->postData ) {
153  $options['http']['content'] = $this->postData;
154  }
155 
156  if ( $this->sslVerifyHost ) {
157  // PHP 5.6.0 deprecates CN_match, in favour of peer_name which
158  // actually checks SubjectAltName properly.
159  if ( version_compare( PHP_VERSION, '5.6.0', '>=' ) ) {
160  $options['ssl']['peer_name'] = $this->parsedUrl['host'];
161  } else {
162  $options['ssl']['CN_match'] = $this->parsedUrl['host'];
163  }
164  }
165 
166  $options['ssl'] += $this->getCertOptions();
167 
168  $context = stream_context_create( $options );
169 
170  $this->headerList = [];
171  $reqCount = 0;
172  $url = $this->url;
173 
174  $result = [];
175 
176  if ( $this->profiler ) {
177  $profileSection = $this->profiler->scopedProfileIn(
178  __METHOD__ . '-' . $this->profileName
179  );
180  }
181  do {
182  $reqCount++;
183  $this->fopenErrors = [];
184  set_error_handler( [ $this, 'errorHandler' ] );
185  $fh = fopen( $url, "r", false, $context );
186  restore_error_handler();
187 
188  if ( !$fh ) {
189  // HACK for instant commons.
190  // If we are contacting (commons|upload).wikimedia.org
191  // try again with CN_match for en.wikipedia.org
192  // as php does not handle SubjectAltName properly
193  // prior to "peer_name" option in php 5.6
194  if ( isset( $options['ssl']['CN_match'] )
195  && ( $options['ssl']['CN_match'] === 'commons.wikimedia.org'
196  || $options['ssl']['CN_match'] === 'upload.wikimedia.org' )
197  ) {
198  $options['ssl']['CN_match'] = 'en.wikipedia.org';
199  $context = stream_context_create( $options );
200  continue;
201  }
202  break;
203  }
204 
205  $result = stream_get_meta_data( $fh );
206  $this->headerList = $result['wrapper_data'];
207  $this->parseHeader();
208 
209  if ( !$this->followRedirects ) {
210  break;
211  }
212 
213  # Handle manual redirection
214  if ( !$this->isRedirect() || $reqCount > $this->maxRedirects ) {
215  break;
216  }
217  # Check security of URL
218  $url = $this->getResponseHeader( "Location" );
219 
220  if ( !Http::isValidURI( $url ) ) {
221  $this->logger->debug( __METHOD__ . ": insecure redirection\n" );
222  break;
223  }
224  } while ( true );
225  if ( $this->profiler ) {
226  $this->profiler->scopedProfileOut( $profileSection );
227  }
228 
229  $this->setStatus();
230 
231  if ( $fh === false ) {
232  if ( $this->fopenErrors ) {
233  $this->logger->warning( __CLASS__
234  . ': error opening connection: {errstr1}', $this->fopenErrors );
235  }
236  $this->status->fatal( 'http-request-error' );
237  return Status::wrap( $this->status ); // TODO B/C; move this to callers
238  }
239 
240  if ( $result['timed_out'] ) {
241  $this->status->fatal( 'http-timed-out', $this->url );
242  return Status::wrap( $this->status ); // TODO B/C; move this to callers
243  }
244 
245  // If everything went OK, or we received some error code
246  // get the response body content.
247  if ( $this->status->isOK() || (int)$this->respStatus >= 300 ) {
248  while ( !feof( $fh ) ) {
249  $buf = fread( $fh, 8192 );
250 
251  if ( $buf === false ) {
252  $this->status->fatal( 'http-read-error' );
253  break;
254  }
255 
256  if ( strlen( $buf ) ) {
257  call_user_func( $this->callback, $fh, $buf );
258  }
259  }
260  }
261  fclose( $fh );
262 
263  return Status::wrap( $this->status ); // TODO B/C; move this to callers
264  }
265 }
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:438
$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:2581
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 '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. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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! 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:1963
MWHttpRequest\$sslVerifyCert
$sslVerifyCert
Definition: MWHttpRequest.php:47
Debian
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy like it should help lighten the load on the database servers by caching data and objects in Debian
Definition: memcached.txt:10
PhpHttpRequest\errorHandler
errorHandler( $errno, $errstr)
Custom error handler for dealing with fopen() errors.
Definition: PhpHttpRequest.php:94
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:411
MWHttpRequest\$postData
$postData
Definition: MWHttpRequest.php:43
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:469
MWHttpRequest\$timeout
int string $timeout
Definition: MWHttpRequest.php:39
PhpHttpRequest\execute
execute()
Definition: PhpHttpRequest.php:104
MWHttpRequest\$method
$method
Definition: MWHttpRequest.php:49
MWHttpRequest
This wrapper class will call out to curl (if available) or fallback to regular PHP if necessary for h...
Definition: MWHttpRequest.php:33
MWHttpRequest\getHeaderList
getHeaderList()
Get an array of the headers.
Definition: MWHttpRequest.php:319
MWHttpRequest\$parsedUrl
$parsedUrl
Definition: MWHttpRequest.php:52
$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:1965
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:48
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:505
Http\isValidURI
static isValidURI( $uri)
Checks that the given URI is a valid one.
Definition: Http.php:146
PhpHttpRequest
Definition: PhpHttpRequest.php:21
MWHttpRequest\$url
$url
Definition: MWHttpRequest.php:51
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:442
MWHttpRequest\prepare
prepare()
Definition: MWHttpRequest.php:388