stklcode/statify-blacklist
stklcode/statify-blacklist
1
0
Fork 0
Code Issues Actions Releases 21 Activity

Preprocessing of regular expression in separate funciton

Browse Source
This commit is contained in:
Stefan Kalscheuer 2019-03-17 17:27:33 +01:00
parent 39dcce3eeb
commit 1c69ba31bb
2 changed files with 46 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
inc/class-statifyblacklist.php
View File

@ -116,6 +116,7 @@ class StatifyBlacklist {
* @since 1.2.1 update_options($options = null) Parameter with default value introduced. * @since 1.2.1 update_options($options = null) Parameter with default value introduced.
* *
* @param array $options Optional. New options to save. * @param array $options Optional. New options to save.
*
* @return void * @return void
*/ */
public static function update_options( $options = null ) { public static function update_options( $options = null ) {
@ -181,10 +182,10 @@ class StatifyBlacklist {
case self::MODE_REGEX: case self::MODE_REGEX:
case self::MODE_REGEX_CI: case self::MODE_REGEX_CI:
// Merge given regular expressions into one. // Merge given regular expressions into one.
$regexp = '/' . implode( '|', array_keys( self::$_options['referer']['blacklist'] ) ) . '/'; $regexp = self::regex(
if ( self::MODE_REGEX_CI === self::$_options['referer']['regexp'] ) { array_keys( self::$_options['referer']['blacklist'] ),
$regexp .= 'i'; self::MODE_REGEX_CI === self::$_options['referer']['regexp']
} );
// Check blacklist (no return to continue filtering #12). // Check blacklist (no return to continue filtering #12).
if ( 1 === preg_match( $regexp, $referer ) ) { if ( 1 === preg_match( $regexp, $referer ) ) {
@ -229,10 +230,10 @@ class StatifyBlacklist {
$target = ( isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : '/' ); $target = ( isset( $_SERVER['REQUEST_URI'] ) ? $_SERVER['REQUEST_URI'] : '/' );
// @codingStandardsIgnoreEnd // @codingStandardsIgnoreEnd
// Merge given regular expressions into one. // Merge given regular expressions into one.
$regexp = '/' . implode( '|', array_keys( self::$_options['target']['blacklist'] ) ) . '/'; $regexp = self::regex(
if ( 2 === self::$_options['target']['regexp'] ) { array_keys( self::$_options['target']['blacklist'] ),
$regexp .= 'i'; self::MODE_REGEX_CI === self::$_options['target']['regexp']
} );
// Check blacklist (no return to continue filtering #12). // Check blacklist (no return to continue filtering #12).
if ( 1 === preg_match( $regexp, $target ) ) { if ( 1 === preg_match( $regexp, $target ) ) {
@ -268,6 +269,37 @@ class StatifyBlacklist {
return null; return null;
} }
/**
* Preprocess regular expression provided by the user, i.e. add delimiters and optional ci flag.
*
* @param string|array $expression Original expression string or array of expressions.
* @param string|array $case_insensitive Make expression match case-insensitive.
*
* @return string Preprocessed expression ready for preg_match().
*/
protected static function regex( $expression, $case_insensitive ) {
$res = '/';
if ( is_string( $expression ) ) {
$res .= str_replace( '/', '\/', $expression );
} elseif ( is_array( $expression ) ) {
$res .= implode(
'|',
array_map(
function ( $e ) {
return str_replace( '/', '\/', $e );
},
$expression
)
);
}
$res .= '/';
if ( $case_insensitive ) {
$res .= 'i';
}
return $res;
}
/** /**
* Helper method to determine the client's IP address. * Helper method to determine the client's IP address.
* *

7
test/statifyblacklist-test.php
View File

@ -617,11 +617,16 @@ class StatifyBlacklist_Test extends PHPUnit\Framework\TestCase {
StatifyBlacklist::$_options['referer']['regexp'] = StatifyBlacklist::MODE_REGEX; StatifyBlacklist::$_options['referer']['regexp'] = StatifyBlacklist::MODE_REGEX;
StatifyBlacklist::$_options['referer']['blacklist'] = array( 'example\.com' => 0 ); StatifyBlacklist::$_options['referer']['blacklist'] = array( 'example\.com' => 0 );
StatifyBlacklist::$_options['target']['regexp'] = StatifyBlacklist::MODE_REGEX; StatifyBlacklist::$_options['target']['regexp'] = StatifyBlacklist::MODE_REGEX;
StatifyBlacklist::$_options['target']['blacklist'] = array( '\/excluded\/.*' => 0 ); StatifyBlacklist::$_options['target']['blacklist'] = array( '/excluded/.*' => 0 );
$this->assertNull( StatifyBlacklist::apply_blacklist_filter() ); $this->assertNull( StatifyBlacklist::apply_blacklist_filter() );
$_SERVER['HTTP_REFERER'] = 'https://example.com'; $_SERVER['HTTP_REFERER'] = 'https://example.com';
$this->assertTrue( StatifyBlacklist::apply_blacklist_filter() ); $this->assertTrue( StatifyBlacklist::apply_blacklist_filter() );
// Check case-insensitive match.
$_SERVER['HTTP_REFERER'] = 'https://eXaMpLe.com';
$this->assertNull( StatifyBlacklist::apply_blacklist_filter() );
StatifyBlacklist::$_options['referer']['regexp'] = StatifyBlacklist::MODE_REGEX_CI;
$this->assertTrue( StatifyBlacklist::apply_blacklist_filter() );
$_SERVER['HTTP_REFERER'] = 'https://example.net'; $_SERVER['HTTP_REFERER'] = 'https://example.net';
$_SERVER['REQUEST_URI'] = '/excluded/page/'; $_SERVER['REQUEST_URI'] = '/excluded/page/';
$this->assertTrue( StatifyBlacklist::apply_blacklist_filter() ); $this->assertTrue( StatifyBlacklist::apply_blacklist_filter() );