notifyController

Complexity

Total Complexity

66

Size/Duplication

Total Lines	560
Duplicated Lines	0 %

Importance

Changes	9
Bugs	0	Features	0

27 Methods

Rating	Name	Duplication	Size	Complexity
A	getPagantisOrder()	0	10	2
A	unblockConcurrency()	0	16	4
A	getPagantisOrderId()	0	14	3
A	confirmInformation()	0	24	3
A	__construct()	0	3	1
A	checkConcurrency()	0	6	1
A	checkOrderStatus()	0	14	4
A	confirmPagantisOrder()	0	18	3
A	validateAmount()	0	7	2
A	getMerchantOrder()	0	6	2
A	checkConcurrencyTable()	0	11	2
A	checkMerchantOrderStatus()	0	6	2
A	getQuoteId()	0	4	2
B	processInformation()	0	44	6
A	rollbackMerchantOrder()	0	13	1
A	getExtraConfig()	0	14	3
A	getOrigin()	0	3	1
A	setOrderStatus()	0	3	1
A	updateBdInfo()	0	28	3
B	blockConcurrency()	0	57	8
A	getOrderStatus()	0	3	1
A	setOscommerceOrderId()	0	3	1
A	setOrigin()	0	3	1
A	checkPagantisStatus()	0	19	5
A	getOscommerceOrderId()	0	3	1
A	findOscommerceOrderId()	0	12	1
A	insertLog()	0	10	2

<?php

use Pagantis\OrdersApiClient\Client;
use Pagantis\ModuleUtils\Exception\AlreadyProcessedException;
use Pagantis\ModuleUtils\Exception\AmountMismatchException;
use Pagantis\ModuleUtils\Exception\MerchantOrderNotFoundException;
use Pagantis\ModuleUtils\Exception\NoIdentificationException;
use Pagantis\ModuleUtils\Exception\OrderNotFoundException;
use Pagantis\ModuleUtils\Exception\QuoteNotFoundException;
use Pagantis\ModuleUtils\Exception\UnknownException;
use Pagantis\ModuleUtils\Exception\WrongStatusException;
use Pagantis\ModuleUtils\Model\Response\JsonSuccessResponse;
use Pagantis\ModuleUtils\Model\Response\JsonExceptionResponse;
use Pagantis\ModuleUtils\Exception\ConcurrencyException;
use Pagantis\ModuleUtils\Model\Log\LogEntry;
use Pagantis\OrdersApiClient\Model\Order;

define('TABLE_PAGANTIS_LOG', 'pagantis_log');
define('TABLE_PAGANTIS_CONFIG', 'pagantis_config');
define('TABLE_PAGANTIS_ORDERS', 'pagantis_order');
define('TABLE_PAGANTIS_CONCURRENCY', 'pagantis_concurrency');

class notifyController
{
    /** Seconds to expire a locked request */
    const CONCURRENCY_TIMEOUT = 10;

    /** @var mixed $pagantisOrder */
    protected $pagantisOrder;

    /** @var $string $origin */

The doc comment $string at position 0 could not be parsed: Unknown type name '$string' at position 0 in $string.

    public $origin;

    /** @var $string */

The doc comment $string at position 0 could not be parsed: Unknown type name '$string' at position 0 in $string.

    public $order;

    /** @var mixed $oscommerceOrderId */
    protected $oscommerceOrderId = '';

    /** @var mixed $cfg */
    protected $cfg;

    /** @var Client $orderClient */
    protected $orderClient;

    /** @var Order $oscommerceOrder */
    protected $oscommerceOrder;

    /** @var mixed $pagantisOrderId */
    protected $pagantisOrderId = '';

    /** @var array $extraConfig */
    protected $extraConfig;

    /**
     * notifyController constructor.
     */
    public function __construct()
    {
        $this->extraConfig = $this->getExtraConfig();
    }

