CRM/Utils/HttpClient.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  38  * $Id$
  39  *
  40  */
  41 class CRM_Utils_HttpClient {
  42
  43   const STATUS_OK = 'ok';
  44   const STATUS_WRITE_ERROR = 'write-error';
  45   const STATUS_DL_ERROR = 'dl-error';
  46
  47   /**
  48    * @var CRM_Utils_HttpClient
  49    */
  50   protected static $singleton;
  51
  52   /**
  53    * @var int|NULL seconds; or NULL to use system default
  54    */
  55   protected $connectionTimeout;
  56
  57   public static function singleton() {
  58     if (!self::$singleton) {
  59       self::$singleton = new CRM_Utils_HttpClient();
  60     }
  61     return self::$singleton;
  62   }
  63
  64   public function __construct($connectionTimeout = NULL) {
  65     $this->connectionTimeout = $connectionTimeout;
  66   }
  67
  68   /**
  69    * Download the remote zipfile.
  70    *
  71    * @param string $remoteFile URL of a .zip file
  72    * @param string $localFile path at which to store the .zip file
  73    * @return STATUS_OK|STATUS_WRITE_ERROR|STATUS_DL_ERROR
  74    */
  75   public function fetch($remoteFile, $localFile) {
  76     // Download extension zip file ...
  77     if (!function_exists('curl_init')) {
  78       CRM_Core_Error::fatal('Cannot install this extension - curl is not installed!');
  79     }
  80
  81     list($ch, $caConfig) = $this->createCurl($remoteFile);
  82     if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) {
  83       CRM_Core_Error::fatal('Cannot install this extension - does not support SSL');
  84     }
  85
  86     $fp = @fopen($localFile, "w");
  87     if (!$fp) {
  88       CRM_Core_Session::setStatus(ts('Unable to write to %1.<br />Is the location writable?', array(1 => $localFile)), ts('Write Error'), 'error');
  89       return self::STATUS_WRITE_ERROR;
  90     }
  91     curl_setopt($ch, CURLOPT_FILE, $fp);
  92
  93     curl_exec($ch);
  94     if (curl_errno($ch)) {
  95       CRM_Core_Session::setStatus(ts('Unable to download extension from %1. Error Message: %2',
  96         array(1 => $remoteFile, 2 => curl_error($ch))), ts('Download Error'), 'error');
  97       return self::STATUS_DL_ERROR;
  98     }
  99     else {
 100       curl_close($ch);
 101     }
 102
 103     fclose($fp);
 104
 105     return self::STATUS_OK;
 106   }
 107
 108   /**
 109    * Send an HTTP GET for a remote resource
 110    *
 111    * @param string $remoteFile URL of remote file
 112    * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
 113    */
 114   public function get($remoteFile) {
 115     // Download extension zip file ...
 116     if (!function_exists('curl_init')) {
 117       // CRM-13805
 118       CRM_Core_Session::setStatus(
 119         ts('As a result, actions like retrieving the CiviCRM news feed will fail. Talk to your server administrator or hosting company to rectify this.'),
 120         ts('Curl is not installed')
 121       );
 122       return array(self::STATUS_DL_ERROR, NULL);
 123     }
 124
 125     list($ch, $caConfig) = $this->createCurl($remoteFile);
 126
 127     if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) {
 128       //CRM_Core_Error::fatal('Cannot install this extension - does not support SSL');
 129       return array(self::STATUS_DL_ERROR, NULL);
 130     }
 131
 132     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
 133     $data = curl_exec($ch);
 134     if (curl_errno($ch)) {
 135       return array(self::STATUS_DL_ERROR, $data);
 136     }
 137     else {
 138       curl_close($ch);
 139     }
 140
 141     return array(self::STATUS_OK, $data);
 142   }
 143
 144   /**
 145    * Send an HTTP POST for a remote resource
 146    *
 147    * @param string $remoteFile URL of a .zip file
 148    * @param $params
 149    *
 150    * @internal param string $localFile path at which to store the .zip file
 151    * @return array array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string)
 152    */
 153   public function post($remoteFile, $params) {
 154     // Download extension zip file ...
 155     if (!function_exists('curl_init')) {
 156       //CRM_Core_Error::fatal('Cannot install this extension - curl is not installed!');
 157       return array(self::STATUS_DL_ERROR, NULL);
 158     }
 159
 160     list($ch, $caConfig) = $this->createCurl($remoteFile);
 161
 162     if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) {
 163       //CRM_Core_Error::fatal('Cannot install this extension - does not support SSL');
 164       return array(self::STATUS_DL_ERROR, NULL);
 165     }
 166
 167     curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
 168     curl_setopt($ch, CURLOPT_POST, true);
 169     curl_setopt($ch, CURLOPT_POST,count($params));
 170     curl_setopt($ch, CURLOPT_POSTFIELDS,$params);
 171     $data = curl_exec($ch);
 172     if (curl_errno($ch)) {
 173       return array(self::STATUS_DL_ERROR, $data);
 174     }
 175     else {
 176       curl_close($ch);
 177     }
 178
 179     return array(self::STATUS_OK, $data);
 180   }
 181
 182   /**
 183    * @param string $remoteFile
 184    * @return array (0 => resource, 1 => CA_Config_Curl)
 185    */
 186   protected function createCurl($remoteFile) {
 187     require_once 'CA/Config/Curl.php';
 188     $caConfig = CA_Config_Curl::probe(array(
 189       'verify_peer' => (bool) CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::SYSTEM_PREFERENCES_NAME, 'verifySSL', NULL, TRUE)
 190     ));
 191
 192     $ch = curl_init();
 193     curl_setopt($ch, CURLOPT_URL, $remoteFile);
 194     curl_setopt($ch, CURLOPT_HEADER, FALSE);
 195     curl_setopt($ch, CURLOPT_ENCODING, 'gzip');
 196     curl_setopt($ch, CURLOPT_VERBOSE, 0);
 197     if ($this->isRedirectSupported()) {
 198       curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
 199     }
 200     if ($this->connectionTimeout !== NULL) {
 201       curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $this->connectionTimeout);
 202     }
 203     if (preg_match('/^https:/', $remoteFile) && $caConfig->isEnableSSL()) {
 204       curl_setopt_array($ch, $caConfig->toCurlOptions());
 205     }
 206
 207     return array($ch, $caConfig);
 208   }
 209
 210   public function isRedirectSupported() {
 211     return (ini_get('open_basedir') == '') && (ini_get('safe_mode') == 'Off' || ini_get('safe_mode') === FALSE);
 212   }
 213
 214 }