MediaWiki  1.29.2
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 
92  public function errorHandler( $errno, $errstr ) {
93  $n = count( $this->fopenErrors ) + 1;
94  $this->fopenErrors += [ "errno$n" => $errno, "errstr$n" => $errstr ];
95  }
96 
102  public function execute() {
103  $this->prepare();
104 
105  if ( is_array( $this->postData ) ) {
106  $this->postData = wfArrayToCgi( $this->postData );
107  }
108 
109  if ( $this->parsedUrl['scheme'] != 'http'
110  && $this->parsedUrl['scheme'] != 'https' ) {
111  $this->status->fatal( 'http-invalid-scheme', $this->parsedUrl['scheme'] );
112  }
113 
114  $this->reqHeaders['Accept'] = "*/*";
115  $this->reqHeaders['Connection'] = 'Close';
116  if ( $this->method == 'POST' ) {
117  // Required for HTTP 1.0 POSTs
118  $this->reqHeaders['Content-Length'] = strlen( $this->postData );
119  if ( !isset( $this->reqHeaders['Content-Type'] ) ) {
120  $this->reqHeaders['Content-Type'] = "application/x-www-form-urlencoded";
121  }
122  }
123 
124  // Set up PHP stream context
125  $options = [
126  'http' => [
127  'method' => $this->method,
128  'header' => implode( "\r\n", $this->getHeaderList() ),
129  'protocol_version' => '1.1',
130  'max_redirects' => $this->followRedirects ? $this->maxRedirects : 0,
131  'ignore_errors' => true,
132  'timeout' => $this->timeout,
133  // Curl options in case curlwrappers are installed
134  'curl_verify_ssl_host' => $this->sslVerifyHost ? 2 : 0,
135  'curl_verify_ssl_peer' => $this->sslVerifyCert,
136  ],
137  'ssl' => [
138  'verify_peer' => $this->sslVerifyCert,
139  'SNI_enabled' => true,
140  'ciphers' => 'HIGH:!SSLv2:!SSLv3:-ADH:-kDH:-kECDH:-DSS',
141  'disable_compression' => true,
142  ],
143  ];
144 
145  if ( $this->proxy ) {
146  $options['http']['proxy'] = $this->urlToTcp( $this->proxy );
147  $options['http']['request_fulluri'] = true;
148  }
149 
150  if ( $this->postData ) {
151  $options['http']['content'] = $this->postData;
152  }
153 
154  if ( $this->sslVerifyHost ) {
155  // PHP 5.6.0 deprecates CN_match, in favour of peer_name which
156  // actually checks SubjectAltName properly.
157  if ( version_compare( PHP_VERSION, '5.6.0', '>=' ) ) {
158  $options['ssl']['peer_name'] = $this->parsedUrl['host'];
159  } else {
160  $options['ssl']['CN_match'] = $this->parsedUrl['host'];
161  }
162  }
163 
164  $options['ssl'] += $this->getCertOptions();
165 
166  $context = stream_context_create( $options );
167 
168  $this->headerList = [];
169  $reqCount = 0;
170  $url = $this->url;
171 
172  $result = [];
173 
174  if ( $this->profiler ) {
175  $profileSection = $this->profiler->scopedProfileIn(
176  __METHOD__ . '-' . $this->profileName
177  );
178  }
179  do {
180  $reqCount++;
181  $this->fopenErrors = [];
182  set_error_handler( [ $this, 'errorHandler' ] );
183  $fh = fopen( $url, "r", false, $context );
184  restore_error_handler();
185 
186  if ( !$fh ) {
187  // HACK for instant commons.
188  // If we are contacting (commons|upload).wikimedia.org
189  // try again with CN_match for en.wikipedia.org
190  // as php does not handle SubjectAltName properly
191  // prior to "peer_name" option in php 5.6
192  if ( isset( $options['ssl']['CN_match'] )
193  && ( $options['ssl']['CN_match'] === 'commons.wikimedia.org'
194  || $options['ssl']['CN_match'] === 'upload.wikimedia.org' )
195  ) {
196  $options['ssl']['CN_match'] = 'en.wikipedia.org';
197  $context = stream_context_create( $options );
198  continue;
199  }
200  break;
201  }
202 
203  $result = stream_get_meta_data( $fh );
204  $this->headerList = $result['wrapper_data'];
205  $this->parseHeader();
206 
207  if ( !$this->followRedirects ) {
208  break;
209  }
210 
211  # Handle manual redirection
212  if ( !$this->isRedirect() || $reqCount > $this->maxRedirects ) {
213  break;
214  }
215  # Check security of URL
216  $url = $this->getResponseHeader( "Location" );
217 
218  if ( !Http::isValidURI( $url ) ) {
219  $this->logger->debug( __METHOD__ . ": insecure redirection\n" );
220  break;
221  }
222  } while ( true );
223  if ( $this->profiler ) {
224  $this->profiler->scopedProfileOut( $profileSection );
225  }
226 
227  $this->setStatus();
228 
229  if ( $fh === false ) {
230  if ( $this->fopenErrors ) {
231  $this->logger->warning( __CLASS__
232  . ': error opening connection: {errstr1}', $this->fopenErrors );
233  }
234  $this->status->fatal( 'http-request-error' );
235  return Status::wrap( $this->status ); // TODO B/C; move this to callers
236  }
237 
238  if ( $result['timed_out'] ) {
239  $this->status->fatal( 'http-timed-out', $this->url );
240  return Status::wrap( $this->status ); // TODO B/C; move this to callers
241  }
242 
243  // If everything went OK, or we received some error code
244  // get the response body content.
245  if ( $this->status->isOK() || (int)$this->respStatus >= 300 ) {
246  while ( !feof( $fh ) ) {
247  $buf = fread( $fh, 8192 );
248 
249  if ( $buf === false ) {
250  $this->status->fatal( 'http-read-error' );
251  break;
252  }
253 
254  if ( strlen( $buf ) ) {
255  call_user_func( $this->callback, $fh, $buf );
256  }
257  }
258  }
259  fclose( $fh );
260 
261  return Status::wrap( $this->status ); // TODO B/C; move this to callers
262  }
263 }
$context
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2612
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:434
captcha-old.count
count
Definition: captcha-old.py:225
$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:1954
MWHttpRequest\$sslVerifyCert
$sslVerifyCert
Definition: MWHttpRequest.php:43
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
MWHttpRequest\$timeout
$timeout
Definition: MWHttpRequest.php:37
PhpHttpRequest\errorHandler
errorHandler( $errno, $errstr)
Custom error handler for dealing with fopen() errors.
Definition: PhpHttpRequest.php:92
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:407
MWHttpRequest\$postData
$postData
Definition: MWHttpRequest.php:39
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:465
PhpHttpRequest\execute
execute()
Definition: PhpHttpRequest.php:102
MWHttpRequest\$method
$method
Definition: MWHttpRequest.php:45
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:315
MWHttpRequest\$parsedUrl
$parsedUrl
Definition: MWHttpRequest.php:48
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:44
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:501
Http\isValidURI
static isValidURI( $uri)
Checks that the given URI is a valid one.
Definition: Http.php:146
PhpHttpRequest
Definition: PhpHttpRequest.php:21
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1049
MWHttpRequest\$url
$url
Definition: MWHttpRequest.php:47
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:408
MWHttpRequest\prepare
prepare()
Definition: MWHttpRequest.php:384