statusforward.php

<?php
/**
 * PAYONE OXID Connector is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PAYONE OXID Connector is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with PAYONE OXID Connector.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @link          http://www.payone.de
 * @copyright (C) Payone GmbH
 * @version       OXID eShop CE
 */

namespace Fatchip\PayOne;

set_time_limit(0);
ini_set('memory_limit', 
    '1024M');
ini_set('log_errors', 1);
ini_set('error_log', 
    '../../../log/fcpoErrors.log');

include_once __DIR__ . "/../../../bootstrap.php";
include_once __DIR__ . "/statusbase.php";

use Exception;
use OxidEsales\Eshop\Core\DatabaseProvider;
use OxidEsales\Eshop\Core\Exception\DatabaseConnectionException;
use OxidEsales\Eshop\Core\Exception\DatabaseErrorException;

class FcPayOneTransactionStatusForwarder extends FcPayOneTransactionStatusBase
{
    public const STATE_STARTING = 'starting';
    public const STATE_FINISHED = 'finished';

    /**
     * Map for translating database fields to call params
     */
    private array $_aDbFields2Params = ['FCPO_KEY' => 'key', 
    'FCPO_TXACTION' => 'txaction', 
    'FCPO_PORTALID' => 'portalid', 'FCPO_AID' => 'aid', 'FCPO_CLEARINGTYPE' => 'clearingtype', 'FCPO_TXTIME' => 'txtime', 'FCPO_CURRENCY' => 'currency', 'FCPO_USERID' => 'userid', 'FCPO_ACCESSNAME' => 'accessname', 'FCPO_ACCESSCODE' => 'accesscode', 'FCPO_PARAM' => 'param', 'FCPO_MODE' => 'mode', 'FCPO_PRICE' => 'price', 'FCPO_TXID' => 'txid', 'FCPO_REFERENCE' => 'reference', 'FCPO_SEQUENCENUMBER' => 'sequencenumber', 'FCPO_COMPANY' => 'company', 'FCPO_FIRSTNAME' => 'firstname', 'FCPO_LASTNAME' => 'lastname', 'FCPO_STREET' => 'street', 'FCPO_ZIP' => 'zip', 'FCPO_CITY' => 'city', 'FCPO_EMAIL' => 'email', 'FCPO_COUNTRY' => 'country', 'FCPO_SHIPPING_COMPANY' => 'shipping_company', 'FCPO_SHIPPING_FIRSTNAME' => 'shipping_firstname', 'FCPO_SHIPPING_LASTNAME' => 'shipping_lastname', 'FCPO_SHIPPING_STREET' => 'shipping_street', 'FCPO_SHIPPING_ZIP' => 'shipping_zip', 'FCPO_SHIPPING_CITY' => 'shipping_city', 'FCPO_SHIPPING_COUNTRY' => 'shipping_country', 'FCPO_BANKCOUNTRY' => 'bankcountry', 'FCPO_BANKACCOUNT' => 'bankaccount', 'FCPO_BANKCODE' => 'bankcode', 'FCPO_BANKACCOUNTHOLDER' => 'bankaccountholder', 'FCPO_CARDEXPIREDATE' => 'cardexpiredate', 'FCPO_CARDTYPE' => 'cardtype', 'FCPO_CARDPAN' => 'cardpan', 'FCPO_CUSTOMERID' => 'customerid', 'FCPO_BALANCE' => 'balance', 'FCPO_RECEIVABLE' => 'receivable', 'FCPO_CLEARING_BANKACCOUNTHOLDER' => 'clearing_bankaccountholder', 'FCPO_CLEARING_BANKACCOUNT' => 'clearing_bankaccount', 'FCPO_CLEARING_BANKCODE' => 'clearing_bankcode', 'FCPO_CLEARING_BANKNAME' => 'clearing_bankname', 'FCPO_CLEARING_BANKBIC' => 'clearing_bankbic', 'FCPO_CLEARING_BANKIBAN' => 'clearing_bankiban', 'FCPO_CLEARING_LEGALNOTE' => 'clearing_legalnote', 'FCPO_CLEARING_DUEDATE' => 'clearing_duedate', 'FCPO_CLEARING_REFERENCE' => 'clearing_reference', 'FCPO_CLEARING_INSTRUCTIONNOTE' => 'clearing_instructionnote'];
    /** @var string */
    private const S_FILE = "forwardprocess.txt";

