CRM/Utils/HttpClient.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  * This class handles HTTP downloads
  14  *
  15  * FIXME: fetch() and get() report errors differently -- e.g.
  16  * fetch() returns fatal and get() returns an error code. Should
  17  * refactor both (or get a third-party HTTP library) but don't
  18  * want to deal with that so late in the 4.3 dev cycle.
  19  *
  20  * @package CRM
  21  * @copyright CiviCRM LLC https://civicrm.org/licensing
  22  */
  23 class CRM_Utils_HttpClient {
  24
  25   const STATUS_OK = 'ok';
  26   const STATUS_WRITE_ERROR = 'write-error';
  27   const STATUS_DL_ERROR = 'dl-error';
  28
  29   /**
  30    * @var CRM_Utils_HttpClient
  31    */
  32   protected static $singleton;
  33
  34   /**
  35    * @var int|null
  36    *   seconds; or NULL to use system default
  37    */
  38   protected $connectionTimeout;
  39
  40   /**
  41    * @return CRM_Utils_HttpClient
  42    */
  43   public static function singleton() {
  44     if (!self::$singleton) {
  45       self::$singleton = new CRM_Utils_HttpClient();
  46     }
  47     return self::$singleton;
  48   }
  49
  50   /**
  51    * @param null $connectionTimeout
  52    */
  53   public function __construct($connectionTimeout = NULL) {
  54     $this->connectionTimeout = $connectionTimeout;
  55   }
  56
  57   /**
  58    * Download the remote zipfile.
  59    *
  60    * @param string $remoteFile
  61    *   URL of a .zip file.
  62    * @param string $localFile
  63    *   Path at which to store the .zip file.
  64    * @return STATUS_OK|STATUS_WRITE_ERROR|STATUS_DL_ERROR
  65    *
  66    * @throws CRM_Core_Exception
  67    */
  68   public function fetch($remoteFile, $localFile) {
  69     // Download extension zip file ...
  70     if (!function_exists('curl_init')) {
  71       throw new CRM_Core_Exception('Cannot install this extension - curl is not installed!');
  72     }
  73
  74     list($ch, $caConfig) = $this->createCurl($remoteFile);
  75     if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) {
  76       throw new CRM_Core_Exception('Cannot install this extension - does not support SSL');
  77     }
  78
  79     $fp = @fopen($localFile, "w");
  80     if (!$fp) {
  81       return self::STATUS_WRITE_ERROR;
  82     }
  83     curl_setopt($ch, CURLOPT_FILE, $fp);
  84
  85     curl_exec($ch);
  86     if (curl_errno($ch)) {
  87       return self::STATUS_DL_ERROR;
  88     }
  89     else {
  90       curl_close($ch);
  91     }
  92
  93     fclose($fp);
  94
  95     return self::STATUS_OK;
  96   }
  97
  98   /**
  99    * Send an HTTP GET for a remote resource.
 100    *
 101    * @param string $remoteFile
 102    *   URL of remote file.
 103    * @return array
 104    *   array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
 105    */
 106   public function get($remoteFile) {
 107     // Download extension zip file ...
 108     if (!function_exists('curl_init')) {
 109       // CRM-13805
 110       CRM_Core_Session::setStatus(
 111         ts('As a result, actions like retrieving the CiviCRM news feed will fail. Talk to your server administrator or hosting company to rectify this.'),
 112         ts('Curl is not installed')
 113       );
 114       return [self::STATUS_DL_ERROR, NULL];
 115     }
 116
 117     list($ch, $caConfig) = $this->createCurl($remoteFile);
 118
 119     if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) {
 120       return [self::STATUS_DL_ERROR, NULL];
 121     }
 122
 123     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
 124     $data = curl_exec($ch);
 125     if (curl_errno($ch)) {
 126       return [self::STATUS_DL_ERROR, $data];
 127     }
 128     else {
 129       curl_close($ch);
 130     }
 131
 132     return [self::STATUS_OK, $data];
 133   }
 134
 135   /**
 136    * Send an HTTP POST for a remote resource.
 137    *
 138    * @param string $remoteFile
 139    *   URL of a .zip file.
 140    * @param array $params
 141    *
 142    * @return array
 143    *   array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
 144    */
 145   public function post($remoteFile, $params) {
 146     // Download extension zip file ...
 147     if (!function_exists('curl_init')) {
 148       return [self::STATUS_DL_ERROR, NULL];
 149     }
 150
 151     list($ch, $caConfig) = $this->createCurl($remoteFile);
 152
 153     if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) {
 154       return [self::STATUS_DL_ERROR, NULL];
 155     }
 156
 157     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
 158     curl_setopt($ch, CURLOPT_POST, TRUE);
 159     curl_setopt($ch, CURLOPT_POST, count($params));
 160     curl_setopt($ch, CURLOPT_POSTFIELDS, $params);
 161     $data = curl_exec($ch);
 162     if (curl_errno($ch)) {
 163       return [self::STATUS_DL_ERROR, $data];
 164     }
 165     else {
 166       curl_close($ch);
 167     }
 168
 169     return [self::STATUS_OK, $data];
 170   }
 171
 172   /**
 173    * @param string $remoteFile
 174    * @return array
 175    *   (0 => resource, 1 => CA_Config_Curl)
 176    */
 177   protected function createCurl($remoteFile) {
 178     $caConfig = CA_Config_Curl::probe([
 179       'verify_peer' => (bool) Civi::settings()->get('verifySSL'),
 180     ]);
 181
 182     $ch = curl_init();
 183     curl_setopt($ch, CURLOPT_URL, $remoteFile);
 184     curl_setopt($ch, CURLOPT_HEADER, FALSE);
 185     curl_setopt($ch, CURLOPT_ENCODING, 'gzip');
 186     curl_setopt($ch, CURLOPT_VERBOSE, 0);
 187     if ($this->isRedirectSupported()) {
 188       curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
 189     }
 190     if ($this->connectionTimeout !== NULL) {
 191       curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $this->connectionTimeout);
 192     }
 193     if (preg_match('/^https:/', $remoteFile) && $caConfig->isEnableSSL()) {
 194       curl_setopt_array($ch, $caConfig->toCurlOptions());
 195     }
 196
 197     return [$ch, $caConfig];
 198   }
 199
 200   /**
 201    * @return bool
 202    */
 203   public function isRedirectSupported() {
 204     return (ini_get('open_basedir') == '') && (ini_get('safe_mode') == 'Off' || ini_get('safe_mode') == '' || ini_get('safe_mode') === FALSE);
 205   }
 206
 207 }