557 lines
14 KiB
PHP
557 lines
14 KiB
PHP
<?php
|
|
|
|
namespace AutomateWoo;
|
|
|
|
use AutomateWoo\Actions\PreviewableInterface;
|
|
use AutomateWoo\Triggers\ManualInterface;
|
|
use AutomateWoo\Workflows\Factory;
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* @class Admin_Workflow_Edit
|
|
* @since 2.6.1
|
|
*/
|
|
class Admin_Workflow_Edit {
|
|
/** @var Workflow */
|
|
public $workflow;
|
|
|
|
/** @var string The screen ID */
|
|
public static $screen = 'aw_workflow';
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
public function __construct() {
|
|
add_action( 'admin_head', [ $this, 'setup_workflow' ] );
|
|
add_action( 'admin_head', [ $this, 'register_meta_boxes' ] );
|
|
add_action( 'admin_head', [ $this, 'enqueue_scripts' ], 15 );
|
|
add_action( 'admin_footer', [ $this, 'workflow_js_templates' ], 15 );
|
|
add_action( 'save_post', [ $this, 'save' ] );
|
|
add_action( 'save_post', [ $this, 'maybe_redirect_to_manual_runner' ], 1000 );
|
|
|
|
add_filter( 'wp_insert_post_data', [ $this, 'insert_post_data' ] );
|
|
add_filter( 'wp_untrash_post_status', [ $this, 'set_restored_workflow_status' ], 10, 2 );
|
|
}
|
|
|
|
/**
|
|
* Setup workflow object
|
|
*/
|
|
public function setup_workflow() {
|
|
global $post;
|
|
|
|
if ( $post && $post->post_status !== 'auto-draft' ) {
|
|
$this->workflow = Factory::get( $post->ID );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enqueue scripts
|
|
* Do this on the admin_head action so we have access to the post object
|
|
*/
|
|
public function enqueue_scripts() {
|
|
wp_dequeue_script( 'autosave' );
|
|
|
|
wp_localize_script( 'automatewoo-workflows', 'automatewooWorkflowLocalizeScript', $this->get_js_data() );
|
|
|
|
wp_enqueue_script( 'automatewoo-workflows' );
|
|
wp_enqueue_script( 'automatewoo-variables' );
|
|
wp_enqueue_script( 'automatewoo-rules' );
|
|
|
|
wp_enqueue_media();
|
|
|
|
// dummy editor for ajax cloning
|
|
?><div style="display: none"><?php wp_editor( '', 'automatewoo_editor' ); ?></div>
|
|
<?php
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public function get_js_data() {
|
|
global $post;
|
|
|
|
Rules::get_all(); // load all the rules into memory so the order is preserved
|
|
|
|
// get rule options
|
|
if ( $this->workflow ) {
|
|
|
|
$rule_options = $this->workflow->get_rule_data();
|
|
|
|
foreach ( $rule_options as &$rule_group ) {
|
|
foreach ( $rule_group as &$rule ) {
|
|
|
|
if ( ! isset( $rule['name'] ) ) {
|
|
continue;
|
|
}
|
|
|
|
$rule_object = Rules::get( $rule['name'] );
|
|
|
|
if ( ! $rule_object ) {
|
|
continue;
|
|
}
|
|
|
|
if ( $rule_object->type === 'object' ) {
|
|
/** @var Rules\Abstract_Object|Rules\Searchable_Select_Rule_Abstract $rule_object */
|
|
|
|
// If rule has multiple values get the display value for all keys
|
|
if ( $rule_object->is_multi ) {
|
|
foreach ( (array) $rule['value'] as $item ) {
|
|
$rule['selected'][] = $rule_object->get_object_display_value( $item );
|
|
}
|
|
} else {
|
|
$rule['selected'] = $rule_object->get_object_display_value( $rule['value'] );
|
|
}
|
|
} else {
|
|
// Format the rule value
|
|
$rule['value'] = $rule_object->format_value( $rule['value'] );
|
|
}
|
|
|
|
if ( $rule_object->type === 'select' ) {
|
|
/** @var Rules\Abstract_Select $rule_object */
|
|
// Preload select choices for any rules in use on the workflow
|
|
$rule_object->get_select_choices();
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
$rule_options = [];
|
|
}
|
|
|
|
// Pass action data map
|
|
$actions_data = [];
|
|
|
|
foreach ( Actions::get_all() as $action ) {
|
|
$actions_data[ $action->get_name() ] = [
|
|
'can_be_previewed' => $action instanceof PreviewableInterface,
|
|
'required_data_items' => $action->required_data_items,
|
|
'group' => sanitize_key( $action->get_group() ),
|
|
];
|
|
}
|
|
|
|
// variables data
|
|
$variables_data = [];
|
|
|
|
foreach ( Variables::get_list() as $data_type => $data_variables ) {
|
|
$variables_data[ $data_type ] = array_keys( $data_variables );
|
|
}
|
|
|
|
// convert user variables to customer
|
|
if ( isset( $variables_data['user'] ) ) {
|
|
foreach ( $variables_data['user'] as $variable ) {
|
|
$variables_data['customer'][] = $variable;
|
|
}
|
|
}
|
|
|
|
$utm_source = 'workflow-edit';
|
|
|
|
$meta_box_help_tips = [
|
|
'rules_box' => Admin::help_link( Admin::get_docs_link( 'rules', $utm_source ) ),
|
|
'trigger_box' => Admin::help_link( Admin::get_docs_link( 'triggers', $utm_source ) ),
|
|
'actions_box' => Admin::help_link( Admin::get_docs_link( 'actions', $utm_source ) ),
|
|
];
|
|
|
|
return [
|
|
'id' => $post->ID,
|
|
'isNew' => 'auto-draft' === $post->post_status,
|
|
'trigger' => $this->workflow ? self::get_trigger_data( $this->workflow->get_trigger() ) : false,
|
|
'ruleOptions' => $rule_options,
|
|
'allRules' => self::get_rules_data(),
|
|
'actions' => $actions_data,
|
|
'variables' => $variables_data,
|
|
'metaBoxHelpTips' => $meta_box_help_tips,
|
|
'nonces' => [
|
|
'aw_fill_trigger_fields' => wp_create_nonce( 'aw_fill_trigger_fields' ),
|
|
'aw_fill_action_fields' => wp_create_nonce( 'aw_fill_action_fields' ),
|
|
'aw_save_preview_data' => wp_create_nonce( 'aw_save_preview_data' ),
|
|
'aw_update_dynamic_action_select' => wp_create_nonce( 'aw_update_dynamic_action_select' ),
|
|
'aw_update_dynamic_trigger_options_select' => wp_create_nonce( 'aw_update_dynamic_trigger_options_select' ),
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @param Trigger $trigger
|
|
* @return array|false
|
|
*/
|
|
public static function get_trigger_data( $trigger ) {
|
|
$data = [];
|
|
|
|
if ( ! $trigger ) {
|
|
return false;
|
|
}
|
|
|
|
$data['title'] = $trigger->get_title();
|
|
$data['name'] = $trigger->get_name();
|
|
$data['description'] = $trigger->get_description();
|
|
$data['supplied_data_items'] = array_values( $trigger->get_supplied_data_items() );
|
|
$data['allow_queueing'] = $trigger::SUPPORTS_QUEUING;
|
|
$data['is_manual'] = $trigger instanceof ManualInterface;
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public static function get_rules_data() {
|
|
$data = [];
|
|
|
|
foreach ( Rules::get_all() as $rule ) {
|
|
$rule_data = (array) $rule;
|
|
|
|
if ( is_callable( [ $rule, 'get_search_ajax_action' ] ) ) {
|
|
$rule_data['ajax_action'] = $rule->get_search_ajax_action();
|
|
}
|
|
|
|
$data[ $rule->name ] = $rule_data;
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Workflow meta boxes
|
|
*/
|
|
public function register_meta_boxes() {
|
|
remove_meta_box( 'submitdiv', self::$screen, 'side' );
|
|
|
|
Admin::add_meta_box(
|
|
'save_box',
|
|
__( 'Save', 'automatewoo' ),
|
|
[ $this, 'meta_box_save' ],
|
|
self::$screen,
|
|
'side'
|
|
);
|
|
|
|
Admin::add_meta_box(
|
|
'trigger_box',
|
|
__( 'Trigger', 'automatewoo' ),
|
|
[ $this, 'meta_box_triggers' ],
|
|
self::$screen,
|
|
'normal',
|
|
'high'
|
|
);
|
|
|
|
Admin::add_meta_box(
|
|
'manual_workflow_box',
|
|
__( 'Manual workflow options', 'automatewoo' ),
|
|
function () {
|
|
Admin::get_view(
|
|
'meta-box-manual-workflow',
|
|
[
|
|
'workflow' => $this->workflow,
|
|
'current_trigger' => $this->workflow
|
|
? $this->workflow->get_trigger() : false,
|
|
]
|
|
);
|
|
},
|
|
self::$screen,
|
|
'normal',
|
|
'high'
|
|
);
|
|
|
|
Admin::add_meta_box(
|
|
'rules_box',
|
|
__( 'Rules <small>(optional)</small>', 'automatewoo' ),
|
|
[ $this, 'meta_box_rules' ],
|
|
self::$screen,
|
|
'normal',
|
|
'high'
|
|
);
|
|
|
|
Admin::add_meta_box(
|
|
'actions_box',
|
|
__( 'Actions', 'automatewoo' ),
|
|
[ $this, 'meta_box_actions' ],
|
|
self::$screen,
|
|
'normal',
|
|
'high'
|
|
);
|
|
|
|
Admin::add_meta_box(
|
|
'timing_box',
|
|
__( 'Timing', 'automatewoo' ),
|
|
[ $this, 'meta_box_timing' ],
|
|
self::$screen,
|
|
'side'
|
|
);
|
|
|
|
Admin::add_meta_box(
|
|
'options_box',
|
|
__( 'Options', 'automatewoo' ),
|
|
[ $this, 'meta_box_options' ],
|
|
self::$screen,
|
|
'side'
|
|
);
|
|
|
|
Admin::add_meta_box(
|
|
'variables_box',
|
|
__( 'Variables', 'automatewoo' ),
|
|
[ $this, 'meta_box_variables' ],
|
|
self::$screen,
|
|
'side'
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Triggers meta box
|
|
*/
|
|
public function meta_box_triggers() {
|
|
Admin::get_view(
|
|
'meta-box-trigger',
|
|
[
|
|
'workflow' => $this->workflow,
|
|
'current_trigger' => $this->workflow ? $this->workflow->get_trigger() : false,
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Rules meta box
|
|
*/
|
|
public function meta_box_rules() {
|
|
Admin::get_view(
|
|
'meta-box-rules',
|
|
[
|
|
'workflow' => $this->workflow,
|
|
'selected_trigger' => $this->workflow ? $this->workflow->get_trigger() : false,
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Actions meta box
|
|
*/
|
|
public function meta_box_actions() {
|
|
$action_select_box_values = [];
|
|
|
|
foreach ( Actions::get_all() as $action ) {
|
|
$action_select_box_values[ $action->get_group() ][ $action->get_name() ] = $action->get_title();
|
|
}
|
|
|
|
Admin::get_view(
|
|
'meta-box-actions',
|
|
[
|
|
'workflow' => $this->workflow,
|
|
'actions' => $this->workflow ? $this->workflow->get_actions() : [],
|
|
'action_select_box_values' => $action_select_box_values,
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Variables meta box
|
|
*/
|
|
public function meta_box_variables() {
|
|
Admin::get_view( 'meta-box-variables' );
|
|
}
|
|
|
|
/**
|
|
* Timing meta box
|
|
*/
|
|
public function meta_box_timing() {
|
|
Admin::get_view(
|
|
'meta-box-timing',
|
|
[
|
|
'workflow' => $this->workflow,
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Options meta box
|
|
*/
|
|
public function meta_box_options() {
|
|
Admin::get_view(
|
|
'meta-box-options',
|
|
[
|
|
'workflow' => $this->workflow,
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Replace standard post submit box
|
|
*/
|
|
public function meta_box_save() {
|
|
Admin::get_view(
|
|
'meta-box-save',
|
|
[
|
|
'workflow' => $this->workflow,
|
|
]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Load JS modal and alert templates
|
|
*
|
|
* @return void
|
|
*/
|
|
public function workflow_js_templates() {
|
|
Admin::get_view( 'js-workflow-templates' );
|
|
if ( 'preset' === aw_get_url_var( 'workflow-origin' ) ) {
|
|
Admin::get_view( 'js-workflow-preset-alert' );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Save custom post data for workflow
|
|
*
|
|
* @param int $post_id The ID of the post currently being saved
|
|
*
|
|
* @return void
|
|
*/
|
|
public function save( $post_id ) {
|
|
$posted = aw_get_post_var( 'aw_workflow_data' );
|
|
|
|
if ( ! is_array( $posted ) ) {
|
|
return;
|
|
}
|
|
|
|
$workflow = Factory::get( $post_id );
|
|
|
|
$workflow->set_type( isset( $posted['type'] ) ? $posted['type'] : 'automatic' );
|
|
|
|
$raw_rule_options = isset( $posted['rule_options'] ) ? $posted['rule_options'] : [];
|
|
$workflow->set_rule_data( $raw_rule_options );
|
|
|
|
switch ( $workflow->get_type() ) {
|
|
case 'automatic':
|
|
$workflow->set_trigger_data(
|
|
isset( $posted['trigger_name'] ) ? $posted['trigger_name'] : '',
|
|
isset( $posted['trigger_options'] ) ? $posted['trigger_options'] : []
|
|
);
|
|
break;
|
|
case 'manual':
|
|
$workflow->set_trigger_data(
|
|
isset( $posted['manual_trigger_name'] ) ? $posted['manual_trigger_name'] : '',
|
|
[]
|
|
);
|
|
break;
|
|
}
|
|
|
|
$trigger_name = $workflow->get_trigger_name();
|
|
|
|
$raw_actions_data = isset( $posted['actions'] ) ? $posted['actions'] : [];
|
|
$workflow->set_actions_data( $raw_actions_data );
|
|
|
|
$options = [];
|
|
$options['when_to_run'] = $this->extract_string_option_value( 'when_to_run', $posted, 'immediately' );
|
|
$options['click_tracking'] = $this->extract_string_option_value( 'click_tracking', $posted );
|
|
|
|
if ( $options['click_tracking'] ) {
|
|
$options['conversion_tracking'] = $this->extract_string_option_value( 'conversion_tracking', $posted );
|
|
$options['ga_link_tracking'] = $this->extract_string_option_value( 'ga_link_tracking', $posted );
|
|
}
|
|
|
|
if ( $trigger_name ) {
|
|
$trigger = Triggers::get( $trigger_name );
|
|
// If queueing is disabled for the trigger force when to run option
|
|
if ( $trigger && ! $trigger::SUPPORTS_QUEUING ) {
|
|
$options['when_to_run'] = 'immediately';
|
|
}
|
|
}
|
|
|
|
switch ( $options['when_to_run'] ) {
|
|
|
|
case 'delayed':
|
|
$options['run_delay_value'] = $this->extract_string_option_value( 'run_delay_value', $posted );
|
|
$options['run_delay_unit'] = $this->extract_string_option_value( 'run_delay_unit', $posted );
|
|
break;
|
|
|
|
case 'scheduled':
|
|
$options['run_delay_value'] = $this->extract_string_option_value( 'run_delay_value', $posted );
|
|
$options['run_delay_unit'] = $this->extract_string_option_value( 'run_delay_unit', $posted );
|
|
$options['scheduled_time'] = $this->extract_string_option_value( 'scheduled_time', $posted );
|
|
$options['scheduled_day'] = $this->extract_array_option_value( 'scheduled_day', $posted );
|
|
break;
|
|
|
|
case 'fixed':
|
|
$options['fixed_date'] = $this->extract_string_option_value( 'fixed_date', $posted );
|
|
$options['fixed_time'] = $this->extract_array_option_value( 'fixed_time', $posted );
|
|
break;
|
|
|
|
case 'datetime':
|
|
$options['queue_datetime'] = $this->extract_string_option_value( 'queue_datetime', $posted );
|
|
break;
|
|
}
|
|
|
|
$workflow->update_meta( 'workflow_options', $options );
|
|
$workflow->update_meta( 'is_transactional', ! empty( $posted['is_transactional'] ) );
|
|
|
|
// Clear cached workflow data.
|
|
Cache::flush_group( 'workflows' );
|
|
}
|
|
|
|
/**
|
|
* Redirect to manual runner if relevant button was clicked.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param int $post_id The post ID
|
|
*/
|
|
public function maybe_redirect_to_manual_runner( $post_id ) {
|
|
if ( aw_get_post_var( 'automatewoo_redirect_to_runner' ) ) {
|
|
wp_safe_redirect( Admin::page_url( 'manual-workflow-runner', $post_id ) );
|
|
exit;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $option
|
|
* @param array $posted
|
|
* @param string $default
|
|
*
|
|
* @return string
|
|
*/
|
|
public function extract_string_option_value( $option, $posted, $default = '' ) {
|
|
return isset( $posted['workflow_options'][ $option ] ) ? Clean::string( $posted['workflow_options'][ $option ] ) : $default;
|
|
}
|
|
|
|
/**
|
|
* @param string $option
|
|
* @param array $posted
|
|
* @param array $default
|
|
*
|
|
* @return array
|
|
*/
|
|
public function extract_array_option_value( $option, $posted, $default = [] ) {
|
|
return isset( $posted['workflow_options'][ $option ] ) ? Clean::recursive( $posted['workflow_options'][ $option ] ) : $default;
|
|
}
|
|
|
|
/**
|
|
* Set post status before post is saved.
|
|
*
|
|
* @param array $data
|
|
* @return array
|
|
*/
|
|
public function insert_post_data( $data ) {
|
|
$status = Clean::string( aw_request( 'workflow_status' ) );
|
|
|
|
if ( $status ) {
|
|
$data['post_status'] = $status === 'active' ? 'publish' : 'aw-disabled';
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Set the post status to "aw-disabled" when a workflow is restored
|
|
* from trash to avoid it being set as "draft".
|
|
*
|
|
* @param string $new_status The new status of the post being restored.
|
|
* @param int $post_id The ID of the post being restored.
|
|
*
|
|
* @return string
|
|
*/
|
|
public function set_restored_workflow_status( $new_status, $post_id ): string {
|
|
if ( 'aw_workflow' === get_post_type( $post_id ) ) {
|
|
return 'aw-disabled';
|
|
}
|
|
|
|
return $new_status;
|
|
}
|
|
}
|
