-
-
Notifications
You must be signed in to change notification settings - Fork 9
/
APIHelper.php
320 lines (267 loc) · 10.4 KB
/
APIHelper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
<?php
use QuickBooksOnline\API\Core\HttpClients\FaultHandler;
class CRM_Quickbooks_APIHelper {
private static $quickBooksDataService = NULL; //Data service object for login
private static $quickBooksAccountingDataService = NULL; // Data service object for accounting and company info retrieval
/**
* Generate random State token to verify the Access token on redirection.
*
* @param $length
* @param string $keyspace
*
* @return string
* @throws Exception
*/
public static function generateStateToken($length, $keyspace = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ') {
$pieces = [];
$max = mb_strlen($keyspace, '8bit') - 1;
for ($i = 0; $i < $length; ++$i) {
$pieces[] = $keyspace[random_int(0, $max)];
}
return implode('', $pieces);
}
/**
* Generate dataservice object to verify and login into QuickBooks
*
* @return \QuickBooksOnline\API\DataService\DataService|null
* @throws CiviCRM_API3_Exception
* @throws \QuickBooksOnline\API\Exception\SdkException
*/
public static function getLoginDataServiceObject() {
if (self::$quickBooksDataService) {
return self::$quickBooksDataService;
}
$redirectUrl = self::getRedirectUrl();
$stateTokenValue = self::generateStateToken(40);
$clientID = civicrm_api3('Setting', 'getvalue', ['name' => 'quickbooks_consumer_key']);
$clientSecret = civicrm_api3('Setting', 'getvalue', ['name' => 'quickbooks_shared_secret']);
$config = CRM_Core_Config::singleton();
$logLocation = $config->configAndLogDir;
$logActivated = civicrm_api3('Setting', 'getvalue', ['name' => 'quickbooks_activate_qbo_logging']);
$stateToken = [
'state_token' => $stateTokenValue,
];
Civi::settings()->set('quickbooks_state_token', $stateTokenValue);
self::$quickBooksDataService = \QuickBooksOnline\API\DataService\DataService::Configure([
'auth_mode' => 'oauth2',
'ClientID' => $clientID,
'ClientSecret' => $clientSecret,
'RedirectURI' => $redirectUrl,
'scope' => 'com.intuit.quickbooks.accounting',
'response_type' => 'code',
'state' => json_encode($stateToken),
]);
if ($logActivated) {
self::$quickBooksDataService->setLogLocation($logLocation);
self::$quickBooksDataService->enableLog();
} else {
self::$quickBooksDataService->disableLog();
}
return self::$quickBooksDataService;
}
/**
* Generates data service object for accounting into QuickBooks.
*
* @return \QuickBooksOnline\API\DataService\DataService|null
* @throws CiviCRM_API3_Exception
* @throws \QuickBooksOnline\API\Exception\SdkException
*/
public static function getAccountingDataServiceObject($forRefreshToken = FALSE) {
if (!$forRefreshToken) {
self::refreshAccessTokenIfRequired();
}
if (self::$quickBooksAccountingDataService && !$forRefreshToken) {
return self::$quickBooksAccountingDataService;
}
$QBCredentials = self::getQuickBooksCredentials();
$config = CRM_Core_Config::singleton();
$logLocation = $config->configAndLogDir;
$logActivated = civicrm_api3('Setting', 'getvalue', ['name' => 'quickbooks_activate_qbo_logging']);
$baseUrl = civicrm_api3('Setting', 'getvalue', ['name' => 'quickbooks_baseurl']);
$dataServiceParams = [
'auth_mode' => 'oauth2',
'ClientID' => $QBCredentials['clientID'],
'ClientSecret' => $QBCredentials['clientSecret'],
'accessTokenKey' => $QBCredentials['accessToken'],
'refreshTokenKey' => $QBCredentials['refreshToken'],
'QBORealmID' => $QBCredentials['realMId'],
'baseUrl' => $baseUrl,
];
if ($forRefreshToken) {
unset($dataServiceParams['accessTokenKey']);
}
$dataService = \QuickBooksOnline\API\DataService\DataService::Configure($dataServiceParams);
if ($logActivated) {
$dataService->setLogLocation($logLocation);
$dataService->enableLog();
} else {
$dataService->disableLog();
}
if (!$forRefreshToken) {
self::$quickBooksAccountingDataService = $dataService;
return self::$quickBooksAccountingDataService;
}
return $dataService;
}
/**
* Get redirection URL for OAuth request.
*
* @return mixed
*/
private static function getRedirectUrl() {
return str_replace('&', '&', CRM_Utils_System::url('civicrm/quickbooks/OAuth', NULL, TRUE, NULL));
}
/**
* Refresh QuickBooks access token if required.
*
* @throws CiviCRM_API3_Exception
* @throws \QuickBooksOnline\API\Exception\SdkException
*/
private static function refreshAccessTokenIfRequired() {
$QBCredentials = self::getQuickBooksCredentials();
$now = new DateTime();
$now->modify("-5 minutes");
$isAccessTokenExpired = self::isTokenExpired($QBCredentials);
$isRefreshTokenExpired = self::isTokenExpired($QBCredentials, TRUE);
if ($isAccessTokenExpired || $isRefreshTokenExpired) {
$dataService = self::getAccountingDataServiceObject(TRUE);
try {
$OAuth2LoginHelper = $dataService->getOAuth2LoginHelper();
if ($isRefreshTokenExpired) {
$refreshedAccessTokenObj = $OAuth2LoginHelper->refreshAccessTokenWithRefreshToken($QBCredentials['refreshToken']);
}
else {
$refreshedAccessTokenObj = $OAuth2LoginHelper->refreshToken();
}
$tokenExpiresIn = new DateTime();
$tokenExpiresIn->modify("+" . $refreshedAccessTokenObj->getAccessTokenValidationPeriodInSeconds() . "seconds");
$refreshTokenExpiresIn = new DateTime();
$refreshTokenExpiresIn->modify("+" . $refreshedAccessTokenObj->getRefreshTokenValidationPeriodInSeconds() . "seconds");
$accessToken = $refreshedAccessTokenObj->getAccessToken();
$refreshToken = $refreshedAccessTokenObj->getRefreshToken();
civicrm_api3('Setting', 'create', [
'quickbooks_access_token' => $accessToken,
'quickbooks_refresh_token' => $refreshToken,
'quickbooks_access_token_expiryDate' => $tokenExpiresIn->format("Y-m-d H:i:s"),
'quickbooks_refresh_token_expiryDate' => $refreshTokenExpiresIn->format("Y-m-d H:i:s"),
]);
} catch (\QuickBooksOnline\API\Exception\IdsException $e) {
}
}
}
/**
* Get all required credentials to connect with QuickBooks
*
* @return array
* @throws CiviCRM_API3_Exception
*/
public static function getQuickBooksCredentials() {
$quickBooksSettings = civicrm_api3('Setting', 'get', ['group' => "QuickBooks Online Settings"]);
$quickBooksSettings = $quickBooksSettings['values'][$quickBooksSettings['id']];
$clientID = $quickBooksSettings["quickbooks_consumer_key"];
$clientSecret = $quickBooksSettings["quickbooks_shared_secret"];
$accessToken = $quickBooksSettings["quickbooks_access_token"];
$refreshToken = $quickBooksSettings["quickbooks_refresh_token"];
$realMId = $quickBooksSettings["quickbooks_realmId"];
$tokenExpiryDate = $quickBooksSettings["quickbooks_access_token_expiryDate"];
$refreshTokenExpiryDate = $quickBooksSettings["quickbooks_refresh_token_expiryDate"];
return [
'clientID' => $clientID,
'clientSecret' => $clientSecret,
'accessToken' => $accessToken,
'refreshToken' => $refreshToken,
'realMId' => $realMId,
'accessTokenExpiryDate' => $tokenExpiryDate,
'refreshTokenExpiryDate' => $refreshTokenExpiryDate,
];
}
/**
* Check if refresh/access token expired or not.
*
* @param $QBCredentials
*
* @return bool
* @throws Exception
*/
public static function isTokenExpired($QBCredentials, $isRefreshToken = FALSE) {
$tokenKey = "accessTokenExpiryDate";
if ($isRefreshToken) {
$tokenKey = "refreshTokenExpiryDate";
}
$isTokenExpired = FALSE;
if (isset($QBCredentials[$tokenKey]) && !empty($QBCredentials[$tokenKey]) && $QBCredentials[$tokenKey] != 1) {
$currentDateTime = new DateTime();
$currentDateTime->modify("-5 minutes");
$tokenExpiryDate = DateTime::createFromFormat("Y-m-d H:i:s", $QBCredentials[$tokenKey]);
if ($currentDateTime > $tokenExpiryDate) {
$isTokenExpired = TRUE;
}
}
return $isTokenExpired;
}
/**
* Check if the API credentials are authorized.
*
* @return bool
* @throws \Exception
*/
public static function isAuthorized() {
$QBCredentials = CRM_Quickbooks_APIHelper::getQuickBooksCredentials();
if (empty($QBCredentials['accessToken'])) {
return FALSE;
}
if (empty($QBCredentials['refreshToken'])) {
return FALSE;
}
if (self::isTokenExpired($QBCredentials, TRUE)) {
return FALSE;
}
return TRUE;
}
/**
* Helper Function to convert faults errors saved by the SDK into something
* we can store in an Account* error_data
*
* @param FaultHandler $error_response
*
* @return array|string[]
*/
public static function parseErrorResponse($error_response) {
// Start with a blank set of error messages.
$error_message = [];
// Quickbooks Online API seems to always send XML error messages, even when
// you query with JSON. Parse into a document tree.
$response_doc = new DOMDocument();
if($response_doc->loadXML($error_response->getResponseBody())) {
// Error responses wrap (at least one) Error element.
$error_els = $response_doc->getElementsByTagName('Error');
foreach($error_els as $error) {
// Nice errors have a Detail element, which tends to render the possibly
// also present Message redundant.
if (($details = $error->getElementsByTagName('Detail'))->length > 0) {
for ($n = 0; $n < $details->length; $n++) {
$detail = $details->item($n);
$error_message[] = $detail->textContent;
}
}
// If there's no Detail, just use the Message
elseif(($messages = $error->getElementsByTagName('Message'))->length > 0) {
for ($n = 0; $n < $messages->length; $n++) {
$message = $messages->item($n);
$error_message[] = $message->textContent;
}
}
// Finally, the error might just have text in it.
else {
$error_message[] =& $error->textContent;
}
}
}
// If either the response was not XML, or was not in an XML format we
// expected, just put the code and response in as it has been.
if(!count($error_message)){
$error_message = [ $error_response->getHttpStatusCode() . ': [' . $error_response->getResponseBody() . ']' ];
}
return $error_message;
}
}