1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 

<?php

/**
 * Class for processing automation rules in inbound_automation_queue table
 * @package     Automation
 * @subpackage  Rules
*/


class Inbound_Automation_Processing {

    static $definitions;
    static $queue;
    static $job; /* placeholder for queued record being processed.   */
    static $job_id; /* placeholder for unique queue id of current job being processed  */
    static $job_rule_id; /* placeholder for rule id of current job being processed */
    static $job_tasks; /* placeholder for tasks dataset related to a running job */
    static $job_trigger_data; /* placeholder for tasks dataset related to a running job */
    static $job_run_date; /* placeholder for scheduling */

    /**
    *  Initializes class
    */
    public function __construct() {

        /* Load Hooks */
        self::load_hooks();

    }

    /**
    *  Loads hooks & filters
    */
    public static function load_hooks() {
        /* Load debug tools */
        add_action( 'admin_enqueue_scripts' , array( __CLASS__ , 'load_debug_tools' ) );

        /* Adds automation processing to Inbound heartbeat */
        add_action( 'inbound_automation_heartbeat' , array( __CLASS__ , 'process_rules' ) );

    }

    /**
    *  Loads debug tools
    */
    public static function load_debug_tools() {
        global $post;

        if ( !is_admin()) {
            return true;
        }

        if (isset($_GET['automation-view-rule-queue'])) {
            self::load_queue( false );
            echo '<pre>';
            print_r(self::$queue);
            echo '</pre>';exit;
        }

        if (isset($_GET['automation-run-rules'])) {
            self::process_rules();
            exit;
        }
    }

    /*
    * Load the Job Queue And Process All Scheduled Jobs
    */
    public static function process_rules() {

        self::load_queue();

        /* If queue empty quit automation processing */
        if ( !self::$queue || !is_array(self::$queue) ) {
            return;
        }

        /* Loop through queue and process job */
        foreach (self::$queue as $job_id => $job) {

            /* set static variables */
            self::$job = $job;
            self::$job_id = $job['id'];
            self::$job_rule_id = $job['rule_id'];
            self::$job_tasks = json_decode($job['tasks'],true);
            self::$job_trigger_data = json_decode($job['trigger_data'],true);

            /* discover datetime to run */
            $timezone_format = 'Y-m-d G:i:s T';
            $wordpress_date_time =  date_i18n($timezone_format);
            self::$job_run_date = $wordpress_date_time;

            /* run job */
            self::run_job();

            /* Update Rule After Completed Job */
            self::update_rule();

        }

    }

    /**
    *  Load rule queue
    */
    public static function load_queue( $hide_future_events = true) {
        global $wpdb;

        $table_name = $wpdb->prefix . "inbound_automation_queue";

        /* discover datetime to run */
        $timezone_format = 'Y-m-d G:i:s';
        $wordpress_date_time =  date_i18n($timezone_format);

        $query = 'SELECT * FROM '.$table_name . " WHERE status != 'complete' && status != 'running' && status != 'cancelled' && status != 'canceled' ";

        if (!$hide_future_events) {
            $query .= ' AND datetime <= "'.$wordpress_date_time.'" ';
        }

        self::$queue = $wpdb->get_results( $query , ARRAY_A );

        return self::$queue;
    }

    /**
    *  Update rule queue
    */
    public static function update_rule() {

        global $wpdb;

        $table_name = $wpdb->prefix . "inbound_automation_queue";

        /* Remove Job from Rule Queue if Empty */
        if (!isset(self::$job_tasks['action_blocks']) || !self::$job_tasks['action_blocks']) {

            $args = array(
                'id' => self::$job_id
            );

            $wpdb->update( $table_name , array('status'=>'complete') , $args );

            inbound_record_log(
                __( 'Job Completed' , 'inbound-pro' ) ,
                __('This job has successfully completed all it\'s tasks.' , 'inbound-pro' ),
                self::$job_rule_id ,
                self::$job_id ,
                'processing_event'
            );

        } else {
            self::mark_job_waiting();
        }

    }

