CreateAutomationFromTemplateController.php
2 months ago
DeleteAutomationController.php
2 months ago
DuplicateAutomationController.php
2 months ago
UpdateAutomationController.php
2 months ago
UpdateStepsController.php
11 months ago
index.php
3 years ago
UpdateAutomationController.php
193 lines
| 1 | <?php declare(strict_types = 1); |
| 2 | |
| 3 | namespace MailPoet\Automation\Engine\Builder; |
| 4 | |
| 5 | if (!defined('ABSPATH')) exit; |
| 6 | |
| 7 | |
| 8 | use ActionScheduler_Store; |
| 9 | use MailPoet\Automation\Engine\Control\ActionScheduler; |
| 10 | use MailPoet\Automation\Engine\Data\Automation; |
| 11 | use MailPoet\Automation\Engine\Data\AutomationRun; |
| 12 | use MailPoet\Automation\Engine\Data\Step; |
| 13 | use MailPoet\Automation\Engine\Exceptions; |
| 14 | use MailPoet\Automation\Engine\Exceptions\UnexpectedValueException; |
| 15 | use MailPoet\Automation\Engine\Hooks; |
| 16 | use MailPoet\Automation\Engine\Storage\AutomationRunStorage; |
| 17 | use MailPoet\Automation\Engine\Storage\AutomationStorage; |
| 18 | use MailPoet\Automation\Engine\Validation\AutomationValidator; |
| 19 | |
| 20 | class UpdateAutomationController { |
| 21 | /** @var Hooks */ |
| 22 | private $hooks; |
| 23 | |
| 24 | /** @var AutomationStorage */ |
| 25 | private $storage; |
| 26 | |
| 27 | /** @var AutomationValidator */ |
| 28 | private $automationValidator; |
| 29 | |
| 30 | /** @var UpdateStepsController */ |
| 31 | private $updateStepsController; |
| 32 | |
| 33 | private AutomationRunStorage $automationRunStorage; |
| 34 | |
| 35 | private ActionScheduler $actionScheduler; |
| 36 | |
| 37 | public function __construct( |
| 38 | Hooks $hooks, |
| 39 | AutomationStorage $storage, |
| 40 | AutomationValidator $automationValidator, |
| 41 | AutomationRunStorage $automationRunStorage, |
| 42 | ActionScheduler $actionScheduler, |
| 43 | UpdateStepsController $updateStepsController |
| 44 | ) { |
| 45 | $this->hooks = $hooks; |
| 46 | $this->storage = $storage; |
| 47 | $this->automationValidator = $automationValidator; |
| 48 | $this->updateStepsController = $updateStepsController; |
| 49 | $this->automationRunStorage = $automationRunStorage; |
| 50 | $this->actionScheduler = $actionScheduler; |
| 51 | } |
| 52 | |
| 53 | public function updateAutomation(int $id, array $data): Automation { |
| 54 | $automation = $this->storage->getAutomation($id); |
| 55 | if (!$automation) { |
| 56 | throw Exceptions::automationNotFound($id); |
| 57 | } |
| 58 | $previousAutomation = clone $automation; |
| 59 | |
| 60 | if (array_key_exists('name', $data)) { |
| 61 | $automation->setName($data['name']); |
| 62 | } |
| 63 | $originalStatus = $automation->getStatus(); |
| 64 | |
| 65 | if (array_key_exists('status', $data)) { |
| 66 | $this->checkAutomationStatus($data['status']); |
| 67 | $automation->setStatus($data['status']); |
| 68 | } |
| 69 | |
| 70 | if (array_key_exists('steps', $data)) { |
| 71 | $this->validateTriggerInvariants($automation, $data['steps']); |
| 72 | $this->validateAutomationSteps($automation, $data['steps']); |
| 73 | $this->updateStepsController->updateSteps($automation, $data['steps']); |
| 74 | foreach ($automation->getSteps() as $step) { |
| 75 | $this->hooks->doAutomationStepBeforeSave($step, $automation); |
| 76 | $this->hooks->doAutomationStepByKeyBeforeSave($step, $automation); |
| 77 | } |
| 78 | } |
| 79 | |
| 80 | $shouldUnscheduleAutomationRuns = ( |
| 81 | ($automation->getStatus() === Automation::STATUS_DRAFT) |
| 82 | && ($originalStatus === Automation::STATUS_ACTIVE) |
| 83 | ) || !empty($data['cancel_running_runs']); |
| 84 | |
| 85 | if (array_key_exists('meta', $data)) { |
| 86 | $automation->deleteAllMetas(); |
| 87 | foreach ($data['meta'] as $key => $value) { |
| 88 | $automation->setMeta($key, $value); |
| 89 | } |
| 90 | } |
| 91 | |
| 92 | $this->hooks->doAutomationBeforeSave($automation); |
| 93 | |
| 94 | $this->automationValidator->validate($automation); |
| 95 | $this->storage->updateAutomation($automation); |
| 96 | |
| 97 | if ($shouldUnscheduleAutomationRuns) { |
| 98 | $this->unscheduleAutomationRuns($automation); |
| 99 | } |
| 100 | |
| 101 | $automation = $this->storage->getAutomation($id); |
| 102 | if (!$automation) { |
| 103 | throw Exceptions::automationNotFound($id); |
| 104 | } |
| 105 | $this->hooks->doAutomationAfterUpdate($automation, $previousAutomation); |
| 106 | return $automation; |
| 107 | } |
| 108 | |
| 109 | private function checkAutomationStatus(string $status): void { |
| 110 | if (!in_array($status, Automation::STATUS_ALL, true)) { |
| 111 | // translators: %s is the status. |
| 112 | throw UnexpectedValueException::create()->withMessage(sprintf(__('Invalid status: %s', 'mailpoet'), $status)); |
| 113 | } |
| 114 | } |
| 115 | |
| 116 | private function validateTriggerInvariants(Automation $automation, array $steps): void { |
| 117 | $existingTriggers = []; |
| 118 | foreach ($automation->getSteps() as $step) { |
| 119 | if ($step->getType() === Step::TYPE_TRIGGER) { |
| 120 | $existingTriggers[$step->getId()] = $step; |
| 121 | } |
| 122 | } |
| 123 | |
| 124 | $newTriggers = []; |
| 125 | foreach ($steps as $id => $data) { |
| 126 | if (($data['type'] ?? null) === Step::TYPE_TRIGGER) { |
| 127 | $newTriggers[$id] = $data; |
| 128 | } |
| 129 | } |
| 130 | |
| 131 | $triggersChanged = false; |
| 132 | if (count($newTriggers) !== count($existingTriggers)) { |
| 133 | $triggersChanged = true; |
| 134 | } |
| 135 | |
| 136 | if (!$triggersChanged) { |
| 137 | foreach ($existingTriggers as $id => $existingTrigger) { |
| 138 | $newTrigger = $newTriggers[$id] ?? null; |
| 139 | if (!$newTrigger || ($newTrigger['key'] ?? '') !== $existingTrigger->getKey()) { |
| 140 | $triggersChanged = true; |
| 141 | break; |
| 142 | } |
| 143 | } |
| 144 | } |
| 145 | |
| 146 | if ($triggersChanged && $this->automationRunStorage->getCountForAutomation($automation) > 0) { |
| 147 | throw Exceptions::automationTriggerModificationNotSupported(); |
| 148 | } |
| 149 | } |
| 150 | |
| 151 | protected function validateAutomationSteps(Automation $automation, array $steps): void { |
| 152 | $existingSteps = $automation->getSteps(); |
| 153 | if (count($steps) !== count($existingSteps)) { |
| 154 | throw Exceptions::automationStructureModificationNotSupported(); |
| 155 | } |
| 156 | |
| 157 | foreach ($steps as $id => $data) { |
| 158 | $existingStep = $existingSteps[$id] ?? null; |
| 159 | if (!$existingStep || !$this->stepChanged(Step::fromArray($data), $existingStep)) { |
| 160 | throw Exceptions::automationStructureModificationNotSupported(); |
| 161 | } |
| 162 | } |
| 163 | } |
| 164 | |
| 165 | private function stepChanged(Step $a, Step $b): bool { |
| 166 | $aData = $a->toArray(); |
| 167 | $bData = $b->toArray(); |
| 168 | unset($aData['args'], $aData['filters']); |
| 169 | unset($bData['args'], $bData['filters']); |
| 170 | return $aData === $bData; |
| 171 | } |
| 172 | |
| 173 | private function unscheduleAutomationRuns(Automation $automation): void { |
| 174 | $runIds = []; |
| 175 | $runs = $this->automationRunStorage->getAutomationRunsForAutomation($automation); |
| 176 | foreach ($runs as $run) { |
| 177 | if ($run->getStatus() === AutomationRun::STATUS_RUNNING) { |
| 178 | $this->automationRunStorage->updateStatus($run->getId(), AutomationRun::STATUS_CANCELLED); |
| 179 | } |
| 180 | $runIds[$run->getId()] = $run; |
| 181 | } |
| 182 | |
| 183 | $actions = $this->actionScheduler->getScheduledActions(['hook' => Hooks::AUTOMATION_STEP, 'status' => ActionScheduler_Store::STATUS_PENDING]); |
| 184 | foreach ($actions as $action) { |
| 185 | $args = $action->get_args(); |
| 186 | $automationArgs = reset($args); |
| 187 | if (isset($automationArgs['automation_run_id']) && isset($runIds[$automationArgs['automation_run_id']])) { |
| 188 | $this->actionScheduler->unscheduleAction(Hooks::AUTOMATION_STEP, $args); |
| 189 | } |
| 190 | } |
| 191 | } |
| 192 | } |
| 193 |