From: Daimona Eaytoy <daimona.wiki@gmail.com>
Date: Wed, 5 Sep 2018 14:20:13 +0000 (+0200)
Subject: StringUtils: Add a utility for checking if a string is a valid regex
X-Git-Tag: 1.34.0-rc.0~159^2
X-Git-Url: http://git.cyclocoop.org/?a=commitdiff_plain;h=c14571ba26e;hp=2083ba21997bc214c34a5a1edbeef61b0cb98981;p=lhc%2Fweb%2Fwiklou.git

StringUtils: Add a utility for checking if a string is a valid regex

There's no function to check if a string is a valid regex, and doing it
via preg_match requires error suppression, often performed with @. This
isn't however a good practice, and suppressing errors via functions is
not a one line solution. Adding an utility function would probably be a
benefit for several use cases (try to grep '@preg_match' for a few of
them).

Change-Id: I257a096319f1ec13441e9f745dcd22545fdd5cc6
---

diff --git a/includes/libs/StringUtils.php b/includes/libs/StringUtils.php
index 51d108168a..19dd8fe4d3 100644
--- a/includes/libs/StringUtils.php
+++ b/includes/libs/StringUtils.php
@@ -1,4 +1,7 @@
 <?php
+
+use Wikimedia\AtEase\AtEase;
+
 /**
  * Methods to play with strings.
  *
@@ -340,4 +343,21 @@ class StringUtils {
 			return new ArrayIterator( explode( $separator, $subject ) );
 		}
 	}
+
+	/**
+	 * Utility function to check if the given string is a valid regex. Avoids
+	 * manually calling suppressWarnings and restoreWarnings, and provides a
+	 * one-line solution without the need to use @.
+	 *
+	 * @since 1.34
+	 * @param string $string The string you want to check being a valid regex
+	 * @return bool
+	 */
+	public static function isValidRegex( $string ) {
+		AtEase::suppressWarnings();
+		// @phan-suppress-next-line PhanParamSuspiciousOrder False positive
+		$isValid = preg_match( $string, '' );
+		AtEase::restoreWarnings();
+		return $isValid !== false;
+	}
 }
diff --git a/tests/phpunit/includes/libs/StringUtilsTest.php b/tests/phpunit/includes/libs/StringUtilsTest.php
index fcfa53e22d..79d5788fa2 100644
--- a/tests/phpunit/includes/libs/StringUtilsTest.php
+++ b/tests/phpunit/includes/libs/StringUtilsTest.php
@@ -125,4 +125,28 @@ class StringUtilsTest extends PHPUnit\Framework\TestCase {
 			'noncharacters 2' => [ $PASS, "\xef\xbf\xbf" ],
 		];
 	}
+
+	/**
+	 * @param strin $input
+	 * @param bool $expected
+	 * @dataProvider provideRegexps
+	 * @covers StringUtils::isValidRegex
+	 */
+	public function testIsValidRegex( $input, $expected ) {
+		$this->assertSame( $expected, StringUtils::isValidRegex( $input ) );
+	}
+
+	/**
+	 * Data provider for testValidRegex
+	 */
+	public static function provideRegexps() {
+		return [
+			[ 'foo', false ],
+			[ '/foo/', true ],
+			[ '//', true ],
+			[ '/(foo/', false ],
+			[ '!(f[o]{2})!', true ],
+			[ '/foo\/', false ]
+		];
+	}
 }