    /**
     * Mark Job With Running Status
     */
    public static function mark_job_running() {

        global $wpdb;

        $table_name = $wpdb->prefix . "inbound_automation_queue";

        $update = array(
            'status' => 'running',
        );

        $where = array(
            'id' => self::$job_id,
        );

        $wpdb->update($table_name, $update , $where);
    }

    /**
     * Mark Job With Running Status
     */
    public static function mark_job_waiting() {

        global $wpdb;

        $table_name = $wpdb->prefix . "inbound_automation_queue";

        $update = array(
            'tasks' => json_encode(self::$job_tasks),
            'datetime' => self::$job_run_date,
            'status' => 'waiting',
        );
        $where = array(
            'id' => self::$job_id,
        );

        $wpdb->update($table_name, $update , $where);
    }

    /**
    * Run Scheduled Job
    * @returns ARRAY $job updated dataset
    */
    public static function run_job() {

        /* Tell Log We Are Running An Job */
        inbound_record_log(  'Starting Job' , '<pre>' . print_r( self::$job , true ) . '</pre>', self::$job_rule_id , self::$job_id , 'processing_event' );

        /* mark job running */
        self::mark_job_running();

        foreach ( self::$job_tasks['action_blocks'] as $block_id => $block ) {

            /* Filter Action Block */
            self::$job_tasks['action_blocks'][$block_id]['evaluated'] = self::evaluate_action_block( $block );

            /* If Evaluation Fails */
            if ( self::$job_tasks['action_blocks'][$block_id]['evaluated'] != 'true' ) {

                /* Run 'Else' Actions & Unset Action Block*/
                if ( isset( self::$job_tasks['action_blocks'][$block_id]['actions']['else']) ) {
                    self::$job_tasks['action_blocks'][ $block_id ] = self::run_actions( self::$job_tasks['action_blocks'][ $block_id ] , 'else' );
                }

                /* Continue to Next Action Block If Above Coditions are False & Unset Action Block */
                else {
                    unset( self::$job_tasks['action_blocks'][$block_id] );
                    continue;
                }
            }

            /* If Evaluates to True */
            else {
                /* Run 'Then' Actions */
                if ( isset($block['actions']['then']) ) {
                    self::$job_tasks['action_blocks'][ $block_id ] = self::run_actions( self::$job_tasks['action_blocks'][ $block_id ] , 'then' );
                }
            }
        }

        /* remove action blocks with completed actions */
        Inbound_Automation_Processing::unset_completed_actions( );
    }

    /**
    *   Run Action Block Actions
    */
    public static function run_actions( $block , $type ) {

        if ( !isset( $block['actions'][ $type ] ) ) {
            return;
        }

        foreach ($block['actions'][ $type ] as $action_id => $action) {

            /* pass on action 'pointer' or 'run_date' */
            if ( !is_int($action_id) ) {
                continue;
            }

            /* Check if Action Has Memory Set - Advance to Next Action if Necessary */
            if ( isset($block['actions'][ $type ]['pointer'])  && $block['actions'][ $type ]['pointer'] > $action_id ) {
                //continue;
            }

            /* Set Current Action Id Into Memory */
            $block['actions'][ $type ]['pointer'] = $action_id;

            /* Check if Current Actions Meta Has Schedule Set Abandon Actions if Time Condition Not Met */
            if ( isset($block['actions'][ $type ]['run_date']) && ( strtotime($block['actions'][ $type ]['run_date']) > strtotime( current_time('Y-m-d H:i:s') ) ) ) {
                inbound_record_log(
                    __( 'Action Delayed' , 'inbound-pro' ) ,
                    'Action Set to Be Performed on ' . $block['actions'][ $type ]['run_date'] . '<h2>Raw Action Block Data</h2><pre>' . print_r($block , true ) . '</pre>',
                    self::$job_rule_id ,
                    self::$job_id ,
                    'delay_event'
                );
                break;
            }

            /* Set Additional Data into Action Settings Array */
            $block['actions'][ $type ][ $action_id ]['rule_id'] = self::$job_rule_id;
            $block['actions'][ $type ][ $action_id ]['job_id'] = self::$job_id;

            /* Run Action */
            $block['actions'][ $type ][ $action_id ] = self::run_action( $block['actions'][ $type ][ $action_id ] );

            /* Check to see if Wait Command Was Returned For Next Action */
            if ( isset( $block['actions'][ $type ][ $action_id ]['run_date'] ) ) {

                /* Update Actions Meta With Schedule Date */
                $block['actions'][ $type ]['run_date'] = $block['actions'][ $type ][ $action_id ]['run_date'];
                self::$job_run_date = $block['actions'][ $type ]['run_date'];
            }

            /* Remove Action from Block */
            unset( $block['actions'][ $type ][ $action_id ] );

        }

        return $block;

    }


