class.registry.php

Go to the documentation of this file.

<?php
/*
 * Copyright (c) 2021-2024 Bearsampp
 * License:  GNU General Public License version 3 or later; see LICENSE.txt
 * Author: Bear
 * Website: https://bearsampp.com
 * Github: https://github.com/Bearsampp
 */

class Registry
{
    const END_PROCESS_STR = 'FINISHED!';
 
    const HKEY_CLASSES_ROOT = 'HKCR';
    const HKEY_CURRENT_USER = 'HKCU';
    const HKEY_LOCAL_MACHINE = 'HKLM';
    const HKEY_USERS = 'HKEY_USERS';
 
    const REG_SZ = 'REG_SZ';
    const REG_EXPAND_SZ = 'REG_EXPAND_SZ';
    const REG_BINARY = 'REG_BINARY';
    const REG_DWORD = 'REG_DWORD';
    const REG_MULTI_SZ = 'REG_MULTI_SZ';
 
    const REG_ERROR_ENTRY = 'REG_ERROR_ENTRY';
    const REG_ERROR_SET = 'REG_ERROR_SET';
    const REG_NO_ERROR = 'REG_NO_ERROR';
 
    const ENV_KEY = 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment';
 
    // App bins entry
    const APP_BINS_REG_ENTRY = 'BEARSAMPP_BINS';
 
    // App path entry
    const APP_PATH_REG_ENTRY = 'BEARSAMPP_PATH';
 
    // System path entry
    const SYSPATH_REG_ENTRY = 'Path';
 
    // Processor architecture
    const PROCESSOR_REG_SUBKEY = 'HARDWARE\DESCRIPTION\System\CentralProcessor\0';
    const PROCESSOR_REG_ENTRY = 'Identifier';
 
    private $latestError;

    public function __construct()
    {
        Log::initClass($this);
        $this->latestError = null;
    }

    private function writeLog($log)
    {
        global $bearsamppRoot;
        Log::debug($log, Path::getRegistryLogFilePath());
    }

    public function exists($key, $subkey, $entry = null)
    {
        $this->writeLog('Exists ' . $key . '\\' . $subkey . '\\' . $entry);
 
        // Use Win32Native COM implementation
        $result = Win32Native::registryExists($key, $subkey, $entry);
 
        $this->writeLog('-> result: ' . ($result ? '1' : '0'));
 
        return $result;
    }

    public function getValue($key, $subkey, $entry = null)
    {
        global $bearsamppLang;
 
        $this->latestError = null;
 
        $this->writeLog('GetValue ' . $key . '\\' . $subkey . '\\' . $entry);
 
        // Use Win32Native COM implementation
        $result = Win32Native::registryGetValue($key, $subkey, $entry);
 
        $this->writeLog('-> result: ' . $result);
 
        if ($result === null) {
            $this->latestError = $bearsamppLang->getValue(Lang::ERROR) . ' Registry value not found';
            return false;
        }
 
        return $result;
    }

    public function setStringValue($key, $subkey, $entry, $value)
    {
        return $this->setValue($key, $subkey, $entry, $value, 'SetStringValue');
    }

    public function setExpandStringValue($key, $subkey, $entry, $value)
    {
        return $this->setValue($key, $subkey, $entry, $value, 'SetExpandedStringValue');
    }

    public function deleteValue($key, $subkey, $entry)
    {
        $this->writeLog('delete');
        return $this->setValue($key, $subkey, $entry, null, 'DeleteValue');
    }

