* Dariusz Rumiński * * This source file is subject to the MIT license that is bundled * with this source code in the file LICENSE. */ namespace PhpCsFixer; /** * This class replaces preg_* functions to better handling UTF8 strings, * ensuring no matter "u" modifier is present or absent subject will be handled correctly. * * @author Kuba Werłos * * @internal */ final class Preg { /** * @param string $pattern * @param string $subject * @param null|string[] $matches * @param int $flags * @param int $offset * * @throws PregException * * @return int */ public static function match($pattern, $subject, &$matches = null, $flags = 0, $offset = 0) { $result = @preg_match(self::addUtf8Modifier($pattern), $subject, $matches, $flags, $offset); if (false !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } $result = @preg_match(self::removeUtf8Modifier($pattern), $subject, $matches, $flags, $offset); if (false !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } throw self::newPregException(preg_last_error(), __METHOD__, (array) $pattern); } /** * @param string $pattern * @param string $subject * @param null|string[] $matches * @param int $flags * @param int $offset * * @throws PregException * * @return int */ public static function matchAll($pattern, $subject, &$matches = null, $flags = PREG_PATTERN_ORDER, $offset = 0) { $result = @preg_match_all(self::addUtf8Modifier($pattern), $subject, $matches, $flags, $offset); if (false !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } $result = @preg_match_all(self::removeUtf8Modifier($pattern), $subject, $matches, $flags, $offset); if (false !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } throw self::newPregException(preg_last_error(), __METHOD__, (array) $pattern); } /** * @param string|string[] $pattern * @param string|string[] $replacement * @param string|string[] $subject * @param int $limit * @param null|int $count * * @throws PregException * * @return string|string[] */ public static function replace($pattern, $replacement, $subject, $limit = -1, &$count = null) { $result = @preg_replace(self::addUtf8Modifier($pattern), $replacement, $subject, $limit, $count); if (null !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } $result = @preg_replace(self::removeUtf8Modifier($pattern), $replacement, $subject, $limit, $count); if (null !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } throw self::newPregException(preg_last_error(), __METHOD__, (array) $pattern); } /** * @param string|string[] $pattern * @param callable $callback * @param string|string[] $subject * @param int $limit * @param null|int $count * * @throws PregException * * @return string|string[] */ public static function replaceCallback($pattern, $callback, $subject, $limit = -1, &$count = null) { $result = @preg_replace_callback(self::addUtf8Modifier($pattern), $callback, $subject, $limit, $count); if (null !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } $result = @preg_replace_callback(self::removeUtf8Modifier($pattern), $callback, $subject, $limit, $count); if (null !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } throw self::newPregException(preg_last_error(), __METHOD__, (array) $pattern); } /** * @param string $pattern * @param string $subject * @param int $limit * @param int $flags * * @throws PregException * * @return string[] */ public static function split($pattern, $subject, $limit = -1, $flags = 0) { $result = @preg_split(self::addUtf8Modifier($pattern), $subject, $limit, $flags); if (false !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } $result = @preg_split(self::removeUtf8Modifier($pattern), $subject, $limit, $flags); if (false !== $result && PREG_NO_ERROR === preg_last_error()) { return $result; } throw self::newPregException(preg_last_error(), __METHOD__, (array) $pattern); } /** * @param string|string[] $pattern * * @return string|string[] */ private static function addUtf8Modifier($pattern) { if (\is_array($pattern)) { return array_map(__METHOD__, $pattern); } return $pattern.'u'; } /** * @param string|string[] $pattern * * @return string|string[] */ private static function removeUtf8Modifier($pattern) { if (\is_array($pattern)) { return array_map(__METHOD__, $pattern); } if ('' === $pattern) { return ''; } $delimiter = $pattern[0]; $endDelimiterPosition = strrpos($pattern, $delimiter); return substr($pattern, 0, $endDelimiterPosition).str_replace('u', '', substr($pattern, $endDelimiterPosition)); } /** * Create PregException. * * Create the generic PregException message and if possible due to finding * an invalid pattern, tell more about such kind of error in the message. * * @param int $error * @param string $method * @param string[] $patterns * * @return PregException */ private static function newPregException($error, $method, array $patterns) { foreach ($patterns as $pattern) { $last = error_get_last(); $result = @preg_match($pattern, ''); if (false !== $result) { continue; } $code = preg_last_error(); $next = error_get_last(); if ($last !== $next) { $message = sprintf( '(code: %d) %s', $code, preg_replace('~preg_[a-z_]+[()]{2}: ~', '', $next['message']) ); } else { $message = sprintf('(code: %d)', $code); } return new PregException( sprintf('%s(): Invalid PCRE pattern "%s": %s (version: %s)', $method, $pattern, $message, PCRE_VERSION), $code ); } return new PregException(sprintf('Error occurred when calling %s.', $method), $error); } }