    /**
    * Run Action
    */
    public static function run_action( $action  ) {

        $class = new $action['action_class_name'];

        $action = $class->run_action( $action  , self::$job_trigger_data , self::$job_rule_id );

        return $action;
    }


    /**
    * Evaluate Action Block
    */
    public static function evaluate_action_block( $block ) {

        /* Check Action Filters */
        if ( isset( $block['filters'] )  && $block['filters'] && $filters = $block['filters'] ) {
            global $Inbound_Automation_Loader;

            /* load trigger db filters */
            self::$definitions = $Inbound_Automation_Loader;

            $evaluate = 'true';
            $evals = array();

            /* Check How Many Conditions as True */
            foreach( $block['filters'] as $filter) {

                $db_lookup_filter = self::$definitions->db_lookup_filters[ $filter['action_filter_id'] ];

                $evals[] = self::evaluate_filter( $db_lookup_filter , $filter );

            }


            /* Return Final Evaluation Decision Based On Eval Nature */
            $evaluate = self::evaluate_filters( $block['action_block_filters_evaluate'] , $evals );
            $evaluate = ($evaluate) ? $evaluate : 'false';

            /* Add Extra Data to $block for Log Event */
            $block['arguments'] = $filters;
            $block['evaluated'] = $evaluate;
            $block['evals'] = $evals;


            /* Log Evaluation Attempt */
            inbound_record_log(
                __( 'Evaluating' , 'inboun-pro' ) ,
                '<h2>'. __( 'Evaluated:' , 'inbound-pro' ) .'</h2><pre>'. $evaluate .'</pre>' .
                '<h2>'. __( 'Action Evaluation Nature:' , 'inbound-pro' ) .'</h2><pre>' . $block['action_block_filters_evaluate'] . '</pre>' .
                '<h2>' . __( 'Action Evaluation Debug Data:' , 'inbound-pro' ) .'</h2> <pre>' . print_r( $evals , true )  . '</pre>' .
                '<h2>'. __('Action Block' , 'inbound-pro' ) .'</h2><pre>'.print_r( $block , true ).'</pre>'
                , self::$job_rule_id
                , self::$job_id
                ,'evaluation_event'
            );

            return $evaluate;

        } else {
            /* No Filters Detected */
            return true;
        }

    }


    /*
    * Evaluate Filter By Comparing Filter with Corresponding Incoming Data
    * @param db_lookup_filter ARRAY contains db lookup data related to action filter being evaluated
    * @param filter ARRAY contains data related to filter being evaluated
    *
    * @returns ARRAY of evaluation result data
    */
    public static function evaluate_filter( $db_lookup_filter , $filter ) {

        $eval = false;
        $class_name = $db_lookup_filter['class_name'];
        $function_name = 'query_' . $filter['action_filter_key'] ;

        $db_lookup = $class_name::$function_name(  $filter , self::$job_trigger_data );

        if ( $db_lookup===null ) {

            return array(
                'filter_key' => $filter['action_filter_key'] ,
                'filter_compare' => $filter['action_filter_compare'],
                'filter_value' => $filter['action_filter_value'],
                'db_lookup_value' => 'EMPTY',
                'eval' => false
            );

        }

        switch ($filter['action_filter_compare']) {

            case 'greater-than' :

                if ( $filter['action_filter_value'] < $db_lookup ) {
                    $eval = true;
                }

                BREAK;

            case 'greater-than-equal-to' :

                if ( $filter['action_filter_value'] <= $db_lookup ) {
                    $eval = true;
                }

                BREAK;

            case 'less-than' :

                if ( $db_lookup < $filter['action_filter_value'] ) {
                    $eval = true;
                }

                BREAK;


            case 'less-than-equal-to' :

                if ( $filter['action_filter_value'] >= $db_lookup ) {
                    $eval = true;
                }

                BREAK;

            case 'contains' :

                if ( stristr( $db_lookup , $filter['action_filter_value'] ) ) {
                    $eval = true;
                }

                BREAK;

            case 'equals' :

                if (  $filter['action_filter_value'] == $db_lookup ) {
                    $eval = true;
                }

                BREAK;

        }

        return array(
            'filter_key' => $filter['action_filter_key'] ,
            'filter_compare' => $filter['action_filter_compare'],
            'filter_value' => $filter['action_filter_value'],
            'db_lookup_value' => $db_lookup,
            'eval' => $eval
        );

    }

