linkmobility4Ordermanager/src/Application/Model/Actions/d3linkmobility_ordermanager_action.php

<?php

/**
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * https://www.d3data.de
 *
 * @copyright (C) D3 Data Development (Inh. Thomas Dartsch)
 * @author    D3 Data Development - Daniel Seifert <support@shopmodule.com>
 * @link      https://www.oxidmodule.com
 */

declare(strict_types=1);

namespace D3\Linkmobility4Ordermanager\Application\Model\Actions;

use D3\Linkmobility4Ordermanager\Application\Model\d3linkmobility_ordermanager_sender;
use D3\Linkmobility4Ordermanager\Application\Model\Exceptions\emptyMesageException;
use D3\Linkmobility4OXID\Application\Model\Exceptions\noRecipientFoundException;
use D3\ModCfg\Application\Model\Exception\d3_cfg_mod_exception;
use D3\ModCfg\Application\Model\Exception\d3ParameterNotFoundException;
use D3\ModCfg\Application\Model\Exception\d3ShopCompatibilityAdapterException;
use D3\Ordermanager\Application\Model\Actions\d3ordermanager_action_abstract;
use D3\Ordermanager\Application\Model\d3ordermanager_conf;
use D3\Ordermanager\Application\Model\Exceptions\d3ActionRequirementAbstract;
use D3\Ordermanager\Application\Model\Exceptions\d3ordermanager_actionException;
use DebugBar\DebugBarException;
use Doctrine\DBAL\DBALException;
use OxidEsales\Eshop\Application\Model\Content;
use OxidEsales\Eshop\Core\Exception\DatabaseConnectionException;
use OxidEsales\Eshop\Core\Exception\DatabaseErrorException;
use OxidEsales\Eshop\Core\Exception\DatabaseException;
use OxidEsales\Eshop\Core\Exception\StandardException;
use OxidEsales\Eshop\Core\Language;
use OxidEsales\Eshop\Core\Registry;

class d3linkmobility_ordermanager_action extends d3ordermanager_action_abstract
{
    public $sTplName = 'd3linkmobility_ordermanager_action.tpl';
    public const ACTIVE_SWITCH = 'blActionLinkmobility_status';
    public $sTitleIdent = 'D3_LINKMOBILITY_ORDERMANAGER_ACTION';

    public const SOURCE_TEMPLATE = 'template';
    public const SOURCE_CMS = 'cms';

    /**
     * @return array
     */
    final public function isAllowedInEditions(): array
    {
        return [
            d3ordermanager_conf::SERIAL_BIT_FREE_EDITION,
            d3ordermanager_conf::SERIAL_BIT_STANDARD_EDITION,
            d3ordermanager_conf::SERIAL_BIT_PREMIUM_EDITION,
        ];
    }

    /**
     * @return string
     */
    public function getUnvalidConfigurationMessageIdent(): string
    {
        if ($this->hasRequiredValuesNoSource(false)) {
            return 'D3_ORDERMANAGER_ACTION_LINKMOBILITYMESSAGE_ERR_NOVALIDSOURCE';
        } elseif ($this->hasRequiredValuesTplSource(false)) {
            return 'D3_ORDERMANAGER_ACTION_LINKMOBILITYMESSAGE_ERR_NOVALIDTPL';
        } elseif ($this->hasRequiredValuesCmsSource(false)) {
            return 'D3_ORDERMANAGER_ACTION_LINKMOBILITYMESSAGE_ERR_NOVALIDCMS';
        } else {
            return 'D3_ORDERMANAGER_ACTION_LINKMOBILITYMESSAGE_ERR_UNDEFINED';
        }
    }

    /**
     * @throws DBALException
     * @throws DatabaseConnectionException
     * @throws DatabaseErrorException
     * @throws DatabaseException
     * @throws StandardException
     * @throws d3ParameterNotFoundException
     * @throws d3ActionRequirementAbstract
     * @throws d3ordermanager_actionException
     * @throws DebugBarException
     * @throws d3ShopCompatibilityAdapterException
     * @throws d3_cfg_mod_exception
     */
    public function startAction()
    {
        if (false === $this->isExecutable()) {
            return;
        }

        $this->throwUnvalidConfigurationException();

        startProfile(__METHOD__);

        /** @var Language $oLang */
        $oLang = oxNew(Language::class);

        $this->getManager()->getRemarkHandler()->addNote(
            sprintf(
                $oLang->translateString('D3_ORDERMANAGER_JOBDESC_SENDLMMESSAGE', null, true),
                $this->getRecipientDescription()
            )
        );

        $this->startExecution();

        stopProfile(__METHOD__);
    }

    /**
     * @return string
     */
    public function getRecipientDescription(): string
    {
        $aMailDesc = [];
        ($this->getManager()->getValue('blLinkMobilityMessageToCustomer') ? $aMailDesc[] = 'Customer' : '');
        (
            $this->getManager()->getValue('blLinkMobilityMessageToCustom') ?
            $aMailDesc[] = 'Custom: ' . $this->getManager()->getValue('sLinkMobilityMessageToCustomAddress') :
            ''
        );

        return implode(', ', $aMailDesc);
    }

    /**
     * @return bool
     */
    public function hasRequiredValues(): bool
    {
        return $this->hasRequiredValuesNoSource(true) &&
            (
                $this->hasRequiredValuesTplSource(true) ||
                $this->hasRequiredValuesCmsSource(true)
            ) && $this->hasRequiredValuesRecipient();
    }

    /**
     * @param bool $blExpected
     *
     * @return bool
     */
    protected function hasRequiredValuesNoSource(bool $blExpected): bool
    {
        $source = (string) $this->getManager()->getValue('sLinkMobilityMessageFromSource');

        $return = strlen(trim($source)) &&
                  in_array(trim($source), [self::SOURCE_CMS, self::SOURCE_TEMPLATE]);

        return $blExpected ? $return : false === $return;
    }

    /**
     * @param bool $blExpected
     *
     * @return bool
     */
    protected function hasRequiredValuesTplSource(bool $blExpected): bool
    {
        $source = (string) $this->getManager()->getValue('sLinkMobilityMessageFromSource');

        if (trim($source) !== self::SOURCE_TEMPLATE) {
            return false;
        }

        $template = (string) $this->getManager()->getValue('sLinkMobilityMessageFromTemplatename');
        $theme = (string) $this->getManager()->getValue('sLinkMobilityMessageFromTheme');

        if ($blExpected === true) {
            return (bool) strlen(trim($template)) === true &&
                (bool) strlen(trim($theme)) === true;
        } else {
            return (bool) strlen(trim($template)) === false ||
                (bool) strlen(trim($theme)) === false;
        }
    }

    /**
     * @param bool $blExpected
     *
     * @return bool
     */
    protected function hasRequiredValuesCmsSource(bool $blExpected): bool
    {
        $source = (string) $this->getManager()->getValue('sLinkMobilityMessageFromSource');

        if (trim($source) !== self::SOURCE_CMS) {
            return false;
        }

        /** @var Content $content */
        $content = oxNew(Content::class);
        $contentname = (string) $this->getManager()->getValue('sLinkMobilityMessageFromContentname');

        if ($blExpected === true) {
            return (bool) strlen(trim($contentname)) === true &&
                $content->exists(trim($contentname)) === true;
        } else {
            return (bool) strlen(trim($contentname)) === false ||
                $content->exists(trim($contentname)) === false;
        }
    }

    /**
     * @return bool
     */
    protected function hasRequiredValuesRecipient(): bool
    {
        $toCust = (bool) $this->getManager()->getValue('blLinkMobilityMessageToCustomer');
        $toCustom = (bool) $this->getManager()->getValue('blLinkMobilityMessageToCustom');
        $toCustomAddress = (string) $this->getManager()->getValue('sLinkMobilityMessageToCustomAddress');

        return  $toCust || (
            $toCustom &&
                (bool) strlen(trim($toCustomAddress))
        );
    }

    /**
     * @return bool
     * @throws DBALException
     * @throws DatabaseConnectionException
     * @throws DatabaseErrorException
     */
    public function canExecuteMethod(): bool
    {
        return $this->getManager()->getExecMode();
    }

    /**
     * @throws DBALException
     * @throws DatabaseConnectionException
     * @throws DatabaseErrorException
     * @throws DatabaseException
     * @throws StandardException
     * @throws d3ShopCompatibilityAdapterException
     * @throws d3_cfg_mod_exception
     */
    public function startExecution()
    {
        try {
            if ($this->canExecuteMethod() && $this->hasRequiredValues()) {
                $this->getSendClass()->sendOrderManagerSms($this->getManager(), $this->getItem());
            }
        } catch (emptyMesageException $e) {
            Registry::getLogger()->error($e->getMessage());
            $this->getManager()->getRemarkHandler()->addNote(
                Registry::getLang()->translateString('D3_ORDERMANAGER_JOBDESC_SENDLMMESSAGE_EMPTYMESSAGE', null, true)
            );
        } catch (noRecipientFoundException $e) {
            Registry::getLogger()->info(
                $this->getManager()->getFieldData('oxtitle')." => ".
                $this->getItem()->getFieldData('oxordernr').": ".
                $e->getMessage()
            );
            $this->getManager()->getRemarkHandler()->addNote(
                Registry::getLang()->translateString('D3_ORDERMANAGER_JOBDESC_SENDLMMESSAGE_NORECIPIENT', null, true)
            );
        }
    }

    /**
     * @return d3linkmobility_ordermanager_sender
     */
    public function getSendClass(): d3linkmobility_ordermanager_sender
    {
        return oxNew(d3linkmobility_ordermanager_sender::class);
    }

    /**
     * @return string
     */
    public function getActiveSwitchParameter(): string
    {
        return self::ACTIVE_SWITCH;
    }
}