/modules/bizproc/lib/controller/script.php

<?php

namespace Bitrix\Bizproc\Controller;

use Bitrix\Bizproc\FieldType;
use Bitrix\Bizproc\Script\Entity\ScriptTable;
use Bitrix\Bizproc\Script\Entity\ScriptQueueDocumentTable;
use Bitrix\Bizproc\Script\Entity\ScriptQueueTable;
use Bitrix\Bizproc\Script\Queue;
use Bitrix\Main;
use Bitrix\Main\Localization\Loc;
use Bitrix\Bizproc\Script\Manager;

class Script extends Base
{
	public const START_STATUS_NOT_PERMITTED = 'NOT_PERMITTED';
	public const START_STATUS_NOT_EXISTS = 'NOT_EXISTS';
	public const START_STATUS_NO_DOCUMENTS = 'NO_DOCUMENTS';
	public const START_STATUS_FILL_PARAMETERS = 'FILL_PARAMETERS';
	public const START_STATUS_INVALID_PARAMETERS = 'INVALID_PARAMETERS';
	public const START_STATUS_QUEUED = 'QUEUED';

	//TODO: use dynamic rules such as b24 limitation api
	private const LIMIT_DOCUMENT_ID = 1000;
	private const LIMIT_QUEUES = 1;

	public function startAction($scriptId, array $documentIds, array $parameters = [])
	{
		$userId = $this->getCurrentUser()->getId();

		if (!Manager::canUserStartScript($scriptId, $userId))
		{
			return [
				'status' => static::START_STATUS_NOT_PERMITTED,
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_START')
			];
		}

		$documentIds = array_unique($documentIds);

		if (count($documentIds) > $this->getDocumentIdLimit())
		{
			return [
				'status' => static::START_STATUS_NOT_PERMITTED,
				'error' => Loc::getMessage(
					'BIZPROC_CONTROLLER_SCRIPT_ERROR_DOCUMENT_ID_LIMIT',
					[
						'#LIMIT#' => $this->getDocumentIdLimit(),
						'#SELECTED#' => count($documentIds),
					]
				)
			];
		}

		$script = Manager::getById($scriptId);

		if (!$script)
		{
			return [
				'status' => static::START_STATUS_NOT_EXISTS,
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_NOT_EXISTS')
			];
		}

		if (!$script->getActive())
		{
			return [
				'status' => static::START_STATUS_NOT_PERMITTED,
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_START_INACTIVE')
			];
		}

		$queuesCnt = ScriptTable::getActiveQueueCount($scriptId);

		if ($queuesCnt >= $this->getQueuesLimit())
		{
			return [
				'status' => static::START_STATUS_NOT_PERMITTED,
				'error' => Loc::getMessage(
					'BIZPROC_CONTROLLER_SCRIPT_ERROR_QUEUES_LIMIT',
					[
						'#LIMIT#' => $this->getQueuesLimit(),
						'#CNT#' => $queuesCnt,
					]
				)
			];
		}

		$script->fill('WORKFLOW_TEMPLATE');
		/** @var \Bitrix\Bizproc\Workflow\Template\Tpl $tpl */
		$tpl = $script->getWorkflowTemplate();

		$templateParameters = $tpl->getParameters();

		if ($templateParameters)
		{
			if (empty($parameters))
			{
				return [
					'status' => static::START_STATUS_FILL_PARAMETERS,
					'parameters' => self::convertTemplateParameters($templateParameters, $tpl->getDocumentComplexType()),
					'documentType' => $tpl->getDocumentComplexType(),
					'scriptName' => $script->getName(),
				];
			}

			$parameters = \CBPWorkflowTemplateLoader::CheckWorkflowParameters(
				$templateParameters,
				$parameters,
				$tpl->getDocumentComplexType(),
				$errors
			);

			if (!empty($errors))
			{
				return [
					'status' => static::START_STATUS_INVALID_PARAMETERS,
					'error' => reset($errors)['message']
				];
			}
		}

		//TODO: move logic to Manager
		$addResult = ScriptQueueTable::add([
			'SCRIPT_ID' => $scriptId,
			'STARTED_DATE' => new Main\Type\DateTime(),
			'STARTED_BY' => $userId,
			'STATUS' => Queue\Status::QUEUED,
			'MODIFIED_DATE' => new Main\Type\DateTime(),
			'WORKFLOW_PARAMETERS' => $parameters,
		]);

		$queueId = null;
		if ($addResult->isSuccess())
		{
			$queueId = $addResult->getId();
			$documentRows = array_map(
				function ($id) use ($queueId)
				{
					return [
						'QUEUE_ID' => $queueId,
						'DOCUMENT_ID' => $id,
						'STATUS' => Queue\Status::QUEUED,
					];
				},
				$documentIds
			);
			ScriptQueueDocumentTable::addMulti($documentRows, true);
		}

		Queue\Stepper::bind(1, [$queueId, $scriptId]);

		return [
			'status' => static::START_STATUS_QUEUED,
			'queueId' => $queueId,
		];
	}

