CRM/Utils/HttpClient.php

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