Test Failed
Push — master ( e624a7...8d7cd9 )
by PHPLicengine
443:04 queued 441:12
created

Api::setOAuth()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 3
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 5
rs 10
1
<?php
2
3
// Api.php
4
#################################################
5
##
6
## PHPLicengine
7
##
8
#################################################
9
## Copyright 2009-{current_year} PHPLicengine
10
## 
11
## Licensed under the Apache License, Version 2.0 (the "License");
12
## you may not use this file except in compliance with the License.
13
## You may obtain a copy of the License at
14
##
15
##    http://www.apache.org/licenses/LICENSE-2.0
16
##
17
## Unless required by applicable law or agreed to in writing, software
18
## distributed under the License is distributed on an "AS IS" BASIS,
19
## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20
## See the License for the specific language governing permissions and
21
## limitations under the License.
22
#################################################
23
24
namespace PHPLicengine\Api;
25
use PHPLicengine\Exception\CurlException;
26
27
class Api implements ApiInterface {
28
29
              protected $_api_key_var = 'Authorization: Bearer ';
30
              protected $_api_key;
31
              protected $_timeout = 30;
32
              protected $_verify_ssl = true;
33
              protected $_verify_host = 2;
34
              protected $curlErrno = false;
35
              protected $curlError = false;
36
              protected $curlProxy = false;
37
              protected $response = false;
38
              protected $request = array();
39
              protected $json = true;
40
              protected $accept;
41
              protected $curlInfo;
42
              protected $_curl_callback;
43
44
              public function __construct($api_key = "", $basic = "") 
45
              { 
46
                     if (!function_exists('curl_init')) 
47
                     { 
48
                            throw new CurlException("cURL is not available. This API wrapper cannot be used."); 
49
                     } 
50
                  
51
                     if (isset($api_key))
52
                     {
53
                            $this->setApiKey($api_key);
54
                     } 
55
                  
56
                     if ($basic === true) 
57
                     {
58
                            $this->_api_key_var = 'Authorization: Basic ';
59
                            $this->json = false;
60
                     }
61
              }
62
63
              public function setOAuth()
64
              {
65
                     $this->_api_key_var = '';
66
                     $this->json = false;
67
                     $this->accept = true;
68
              }
69
  
70
              public function enableJson() 
71
              {
72
                     $this->_api_key_var = 'Authorization: Bearer ';
73
                     $this->json = true;
74
              } 
75
           
76
              public function setApiKey($api_key) 
77
              { 
78
                     $this->_api_key = $api_key;
79
              } 
80
81
              public function enableSslVerification() 
82
              { 
83
                     $this->_verify_ssl = true; 
84
                     $this->_verify_host = 2; 
85
              } 
86
  
87
              public function disableSslVerification() 
88
              { 
89
                     $this->_verify_ssl = false; 
90
                     $this->_verify_host = 0; 
91
              } 
92
93
              public function setTimeout($timeout) 
94
              { 
95
                     $this->_timeout = $timeout; 
96
              } 
97
98
              public function setCurlProxy($proxy)  
99
              {  
100
                     $this->curlProxy = $proxy;  
101
              }  
102
103
              public function setCurlCallback($callback) 
104
              { 
105
                     $this->_curl_callback = $callback; 
106
              } 
107
108
              private function _call($url, $params = null, $headers = null, $method = "GET") 
109
              {
110
                     $ch = curl_init();
111
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_URL, $url);
112
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_FOLLOWLOCATION, false);
113
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_TIMEOUT, $this->_timeout);
114
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_RETURNTRANSFER, true);
115
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_SSL_VERIFYPEER, $this->_verify_ssl);
116
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_SSL_VERIFYHOST, $this->_verify_host);
117
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_HEADER, true);
118
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLINFO_HEADER_OUT, true);
119
                     if ($this->curlProxy) {  
120
                            curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_PROXY, $this->curlProxy);  
121
                     }  
122
                     if ($this->_curl_callback) { 
123
                            call_user_func($this->_curl_callback, $ch, $params, $headers, $method); 
124
                     } 
125
                     switch (strtoupper($method)) { 
126
                            case 'PUT':
127
                            case 'PATCH':
128
                            case 'DELETE':
129
                                          curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_CUSTOMREQUEST, strtoupper($method));
130
                                          curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_POSTFIELDS, json_encode($params));
131
                            break;
132
                            case 'POST':
133
                                          curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_POST, true);
134
                                          if ($this->json === true) {
135
                                                 $params = json_encode($params);
136
                                          }
137
                                          curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_POSTFIELDS, $params);
138
                            break;
139
                            case 'GET':
140
                                          curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_HTTPGET, true);
141
                                          if (!empty($params)) {
142
                                                 $url .= '?'.http_build_query($params);
143
                                                 curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_URL, $url);
144
                                          }
145
                            break;
146
                     }
