baseservicehandler.php

<?php
namespace Bitrix\Sale\PaySystem;
 
use Bitrix\Main\Application;
use Bitrix\Main\Context;
use Bitrix\Main\Text;
use Bitrix\Main\Error;
use Bitrix\Main\IO;
use Bitrix\Main\Localization\Loc;
use Bitrix\Main\Request;
use Bitrix\Sale\BusinessValue;
use Bitrix\Sale\Payment;
 
Loc::loadMessages(__FILE__);
 
abstract class BaseServiceHandler
{
    const STREAM = 1;
    const STRING = 2;
 
    const TEST_URL = 'test';
    const ACTIVE_URL = 'active';
 
    protected $handlerType = '';
 
    protected $service = null;
 
    protected $extraParams = array();
    protected $initiateMode = self::STREAM;
 
    protected $isClone = false;
 
    private array $businessCodes = [];
 
    abstract public function initiatePay(Payment $payment, Request $request = null);
 
    public function __construct($type, Service $service)
    {
        $this->handlerType = $type;
        $this->service = $service;
    }
 
    public function showTemplate(Payment $payment = null, $template = '')
    {
        $result = new ServiceResult();
 
        global $APPLICATION, $USER, $DB;
 
        $templatePath = $this->searchTemplate($template);
 
        if ($templatePath != '' && IO\File::isFileExists($templatePath))
        {
            $params = array_merge($this->getParamsBusValue($payment), $this->getExtraParams());
 
            if ($this->initiateMode == self::STREAM)
            {
                require($templatePath);
 
                if ($this->service->getField('ENCODING') != '')
                {
                    define("BX_SALE_ENCODING", $this->service->getField('ENCODING'));
                    AddEventHandler('main', 'OnEndBufferContent', array($this, 'OnEndBufferContent'));
                }
            }
            elseif ($this->initiateMode == self::STRING)
            {
                ob_start();
                $content = require($templatePath);
 
                $buffer = ob_get_contents();
                if ($buffer <> '')
                    $content = $buffer;
 
                if ($this->service->getField('ENCODING') != '')
                {
                    $encoding = Context::getCurrent()->getCulture()->getCharset();
                    $content = Text\Encoding::convertEncoding($content, $encoding, $this->service->getField('ENCODING'));
                }
 
                $result->setTemplate($content);
                ob_end_clean();
            }
        }
        else
        {
            $result->addError(new Error(Loc::getMessage('SALE_PS_BASE_SERVICE_TEMPLATE_ERROR')));
        }
 
        return $result;
    }
 
    private function searchTemplate($template)
    {
        $documentRoot = Application::getDocumentRoot();
        $siteTemplate = \CSite::GetCurTemplate();
        $template = Manager::sanitize($template);
        $handlerName = static::getName();
 
        $folders = array();
 
        $folders[] = '/local/templates/' . $siteTemplate . '/payment/' . $handlerName . '/template';
        if ($siteTemplate !== '.default')
        {
            $folders[] = '/local/templates/.default/payment/' . $handlerName . '/template';
        }
 
        $folders[] = '/bitrix/templates/' . $siteTemplate . '/payment/' . $handlerName . '/template';
        if ($siteTemplate !== '.default')
        {
            $folders[] = '/bitrix/templates/.default/payment/' . $handlerName . '/template';
        }
 
        $baseFolders = Manager::getHandlerDirectories();
        if (isset($baseFolders[$this->handlerType]))
        {
            $folders[] = $baseFolders[$this->handlerType] . $handlerName . '/template';
        }
 
        foreach ($folders as $folder)
        {
            $templatePath = $documentRoot . $folder . '/' . $template . '.php';
 
            if (IO\File::isFileExists($templatePath))
            {
                return $templatePath;
            }
        }
 
        return '';
    }
 
 
    public function getParamsBusValue(Payment $payment = null)
    {
        $params = array();
        $codes = $this->getBusinessCodes();
 
        if ($codes)
        {
            foreach ($codes as $code)
                $params[$code] = $this->getBusinessValue($payment, $code);
        }
 
        return $params;
    }
 
    static protected function getName()
    {
        return Manager::getFolderFromClassName(get_called_class());
    }
 
    protected function getBusinessValue(Payment $payment = null, $code)
    {
        $value = BusinessValue::get($code, $this->service->getConsumerName(), $payment);
        if (is_string($value))
        {
            $value = trim($value);
        }
 
        return $value;
    }
 
