HEX
Server: LiteSpeed
System: Linux s1049.use1.mysecurecloudhost.com 4.18.0-477.27.2.lve.el8.x86_64 #1 SMP Wed Oct 11 12:32:56 UTC 2023 x86_64
User: xedaptot (3356)
PHP: 8.3.31
Disabled: NONE
Upload Files
File: /home/xedaptot/be.naniguide.com/app/Library/Automation/Action.php
<?php

namespace Acelle\Library\Automation;

use Carbon\Carbon;
use Exception;
use Throwable;

abstract class Action
{
    protected $id;
    protected $title;
    protected $type; // ElementCondition (Evaluate), ElementTrigger (Trigger), ElementWait (Wait), ElementAction (Send)
    protected $child;
    protected $options;

    // Own attributes that should be kept
    protected $last_executed = null;
    protected $evaluationResult = null;

    // parent object
    protected $autoTrigger;
    protected $logger;

    public function __construct($params = [])
    {
        $this->id = $params['id'];
        $this->title = $params['title'];
        $this->type = $params['type'];
        $this->child = array_key_exists('child', $params) ? $params['child'] : null;
        $this->options = array_key_exists('options', $params) ? $params['options'] : [];

        $this->last_executed = array_key_exists('last_executed', $params) ? $params['last_executed'] : null;
        $this->evaluationResult = array_key_exists('evaluationResult', $params) ? $params['evaluationResult'] : null;
    }

    public function setAutoTrigger($autoTrigger)
    {
        $this->autoTrigger = $autoTrigger;
        $this->logger = $autoTrigger->logger();
    }

    public function toJson()
    {
        return [
            'id' => $this->getId(),
            'title' => $this->getTitle(),
            'type' => $this->type,
            'child' => $this->child,
            'options' => $this->getOptions(),
            'last_executed' => $this->getLastExecuted(),
            'evaluationResult' => $this->evaluationResult,
        ];
    }

    public function getId()
    {
        return $this->id;
    }

    public function getType()
    {
        return $this->type;
    }

    public function getTitle()
    {
        return $this->title;
    }

    public function getLastExecuted()
    {
        return $this->last_executed;
    }

    public function getLastExecutedCarbon()
    {
        return Carbon::createFromTimestamp($this->last_executed);
    }

    public function getOptions()
    {
        return $this->options;
    }

    public function getOption($key)
    {
        return $this->options[$key] ?? null;
    }

    public function setOption($name, $value)
    {
        $this->options[$name] = $value;
    }

    public function getNextActionId()
    {
        return $this->child;
    }

    public function getEvaluationResult()
    {
        return $this->evaluationResult;
    }

    public function recordLastExecutedTime()
    {
        // Correct: for storing a string as datetime
        $this->last_executed = Carbon::now()->timestamp;
    }

    public function hasChild($e)
    {
        if (is_null($this->child)) {
            return false;
        }

        return $e->getId() == $this->child;
    }

    // Only use it when an autotrigger is available
    public function getParent()
    {
        if (is_null($this->autoTrigger)) {
            throw new Exception('There is no AutoTrigger associated with this action');
        }

        $parent = null;
        $this->autoTrigger->getActions(function ($action) use (&$parent) {
            if ($action->hasChild($this)) {
                $parent = $action;
            }
        });

        return $parent;
    }

    public function isCondition()
    {
        return false;
    }

    public function getProgressDescription($timezone = null, $locale = null)
    {
        return null;
    }

    public function getLastExecutedHumanReadable()
    {
        if (is_null($this->getLastExecuted())) {
            return null;
        }

        return Carbon::createFromTimestamp($this->getLastExecuted())->diffForHumans();
    }

    // Template Pattern, execute will in turn call doExecute of inherited classes
    // Just to record the current action information in case of any error
    public function execute($manually = false)
    {
        // IMPORTANT: this should be placed outside of the try/catch
        // Otherwise, error again in catch block (no trigger information to log)
        if (is_null($this->autoTrigger)) {
            throw new Exception('There is no AutoTrigger associated with this action');
        }

        try {
            // Execute once only
            if (!is_null($this->getLastExecuted())) {
                throw new Exception("Action already executed");
            }

            // Actually execute, implemented by child classes
            $result = $this->doExecute($manually);

            if ($result) {
                // Only record last_executed and execute callback if success
                // IMPORTANT: callback is normally used for saving the current action status
                // IMPORTANT: if action is not saved at this point (with last_executed flag not null),
                //            it MIGHT execute again! sending duplicate emails for example.
                //            Or, in case of Evaluate: it keeps being executed over and over again
                //            and evaluation result may CHANGE over time (email gets clicked/opened)

                $this->recordLastExecutedTime();
                $this->save();
                $this->autoTrigger->recordToTimeline($this);
            } else {
                // it is up to the action to determine what to do in case of false
            }

            return $result;
        } catch (Throwable $t) {
            $msg = trans('messages.automation.trigger.error.action_failed', [
                'email' => $this->autoTrigger->getSubscriberCachedInfo('email', $fallback = true, $default = '[email]'),
                'id' => "Trigger {$this->autoTrigger->id}=>{$this->getId()}",
                'title' => $this->getTitle(),
                'err' => $t->getMessage(),
            ]);

            $this->logger->error($msg);

            throw new Exception($msg);
        }
    }

    public function isDelayAction()
    {
        // Whether or not this action type can delay the workflow
        // Only return true in case of CONDITION and WAIT and SEND and TRIGGER
        return false;
    }

    public function save()
    {
        $this->autoTrigger->updateAction($this);
    }

    public function retry()
    {
        throw new Exception("Action type {$this->getType()} does not support retry.");
    }

    public function setError($errorMsg)
    {
        $this->setOption('error', $errorMsg);
        $this->autoTrigger->setError(true, $save = false);
        $this->save();
    }

    public function update(array $json)
    {
        // Keep the following attributes, do not overwrite
        $keepMain = [ 'options', 'last_executed', 'evaluationResult' ];

        // Keep options
        $keep = [ 'queued_at', 'sent_at', 'delivery_job_id', 'delay_note', 'error'];

        foreach ($json as $key => $value) {
            if (!in_array($key, $keepMain)) {
                $this->{$key} = $value;
            }
        }

        foreach ($json['options'] as $key => $value) {
            if (!in_array($key, $keep)) {
                $this->setOption($key, $value);
            }
        }
    }
}