AbstractWorkflow - Code Metrics - Inspection of "sm-115 Рефакторинг кода." - old-town/old-town-workflow - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — dev ( 909684...e1b3d2 )

by Андрей
created 2016-03-10 10:23 UTC
AbstractWorkflow F

↳ Parent: Project
Complexity

Total Complexity
272
Size/Duplication

Total Lines	2111
Duplicated Lines	1.85 %
Coupling/Cohesion

Components	1
Dependencies	38
Importance

Changes	26
Bugs	0	Features	0
Metric	Value
wmc	272
c	26
b	0
f	0
lcom	1
cbo	38
dl	39
loc	2111
rs	0.5217
53 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	initLoger()	0	8	2
B	initialize()	0	49	5
B	populateTransientMap()	0	55	5
A	validateIterateData()	0	7	3
A	convertDataInArray()	0	16	4
F	transitionWorkflow()	0	222	46
A	buildJoinsSteps()	0	14	4
C	getAvailableAutoActions()	14	58	9
C	getAvailableAutoActionsForStep()	7	27	7
A	completeEntry()	0	14	4
F	createNewCurrentStep()	0	109	18
A	transientVarsFactory()	0	5	1
D	doAction()	0	78	14
B	checkImplicitFinish()	0	27	5
C	canModifyEntryState()	12	58	14
A	getCurrentSteps()	0	4	1
A	getHistorySteps()	0	4	1
A	getStepFromStorage()	0	20	4
B	changeEntryState()	0	37	6
B	executeFunction()	0	25	4
C	verifyInputs()	0	39	7
A	getCurrentStep()	0	19	4
B	isActionAvailable()	0	33	6
A	getWorkflowDescriptorForAction()	0	17	4
B	canInitialize()	0	43	6
B	canInitializeInternal()	0	26	3
A	getResolver()	0	13	2
A	getPersistence()	0	4	1
A	getConfiguration()	0	16	4
A	getLog()	0	4	1
A	setLog()	0	14	2
A	getWorkflowDescriptor()	0	10	2
B	executeTriggerFunction()	0	24	2
C	getAvailableActions()	6	65	11
C	getAvailableActionsForStep()	0	42	8
A	setConfiguration()	0	6	1
A	getEntryState()	0	16	2
A	getPersistenceProperties()	0	4	1
A	getPropertySet()	0	16	2
A	getWorkflowNames()	0	11	2
A	setTypeResolver()	0	6	1
C	getSecurityPermissions()	0	59	9
A	getWorkflowName()	0	19	3
A	removeWorkflowDescriptor()	0	4	1
A	saveWorkflowDescriptor()	0	6	1
A	query()	0	4	1
A	getDefaultTypeResolverClass()	0	4	1
A	setDefaultTypeResolverClass()	0	6	1
A	passesConditionsByDescriptor()	0	16	3
C	passesConditionsWithType()	0	42	12
C	passesCondition()	0	44	8
A	prepareArgs()	0	10	2
How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class
Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.
Complex classes like AbstractWorkflow often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AbstractWorkflow, and based on these observations, apply Extract Interface, too.
<?php
/**
 * @link https://github.com/old-town/old-town-workflow
 * @author  Malofeykin Andrey  <[email protected]>
 */
namespace OldTown\Workflow;

use OldTown\Log\LogFactory;
use OldTown\PropertySet\PropertySetInterface;
use OldTown\PropertySet\PropertySetManager;
use OldTown\Workflow\Config\ConfigurationInterface;
use OldTown\Workflow\Config\DefaultConfiguration;
use OldTown\Workflow\Exception\FactoryException;
use OldTown\Workflow\Exception\InternalWorkflowException;
use OldTown\Workflow\Exception\InvalidActionException;
use OldTown\Workflow\Exception\InvalidArgumentException;
use OldTown\Workflow\Exception\InvalidEntryStateException;
use OldTown\Workflow\Exception\InvalidInputException;
use OldTown\Workflow\Exception\InvalidRoleException;
use OldTown\Workflow\Exception\StoreException;
use OldTown\Workflow\Exception\WorkflowException;
use OldTown\Workflow\Loader\ActionDescriptor;
use OldTown\Workflow\Loader\ConditionDescriptor;
use OldTown\Workflow\Loader\ConditionsDescriptor;
use OldTown\Workflow\Loader\FunctionDescriptor;
use OldTown\Workflow\Loader\PermissionDescriptor;
use OldTown\Workflow\Loader\RegisterDescriptor;
use OldTown\Workflow\Loader\ResultDescriptor;
use OldTown\Workflow\Loader\ValidatorDescriptor;
use OldTown\Workflow\Loader\WorkflowDescriptor;
use OldTown\Workflow\Query\WorkflowExpressionQuery;
use OldTown\Workflow\Spi\SimpleWorkflowEntry;
use OldTown\Workflow\Spi\StepInterface;
use OldTown\Workflow\Spi\WorkflowEntryInterface;
use OldTown\Workflow\Spi\WorkflowStoreInterface;
use OldTown\Workflow\TransientVars\TransientVarsInterface;
use Psr\Log\LoggerInterface;
use Traversable;
use SplObjectStorage;
use DateTime;
use OldTown\Workflow\TransientVars\BaseTransientVars;
use ReflectionClass;
use ArrayObject;


/**
 * Class AbstractWorkflow
 *
 * @package OldTown\Workflow
 */
abstract class  AbstractWorkflow implements WorkflowInterface
{
    /**
     * @var string
     */
    const CURRENT_STEPS = 'currentSteps';

    /**
     * @var string
     */
    const HISTORY_STEPS = 'historySteps';

    /**
     * @var WorkflowContextInterface
     */
    protected $context;

    /**
     * @var ConfigurationInterface
     */
    protected $configuration;

    /**
     *
     * @var array
     */
    protected $stateCache = [];

    /**
     * @var TypeResolverInterface
     */
    protected $typeResolver;

    /**
     * Логер
     *
     * @var LoggerInterface
     */
    protected $log;

    /**
     * Резолвер для создания провайдеров отвечающих за исполнение функций, проверку условий, выполнение валидаторов и т.д.
     *
     * @var string
     */
    protected $defaultTypeResolverClass = TypeResolver::class;

    /**
     * AbstractWorkflow constructor.
     *
     * @throws InternalWorkflowException
     */
    public function __construct()
    {
        $this->initLoger();
    }

    /**
     * Инициализация системы логирования
     *
     * @throws InternalWorkflowException
     */
    protected function initLoger()
    {
        try {
            $this->log = LogFactory::getLog();
        } catch (\Exception $e) {
            throw new InternalWorkflowException($e->getMessage(), $e->getCode(), $e);
        }
    }

    /**
     * Инициализация workflow. Workflow нужно иницаилизровать прежде, чем выполнять какие либо действия.
     * Workflow может быть инициализированно только один раз
     *
     * @param string $workflowName Имя workflow
     * @param integer $initialAction Имя первого шага, с которого начинается workflow
     * @param TransientVarsInterface $inputs Данные введеные пользователем
     *
     * @return integer
     *
     * @throws InternalWorkflowException
     * @throws InvalidActionException
     * @throws InvalidRoleException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     * @throws InvalidArgumentException
     * @throws WorkflowException
     */
    public function initialize($workflowName, $initialAction, TransientVarsInterface $inputs = null)
    {
        try {
            $initialAction = (integer)$initialAction;

            $wf = $this->getConfiguration()->getWorkflow($workflowName);

            $store = $this->getPersistence();

            $entry = $store->createEntry($workflowName);

            $ps = $store->getPropertySet($entry->getId());


            if (null === $inputs) {
                $inputs = $this->transientVarsFactory();
            }
            $transientVars = $inputs;
            $inputs = clone $transientVars;

            $this->populateTransientMap($entry, $transientVars, $wf->getRegisters(), $initialAction, new ArrayObject(), $ps);

            if (!$this->canInitializeInternal($workflowName, $initialAction, $transientVars, $ps)) {
                $this->context->setRollbackOnly();
                $errMsg = 'You are restricted from initializing this workflow';
                throw new InvalidRoleException($errMsg);
            }

            $action = $wf->getInitialAction($initialAction);

            if (null === $action) {
                $errMsg = sprintf('Invalid initial action id: %s', $initialAction);
                throw new InvalidActionException($errMsg);
            }

            $currentSteps = new SplObjectStorage();
            $this->transitionWorkflow($entry, $currentSteps, $store, $wf, $action, $transientVars, $inputs, $ps);

            $entryId = $entry->getId();
        } catch (WorkflowException $e) {
            $this->context->setRollbackOnly();
            throw new InternalWorkflowException($e->getMessage(), $e->getCode(), $e);
        }


        // now clone the memory PS to the real PS
        //PropertySetManager.clone(ps, store.getPropertySet(entryId));

        return $entryId;
    }

