pagantis /
prestashop
| Total Complexity | 49 |
| Total Lines | 395 |
| Duplicated Lines | 0 % |
| Changes | 6 | ||
| Bugs | 0 | Features | 1 |
Complex classes like PagantisNotifyModuleFrontController often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use PagantisNotifyModuleFrontController, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 29 | class PagantisNotifyModuleFrontController extends AbstractController |
||
| 30 | { |
||
| 31 | /** |
||
| 32 | * @var bool $processError |
||
| 33 | */ |
||
| 34 | protected $processError; |
||
| 35 | |||
| 36 | /** |
||
| 37 | * @var string $merchantOrderId |
||
| 38 | */ |
||
| 39 | protected $merchantOrderId; |
||
| 40 | |||
| 41 | /** |
||
| 42 | * @var \Cart $merchantOrder |
||
|
|
|||
| 43 | */ |
||
| 44 | protected $merchantOrder; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * @var string $pagantisOrderId |
||
| 48 | */ |
||
| 49 | protected $pagantisOrderId; |
||
| 50 | |||
| 51 | /** |
||
| 52 | * @var \Pagantis\OrdersApiClient\Model\Order $pagantisOrder |
||
| 53 | */ |
||
| 54 | protected $pagantisOrder; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * @var Pagantis\OrdersApiClient\Client $orderClient |
||
| 58 | */ |
||
| 59 | protected $orderClient; |
||
| 60 | |||
| 61 | /** |
||
| 62 | * @var mixed $config |
||
| 63 | */ |
||
| 64 | protected $config; |
||
| 65 | |||
| 66 | /** |
||
| 67 | * @var Object $jsonResponse |
||
| 68 | */ |
||
| 69 | protected $jsonResponse; |
||
| 70 | |||
| 71 | /** |
||
| 72 | * @throws Exception |
||
| 73 | */ |
||
| 74 | public function postProcess() |
||
| 75 | { |
||
| 76 | try { |
||
| 77 | $this->checkConcurrency(); |
||
| 78 | $this->getMerchantOrder(); |
||
| 79 | $this->getPagantisOrderId(); |
||
| 80 | $this->getPagantisOrder(); |
||
| 81 | $this->checkOrderStatus(); |
||
| 82 | $this->checkMerchantOrderStatus(); |
||
| 83 | $this->validateAmount(); |
||
| 84 | $this->processMerchantOrder(); |
||
| 85 | } catch (\Exception $exception) { |
||
| 86 | $this->jsonResponse = new JsonExceptionResponse(); |
||
| 87 | $this->jsonResponse->setMerchantOrderId($this->merchantOrderId); |
||
| 88 | $this->jsonResponse->setPagantisOrderId($this->pagantisOrderId); |
||
| 89 | $this->jsonResponse->setException($exception); |
||
| 90 | return $this->cancelProcess($this->jsonResponse); |
||
| 91 | } |
||
| 92 | |||
| 93 | try { |
||
| 94 | $this->jsonResponse = new JsonSuccessResponse(); |
||
| 95 | $this->jsonResponse->setMerchantOrderId($this->merchantOrderId); |
||
| 96 | $this->jsonResponse->setPagantisOrderId($this->pagantisOrderId); |
||
| 97 | $this->confirmPagantisOrder(); |
||
| 98 | } catch (\Exception $exception) { |
||
| 99 | $this->rollbackMerchantOrder(); |
||
| 100 | $this->jsonResponse = new JsonExceptionResponse(); |
||
| 101 | $this->jsonResponse->setMerchantOrderId($this->merchantOrderId); |
||
| 102 | $this->jsonResponse->setPagantisOrderId($this->pagantisOrderId); |
||
| 103 | $this->jsonResponse->setException($exception); |
||
| 104 | return $this->cancelProcess($this->jsonResponse); |
||
| 105 | } |
||
| 106 | |||
| 107 | try { |
||
| 108 | $this->unblockConcurrency(); |
||
| 109 | } catch (\Exception $exception) { |
||
| 110 | // Do nothing |
||
| 111 | } |
||
| 112 | |||
| 113 | return $this->finishProcess(false); |
||
| 114 | } |
||
| 115 | |||
| 116 | /** |
||
| 117 | * Check the concurrency of the purchase |
||
| 118 | * |
||
| 119 | * @throws Exception |
||
| 120 | */ |
||
| 121 | public function checkConcurrency() |
||
| 122 | { |
||
| 123 | $this->prepareVariables(); |
||
| 124 | $this->unblockConcurrency(); |
||
| 125 | $this->blockConcurrency($this->merchantOrderId); |
||
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Find and init variables needed to process payment |
||
| 130 | * |
||
| 131 | * @throws Exception |
||
| 132 | */ |
||
| 133 | public function prepareVariables() |
||
| 134 | { |
||
| 135 | $this->processError = false; |
||
| 136 | $callbackOkUrl = $this->context->link->getPageLink( |
||
| 137 | 'order-confirmation', |
||
| 138 | null, |
||
| 139 | null |
||
| 140 | ); |
||
| 141 | $callbackKoUrl = $this->context->link->getPageLink( |
||
| 142 | 'order', |
||
| 143 | null, |
||
| 144 | null, |
||
| 145 | array('step'=>3) |
||
| 146 | ); |
||
| 147 | try { |
||
| 148 | $this->config = array( |
||
| 149 | 'urlOK' => (Pagantis::getExtraConfig('PAGANTIS_URL_OK') !== '') ? |
||
| 150 | Pagantis::getExtraConfig('PAGANTIS_URL_OK') : $callbackOkUrl, |
||
| 151 | 'urlKO' => (Pagantis::getExtraConfig('PAGANTIS_URL_KO') !== '') ? |
||
| 152 | Pagantis::getExtraConfig('PAGANTIS_URL_KO') : $callbackKoUrl, |
||
| 153 | 'publicKey' => Configuration::get('pagantis_public_key'), |
||
| 154 | 'privateKey' => Configuration::get('pagantis_private_key'), |
||
| 155 | 'secureKey' => Tools::getValue('key'), |
||
| 156 | ); |
||
| 157 | } catch (\Exception $exception) { |
||
| 158 | throw new ConfigurationNotFoundException(); |
||
| 159 | } |
||
| 160 | |||
| 161 | $this->merchantOrderId = Tools::getValue('id_cart'); |
||
| 162 | if ($this->merchantOrderId == '') { |
||
| 163 | throw new QuoteNotFoundException(); |
||
| 164 | } |
||
| 165 | |||
| 166 | |||
| 167 | if (!($this->config['secureKey'] && $this->merchantOrderId && Module::isEnabled(self::PAGANTIS_CODE))) { |
||
| 168 | // This exception is only for Prestashop |
||
| 169 | throw new UnknownException('Module may not be enabled'); |
||
| 170 | } |
||
| 171 | } |
||
| 172 | |||
| 173 | /** |
||
| 174 | * Retrieve the merchant order by id |
||
| 175 | * |
||
| 176 | * @throws Exception |
||
| 177 | */ |
||
| 178 | public function getMerchantOrder() |
||
| 188 | } |
||
| 189 | } |
||
| 190 | |||
| 191 | /** |
||
| 192 | * Find PAGANTIS Order Id in AbstractController::PAGANTIS_ORDERS_TABLE |
||
| 193 | * |
||
| 194 | * @throws Exception |
||
| 195 | */ |
||
| 196 | private function getPagantisOrderId() |
||
| 208 | } |
||
| 209 | } |
||
| 210 | |||
| 211 | /** |
||
| 212 | * Find PAGANTIS Order in Orders Server using Pagantis\OrdersApiClient |
||
| 213 | * |
||
| 214 | * @throws Exception |
||
| 215 | */ |
||
| 216 | private function getPagantisOrder() |
||
| 222 | } |
||
| 223 | } |
||
| 224 | |||
| 225 | /** |
||
| 226 | * Compare statuses of merchant order and PAGANTIS order, witch have to be the same. |
||
| 227 | * |
||
| 228 | * @throws Exception |
||
| 229 | */ |
||
| 230 | public function checkOrderStatus() |
||
| 231 | { |
||
| 232 | if ($this->pagantisOrder->getStatus() === PagantisModelOrder::STATUS_CONFIRMED) { |
||
| 233 | $this->jsonResponse = new JsonSuccessResponse(); |
||
| 234 | $this->jsonResponse->setMerchantOrderId($this->merchantOrderId); |
||
| 235 | $this->jsonResponse->setPmtOrderId($this->pagantisOrderId); |
||
| 236 | return $this->finishProcess(false); |
||
| 237 | } |
||
| 238 | |||
| 239 | if ($this->pagantisOrder->getStatus() !== PagantisModelOrder::STATUS_AUTHORIZED) { |
||
| 240 | $status = '-'; |
||
| 241 | if ($this->pagantisOrder instanceof \Pagantis\OrdersApiClient\Model\Order) { |
||
| 242 | $status = $this->pagantisOrder->getStatus(); |
||
| 243 | } |
||
| 244 | throw new WrongStatusException($status); |
||
| 245 | } |
||
| 246 | } |
||
| 247 | |||
| 248 | /** |
||
| 249 | * Check that the merchant order was not previously processes and is ready to be paid |
||
| 250 | * |
||
| 251 | * @throws Exception |
||
| 252 | */ |
||
| 253 | public function checkMerchantOrderStatus() |
||
| 254 | { |
||
| 255 | if ($this->merchantOrder->orderExists() !== false) { |
||
| 256 | throw new WrongStatusException('already_processed'); |
||
| 257 | } |
||
| 258 | } |
||
| 259 | |||
| 260 | /** |
||
| 261 | * Check that the merchant order and the order in PAGANTIS have the same amount to prevent hacking |
||
| 262 | * |
||
| 263 | * @throws Exception |
||
| 264 | */ |
||
| 265 | public function validateAmount() |
||
| 272 | } |
||
| 273 | } |
||
| 274 | |||
| 275 | /** |
||
| 276 | * Process the merchant order and notify client |
||
| 277 | * |
||
| 278 | * @throws Exception |
||
| 279 | */ |
||
| 280 | public function processMerchantOrder() |
||
| 297 | } |
||
| 298 | } |
||
| 299 | |||
| 300 | /** |
||
| 301 | * Confirm the order in PAGANTIS |
||
| 302 | * |
||
| 303 | * @throws Exception |
||
| 304 | */ |
||
| 305 | private function confirmPagantisOrder() |
||
| 322 | } |
||
| 323 | } |
||
| 324 | |||
| 325 | /** |
||
| 326 | * Leave the merchant order as it was previously |
||
| 327 | * |
||
| 328 | * @throws Exception |
||
| 329 | */ |
||
| 330 | public function rollbackMerchantOrder() |
||
| 332 | // Do nothing because the order is created only when the purchase was successfully |
||
| 333 | } |
||
| 334 | |||
| 335 | /** |
||
| 336 | * Lock the concurrency to prevent duplicated inputs |
||
| 337 | * |
||
| 338 | * @param $orderId |
||
| 339 | * @throws Exception |
||
| 340 | */ |
||
| 341 | protected function blockConcurrency($orderId) |
||
| 342 | { |
||
| 343 | try { |
||
| 344 | Db::getInstance()->insert('pagantis_cart_process', array('id' => $orderId, 'timestamp' => (time()))); |
||
| 345 | } catch (\Exception $exception) { |
||
| 346 | throw new ConcurrencyException(); |
||
| 347 | } |
||
| 348 | } |
||
| 349 | |||
| 350 | /** |
||
| 351 | * Unlock the concurrency |
||
| 352 | * |
||
| 353 | * @throws Exception |
||
| 354 | */ |
||
| 355 | protected function unblockConcurrency() |
||
| 356 | { |
||
| 357 | try { |
||
| 358 | Db::getInstance()->delete('pagantis_cart_process', 'timestamp < ' . (time() - 6)); |
||
| 359 | } catch (\Exception $exception) { |
||
| 360 | throw new ConcurrencyException(); |
||
| 361 | } |
||
| 362 | } |
||
| 363 | |||
| 364 | /** |
||
| 365 | * Do all the necessary actions to cancel the confirmation process in case of error |
||
| 366 | * 1. Unblock concurrency |
||
| 367 | * 2. Save log |
||
| 368 | * |
||
| 369 | * @param String|null $response Response as json |
||
| 370 | * |
||
| 371 | */ |
||
| 372 | public function cancelProcess($response = null) |
||
| 373 | { |
||
| 374 | if ($this->merchantOrder && $this->processError === true) { |
||
| 375 | sleep(5); |
||
| 376 | $id = (!is_null($this->pagantisOrder))?$this->pagantisOrder->getId():null; |
||
| 377 | $status = (!is_null($this->pagantisOrder))?$this->pagantisOrder->getStatus():null; |
||
| 378 | $this->module->validateOrder( |
||
| 379 | $this->merchantOrderId, |
||
| 380 | Configuration::get('PS_OS_ERROR'), |
||
| 381 | $this->merchantOrder->getOrderTotal(true), |
||
| 382 | $this->module->displayName, |
||
| 383 | ' pagantisOrderId: ' . $id. |
||
| 384 | ' pagantisOrderStatus: '. $status, |
||
| 385 | null, |
||
| 386 | null, |
||
| 387 | false, |
||
| 388 | $this->config['secureKey'] |
||
| 389 | ); |
||
| 390 | } |
||
| 391 | |||
| 392 | $debug = debug_backtrace(); |
||
| 393 | $method = $debug[1]['function']; |
||
| 394 | $line = $debug[1]['line']; |
||
| 395 | $this->saveLog(array( |
||
| 396 | 'message' => $response, |
||
| 397 | 'method' => $method, |
||
| 398 | 'file' => __FILE__, |
||
| 399 | 'line' => $line, |
||
| 400 | 'code' => 200 |
||
| 401 | )); |
||
| 402 | return $this->finishProcess(true); |
||
| 403 | } |
||
| 404 | |||
| 405 | /** |
||
| 406 | * Redirect the request to the e-commerce or show the output in json |
||
| 407 | * |
||
| 408 | * @param bool $error |
||
| 409 | */ |
||
| 410 | public function finishProcess($error = true) |
||
| 424 | } |
||
| 425 | } |
||
| 426 |
Loading history...
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"], you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths