| @@ -8,9 +8,13 @@ | ||
| 8 | 8 | namespace BitCode\BitForm\Core\Integration; |
| 9 | 9 | |
| 10 | 10 | use BitCode\BitForm\Core\Database\FormEntryModel; |
| 11 | 11 | use BitCode\BitForm\Core\Database\FormModel; |
| 12 | +use BitCode\BitForm\Core\Util\ApiResponse; | |
| 13 | +use BitCode\BitForm\Core\Util\IpTool; | |
| 14 | +use BitCode\BitForm\Core\Util\Log; | |
| 12 | 15 | use BitCode\BitForm\Core\Util\SmartTags; |
| 16 | +use BitCode\BitForm\Core\Util\Utilities; | |
| 13 | 17 | /** |
| 14 | 18 | * Provides details of available integration and helps to |
| 15 | 19 | * execute available integrations |
| 16 | 20 | */ |
| @@ -16,17 +20,31 @@ | ||
| 16 | 20 | */ |
| 17 | 21 | |
| 18 | 22 | use FilesystemIterator; |
| 19 | 23 | |
| 20 | -final class Integrations { | |
| 24 | +final class Integrations | |
| 25 | +{ | |
| 21 | 26 | public $integrations = []; |
| 27 | + private static $_instance = null; | |
| 22 | 28 | |
| 23 | 29 | /** |
| 24 | 30 | * Undocumented function |
| 31 | + */ | |
| 32 | + public static function getInstance() | |
| 33 | + { | |
| 34 | + if (null === self::$_instance) { | |
| 35 | + self::$_instance = new Integrations(); | |
| 36 | + } | |
| 37 | + return self::$_instance; | |
| 38 | + } | |
| 39 | + | |
| 40 | + /** | |
| 41 | + * Undocumented function | |
| 25 | 42 | * |
| 26 | - * @return all | |
| 43 | + * @return array | |
| 27 | 44 | */ |
| 28 | - public function getAllIntegrations() { | |
| 45 | + public function getAllIntegrations() | |
| 46 | + { | |
| 29 | 47 | return $this->allIntegrations(); |
| 30 | 48 | } |
| 31 | 49 | |
| 32 | 50 | /** |
| @@ -31,20 +49,21 @@ | ||
| 31 | 49 | |
| 32 | 50 | /** |
| 33 | 51 | * Undocumented function |
| 34 | 52 | * |
| 35 | - * @return void | |
| 53 | + * @return array | |
| 36 | 54 | */ |
| 37 | - protected function allIntegrations() { | |
| 55 | + protected function allIntegrations() | |
| 56 | + { | |
| 38 | 57 | $dirs = new FilesystemIterator(__DIR__); |
| 39 | 58 | foreach ($dirs as $dirInfo) { |
| 40 | 59 | if ($dirInfo->isDir()) { |
| 41 | - $integartionBaseName = basename($dirInfo); | |
| 60 | + $integrationsBaseName = basename($dirInfo); | |
| 42 | 61 | if ( |
| 43 | - file_exists(__DIR__ . '/' . $integartionBaseName) | |
| 44 | - && file_exists(__DIR__ . '/' . $integartionBaseName . '/' . $integartionBaseName . 'Handler.php') | |
| 62 | + file_exists(__DIR__ . '/' . $integrationsBaseName) | |
| 63 | + && file_exists(__DIR__ . '/' . $integrationsBaseName . '/' . $integrationsBaseName . 'Handler.php') | |
| 45 | 64 | ) { |
| 46 | - $integrations[] = $integartionBaseName; | |
| 65 | + $integrations[] = $integrationsBaseName; | |
| 47 | 66 | } |
| 48 | 67 | } |
| 49 | 68 | } |
| 50 | 69 | return $integrations; |
| @@ -52,19 +71,32 @@ | ||
| 52 | 71 | |
| 53 | 72 | /** |
| 54 | 73 | * Checks a Integration Exists or not |
| 55 | 74 | * |
| 56 | - * @param String $name Name of Integration | |
| 57 | - * @return boolean | |
| 75 | + * @param string $name Name of Integration | |
| 76 | + * @return boolean | string | |
| 58 | 77 | */ |
| 59 | - protected static function isExists($name) { | |
| 60 | - if (file_exists(__DIR__ . '/' . $name) && file_exists(__DIR__ . '/' . $name . '/' . $name . 'Handler.php')) { | |
| 61 | - return __NAMESPACE__ . "\\{$name}\\{$name}Handler"; | |
| 62 | - } elseif (class_exists("BitCode\\BitFormPro\\Integration\\{$name}\\{$name}Handler")) { | |
| 63 | - return "BitCode\\BitFormPro\\Integration\\{$name}\\{$name}Handler"; | |
| 64 | - } else { | |
| 78 | + protected static function isExists($name) | |
| 79 | + { | |
| 80 | + $path = Utilities::getRealPath(__DIR__, $name); | |
| 81 | + if (!empty($path) && $fileName = Utilities::getRealPath(__DIR__ . "/{$path}", "{$name}Handler.php")) { | |
| 82 | + $className = Utilities::getFileNameExceptExtension($fileName); | |
| 83 | + return __NAMESPACE__ . "\\{$path}\\{$className}"; | |
| 84 | + } | |
| 85 | + | |
| 86 | + if (!defined('BITFORMPRO_PLUGIN_DIR_PATH')) { | |
| 65 | 87 | return false; |
| 66 | 88 | } |
| 89 | + | |
| 90 | + $proPath = BITFORMPRO_PLUGIN_DIR_PATH . '/includes/Integration'; | |
| 91 | + $proNamespace = 'BitCode\\BitFormPro\\Integration'; | |
| 92 | + $path = Utilities::getRealPath($proPath, $name); | |
| 93 | + if (!empty($path) && $fileName = Utilities::getRealPath("{$proPath}/{$path}", "{$name}Handler.php")) { | |
| 94 | + $className = Utilities::getFileNameExceptExtension($fileName); | |
| 95 | + return "{$proNamespace}\\{$path}\\{$className}"; | |
| 96 | + } | |
| 97 | + | |
| 98 | + return false; | |
| 67 | 99 | } |
| 68 | 100 | |
| 69 | 101 | /** |
| 70 | 102 | * This function helps to get single integration information |
| @@ -70,22 +102,24 @@ | ||
| 70 | 102 | * This function helps to get single integration information |
| 71 | 103 | * |
| 72 | 104 | * @return bool setIntegration() |
| 73 | 105 | */ |
| 74 | - public function getIntegration($integartionBaseName) { | |
| 75 | - return $this->setIntegration($integartionBaseName); | |
| 106 | + public function getIntegration($integrationBaseName) | |
| 107 | + { | |
| 108 | + return $this->setIntegration($integrationBaseName); | |
| 76 | 109 | } |
| 77 | 110 | |
| 78 | - public function registerAjax() { | |
| 111 | + public function registerAjax() | |
| 112 | + { | |
| 79 | 113 | $dirs = new FilesystemIterator(__DIR__); |
| 80 | 114 | foreach ($dirs as $dirInfo) { |
| 81 | 115 | if ($dirInfo->isDir()) { |
| 82 | - $integartionBaseName = basename($dirInfo); | |
| 116 | + $integrationBaseName = basename($dirInfo); | |
| 83 | 117 | if ( |
| 84 | - file_exists(__DIR__ . '/' . $integartionBaseName) | |
| 85 | - && file_exists(__DIR__ . '/' . $integartionBaseName . '/' . $integartionBaseName . 'Handler.php') | |
| 118 | + file_exists(__DIR__ . '/' . $integrationBaseName) | |
| 119 | + && file_exists(__DIR__ . '/' . $integrationBaseName . '/' . $integrationBaseName . 'Handler.php') | |
| 86 | 120 | ) { |
| 87 | - $integration = __NAMESPACE__ . "\\{$integartionBaseName}\\{$integartionBaseName}Handler"; | |
| 121 | + $integration = __NAMESPACE__ . "\\{$integrationBaseName}\\{$integrationBaseName}Handler"; | |
| 88 | 122 | if (method_exists($integration, 'registerAjax')) { |
| 89 | 123 | $integration::registerAjax(); |
| 90 | 124 | // (new $integration(0, 0))->registerAjax(); |
| 91 | 125 | } |
| @@ -95,9 +129,10 @@ | ||
| 95 | 129 | } |
| 96 | 130 | } |
| 97 | 131 | } |
| 98 | 132 | |
| 99 | - protected static function entryDeleted($formId, $entryId) { | |
| 133 | + protected static function entryDeleted($formId, $entryId) | |
| 134 | + { | |
| 100 | 135 | $formModel = new FormModel(); |
| 101 | 136 | $formContent = $formModel->get( |
| 102 | 137 | [ |
| 103 | 138 | 'id', |
| @@ -122,9 +157,10 @@ | ||
| 122 | 157 | } |
| 123 | 158 | } |
| 124 | 159 | } |
| 125 | 160 | |
| 126 | - public static function specialTagFields($fieldMap) { | |
| 161 | + public static function specialTagFields($fieldMap) | |
| 162 | + { | |
| 127 | 163 | $specialTagFieldValue = []; |
| 128 | 164 | |
| 129 | 165 | foreach ($fieldMap as $value) { |
| 130 | 166 | $triggerValue = $value->formField; |
| @@ -135,37 +171,90 @@ | ||
| 135 | 171 | |
| 136 | 172 | /** |
| 137 | 173 | * This function helps to execute Integration |
| 138 | 174 | * |
| 139 | - * @param Array $integrations List of integrstion to execute. | |
| 175 | + * @param array $integrations List of integration to execute. | |
| 140 | 176 | * Element will be json string like {"id":1} |
| 141 | - * @param Array $fieldValues Values of submitted fields | |
| 142 | - * @param Integer $formID ID of current form | |
| 177 | + * @param array $fieldValues Values of submitted fields | |
| 178 | + * @param integer $formID ID of current form | |
| 143 | 179 | * |
| 144 | 180 | * @return void Nothing to return |
| 145 | 181 | */ |
| 146 | - public static function executeIntegrations($integrations, $fieldValues, $formID, $logID = null, $entryID = 0) { | |
| 182 | + public static function executeIntegrations($integrations, $fieldValues, $formID, $logID = null, $entryID = 0) | |
| 183 | + { | |
| 147 | 184 | $integrationHandler = new IntegrationHandler($formID); |
| 185 | + $logResponse = new ApiResponse(); | |
| 186 | + $intThatNeedNoFileHandling = ['ACF', 'MetaBox', 'Pods']; //these takes raw file and upload it | |
| 187 | + $baseFieldValues = $fieldValues; | |
| 188 | + $entryDetails = [ | |
| 189 | + 'formId' => $formID, | |
| 190 | + 'entryId' => $entryID, | |
| 191 | + 'fieldValues' => $fieldValues | |
| 192 | + ]; | |
| 148 | 193 | if (is_array($integrations)) { |
| 149 | 194 | foreach ($integrations as $integrationIDStr) { |
| 150 | 195 | if (!is_string($integrationIDStr)) { |
| 151 | 196 | return; |
| 152 | 197 | } |
| 153 | - $integrationID = intval(json_decode($integrationIDStr)->id, 10); | |
| 198 | + $currentFieldValues = $baseFieldValues; | |
| 199 | + $integrationID = intval(Utilities::jsonObj($integrationIDStr)->id ?? 0, 10); | |
| 154 | 200 | if (!empty($integrationID) && is_int($integrationID)) { |
| 155 | 201 | $integrationResult |
| 156 | - = $integrationHandler->getAIntegration($integrationID); | |
| 202 | + = $integrationHandler->getAIntegration($integrationID); | |
| 157 | 203 | $integrationDetails = is_wp_error($integrationResult) ? null : $integrationResult[0]; |
| 204 | + // Honor enable/disable: a disabled integration is never executed. | |
| 205 | + if (!is_null($integrationDetails) && isset($integrationDetails->status) && empty($integrationDetails->status)) { | |
| 206 | + continue; | |
| 207 | + } | |
| 158 | 208 | $integrationName = is_null($integrationDetails) ? null : ucfirst(str_replace(' ', '', $integrationDetails->integration_type)); |
| 209 | + if ('Brevo(SendinBlue)' === $integrationName) { | |
| 210 | + $integrationName = 'SendinBlue'; | |
| 211 | + } | |
| 159 | 212 | if (!is_null($integrationName) && static::isExists($integrationName)) { |
| 213 | + if (!in_array($integrationName, $intThatNeedNoFileHandling)) { | |
| 214 | + $currentFieldValues = IntegrationHandler::handleFileUrl($currentFieldValues, $formID, $entryID); | |
| 215 | + } | |
| 160 | 216 | $integration = static::isExists($integrationName); |
| 161 | 217 | $handler = new $integration($integrationID, $formID); |
| 162 | 218 | $integDetails = is_string($integrationDetails->integration_details) ? json_decode($integrationDetails->integration_details) : $integrationDetails->integration_details; |
| 163 | 219 | if (isset($integDetails->field_map)) { |
| 164 | 220 | $sptagData = self::specialTagFields($integDetails->field_map); |
| 165 | - $fieldValues = $fieldValues + $sptagData; | |
| 221 | + $currentFieldValues = $currentFieldValues + $sptagData; | |
| 166 | 222 | } |
| 167 | - $handler->execute($integrationHandler, $integrationDetails, $fieldValues, $entryID, $logID); | |
| 223 | + // fresh time budget per handler: a chain of slow integrations (30s HTTP | |
| 224 | + // timeout each) must not be killed by max_execution_time mid-loop | |
| 225 | + if (\function_exists('set_time_limit') && false === strpos((string) ini_get('disable_functions'), 'set_time_limit')) { | |
| 226 | + set_time_limit(60); | |
| 227 | + } | |
| 228 | + try { | |
| 229 | + $handler->execute($integrationHandler, $integrationDetails, $currentFieldValues, $entryID, $logID); | |
| 230 | + } catch (\Throwable $executionError) { | |
| 231 | + // one failing integration must not abort the remaining ones | |
| 232 | + Log::debug_log('[+] Integration execution threw: ' . $executionError->getMessage()); | |
| 233 | + $logResponse->apiResponse( | |
| 234 | + $logID, | |
| 235 | + $integrationID, | |
| 236 | + ['type' => 'record', 'type_name' => $integrationName ?: 'Integration'], | |
| 237 | + 'errors', | |
| 238 | + $executionError->getMessage(), | |
| 239 | + $entryDetails | |
| 240 | + ); | |
| 241 | + } | |
| 242 | + } else { | |
| 243 | + do_action('bitform_integration_run_failure', $integrationID, $formID); | |
| 244 | + | |
| 245 | + $errorMsg = apply_filters('bitform_filter_integration_run_failure_message', __('Integration execution failed', 'bit-form'), $integrationID, $formID); | |
| 246 | + | |
| 247 | + Log::debug_log('[+] Integration execution failed: ' . $errorMsg); | |
| 248 | + | |
| 249 | + $logResponse->apiResponse( | |
| 250 | + $logID, | |
| 251 | + $integrationID, | |
| 252 | + ['type' => 'record', 'type_name' => $integrationName || 'Integration'], | |
| 253 | + 'errors', | |
| 254 | + $errorMsg, | |
| 255 | + $entryDetails | |
| 256 | + ); | |
| 168 | 257 | } |
| 169 | 258 | } |
| 170 | 259 | } |
| 171 | 260 | } |
| @@ -170,14 +259,91 @@ | ||
| 170 | 259 | } |
| 171 | 260 | } |
| 172 | 261 | } |
| 173 | 262 | |
| 174 | - public static function integrationExecutionHelper($integrations, $fieldValue, $formID, $entryID, $logID) { | |
| 263 | + public static function integrationExecutionHelper($integrations, $fieldValue, $formID, $entryID, $logID) | |
| 264 | + { | |
| 175 | 265 | if (empty($integrations) || empty($formID)) { |
| 176 | 266 | return; |
| 177 | 267 | } |
| 268 | + $trnasientData = get_transient("bitform_trigger_transient_{$entryID}"); | |
| 269 | + $trnasientData = is_string($trnasientData) ? json_decode($trnasientData) : $trnasientData; | |
| 270 | + if (!empty($trnasientData['fields'])) { | |
| 271 | + $fieldValue = array_merge($fieldValue, $trnasientData['fields']); | |
| 272 | + } | |
| 178 | 273 | foreach ($integrations as $key => $value) { |
| 179 | 274 | self::executeIntegrations($value, $fieldValue, $formID, $logID, $entryID); |
| 180 | 275 | } |
| 181 | 276 | self::entryDeleted($formID, $entryID); |
| 277 | + } | |
| 278 | + | |
| 279 | + /** | |
| 280 | + * This function helps to save connected integration app | |
| 281 | + * | |
| 282 | + * @return wp_error | mixed | |
| 283 | + */ | |
| 284 | + public function saveConnectedIntegrationApp($appConfig) | |
| 285 | + { | |
| 286 | + // error_log('[+] saveConnectedIntegrationApp: ' . print_r($appConfig, true)); | |
| 287 | + $connectionName = $appConfig->name; | |
| 288 | + $connectionType = $appConfig->type; | |
| 289 | + // $connectionDetails = wp_json_encode($appConfig); | |
| 290 | + | |
| 291 | + if (empty($appConfig->details)) { | |
| 292 | + unset($appConfig->name, $appConfig->id); | |
| 293 | + | |
| 294 | + $connectionDetails = !is_string($appConfig) ? | |
| 295 | + wp_json_encode($appConfig) : $appConfig; | |
| 296 | + } else { | |
| 297 | + $connectionDetails = !is_string($appConfig->details) ? | |
| 298 | + wp_json_encode($appConfig->details) : $appConfig->details; | |
| 299 | + } | |
| 300 | + $connectionCategory = 'connected_integration_apps'; | |
| 301 | + | |
| 302 | + // saveIntegration reads user_details['id'|'ip'|'time']; without them the insert | |
| 303 | + // raises null-offset warnings and stores null user_id/created_at | |
| 304 | + $integrationHandler = new IntegrationHandler(0, IpTool::getUserDetail()); | |
| 305 | + | |
| 306 | + return $integrationHandler->saveIntegration($connectionName, $connectionType, $connectionDetails, $connectionCategory); | |
| 307 | + } | |
| 308 | + | |
| 309 | + // get connectd integration app | |
| 310 | + public function getConnectedIntegrationApp($integration_type = null) | |
| 311 | + { | |
| 312 | + $connectionCategory = 'connected_integration_apps'; | |
| 313 | + | |
| 314 | + $integrationHandler = new IntegrationHandler(0); | |
| 315 | + $allConnectedIntegApps = $integrationHandler->getAllIntegration($connectionCategory, $integration_type); | |
| 316 | + | |
| 317 | + if (!is_wp_error($allConnectedIntegApps)) { | |
| 318 | + foreach ($allConnectedIntegApps as $integrationkey => $integrationValue) { | |
| 319 | + $integrationData = [ | |
| 320 | + 'id' => $integrationValue->id, | |
| 321 | + 'name' => $integrationValue->integration_name, | |
| 322 | + 'type' => $integrationValue->integration_type, | |
| 323 | + ]; | |
| 324 | + $allConnectedIntegApps[$integrationkey]->integration_details = wp_json_encode(array_merge( | |
| 325 | + $integrationData, | |
| 326 | + is_string($integrationValue->integration_details) ? | |
| 327 | + (array) json_decode($integrationValue->integration_details) : | |
| 328 | + $integrationValue->integration_details | |
| 329 | + )); | |
| 330 | + } | |
| 331 | + } | |
| 332 | + return $allConnectedIntegApps; | |
| 333 | + } | |
| 334 | + | |
| 335 | + public function deleteConnectedApp($appId) | |
| 336 | + { | |
| 337 | + $integrationHandler = new IntegrationHandler(0); | |
| 338 | + | |
| 339 | + return $integrationHandler->deleteIntegration($appId); | |
| 340 | + } | |
| 341 | + | |
| 342 | + public function renameConnectedApp($appId, $name) | |
| 343 | + { | |
| 344 | + // User details carry the time renameConnectedApp() stamps into updated_at. | |
| 345 | + $integrationHandler = new IntegrationHandler(0, IpTool::getUserDetail()); | |
| 346 | + | |
| 347 | + return $integrationHandler->renameConnectedApp($appId, $name); | |
| 182 | 348 | } |
| 183 | 349 | } |