    /**
     * @param WorkflowEntryInterface $entry
     * @param TransientVarsInterface $transientVars
     * @param array|Traversable|RegisterDescriptor[]|SplObjectStorage $registersStorage
     * @param integer $actionId
     * @param array|Traversable $currentSteps
     * @param PropertySetInterface $ps
     *
     *
     * @return TransientVarsInterface
     *
     * @throws InvalidArgumentException
     * @throws WorkflowException
     * @throws InternalWorkflowException
     */
    protected function populateTransientMap(WorkflowEntryInterface $entry, TransientVarsInterface $transientVars, $registersStorage, $actionId = null, $currentSteps, PropertySetInterface $ps)
    {
        $this->validateIterateData($currentSteps);

        $registers = $this->convertDataInArray($registersStorage);


        /** @var RegisterDescriptor[] $registers */

        $transientVars['context'] = $this->context;
        $transientVars['entry'] = $entry;
        $transientVars['entryId'] = $entry->getId();
        $transientVars['store'] = $this->getPersistence();
        $transientVars['configuration'] = $this->getConfiguration();
        $transientVars['descriptor'] = $this->getConfiguration()->getWorkflow($entry->getWorkflowName());

        if (null !== $actionId) {
            $transientVars['actionId'] = $actionId;
        }

        $transientVars['currentSteps'] = $currentSteps;


        foreach ($registers as $register) {
            $args = $register->getArgs();
            $type = $register->getType();

            try {
                $r = $this->getResolver()->getRegister($type, $args);
            } catch (\Exception $e) {
                $errMsg = 'Ошибка при инициализации register';
                $this->context->setRollbackOnly();
                throw new WorkflowException($errMsg, $e->getCode(), $e);
            }

            $variableName = $register->getVariableName();
            try {
                $value = $r->registerVariable($this->context, $entry, $args, $ps);

                $transientVars[$variableName] = $value;
            } catch (\Exception $e) {
                $this->context->setRollbackOnly();

                $errMsg = sprintf(
                    'При получение значения переменной %s из registry %s произошла ошибка',
                    $variableName,
                    get_class($r)
                );

                throw new WorkflowException($errMsg, $e->getCode(), $e);
            }
        }

        return $transientVars;
    }

    /**
     * Проверка того что данные могут быть использованы в цикле
     *
     * @param $data
     *
     * @throws InvalidArgumentException
     */
    protected function validateIterateData($data)
    {
        if (!is_array($data) && !$data  instanceof Traversable) {
            $errMsg = 'Data not iterate';
            throw new InvalidArgumentException($errMsg);
        }
    }

    /**
     * Преобразование данных в массив
     *
     * @param $data
     *
     * @return array
     *
     * @throws InvalidArgumentException
     */
    protected function convertDataInArray($data)
    {
        $result = [];
        if ($data instanceof Traversable) {
            foreach ($data as $k => $v) {
                $result[$k] = $v;
            }
        } elseif (is_array($data)) {
            $result = $data;
        } else {
            $errMsg = 'Data must be an array or an interface to implement Traversable';
            throw new InvalidArgumentException($errMsg);
        }

        return $result;
    }