147
148
                     $headers[] = $this->_api_key_var.$this->_api_key;
149
                     if ($this->json === true) {
150
                            $headers[] = 'Content-Type: application/json';
151
                     }
152
                     if ($this->accept === true) {
153
                            $headers[] = 'Accept: application/json';
154
                     }
155
                  
156
                     curl_setopt(/** @scrutinizer ignore-type */ $ch, CURLOPT_HTTPHEADER, $headers);
157
158
                     $this->request['method'] = strtoupper($method);
159
                     $this->request['headers'] = $headers;
160
                     $this->request['params'] = $params;
161
162
                     $this->response = curl_exec(/** @scrutinizer ignore-type */ $ch);
163
                     if (curl_errno(/** @scrutinizer ignore-type */ $ch)) {
164
                            $this->curlErrno = curl_errno(/** @scrutinizer ignore-type */ $ch);
165
                            $this->curlError = curl_error(/** @scrutinizer ignore-type */ $ch);
166
                            curl_close(/** @scrutinizer ignore-type */ $ch);
167
                            return;
168
                     }
169
                     $this->curlInfo = curl_getinfo(/** @scrutinizer ignore-type */ $ch);
170
                     curl_close(/** @scrutinizer ignore-type */ $ch);
171
                     return new Result($this->_getBody(), $this->_getHeaders(), $this->curlInfo);
172
              }
173
174
              private function _parseHeaders($raw_headers) 
175
              {
176
                     if (!function_exists('http_parse_headers')) {
177
                            $headers = array();
178
                            $key = '';
179
                            foreach (explode("\n", $raw_headers) as $i => $h) {
180
                                   $h = explode(':', $h, 2);
181
                                   if (isset($h[1])) {
182
                                          if (!isset($headers[$h[0]])) {
183
                                                 $headers[$h[0]] = trim($h[1]);
184
                                          } elseif (is_array($headers[$h[0]])) {
185
                                                 $headers[$h[0]] = array_merge($headers[$h[0]], array(trim($h[1])));
186
                                          } else {
187
                                                 $headers[$h[0]] = array_merge(array($headers[$h[0]]), array(trim($h[1])));
188
                                          }
189
                                          $key = $h[0];
190
                                   } else { 
191
                                          if (substr($h[0], 0, 1) == "\t") {
192
                                                 $headers[$key] .= "\r\n\t".trim($h[0]);
193
                                          } elseif (!$key) {
194
                                                 $headers[0] = trim($h[0]);
195
                                          }
196
                                   }
197
                            }
198
                            return $headers;
199
                     } else {
200
                            return http_parse_headers($raw_headers);
201
                     } 
202
              }
203
204
              private function _getHeaders()
205
              {
206
                     return $this->_parseHeaders(substr($this->response, 0, $this->curlInfo['header_size']));
0 ignored issues
show
Bug introduced by
$this->response of type boolean is incompatible with the type string expected by parameter $string of substr(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

206
                     return $this->_parseHeaders(substr(/** @scrutinizer ignore-type */ $this->response, 0, $this->curlInfo['header_size']));
Loading history...
207
              }
208
209
              private function _getBody()
210
              {
211
                     return substr($this->response, $this->curlInfo['header_size']);
0 ignored issues
show
Bug introduced by
$this->response of type boolean is incompatible with the type string expected by parameter $string of substr(). ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

211
                     return substr(/** @scrutinizer ignore-type */ $this->response, $this->curlInfo['header_size']);
Loading history...
212
              }
213
214
              public function getResponse()
215
              {
216
                     return $this->response;      
217
              }
218
219
              public function getRequest()
220
              {
221
                     return $this->request;
222
              }
223
           
224
              public function get($url, $params = null, $headers = null)
225
              {
226
                     return $this->_call($url, $params, $headers, $method = "GET");      
227
              }
228
           
229
              public function post($url, $params = null, $headers = null)
230
              {
231
                     return $this->_call($url, $params, $headers, $method = "POST");      
232
              }
233
234
              public function delete($url, $params = null, $headers = null) 
235
              {
236
                     return $this->_call($url, $params, $headers, $method = "DELETE");      
237
              }
238
239
              public function put($url, $params = null, $headers = null) 
240
              {
241
                     return $this->_call($url, $params, $headers, $method = "PUT");      
242
              }
243
244
              public function patch($url, $params = null, $headers = null) 
245
              {
246
                     return $this->_call($url, $params, $headers, $method = "PATCH");      
247
              }
248
249
              public function getCurlInfo()
250
              {
251
                     return $this->curlInfo;
252
              }
253
254
              public function isCurlError() 
255
              {
256
                     return (bool) $this->curlErrno;
257
              }
258
259
              public function getCurlErrno() 
260
              {
261
                     return $this->curlErrno;
262
              }
263
264
              public function getCurlError() 
265
              {
266
                     return $this->curlError;
267
              }
268
           
269
}
270