    /**
     * Central handling of forward request
     *
     *
     */
    public function handleForwarding(): void
    {
        try {
            $this->_isJobAlreadyRunning();
            $this->_isKeyValid();
            $this->_setJobState(self::STATE_STARTING);
            $this->_forwardRequests();
            $this->_setJobState(self::STATE_FINISHED);
        } catch (Exception $e) {
            echo "Error occured! Please check logfile for details.\n";
            $this->_logException($e->getMessage());
            exit(1);
        }
    }

    /**
     * Checks if a forward job is currently running
     *
     *
     * @throws Exception
     */
    private function _isJobAlreadyRunning(): void
    {
        $blProcessFileExists = $this->_checkProcessFileExists();
        if (!$blProcessFileExists) {
            return;
        }

        $this->_checkProcessExists();
    }

    /**
     * Checking if process file exists
     *
     *
     */
    private function _checkProcessFileExists(): bool
    {
        $sProcessFile = $this->_getProcessFilePath();
        return file_exists($sProcessFile);
    }

    /**
     * Returns path to processfile
     *
     *
     * @return string
     */
    private function _getProcessFilePath(): string
    {
        $sTmpPath = __DIR__ . "/";

        return $sTmpPath . self::S_FILE;
    }

    /**
     * Deeply checking if former process still exists. If not processfile
     * should be cleaned up and reported so we don't run into eternal loops.
     * Killing processes is explicitely not done here due this should be
     * handled by OS
     *
     *
     * @return void
     * @throws Exception
     */
    private function _checkProcessExists(): void
    {
        $sProcessFile = $this->_getProcessFilePath();
        $iPid = (int)file_get_contents($sProcessFile);

        if ($iPid === 0) {
            unlink($sProcessFile);
            $sMessage =
                'Processfile did not contain a valid PID! Deleted processfile for next run.';
            throw new Exception($sMessage);
        }

        if (file_exists("/proc/$iPid")) {
            throw new Exception('Cronjob already running! Abort current attempt.');
        }

        unlink($sProcessFile);
        $sMessage =
            'Former started process ' . $iPid . ' no longer exists! ' .
            'Deleted processfile for next run.';
        throw new Exception($sMessage);
    }

    /**
     * Setting current state of job
     *
     * @param string $sState
     */
    private function _setJobState(string $sState): void
    {
        $sProcessFile = $this->_getProcessFilePath();
        $iPid = getmypid();
        $this->_logForwardMessage($sState . ' job with PID ' . $iPid);
        if ($sState == self::STATE_STARTING) {
            $oProcessFile = fopen($sProcessFile, 'w');
            fwrite($oProcessFile, $iPid);
            fclose($oProcessFile);
            return;
        }
        if ($sState == self::STATE_FINISHED) {
            unlink($sProcessFile);
        }
    }