    /**
     * Переход между двумя статусами
     *
     * @param WorkflowEntryInterface $entry
     * @param SplObjectStorage|StepInterface[] $currentSteps
     * @param WorkflowStoreInterface $store
     * @param WorkflowDescriptor $wf
     * @param ActionDescriptor $action
     * @param TransientVarsInterface $transientVars
     * @param TransientVarsInterface $inputs
     * @param PropertySetInterface $ps
     *
     * @return boolean
     *
     * @throws InternalWorkflowException
     */
    protected function transitionWorkflow(WorkflowEntryInterface $entry, SplObjectStorage $currentSteps, WorkflowStoreInterface $store, WorkflowDescriptor $wf, ActionDescriptor $action, TransientVarsInterface $transientVars, TransientVarsInterface $inputs, PropertySetInterface $ps)
    {
        try {
            $step = $this->getCurrentStep($wf, $action->getId(), $currentSteps, $transientVars, $ps);

            $validators = $action->getValidators();
            if ($validators->count() > 0) {
                $this->verifyInputs($validators, $transientVars, $ps);
            }


            if (null !== $step) {
                $stepPostFunctions = $wf->getStep($step->getStepId())->getPostFunctions();
                foreach ($stepPostFunctions as $function) {
                    $this->executeFunction($function, $transientVars, $ps);
                }
            }

            $preFunctions = $action->getPreFunctions();
            foreach ($preFunctions as $preFunction) {
                $this->executeFunction($preFunction, $transientVars, $ps);
            }

            $conditionalResults = $action->getConditionalResults();
            $extraPreFunctions = null;
            $extraPostFunctions = null;

            $theResult = null;


            $currentStepId = null !== $step ? $step->getStepId()  : -1;
            foreach ($conditionalResults as $conditionalResult) {
                if ($this->passesConditionsWithType(null, $conditionalResult->getConditions(), $transientVars, $ps, $currentStepId)) {
                    $theResult = $conditionalResult;

                    $validatorsStorage = $conditionalResult->getValidators();
                    if ($validatorsStorage->count() > 0) {
                        $this->verifyInputs($validatorsStorage, $transientVars, $ps);
                    }

                    $extraPreFunctions = $conditionalResult->getPreFunctions();
                    $extraPostFunctions = $conditionalResult->getPostFunctions();

                    break;
                }
            }


            if (null ===  $theResult) {
                $theResult = $action->getUnconditionalResult();
                $this->verifyInputs($theResult->getValidators(), $transientVars, $ps);
                $extraPreFunctions = $theResult->getPreFunctions();
                $extraPostFunctions = $theResult->getPostFunctions();
            }

            $logMsg = sprintf('theResult=%s %s', $theResult->getStep(), $theResult->getStatus());
            $this->getLog()->debug($logMsg);


            if ($extraPreFunctions && $extraPreFunctions->count() > 0) {
                foreach ($extraPreFunctions as $function) {
                    $this->executeFunction($function, $transientVars, $ps);
                }
            }

            $split = $theResult->getSplit();
            $join = $theResult->getJoin();
            if (null !== $split && 0 !== $split) {
                $splitDesc = $wf->getSplit($split);
                $results = $splitDesc->getResults();
                $splitPreFunctions = [];
                $splitPostFunctions = [];

                foreach ($results as $resultDescriptor) {
                    if ($resultDescriptor->getValidators()->count() > 0) {
                        $this->verifyInputs($resultDescriptor->getValidators(), $transientVars, $ps);
                    }

                    foreach ($resultDescriptor->getPreFunctions() as $function) {
                        $splitPreFunctions[] = $function;
                    }
                    foreach ($resultDescriptor->getPostFunctions() as $function) {
                        $splitPostFunctions[] = $function;
                    }
                }

                foreach ($splitPreFunctions as $function) {
                    $this->executeFunction($function, $transientVars, $ps);
                }

                if (!$action->isFinish()) {
                    $moveFirst = true;

                    //???????????????????

//                $theResults = [];
//                foreach ($results as $result) {
//                    $theResults[] = $result;
//                }

                    foreach ($results as $resultDescriptor) {
                        $moveToHistoryStep = null;

                        if ($moveFirst) {
                            $moveToHistoryStep = $step;
                        }

                        $previousIds = [];

                        if (null !== $step) {
                            $previousIds[] = $step->getStepId();
                        }

                        $this->createNewCurrentStep($resultDescriptor, $entry, $store, $action->getId(), $moveToHistoryStep, $previousIds, $transientVars, $ps);
                        $moveFirst = false;
                    }
                }


                foreach ($splitPostFunctions as $function) {
                    $this->executeFunction($function, $transientVars, $ps);
                }
            } elseif (null !== $join && 0 !== $join) {
                $joinDesc = $wf->getJoin($join);
                $oldStatus = $theResult->getOldStatus();
                $caller = $this->context->getCaller();
                if (null !== $step) {
                    $step = $store->markFinished($step, $action->getId(), new DateTime(), $oldStatus, $caller);
                } else {
                    $errMsg = 'Invalid step';
                    throw new InternalWorkflowException($errMsg);
                }


                $store->moveToHistory($step);

                /** @var StepInterface[] $joinSteps */
                $joinSteps = [];
                $joinSteps[] = $step;

                $joinSteps = $this->buildJoinsSteps($currentSteps, $step, $wf, $join, $joinSteps);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

                $historySteps = $store->findHistorySteps($entry->getId());

                $joinSteps = $this->buildJoinsSteps($historySteps, $step, $wf, $join, $joinSteps);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}


                $jn = new JoinNodes($joinSteps);
                $transientVars['jn'] = $jn;


                if ($this->passesConditionsWithType(null, $joinDesc->getConditions(), $transientVars, $ps, 0)) {
                    $joinResult = $joinDesc->getResult();

                    $joinResultValidators = $joinResult->getValidators();
                    if ($joinResultValidators->count() > 0) {
                        $this->verifyInputs($joinResultValidators, $transientVars, $ps);
                    }

                    foreach ($joinResult->getPreFunctions() as $function) {
                        $this->executeFunction($function, $transientVars, $ps);
                    }

                    $previousIds = [];
                    $i = 1;

                    foreach ($joinSteps as  $currentJoinStep) {
                        if (!$historySteps->contains($currentJoinStep) && $currentJoinStep->getId() !== $step->getId()) {
                            $store->moveToHistory($step);
                        }

                        $previousIds[$i] = $currentJoinStep->getId();
                    }

                    if (!$action->isFinish()) {
                        $previousIds[0] = $step->getId();
                        $theResult = $joinDesc->getResult();

                        $this->createNewCurrentStep($theResult, $entry, $store, $action->getId(), null, $previousIds, $transientVars, $ps);
                    }

                    foreach ($joinResult->getPostFunctions() as $function) {
                        $this->executeFunction($function, $transientVars, $ps);
                    }
                }
            } else {
                $previousIds = [];

                if (null !== $step) {
                    $previousIds[] = $step->getId();
                }

                if (!$action->isFinish()) {
                    $this->createNewCurrentStep($theResult, $entry, $store, $action->getId(), $step, $previousIds, $transientVars, $ps);
                }
            }

            if ($extraPostFunctions && $extraPostFunctions->count() > 0) {
                foreach ($extraPostFunctions as $function) {
                    $this->executeFunction($function, $transientVars, $ps);
                }
            }

            if (WorkflowEntryInterface::COMPLETED !== $entry->getState() && null !== $wf->getInitialAction($action->getId())) {
                $this->changeEntryState($entry->getId(), WorkflowEntryInterface::ACTIVATED);
            }

            if ($action->isFinish()) {
                $this->completeEntry($action, $entry->getId(), $this->getCurrentSteps($entry->getId()), WorkflowEntryInterface::COMPLETED);
                return true;
            }

            $availableAutoActions = $this->getAvailableAutoActions($entry->getId(), $inputs);

            if (count($availableAutoActions) > 0) {
                $this->doAction($entry->getId(), $availableAutoActions[0], $inputs);
            }

            return false;
        } catch (\Exception $e) {
            throw new InternalWorkflowException($e->getMessage(), $e->getCode(), $e);
        }
    }

    /**
     * Подготавливает данные о шагах используемых в объеденение
     *
     * @param StepInterface[]    $steps
     * @param StepInterface      $step
     * @param WorkflowDescriptor $wf
     * @param integer            $join
     *
     * @param array              $joinSteps
     *
     * @return array
     *
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    protected function buildJoinsSteps($steps, StepInterface $step, WorkflowDescriptor $wf, $join, array $joinSteps = [])
    {
        foreach ($steps as $currentStep) {
            if ($currentStep->getId() !== $step->getId()) {
                $stepDesc = $wf->getStep($currentStep->getStepId());

                if ($stepDesc->resultsInJoin($join)) {
                    $joinSteps[] = $currentStep;
                }
            }
        }

        return $joinSteps;
    }

    /**
     * @param       $id
     * @param TransientVarsInterface $inputs
     *
     * @return array
     */
    protected function getAvailableAutoActions($id, TransientVarsInterface $inputs)
    {
        try {
            $store = $this->getPersistence();
            $entry = $store->findEntry($id);

            if (null === $entry) {
                $errMsg = sprintf(
                    'Нет сущности workflow c id %s',
                    $id
                );
                throw new InvalidArgumentException($errMsg);
            }


            if (WorkflowEntryInterface::ACTIVATED !== $entry->getState()) {
                $logMsg = sprintf('--> состояние %s', $entry->getState());
                $this->getLog()->debug($logMsg);
                return [0];
            }

            $wf = $this->getConfiguration()->getWorkflow($entry->getWorkflowName());

            $l = [];
            $ps = $store->getPropertySet($id);
            $transientVars = $inputs;
            $currentSteps = $store->findCurrentSteps($id);

            $this->populateTransientMap($entry, $transientVars, $wf->getRegisters(), 0, $currentSteps, $ps);

            $globalActions = $wf->getGlobalActions();

            foreach ($globalActions as $action) {

                $transientVars['actionId'] = $action->getId();

                if ($action->getAutoExecute() && $this->isActionAvailable($action, $transientVars, $ps, 0)) {
                    $l[] = $action->getId();
                }
            }

            foreach ($currentSteps as $step) {

                $availableAutoActionsForStep = $this->getAvailableAutoActionsForStep($wf, $step, $transientVars, $ps);
                foreach ($availableAutoActionsForStep as $v) {
                    $l[] = $v;
                }
                //$l = array_merge($l, $availableAutoActionsForStep);

            }

            $l = array_unique($l);

            return $l;
        } catch (\Exception $e) {
            $errMsg = 'Ошибка при проверке доступных действий';
            $this->getLog()->error($errMsg, [$e]);
        }

        return [];
    }


    /**
     * @param WorkflowDescriptor   $wf
     * @param StepInterface        $step
     * @param TransientVarsInterface                $transientVars
     * @param PropertySetInterface $ps
     *
     * @return array
     *
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     * @throws InternalWorkflowException
     * @throws WorkflowException
     */
    protected function getAvailableAutoActionsForStep(WorkflowDescriptor $wf, StepInterface $step, TransientVarsInterface $transientVars, PropertySetInterface $ps)
    {
        $l = [];
        $s = $wf->getStep($step->getStepId());

        if (null === $s) {
            $msg = sprintf('getAvailableAutoActionsForStep вызвана с несуществующим id %s', $step->getStepId());
            $this->getLog()->debug($msg);
            return $l;
        }


        $actions = $s->getActions();
        if (null === $actions || 0 === $actions->count()) {
            return $l;
        }

        foreach ($actions as $action) {

            $transientVars['actionId'] = $action->getId();

            if ($action->getAutoExecute() && $this->isActionAvailable($action, $transientVars, $ps, 0)) {
                $l[] = $action->getId();
            }
        }

        return $l;
    }

    /**
     * @param ActionDescriptor $action
     * @param                  $id
     * @param array|Traversable $currentSteps
     * @param                  $state
     *
     * @return void
     *
     * @throws InvalidArgumentException
     * @throws InternalWorkflowException
     */
    protected function completeEntry(ActionDescriptor $action = null, $id, $currentSteps, $state)
    {
        $this->validateIterateData($currentSteps);


        $this->getPersistence()->setEntryState($id, $state);

        $oldStatus = null !== $action ? $action->getUnconditionalResult()->getOldStatus() : 'Finished';
        $actionIdValue = null !== $action ? $action->getId() : -1;
        foreach ($currentSteps as $step) {
            $this->getPersistence()->markFinished($step, $actionIdValue, new DateTime(), $oldStatus, $this->context->getCaller());
            $this->getPersistence()->moveToHistory($step);
        }
    }
    /**
     * @param ResultDescriptor       $theResult
     * @param WorkflowEntryInterface $entry
     * @param WorkflowStoreInterface $store
     * @param integer                $actionId
     * @param StepInterface          $currentStep
     * @param array                  $previousIds
     * @param TransientVarsInterface                  $transientVars
     * @param PropertySetInterface   $ps
     *
     * @return StepInterface
     *
     * @throws InternalWorkflowException
     * @throws StoreException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     * @throws WorkflowException
     */
    protected function createNewCurrentStep(
        ResultDescriptor $theResult,
        WorkflowEntryInterface $entry,
        WorkflowStoreInterface $store,
        $actionId,
        StepInterface $currentStep = null,
        array $previousIds = [],
        TransientVarsInterface $transientVars,
        PropertySetInterface $ps
    ) {
        try {
            $nextStep = $theResult->getStep();

            if (-1 === $nextStep) {
                if (null !== $currentStep) {
                    $nextStep = $currentStep->getStepId();
                } else {
                    $errMsg = 'Неверный аргумент. Новый шаг является таким же как текущий. Но текущий шаг не указан';
                    throw new StoreException($errMsg);
                }
            }

            $owner = $theResult->getOwner();

            $logMsg = sprintf(
                'Результат: stepId=%s, status=%s, owner=%s, actionId=%s, currentStep=%s',
                $nextStep,
                $theResult->getStatus(),
                $owner,
                $actionId,
                null !== $currentStep ? $currentStep->getId() : 0
            );
            $this->getLog()->debug($logMsg);

            $variableResolver = $this->getConfiguration()->getVariableResolver();

            if (null !== $owner) {
                $o = $variableResolver->translateVariables($owner, $transientVars, $ps);
                $owner = null !== $o ? (string)$o : null;
            }


            $oldStatus = $theResult->getOldStatus();
            $oldStatus = (string)$variableResolver->translateVariables($oldStatus, $transientVars, $ps);

            $status = $theResult->getStatus();
            $status = (string)$variableResolver->translateVariables($status, $transientVars, $ps);


            if (null !== $currentStep) {
                $store->markFinished($currentStep, $actionId, new DateTime(), $oldStatus, $this->context->getCaller());
                $store->moveToHistory($currentStep);
            }

            $startDate = new DateTime();
            $dueDate = null;

            $theResultDueDate = (string)$theResult->getDueDate();
            $theResultDueDate = trim($theResultDueDate);
            if (strlen($theResultDueDate) > 0) {
                $dueDateObject = $variableResolver->translateVariables($theResultDueDate, $transientVars, $ps);

                if ($dueDateObject instanceof DateTime) {
                    $dueDate = $dueDateObject;
                } elseif (is_string($dueDateObject)) {
                    $dueDate = new DateTime($dueDate);
                } elseif (is_numeric($dueDateObject)) {
                    $dueDate = DateTime::createFromFormat('U', $dueDateObject);
                    if (false === $dueDate) {
                        $errMsg = 'Invalid due date conversion';
                        throw new Exception\InternalWorkflowException($errMsg);
                    }
                }
            }

            $newStep = $store->createCurrentStep($entry->getId(), $nextStep, $owner, $startDate, $dueDate, $status, $previousIds);
            $transientVars['createdStep'] =  $newStep;

            if (null === $currentStep && 0 === count($previousIds)) {
                $currentSteps = [];
                $currentSteps[] = $newStep;
                $transientVars['currentSteps'] =  $currentSteps;
            }

            if (! $transientVars->offsetExists('descriptor')) {
                $errMsg = 'Ошибка при получение дескриптора workflow из transientVars';
                throw new InternalWorkflowException($errMsg);
            }

            /** @var WorkflowDescriptor $descriptor */
            $descriptor = $transientVars['descriptor'];
            $step = $descriptor->getStep($nextStep);

            if (null === $step) {
                $errMsg = sprintf('Шаг #%s не найден', $nextStep);
                throw new WorkflowException($errMsg);
            }

            $preFunctions = $step->getPreFunctions();

            foreach ($preFunctions as $function) {
                $this->executeFunction($function, $transientVars, $ps);
            }
        } catch (WorkflowException $e) {
            $this->context->setRollbackOnly();
            /** @var WorkflowException $e */
            throw $e;
        }
    }

    /**
     * Создает хранилище переменных
     *
     * @param $class
     *
     * @return TransientVarsInterface
     */
    protected function transientVarsFactory($class = BaseTransientVars::class)
    {
        $r = new \ReflectionClass($class);
        return $r->newInstance();
    }

    /**
     *
     *
     * Осуществляет переходл в новое состояние, для заданного процесса workflow
     *
     * @param integer $entryId id запущенного процесса workflow
     * @param integer $actionId id действия, доступного та текущем шаеге процессса workflow
     * @param TransientVarsInterface $inputs Входные данные для перехода
     *
     * @return void
     *
     * @throws WorkflowException
     * @throws InvalidActionException
     * @throws InvalidArgumentException
     * @throws InternalWorkflowException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function doAction($entryId, $actionId, TransientVarsInterface $inputs = null)
    {
        $actionId = (integer)$actionId;
        if (null === $inputs) {
            $inputs = $this->transientVarsFactory();
        }
        $transientVars = $inputs;
        $inputs = clone $transientVars;

        $store = $this->getPersistence();
        $entry = $store->findEntry($entryId);

        if (WorkflowEntryInterface::ACTIVATED !== $entry->getState()) {
            return;
        }

        $wf = $this->getConfiguration()->getWorkflow($entry->getWorkflowName());

        $currentSteps = $store->findCurrentSteps($entryId);
        $action = null;

        $ps = $store->getPropertySet($entryId);

        $this->populateTransientMap($entry, $transientVars, $wf->getRegisters(), $actionId, $currentSteps, $ps);


        $validAction = false;

        foreach ($wf->getGlobalActions() as $actionDesc) {
            if ($actionId === $actionDesc->getId()) {
                $action = $actionDesc;

                if ($this->isActionAvailable($action, $transientVars, $ps, 0)) {
                    $validAction = true;
                }
            }
        }


        foreach ($currentSteps as $step) {
            $s = $wf->getStep($step->getStepId());

            foreach ($s->getActions() as $actionDesc) {
                if (!$actionDesc instanceof ActionDescriptor) {
                    $errMsg = 'Invalid action descriptor';
                    throw new InternalWorkflowException($errMsg);
                }

                if ($actionId === $actionDesc->getId()) {
                    $action = $actionDesc;

                    if ($this->isActionAvailable($action, $transientVars, $ps, $s->getId())) {
                        $validAction = true;
                    }
                }
            }
        }


        if (!$validAction) {
            $errMsg = sprintf(
                'Action %s is invalid',
                $actionId
            );
            throw new InvalidActionException($errMsg);
        }


        try {
            if ($this->transitionWorkflow($entry, $currentSteps, $store, $wf, $action, $transientVars, $inputs, $ps)) {
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                $this->checkImplicitFinish($action, $entryId);
            }
        } catch (WorkflowException $e) {
            $this->context->setRollbackOnly();
            /** @var  WorkflowException $e*/
            throw $e;
        }
    }

    /**
     * @param ActionDescriptor $action
     * @param                  $id
     *
     * @return void
     *
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     * @throws InvalidArgumentException
     * @throws InternalWorkflowException
     */
    protected function checkImplicitFinish(ActionDescriptor $action, $id)
    {
        $store = $this->getPersistence();
        $entry = $store->findEntry($id);

        $wf = $this->getConfiguration()->getWorkflow($entry->getWorkflowName());

        $currentSteps = $store->findCurrentSteps($id);

        $isCompleted = $wf->getGlobalActions()->count() === 0;

        foreach ($currentSteps as $step) {
            if ($isCompleted) {
                break;
            }

            $stepDes = $wf->getStep($step->getStepId());

            if ($stepDes->getActions()->count() > 0) {
                $isCompleted = true;
            }
        }

        if ($isCompleted) {
            $this->completeEntry($action, $id, $currentSteps, WorkflowEntryInterface::COMPLETED);
        }
    }

    /**
     *
     * Check if the state of the specified workflow instance can be changed to the new specified one.
     *
     * @param integer $id The workflow instance id.
     * @param integer $newState The new state id.
     *
     * @return boolean true if the state of the workflow can be modified, false otherwise.
     *
     * @throws InternalWorkflowException
     */
    public function canModifyEntryState($id, $newState)
    {
        $store = $this->getPersistence();
        $entry = $store->findEntry($id);

        $currentState = $entry->getState();

        $result = false;
        try {
            switch ($newState) {
                case WorkflowEntryInterface::COMPLETED: {
                    if (WorkflowEntryInterface::ACTIVATED === $currentState) {
                        $result = true;
                    }
                    break;
                }

                //@TODO Разобраться с бизнес логикой. Может быть нужно добавить break
                /** @noinspection PhpMissingBreakStatementInspection */
                case WorkflowEntryInterface::CREATED: {
                    $result = false;
                }
                case WorkflowEntryInterface::ACTIVATED: {

                    if (WorkflowEntryInterface::CREATED === $currentState || WorkflowEntryInterface::SUSPENDED === $currentState) {
                        $result = true;
                    }
                    break;
                }
                case WorkflowEntryInterface::SUSPENDED: {
                    if (WorkflowEntryInterface::ACTIVATED === $currentState) {
                        $result = true;
                    }
                    break;
                }
                case WorkflowEntryInterface::KILLED: {

                    if (WorkflowEntryInterface::CREATED === $currentState || WorkflowEntryInterface::ACTIVATED === $currentState || WorkflowEntryInterface::SUSPENDED === $currentState) {
                        $result = true;
                    }
                    break;
                }
                default: {
                    $result = false;
                    break;
                }

            }

            return $result;
        } catch (StoreException $e) {
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
            $errMsg = sprintf(
                'Ошибка проверки изменения состояния для инстанса #%s',
                $id
            );
            $this->getLog()->error($errMsg, [$e]);
        }

        return false;
    }


    /**
     *
     * Возвращает коллекцию объектов описывающие состояние для текущего экземпляра workflow
     *
     * @param integer $entryId id экземпляра workflow
     *
     * @return SplObjectStorage|StepInterface[]
     *
     * @throws InternalWorkflowException
     */
    public function getCurrentSteps($entryId)
    {
        return $this->getStepFromStorage($entryId, static::CURRENT_STEPS);
    }

    /**
     * Возвращает информацию о том в какие шаги, были осуществленны переходы, для процесса workflow с заданным id
     *
     * @param integer $entryId уникальный идентификатор процесса workflow
     *
     * @return StepInterface[]|SplObjectStorage список шагов
     *
     * @throws InternalWorkflowException
     */
    public function getHistorySteps($entryId)
    {
        return $this->getStepFromStorage($entryId, static::HISTORY_STEPS);
    }

    /**
     * Получение шагов информации о шагах процесса workflow
     *
     * @param $entryId
     * @param $type
     *
     * @return Spi\StepInterface[]|SplObjectStorage
     *
     * @throws InternalWorkflowException
     */
    protected function getStepFromStorage($entryId, $type)
    {
        try {
            $store = $this->getPersistence();

            if (static::CURRENT_STEPS === $type) {
                return $store->findCurrentSteps($entryId);
            } elseif (static::HISTORY_STEPS === $type) {
                return $store->findHistorySteps($entryId);
            }
        } catch (StoreException $e) {
            $errMsg = sprintf(
                'Ошибка при получение истории шагов для экземпляра workflow c id# %s',
                $entryId
            );
            $this->getLog()->error($errMsg, [$e]);
        }

        return new SplObjectStorage();
    }



    /**
     *
     *
     * Modify the state of the specified workflow instance.
     * @param integer $id The workflow instance id.
     * @param integer $newState the new state to change the workflow instance to.
     *
     * @throws InvalidArgumentException
     * @throws InvalidEntryStateException
     * @throws InternalWorkflowException
     */
    public function changeEntryState($id, $newState)
    {
        $store = $this->getPersistence();
        $entry = $store->findEntry($id);

        if ($newState === $entry->getState()) {
            return;
        }

        if ($this->canModifyEntryState($id, $newState)) {
            if (WorkflowEntryInterface::KILLED === $newState || WorkflowEntryInterface::COMPLETED === $newState) {
                $currentSteps = $this->getCurrentSteps($id);

                if (count($currentSteps) > 0) {
                    $this->completeEntry(null, $id, $currentSteps, $newState);
                }
            }

            $store->setEntryState($id, $newState);
        } else {
            $errMsg = sprintf(
                'Не возможен переход в экземпляре workflow #%s. Текущее состояние %s, ожидаемое состояние %s',
                $id,
                $entry->getState(),
                $newState
            );

            throw new InvalidEntryStateException($errMsg);
        }

        $msg = sprintf(
            '%s : Новое состояние: %s',
            $entry->getId(),
            $entry->getState()
        );
        $this->getLog()->debug($msg);
    }


    /**
     * @param FunctionDescriptor $function
     * @param TransientVarsInterface $transientVars
     * @param PropertySetInterface $ps
     *
     * @throws WorkflowException
     * @throws InternalWorkflowException
     */
    protected function executeFunction(FunctionDescriptor $function, TransientVarsInterface $transientVars, PropertySetInterface $ps)
    {
        if (null !== $function) {
            $type = $function->getType();

            $argsOriginal = $function->getArgs();
            $args = $this->prepareArgs($argsOriginal, $transientVars, $ps);

            $provider = $this->getResolver()->getFunction($type, $args);

            if (null === $provider) {
                $this->context->setRollbackOnly();
                $errMsg = 'Не загружен провайдер для функции';
                throw new WorkflowException($errMsg);
            }

            try {
                $provider->execute($transientVars, $args, $ps);
            } catch (WorkflowException $e) {
                $this->context->setRollbackOnly();
                /** @var  WorkflowException $e*/
                throw $e;
            }
        }
    }


    /**
     * @param $validatorsStorage
     * @param TransientVarsInterface $transientVars
     * @param PropertySetInterface $ps
     *
     * @throws WorkflowException
     * @throws InvalidArgumentException
     * @throws InternalWorkflowException
     * @throws InvalidInputException
     */
    protected function verifyInputs($validatorsStorage, TransientVarsInterface $transientVars, PropertySetInterface $ps)
    {
        $validators = $this->convertDataInArray($validatorsStorage);

        /** @var ValidatorDescriptor[] $validators */
        foreach ($validators as $input) {
            if (null !== $input) {
                $type = $input->getType();
                $argsOriginal = $input->getArgs();

                $args = $this->prepareArgs($argsOriginal, $transientVars, $ps);


                $validator = $this->getResolver()->getValidator($type, $args);

                if (null === $validator) {
                    $this->context->setRollbackOnly();
                    $errMsg = 'Ошибка при загрузке валидатора';
                    throw new WorkflowException($errMsg);
                }

                try {
                    $validator->validate($transientVars, $args, $ps);
                } catch (InvalidInputException $e) {
                    /** @var  InvalidInputException $e*/
                    throw $e;
                } catch (\Exception $e) {
                    $this->context->setRollbackOnly();

                    if ($e instanceof WorkflowException) {
                        /** @var  WorkflowException $e*/
                        throw $e;
                    }

                    throw new WorkflowException($e->getMessage(), $e->getCode(), $e);
                }
            }
        }
    }


    /**
     * Возвращает текущий шаг
     *
     * @param WorkflowDescriptor $wfDesc
     * @param integer $actionId
     * @param StepInterface[]|SplObjectStorage $currentSteps
     * @param TransientVarsInterface $transientVars
     * @param PropertySetInterface $ps
     *
     * @return StepInterface
     *
     * @throws InternalWorkflowException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     * @throws WorkflowException
     */
    protected function getCurrentStep(WorkflowDescriptor $wfDesc, $actionId, SplObjectStorage $currentSteps, TransientVarsInterface $transientVars, PropertySetInterface $ps)
    {
        if (1 === $currentSteps->count()) {
            $currentSteps->rewind();
            return $currentSteps->current();
        }


        foreach ($currentSteps as $step) {
            $stepId = $step->getId();
            $action = $wfDesc->getStep($stepId)->getAction($actionId);

            if ($this->isActionAvailable($action, $transientVars, $ps, $stepId)) {
                return $step;
            }
        }

        return null;
    }

    /**
     * @param ActionDescriptor|null $action
     * @param TransientVarsInterface $transientVars
     * @param PropertySetInterface $ps
     * @param $stepId
     *
     * @return boolean
     *
     * @throws InternalWorkflowException
     * @throws InternalWorkflowException
     * @throws WorkflowException
     */
    protected function isActionAvailable(ActionDescriptor $action = null, TransientVarsInterface $transientVars, PropertySetInterface $ps, $stepId)
    {
        if (null === $action) {
            return false;
        }

        $result = null;
        $actionHash = spl_object_hash($action);

        $result = array_key_exists($actionHash, $this->stateCache) ? $this->stateCache[$actionHash] : $result;

        $wf = $this->getWorkflowDescriptorForAction($action);


        if (null === $result) {
            $restriction = $action->getRestriction();
            $conditions = null;

            if (null !== $restriction) {
                $conditions = $restriction->getConditionsDescriptor();
            }

            $result = $this->passesConditionsByDescriptor($wf->getGlobalConditions(), $transientVars, $ps, $stepId)
                && $this->passesConditionsByDescriptor($conditions, $transientVars, $ps, $stepId);

            $this->stateCache[$actionHash] = $result;
        }


        $result = (boolean)$result;

        return $result;
    }

    /**
     * По дейсвтию получаем дексрипторв workflow
     *
     * @param ActionDescriptor $action
     *
     * @return WorkflowDescriptor
     *
     * @throws InternalWorkflowException
     */
    private function getWorkflowDescriptorForAction(ActionDescriptor $action)
    {
        $objWfd = $action;

        $count = 0;
        while (!$objWfd instanceof WorkflowDescriptor || null === $objWfd) {
            $objWfd = $objWfd->getParent();

            $count++;
            if ($count > 10) {
                $errMsg = 'Ошибка при получение WorkflowDescriptor';
                throw new InternalWorkflowException($errMsg);
            }
        }

        return $objWfd;
    }


    /**
     * Проверяет имеет ли пользователь достаточно прав, что бы иниициировать вызываемый процесс
     *
     * @param string $workflowName имя workflow
     * @param integer $initialAction id начального состояния
     * @param TransientVarsInterface $inputs
     *
     * @return bool
     *
     * @throws InvalidArgumentException
     * @throws WorkflowException
     * @throws InternalWorkflowException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function canInitialize($workflowName, $initialAction, TransientVarsInterface $inputs = null)
    {
        $mockWorkflowName = $workflowName;
        $mockEntry = new SimpleWorkflowEntry(0, $mockWorkflowName, WorkflowEntryInterface::CREATED);

        try {
            $ps = PropertySetManager::getInstance('memory', null);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            if (!$ps instanceof PropertySetInterface) {
                $errMsg = 'Invalid create PropertySet';
                throw new InternalWorkflowException($errMsg);
            }
        } catch (\Exception $e) {
            throw new InternalWorkflowException($e->getMessage(), $e->getCode(), $e);
        }




        if (null === $inputs) {
            $inputs = $this->transientVarsFactory();
        }
        $transientVars = $inputs;

        try {
            $this->populateTransientMap($mockEntry, $transientVars, [], $initialAction, [], $ps);

            $result = $this->canInitializeInternal($workflowName, $initialAction, $transientVars, $ps);

            return $result;
        } catch (InvalidActionException $e) {
            $this->getLog()->error($e->getMessage(), [$e]);

            return false;
        } catch (WorkflowException $e) {
            $errMsg = sprintf(
                'Ошибка при проверки canInitialize: %s',
                $e->getMessage()
            );
            $this->getLog()->error($errMsg, [$e]);

            return false;
        }
    }


    /**
     * Проверяет имеет ли пользователь достаточно прав, что бы иниициировать вызываемый процесс
     *
     * @param string $workflowName имя workflow
     * @param integer $initialAction id начального состояния
     * @param TransientVarsInterface $transientVars
     *
     * @param PropertySetInterface $ps
     *
     * @return bool
     *
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     * @throws InvalidActionException
     * @throws InternalWorkflowException
     * @throws WorkflowException
     */
    protected function canInitializeInternal($workflowName, $initialAction, TransientVarsInterface $transientVars, PropertySetInterface $ps)
    {
        $wf = $this->getConfiguration()->getWorkflow($workflowName);

        $actionDescriptor = $wf->getInitialAction($initialAction);

        if (null === $actionDescriptor) {
            $errMsg = sprintf(
                'Некорректное инициирующие действие # %s',
                $initialAction
            );
            throw new InvalidActionException($errMsg);
        }

        $restriction = $actionDescriptor->getRestriction();


        $conditions = null;
        if (null !== $restriction) {
            $conditions = $restriction->getConditionsDescriptor();
        }

        $passesConditions = $this->passesConditionsByDescriptor($conditions, $transientVars, $ps, 0);

        return $passesConditions;
    }

    /**
     * Возвращает резолвер
     *
     * @return TypeResolverInterface
     */
    public function getResolver()
    {
        if (null !== $this->typeResolver) {
            return $this->typeResolver;
        }

        $classResolver = $this->getDefaultTypeResolverClass();
        $r = new ReflectionClass($classResolver);
        $resolver = $r->newInstance();
        $this->typeResolver = $resolver;

        return $this->typeResolver;
    }

    /**
     * Возвращает хранилище состояния workflow
     *
     * @return WorkflowStoreInterface
     *
     * @throws InternalWorkflowException
     */
    protected function getPersistence()
    {
        return $this->getConfiguration()->getWorkflowStore();
    }

    /**
     * Получить конфигурацию workflow. Метод также проверяет была ли иницилазированн конфигурация, если нет, то
     * инициализирует ее.
     *
     * Если конфигурация не была установленна, то возвращает конфигурацию по умолчанию
     *
     * @return ConfigurationInterface|DefaultConfiguration Конфигурация которая была установленна
     *
     * @throws InternalWorkflowException
     */
    public function getConfiguration()
    {
        $config = null !== $this->configuration ? $this->configuration : DefaultConfiguration::getInstance();

        if (!$config->isInitialized()) {
            try {
                $config->load(null);
            } catch (FactoryException $e) {
                $errMsg = 'Ошибка при иницилазации конфигурации workflow';
                $this->getLog()->critical($errMsg, ['exception' => $e]);
                throw new InternalWorkflowException($errMsg, $e->getCode(), $e);
            }
        }

        return $config;
    }

    /**
     * @return LoggerInterface
     */
    public function getLog()
    {
        return $this->log;
    }

    /**
     * @param LoggerInterface $log
     *
     * @return $this
     *
     * @throws InternalWorkflowException
     */
    public function setLog($log)
    {
        try {
            LogFactory::validLogger($log);
        } catch (\Exception $e) {
            $errMsg = 'Ошибка при валидации логера';
            throw new InternalWorkflowException($errMsg, $e->getCode(), $e);
        }


        $this->log = $log;

        return $this;
    }


    /**
     * Get the workflow descriptor for the specified workflow name.
     *
     * @param string $workflowName The workflow name.
     * @return WorkflowDescriptor
     *
     * @throws InternalWorkflowException
     */
    public function getWorkflowDescriptor($workflowName)
    {
        try {
            return $this->getConfiguration()->getWorkflow($workflowName);
        } catch (FactoryException $e) {
            $errMsg = 'Ошибка при загрузке workflow';
            $this->getLog()->error($errMsg, ['exception' => $e]);
            throw new InternalWorkflowException($errMsg, $e->getCode(), $e);
        }
    }


    /**
     * Executes a special trigger-function using the context of the given workflow instance id.
     * Note that this method is exposed for Quartz trigger jobs, user code should never call it.
     *
     * @param integer $id The workflow instance id
     * @param integer $triggerId The id of the special trigger-function
     *
     * @throws InvalidArgumentException
     * @throws WorkflowException
     * @throws InternalWorkflowException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    public function executeTriggerFunction($id, $triggerId)
    {
        $store = $this->getPersistence();
        $entry = $store->findEntry($id);

        if (null === $entry) {
            $errMsg = sprintf(
                'Ошибка при выполнение тригера # %s для несуществующего экземпляра workflow id# %s',
                $triggerId,
                $id
            );
            $this->getLog()->warning($errMsg);
            return;
        }

        $wf = $this->getConfiguration()->getWorkflow($entry->getWorkflowName());

        $ps = $store->getPropertySet($id);
        $transientVars = $this->transientVarsFactory();

        $this->populateTransientMap($entry, $transientVars, $wf->getRegisters(), null, $store->findCurrentSteps($id), $ps);

        $this->executeFunction($wf->getTriggerFunction($triggerId), $transientVars, $ps);
    }

    /**
     * @param $id
     * @param $inputs
     *
     * @return array
     *
     */
    public function getAvailableActions($id, TransientVarsInterface $inputs = null)
    {
        try {
            $store = $this->getPersistence();
            $entry = $store->findEntry($id);

            if (null === $entry) {
                $errMsg = sprintf(
                    'Не существует экземпляра workflow c id %s',
                    $id
                );
                throw new InvalidArgumentException($errMsg);
            }

            if (WorkflowEntryInterface::ACTIVATED === $entry->getState()) {
                return [];
            }

            $wf = $this->getConfiguration()->getWorkflow($entry->getWorkflowName());

            $l = [];
            $ps = $store->getPropertySet($id);

            $transientVars = $inputs;
            if (null === $transientVars) {
                $transientVars = $this->transientVarsFactory();
            }

            $currentSteps = $store->findCurrentSteps($id);

            $this->populateTransientMap($entry, $transientVars, $wf->getRegisters(), 0, $currentSteps, $ps);

            $globalActions = $wf->getGlobalActions();

            foreach ($globalActions as $action) {
                $restriction = $action->getRestriction();
                $conditions = null;

                $transientVars['actionId'] = $action->getId();

                if (null !== $restriction) {
                    $conditions = $restriction->getConditionsDescriptor();
                }

                $flag = $this->passesConditionsByDescriptor($wf->getGlobalConditions(), $transientVars, $ps, 0) && $this->passesConditionsByDescriptor($conditions, $transientVars, $ps, 0);
                if ($flag) {
                    $l[] = $action->getId();
                }
            }


            foreach ($currentSteps as $step) {

                $data = $this->getAvailableActionsForStep($wf, $step, $transientVars, $ps);
                foreach ($data as $v) {
                    $l[] = $v;
                }
            }
            return array_unique($l);
        } catch (\Exception $e) {
            $errMsg = 'Ошибка проверки доступных действий';
            $this->getLog()->error($errMsg, [$e]);
        }

        return [];
    }

    /**
     * @param WorkflowDescriptor   $wf
     * @param StepInterface        $step
     * @param TransientVarsInterface                $transientVars
     * @param PropertySetInterface $ps
     *
     * @return array
     *
     * @throws InternalWorkflowException
     * @throws WorkflowException
     * @throws \OldTown\Workflow\Exception\ArgumentNotNumericException
     */
    protected function getAvailableActionsForStep(WorkflowDescriptor $wf, StepInterface $step, TransientVarsInterface $transientVars, PropertySetInterface $ps)
    {
        $l = [];
        $s = $wf->getStep($step->getStepId());

        if (null === $s) {
            $errMsg = sprintf(
                'getAvailableActionsForStep вызван с не существующим id шага %s',
                $step->getStepId()
            );

            $this->getLog()->warning($errMsg);

            return $l;
        }

        $actions  = $s->getActions();

        if (null === $actions || 0  === $actions->count()) {
            return $l;
        }

        foreach ($actions as $action) {
            $restriction = $action->getRestriction();
            $conditions = null;

            $transientVars['actionId'] = $action->getId();


            if (null !== $restriction) {
                $conditions = $restriction->getConditionsDescriptor();
            }

            $f = $this->passesConditionsByDescriptor($wf->getGlobalConditions(), $transientVars, $ps, $s->getId())
                 && $this->passesConditionsByDescriptor($conditions, $transientVars, $ps, $s->getId());
            if ($f) {
                $l[] = $action->getId();
            }
        }

        return $l;
    }

    /**
     * @param ConfigurationInterface $configuration
     *
     * @return $this
     */
    public function setConfiguration(ConfigurationInterface $configuration)
    {
        $this->configuration = $configuration;

        return $this;
    }

    /**
     * Возвращает состояние для текущего экземпляра workflow
     *
     * @param integer $id id экземпляра workflow
     * @return integer id текущего состояния
     *
     * @throws InternalWorkflowException
     */
    public function getEntryState($id)
    {
        try {
            $store = $this->getPersistence();

            return $store->findEntry($id)->getState();
        } catch (StoreException $e) {
            $errMsg = sprintf(
                'Ошибка при получение состояния экземпляра workflow c id# %s',
                $id
            );
            $this->getLog()->error($errMsg, [$e]);
        }

        return WorkflowEntryInterface::UNKNOWN;
    }


    /**
     * Настройки хранилища
     *
     * @return array
     *
     * @throws InternalWorkflowException
     */
    public function getPersistenceProperties()
    {
        return $this->getConfiguration()->getPersistenceArgs();
    }


    /**
     * Get the PropertySet for the specified workflow instance id.
     * @param integer $id The workflow instance id.
     *
     * @return PropertySetInterface
     * @throws InternalWorkflowException
     */
    public function getPropertySet($id)
    {
        $ps = null;

        try {
            $ps = $this->getPersistence()->getPropertySet($id);
        } catch (StoreException $e) {
            $errMsg = sprintf(
                'Ошибка при получение PropertySet для экземпляра workflow c id# %s',
                $id
            );
            $this->getLog()->error($errMsg, [$e]);
        }

        return $ps;
    }

    /**
     * @return string[]
     *
     * @throws InternalWorkflowException
     */
    public function getWorkflowNames()
    {
        try {
            return $this->getConfiguration()->getWorkflowNames();
        } catch (FactoryException $e) {
            $errMsg = 'Ошибка при получение имен workflow';
            $this->getLog()->error($errMsg, [$e]);
        }

        return [];
    }

    /**
     * @param TypeResolverInterface $typeResolver
     *
     * @return $this
     */
    public function setTypeResolver(TypeResolverInterface $typeResolver)
    {
        $this->typeResolver = $typeResolver;

        return $this;
    }


    /**
     * Get a collection (Strings) of currently defined permissions for the specified workflow instance.
     * @param integer $id id the workflow instance id.
     * @param TransientVarsInterface $inputs inputs The inputs to the workflow instance.
     *
     * @return array  A List of permissions specified currently (a permission is a string name).
     *
     */
    public function getSecurityPermissions($id, TransientVarsInterface $inputs = null)
    {
        try {
            $store = $this->getPersistence();
            $entry = $store->findEntry($id);
            $wf = $this->getConfiguration()->getWorkflow($entry->getWorkflowName());

            $ps = $store->getPropertySet($id);

            if (null === $inputs) {
                $inputs = $this->transientVarsFactory();
            }
            $transientVars = $inputs;

            $currentSteps = $store->findCurrentSteps($id);

            try {
                $this->populateTransientMap($entry, $transientVars, $wf->getRegisters(), null, $currentSteps, $ps);
            } catch (\Exception $e) {
                $errMsg = sprintf(
                    'Внутреннея ошибка: %s',
                    $e->getMessage()
                );
                throw new InternalWorkflowException($errMsg, $e->getCode(), $e);
            }


            $s = [];

            foreach ($currentSteps as $step) {
                $stepId = $step->getStepId();

                $xmlStep = $wf->getStep($stepId);

                $securities = $xmlStep->getPermissions();

                foreach ($securities as $security) {
                    if (!$security instanceof PermissionDescriptor) {
                        $errMsg = 'Invalid PermissionDescriptor';
                        throw new InternalWorkflowException($errMsg);
                    }
                    $conditionsDescriptor = $security->getRestriction()->getConditionsDescriptor();
                    if (null !== $security->getRestriction() && $this->passesConditionsByDescriptor($conditionsDescriptor, $transientVars, $ps, $xmlStep->getId())) {
                        $s[$security->getName()] = $security->getName();
                    }
                }
            }

            return $s;
        } catch (\Exception $e) {
            $errMsg = sprintf(
                'Ошибка при получение информации о правах доступа для экземпляра workflow c id# %s',
                $id
            );
            $this->getLog()->error($errMsg, [$e]);
        }

        return [];
    }


    /**
     * Get the name of the specified workflow instance.
     *
     * @param integer $id the workflow instance id.
     *
     * @return string
     *
     * @throws InternalWorkflowException
     */
    public function getWorkflowName($id)
    {
        try {
            $store = $this->getPersistence();
            $entry = $store->findEntry($id);

            if (null !== $entry) {
                return $entry->getWorkflowName();
            }
        } catch (FactoryException $e) {
            $errMsg = sprintf(
                'Ошибка при получение имен workflow для инстанса с id # %s',
                $id
            );
            $this->getLog()->error($errMsg, [$e]);
        }

        return null;
    }

    /**
     * Удаляет workflow
     *
     * @param string $workflowName
     *
     * @return bool
     *
     * @throws InternalWorkflowException
     */
    public function removeWorkflowDescriptor($workflowName)
    {
        return $this->getConfiguration()->removeWorkflow($workflowName);
    }

    /**
     * @param                    $workflowName
     * @param WorkflowDescriptor $descriptor
     * @param                    $replace
     *
     * @return bool
     *
     * @throws InternalWorkflowException
     */
    public function saveWorkflowDescriptor($workflowName, WorkflowDescriptor $descriptor, $replace)
    {
        $success = $this->getConfiguration()->saveWorkflow($workflowName, $descriptor, $replace);

        return $success;
    }


    /**
     * Query the workflow store for matching instances
     *
     * @param WorkflowExpressionQuery $query
     *
     * @return array
     *
     * @throws InternalWorkflowException
     */
    public function query(WorkflowExpressionQuery $query)
    {
        return $this->getPersistence()->query($query);
    }

    /**
     * @return string
     */
    public function getDefaultTypeResolverClass()
    {
        return $this->defaultTypeResolverClass;
    }

    /**
     * @param string $defaultTypeResolverClass
     *
     * @return $this
     */
    public function setDefaultTypeResolverClass($defaultTypeResolverClass)
    {
        $this->defaultTypeResolverClass = (string)$defaultTypeResolverClass;

        return $this;
    }


    /**
     * @param ConditionsDescriptor $descriptor
     * @param TransientVarsInterface $transientVars
     * @param PropertySetInterface $ps
     * @param                      $currentStepId
     *
     * @return bool
     *
     * @throws InternalWorkflowException
     * @throws WorkflowException
     */
    protected function passesConditionsByDescriptor(ConditionsDescriptor $descriptor = null, TransientVarsInterface $transientVars, PropertySetInterface $ps, $currentStepId)
    {
        if (null === $descriptor) {
            return true;
        }

        $type = $descriptor->getType();
        $conditions = $descriptor->getConditions();
        if (!$conditions instanceof SplObjectStorage) {
            $errMsg = 'Invalid conditions';
            throw new InternalWorkflowException($errMsg);
        }
        $passesConditions = $this->passesConditionsWithType($type, $conditions, $transientVars, $ps, $currentStepId);

        return $passesConditions;
    }

    /**
     * @param string $conditionType
     * @param SplObjectStorage $conditions
     * @param TransientVarsInterface $transientVars
     * @param PropertySetInterface $ps
     * @param integer $currentStepId
     *
     * @return bool
     *
     * @throws InternalWorkflowException
     * @throws InternalWorkflowException
     * @throws WorkflowException
     *
     */
    protected function passesConditionsWithType($conditionType, SplObjectStorage $conditions = null, TransientVarsInterface $transientVars, PropertySetInterface $ps, $currentStepId)
    {
        if (null === $conditions) {
            return true;
        }

        if (0 === $conditions->count()) {
            return true;
        }

        $and = strtoupper($conditionType) === 'AND';
        $or = !$and;

        foreach ($conditions as $descriptor) {
            if ($descriptor instanceof ConditionsDescriptor) {
                $descriptorConditions = $descriptor->getConditions();
                if (!$descriptorConditions instanceof SplObjectStorage) {
                    $errMsg = 'Invalid conditions container';
                    throw new InternalWorkflowException($errMsg);
                }

                $result = $this->passesConditionsWithType($descriptor->getType(), $descriptorConditions, $transientVars, $ps, $currentStepId);
            } elseif ($descriptor instanceof ConditionDescriptor) {
                $result = $this->passesCondition($descriptor, $transientVars, $ps, $currentStepId);
            } else {
                $errMsg = 'Invalid condition descriptor';
                throw new Exception\InternalWorkflowException($errMsg);
            }

            if ($and && !$result) {
                return false;
            } elseif ($or && $result) {
                return true;
            }
        }

        if ($and) {
            return true;
        }

        return false;
    }

    /**
     * @param ConditionDescriptor $conditionDesc
     * @param TransientVarsInterface $transientVars
     * @param PropertySetInterface $ps
     * @param integer $currentStepId
     *
     * @return boolean
     *
     * @throws WorkflowException
     * @throws InternalWorkflowException
     */
    protected function passesCondition(ConditionDescriptor $conditionDesc, TransientVarsInterface $transientVars, PropertySetInterface $ps, $currentStepId)
    {
        $type = $conditionDesc->getType();

        $argsOriginal = $conditionDesc->getArgs();


        $args = $this->prepareArgs($argsOriginal, $transientVars, $ps);

        if (-1 !== $currentStepId) {
            $stepId = array_key_exists('stepId', $args) ? (integer)$args['stepId'] : null;

            if (null !== $stepId && -1 === $stepId) {
                $args['stepId'] = $currentStepId;
            }
        }

        $condition = $this->getResolver()->getCondition($type, $args);

        if (null === $condition) {
            $this->context->setRollbackOnly();
            $errMsg = 'Огибка при загрузки условия';
            throw new WorkflowException($errMsg);
        }

        try {
            $passed = $condition->passesCondition($transientVars, $args, $ps);

            if ($conditionDesc->isNegate()) {
                $passed = !$passed;
            }
        } catch (\Exception $e) {
            $this->context->setRollbackOnly();

            $errMsg = sprintf(
                'Ошбика при выполнение условия %s',
                get_class($condition)
            );

            throw new WorkflowException($errMsg, $e->getCode(), $e);
        }

        return $passed;
    }

    /**
     * Подготавливает аргументы.
     *
     * @param array                  $argsOriginal
     *
     * @param TransientVarsInterface $transientVars
     * @param PropertySetInterface   $ps
     *
     * @return array
     *
     * @throws InternalWorkflowException
     */
    protected function prepareArgs(array $argsOriginal = [], TransientVarsInterface $transientVars, PropertySetInterface $ps)
    {
        $args = [];
        foreach ($argsOriginal as $key => $value) {
            $translateValue = $this->getConfiguration()->getVariableResolver()->translateVariables($value, $transientVars, $ps);
            $args[$key] = $translateValue;
        }

        return $args;
    }
}

old-town / old-town-workflow

GitHub Access Token became invalid
