Commit | Line | Data |
---|---|---|
6a488035 TO |
1 | <?php |
2 | /* | |
3 | +--------------------------------------------------------------------+ | |
7e9e8871 | 4 | | CiviCRM version 4.7 | |
6a488035 | 5 | +--------------------------------------------------------------------+ |
fa938177 | 6 | | Copyright CiviCRM LLC (c) 2004-2016 | |
6a488035 TO |
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 | +--------------------------------------------------------------------+ | |
d25dd0ee | 26 | */ |
6a488035 TO |
27 | |
28 | /** | |
e647e388 TO |
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. | |
6a488035 TO |
35 | * |
36 | * @package CRM | |
fa938177 | 37 | * @copyright CiviCRM LLC (c) 2004-2016 |
6a488035 TO |
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 | ||
3b6f287b TO |
45 | /** |
46 | * @var CRM_Utils_HttpClient | |
47 | */ | |
48 | protected static $singleton; | |
49 | ||
afcc9be0 | 50 | /** |
50bfb460 SB |
51 | * @var int|NULL |
52 | * seconds; or NULL to use system default | |
afcc9be0 | 53 | */ |
021cfda1 | 54 | protected $connectionTimeout; |
afcc9be0 | 55 | |
5bc392e6 EM |
56 | /** |
57 | * @return CRM_Utils_HttpClient | |
58 | */ | |
3b6f287b TO |
59 | public static function singleton() { |
60 | if (!self::$singleton) { | |
61 | self::$singleton = new CRM_Utils_HttpClient(); | |
62 | } | |
63 | return self::$singleton; | |
64 | } | |
65 | ||
5bc392e6 EM |
66 | /** |
67 | * @param null $connectionTimeout | |
68 | */ | |
021cfda1 TO |
69 | public function __construct($connectionTimeout = NULL) { |
70 | $this->connectionTimeout = $connectionTimeout; | |
afcc9be0 TO |
71 | } |
72 | ||
6a488035 TO |
73 | /** |
74 | * Download the remote zipfile. | |
75 | * | |
77855840 TO |
76 | * @param string $remoteFile |
77 | * URL of a .zip file. | |
78 | * @param string $localFile | |
79 | * Path at which to store the .zip file. | |
6a488035 TO |
80 | * @return STATUS_OK|STATUS_WRITE_ERROR|STATUS_DL_ERROR |
81 | */ | |
3b6f287b | 82 | public function fetch($remoteFile, $localFile) { |
6a488035 TO |
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 | } | |
e647e388 TO |
87 | |
88 | list($ch, $caConfig) = $this->createCurl($remoteFile); | |
6a488035 TO |
89 | if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) { |
90 | CRM_Core_Error::fatal('Cannot install this extension - does not support SSL'); | |
91 | } | |
92 | ||
6a488035 TO |
93 | $fp = @fopen($localFile, "w"); |
94 | if (!$fp) { | |
b769826b | 95 | // Fixme: throw error instead of setting message |
6a488035 TO |
96 | CRM_Core_Session::setStatus(ts('Unable to write to %1.<br />Is the location writable?', array(1 => $localFile)), ts('Write Error'), 'error'); |
97 | return self::STATUS_WRITE_ERROR; | |
98 | } | |
99 | curl_setopt($ch, CURLOPT_FILE, $fp); | |
100 | ||
101 | curl_exec($ch); | |
102 | if (curl_errno($ch)) { | |
b769826b | 103 | // Fixme: throw error instead of setting message |
6a488035 | 104 | CRM_Core_Session::setStatus(ts('Unable to download extension from %1. Error Message: %2', |
b769826b | 105 | array(1 => $remoteFile, 2 => curl_error($ch))), ts('Extension download error'), 'error'); |
6a488035 TO |
106 | return self::STATUS_DL_ERROR; |
107 | } | |
108 | else { | |
109 | curl_close($ch); | |
110 | } | |
111 | ||
112 | fclose($fp); | |
113 | ||
114 | return self::STATUS_OK; | |
115 | } | |
afcc9be0 TO |
116 | |
117 | /** | |
fe482240 | 118 | * Send an HTTP GET for a remote resource. |
afcc9be0 | 119 | * |
77855840 TO |
120 | * @param string $remoteFile |
121 | * URL of remote file. | |
a6c01b45 CW |
122 | * @return array |
123 | * array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string) | |
afcc9be0 TO |
124 | */ |
125 | public function get($remoteFile) { | |
afcc9be0 TO |
126 | // Download extension zip file ... |
127 | if (!function_exists('curl_init')) { | |
dadcd1ac FG |
128 | // CRM-13805 |
129 | CRM_Core_Session::setStatus( | |
130 | ts('As a result, actions like retrieving the CiviCRM news feed will fail. Talk to your server administrator or hosting company to rectify this.'), | |
131 | ts('Curl is not installed') | |
132 | ); | |
afcc9be0 TO |
133 | return array(self::STATUS_DL_ERROR, NULL); |
134 | } | |
e647e388 TO |
135 | |
136 | list($ch, $caConfig) = $this->createCurl($remoteFile); | |
137 | ||
afcc9be0 | 138 | if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) { |
50bfb460 | 139 | // CRM_Core_Error::fatal('Cannot install this extension - does not support SSL'); |
afcc9be0 TO |
140 | return array(self::STATUS_DL_ERROR, NULL); |
141 | } | |
142 | ||
afcc9be0 | 143 | curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); |
afcc9be0 TO |
144 | $data = curl_exec($ch); |
145 | if (curl_errno($ch)) { | |
2b5a6dbf | 146 | return array(self::STATUS_DL_ERROR, $data); |
afcc9be0 TO |
147 | } |
148 | else { | |
149 | curl_close($ch); | |
150 | } | |
151 | ||
152 | return array(self::STATUS_OK, $data); | |
e647e388 TO |
153 | } |
154 | ||
49626e3d | 155 | /** |
fe482240 | 156 | * Send an HTTP POST for a remote resource. |
49626e3d | 157 | * |
77855840 TO |
158 | * @param string $remoteFile |
159 | * URL of a .zip file. | |
c490a46a | 160 | * @param array $params |
f4aaa82a | 161 | * |
a6c01b45 CW |
162 | * @return array |
163 | * array(0 => STATUS_OK|STATUS_DL_ERROR, 1 => string) | |
49626e3d CW |
164 | */ |
165 | public function post($remoteFile, $params) { | |
166 | // Download extension zip file ... | |
167 | if (!function_exists('curl_init')) { | |
168 | //CRM_Core_Error::fatal('Cannot install this extension - curl is not installed!'); | |
169 | return array(self::STATUS_DL_ERROR, NULL); | |
170 | } | |
171 | ||
172 | list($ch, $caConfig) = $this->createCurl($remoteFile); | |
173 | ||
174 | if (preg_match('/^https:/', $remoteFile) && !$caConfig->isEnableSSL()) { | |
50bfb460 | 175 | // CRM_Core_Error::fatal('Cannot install this extension - does not support SSL'); |
49626e3d CW |
176 | return array(self::STATUS_DL_ERROR, NULL); |
177 | } | |
178 | ||
179 | curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); | |
e7292422 TO |
180 | curl_setopt($ch, CURLOPT_POST, TRUE); |
181 | curl_setopt($ch, CURLOPT_POST, count($params)); | |
182 | curl_setopt($ch, CURLOPT_POSTFIELDS, $params); | |
49626e3d CW |
183 | $data = curl_exec($ch); |
184 | if (curl_errno($ch)) { | |
2b5a6dbf | 185 | return array(self::STATUS_DL_ERROR, $data); |
49626e3d CW |
186 | } |
187 | else { | |
188 | curl_close($ch); | |
189 | } | |
190 | ||
191 | return array(self::STATUS_OK, $data); | |
192 | } | |
193 | ||
e647e388 TO |
194 | /** |
195 | * @param string $remoteFile | |
a6c01b45 CW |
196 | * @return array |
197 | * (0 => resource, 1 => CA_Config_Curl) | |
e647e388 TO |
198 | */ |
199 | protected function createCurl($remoteFile) { | |
e647e388 | 200 | $caConfig = CA_Config_Curl::probe(array( |
aaffa79f | 201 | 'verify_peer' => (bool) Civi::settings()->get('verifySSL'), |
e647e388 TO |
202 | )); |
203 | ||
204 | $ch = curl_init(); | |
205 | curl_setopt($ch, CURLOPT_URL, $remoteFile); | |
206 | curl_setopt($ch, CURLOPT_HEADER, FALSE); | |
207 | curl_setopt($ch, CURLOPT_ENCODING, 'gzip'); | |
208 | curl_setopt($ch, CURLOPT_VERBOSE, 0); | |
eb066397 | 209 | if ($this->isRedirectSupported()) { |
439b9688 LS |
210 | curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE); |
211 | } | |
021cfda1 TO |
212 | if ($this->connectionTimeout !== NULL) { |
213 | curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, $this->connectionTimeout); | |
214 | } | |
e647e388 TO |
215 | if (preg_match('/^https:/', $remoteFile) && $caConfig->isEnableSSL()) { |
216 | curl_setopt_array($ch, $caConfig->toCurlOptions()); | |
217 | } | |
afcc9be0 | 218 | |
e647e388 | 219 | return array($ch, $caConfig); |
afcc9be0 TO |
220 | } |
221 | ||
5bc392e6 EM |
222 | /** |
223 | * @return bool | |
224 | */ | |
eb066397 | 225 | public function isRedirectSupported() { |
8c633404 | 226 | return (ini_get('open_basedir') == '') && (ini_get('safe_mode') == 'Off' || ini_get('safe_mode') == '' || ini_get('safe_mode') === FALSE); |
eb066397 TO |
227 | } |
228 | ||
6a488035 | 229 | } |