Fhp\Dialog\Dialog

Complexity

Total Complexity

22

Size/Duplication

Total Lines	362
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	13

Test Coverage

Coverage

0%

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	sendMessage()	0	30	4
A	handleResponse()	0	13	3
A	logMessage()	0	18	4
A	getDialogId()	0	4	1
A	getMessageNumber()	0	4	1
A	getSystemId()	0	4	1
A	getSupportedPinTanMechanisms()	0	4	1
A	getHksalMaxVersion()	0	4	1
A	getHkkazMaxVersion()	0	4	1
A	getBankName()	0	4	1
A	initDialog()	0	28	1
A	syncDialog()	0	46	1
A	endDialog()	0	26	1

<?php
namespace Fhp\Dialog;

use Fhp\Adapter\Exception\AdapterException;
use Fhp\Adapter\Exception\CurlException;
use Fhp\Connection;
use Fhp\Dialog\Exception\FailedRequestException;
use Fhp\Message\AbstractMessage;
use Fhp\Message\Message;
use Fhp\Response\Initialization;
use Fhp\Response\Response;
use Fhp\Segment\HKEND;
use Fhp\Segment\HKIDN;
use Fhp\Segment\HKSYN;
use Fhp\Segment\HKVVB;
use Psr\Log\LoggerInterface;
use Psr\Log\LogLevel;

/**
 * Class Dialog
 * @package Fhp\Dialog
 */
class Dialog
{
    const DEFAULT_COUNTRY_CODE = 280;

    /**
     * @var Connection
     */
    protected $connection;

    /**
     * @var LoggerInterface
     */
    protected $logger;

    /**
     * @var int
     */
    protected $messageNumber = 1;

    /**
     * @var int
     */
    protected $dialogId = 0;

    /**
     * @var int|string
     */
    protected $systemId = 0;

    /**
     * @var string
     */
    protected $bankCode;

    /**
     * @var string
     */
    protected $username;

    /**
     * @var string
     */
    protected $pin;

    /**
     * @var string
     */
    protected $bankName;

    /**
     * @var array
     */
    protected $supportedTanMechanisms = array();

    /**
     * @var int
     */
    protected $hksalVersion = 6;

    /**
     * @var int
     */
    protected $hkkazVersion = 6;

    /**
     * Dialog constructor.
     *
     * @param Connection $connection
     * @param string $bankCode
     * @param string $username
     * @param string $pin
     * @param string $systemId
     * @param LoggerInterface $logger
     */
    public function __construct(Connection $connection, $bankCode, $username, $pin, $systemId, LoggerInterface $logger)
    {
        $this->connection = $connection;
        $this->bankCode = $bankCode;
        $this->username = $username;
        $this->pin = $pin;
        $this->systemId = $systemId;
        $this->logger = $logger;
    }

    /**
     * @param AbstractMessage $message
     * @return Response
     * @throws AdapterException
     * @throws CurlException
     * @throws FailedRequestException
     */
    public function sendMessage(AbstractMessage $message)
    {
        try {
            $this->logger->info('Sending Message');
            $message->setMessageNumber($this->messageNumber);
            $message->setDialogId($this->dialogId);

            $result = $this->connection->send($message);
            $this->messageNumber++;
            $response = new Response($result);

            $this->handleResponse($response);

            if (!$response->isSuccess()) {
                $summary = $response->getMessageSummary();
                $ex = new FailedRequestException($summary);
                $this->logger->error($ex->getMessage());
                throw $ex;
            }

            return $response;
        } catch (AdapterException $e) {
            $this->logger->critical($e->getMessage());
            if ($e instanceof CurlException) {
                $this->logger->debug(print_r($e->getCurlInfo(), true));
            }

            throw $e;
        }
    }

    /**
     * @param Response $response
     */
    protected function handleResponse(Response $response)
    {
        $summary = $response->getMessageSummary();
        $segSum  = $response->getSegmentSummary();

        foreach ($summary as $code => $message) {
            $this->logMessage('HIRMG', $code, $message);
        }

        foreach ($segSum as $code => $message) {
            $this->logMessage('HIRMS', $code, $message);
        }
    }

    /**
     * @param string $type
     * @param string $code
     * @param $message
     */
    protected function logMessage($type, $code, $message)
    {
        switch (substr($code, 0, 1)) {
            case '0':
                $level = LogLevel::INFO;
                break;
            case "3":
                $level = LogLevel::WARNING;
                break;
            case "9":
                $level = LogLevel::ERROR;
                break;
            default:
                $level = LogLevel::INFO;
        }

        $this->logger->log($level, '[' . $type . '] ' . $message);
    }

    /**
     * Gets the dialog ID.
     *
     * @return integer
     */
    public function getDialogId()
    {
        return $this->dialogId;
    }

    /**
     * Gets the current message number.
     *
     * @return int
     */
    public function getMessageNumber()
    {
        return $this->messageNumber;
    }