    /*
    * Evaluate All Filters Based on Evaluation Condition
    * @param eval_nature STRING contains instructions on how to process filters
    * @param evals ARRAY of indivual filter evaluation results
    *
    * @returns BOOL for overall evaluation result
    */
    public static function evaluate_filters( $eval_nature , $evals ) {

        switch ($eval_nature) {
            case 'match-any' :
                foreach ( $evals as $eval ) {
                    if ($eval['eval']) {
                        $evaluate = 'true';
                        break;
                    } else {
                        $evaluate = 'false';
                    }
                }

                BREAK;

            case 'match-all' :
                $i_evals = count($evals);
                $e = 0;
                $evaluate = false;

                foreach ( $evals as $eval ) {
                    if ($eval['eval']) {
                        $e++;
                    }
                }

                if ($e == $i_evals) {
                    $evaluate = true;
                }
                BREAK;

            case 'match-none' :
                foreach ( $evals as $eval ) {
                    if ($eval['eval']) {
                        $evaluate = 'false';
                        break;
                    } else {
                        $evaluate = 'true';

                    }
                }

                BREAK;
        }

        return $evaluate;
    }



    /**
    *  Unsets action blocks where all actions have completed
    *  @return ARRAY $action_blocks
    */
    public static function unset_completed_actions() {


        /* loop through action blocks and remove blocks with no more queued actions */
        foreach ( self::$job_tasks['action_blocks'] as $i => $block ) {

            unset($block['actions']['then']['pointer']);
            unset($block['actions']['then']['run_date']);

            if (self::$job_tasks['action_blocks'][$i]['evaluated']) {
                unset(self::$job_tasks['action_blocks'][$i]['actions']['else']);
            }

            if (count($block['actions']['then']) < 1) {
                unset(self::$job_tasks['action_blocks'][$i]['actions']['then']);
            }

            if (
                count($block['actions']['then']) < 1
                &&
                ( !isset($block['actions']['else']) || count($block['actions']['else']) < 1 )
            ) {
                unset(self::$job_tasks['action_blocks']);
            }

        }
    }


    /**
    * Adds Job to Processing Queue
    */
    public static function add_job_to_queue( $rule , $arguments ) {

        global $wpdb;
        $table_name = $wpdb->prefix . "inbound_automation_queue";

        /* discover datetime to run - first entry is always "now" */
        $timezone_format = 'Y-m-d G:i:s T';
        $wordpress_date_time =  date_i18n($timezone_format);

        /* setup rule arguments */
        $rule_args = array(
            'rule_id' => $rule['ID'],
            'tasks' => json_encode($rule),
            'trigger_data' => json_encode($arguments),
            'status' => 'pending',
            'datetime' => $wordpress_date_time
        );

        /* add job to automation queue */
        $wpdb->insert(
            $table_name,
            $rule_args
        );

        return '-';
    }

}


/**
 * Loads Inbound_Automation_Processing class in `init` hook
 * @package Automation
 */
function inbound_automation_processing() {
    new Inbound_Automation_Processing();
}
add_action( 'init' , 'inbound_automation_processing' , 2 );