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/Model/AutoTrigger.php
<?php

/**
 * Automation Event Trigger class.
 *
 * Model class for logging triggered events
 *
 * LICENSE: This product includes software developed at
 * the Acelle Co., Ltd. (http://acellemail.com/).
 *
 * @category   MVC Model
 *
 * @author     N. Pham <[email protected]>
 * @author     L. Pham <[email protected]>
 * @copyright  Acelle Co., Ltd
 * @license    Acelle Co., Ltd
 *
 * @version    1.0
 *
 * @link       http://acellemail.com
 */

namespace Acelle\Model;

use Illuminate\Database\Eloquent\Model;
use Acelle\Library\Automation\Action;
use Acelle\Library\Automation\Trigger;
use Acelle\Library\Automation\Send;
use Acelle\Library\Automation\Wait;
use Exception;
use Acelle\Library\Traits\HasUid;
use Closure;
use Acelle\Model\Subscriber;

class AutoTrigger extends Model
{
    use HasUid;

    protected $fillable = [
        //
    ];

    protected $casts = [
        'created_at' => 'datetime',
        'updated_at' => 'datetime',
    ];

    public static function boot()
    {
        parent::boot();

        self::saving(function ($model) {
            $model->updateExecutedIndex();
        });

        self::retrieved(function ($model) {
            // IMPORTANT: in case of any change made to the parent automation2
            if (!is_null($model->id)) {
                $model->updateWorkflow();
            }
        });

        // Why ::creating is required here although it was already in HasUid!!!!!!!!
        static::creating(function ($item) {
            if (is_null($item->uid)) {
                $item->generateUid();
            }
        });
    }

    /**
     * Associations.
     *
     * @return the associated subscriber
     */
    public function subscriber()
    {
        return $this->belongsTo('Acelle\Model\Subscriber');
    }

    /**
     * Associations.
     *
     * @return the associated automation2
     */
    public function automation2()
    {
        return $this->belongsTo('Acelle\Model\Automation2');
    }

    /**
     * Associations.
     *
     * @return the associated timelines
     */
    public function timelines()
    {
        return $this->hasMany('Acelle\Model\Timeline')->orderBy('created_at', 'DESC');
    }

    public function scopeError($query)
    {
        $query->where('is_error', true);

        return $query;
    }

    // Mark the next action as "latest" and return it
    public function getNextAction($action)
    {
        $nextId = $action->getNextActionId();
        return $this->getActionById($nextId);
    }

    public function recordToTimeline($action)
    {
        $connection = $this->automation2->customer->getDbConnection();
        if (is_null(Subscriber::on($connection)->find($this->subscriber_id))) {
            // In case of DELETE/MOVE contact operation, no timeline needed
            return;
        }

        $this->timelines()->create([
            'automation2_id' => $this->automation2_id,
            'subscriber_id' => $this->subscriber_id,
            'activity' => $action->getActionDescription(),
            'activity_type' => $action->getType(),
        ]);
    }

    // Notice that this method my be called from an automation or individually
    // As a result, try catch is needed
    public function check($manually = false)
    {
        // If subscriber was previouusly deleted or moved
        if (is_null($this->subscriber)) {
            $this->logger()->info("Subscriber is null, possibly MOVED or DELETED");
            return;
        }

        $this->withUpdateLock(function () use ($manually) {
            $this->logger()->info(sprintf('Trigger #%s (%s) of automation [%s] starts checking', $this->id, $this->subscriber->email, $this->automation2->name));

            // IMPORTANT: make sure the trigger data is up-to-date before taking any actions (send emails for example)
            $this->refresh();

            // STEP #1: Get latest action
            $latest = $this->findLastActionToExecute();

            if ($latest == null) {
                $this->logger()->info(sprintf('Trigger #%s (%s) already reached last asction', $this->id, $this->subscriber->email, $this->automation2->name));
                return;
            }

            $this->logger()->info(sprintf('Trigger #%s (%s) start from lastest action [%s]', $this->id, $this->subscriber->email, $latest->getTitle()));

            // Save to DB and Record to timeline every time we pass an action
            // IMPORTANT: if action is not saved (with last_executed flag not null), it MIGHT execute again! sending duplicate emails for example

            // * Trigger => always true
            // * Send => false (dispatched a job, waiting for result) or true (job done and writes success status)
            // * Operation => always true
            // * Evaluation => always true
            // * Wait => true or false

            // true means: done with this step, should proceed next while false means stop, wait for next check
            while ($latest->execute($manually) == 'true') {
                $latest = $this->getNextAction($latest);
                if ($latest == null) {
                    $this->logger()->info(sprintf('Trigger [#%s - %s]: Reach last action, END!', $this->id, $this->subscriber->email));
                    break;
                }

                $this->logger()->info(sprintf('Trigger [#%s - %s]: continue with action [%s]', $this->id, $this->subscriber->email, $latest->getTitle()));
            }

            if (!is_null($latest)) {
                $this->logger()->info(sprintf('Trigger [#%s - %s]: is currently PENDING at [%s]', $this->id, $this->subscriber->email, $latest->getTitle()));
            }
        });
    }

    public function withUpdateLock(Closure $task)
    {
        $key = 'auto_trigger_lock_'.$this->uid;
        with_cache_lock($key, function () use ($task) {
            $task($this);
        }, $getLockTimeout = 1, $keepLockFor = 60, function () {
            $this->logger()->info(sprintf('Trigger [#%s - %s]: is currently handled by another process, silently QUIT', $this->id, $this->subscriber->email));

            applog('trigger-conflict')->info(sprintf('Trigger [#%s - %s]: is currently handled by another process, silently QUIT', $this->id, $this->subscriber->email));
        });
    }