    /**
     * Validation vs PagantisClient
     *
     * @return array|Array_

The type Array_ was not found. Maybe you did not declare it correctly or list all dependencies?

     * @throws Exception
     */
    public function processInformation()
    {
        require_once('vendor/autoload.php');
        try {
            $this->checkConcurrency();
            $this->getMerchantOrder();
            $this->getPagantisOrderId();
            $this->getPagantisOrder();
            $this->checkOrderStatus();
            $this->checkMerchantOrderStatus();
            $this->validateAmount();
            //$this->processMerchantOrder(); //ESTE PASO SE HACE EN EL CHECKOUT_PROCESS
        } catch (\Exception $exception) {
            $this->unblockConcurrency($this->oscommerceOrderId);
            $jsonResponse = new JsonExceptionResponse();
            $jsonResponse->setMerchantOrderId($this->merchantOrderId);
            $jsonResponse->setPagantisOrderId($this->pagantisOrderId);
            $jsonResponse->setException($exception);
            $this->insertLog($exception);

            if ($this->extraConfig['PAGANTIS_URL_KO'] =! '') {
                $koUrl = $this->extraConfig['PAGANTIS_URL_KO'];
            } else {
                $koUrl = trim(tep_href_link(FILENAME_CHECKOUT_SHIPPING, '', 'SSL', false));

The function tep_href_link was not found. Maybe you did not declare it correctly or list all dependencies?

The constant FILENAME_CHECKOUT_SHIPPING was not found. Maybe you did not declare it correctly or list all dependencies?

            }

            if ($this->origin == 'notify') {
                $jsonResponse->printResponse();
            } else {
                if ($exception->getMessage() == AlreadyProcessedException::ERROR_MESSAGE) {
                    if ($this->extraConfig['PAGANTIS_URL_OK']!='') {
                        $confirmationUrl = $this->extraConfig['PAGANTIS_URL_OK'];
                        $confirmationUrl.="?order_id=$this->merchantOrderId";
                    } else {
                        $confirmationUrl = trim(tep_href_link(FILENAME_ACCOUNT_HISTORY_INFO, '', 'SSL', false));

The constant FILENAME_ACCOUNT_HISTORY_INFO was not found. Maybe you did not declare it correctly or list all dependencies?

                        $confirmationUrl.="?order_id=$this->merchantOrderId";
                    }

                    header("Location: $confirmationUrl");
                    exit;
                }

                header("Location: $koUrl");
                exit;
            }
        }
    }

    public function confirmInformation()
    {
        try {
            $this->confirmPagantisOrder();
            $this->updateBdInfo();
            $jsonResponse = new JsonSuccessResponse();
            $jsonResponse->setMerchantOrderId($this->merchantOrderId);
            $jsonResponse->setPagantisOrderId($this->pagantisOrderId);
            $this->unblockConcurrency($this->oscommerceOrderId);
        } catch (\Exception $exception) {
            $this->rollbackMerchantOrder();
            $this->unblockConcurrency($this->oscommerceOrderId);
            $jsonResponse = new JsonExceptionResponse();
            $jsonResponse->setMerchantOrderId($this->merchantOrderId);
            $jsonResponse->setPagantisOrderId($this->pagantisOrderId);
            $jsonResponse->setException($exception);
            $jsonResponse->toJson();
            $this->insertLog($exception);
        }

        if ($this->origin == 'notify') {
            $jsonResponse->printResponse();
        } else {
            return $jsonResponse;
        }
    }

    /**
     * COMMON FUNCTIONS
     */

    /**
     * @throws Exception
     */
    private function checkConcurrency()
    {
        $this->getQuoteId();
        $this->checkConcurrencyTable();
        $this->unblockConcurrency();
        $this->blockConcurrency();
    }

    /**
     * @throws MerchantOrderNotFoundException
     */
    private function getMerchantOrder()
    {
        global $order;
        $this->oscommerceOrder = $order;
        if (!isset($order->info)) {
            throw new MerchantOrderNotFoundException();
        }
    }

    /**
     * @throws NoIdentificationException
     */
    private function getPagantisOrderId()
    {
        $query = sprintf(
            "select pagantis_order_id from %s where os_order_reference='%s'",
            TABLE_PAGANTIS_ORDERS,
            $this->oscommerceOrderId
        );
        $resultsSelect = tep_db_query($query);

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

        while ($orderRow = tep_db_fetch_array($resultsSelect)) {

The function tep_db_fetch_array was not found. Maybe you did not declare it correctly or list all dependencies?

            $this->pagantisOrderId = $orderRow['pagantis_order_id'];
        }

        if ($this->pagantisOrderId == '') {
            throw new NoIdentificationException();
        }
    }

    /**
     * @throws OrderNotFoundException
     */
    private function getPagantisOrder()
    {
        try {
            $publicKey     = trim(MODULE_PAYMENT_PAGANTIS_PK);

The constant MODULE_PAYMENT_PAGANTIS_PK was not found. Maybe you did not declare it correctly or list all dependencies?

            $secretKey     = trim(MODULE_PAYMENT_PAGANTIS_SK);

The constant MODULE_PAYMENT_PAGANTIS_SK was not found. Maybe you did not declare it correctly or list all dependencies?

            $this->orderClient   = new \Pagantis\OrdersApiClient\Client($publicKey, $secretKey);
            /** @var Pagantis\OrdersApiClient\Model\Order pagantisOrder */
            $this->pagantisOrder = $this->orderClient->getOrder($this->pagantisOrderId);
        } catch (\Exception $e) {
            throw new OrderNotFoundException();
        }
    }

