humbug / php-scoper

src/Configuration/RegexChecker.php

<?php

declare(strict_types=1);

/*
 * This file is part of the humbug/php-scoper package.
 *
 * Copyright (c) 2017 Théo FIDRY <theo.fidry@gmail.com>,
 *                    Pádraic Brady <padraic.brady@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Humbug\PhpScoper\Configuration;

use function array_pop;
use function count;
use function explode;
use function in_array;
use function preg_last_error;
use function preg_last_error_msg;
use function preg_match as native_preg_match;
use function Safe\sprintf;
use function str_split;
use function strlen;

final class RegexChecker
{
    // Some characters are best to not be allowed as regex delimiters in order
    // to not result in some fancy regexes
    // See https://github.com/humbug/php-scoper/issues/597
    private const INVALID_REGEX_DELIMITERS = [
        '\\',
        '_',
    ];

    // https://www.php.net/manual/en/reference.pcre.pattern.modifiers.php
    private const PATTERN_MODIFIERS = [
        'i',
        'm',
        's',
        'x',
        'A',
        'D',
        'S',
        'U',
        'X',
        'J',
        'u',
    ];

    public function isRegexLike(string $value): bool
    {
        $valueLength = strlen($value);

        if ($valueLength < 2) {
            return false;
        }

        /** @var non-empty-string $firstCharacter */
        $firstCharacter = $value[0];

        if (!self::isValidDelimiter($firstCharacter)) {
            return false;
        }

        $parts = explode($firstCharacter, $value);

        if (count($parts) !== 3) {
            return false;
        }

        $lastPart = array_pop($parts);

        if (!self::isValidRegexFlags($lastPart)) {
            return false;
        }

        return true;
    }

    public function validateRegex(string $regex): ?string
    {
        if (@native_preg_match($regex, '') !== false) {
            return null;
        }

        return sprintf(

The function Safe\sprintf() has been deprecated: The Safe version of this function is no longer needed in PHP 8.0+

            'Invalid regex: %s (code %s)',
            preg_last_error_msg(),
            preg_last_error(),
        );
    }

    private static function isValidDelimiter(string $delimiter): bool
    {
        return !in_array($delimiter, self::INVALID_REGEX_DELIMITERS, true)
            && native_preg_match('/^\p{L}$/u', $delimiter) === 0;
    }

    private static function isValidRegexFlags(string $value): bool
    {
        if ('' === $value) {
            return true;
        }

        $characters = str_split($value);

        foreach ($characters as $character) {
            if (!in_array($character, self::PATTERN_MODIFIERS, true)) {
                return false;
            }
        }

        return true;
    }
}