    /**
     * Get requests to forward to and trigger forwarding
     *
     *
     * @throws
     */
    private function _forwardRequests(): void
    {
        $sQueryLimitStatusmessageId = null;
        $sLimitStatusmessageId =
            $this->fcGetPostParam('statusmessageid');
        if ($sLimitStatusmessageId !== '' && $sLimitStatusmessageId !== '0') {
            $this->_createMissingQueueEntries($sLimitStatusmessageId);
            $sQueryLimitStatusmessageId =
                " AND  FCSTATUSMESSAGEID='{$sLimitStatusmessageId}' ";
        }
        $sQuery = "
                SELECT
                    OXID,
                    FCSTATUSMESSAGEID,
                    FCSTATUSFORWARDID
                FROM fcpostatusforwardqueue
                WHERE FCFULFILLED='0'
                {$sQueryLimitStatusmessageId}
            ";
        $database = DatabaseProvider::getDb(DatabaseProvider::FETCH_MODE_ASSOC);
        $aRows = $database->getAll($sQuery);
        $this->_logForwardMessage('Found requests to forward: ' . print_r($aRows, true));
        foreach ($aRows as $aRow) {
            $sQueueId = $aRow['OXID'];
            $sStatusmessageId = $aRow['FCSTATUSMESSAGEID'];
            $sForwardId = $aRow['FCSTATUSFORWARDID'];

            $this->_forwardRequest($sQueueId, $sForwardId, $sStatusmessageId);
        }
    }

    /**
     * If new redirect targets have been added for given statusmessage, create
     * referring queue entries
     *
     * @throws Exception
     */
    private function _createMissingQueueEntries(string $sStatusmessageId): void
    {
        $aParams = $this->_fetchPostParams($sStatusmessageId);
        $aRequest = $aParams['array'];
        $sPayoneStatus = $aRequest['txaction'];
        $this->_addQueueEntries($sStatusmessageId, $sPayoneStatus);
    }

    /**
     * Collects request data from database and prepare result
     *
     * @param string $sStatusmessageId
     * @return array{string: string, array: mixed[]}
     * @throws DatabaseConnectionException
     */
    private function _fetchPostParams(string $sStatusmessageId): array
    {
        $database = DatabaseProvider::getDb(DatabaseProvider::FETCH_MODE_ASSOC);
        $sQuery = "
                SELECT * 
                FROM fcpotransactionstatus 
                WHERE OXID=" . $database->quote($sStatusmessageId);
        $aRow = $database->getRow($sQuery);
        if ($aRow === false) {
            $sExceptionMessage =
                'Could not find transaction status message for ID ' . $sStatusmessageId . '!';
            throw new Exception($sExceptionMessage);
        }
        $aRequestParams = $this->_cleanParams($aRow);
        $sParams = '';
        foreach ($aRequestParams as $sKey => $mValue) {
            $sParams .= $this->_addParam($sKey, $mValue);
        }
        return ['string' => $sParams, 'array' => $aRequestParams];
    }

    /**
     * Removes all empty params and translate db fields to corresponding
     * call
     *
     * @param $aParams
     * @return array<int|string, mixed>
     */
    private function _cleanParams(array $aParams): array
    {
        $aCleanedParams = [];
        foreach ($aParams as $sKey => $sValue) {
            $blValid = (
                isset($this->_aDbFields2Params[$sKey]) &&
                $sValue != ''
            );
            if (!$blValid) {
                continue;
            }
            if ($sKey === 'FCPO_TXTIME') {
                $sValue = strtotime((string) $sValue);
            }
            $sCallKey = $this->_aDbFields2Params[$sKey];
            $aCleanedParams[$sCallKey] = $sValue;
        }

        return $aCleanedParams;
    }