    /**
     * @throws AlreadyProcessedException
     * @throws WrongStatusException
     */
    private function checkOrderStatus()
    {
        try {
            $this->checkPagantisStatus(array('AUTHORIZED'));
        } catch (\Exception $e) {
            if ($this->findOscommerceOrderId()!='') {
                throw new AlreadyProcessedException();
            } else {
                if ($this->pagantisOrder instanceof \Pagantis\OrdersApiClient\Model\Order) {
                    $status = $this->pagantisOrder->getStatus();
                } else {
                    $status = '-';
                }
                throw new WrongStatusException($status);
            }
        }
    }

    /**
     * @throws AlreadyProcessedException
     */
    private function checkMerchantOrderStatus()
    {
        global $order;

        if ($order->info['order_status']!=='1') {
            throw new AlreadyProcessedException();
        }
    }

    /**
     * @throws AmountMismatchException
     */
    private function validateAmount()
    {
        $pagantisAmount = $this->pagantisOrder->getShoppingCart()->getTotalAmount();
        $ocAmount = intval($this->oscommerceOrder->info['total'] * 100);

The property info does not seem to exist on Pagantis\OrdersApiClient\Model\Order.

        if ($pagantisAmount != $ocAmount) {
            throw new AmountMismatchException($pagantisAmount, $ocAmount);
        }
    }

    /**
     * @return false|string
     * @throws UnknownException
     */
    private function confirmPagantisOrder()
    {
        try {
            $this->pagantisOrder = $this->orderClient->confirmOrder($this->pagantisOrderId);
        } catch (\Exception $e) {
            /** @var Pagantis\OrdersApiClient\Model\Order pagantisOrder */
            $this->pagantisOrder = $this->orderClient->getOrder($this->pagantisOrderId);
            if ($this->pagantisOrder->getStatus() !== Order::STATUS_CONFIRMED) {
                throw new UnknownException($e->getMessage());
            } else {
                $logMessage = 'Concurrency issue: Order_id '.$this->pagantisOrderId.' was confirmed by other process';
                $this->insertLog(null, $logMessage);
            }

        }

        $jsonResponse = new JsonSuccessResponse();
        return $jsonResponse->toJson();
    }
    /**
     * UTILS FUNCTIONS
     */

    /** STEP 1 CC - Check concurrency */

    /**
     * @throws QuoteNotFoundException
     */
    private function getQuoteId()
    {
        if ($this->oscommerceOrderId == "") {
            throw new QuoteNotFoundException();
        }
    }