	public function deleteAction($scriptId)
	{
		$userId = $this->getCurrentUser()->getId();
		$script = Manager::getById($scriptId);

		if (!$script)
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_NOT_EXISTS')
			];
		}

		if (!Manager::canUserEditScript($script->getId(), $userId))
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_DELETE_SCRIPT')
			];
		}

		$result = Manager::deleteScript($scriptId);

		if (!$result->isSuccess())
		{
			return ['error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_DELETE_RUNNING_SCRIPT')];
		}

		return ['status' => 'success'];
	}

	public function activateAction(int $scriptId)
	{
		$script = Manager::getById($scriptId);

		if (!$script)
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_NOT_EXISTS')
			];
		}

		$userId = $this->getCurrentUser()->getId();
		if (!Manager::canUserEditScript($script->getId(), $userId))
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_UPDATE_SCRIPT')
			];
		}

		Manager::activateScript($scriptId);

		return ['status' => 'success'];
	}

	public function deactivateAction(int $scriptId)
	{
		$script = Manager::getById($scriptId);

		if (!$script)
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_NOT_EXISTS')
			];
		}

		$userId = $this->getCurrentUser()->getId();
		if (!Manager::canUserEditScript($script->getId(), $userId))
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_UPDATE_SCRIPT')
			];
		}

		Manager::deactivateScript($scriptId);

		return ['status' => 'success'];
	}

	public function terminateQueueAction(int $queueId)
	{
		$userId = $this->getCurrentUser()->getId();
		$queue = Manager::getQueueById($queueId);

		if (!$queue)
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_NOT_EXISTS')
			];
		}

		if (!Manager::canUserStartScript($queue->getScriptId(), $userId))
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_TERMINATE')
			];
		}

		if ($queue->getStatus() > Queue\Status::EXECUTING)
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_TERMINATE_FINISHED')
			];
		}

		Manager::terminateQueue($queueId, $userId);
		return ['status' => 'success'];
	}

	public function execQueueAction(int $queueId)
	{
		$queue = Manager::getQueueById($queueId);

		if (!$queue)
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_NOT_EXISTS')
			];
		}

		//emulate Stepper step
		$stepper = Queue\Stepper::createInstance();
		$option = [];
		$stepper->setOuterParams([$queueId, $queue->getScriptId()]);
		$result = $stepper->execute($option);

		return ['status' => 'success', 'finished' => ($result === $stepper::FINISH_EXECUTION)];
	}

	public function deleteQueueAction(int $queueId)
	{
		$userId = $this->getCurrentUser()->getId();
		$queue = Manager::getQueueById($queueId);

		if (!$queue)
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_NOT_EXISTS')
			];
		}

		if (!Manager::canUserStartScript($queue->getScriptId(), $userId))
		{
			return [
				'error' => Loc::getMessage('BIZPROC_CONTROLLER_SCRIPT_CANT_DELETE_QUEUE')
			];
		}

		Manager::deleteQueue($queueId, $userId);
		return ['status' => 'success'];
	}

	private function getDocumentIdLimit(): int
	{
		return self::LIMIT_DOCUMENT_ID;
	}

	private function getQueuesLimit(): int
	{
		return self::LIMIT_QUEUES;
	}

	private static function convertTemplateParameters(array $parameters, array $documentType): array
	{
		$result = [];
		foreach ($parameters as $id => $parameter)
		{
			$parameter = FieldType::normalizeProperty($parameter);
			$parameter['Id'] = $id;

			if ($parameter['Type'] === 'user')
			{
				$parameter['Default'] = \CBPHelper::UsersArrayToString(
					$parameter['Default'], [], $documentType
				);
			}

			$result[] = $parameter;
		}
		return $result;
	}
}