    public function updateAction($action)
    {
        $json = $this->getJson();

        if (array_key_exists($action->getId(), $json)) {
            $current = $json[$action->getId()];
            $updated = array_merge($current, $action->toJson());
            $json[$action->getId()] = $updated;
        } else {
            $json[$action->getId()] = $action->toJson();
        }

        $this->data = json_encode($json);
        $this->save();
    }

    private function updateExecutedIndex()
    {
        $executed = [];
        $this->getActions(function ($action) use (&$executed) {
            if (!is_null($action->getLastExecuted())) {
                $executed[] = $action->getId();
            }
        });

        $this->executed_index = implode(',', $executed);
    }

    // Get actions in the RIGHT order and with the right branch
    // Use this method instead of #getActions which is for loading the first Trigger only
    public function traverseExecutedPathWithLastPendingAction($callback)
    {
        $lastActionToExecute = $this->findLastActionToExecute();


        // Starting point
        $action = $this->getTrigger();

        if (is_null($action)) {
            return;
        }

        do {
            /* DEPRECATED: the following check is deprecated: do not BREAK
             *             as there might be NEW ACTIONS inserted to automations (they do not have last_executed value)
             *
             */
            // if (is_null($action->getLastExecuted()) && !$action->isDelayAction()) {
            //     break;
            // }

            if (($lastActionToExecute && $action->getId() == $lastActionToExecute->getId()) || !is_null($action->getLastExecuted())) {
                $callback($action);
            }

            $action = $this->getNextAction($action);
        } while (!is_null($action));
    }

    public function getExecutedActions()
    {
        $list = [];
        $this->traverseExecutedPathWithLastPendingAction(function ($action) use (&$list) {
            $list[] = $action;
        });

        return $list;
    }

    public function getActions($callback)
    {
        $json = $this->getJson();
        foreach ($json as $key => $attributes) {
            $attributes['id'] = $key;
            $instance = $this->getAction($attributes);
            $instance->setAutoTrigger($this);
            $callback($instance);
        }
    }

    public function getAction($attributes)
    {
        return $this->automation2->getAction($attributes);
    }

    public function updateWorkflow()
    {
        $origins = json_decode($this->automation2->data, true);
        $newJson = [];

        foreach ($origins as $r) {
            $tmp = $this->getAction($r);
            $newAttrs = $tmp->toJson();
            $currentAction = $this->getActionById($tmp->getId());

            if (is_null($currentAction)) {
                $newJson[$tmp->getId()] = $newAttrs;
            } else {

                // Update main attributes, except for 'options' and some other
                $currentAction->update($newAttrs);
                $newJson[$currentAction->getId()] = $currentAction->toJson();
            }
        }

        $this->data = json_encode($newJson);
        $this->save();

        return $this;
    }

    public function getJson()
    {
        return is_null($this->data) ? [] : json_decode($this->data, true);
    }

    // for debugging only
    public function getTrigger()
    {
        $trigger = null;
        $this->getActions(function ($e) use (&$trigger) {
            if ($e->getType() == 'ElementTrigger') {
                $trigger = $e;
            }
        });

        if ($trigger == null) {
            throw new Exception("Automation does not have a trigger!!!!");
        }

        return  $trigger;
    }

    public function logger()
    {
        return $this->automation2->logger();
    }

    public function getActionById($id)
    {
        $selected = null;
        $this->getActions(function ($action) use ($id, &$selected) {
            if ($action->getId() == $id) {
                $selected = $action;
            }
        });

        return $selected;
    }

    public function isActionExecuted($id)
    {
        return !is_null($this->getActionById($id)->getLastExecuted());
    }

    public function isComplete()
    {
        $last = $this->findLastActionToExecute();
        return is_null($last);
    }

    public function findLastActionToExecute()
    {
        // IMPORTANT: there might be new Element added to the flow by Automation with last_executed = null, skip them all
        // Just come to the end and get the last element with last_executed=null
        $lastExecutedAction = null;
        $this->getActions(function ($action) use (&$lastExecutedAction) {
            if (!is_null($action->getLastExecuted())) {
                $lastExecutedAction = $action;
            }
        });

        if (is_null($lastExecutedAction)) {
            return $this->getTrigger();
        } else {
            $nextId = $lastExecutedAction->getNextActionId();

            if (is_null($nextId)) {
                return null;
            } else {
                return $this->getActionById($nextId);
            }
        }
    }

    public function getLatestAction()
    {
        $action = $this->getTrigger();

        if (is_null($action->getLastExecuted())) {
            return null;
        }

        while (!is_null($action->getLastExecuted())) {
            $nextId = $action->getNextActionId();

            if (is_null($nextId)) {
                return $action;
            }

            $action = $this->getActionById($nextId);
        }

        return $action->getParent();
    }

    public function setError(bool $isError, $save = true)
    {
        $this->is_error = $isError;

        if ($save) {
            $this->save();
        }

        return $this;
    }

    public function cacheSubscriberInfo()
    {
        if (is_null($this->subscriber)) {
            throw new Exception("Subscriber information not available");
        }

        $this->cached_subscriber = json_encode($this->subscriber->getAttributes());
        return $this->save();
    }

    public function getSubscriberCachedInfo($key, $fallbackToRealSubscriber = true, $default = null)
    {
        if (is_null($this->cached_subscriber)) {
            // throw new Exception("No cached information");

            if ($fallbackToRealSubscriber && $this->subscriber) {
                return $this->subscriber[$key];
            } else {
                return $default;
            }
        }

        $info = json_decode($this->cached_subscriber, true);

        if (!array_key_exists($key, $info)) {
            throw new Exception("Attribute {$key} not found in cached info: ".$this->cached_subscriber);
        }

        return $info[$key];
    }
}