    /**
     * Check if concurrency table exists
     */
    private function checkConcurrencyTable()
    {
        $checkTable = tep_db_query("SHOW TABLES LIKE '".TABLE_PAGANTIS_CONCURRENCY."'");

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

        if (tep_db_num_rows($checkTable) == 0) {

The function tep_db_num_rows was not found. Maybe you did not declare it correctly or list all dependencies?

            $sql = "CREATE TABLE IF NOT EXISTS ".TABLE_PAGANTIS_CONCURRENCY." (
                            id int NOT NULL,
                            `timestamp` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
                            UNIQUE KEY id(id))";
            tep_db_query($sql);
        }
        return;
    }

    /**
     * Unlock the concurrency
     *
     * @param null $orderId

Are you sure the doc-type for parameter $orderId is correct as it would always require null to be passed?

     * @throws Exception
     */
    private function unblockConcurrency($orderId = null)
    {
        try {
            if ($orderId == null) {

The condition $orderId == null is always true.

                $query = sprintf(
                    "delete from %s where timestamp<TIMESTAMPADD(SECOND, -%s, CURRENT_TIMESTAMP)",
                    TABLE_PAGANTIS_CONCURRENCY,
                    self::CONCURRENCY_TIMEOUT
                );
                tep_db_query($query);

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

            } elseif ($orderId!='') {
                $query = "delete from ".TABLE_PAGANTIS_CONCURRENCY." where id='$orderId'";
                tep_db_query($query);
            }
        } catch (Exception $exception) {
            throw new ConcurrencyException();
        }
    }

    /**
     * @throws \Exception
     */
    private function blockConcurrency()
    {
        try {
            $query = "SELECT timestamp FROM ".TABLE_PAGANTIS_CONCURRENCY." where id='$this->oscommerceOrderId'";
            $resultsSelect = tep_db_query($query);

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

            $orderRow = tep_db_fetch_array($resultsSelect);

The function tep_db_fetch_array was not found. Maybe you did not declare it correctly or list all dependencies?

            if (isset($orderRow['timestamp'])) {
                if ($this->origin == 'notify') {
                    throw new ConcurrencyException();
                } else {
                    $query = sprintf(
                        "SELECT TIMESTAMPDIFF(SECOND,NOW()-INTERVAL %s SECOND, timestamp) as rest FROM %s %s",
                        self::CONCURRENCY_TIMEOUT,
                        TABLE_PAGANTIS_CONCURRENCY,
                        "WHERE id='".$this->oscommerceOrderId."'"
                    );
                    $resultsSelect = tep_db_query($query);
                    $resultsArray = tep_db_fetch_array($resultsSelect);
                    $restSeconds = isset($resultsArray['rest']) ? ($resultsArray['rest']) : 0;
                    $expirationSec = ($restSeconds>self::CONCURRENCY_TIMEOUT)? self::CONCURRENCY_TIMEOUT : $restSeconds;
                    if ($expirationSec > 0) {
                        sleep($expirationSec + 1);
                    }

                    //Check if the notification have been processed
                    $query = sprintf(
                        "select os_order_id from %s where os_order_reference='%s'",
                        TABLE_PAGANTIS_ORDERS,
                        $this->oscommerceOrderId
                    );
                    $resultsSelect = tep_db_query($query);
                    $os_order_id = tep_db_fetch_array($resultsSelect);
                    if (isset($os_order_id['os_order_id'])) {
                        $redirectUrl = trim(tep_href_link(FILENAME_ACCOUNT_HISTORY_INFO, '', 'SSL', false));

The function tep_href_link was not found. Maybe you did not declare it correctly or list all dependencies?

The constant FILENAME_ACCOUNT_HISTORY_INFO was not found. Maybe you did not declare it correctly or list all dependencies?

                        $redirectUrl.="?order_id=$this->oscommerceOrderId";
                    } else {
                        $redirectUrl = trim(tep_href_link(FILENAME_CHECKOUT_SHIPPING, '', 'SSL', false));

The constant FILENAME_CHECKOUT_SHIPPING was not found. Maybe you did not declare it correctly or list all dependencies?

                    }

                    $logMessage = sprintf(
                        "User waiting %s seconds, default seconds %s, bd time to expire %s seconds => Url: %s",
                        $expirationSec,
                        self::CONCURRENCY_TIMEOUT,
                        $restSeconds,
                        $redirectUrl
                    );
                    $this->insertLog(null, $logMessage);

                    header("Location: $redirectUrl");
                    exit;
                }
            } else {
                $query = "INSERT INTO ".TABLE_PAGANTIS_CONCURRENCY." (id) VALUES ('$this->oscommerceOrderId');";
                tep_db_query($query);
            }
        } catch (Exception $exception) {
            throw new ConcurrencyException();
        }
    }

    /** STEP 2 GMO - Get Merchant Order */
    /** STEP 3 GPOI - Get Pagantis OrderId */
    /** STEP 4 GPO - Get Pagantis Order */
    /** STEP 5 COS - Check Order Status */
    /**
     * @param $statusArray
     *
     * @throws \Exception
     */
    private function checkPagantisStatus($statusArray)
    {
        $pagantisStatus = array();
        foreach ($statusArray as $status) {
            $pagantisStatus[] = constant("\Pagantis\OrdersApiClient\Model\Order::STATUS_$status");
        }

        if ($this->pagantisOrder instanceof \Pagantis\OrdersApiClient\Model\Order) {
            $payed = in_array($this->pagantisOrder->getStatus(), $pagantisStatus);
            if (!$payed) {
                if ($this->pagantisOrder instanceof \Pagantis\OrdersApiClient\Model\Order) {

$this->pagantisOrder is always a sub-type of Pagantis\OrdersApiClient\Model\Order.

                    $status = $this->pagantisOrder->getStatus();
                } else {
                    $status = '-';
                }
                throw new WrongStatusException($status);
            }
        } else {
            throw new OrderNotFoundException();
        }
    }

    /**
     * @return mixed
     */
    private function findOscommerceOrderId()
    {
        $query = sprintf(
            "select os_order_id from %s where os_order_reference='%s'",
            TABLE_PAGANTIS_ORDERS,
            $this->oscommerceOrderId
        );
        $resultsSelect = tep_db_query($query);

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

        $orderRow = tep_db_fetch_array($resultsSelect);

The function tep_db_fetch_array was not found. Maybe you did not declare it correctly or list all dependencies?

        $this->merchantOrderId = $orderRow['os_order_id'];

The property merchantOrderId does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        return $orderRow['os_order_id'];
    }

    /** STEP 6 CMOS - Check Merchant Order Status */
    /** STEP 7 VA - Validate Amount */
    /** STEP 8 PMO - Process Merchant Order */

    /**
     * Save the order status with the related identification
     */
    private function updateBdInfo()
    {
        global $insert_id;
        $this->merchantOrderId = $insert_id;

The property merchantOrderId does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $query = sprintf(
            "update %s set os_order_id='%s' where os_order_reference='%s'",
            TABLE_PAGANTIS_ORDERS,
            $insert_id,
            $this->oscommerceOrderId
        );
        tep_db_query($query);

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

        $metadataOrder = $this->pagantisOrder->getMetadata();

        $metadataInfo = '';
        foreach ($metadataOrder as $metadataKey => $metadataValue) {
            if ($metadataKey == 'promotedProduct') {
                $metadataInfo.= "/Producto promocionado = $metadataValue";
            }
        }

        $comment = "Pagantis id=$this->pagantisOrderId/Via=".ucfirst($this->origin)."/".$metadataInfo;
        $query = "insert into ".TABLE_ORDERS_STATUS_HISTORY ."(comments, orders_id, orders_status_id, customer_notified,

The constant TABLE_ORDERS_STATUS_HISTORY was not found. Maybe you did not declare it correctly or list all dependencies?

        date_added) values ('$comment', ".$insert_id.", '2', -1, now() )";
        tep_db_query($query);

        $query = "update ".TABLE_ORDERS." set orders_status='2' where orders_id='$insert_id'";