    /**
     * Gets the system ID.
     *
     * @return int|string
     */
    public function getSystemId()
    {
        return $this->systemId;
    }

    /**
     * Gets all supported TAN mechanisms.
     *
     * @return array
     */
    public function getSupportedPinTanMechanisms()
    {
        return $this->supportedTanMechanisms;
    }

    /**
     * Gets the max possible HKSAL version.
     *
     * @return int
     */
    public function getHksalMaxVersion()
    {
        return $this->hksalVersion;
    }

    /**
     * Gets the max possible HKKAZ version.
     *
     * @return int
     */
    public function getHkkazMaxVersion()
    {
        return $this->hkkazVersion;
    }

    /**
     * Gets the bank name.
     *
     * @return string
     */
    public function getBankName()
    {
        return $this->bankName;
    }

    /**
     * Initializes a dialog.
     *
     * @return string|null
     * @throws AdapterException
     * @throws CurlException
     * @throws FailedRequestException
     * @throws \Exception
     */
    public function initDialog()
    {
        $this->logger->info('Initialize Dialog');
        $identification = new HKIDN(3, $this->bankCode, $this->username, $this->systemId);
        $prepare        = new HKVVB(4, HKVVB::DEFAULT_BPD_VERSION, HKVVB::DEFAULT_UPD_VERSION, HKVVB::LANG_DEFAULT);

        $message = new Message(
            $this->bankCode,
            $this->username,
            $this->pin,
            $this->systemId,
            0,
            1,
            array($identification, $prepare),
            array(AbstractMessage::OPT_PINTAN_MECH => $this->supportedTanMechanisms)
        );

        $this->logger->debug('Sending INIT message: ' . (string) $message);

        $response = $this->sendMessage($message)->rawResponse;
        $this->logger->debug('Got INIT response: ' . $response);

        $result = new Initialization($response);
        $this->dialogId = $result->getDialogId();

It seems like $result->getDialogId() can also be of type string. However, the property $dialogId is declared as type integer. Maybe add an additional type check?

        $this->logger->info('Received dialog ID: ' . $this->dialogId);

        return $this->dialogId;
    }

    /**
     * Sends sync request.
     *
     * @return string
     * @throws AdapterException
     * @throws CurlException
     * @throws FailedRequestException
     * @throws \Exception
     */
    public function syncDialog()
    {
        $this->logger->info('Initialize SYNC');
        $this->messageNumber = 1;
        $this->systemId = 0;
        $this->dialogId = 0;

        $identification = new HKIDN(3, $this->bankCode, $this->username, 0);
        $prepare        = new HKVVB(4, HKVVB::DEFAULT_BPD_VERSION, HKVVB::DEFAULT_UPD_VERSION, HKVVB::LANG_DEFAULT);
        $sync           = new HKSYN(5);

        $syncMsg = new Message(
            $this->bankCode,
            $this->username,
            $this->pin,
            $this->systemId,
            $this->dialogId,
            $this->messageNumber,
            array($identification, $prepare, $sync)
        );

        $this->logger->debug('Sending SYNC message: ' . (string) $syncMsg);
        $response = $this->sendMessage($syncMsg);

        $this->logger->debug('Got SYNC response: ' . $response->rawResponse);

        // save BPD (Bank Parameter Daten)
        $this->systemId = $response->getSystemId();
        $this->dialogId = $response->getDialogId();

It seems like $response->getDialogId() can also be of type string. However, the property $dialogId is declared as type integer. Maybe add an additional type check?

        $this->bankName = $response->getBankName();

        // max version for segment HKSAL (Saldo abfragen)
        $this->hksalVersion = $response->getHksalMaxVersion();
        $this->supportedTanMechanisms = $response->getSupportedTanMechanisms();

        // max version for segment HKKAZ (Kontoumsätze anfordern / Zeitraum)
        $this->hkkazVersion = $response->getHkkazMaxVersion();

        $this->logger->info('Received system id: ' . $response->getSystemId());
        $this->logger->info('Received dialog id: ' . $response->getDialogId());
        $this->logger->info('Supported TAN mechanisms: ' . implode(', ', $this->supportedTanMechanisms));

        $this->endDialog();

        return $response->rawResponse;
    }

    /**
     * Ends a previous started dialog.
     *
     * @return string
     * @throws AdapterException
     * @throws CurlException
     * @throws FailedRequestException
     */
    public function endDialog()
    {
        $this->logger->info('Initialize END dialog message');

        $endMsg = new Message(
            $this->bankCode,
            $this->username,
            $this->pin,
            $this->systemId,
            $this->dialogId,
            $this->messageNumber,
            array(
                new HKEND(3, $this->dialogId)
            )
        );

        $this->logger->debug('Sending END message: ' . (string) $endMsg);
        $response = $this->sendMessage($endMsg);
        $this->logger->debug('Got END response: ' . $response->rawResponse);

        $this->logger->info('Resetting dialog ID and message number count');
        $this->dialogId = 0;
        $this->messageNumber = 1;

        return $response->rawResponse;
    }
}