    /**
     * Forward request from queue
     *
     * @param string $sQueueId
     * @param string $sForwardId
     * @param string $sStatusmessageId
     * @throws DatabaseConnectionException
     */
    private function _forwardRequest(string $sQueueId, string $sForwardId, string $sStatusmessageId): void
    {
        $oConfig = $this->getConfig();
        $sConfTimeout = $oConfig->getConfigParam('sTransactionRedirectTimeout');
        $iTimeout = ($sConfTimeout) ? (int)$sConfTimeout : 10;
        $aParams = $this->_fetchPostParams($sStatusmessageId);
        $sParams = $aParams['string'];
        $aRequest = $aParams['array'];
        $aForwardData = $this->_getForwardData($sForwardId);
        $sUrl = $aForwardData['url'];
        $this->_logForwardMessage('Trying to forward to url: ' . $sUrl . '...');
        $this->_logForwardMessage($sParams);
        $sParams = substr($sParams, 1);
        $oCurl = curl_init($sUrl);
        curl_setopt($oCurl, CURLOPT_POST, 1);
        curl_setopt($oCurl, CURLOPT_POSTFIELDS, $sParams);
        curl_setopt($oCurl, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($oCurl, CURLOPT_SSL_VERIFYHOST, false);
        curl_setopt($oCurl, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($oCurl, CURLOPT_TIMEOUT, $iTimeout);
        $mResult = curl_exec($oCurl);
        $mCurlInfo = curl_getinfo($oCurl);
        $blValidResult = (is_string($mResult) && trim($mResult) == 'TSOK');
        $this->_setForwardingResult($sQueueId, $blValidResult, $aRequest, $mResult, $mCurlInfo);
        curl_close($oCurl);
    }

    /**
     * Returns elementary forward data
     *
     * @param string $sForwardId
     * @return array
     * @throws DatabaseConnectionException
     */
    private function _getForwardData(string $sForwardId): array
    {
        $database = DatabaseProvider::getDb(DatabaseProvider::FETCH_MODE_ASSOC);
        $sQuery = "
                SELECT 
                    FCPO_URL,
                    FCPO_TIMEOUT
                FROM fcpostatusforwarding 
                WHERE OXID=" . $database->quote($sForwardId);

        $aRow = $database->getRow($sQuery);
        if ($aRow === false) {
            throw new Exception('Could not find forward data for ID ' . $sForwardId . '!');
        }

        return ['url' => $aRow['FCPO_URL'], 'timeout' => $aRow['FCPO_TIMEOUT']];
    }

    /**
     * Updates processed queue entry with current data
     *
     * @param string      $sQueueId
     * @param bool        $blValidResult
     * @param array       $aRequest
     * @param bool|string $mResult
     * @param array|bool  $mCurlInfo
     * @throws DatabaseConnectionException
     * @throws DatabaseErrorException
     */
    private function _setForwardingResult(string $sQueueId, bool $blValidResult, array $aRequest, bool|string $mResult, array|bool $mCurlInfo): void
    {
        $database = DatabaseProvider::getDb();
        $sFulfilled = ($blValidResult) ? '1' : '0';
        $sFulfilled = $database->quote($sFulfilled);
        $sRequest = $database->quote(print_r($aRequest, true));
        $sResponse = $database->quote((string)$mResult);
        $sResponseInfo = $database->quote(print_r($mCurlInfo, true));
        $sQuery = "
            UPDATE fcpostatusforwardqueue
            SET 
                FCTRIES=FCTRIES+1,
                FCLASTTRY=NOW(),
                FCLASTREQUEST=" . $sRequest . ",
                FCLASTRESPONSE=" . $sResponse . ",
                FCRESPONSEINFO=" . $sResponseInfo . ",
                FCFULFILLED=" . $sFulfilled . "
            WHERE
                OXID=" . $database->quote($sQueueId);
        $this->_logForwardMessage("Updating Request with query:\n" . $sQuery . "\n");
        $database->execute($sQuery);
        // update entry in transactionlog table for filtering tries and status
        $sForwardState = ($blValidResult) ? 'OK' : 'ERROR';
        $sQueryUpdateTransactionlog = "
            UPDATE fcpotransactionstatus
            SET 
                FCPO_FORWARD_TRIES=FCPO_FORWARD_TRIES+1,
                FCPO_FORWARD_STATE='" . $sForwardState . "'
            WHERE
                FCPO_TXID='" . $aRequest['txid'] . "' AND FCPO_TXACTION = '" . $aRequest['txaction'] . "'";
        $this->_logForwardMessage("Updating transaction log with query:\n" . $sQueryUpdateTransactionlog . "\n");
        $database->execute($sQueryUpdateTransactionlog);
    }
}

$oScript = oxNew(FcPayOneTransactionStatusForwarder::class);
$oScript->handleForwarding();