PluginProbe
Bit Form – Contact Form, Payment Forms, Multi Step Forms, Calculator & Custom Form Builder / 3.2.0
Bit Form – Contact Form, Payment Forms, Multi Step Forms, Calculator & Custom Form Builder v3.2.0
3.3.1 V-3.3.0 3.2.2 3.2.1 3.2.0 3.1.4 3.1.3 3.1.2 3.1.1 3.1.0 V3.0.3 V3.0.2 -3.0.1 V_3.0.0 1.1.1 1.1.8 1.2 1.3 1.4 1.4.18 1.5.2 1.9 2.0 2.10.0 2.10.1 All 138 releases
bit-form / includes / Core / Integration / ZohoAnalytics / ZohoAnalyticsHandler.php

ZohoAnalyticsHandler.php in Bit Form – Contact Form, Payment Forms, Multi Step Forms, Calculator & Custom Form Builder 3.2.0, at includes/Core/Integration/ZohoAnalytics/ZohoAnalyticsHandler.php

534 lines 17.9 KB
No matching file
Up and down to move Enter to open Esc to close
Raw Download Zip
1 <?php
2
3 /**
4 * ZohoAnalytics Integration
5 *
6 */
7
8 namespace BitCode\BitForm\Core\Integration\ZohoAnalytics;
9
10 if (!defined('ABSPATH')) {
11 exit;
12 }
13
14 use BitCode\BitForm\Core\Integration\IntegrationHandler;
15 use BitCode\BitForm\Core\Util\ApiResponse as UtilApiResponse;
16 use BitCode\BitForm\Core\Util\HttpHelper;
17 use BitCode\BitForm\Core\Util\IpTool;
18 use BitCode\BitForm\GlobalHelper;
19 use WP_Error;
20
21 /**
22 * Provide functionality for ZohoCrm integration
23 */
24 class ZohoAnalyticsHandler
25 {
26 private $_formID;
27 private $_integrationID;
28
29 private $_logResponse;
30
31 public function __construct($integrationID, $fromID)
32 {
33 $this->_formID = $fromID;
34 $this->_integrationID = $integrationID;
35 $this->_logResponse = new UtilApiResponse();
36 }
37
38 /**
39 * Helps to register ajax function's with wp
40 *
41 * @return null
42 */
43 public static function registerAjax()
44 {
45 add_action('wp_ajax_bitforms_zanalytics_generate_token', [__CLASS__, 'generateTokens']);
46 add_action('wp_ajax_bitforms_zanalytics_refresh_workspaces', [__CLASS__, 'refreshWorkspacesAjaxHelper']);
47 add_action('wp_ajax_bitforms_zanalytics_refresh_users', [__CLASS__, 'refreshUsersAjaxHelper']);
48 add_action('wp_ajax_bitforms_zanalytics_refresh_tables', [__CLASS__, 'refreshTablesAjaxHelper']);
49 add_action('wp_ajax_bitforms_zanalytics_refresh_table_headers', [__CLASS__, 'refreshTableHeadersAjaxHelper']);
50 }
51
52 /**
53 * Process ajax request for generate_token
54 *
55 * @return JSON zoho crm api response and status
56 */
57 public static function generateTokens()
58 {
59 if (isset($_REQUEST['_ajax_nonce']) && wp_verify_nonce(sanitize_text_field(wp_unslash($_REQUEST['_ajax_nonce'])), 'bitforms_save')) {
60 GlobalHelper::requirePostMethod();
61
62 try {
63 $requestsParams = GlobalHelper::formatRequestData();
64 } catch (\InvalidArgumentException $e) {
65 wp_send_json_error($e->getMessage(), 400);
66 }
67
68 if (
69 empty($requestsParams->{'accounts-server'})
70 || empty($requestsParams->dataCenter)
71 || empty($requestsParams->clientId)
72 || empty($requestsParams->clientSecret)
73 || empty($requestsParams->redirectURI)
74 || empty($requestsParams->code)
75 ) {
76 wp_send_json_error(
77 __(
78 'Requested parameter is empty',
79 'bit-form'
80 ),
81 400
82 );
83 }
84
85 $apiEndpoint = \urldecode($requestsParams->{'accounts-server'}) . '/oauth/v2/token';
86 $requestParams = [
87 'grant_type' => 'authorization_code',
88 'client_id' => $requestsParams->clientId,
89 'client_secret' => $requestsParams->clientSecret,
90 'redirect_uri' => \urldecode($requestsParams->redirectURI),
91 'code' => $requestsParams->code
92 ];
93 $apiResponse = HttpHelper::post($apiEndpoint, $requestParams);
94
95 if (is_wp_error($apiResponse) || !empty($apiResponse->error)) {
96 wp_send_json_error(
97 empty($apiResponse->error) ? 'Unknown' : $apiResponse->error,
98 400
99 );
100 }
101 $apiResponse->generates_on = \time();
102 wp_send_json_success($apiResponse, 200);
103 } else {
104 wp_send_json_error(
105 __(
106 'Token expired',
107 'bit-form'
108 ),
109 401
110 );
111 }
112 }
113
114 /**
115 * Process ajax request for refresh crm modules
116 *
117 * @return JSON crm module data
118 */
119 public static function refreshWorkspacesAjaxHelper()
120 {
121 if (isset($_REQUEST['_ajax_nonce']) && wp_verify_nonce(sanitize_text_field(wp_unslash($_REQUEST['_ajax_nonce'])), 'bitforms_save')) {
122 $authorizationHeader = null;
123
124 GlobalHelper::requirePostMethod();
125
126 try {
127 $queryParams = GlobalHelper::formatRequestData();
128 } catch (\InvalidArgumentException $e) {
129 wp_send_json_error($e->getMessage(), 400);
130 }
131 if (
132 empty($queryParams->tokenDetails)
133 || empty($queryParams->dataCenter)
134 || empty($queryParams->clientId)
135 || empty($queryParams->clientSecret)
136 || empty($queryParams->ownerEmail)
137 ) {
138 wp_send_json_error(
139 __(
140 'Requested parameter is empty',
141 'bit-form'
142 ),
143 400
144 );
145 }
146 $response = [];
147 if ((intval($queryParams->tokenDetails->generates_on) + (55 * 60)) < time()) {
148 $response['tokenDetails'] = ZohoAnalyticsHandler::_refreshAccessToken($queryParams);
149 }
150
151 $workspacesMetaApiEndpoint = "https://analyticsapi.zoho.{$queryParams->dataCenter}/api/{$queryParams->ownerEmail}?ZOHO_ACTION=MYWORKSPACELIST&ZOHO_OUTPUT_FORMAT=JSON&ZOHO_ERROR_FORMAT=JSON&ZOHO_API_VERSION=1.0";
152
153 $authorizationHeader['Authorization'] = "Zoho-oauthtoken {$queryParams->tokenDetails->access_token}";
154 $workspacesMetaResponse = HttpHelper::get($workspacesMetaApiEndpoint, null, $authorizationHeader);
155
156 $allWorkspaces = [];
157 if (!is_wp_error($workspacesMetaResponse) && empty($workspacesMetaResponse->response->error)) {
158 $workspaces = $workspacesMetaResponse->response->result;
159 foreach ($workspaces as $workspace) {
160 $allWorkspaces[] = $workspace->workspaceName;
161 }
162 usort($allWorkspaces, 'strnatcasecmp');
163 $response['workspaces'] = $allWorkspaces;
164 } else {
165 wp_send_json_error(
166 $workspacesMetaResponse->response->error->message,
167 400
168 );
169 }
170 if (!empty($response['tokenDetails']) && !empty($queryParams->id)) {
171 ZohoAnalyticsHandler::_saveRefreshedToken($queryParams->formID, $queryParams->id, $response['tokenDetails'], $response['workspaces']);
172 }
173 wp_send_json_success($response, 200);
174 } else {
175 wp_send_json_error(
176 __(
177 'Token expired',
178 'bit-form'
179 ),
180 401
181 );
182 }
183 }
184
185 public static function refreshUsersAjaxHelper()
186 {
187 if (isset($_REQUEST['_ajax_nonce']) && wp_verify_nonce(sanitize_text_field(wp_unslash($_REQUEST['_ajax_nonce'])), 'bitforms_save')) {
188 $authorizationHeader = null;
189
190 GlobalHelper::requirePostMethod();
191
192 try {
193 $queryParams = GlobalHelper::formatRequestData();
194 } catch (\InvalidArgumentException $e) {
195 wp_send_json_error($e->getMessage(), 400);
196 }
197
198 if (
199 empty($queryParams->tokenDetails)
200 || empty($queryParams->dataCenter)
201 || empty($queryParams->clientId)
202 || empty($queryParams->clientSecret)
203 || empty($queryParams->ownerEmail)
204 ) {
205 wp_send_json_error(
206 __(
207 'Requested parameter is empty',
208 'bit-form'
209 ),
210 400
211 );
212 }
213 $response = [];
214 if ((intval($queryParams->tokenDetails->generates_on) + (55 * 60)) < time()) {
215 $response['tokenDetails'] = ZohoAnalyticsHandler::_refreshAccessToken($queryParams);
216 }
217
218 $usersMetaApiEndpoint = "https://analyticsapi.zoho.{$queryParams->dataCenter}/api/{$queryParams->ownerEmail}?ZOHO_ACTION=GETUSERS&ZOHO_OUTPUT_FORMAT=JSON&ZOHO_ERROR_FORMAT=JSON&ZOHO_API_VERSION=1.0";
219
220 $authorizationHeader['Authorization'] = "Zoho-oauthtoken {$queryParams->tokenDetails->access_token}";
221 $usersMetaResponse = HttpHelper::get($usersMetaApiEndpoint, null, $authorizationHeader);
222
223 $allusers = [];
224 if (!is_wp_error($usersMetaResponse) && empty($usersMetaResponse->response->error)) {
225 $users = $usersMetaResponse->response->result;
226 foreach ($users as $user) {
227 $allusers[] = $user->emailId;
228 }
229 usort($allusers, 'strnatcasecmp');
230 $response['users'] = $allusers;
231 } else {
232 wp_send_json_error(
233 $usersMetaResponse->response->error->message,
234 400
235 );
236 }
237 if (!empty($response['tokenDetails']) && !empty($queryParams->id)) {
238 ZohoAnalyticsHandler::_saveRefreshedToken($queryParams->formID, $queryParams->id, $response['tokenDetails'], $response['users']);
239 }
240 wp_send_json_success($response, 200);
241 } else {
242 wp_send_json_error(
243 __(
244 'Token expired',
245 'bit-form'
246 ),
247 401
248 );
249 }
250 }
251
252 /**
253 * Process ajax request for refesh crm layouts
254 *
255 * @return JSON crm layout data
256 */
257 public static function refreshTablesAjaxHelper()
258 {
259 if (isset($_REQUEST['_ajax_nonce']) && wp_verify_nonce(sanitize_text_field(wp_unslash($_REQUEST['_ajax_nonce'])), 'bitforms_save')) {
260 $authorizationHeader = null;
261
262 GlobalHelper::requirePostMethod();
263
264 try {
265 $queryParams = GlobalHelper::formatRequestData();
266 } catch (\InvalidArgumentException $e) {
267 wp_send_json_error($e->getMessage(), 400);
268 }
269 if (
270 empty($queryParams->workspace)
271 || empty($queryParams->tokenDetails)
272 || empty($queryParams->dataCenter)
273 || empty($queryParams->clientId)
274 || empty($queryParams->clientSecret)
275 ) {
276 wp_send_json_error(
277 __(
278 'Requested parameter is empty',
279 'bit-form'
280 ),
281 400
282 );
283 }
284 $response = [];
285 if ((intval($queryParams->tokenDetails->generates_on) + (55 * 60)) < time()) {
286 $response['tokenDetails'] = ZohoAnalyticsHandler::_refreshAccessToken($queryParams);
287 }
288
289 $tablesMetaApiEndpoint = "https://analyticsapi.zoho.{$queryParams->dataCenter}/api/{$queryParams->ownerEmail}/{$queryParams->workspace}?ZOHO_ACTION=VIEWLIST&ZOHO_OUTPUT_FORMAT=JSON&ZOHO_ERROR_FORMAT=JSON&ZOHO_API_VERSION=1.0";
290
291 $authorizationHeader['Authorization'] = "Zoho-oauthtoken {$queryParams->tokenDetails->access_token}";
292 $tablesMetaResponse = HttpHelper::get($tablesMetaApiEndpoint, null, $authorizationHeader);
293
294 $allTables = [];
295 if (!is_wp_error($tablesMetaResponse)) {
296 $tables = $tablesMetaResponse->response->result;
297 foreach ($tables as $table) {
298 if ('Table' === $table->viewType) {
299 $allTables[] = $table->viewName;
300 }
301 }
302 usort($allTables, 'strnatcasecmp');
303 $response['tables'] = $allTables;
304 } else {
305 wp_send_json_error(
306 'error' === $fieldsMetaResponse->status ? $fieldsMetaResponse->message : 'Unknown',
307 400
308 );
309 }
310 if (!empty($response['tokenDetails']) && $response['tokenDetails'] && !empty($queryParams->id)) {
311 $response['queryWorkspace'] = $queryParams->workspace;
312 ZohoAnalyticsHandler::_saveRefreshedToken($queryParams->formID, $queryParams->id, $response['tokenDetails'], $response);
313 }
314 wp_send_json_success($response, 200);
315 } else {
316 wp_send_json_error(
317 __(
318 'Token expired',
319 'bit-form'
320 ),
321 401
322 );
323 }
324 }
325
326 /**
327 * Process ajax request for refesh crm layouts
328 *
329 * @return JSON crm layout data
330 */
331 public static function refreshTableHeadersAjaxHelper()
332 {
333 if (isset($_REQUEST['_ajax_nonce']) && wp_verify_nonce(sanitize_text_field(wp_unslash($_REQUEST['_ajax_nonce'])), 'bitforms_save')) {
334 $authorizationHeader = null;
335
336 GlobalHelper::requirePostMethod();
337 try {
338 $queryParams = GlobalHelper::formatRequestData();
339 } catch (\InvalidArgumentException $e) {
340 wp_send_json_error($e->getMessage(), 400);
341 }
342 if (
343 empty($queryParams->workspace)
344 || empty($queryParams->table)
345 || empty($queryParams->tokenDetails)
346 || empty($queryParams->dataCenter)
347 || empty($queryParams->clientId)
348 || empty($queryParams->clientSecret)
349 ) {
350 wp_send_json_error(
351 __(
352 'Requested parameter is empty',
353 'bit-form'
354 ),
355 400
356 );
357 }
358 $response = [];
359 if ((intval($queryParams->tokenDetails->generates_on) + (55 * 60)) < time()) {
360 $response['tokenDetails'] = ZohoAnalyticsHandler::_refreshAccessToken($queryParams);
361 }
362
363 $tableHeadersMetaApiEndpoint = "https://analyticsapi.zoho.{$queryParams->dataCenter}/api/{$queryParams->ownerEmail}/{$queryParams->workspace}/{$queryParams->table}?ZOHO_ACTION=EXPORT&ZOHO_OUTPUT_FORMAT=JSON&ZOHO_ERROR_FORMAT=JSON&ZOHO_API_VERSION=1.0";
364
365 $authorizationHeader['Authorization'] = "Zoho-oauthtoken {$queryParams->tokenDetails->access_token}";
366 $tableHeadersMetaResponse = HttpHelper::get($tableHeadersMetaApiEndpoint, null, $authorizationHeader);
367
368 if ('string' === gettype($tableHeadersMetaResponse)) {
369 $tableHeadersMetaResponse = json_decode(preg_replace("/\\\'/", "'", $tableHeadersMetaResponse));
370 }
371
372 if (!is_wp_error($tableHeadersMetaResponse)) {
373 $allHeaders = array_diff($tableHeadersMetaResponse->response->result->column_order, ['Auto Number']);
374 usort($allHeaders, 'strnatcasecmp');
375 $response['table_headers'] = $allHeaders;
376 } else {
377 wp_send_json_error(
378 'error' === $tableHeadersMetaResponse->status ? $tableHeadersMetaResponse->message : 'Unknown',
379 400
380 );
381 }
382 if (!empty($response['tokenDetails']) && $response['tokenDetails'] && !empty($queryParams->id)) {
383 $response['queryModule'] = $queryParams->module;
384 ZohoAnalyticsHandler::_saveRefreshedToken($queryParams->formID, $queryParams->id, $response['tokenDetails'], $response);
385 }
386 wp_send_json_success($response, 200);
387 } else {
388 wp_send_json_error(
389 __(
390 'Token expired',
391 'bit-form'
392 ),
393 401
394 );
395 }
396 }
397
398 /**
399 * Helps to refresh zoho crm access_token
400 *
401 * @param object $apiData Contains required data for refresh access token
402 * @return string|boolean $tokenDetails API token details
403 */
404 protected static function _refreshAccessToken($apiData)
405 {
406 if (
407 empty($apiData->dataCenter)
408 || empty($apiData->clientId)
409 || empty($apiData->clientSecret)
410 || empty($apiData->tokenDetails)
411 ) {
412 return false;
413 }
414 $tokenDetails = $apiData->tokenDetails;
415
416 $dataCenter = $apiData->dataCenter;
417 $apiEndpoint = "https://accounts.zoho.{$dataCenter}/oauth/v2/token";
418 $requestParams = [
419 'grant_type' => 'refresh_token',
420 'client_id' => $apiData->clientId,
421 'client_secret' => $apiData->clientSecret,
422 'refresh_token' => $tokenDetails->refresh_token,
423 ];
424
425 $apiResponse = HttpHelper::post($apiEndpoint, $requestParams);
426 if (is_wp_error($apiResponse) || !empty($apiResponse->error)) {
427 return false;
428 }
429 $tokenDetails->generates_on = \time();
430 $tokenDetails->access_token = $apiResponse->access_token;
431 return $tokenDetails;
432 }
433
434 /**
435 * Save updated access_token to avoid unnecessary token generation
436 *
437 * @param Integer $fromID ID of Integration related form
438 * @param Integer $integrationID ID of Zoho crm Integration
439 * @param Obeject $tokenDetails refreshed token info
440 *
441 * @return null
442 */
443 protected static function _saveRefreshedToken($formID, $integrationID, $tokenDetails, $others = null)
444 {
445 if (empty($formID) || empty($integrationID)) {
446 return;
447 }
448
449 $integrationHandler = new IntegrationHandler($formID, IpTool::getUserDetail());
450 $zanalyticsDetails = $integrationHandler->getAIntegration($integrationID);
451
452 if (is_wp_error($zanalyticsDetails)) {
453 return;
454 }
455 $newDetails = json_decode($zanalyticsDetails[0]->integration_details);
456
457 $newDetails->tokenDetails = $tokenDetails;
458 if (!empty($others['workspaces'])) {
459 $newDetails->default->workspaces = $others['workspaces'];
460 }
461 if (!empty($others['tables'])) {
462 $newDetails->default->tables = $others['tables'];
463 }
464 if (!empty($others['table_headers'])) {
465 $newDetails->default->tables->headers->{$others['table']} = $others['table_headers'];
466 }
467
468 $integrationHandler->updateIntegration($integrationID, $zanalyticsDetails[0]->integration_name, 'Zoho Analytics', wp_json_encode($newDetails), 'form');
469 }
470
471 public function execute(IntegrationHandler $integrationHandler, $integrationData, $fieldValues, $entryID, $logID)
472 {
473 $integrationDetails = is_string($integrationData->integration_details) ? json_decode($integrationData->integration_details) : $integrationData->integration_details;
474
475 $tokenDetails = $integrationDetails->tokenDetails;
476 $workspace = $integrationDetails->workspace;
477 $table = $integrationDetails->table;
478 $ownerEmail = $integrationDetails->ownerEmail;
479 $dataCenter = $integrationDetails->dataCenter;
480 $fieldMap = $integrationDetails->field_map;
481 $actions = $integrationDetails->actions;
482 $defaultDataConf = $integrationDetails->default;
483
484 $entryDetails = [
485 'formId' => $this->_formID,
486 'entryId' => $entryID,
487 'fieldValues' => $fieldValues
488 ];
489
490 if (
491 empty($tokenDetails)
492 || empty($workspace)
493 || empty($table)
494 || empty($fieldMap)
495 ) {
496 $error = new WP_Error('REQ_FIELD_EMPTY', __('workspace, table, fields are required for zoho analytics api', 'bit-form'));
497 $this->_logResponse->apiResponse($logID, $this->_integrationID, 'record', 'validation', $error, $entryDetails);
498 return $error;
499 }
500
501 $requiredParams = null;
502 if ((intval($tokenDetails->generates_on) + (55 * 60)) < time()) {
503 $requiredParams['clientId'] = $integrationDetails->clientId;
504 $requiredParams['clientSecret'] = $integrationDetails->clientSecret;
505 $requiredParams['dataCenter'] = $integrationDetails->dataCenter;
506 $requiredParams['tokenDetails'] = $tokenDetails;
507 $newTokenDetails = ZohoAnalyticsHandler::_refreshAccessToken((object)$requiredParams);
508 if ($newTokenDetails) {
509 ZohoAnalyticsHandler::_saveRefreshedToken($this->_formID, $this->_integrationID, $newTokenDetails);
510 $tokenDetails = $newTokenDetails;
511 }
512 }
513
514 // $actions = $integrationDetails->actions;
515 $recordApiHelper = new RecordApiHelper($tokenDetails, $this->_integrationID, $logID, $this->_formID, $entryID);
516
517 $zanalyticsApiResponse = $recordApiHelper->executeRecordApi(
518 $workspace,
519 $table,
520 $ownerEmail,
521 $dataCenter,
522 $actions,
523 $defaultDataConf,
524 $fieldValues,
525 $fieldMap
526 );
527
528 if (is_wp_error($zanalyticsApiResponse)) {
529 return $zanalyticsApiResponse;
530 }
531 return $zanalyticsApiResponse;
532 }
533 }
534