DigitalOrigin\Pmt\Controller\Payment\LogV2

Complexity

Total Complexity

20

Size/Duplication

Total Lines	141
Duplicated Lines	0 %

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	18	5
A	createCsrfValidationException()	0	3	1
A	validateForCsrf()	0	3	1
D	execute()	0	47	11
A	checkDbLogTable()	0	25	2

<?php
namespace DigitalOrigin\Pmt\Controller\Payment;

use Magento\Framework\App\Action\Action;
use Magento\Framework\App\ResourceConnection;
use Magento\Framework\DB\Ddl\Table;
use Magento\Framework\App\CsrfAwareActionInterface;
use Magento\Framework\App\RequestInterface;
use Magento\Framework\App\Request\InvalidRequestException;

class LogV2 extends Action implements CsrfAwareActionInterface
{
    /** Concurrency tablename */
    const LOGS_TABLE = 'pmt_logs';

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

    /** @var ResourceConnection $dbObject */
    protected $dbObject;

    /**
     * Log constructor.
     *
     * @param \Magento\Framework\App\Action\Context $context
     * @param \DigitalOrigin\Pmt\Helper\Config      $pmtConfig
     * @param ResourceConnection                    $dbObject
     */
    public function __construct(
        \Magento\Framework\App\Action\Context $context,
        \DigitalOrigin\Pmt\Helper\Config $pmtConfig,
        ResourceConnection $dbObject
    ) {
        $this->config = $pmtConfig->getConfig();
        $this->dbObject = $dbObject;

        // CsrfAwareAction Magento2.3 compatibility
        if (interface_exists("\Magento\Framework\App\CsrfAwareActionInterface")) {
            $request = $this->getRequest();
            if ($request instanceof HttpRequest && $request->isPost() && empty($request->getParam('form_key'))) {

The type DigitalOrigin\Pmt\Controller\Payment\HttpRequest was not found. Did you mean HttpRequest? If so, make sure to prefix the type with \.

The method isPost() does not exist on Magento\Framework\App\RequestInterface. It seems like you code against a sub-type of Magento\Framework\App\RequestInterface such as Magento\Framework\Webapi\Request or Magento\Framework\App\Request\Http.

                $formKey = $this->_objectManager->get(\Magento\Framework\Data\Form\FormKey::class);
                $request->setParam('form_key', $formKey->getFormKey());

The method setParam() does not exist on Magento\Framework\App\RequestInterface. Did you maybe mean setParams()?

            }
        }

        return parent::__construct($context);

Are you sure the usage of parent::__construct($context) targeting Magento\Framework\App\Action\Action::__construct() seems to always return null.

    }

    /**
     * Main function
     * @return \Magento\Framework\App\ResponseInterface|\Magento\Framework\Controller\ResultInterface|void
     */
    public function execute()
    {
        try {
            $response = array();
            $secretKey = $this->getRequest()->getParam('secret');
            $privateKey = isset($this->config['pmt_private_key']) ? $this->config['pmt_private_key'] : null;

            if ($secretKey!='' && $privateKey!='') {
                $this->checkDbLogTable();
                /** @var \Magento\Framework\DB\Adapter\AdapterInterface $dbConnection */
                $dbConnection = $this->dbObject->getConnection();
                $tableName    = $this->dbObject->getTableName(self::LOGS_TABLE);
                $sql          = $dbConnection
                    ->select()
                    ->from($tableName, array('log', 'createdAt'));

The call to Magento\Framework\DB\Select::from() has too many arguments starting with $tableName.

                if ($dateFrom = $this->getRequest()->getParam('from')) {
                    $sql->where('createdAt > ?', $dateFrom);
                }

                if ($dateTo = $this->getRequest()->getParam('to')) {
                    $sql->where('createdAt < ?', $dateTo);
                }

                $limit = ($this->getRequest()->getParam('limit')) ? $this->getRequest()->getParam('limit') : 50;
                $sql->limit($limit);
                $sql->order('createdAt', 'desc');

The call to Magento\Framework\DB\Select::order() has too many arguments starting with 'desc'.

                $results = $dbConnection->fetchAll($sql);
                if (isset($results) && $privateKey == $secretKey) {
                    foreach ($results as $key => $result) {
                        $response[$key]['timestamp'] = $result['createdAt'];
                        $response[$key]['log']       = json_decode($result['log']);
                    }
                } else {
                    $response['result'] = 'Error';
                }

                $response = json_encode($response);
                header("HTTP/1.1 200", true, 200);
                header('Content-Type: application/json', true);
                header('Content-Length: '.strlen($response));
                echo($response);
                exit();

Using exit here is not recommended.

            }
        } catch (\Exception $e) {
            die($e->getMessage());

Using exit here is not recommended.

        }
    }

    /**
     * @return void|\Zend_Db_Statement_Interface
     * @throws \Zend_Db_Exception
     */
    private function checkDbLogTable()
    {
        /** @var \Magento\Framework\DB\Adapter\AdapterInterface $dbConnection */
        $dbConnection = $this->dbObject->getConnection();
        $tableName = $this->dbObject->getTableName(self::LOGS_TABLE);
        if (!$dbConnection->isTableExists($tableName)) {
            $table = $dbConnection
                ->newTable($tableName)
                ->addColumn(
                    'id',
                    Table::TYPE_SMALLINT,
                    null,
                    array('nullable'=>false, 'auto_increment'=>true, 'primary'=>true)
                )
                ->addColumn('log', Table::TYPE_TEXT, null, array('nullable'=>false))
                ->addColumn(
                    'createdAt',
                    Table::TYPE_TIMESTAMP,
                    null,
                    array('nullable'=>false,
                          'default'=>Table::TIMESTAMP_INIT)
                );
            return $dbConnection->createTable($table);
        }
        return;
    }

    /**
     * @param RequestInterface $request
     *
     * @return InvalidRequestException|null
     */
    public function createCsrfValidationException(RequestInterface $request): ?InvalidRequestException
    {
        return null;
    }

    /**
     * @param RequestInterface $request
     *
     * @return bool|null
     */
    public function validateForCsrf(RequestInterface $request): ?bool
    {
        return true;
    }
}