    private function setValue($key, $subkey, $entry, $value, $type)
    {
        global $bearsamppLang;
 
        $this->latestError = null;
 
        $this->writeLog('SetValue ' . $key . '\\' . $subkey . '\\' . $entry);
        $this->writeLog('-> value: ' . $value);
        $this->writeLog('-> type: ' . $type);
 
        // Map the VBS type to Win32Native registry type
        $regType = self::REG_SZ; // Default
        if ($type == 'SetExpandedStringValue') {
            $regType = self::REG_EXPAND_SZ;
        } elseif ($type == 'SetStringValue') {
            $regType = self::REG_SZ;
        }
 
        // Handle delete operations
        if ($type == 'DeleteValue' && !empty($entry)) {
            // Delete a value
            $result = Win32Native::registryDeleteValue($key, $subkey, $entry);
        } elseif ($type == 'DeleteValue' && empty($entry)) {
            // Delete a key
            $result = Win32Native::registryDeleteKey($key, $subkey);
        } else {
            // Set a value
            $result = Win32Native::registrySetValue($key, $subkey, $entry, $value, $regType);
        }
 
        if ($subkey == self::ENV_KEY) {
            Batch::refreshEnvVars();
        }
 
        $this->writeLog('-> result: ' . ($result ? 'success' : 'failed'));
 
        if (!$result) {
            $this->latestError = $bearsamppLang->getValue(Lang::ERROR) . ' Registry operation failed';
            return false;
        }
 
        // Verify the value was set correctly (for set operations)
        if ($type != 'DeleteValue' && !empty($value)) {
            $verifyValue = Win32Native::registryGetValue($key, $subkey, $entry);
            if ($verifyValue != $value) {
                $this->latestError = sprintf($bearsamppLang->getValue(Lang::REGISTRY_SET_ERROR_TEXT), $value);
                return false;
            }
        }
 
        return true;
    }

    public function getAppBinsRegKey($fromRegistry = true)
    {
        if ($fromRegistry) {
            $value = $this->getValue(
                self::HKEY_LOCAL_MACHINE,
                self::ENV_KEY,
                self::APP_BINS_REG_ENTRY
            );
            Log::debug('App reg key from registry: ' . $value);
        } else {
            global $bearsamppBins, $bearsamppTools;
            $value = '';
            if ($bearsamppBins->getApache()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppBins->getApache()) . '/bin;';
            }
            if ($bearsamppBins->getPhp()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppBins->getPhp()) . ';';
                $value .= Path::getModuleSymlinkPath($bearsamppBins->getPhp()) . '/pear;';
                $value .= Path::getModuleSymlinkPath($bearsamppBins->getPhp()) . '/deps;';
                $value .= Path::getModuleSymlinkPath($bearsamppBins->getPhp()) . '/imagick;';
            }
            if ($bearsamppBins->getNodejs()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppBins->getNodejs()) . ';';
            }
            if ($bearsamppTools->getComposer()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getComposer()) . ';';
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getComposer()) . '/vendor/bin;';
            }
            if ($bearsamppTools->getGhostscript()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getGhostscript()) . '/bin;';
            }
            if ($bearsamppTools->getGit()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getGit()) . '/bin;';
            }
            if ($bearsamppTools->getNgrok()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getNgrok()) . ';';
            }
            if ($bearsamppTools->getPerl()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getPerl()) . '/perl/site/bin;';
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getPerl()) . '/perl/bin;';
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getPerl()) . '/c/bin;';
            }
            if ($bearsamppTools->getPython()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getPython()) . '/bin;';
            }
            if ($bearsamppTools->getRuby()->isEnable()) {
                $value .= Path::getModuleSymlinkPath($bearsamppTools->getRuby()) . '/bin;';
            }
            $value = Path::formatWindowsPath($value);
            Log::debug('Generated app bins reg key: ' . $value);
        }
 
        return $value;
    }

    public function setAppBinsRegKey($value)
    {
        return $this->setStringValue(
            self::HKEY_LOCAL_MACHINE,
            self::ENV_KEY,
            self::APP_BINS_REG_ENTRY,
            $value
        );
    }

    public function getAppPathRegKey()
    {
        return $this->getValue(
            self::HKEY_LOCAL_MACHINE,
            self::ENV_KEY,
            self::APP_PATH_REG_ENTRY
        );
    }

    public function setAppPathRegKey($value)
    {
        return $this->setStringValue(
            self::HKEY_LOCAL_MACHINE,
            self::ENV_KEY,
            self::APP_PATH_REG_ENTRY,
            $value
        );
    }

    public function getSysPathRegKey()
    {
        return $this->getValue(
            self::HKEY_LOCAL_MACHINE,
            self::ENV_KEY,
            self::SYSPATH_REG_ENTRY
        );
    }

    public function setSysPathRegKey($value)
    {
        return $this->setExpandStringValue(
            self::HKEY_LOCAL_MACHINE,
            self::ENV_KEY,
            self::SYSPATH_REG_ENTRY,
            $value
        );
    }

    public function getProcessorRegKey()
    {
        return $this->getValue(
            self::HKEY_LOCAL_MACHINE,
            self::PROCESSOR_REG_SUBKEY,
            self::PROCESSOR_REG_ENTRY
        );
    }

    public function getLatestError()
    {
        return $this->latestError;
    }
}