woocommerce/includes/libraries/class-wc-eval-math.php

403 lines
13 KiB
PHP
Raw Normal View History

2015-06-12 13:27:50 +00:00
<?php
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
2017-02-16 11:46:01 +00:00
if ( ! class_exists( 'WC_Eval_Math', false ) ) {
2015-12-18 14:26:10 +00:00
/**
* 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 {
2015-06-12 13:27:50 +00:00
/**
* Last error.
*
* @var string
*/
2015-12-18 14:26:10 +00:00
public static $last_error = null;
2015-06-12 13:27:50 +00:00
/**
* Variables (and constants).
*
* @var array
*/
public static $v = array( 'e' => 2.71, 'pi' => 3.14 );
2015-06-12 13:27:50 +00:00
/**
* User-defined functions.
*
* @var array
*/
public static $f = array();
2015-06-12 13:27:50 +00:00
/**
* Constants.
*
* @var array
*/
public static $vb = array( 'e', 'pi' );
2015-06-12 13:27:50 +00:00
/**
* Built-in functions.
*
* @var array
*/
public static $fb = array();
2015-06-12 13:27:50 +00:00
2015-12-18 14:26:10 +00:00
/**
* 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
}
// ===============
2015-12-18 14:26:10 +00:00
// 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
// ===============
2015-12-18 14:26:10 +00:00
// 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
}
2016-06-06 15:59:09 +00:00
$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 ) ) {
2015-12-18 14:26:10 +00:00
if ( array_key_exists( $token, self::$v ) ) {
$stack[ $i ] = self::$v[ $token ];
2015-12-18 14:26:10 +00:00
} else {
return self::trigger( "undefined variable '$token' in function definition" );
}
2015-06-12 13:27:50 +00:00
}
}
self::$f[ $fnn ] = array( 'args' => $args, 'func' => $stack );
2015-12-18 14:26:10 +00:00
return true;
// ===============
2015-12-18 14:26:10 +00:00
} else {
return self::pfx( self::nfx( $expr ) ); // straight up evaluation, woo
2015-06-12 13:27:50 +00:00
}
}
2015-12-18 14:26:10 +00:00
/**
* Convert infix to postfix notation.
*
* @param string $expr
*
* @return array|string
2015-12-18 14:26:10 +00:00
*/
private static function nfx( $expr ) {
2015-06-12 13:27:50 +00:00
2015-12-18 14:26:10 +00:00
$index = 0;
$stack = new WC_Eval_Math_Stack;
$output = array(); // postfix form of expression, to be passed to pfx()
$expr = trim( $expr );
2015-06-12 13:27:50 +00:00
2015-12-18 14:26:10 +00:00
$ops = array( '+', '-', '*', '/', '^', '_' );
$ops_r = array( '+' => 0, '-' => 0, '*' => 0, '/' => 0, '^' => 1 ); // right-associative operator?
$ops_p = array( '+' => 0, '-' => 0, '*' => 1, '/' => 1, '_' => 1, '^' => 2 ); // operator precedence
2015-06-12 13:27:50 +00:00
2015-12-18 14:26:10 +00:00
$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]}'" );
}
2015-06-12 13:27:50 +00:00
2015-12-18 14:26:10 +00:00
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 );
// ===============
2016-09-09 00:14:28 +00:00
if ( '-' === $op and ! $expecting_op ) { // is it a negation instead of a minus?
2015-12-18 14:26:10 +00:00
$stack->push( '_' ); // put a negation on the stack
$index++;
2016-09-09 00:14:28 +00:00
} elseif ( '_' === $op ) { // we have to explicitly deny this, because it's legal on the stack
2015-12-18 14:26:10 +00:00
return self::trigger( "illegal character '_'" ); // but not in the input expression
// ===============
2015-12-18 14:26:10 +00:00
} 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 parethesis?
$op = '*';
$index--; // it's an implicit multiplication
2015-06-12 13:27:50 +00:00
}
2015-12-18 14:26:10 +00:00
// 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 ] ) ) {
2015-12-18 14:26:10 +00:00
$output[] = $stack->pop(); // pop stuff off the stack into the output
}
2016-05-27 01:48:49 +00:00
// many thanks: https://en.wikipedia.org/wiki/Reverse_Polish_notation#The_algorithm_in_detail
2015-12-18 14:26:10 +00:00
$stack->push( $op ); // finally put OUR operator onto the stack
$index++;
$expecting_op = false;
// ===============
2016-09-09 00:14:28 +00:00
} elseif ( ')' === $op && $expecting_op ) { // ready to close a parenthesis?
2015-12-18 14:26:10 +00:00
while ( ( $o2 = $stack->pop() ) != '(' ) { // pop off the stack back to the last (
2016-09-09 00:14:28 +00:00
if ( is_null( $o2 ) ) {
return self::trigger( "unexpected ')'" );
} else {
$output[] = $o2;
}
2015-12-18 14:26:10 +00:00
}
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 ) {
2015-12-18 14:26:10 +00:00
return self::trigger( "too many arguments ($arg_count given, 1 expected)" );
}
2015-12-18 14:26:10 +00:00
} 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)" );
}
2015-12-18 14:26:10 +00:00
} else { // did we somehow push a non-function on the stack? this should never happen
return self::trigger( "internal error" );
}
}
$index++;
// ===============
2016-09-09 00:14:28 +00:00
} elseif ( ',' === $op and $expecting_op ) { // did we just finish a function argument?
2015-12-18 14:26:10 +00:00
while ( ( $o2 = $stack->pop() ) != '(' ) {
2016-09-09 00:14:28 +00:00
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
}
2015-12-18 14:26:10 +00:00
}
// make sure there was a function
if ( ! preg_match( "/^([A-Za-z]\w*)\($/", $stack->last( 2 ), $matches ) ) {
2015-12-18 14:26:10 +00:00
return self::trigger( "unexpected ','" );
}
$stack->push( $stack->pop() + 1 ); // increment the argument count
2015-12-18 14:26:10 +00:00
$stack->push( '(' ); // put the ( back on, we'll need to pop back to it again
$index++;
$expecting_op = false;
// ===============
2016-09-09 00:14:28 +00:00
} elseif ( '(' === $op and ! $expecting_op ) {
2015-12-18 14:26:10 +00:00
$stack->push( '(' ); // that was easy
$index++;
// ===============
} elseif ( $ex and ! $expecting_op ) { // do we now have a function/variable/number?
2015-12-18 14:26:10 +00:00
$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
2015-06-12 13:27:50 +00:00
$output[] = $val;
}
2015-12-18 14:26:10 +00:00
$index += strlen( $val );
// ===============
2016-09-09 00:14:28 +00:00
} elseif ( ')' === $op ) { // miscellaneous error checking
2015-12-18 14:26:10 +00:00
return self::trigger( "unexpected ')'" );
} elseif ( in_array( $op, $ops ) and ! $expecting_op ) {
2015-12-18 14:26:10 +00:00
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" );
2015-06-12 13:27:50 +00:00
}
2016-09-09 00:14:28 +00:00
if ( strlen( $expr ) == $index ) {
2015-12-18 14:26:10 +00:00
if ( in_array( $op, $ops ) ) { // did we end with an operator? bad.
return self::trigger( "operator '$op' lacks operand" );
} else {
break;
}
2015-06-12 13:27:50 +00:00
}
2015-12-18 14:26:10 +00:00
while ( substr( $expr, $index, 1 ) == ' ' ) { // step the index past whitespace (pretty much turns whitespace
$index++; // into implicit multiplication if no operator is there)
}
2015-06-12 13:27:50 +00:00
}
while ( ! is_null( $op = $stack->pop() ) ) { // pop everything off the stack and push onto output
2016-09-09 00:14:28 +00:00
if ( '(' === $op ) {
return self::trigger( "expecting ')'" ); // if there are (s on the stack, ()s were unbalanced
}
2015-12-18 14:26:10 +00:00
$output[] = $op;
2015-06-12 13:27:50 +00:00
}
2015-12-18 14:26:10 +00:00
return $output;
2015-06-12 13:27:50 +00:00
}
/**
* Evaluate postfix notation.
*
* @param mixed $tokens
* @param array $vars
*
* @return mixed
*/
2015-12-18 14:26:10 +00:00
private static function pfx( $tokens, $vars = array() ) {
2016-09-09 00:14:28 +00:00
if ( false == $tokens ) {
return false;
}
2015-12-18 14:26:10 +00:00
$stack = new WC_Eval_Math_Stack;
2015-06-12 13:27:50 +00:00
2015-12-18 14:26:10 +00:00
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" );
}
2015-12-18 14:26:10 +00:00
switch ( $token ) {
case '+':
$stack->push( $op1 + $op2 );
break;
case '-':
$stack->push( $op1 - $op2 );
break;
case '*':
$stack->push( $op1 * $op2 );
break;
case '/':
2016-09-09 00:14:28 +00:00
if ( 0 == $op2 ) {
return self::trigger( 'division by zero' );
}
$stack->push( $op1 / $op2 );
break;
case '^':
$stack->push( pow( $op1, $op2 ) );
break;
2015-12-18 14:26:10 +00:00
}
// if the token is a unary operator, pop one value off the stack, do the operation, and push it back on
2016-09-09 00:14:28 +00:00
} elseif ( '_' === $token ) {
$stack->push( -1 * $stack->pop() );
2015-12-18 14:26:10 +00:00
// 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 ] );
2015-12-18 14:26:10 +00:00
} elseif ( array_key_exists( $token, $vars ) ) {
$stack->push( $vars[ $token ] );
2015-12-18 14:26:10 +00:00
} else {
return self::trigger( "undefined variable '$token'" );
}
2015-06-12 13:27:50 +00:00
}
}
2015-12-18 14:26:10 +00:00
// when we're out of tokens, the stack should have a single element, the final result
2016-09-09 00:14:28 +00:00
if ( 1 != $stack->count ) {
return self::trigger( "internal error" );
}
2015-12-18 14:26:10 +00:00
return $stack->pop();
2015-06-12 13:27:50 +00:00
}
/**
* Trigger an error, but nicely, if need be.
*
* @param string $msg
*
* @return bool
*/
2015-12-18 14:26:10 +00:00
private static function trigger( $msg ) {
self::$last_error = $msg;
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
echo "\nError found in:";
self::debugPrintCallingFunction();
trigger_error( $msg, E_USER_WARNING );
}
return false;
2015-06-12 13:27:50 +00:00
}
/**
* Prints the file name, function name, and
* line number which called your function
* (not this function, then one that called
* it to begin with)
*/
2015-12-18 14:26:10 +00:00
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';
}
2015-12-18 14:26:10 +00:00
echo "\n$file, $func, $line\n";
2015-06-12 13:27:50 +00:00
}
}
2015-12-18 14:26:10 +00:00
/**
* Class WC_Eval_Math_Stack.
*/
class WC_Eval_Math_Stack {
2015-06-12 13:27:50 +00:00
/**
* Stack array.
*
* @var array
*/
2015-12-18 14:26:10 +00:00
public $stack = array();
2015-06-12 13:27:50 +00:00
/**
* Stack counter.
*
* @var integer
*/
2015-12-18 14:26:10 +00:00
public $count = 0;
2015-06-12 13:27:50 +00:00
/**
* Push value into stack.
*
* @param mixed $val
*/
2015-12-18 14:26:10 +00:00
public function push( $val ) {
$this->stack[ $this->count ] = $val;
$this->count++;
}
2015-06-12 13:27:50 +00:00
/**
* Pop value from stack.
*
* @return mixed
*/
2015-12-18 14:26:10 +00:00
public function pop() {
if ( $this->count > 0 ) {
$this->count--;
return $this->stack[ $this->count ];
}
return null;
2015-06-12 13:27:50 +00:00
}
/**
* Get last value from stack.
*
* @param int $n
*
* @return mixed
*/
2015-12-18 14:26:10 +00:00
public function last( $n=1 ) {
$key = $this->count - $n;
return array_key_exists( $key, $this->stack ) ? $this->stack[ $key ] : null;
}
2015-06-12 13:27:50 +00:00
}
}