]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - lib/httpclient.php
Same goes to onStartShowAside() which has 'Action' as type-hint.
[quix0rs-gnu-social.git] / lib / httpclient.php
1 <?php
2 /**
3  * StatusNet, the distributed open-source microblogging tool
4  *
5  * Utility for doing HTTP-related things
6  *
7  * PHP version 5
8  *
9  * LICENCE: This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU Affero General Public License as published by
11  * the Free Software Foundation, either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU Affero General Public License for more details.
18  *
19  * You should have received a copy of the GNU Affero General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  * @category  Action
23  * @package   StatusNet
24  * @author    Evan Prodromou <evan@status.net>
25  * @copyright 2009 StatusNet, Inc.
26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27  * @link      http://status.net/
28  */
29
30 if (!defined('GNUSOCIAL')) {
31     exit(1);
32 }
33
34 require_once 'HTTP/Request2.php';
35 require_once 'HTTP/Request2/Response.php';
36
37 /**
38  * Useful structure for HTTP responses
39  *
40  * We make HTTP calls in several places, and we have several different
41  * ways of doing them. This class hides the specifics of what underlying
42  * library (curl or PHP-HTTP or whatever) that's used.
43  *
44  * This extends the HTTP_Request2_Response class with methods to get info
45  * about any followed redirects.
46  * 
47  * Originally used the name 'HTTPResponse' to match earlier code, but
48  * this conflicts with a class in in the PECL HTTP extension.
49  *
50  * @category HTTP
51  * @package StatusNet
52  * @author Evan Prodromou <evan@status.net>
53  * @author Brion Vibber <brion@status.net>
54  * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
55  * @link http://status.net/
56  */
57 class GNUsocial_HTTPResponse extends HTTP_Request2_Response
58 {
59     function __construct(HTTP_Request2_Response $response, $url, $redirects=0)
60     {
61         foreach (get_object_vars($response) as $key => $val) {
62             $this->$key = $val;
63         }
64         $this->url = strval($url);
65         $this->redirectCount = intval($redirects);
66     }
67
68     /**
69      * Get the count of redirects that have been followed, if any.
70      * @return int
71      */
72     function getRedirectCount()
73     {
74         return $this->redirectCount;
75     }
76
77     /**
78      * Gets the final target URL, after any redirects have been followed.
79      * @return string URL
80      */
81     function getUrl()
82     {
83         return $this->url;
84     }
85
86     /**
87      * Check if the response is OK, generally a 200 or other 2xx status code.
88      * @return bool
89      */
90     function isOk()
91     {
92         $status = $this->getStatus();
93         return ($status >= 200 && $status < 300);
94     }
95 }
96
97 /**
98  * Utility class for doing HTTP client stuff
99  *
100  * We make HTTP calls in several places, and we have several different
101  * ways of doing them. This class hides the specifics of what underlying
102  * library (curl or PHP-HTTP or whatever) that's used.
103  *
104  * This extends the PEAR HTTP_Request2 package:
105  * - sends StatusNet-specific User-Agent header
106  * - 'follow_redirects' config option, defaulting off
107  * - 'max_redirs' config option, defaulting to 10
108  * - extended response class adds getRedirectCount() and getUrl() methods
109  * - get() and post() convenience functions return body content directly
110  *
111  * @category HTTP
112  * @package  StatusNet
113  * @author   Evan Prodromou <evan@status.net>
114  * @author   Brion Vibber <brion@status.net>
115  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
116  * @link     http://status.net/
117  */
118
119 class HTTPClient extends HTTP_Request2
120 {
121
122     function __construct($url=null, $method=self::METHOD_GET, $config=array())
123     {
124         $this->config['max_redirs'] = 10;
125         $this->config['follow_redirects'] = true;
126         
127         // We've had some issues with keepalive breaking with
128         // HEAD requests, such as to youtube which seems to be
129         // emitting chunked encoding info for an empty body
130         // instead of not emitting anything. This may be a
131         // bug on YouTube's end, but the upstream libray
132         // ought to be investigated to see if we can handle
133         // it gracefully in that case as well.
134         $this->config['protocol_version'] = '1.0';
135
136         // Default state of OpenSSL seems to have no trusted
137         // SSL certificate authorities, which breaks hostname
138         // verification and means we have a hard time communicating
139         // with other sites' HTTPS interfaces.
140         //
141         // Turn off verification unless we've configured a CA bundle.
142         if (common_config('http', 'ssl_cafile')) {
143             $this->config['ssl_cafile'] = common_config('http', 'ssl_cafile');
144         } else {
145             $this->config['ssl_verify_peer'] = false;
146         }
147
148         if (common_config('http', 'curl') && extension_loaded('curl')) {
149             $this->config['adapter'] = 'HTTP_Request2_Adapter_Curl';
150         }
151
152         foreach (array('host', 'port', 'user', 'password', 'auth_scheme') as $cf) {
153             $k = 'proxy_'.$cf;
154             $v = common_config('http', $k); 
155             if (!empty($v)) {
156                 $this->config[$k] = $v;
157             }
158         }
159
160         parent::__construct($url, $method, $config);
161         $this->setHeader('User-Agent', self::userAgent());
162     }
163
164     /**
165      * Convenience/back-compat instantiator
166      * @return HTTPClient
167      */
168     public static function start()
169     {
170         return new HTTPClient();
171     }
172
173     /**
174      * Convenience function to run a GET request.
175      *
176      * @return GNUsocial_HTTPResponse
177      * @throws HTTP_Request2_Exception
178      */
179     public function get($url, $headers=array())
180     {
181         return $this->doRequest($url, self::METHOD_GET, $headers);
182     }
183
184     /**
185      * Convenience function to run a HEAD request.
186      *
187      * @return GNUsocial_HTTPResponse
188      * @throws HTTP_Request2_Exception
189      */
190     public function head($url, $headers=array())
191     {
192         return $this->doRequest($url, self::METHOD_HEAD, $headers);
193     }
194
195     /**
196      * Convenience function to POST form data.
197      *
198      * @param string $url
199      * @param array $headers optional associative array of HTTP headers
200      * @param array $data optional associative array or blob of form data to submit
201      * @return GNUsocial_HTTPResponse
202      * @throws HTTP_Request2_Exception
203      */
204     public function post($url, $headers=array(), $data=array())
205     {
206         if ($data) {
207             $this->addPostParameter($data);
208         }
209         return $this->doRequest($url, self::METHOD_POST, $headers);
210     }
211
212     /**
213      * @return GNUsocial_HTTPResponse
214      * @throws HTTP_Request2_Exception
215      */
216     protected function doRequest($url, $method, $headers)
217     {
218         $this->setUrl($url);
219
220         // Workaround for HTTP_Request2 not setting up SNI in socket contexts;
221         // This fixes cert validation for SSL virtual hosts using SNI.
222         // Requires PHP 5.3.2 or later and OpenSSL with SNI support.
223         if ($this->url->getScheme() == 'https' && defined('OPENSSL_TLSEXT_SERVER_NAME')) {
224             $this->config['ssl_SNI_enabled'] = true;
225             $this->config['ssl_SNI_server_name'] = $this->url->getHost();
226         }
227
228         $this->setMethod($method);
229         if ($headers) {
230             foreach ($headers as $header) {
231                 $this->setHeader($header);
232             }
233         }
234         $response = $this->send();
235         return $response;
236     }
237     
238     protected function log($level, $detail) {
239         $method = $this->getMethod();
240         $url = $this->getUrl();
241         common_log($level, __CLASS__ . ": HTTP $method $url - $detail");
242     }
243
244     /**
245      * Pulls up GNU Social's customized user-agent string, so services
246      * we hit can track down the responsible software.
247      *
248      * @return string
249      */
250     static public function userAgent()
251     {
252         return GNUSOCIAL_ENGINE . '/' . GNUSOCIAL_VERSION
253                 . ' (' . GNUSOCIAL_CODENAME . ')';
254     }
255
256     /**
257      * Actually performs the HTTP request and returns a
258      * GNUsocial_HTTPResponse object with response body and header info.
259      *
260      * Wraps around parent send() to add logging and redirection processing.
261      *
262      * @return GNUsocial_HTTPResponse
263      * @throw HTTP_Request2_Exception
264      */
265     public function send()
266     {
267         $maxRedirs = intval($this->config['max_redirs']);
268         if (empty($this->config['follow_redirects'])) {
269             $maxRedirs = 0;
270         }
271         $redirs = 0;
272         do {
273             try {
274                 $response = parent::send();
275             } catch (HTTP_Request2_Exception $e) {
276                 $this->log(LOG_ERR, $e->getMessage());
277                 throw $e;
278             }
279             $code = $response->getStatus();
280             if ($code >= 200 && $code < 300) {
281                 $reason = $response->getReasonPhrase();
282                 $this->log(LOG_INFO, "$code $reason");
283             } elseif ($code >= 300 && $code < 400) {
284                 $url = $this->getUrl();
285                 $target = $response->getHeader('Location');
286                 
287                 if (++$redirs >= $maxRedirs) {
288                     common_log(LOG_ERR, __CLASS__ . ": Too many redirects: skipping $code redirect from $url to $target");
289                     break;
290                 }
291                 try {
292                     $this->setUrl($target);
293                     $this->setHeader('Referer', $url);
294                     common_log(LOG_INFO, __CLASS__ . ": Following $code redirect from $url to $target");
295                     continue;
296                 } catch (HTTP_Request2_Exception $e) {
297                     common_log(LOG_ERR, __CLASS__ . ": Invalid $code redirect from $url to $target");
298                 }
299             } else {
300                 $reason = $response->getReasonPhrase();
301                 $this->log(LOG_ERR, "$code $reason");
302             }
303             break;
304         } while ($maxRedirs);
305         return new GNUsocial_HTTPResponse($response, $this->getUrl(), $redirs);
306     }
307 }