    public function getDescription()
    {
        $description = $this->includeDescription();
 
        if (isset($description['CODES']) && is_array($description['CODES']))
        {
            $description['CODES'] = $this->filterDescriptionCodes($description['CODES']);
        }
 
        return $description;
    }
 
    protected function filterDescriptionCodes($codes)
    {
        $psMode = $this->service->getField('PS_MODE');
 
        return array_filter(
            $codes,
            static function ($code, $key) use ($psMode)
            {
                if (!isset($code['HANDLER_MODE']))
                {
                    return true;
                }
 
                if (!is_array($code['HANDLER_MODE']))
                {
                    trigger_error('HANDLER_MODE must be an array', E_USER_WARNING);
                    return false;
                }
 
                return in_array($psMode, $code['HANDLER_MODE'], true);
            },
            ARRAY_FILTER_USE_BOTH
        );
    }
 
    protected function getBusinessCodes()
    {
        if (!$this->businessCodes)
        {
            $description = $this->includeDescription();
 
            if (isset($description['CODES']) && is_array($description['CODES']))
            {
                $this->businessCodes = array_keys($description['CODES']);
            }
        }
 
        return $this->businessCodes;
    }
 
    protected function getExtraParams()
    {
        return $this->extraParams;
    }
 
    public function setExtraParams(array $values)
    {
        $this->extraParams = $values;
    }
 
    public abstract function getCurrencyList();
 
    public function getClientType($psMode)
    {
        return ClientType::DEFAULT;
    }
 
    public function creditNoDemand(Payment $payment)
    {
        return new ServiceResult();
    }
 
    public function debitNoDemand(Payment $payment)
    {
        return new ServiceResult();
    }
 
    public static function getHandlerModeList()
    {
        return array();
    }
 
    public function setInitiateMode($mode)
    {
        $this->initiateMode = $mode;
    }
 
    protected function getUrl(Payment $payment = null, $action)
    {
        $urlList = $this->getUrlList();
        if (isset($urlList[$action]))
        {
            $url = $urlList[$action];
 
            if (is_array($url))
            {
                if ($this->isTestMode($payment) && isset($url[self::TEST_URL]))
                    return $url[self::TEST_URL];
                else
                    return $url[self::ACTIVE_URL];
            }
            else
            {
                return $url;
            }
        }
 
        return '';
    }
 
    protected function isTestMode(Payment $payment = null)
    {
        return false;
    }
 
    protected function getUrlList()
    {
        return array();
    }
 
 
    public function createClone(\SplObjectStorage $cloneEntity)
    {
        if ($this->isClone() && $cloneEntity->contains($this))
        {
            return $cloneEntity[$this];
        }
 
        $serviceHandlerClone = clone $this;
        $serviceHandlerClone->isClone = true;
 
        if (!$cloneEntity->contains($this))
        {
            $cloneEntity[$this] = $serviceHandlerClone;
        }
 
        if ($this->service)
        {
            if ($cloneEntity->contains($this->service))
            {
                $serviceHandlerClone->service = $cloneEntity[$this->service];
            }
        }
 
        return $serviceHandlerClone;
    }
 
    public function isClone()
    {
        return $this->isClone;
    }
 
    public function getHandlerType()
    {
        return $this->handlerType;
    }
 
    public function OnEndBufferContent(&$content)
    {
        if (
            strpos($content, 'charset=') !== false
            && strpos($content, "charset=".SITE_CHARSET) !== false
        )
        {
            header("Content-Type: text/html; charset=".BX_SALE_ENCODING);
            $content = Text\Encoding::convertEncoding($content, SITE_CHARSET, BX_SALE_ENCODING);
            $content = str_replace("charset=".SITE_CHARSET, "charset=".BX_SALE_ENCODING, $content);
        }
    }
 
    public function getDemoParams()
    {
        return array();
    }
 
    public function isTuned()
    {
        return true;
    }
 
    protected function includeDescription(): array
    {
        $data = null;
 
        $documentRoot = Application::getDocumentRoot();
        $dirs = Manager::getHandlerDirectories();
        $handlerDir = $dirs[$this->handlerType];
        $file = $documentRoot . $handlerDir . static::getName() . '/.description.php';
 
        if (IO\File::isFileExists($file))
        {
            require $file;
        }
 
        return (isset($data) && is_array($data)) ? $data : [];
    }
}