extlib/Auth/Yadis/ParanoidHTTPFetcher.php

   1 <?php
   2
   3 /**
   4  * This module contains the CURL-based HTTP fetcher implementation.
   5  *
   6  * PHP versions 4 and 5
   7  *
   8  * LICENSE: See the COPYING file included in this distribution.
   9  *
  10  * @package OpenID
  11  * @author JanRain, Inc. <openid@janrain.com>
  12  * @copyright 2005-2008 Janrain, Inc.
  13  * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
  14  */
  15
  16 /**
  17  * Interface import
  18  */
  19 require_once "Auth/Yadis/HTTPFetcher.php";
  20
  21 require_once "Auth/OpenID.php";
  22
  23 /**
  24  * A paranoid {@link Auth_Yadis_HTTPFetcher} class which uses CURL
  25  * for fetching.
  26  *
  27  * @package OpenID
  28  */
  29 class Auth_Yadis_ParanoidHTTPFetcher extends Auth_Yadis_HTTPFetcher {
  30     function Auth_Yadis_ParanoidHTTPFetcher()
  31     {
  32         $this->reset();
  33     }
  34
  35     function reset()
  36     {
  37         $this->headers = array();
  38         $this->data = "";
  39     }
  40
  41     /**
  42      * @access private
  43      */
  44     function _writeHeader($ch, $header)
  45     {
  46         array_push($this->headers, rtrim($header));
  47         return strlen($header);
  48     }
  49
  50     /**
  51      * @access private
  52      */
  53     function _writeData($ch, $data)
  54     {
  55         if (strlen($this->data) > 1024*Auth_OpenID_FETCHER_MAX_RESPONSE_KB) {
  56             return 0;
  57         } else {
  58             $this->data .= $data;
  59             return strlen($data);
  60         }
  61     }
  62
  63     /**
  64      * Does this fetcher support SSL URLs?
  65      */
  66     function supportsSSL()
  67     {
  68         $v = curl_version();
  69         if(is_array($v)) {
  70             return in_array('https', $v['protocols']);
  71         } elseif (is_string($v)) {
  72             return preg_match('/OpenSSL/i', $v);
  73         } else {
  74             return 0;
  75         }
  76     }
  77
  78     function get($url, $extra_headers = null)
  79     {
  80         if (!$this->canFetchURL($url)) {
  81             return null;
  82         }
  83
  84         $stop = time() + $this->timeout;
  85         $off = $this->timeout;
  86
  87         $redir = true;
  88
  89         while ($redir && ($off > 0)) {
  90             $this->reset();
  91
  92             $c = curl_init();
  93
  94             if ($c === false) {
  95                 Auth_OpenID::log(
  96                     "curl_init returned false; could not " .
  97                     "initialize for URL '%s'", $url);
  98                 return null;
  99             }
 100
 101             if (defined('CURLOPT_NOSIGNAL')) {
 102                 curl_setopt($c, CURLOPT_NOSIGNAL, true);
 103             }
 104
 105             if (!$this->allowedURL($url)) {
 106                 Auth_OpenID::log("Fetching URL not allowed: %s",
 107                                  $url);
 108                 return null;
 109             }
 110
 111             curl_setopt($c, CURLOPT_WRITEFUNCTION,
 112                         array(&$this, "_writeData"));
 113             curl_setopt($c, CURLOPT_HEADERFUNCTION,
 114                         array(&$this, "_writeHeader"));
 115
 116             if ($extra_headers) {
 117                 curl_setopt($c, CURLOPT_HTTPHEADER, $extra_headers);
 118             }
 119
 120             $cv = curl_version();
 121             if(is_array($cv)) {
 122               $curl_user_agent = 'curl/'.$cv['version'];
 123             } else {
 124               $curl_user_agent = $cv;
 125             }
 126             curl_setopt($c, CURLOPT_USERAGENT,
 127                         Auth_OpenID_USER_AGENT.' '.$curl_user_agent);
 128             curl_setopt($c, CURLOPT_TIMEOUT, $off);
 129             curl_setopt($c, CURLOPT_URL, $url);
 130             curl_setopt($c, CURLOPT_RANGE,
 131                         "0-".(1024 * Auth_OpenID_FETCHER_MAX_RESPONSE_KB));
 132
 133             curl_exec($c);
 134
 135             $code = curl_getinfo($c, CURLINFO_HTTP_CODE);
 136             $body = $this->data;
 137             $headers = $this->headers;
 138
 139             if (!$code) {
 140                 Auth_OpenID::log("Got no response code when fetching %s", $url);
 141                 Auth_OpenID::log("CURL error (%s): %s",
 142                                  curl_errno($c), curl_error($c));
 143                 return null;
 144             }
 145
 146             if (in_array($code, array(301, 302, 303, 307))) {
 147                 $url = $this->_findRedirect($headers);
 148                 $redir = true;
 149             } else {
 150                 $redir = false;
 151                 curl_close($c);
 152
 153                 $new_headers = array();
 154
 155                 foreach ($headers as $header) {
 156                     if (strpos($header, ': ')) {
 157                         list($name, $value) = explode(': ', $header, 2);
 158                         $new_headers[$name] = $value;
 159                     }
 160                 }
 161
 162                 Auth_OpenID::log(
 163                     "Successfully fetched '%s': GET response code %s",
 164                     $url, $code);
 165
 166                 return new Auth_Yadis_HTTPResponse($url, $code,
 167                                                     $new_headers, $body);
 168             }
 169
 170             $off = $stop - time();
 171         }
 172
 173         return null;
 174     }
 175
 176     function post($url, $body, $extra_headers = null)
 177     {
 178         if (!$this->canFetchURL($url)) {
 179             return null;
 180         }
 181
 182         $this->reset();
 183
 184         $c = curl_init();
 185
 186         if (defined('CURLOPT_NOSIGNAL')) {
 187             curl_setopt($c, CURLOPT_NOSIGNAL, true);
 188         }
 189
 190         curl_setopt($c, CURLOPT_POST, true);
 191         curl_setopt($c, CURLOPT_POSTFIELDS, $body);
 192         curl_setopt($c, CURLOPT_TIMEOUT, $this->timeout);
 193         curl_setopt($c, CURLOPT_URL, $url);
 194         curl_setopt($c, CURLOPT_WRITEFUNCTION,
 195                     array(&$this, "_writeData"));
 196
 197         curl_exec($c);
 198
 199         $code = curl_getinfo($c, CURLINFO_HTTP_CODE);
 200
 201         if (!$code) {
 202             Auth_OpenID::log("Got no response code when fetching %s", $url);
 203             return null;
 204         }
 205
 206         $body = $this->data;
 207
 208         curl_close($c);
 209
 210         $new_headers = $extra_headers;
 211
 212         foreach ($this->headers as $header) {
 213             if (strpos($header, ': ')) {
 214                 list($name, $value) = explode(': ', $header, 2);
 215                 $new_headers[$name] = $value;
 216             }
 217
 218         }
 219
 220         Auth_OpenID::log("Successfully fetched '%s': POST response code %s",
 221                          $url, $code);
 222
 223         return new Auth_Yadis_HTTPResponse($url, $code,
 224                                            $new_headers, $body);
 225     }
 226 }
 227
 228 ?>