PhpProfiler\Lib\PhpProcessReader\PhpVersionDetector

Complexity

Total Complexity

12

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	detectPhpVersion()	0	33	3
A	getDereferencer()	0	7	1
A	getTypeReader()	0	6	2
A	getModuleRegistry()	0	12	1
A	decidePhpVersion()	0	31	4
A	__construct()	0	5	1

<?php

/**
 * This file is part of the sj-i/php-profiler package.
 *
 * (c) sji <sji@sj-i.dev>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace PhpProfiler\Lib\PhpProcessReader;

use PhpProfiler\Inspector\Settings\TargetPhpSettings\TargetPhpSettings;
use PhpProfiler\Lib\PhpInternals\Types\Zend\ZendArray;
use PhpProfiler\Lib\PhpInternals\Types\Zend\ZendCastedTypeProvider;
use PhpProfiler\Lib\PhpInternals\Types\Zend\ZendModuleEntry;
use PhpProfiler\Lib\PhpInternals\ZendTypeReader;
use PhpProfiler\Lib\PhpInternals\ZendTypeReaderCreator;
use PhpProfiler\Lib\Process\MemoryReader\MemoryReaderInterface;
use PhpProfiler\Lib\Process\Pointer\Dereferencer;
use PhpProfiler\Lib\Process\Pointer\Pointer;
use PhpProfiler\Lib\Process\Pointer\RemoteProcessDereferencer;
use PhpProfiler\Lib\Process\ProcessSpecifier;
use Webmozart\Assert\Assert;

class PhpVersionDetector
{
    private ?ZendTypeReader $zend_type_reader = null;

    public function __construct(
        private PhpGlobalsFinder $php_globals_finder,
        private MemoryReaderInterface $memory_reader,
        private ZendTypeReaderCreator $zend_type_reader_creator,
    ) {
    }

    /**
     * @param value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> $php_version

The doc comment value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> at position 0 could not be parsed: Unknown type name 'value-of' at position 0 in value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS>.

     */
    private function getTypeReader(string $php_version): ZendTypeReader
    {
        if (is_null($this->zend_type_reader)) {
            $this->zend_type_reader = $this->zend_type_reader_creator->create($php_version);
        }
        return $this->zend_type_reader;
    }

    /**
     * @param value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> $php_version

The doc comment value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> at position 0 could not be parsed: Unknown type name 'value-of' at position 0 in value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS>.

     */
    private function getDereferencer(int $pid, string $php_version): Dereferencer
    {
        return new RemoteProcessDereferencer(
            $this->memory_reader,
            new ProcessSpecifier($pid),
            new ZendCastedTypeProvider(
                $this->getTypeReader($php_version),
            )
        );
    }

    /** @return TargetPhpSettings<value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS>> */
    public function decidePhpVersion(
        ProcessSpecifier $process_specifier,
        TargetPhpSettings $target_php_settings,
    ): TargetPhpSettings {
        if ($target_php_settings->php_version !== 'auto') {
            /** @var TargetPhpSettings<value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS>> */
            return $target_php_settings;
        }
        $module_registry_address = $this->php_globals_finder->findModuleRegistry(
            $process_specifier,
            $target_php_settings,
        );
        $version = null;
        if (!is_null($module_registry_address)) {
            $version = $this->detectPhpVersion($process_specifier->pid, $module_registry_address);
        }

        if (is_null($version)) {
            /** @var value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> $version */
            $version = 'v' . PHP_MAJOR_VERSION . PHP_MINOR_VERSION;
            Assert::true(ZendTypeReader::isSupported($version));
        }

        assert(isset($target_php_settings->libpthread_path));

        return new TargetPhpSettings(
            php_regex: $target_php_settings->php_regex,
            libpthread_regex: $target_php_settings->libpthread_regex,
            php_version: $version,
            php_path: $target_php_settings->php_path,
            libpthread_path: $target_php_settings->libpthread_path,
        );
    }

    /** @return value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS>|null */

The doc comment value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS>|null at position 0 could not be parsed: Unknown type name 'value-of' at position 0 in value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS>|null.

    public function detectPhpVersion(
        int $pid,
        int $module_registry_address
    ): ?string {
        $fake_php_version = ZendTypeReader::defaultVersion();
        $dereferencer = $this->getDereferencer($pid, $fake_php_version);
        $module_registry = $this->getModuleRegistry(
            $module_registry_address,
            $fake_php_version,
            $dereferencer
        );
        $module_registry_entry_bucket = $module_registry->findByKey($dereferencer, 'standard');
        if (is_null($module_registry_entry_bucket)) {
            return null;
        }
        $module_registry_entry_pointer = $module_registry_entry_bucket->val;
        $module_entry_pointer = new Pointer(
            ZendModuleEntry::class,
            $module_registry_entry_pointer->value->lval,
            $this->getTypeReader($fake_php_version)->sizeOf('zend_module_entry')
        );
        /**
         * @var ZendModuleEntry $basic_module_entry
         * @psalm-ignore-var
         */
        $basic_module_entry = $dereferencer->deref($module_entry_pointer);
        $version = $basic_module_entry->getVersion($dereferencer);
        $result_string = 'v' . str_replace('.', '', $version);
        if (ZendTypeReader::isSupported($result_string)) {
            /** @var value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> */
            return $result_string;
        }
        return null;
    }

    /**
     * @param value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> $fake_version

The doc comment value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> at position 0 could not be parsed: Unknown type name 'value-of' at position 0 in value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS>.

     */
    private function getModuleRegistry(
        int $module_registry_address,
        string $fake_php_version,
        Dereferencer $dereferencer
    ): ZendArray {
        /** @var value-of<ZendTypeReader::ALL_SUPPORTED_VERSIONS> $fake_php_version */
        $pointer = new Pointer(
            ZendArray::class,
            $module_registry_address,
            $this->getTypeReader($fake_php_version)->sizeOf('zend_array')
        );
        return $dereferencer->deref($pointer);
    }
}