initial commit
This commit is contained in:
405
includes/libraries/class-wc-eval-math.php
Normal file
405
includes/libraries/class-wc-eval-math.php
Normal file
@ -0,0 +1,405 @@
|
||||
<?php
|
||||
|
||||
use Automattic\Jetpack\Constants;
|
||||
|
||||
if ( ! defined( 'ABSPATH' ) ) {
|
||||
exit;
|
||||
}
|
||||
|
||||
if ( ! class_exists( 'WC_Eval_Math', false ) ) {
|
||||
/**
|
||||
* Class WC_Eval_Math. Supports basic math only (removed eval function).
|
||||
*
|
||||
* Based on EvalMath by Miles Kaufman Copyright (C) 2005 Miles Kaufmann http://www.twmagic.com/.
|
||||
*/
|
||||
class WC_Eval_Math {
|
||||
|
||||
/**
|
||||
* Last error.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
public static $last_error = null;
|
||||
|
||||
/**
|
||||
* Variables (and constants).
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $v = array( 'e' => 2.71, 'pi' => 3.14 );
|
||||
|
||||
/**
|
||||
* User-defined functions.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $f = array();
|
||||
|
||||
/**
|
||||
* Constants.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $vb = array( 'e', 'pi' );
|
||||
|
||||
/**
|
||||
* Built-in functions.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public static $fb = array();
|
||||
|
||||
/**
|
||||
* Evaluate maths string.
|
||||
*
|
||||
* @param string $expr
|
||||
* @return mixed
|
||||
*/
|
||||
public static function evaluate( $expr ) {
|
||||
self::$last_error = null;
|
||||
$expr = trim( $expr );
|
||||
if ( substr( $expr, -1, 1 ) == ';' ) {
|
||||
$expr = substr( $expr, 0, strlen( $expr ) -1 ); // strip semicolons at the end
|
||||
}
|
||||
// ===============
|
||||
// is it a variable assignment?
|
||||
if ( preg_match( '/^\s*([a-z]\w*)\s*=\s*(.+)$/', $expr, $matches ) ) {
|
||||
if ( in_array( $matches[1], self::$vb ) ) { // make sure we're not assigning to a constant
|
||||
return self::trigger( "cannot assign to constant '$matches[1]'" );
|
||||
}
|
||||
if ( ( $tmp = self::pfx( self::nfx( $matches[2] ) ) ) === false ) {
|
||||
return false; // get the result and make sure it's good
|
||||
}
|
||||
self::$v[ $matches[1] ] = $tmp; // if so, stick it in the variable array
|
||||
return self::$v[ $matches[1] ]; // and return the resulting value
|
||||
// ===============
|
||||
// is it a function assignment?
|
||||
} elseif ( preg_match( '/^\s*([a-z]\w*)\s*\(\s*([a-z]\w*(?:\s*,\s*[a-z]\w*)*)\s*\)\s*=\s*(.+)$/', $expr, $matches ) ) {
|
||||
$fnn = $matches[1]; // get the function name
|
||||
if ( in_array( $matches[1], self::$fb ) ) { // make sure it isn't built in
|
||||
return self::trigger( "cannot redefine built-in function '$matches[1]()'" );
|
||||
}
|
||||
$args = explode( ",", preg_replace( "/\s+/", "", $matches[2] ) ); // get the arguments
|
||||
if ( ( $stack = self::nfx( $matches[3] ) ) === false ) {
|
||||
return false; // see if it can be converted to postfix
|
||||
}
|
||||
$stack_size = count( $stack );
|
||||
for ( $i = 0; $i < $stack_size; $i++ ) { // freeze the state of the non-argument variables
|
||||
$token = $stack[ $i ];
|
||||
if ( preg_match( '/^[a-z]\w*$/', $token ) and ! in_array( $token, $args ) ) {
|
||||
if ( array_key_exists( $token, self::$v ) ) {
|
||||
$stack[ $i ] = self::$v[ $token ];
|
||||
} else {
|
||||
return self::trigger( "undefined variable '$token' in function definition" );
|
||||
}
|
||||
}
|
||||
}
|
||||
self::$f[ $fnn ] = array( 'args' => $args, 'func' => $stack );
|
||||
return true;
|
||||
// ===============
|
||||
} else {
|
||||
return self::pfx( self::nfx( $expr ) ); // straight up evaluation, woo
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Convert infix to postfix notation.
|
||||
*
|
||||
* @param string $expr
|
||||
*
|
||||
* @return array|string
|
||||
*/
|
||||
private static function nfx( $expr ) {
|
||||
|
||||
$index = 0;
|
||||
$stack = new WC_Eval_Math_Stack;
|
||||
$output = array(); // postfix form of expression, to be passed to pfx()
|
||||
$expr = trim( $expr );
|
||||
|
||||
$ops = array( '+', '-', '*', '/', '^', '_' );
|
||||
$ops_r = array( '+' => 0, '-' => 0, '*' => 0, '/' => 0, '^' => 1 ); // right-associative operator?
|
||||
$ops_p = array( '+' => 0, '-' => 0, '*' => 1, '/' => 1, '_' => 1, '^' => 2 ); // operator precedence
|
||||
|
||||
$expecting_op = false; // we use this in syntax-checking the expression
|
||||
// and determining when a - is a negation
|
||||
if ( preg_match( "/[^\w\s+*^\/()\.,-]/", $expr, $matches ) ) { // make sure the characters are all good
|
||||
return self::trigger( "illegal character '{$matches[0]}'" );
|
||||
}
|
||||
|
||||
while ( 1 ) { // 1 Infinite Loop ;)
|
||||
$op = substr( $expr, $index, 1 ); // get the first character at the current index
|
||||
// find out if we're currently at the beginning of a number/variable/function/parenthesis/operand
|
||||
$ex = preg_match( '/^([A-Za-z]\w*\(?|\d+(?:\.\d*)?|\.\d+|\()/', substr( $expr, $index ), $match );
|
||||
// ===============
|
||||
if ( '-' === $op and ! $expecting_op ) { // is it a negation instead of a minus?
|
||||
$stack->push( '_' ); // put a negation on the stack
|
||||
$index++;
|
||||
} elseif ( '_' === $op ) { // we have to explicitly deny this, because it's legal on the stack
|
||||
return self::trigger( "illegal character '_'" ); // but not in the input expression
|
||||
// ===============
|
||||
} elseif ( ( in_array( $op, $ops ) or $ex ) and $expecting_op ) { // are we putting an operator on the stack?
|
||||
if ( $ex ) { // are we expecting an operator but have a number/variable/function/opening parenthesis?
|
||||
$op = '*';
|
||||
$index--; // it's an implicit multiplication
|
||||
}
|
||||
// heart of the algorithm:
|
||||
while ( $stack->count > 0 and ( $o2 = $stack->last() ) and in_array( $o2, $ops ) and ( $ops_r[ $op ] ? $ops_p[ $op ] < $ops_p[ $o2 ] : $ops_p[ $op ] <= $ops_p[ $o2 ] ) ) {
|
||||
$output[] = $stack->pop(); // pop stuff off the stack into the output
|
||||
}
|
||||
// many thanks: https://en.wikipedia.org/wiki/Reverse_Polish_notation#The_algorithm_in_detail
|
||||
$stack->push( $op ); // finally put OUR operator onto the stack
|
||||
$index++;
|
||||
$expecting_op = false;
|
||||
// ===============
|
||||
} elseif ( ')' === $op && $expecting_op ) { // ready to close a parenthesis?
|
||||
while ( ( $o2 = $stack->pop() ) != '(' ) { // pop off the stack back to the last (
|
||||
if ( is_null( $o2 ) ) {
|
||||
return self::trigger( "unexpected ')'" );
|
||||
} else {
|
||||
$output[] = $o2;
|
||||
}
|
||||
}
|
||||
if ( preg_match( "/^([A-Za-z]\w*)\($/", $stack->last( 2 ), $matches ) ) { // did we just close a function?
|
||||
$fnn = $matches[1]; // get the function name
|
||||
$arg_count = $stack->pop(); // see how many arguments there were (cleverly stored on the stack, thank you)
|
||||
$output[] = $stack->pop(); // pop the function and push onto the output
|
||||
if ( in_array( $fnn, self::$fb ) ) { // check the argument count
|
||||
if ( $arg_count > 1 ) {
|
||||
return self::trigger( "too many arguments ($arg_count given, 1 expected)" );
|
||||
}
|
||||
} elseif ( array_key_exists( $fnn, self::$f ) ) {
|
||||
if ( count( self::$f[ $fnn ]['args'] ) != $arg_count ) {
|
||||
return self::trigger( "wrong number of arguments ($arg_count given, " . count( self::$f[ $fnn ]['args'] ) . " expected)" );
|
||||
}
|
||||
} else { // did we somehow push a non-function on the stack? this should never happen
|
||||
return self::trigger( "internal error" );
|
||||
}
|
||||
}
|
||||
$index++;
|
||||
// ===============
|
||||
} elseif ( ',' === $op and $expecting_op ) { // did we just finish a function argument?
|
||||
while ( ( $o2 = $stack->pop() ) != '(' ) {
|
||||
if ( is_null( $o2 ) ) {
|
||||
return self::trigger( "unexpected ','" ); // oops, never had a (
|
||||
} else {
|
||||
$output[] = $o2; // pop the argument expression stuff and push onto the output
|
||||
}
|
||||
}
|
||||
// make sure there was a function
|
||||
if ( ! preg_match( "/^([A-Za-z]\w*)\($/", $stack->last( 2 ), $matches ) ) {
|
||||
return self::trigger( "unexpected ','" );
|
||||
}
|
||||
$stack->push( $stack->pop() + 1 ); // increment the argument count
|
||||
$stack->push( '(' ); // put the ( back on, we'll need to pop back to it again
|
||||
$index++;
|
||||
$expecting_op = false;
|
||||
// ===============
|
||||
} elseif ( '(' === $op and ! $expecting_op ) {
|
||||
$stack->push( '(' ); // that was easy
|
||||
$index++;
|
||||
// ===============
|
||||
} elseif ( $ex and ! $expecting_op ) { // do we now have a function/variable/number?
|
||||
$expecting_op = true;
|
||||
$val = $match[1];
|
||||
if ( preg_match( "/^([A-Za-z]\w*)\($/", $val, $matches ) ) { // may be func, or variable w/ implicit multiplication against parentheses...
|
||||
if ( in_array( $matches[1], self::$fb ) or array_key_exists( $matches[1], self::$f ) ) { // it's a func
|
||||
$stack->push( $val );
|
||||
$stack->push( 1 );
|
||||
$stack->push( '(' );
|
||||
$expecting_op = false;
|
||||
} else { // it's a var w/ implicit multiplication
|
||||
$val = $matches[1];
|
||||
$output[] = $val;
|
||||
}
|
||||
} else { // it's a plain old var or num
|
||||
$output[] = $val;
|
||||
}
|
||||
$index += strlen( $val );
|
||||
// ===============
|
||||
} elseif ( ')' === $op ) { // miscellaneous error checking
|
||||
return self::trigger( "unexpected ')'" );
|
||||
} elseif ( in_array( $op, $ops ) and ! $expecting_op ) {
|
||||
return self::trigger( "unexpected operator '$op'" );
|
||||
} else { // I don't even want to know what you did to get here
|
||||
return self::trigger( "an unexpected error occurred" );
|
||||
}
|
||||
if ( strlen( $expr ) == $index ) {
|
||||
if ( in_array( $op, $ops ) ) { // did we end with an operator? bad.
|
||||
return self::trigger( "operator '$op' lacks operand" );
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
while ( substr( $expr, $index, 1 ) == ' ' ) { // step the index past whitespace (pretty much turns whitespace
|
||||
$index++; // into implicit multiplication if no operator is there)
|
||||
}
|
||||
}
|
||||
while ( ! is_null( $op = $stack->pop() ) ) { // pop everything off the stack and push onto output
|
||||
if ( '(' === $op ) {
|
||||
return self::trigger( "expecting ')'" ); // if there are (s on the stack, ()s were unbalanced
|
||||
}
|
||||
$output[] = $op;
|
||||
}
|
||||
return $output;
|
||||
}
|
||||
|
||||
/**
|
||||
* Evaluate postfix notation.
|
||||
*
|
||||
* @param mixed $tokens
|
||||
* @param array $vars
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
private static function pfx( $tokens, $vars = array() ) {
|
||||
if ( false == $tokens ) {
|
||||
return false;
|
||||
}
|
||||
$stack = new WC_Eval_Math_Stack;
|
||||
|
||||
foreach ( $tokens as $token ) { // nice and easy
|
||||
// if the token is a binary operator, pop two values off the stack, do the operation, and push the result back on
|
||||
if ( in_array( $token, array( '+', '-', '*', '/', '^' ) ) ) {
|
||||
if ( is_null( $op2 = $stack->pop() ) ) {
|
||||
return self::trigger( "internal error" );
|
||||
}
|
||||
if ( is_null( $op1 = $stack->pop() ) ) {
|
||||
return self::trigger( "internal error" );
|
||||
}
|
||||
switch ( $token ) {
|
||||
case '+':
|
||||
$stack->push( $op1 + $op2 );
|
||||
break;
|
||||
case '-':
|
||||
$stack->push( $op1 - $op2 );
|
||||
break;
|
||||
case '*':
|
||||
$stack->push( $op1 * $op2 );
|
||||
break;
|
||||
case '/':
|
||||
if ( 0 == $op2 ) {
|
||||
return self::trigger( 'division by zero' );
|
||||
}
|
||||
$stack->push( $op1 / $op2 );
|
||||
break;
|
||||
case '^':
|
||||
$stack->push( pow( $op1, $op2 ) );
|
||||
break;
|
||||
}
|
||||
// if the token is a unary operator, pop one value off the stack, do the operation, and push it back on
|
||||
} elseif ( '_' === $token ) {
|
||||
$stack->push( -1 * $stack->pop() );
|
||||
// if the token is a function, pop arguments off the stack, hand them to the function, and push the result back on
|
||||
} elseif ( ! preg_match( "/^([a-z]\w*)\($/", $token, $matches ) ) {
|
||||
if ( is_numeric( $token ) ) {
|
||||
$stack->push( $token );
|
||||
} elseif ( array_key_exists( $token, self::$v ) ) {
|
||||
$stack->push( self::$v[ $token ] );
|
||||
} elseif ( array_key_exists( $token, $vars ) ) {
|
||||
$stack->push( $vars[ $token ] );
|
||||
} else {
|
||||
return self::trigger( "undefined variable '$token'" );
|
||||
}
|
||||
}
|
||||
}
|
||||
// when we're out of tokens, the stack should have a single element, the final result
|
||||
if ( 1 != $stack->count ) {
|
||||
return self::trigger( "internal error" );
|
||||
}
|
||||
return $stack->pop();
|
||||
}
|
||||
|
||||
/**
|
||||
* Trigger an error, but nicely, if need be.
|
||||
*
|
||||
* @param string $msg
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
private static function trigger( $msg ) {
|
||||
self::$last_error = $msg;
|
||||
if ( ! Constants::is_true( 'DOING_AJAX' ) && Constants::is_true( 'WP_DEBUG' ) ) {
|
||||
echo "\nError found in:";
|
||||
self::debugPrintCallingFunction();
|
||||
trigger_error( $msg, E_USER_WARNING );
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prints the file name, function name, and
|
||||
* line number which called your function
|
||||
* (not this function, then one that called
|
||||
* it to begin with)
|
||||
*/
|
||||
private static function debugPrintCallingFunction() {
|
||||
$file = 'n/a';
|
||||
$func = 'n/a';
|
||||
$line = 'n/a';
|
||||
$debugTrace = debug_backtrace();
|
||||
if ( isset( $debugTrace[1] ) ) {
|
||||
$file = $debugTrace[1]['file'] ? $debugTrace[1]['file'] : 'n/a';
|
||||
$line = $debugTrace[1]['line'] ? $debugTrace[1]['line'] : 'n/a';
|
||||
}
|
||||
if ( isset( $debugTrace[2] ) ) {
|
||||
$func = $debugTrace[2]['function'] ? $debugTrace[2]['function'] : 'n/a';
|
||||
}
|
||||
echo "\n$file, $func, $line\n";
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Class WC_Eval_Math_Stack.
|
||||
*/
|
||||
class WC_Eval_Math_Stack {
|
||||
|
||||
/**
|
||||
* Stack array.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $stack = array();
|
||||
|
||||
/**
|
||||
* Stack counter.
|
||||
*
|
||||
* @var integer
|
||||
*/
|
||||
public $count = 0;
|
||||
|
||||
/**
|
||||
* Push value into stack.
|
||||
*
|
||||
* @param mixed $val
|
||||
*/
|
||||
public function push( $val ) {
|
||||
$this->stack[ $this->count ] = $val;
|
||||
$this->count++;
|
||||
}
|
||||
|
||||
/**
|
||||
* Pop value from stack.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function pop() {
|
||||
if ( $this->count > 0 ) {
|
||||
$this->count--;
|
||||
return $this->stack[ $this->count ];
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get last value from stack.
|
||||
*
|
||||
* @param int $n
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function last( $n=1 ) {
|
||||
$key = $this->count - $n;
|
||||
return array_key_exists( $key, $this->stack ) ? $this->stack[ $key ] : null;
|
||||
}
|
||||
}
|
||||
}
|
||||
160
includes/libraries/wp-async-request.php
Normal file
160
includes/libraries/wp-async-request.php
Normal file
@ -0,0 +1,160 @@
|
||||
<?php
|
||||
/**
|
||||
* WP Async Request
|
||||
*
|
||||
* @package WP-Background-Processing
|
||||
*/
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Abstract WP_Async_Request class.
|
||||
*/
|
||||
abstract class WP_Async_Request {
|
||||
|
||||
/**
|
||||
* Prefix
|
||||
*
|
||||
* (default value: 'wp')
|
||||
*
|
||||
* @var string
|
||||
* @access protected
|
||||
*/
|
||||
protected $prefix = 'wp';
|
||||
|
||||
/**
|
||||
* Action
|
||||
*
|
||||
* (default value: 'async_request')
|
||||
*
|
||||
* @var string
|
||||
* @access protected
|
||||
*/
|
||||
protected $action = 'async_request';
|
||||
|
||||
/**
|
||||
* Identifier
|
||||
*
|
||||
* @var mixed
|
||||
* @access protected
|
||||
*/
|
||||
protected $identifier;
|
||||
|
||||
/**
|
||||
* Data
|
||||
*
|
||||
* (default value: array())
|
||||
*
|
||||
* @var array
|
||||
* @access protected
|
||||
*/
|
||||
protected $data = array();
|
||||
|
||||
/**
|
||||
* Initiate new async request
|
||||
*/
|
||||
public function __construct() {
|
||||
$this->identifier = $this->prefix . '_' . $this->action;
|
||||
|
||||
add_action( 'wp_ajax_' . $this->identifier, array( $this, 'maybe_handle' ) );
|
||||
add_action( 'wp_ajax_nopriv_' . $this->identifier, array( $this, 'maybe_handle' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Set data used during the request
|
||||
*
|
||||
* @param array $data Data.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function data( $data ) {
|
||||
$this->data = $data;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatch the async request
|
||||
*
|
||||
* @return array|WP_Error
|
||||
*/
|
||||
public function dispatch() {
|
||||
$url = add_query_arg( $this->get_query_args(), $this->get_query_url() );
|
||||
$args = $this->get_post_args();
|
||||
|
||||
return wp_remote_post( esc_url_raw( $url ), $args );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get query args
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function get_query_args() {
|
||||
if ( property_exists( $this, 'query_args' ) ) {
|
||||
return $this->query_args;
|
||||
}
|
||||
|
||||
return array(
|
||||
'action' => $this->identifier,
|
||||
'nonce' => wp_create_nonce( $this->identifier ),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get query URL
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function get_query_url() {
|
||||
if ( property_exists( $this, 'query_url' ) ) {
|
||||
return $this->query_url;
|
||||
}
|
||||
|
||||
return admin_url( 'admin-ajax.php' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get post args
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function get_post_args() {
|
||||
if ( property_exists( $this, 'post_args' ) ) {
|
||||
return $this->post_args;
|
||||
}
|
||||
|
||||
return array(
|
||||
'timeout' => 0.01,
|
||||
'blocking' => false,
|
||||
'body' => $this->data,
|
||||
'cookies' => $_COOKIE,
|
||||
'sslverify' => apply_filters( 'https_local_ssl_verify', false ),
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Maybe handle
|
||||
*
|
||||
* Check for correct nonce and pass to handler.
|
||||
*/
|
||||
public function maybe_handle() {
|
||||
// Don't lock up other requests while processing
|
||||
session_write_close();
|
||||
|
||||
check_ajax_referer( $this->identifier, 'nonce' );
|
||||
|
||||
$this->handle();
|
||||
|
||||
wp_die();
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle
|
||||
*
|
||||
* Override this method to perform any actions required
|
||||
* during the async request.
|
||||
*/
|
||||
abstract protected function handle();
|
||||
|
||||
}
|
||||
503
includes/libraries/wp-background-process.php
Normal file
503
includes/libraries/wp-background-process.php
Normal file
@ -0,0 +1,503 @@
|
||||
<?php // @codingStandardsIgnoreLine.
|
||||
/**
|
||||
* Abstract WP_Background_Process class.
|
||||
*
|
||||
* @package WP-Background-Processing
|
||||
* @extends WP_Async_Request
|
||||
*/
|
||||
|
||||
defined( 'ABSPATH' ) || exit;
|
||||
|
||||
/**
|
||||
* Abstract WP_Background_Process class.
|
||||
*/
|
||||
abstract class WP_Background_Process extends WP_Async_Request {
|
||||
|
||||
/**
|
||||
* Action
|
||||
*
|
||||
* (default value: 'background_process')
|
||||
*
|
||||
* @var string
|
||||
* @access protected
|
||||
*/
|
||||
protected $action = 'background_process';
|
||||
|
||||
/**
|
||||
* Start time of current process.
|
||||
*
|
||||
* (default value: 0)
|
||||
*
|
||||
* @var int
|
||||
* @access protected
|
||||
*/
|
||||
protected $start_time = 0;
|
||||
|
||||
/**
|
||||
* Cron_hook_identifier
|
||||
*
|
||||
* @var mixed
|
||||
* @access protected
|
||||
*/
|
||||
protected $cron_hook_identifier;
|
||||
|
||||
/**
|
||||
* Cron_interval_identifier
|
||||
*
|
||||
* @var mixed
|
||||
* @access protected
|
||||
*/
|
||||
protected $cron_interval_identifier;
|
||||
|
||||
/**
|
||||
* Initiate new background process
|
||||
*/
|
||||
public function __construct() {
|
||||
parent::__construct();
|
||||
|
||||
$this->cron_hook_identifier = $this->identifier . '_cron';
|
||||
$this->cron_interval_identifier = $this->identifier . '_cron_interval';
|
||||
|
||||
add_action( $this->cron_hook_identifier, array( $this, 'handle_cron_healthcheck' ) );
|
||||
add_filter( 'cron_schedules', array( $this, 'schedule_cron_healthcheck' ) );
|
||||
}
|
||||
|
||||
/**
|
||||
* Dispatch
|
||||
*
|
||||
* @access public
|
||||
* @return void
|
||||
*/
|
||||
public function dispatch() {
|
||||
// Schedule the cron healthcheck.
|
||||
$this->schedule_event();
|
||||
|
||||
// Perform remote post.
|
||||
return parent::dispatch();
|
||||
}
|
||||
|
||||
/**
|
||||
* Push to queue
|
||||
*
|
||||
* @param mixed $data Data.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function push_to_queue( $data ) {
|
||||
$this->data[] = $data;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Save queue
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function save() {
|
||||
$key = $this->generate_key();
|
||||
|
||||
if ( ! empty( $this->data ) ) {
|
||||
update_site_option( $key, $this->data );
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update queue
|
||||
*
|
||||
* @param string $key Key.
|
||||
* @param array $data Data.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function update( $key, $data ) {
|
||||
if ( ! empty( $data ) ) {
|
||||
update_site_option( $key, $data );
|
||||
}
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete queue
|
||||
*
|
||||
* @param string $key Key.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
public function delete( $key ) {
|
||||
delete_site_option( $key );
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate key
|
||||
*
|
||||
* Generates a unique key based on microtime. Queue items are
|
||||
* given a unique key so that they can be merged upon save.
|
||||
*
|
||||
* @param int $length Length.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
protected function generate_key( $length = 64 ) {
|
||||
$unique = md5( microtime() . rand() );
|
||||
$prepend = $this->identifier . '_batch_';
|
||||
|
||||
return substr( $prepend . $unique, 0, $length );
|
||||
}
|
||||
|
||||
/**
|
||||
* Maybe process queue
|
||||
*
|
||||
* Checks whether data exists within the queue and that
|
||||
* the process is not already running.
|
||||
*/
|
||||
public function maybe_handle() {
|
||||
// Don't lock up other requests while processing
|
||||
session_write_close();
|
||||
|
||||
if ( $this->is_process_running() ) {
|
||||
// Background process already running.
|
||||
wp_die();
|
||||
}
|
||||
|
||||
if ( $this->is_queue_empty() ) {
|
||||
// No data to process.
|
||||
wp_die();
|
||||
}
|
||||
|
||||
check_ajax_referer( $this->identifier, 'nonce' );
|
||||
|
||||
$this->handle();
|
||||
|
||||
wp_die();
|
||||
}
|
||||
|
||||
/**
|
||||
* Is queue empty
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function is_queue_empty() {
|
||||
global $wpdb;
|
||||
|
||||
$table = $wpdb->options;
|
||||
$column = 'option_name';
|
||||
|
||||
if ( is_multisite() ) {
|
||||
$table = $wpdb->sitemeta;
|
||||
$column = 'meta_key';
|
||||
}
|
||||
|
||||
$key = $this->identifier . '_batch_%';
|
||||
|
||||
$count = $wpdb->get_var( $wpdb->prepare( "
|
||||
SELECT COUNT(*)
|
||||
FROM {$table}
|
||||
WHERE {$column} LIKE %s
|
||||
", $key ) );
|
||||
|
||||
return ! ( $count > 0 );
|
||||
}
|
||||
|
||||
/**
|
||||
* Is process running
|
||||
*
|
||||
* Check whether the current process is already running
|
||||
* in a background process.
|
||||
*/
|
||||
protected function is_process_running() {
|
||||
if ( get_site_transient( $this->identifier . '_process_lock' ) ) {
|
||||
// Process already running.
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* Lock process
|
||||
*
|
||||
* Lock the process so that multiple instances can't run simultaneously.
|
||||
* Override if applicable, but the duration should be greater than that
|
||||
* defined in the time_exceeded() method.
|
||||
*/
|
||||
protected function lock_process() {
|
||||
$this->start_time = time(); // Set start time of current process.
|
||||
|
||||
$lock_duration = ( property_exists( $this, 'queue_lock_time' ) ) ? $this->queue_lock_time : 60; // 1 minute
|
||||
$lock_duration = apply_filters( $this->identifier . '_queue_lock_time', $lock_duration );
|
||||
|
||||
set_site_transient( $this->identifier . '_process_lock', microtime(), $lock_duration );
|
||||
}
|
||||
|
||||
/**
|
||||
* Unlock process
|
||||
*
|
||||
* Unlock the process so that other instances can spawn.
|
||||
*
|
||||
* @return $this
|
||||
*/
|
||||
protected function unlock_process() {
|
||||
delete_site_transient( $this->identifier . '_process_lock' );
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get batch
|
||||
*
|
||||
* @return stdClass Return the first batch from the queue
|
||||
*/
|
||||
protected function get_batch() {
|
||||
global $wpdb;
|
||||
|
||||
$table = $wpdb->options;
|
||||
$column = 'option_name';
|
||||
$key_column = 'option_id';
|
||||
$value_column = 'option_value';
|
||||
|
||||
if ( is_multisite() ) {
|
||||
$table = $wpdb->sitemeta;
|
||||
$column = 'meta_key';
|
||||
$key_column = 'meta_id';
|
||||
$value_column = 'meta_value';
|
||||
}
|
||||
|
||||
$key = $this->identifier . '_batch_%';
|
||||
|
||||
$query = $wpdb->get_row( $wpdb->prepare( "
|
||||
SELECT *
|
||||
FROM {$table}
|
||||
WHERE {$column} LIKE %s
|
||||
ORDER BY {$key_column} ASC
|
||||
LIMIT 1
|
||||
", $key ) );
|
||||
|
||||
$batch = new stdClass();
|
||||
$batch->key = $query->$column;
|
||||
$batch->data = maybe_unserialize( $query->$value_column );
|
||||
|
||||
return $batch;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle
|
||||
*
|
||||
* Pass each queue item to the task handler, while remaining
|
||||
* within server memory and time limit constraints.
|
||||
*/
|
||||
protected function handle() {
|
||||
$this->lock_process();
|
||||
|
||||
do {
|
||||
$batch = $this->get_batch();
|
||||
|
||||
foreach ( $batch->data as $key => $value ) {
|
||||
$task = $this->task( $value );
|
||||
|
||||
if ( false !== $task ) {
|
||||
$batch->data[ $key ] = $task;
|
||||
} else {
|
||||
unset( $batch->data[ $key ] );
|
||||
}
|
||||
|
||||
if ( $this->time_exceeded() || $this->memory_exceeded() ) {
|
||||
// Batch limits reached.
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Update or delete current batch.
|
||||
if ( ! empty( $batch->data ) ) {
|
||||
$this->update( $batch->key, $batch->data );
|
||||
} else {
|
||||
$this->delete( $batch->key );
|
||||
}
|
||||
} while ( ! $this->time_exceeded() && ! $this->memory_exceeded() && ! $this->is_queue_empty() );
|
||||
|
||||
$this->unlock_process();
|
||||
|
||||
// Start next batch or complete process.
|
||||
if ( ! $this->is_queue_empty() ) {
|
||||
$this->dispatch();
|
||||
} else {
|
||||
$this->complete();
|
||||
}
|
||||
|
||||
wp_die();
|
||||
}
|
||||
|
||||
/**
|
||||
* Memory exceeded
|
||||
*
|
||||
* Ensures the batch process never exceeds 90%
|
||||
* of the maximum WordPress memory.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function memory_exceeded() {
|
||||
$memory_limit = $this->get_memory_limit() * 0.9; // 90% of max memory
|
||||
$current_memory = memory_get_usage( true );
|
||||
$return = false;
|
||||
|
||||
if ( $current_memory >= $memory_limit ) {
|
||||
$return = true;
|
||||
}
|
||||
|
||||
return apply_filters( $this->identifier . '_memory_exceeded', $return );
|
||||
}
|
||||
|
||||
/**
|
||||
* Get memory limit
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
protected function get_memory_limit() {
|
||||
if ( function_exists( 'ini_get' ) ) {
|
||||
$memory_limit = ini_get( 'memory_limit' );
|
||||
} else {
|
||||
// Sensible default.
|
||||
$memory_limit = '128M';
|
||||
}
|
||||
|
||||
if ( ! $memory_limit || -1 === $memory_limit ) {
|
||||
// Unlimited, set to 32GB.
|
||||
$memory_limit = '32000M';
|
||||
}
|
||||
|
||||
return intval( $memory_limit ) * 1024 * 1024;
|
||||
}
|
||||
|
||||
/**
|
||||
* Time exceeded.
|
||||
*
|
||||
* Ensures the batch never exceeds a sensible time limit.
|
||||
* A timeout limit of 30s is common on shared hosting.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
protected function time_exceeded() {
|
||||
$finish = $this->start_time + apply_filters( $this->identifier . '_default_time_limit', 20 ); // 20 seconds
|
||||
$return = false;
|
||||
|
||||
if ( time() >= $finish ) {
|
||||
$return = true;
|
||||
}
|
||||
|
||||
return apply_filters( $this->identifier . '_time_exceeded', $return );
|
||||
}
|
||||
|
||||
/**
|
||||
* Complete.
|
||||
*
|
||||
* Override if applicable, but ensure that the below actions are
|
||||
* performed, or, call parent::complete().
|
||||
*/
|
||||
protected function complete() {
|
||||
// Unschedule the cron healthcheck.
|
||||
$this->clear_scheduled_event();
|
||||
}
|
||||
|
||||
/**
|
||||
* Schedule cron healthcheck
|
||||
*
|
||||
* @access public
|
||||
* @param mixed $schedules Schedules.
|
||||
* @return mixed
|
||||
*/
|
||||
public function schedule_cron_healthcheck( $schedules ) {
|
||||
$interval = apply_filters( $this->identifier . '_cron_interval', 5 );
|
||||
|
||||
if ( property_exists( $this, 'cron_interval' ) ) {
|
||||
$interval = apply_filters( $this->identifier . '_cron_interval', $this->cron_interval );
|
||||
}
|
||||
|
||||
// Adds every 5 minutes to the existing schedules.
|
||||
$schedules[ $this->identifier . '_cron_interval' ] = array(
|
||||
'interval' => MINUTE_IN_SECONDS * $interval,
|
||||
'display' => sprintf( __( 'Every %d minutes', 'woocommerce' ), $interval ),
|
||||
);
|
||||
|
||||
return $schedules;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle cron healthcheck
|
||||
*
|
||||
* Restart the background process if not already running
|
||||
* and data exists in the queue.
|
||||
*/
|
||||
public function handle_cron_healthcheck() {
|
||||
if ( $this->is_process_running() ) {
|
||||
// Background process already running.
|
||||
exit;
|
||||
}
|
||||
|
||||
if ( $this->is_queue_empty() ) {
|
||||
// No data to process.
|
||||
$this->clear_scheduled_event();
|
||||
exit;
|
||||
}
|
||||
|
||||
$this->handle();
|
||||
|
||||
exit;
|
||||
}
|
||||
|
||||
/**
|
||||
* Schedule event
|
||||
*/
|
||||
protected function schedule_event() {
|
||||
if ( ! wp_next_scheduled( $this->cron_hook_identifier ) ) {
|
||||
wp_schedule_event( time(), $this->cron_interval_identifier, $this->cron_hook_identifier );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear scheduled event
|
||||
*/
|
||||
protected function clear_scheduled_event() {
|
||||
$timestamp = wp_next_scheduled( $this->cron_hook_identifier );
|
||||
|
||||
if ( $timestamp ) {
|
||||
wp_unschedule_event( $timestamp, $this->cron_hook_identifier );
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Cancel Process
|
||||
*
|
||||
* Stop processing queue items, clear cronjob and delete batch.
|
||||
*
|
||||
*/
|
||||
public function cancel_process() {
|
||||
if ( ! $this->is_queue_empty() ) {
|
||||
$batch = $this->get_batch();
|
||||
|
||||
$this->delete( $batch->key );
|
||||
|
||||
wp_clear_scheduled_hook( $this->cron_hook_identifier );
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* Task
|
||||
*
|
||||
* Override this method to perform any actions required on each
|
||||
* queue item. Return the modified item for further processing
|
||||
* in the next pass through. Or, return false to remove the
|
||||
* item from the queue.
|
||||
*
|
||||
* @param mixed $item Queue item to iterate over.
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
abstract protected function task( $item );
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user