3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
22 * MWHttpRequest implemented using internal curl compiled into PHP
24 class CurlHttpRequest
extends MWHttpRequest
{
25 const SUPPORTS_FILE_POSTS
= true;
27 protected $curlOptions = [];
28 protected $headerText = "";
31 * @throws RuntimeException
33 public function __construct() {
34 if ( !function_exists( 'curl_init' ) ) {
35 throw new RuntimeException(
36 __METHOD__
. ': curl (https://www.php.net/curl) is not installed' );
39 parent
::__construct( ...func_get_args() );
44 * @param string $content
47 protected function readHeader( $fh, $content ) {
48 $this->headerText
.= $content;
49 return strlen( $content );
53 * @see MWHttpRequest::execute
58 public function execute() {
61 if ( !$this->status
->isOK() ) {
62 return Status
::wrap( $this->status
); // TODO B/C; move this to callers
65 $this->curlOptions
[CURLOPT_PROXY
] = $this->proxy
;
66 $this->curlOptions
[CURLOPT_TIMEOUT
] = $this->timeout
;
67 $this->curlOptions
[CURLOPT_CONNECTTIMEOUT_MS
] = $this->connectTimeout
* 1000;
68 $this->curlOptions
[CURLOPT_HTTP_VERSION
] = CURL_HTTP_VERSION_1_0
;
69 $this->curlOptions
[CURLOPT_WRITEFUNCTION
] = $this->callback
;
70 $this->curlOptions
[CURLOPT_HEADERFUNCTION
] = [ $this, "readHeader" ];
71 $this->curlOptions
[CURLOPT_MAXREDIRS
] = $this->maxRedirects
;
72 $this->curlOptions
[CURLOPT_ENCODING
] = ""; # Enable compression
74 $this->curlOptions
[CURLOPT_USERAGENT
] = $this->reqHeaders
['User-Agent'];
76 $this->curlOptions
[CURLOPT_SSL_VERIFYHOST
] = $this->sslVerifyHost ?
2 : 0;
77 $this->curlOptions
[CURLOPT_SSL_VERIFYPEER
] = $this->sslVerifyCert
;
79 if ( $this->caInfo
) {
80 $this->curlOptions
[CURLOPT_CAINFO
] = $this->caInfo
;
83 if ( $this->headersOnly
) {
84 $this->curlOptions
[CURLOPT_NOBODY
] = true;
85 $this->curlOptions
[CURLOPT_HEADER
] = true;
86 } elseif ( $this->method
== 'POST' ) {
87 $this->curlOptions
[CURLOPT_POST
] = true;
88 $postData = $this->postData
;
89 // Don't interpret POST parameters starting with '@' as file uploads, because this
90 // makes it impossible to POST plain values starting with '@' (and causes security
91 // issues potentially exposing the contents of local files).
92 $this->curlOptions
[CURLOPT_SAFE_UPLOAD
] = true;
93 $this->curlOptions
[CURLOPT_POSTFIELDS
] = $postData;
95 // Suppress 'Expect: 100-continue' header, as some servers
96 // will reject it with a 417 and Curl won't auto retry
97 // with HTTP 1.0 fallback
98 $this->reqHeaders
['Expect'] = '';
100 $this->curlOptions
[CURLOPT_CUSTOMREQUEST
] = $this->method
;
103 $this->curlOptions
[CURLOPT_HTTPHEADER
] = $this->getHeaderList();
105 $curlHandle = curl_init( $this->url
);
107 if ( !curl_setopt_array( $curlHandle, $this->curlOptions
) ) {
108 $this->status
->fatal( 'http-internal-error' );
109 throw new InvalidArgumentException( "Error setting curl options." );
112 if ( $this->followRedirects
&& $this->canFollowRedirects() ) {
113 Wikimedia\
suppressWarnings();
114 if ( !curl_setopt( $curlHandle, CURLOPT_FOLLOWLOCATION
, true ) ) {
115 $this->logger
->debug( __METHOD__
. ": Couldn't set CURLOPT_FOLLOWLOCATION. " .
116 "Probably open_basedir is set.\n" );
117 // Continue the processing. If it were in curl_setopt_array,
118 // processing would have halted on its entry
120 Wikimedia\restoreWarnings
();
123 if ( $this->profiler
) {
124 $profileSection = $this->profiler
->scopedProfileIn(
125 __METHOD__
. '-' . $this->profileName
129 $curlRes = curl_exec( $curlHandle );
130 if ( curl_errno( $curlHandle ) == CURLE_OPERATION_TIMEOUTED
) {
131 $this->status
->fatal( 'http-timed-out', $this->url
);
132 } elseif ( $curlRes === false ) {
133 $this->status
->fatal( 'http-curl-error', curl_error( $curlHandle ) );
135 $this->headerList
= explode( "\r\n", $this->headerText
);
138 curl_close( $curlHandle );
140 if ( $this->profiler
) {
141 $this->profiler
->scopedProfileOut( $profileSection );
144 $this->parseHeader();
147 return Status
::wrap( $this->status
); // TODO B/C; move this to callers
153 public function canFollowRedirects() {
154 $curlVersionInfo = curl_version();
155 if ( $curlVersionInfo['version_number'] < 0x071304 ) {
156 $this->logger
->debug( "Cannot follow redirects with libcurl < 7.19.4 due to CVE-2009-0037\n" );