The constant TABLE_ORDERS was not found. Maybe you did not declare it correctly or list all dependencies?

        tep_db_query($query);
    }

    /** STEP 9 CPO - Confirmation Pagantis Order */
    private function rollbackMerchantOrder()
    {
        global $insert_id;
        $query = "update orders set orders_status='1' where orders_id='$insert_id' ";
        tep_db_query($query);

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

        $query = sprintf(
            "update %s set os_order_id='' where os_order_reference='%s'",
            TABLE_PAGANTIS_ORDERS,
            $this->oscommerceOrderId
        );

        tep_db_query($query);
    }

    /**
     * @param null $exception

Are you sure the doc-type for parameter $exception is correct as it would always require null to be passed?

     * @param null $message

Are you sure the doc-type for parameter $message is correct as it would always require null to be passed?

     */
    private function insertLog($exception = null, $message = null)
    {
        $logEntry= new LogEntry();
        if ($exception instanceof \Exception) {
            $logEntryJson = $logEntry->error($exception)->toJson();
        } else {
            $logEntryJson = $logEntry->info($message)->toJson();
        }
            $query = "insert into ".TABLE_PAGANTIS_LOG."(log) values ('$logEntryJson')";
            tep_db_query($query);

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

    }

    /**
     * @return array
     */
    private function getExtraConfig()
    {
        $checkTable = tep_db_query("SHOW TABLES LIKE '".TABLE_PAGANTIS_CONFIG."'");

The function tep_db_query was not found. Maybe you did not declare it correctly or list all dependencies?

        $response = array();
        if (tep_db_num_rows($checkTable) > 0) {

The function tep_db_num_rows was not found. Maybe you did not declare it correctly or list all dependencies?

            $query       = "select * from ".TABLE_PAGANTIS_CONFIG;
            $result      = tep_db_query($query);
            $response    = array();
            while ($resultArray = tep_db_fetch_array($result)) {

The function tep_db_fetch_array was not found. Maybe you did not declare it correctly or list all dependencies?

                $response[$resultArray['config']] = $resultArray['value'];
            }
        }

        return $response;
    }

    /***
     * SETTERS Y GETTERS
     */

    /**
     * @return mixed
     */
    public function getOscommerceOrderId()
    {
        return $this->oscommerceOrderId;
    }

    /**
     * @param $oscommerceOrderId
     */
    public function setOscommerceOrderId($oscommerceOrderId)
    {
        $this->oscommerceOrderId = $oscommerceOrderId;
    }

    /**
     * @return mixed
     */
    public function getOrigin()
    {
        return $this->origin;
    }

    /**
     * @param mixed $origin
     */
    public function setOrigin($origin)
    {
        $this->origin = $origin;
    }

    /**
     * @return String
     */
    public function getOrderStatus()
    {
        return $this->orderStatus;
    }

    /**
     * @param String $orderStatus
     */
    public function setOrderStatus($orderStatus)
    {
        $this->orderStatus = $orderStatus;

The property orderStatus does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }
}