class.path.php

Go to the documentation of this file.

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

class Path
{
    public static function getModuleRootPath($module)
    {
        return $module->rootPath;
    }

    public static function getModuleCurrentPath($module)
    {
        return $module->currentPath;
    }

    public static function getModuleSymlinkPath($module)
    {
        return $module->symlinkPath;
    }

    private static $pathFormatCache = [];

    private static $rootPath;

    private static $corePath;

    public static function init($rootPath, $corePath)
    {
        self::$rootPath = str_replace('\\', '/', rtrim($rootPath, '/\\'));
        self::$corePath = str_replace('\\', '/', rtrim($corePath, '/\\'));
    }

    private static $pathFormatCacheMaxSize = 500;

    private static $pathFormatStats = [
        'unix_hits'      => 0,
        'unix_misses'    => 0,
        'windows_hits'   => 0,
        'windows_misses' => 0,
    ];

    public static function formatWindowsPath($path)
    {
        if (empty($path)) {
            return $path;
        }
 
        $cacheKey = 'w_' . $path;
        if (isset(self::$pathFormatCache[$cacheKey])) {
            self::$pathFormatStats['windows_hits']++;
 
            return self::$pathFormatCache[$cacheKey];
        }
 
        self::$pathFormatStats['windows_misses']++;
 
        $result = str_replace('/', '\\', $path);
 
        if (count(self::$pathFormatCache) < self::$pathFormatCacheMaxSize) {
            self::$pathFormatCache[$cacheKey] = $result;
        } else {
            $removeCount                      = (int)(self::$pathFormatCacheMaxSize * 0.1);
            self::$pathFormatCache            = array_slice(self::$pathFormatCache, $removeCount, null, true);
            self::$pathFormatCache[$cacheKey] = $result;
        }
 
        return $result;
    }

    public static function formatUnixPath($path)
    {
        if (empty($path)) {
            return $path;
        }
 
        $cacheKey = 'u_' . $path;
        if (isset(self::$pathFormatCache[$cacheKey])) {
            self::$pathFormatStats['unix_hits']++;
 
            return self::$pathFormatCache[$cacheKey];
        }
 
        self::$pathFormatStats['unix_misses']++;
 
        $result = str_replace('\\', '/', $path);
 
        if (count(self::$pathFormatCache) < self::$pathFormatCacheMaxSize) {
            self::$pathFormatCache[$cacheKey] = $result;
        } else {
            $removeCount                      = (int)(self::$pathFormatCacheMaxSize * 0.1);
            self::$pathFormatCache            = array_slice(self::$pathFormatCache, $removeCount, null, true);
            self::$pathFormatCache[$cacheKey] = $result;
        }
 
        return $result;
    }

    public static function getPathFormatStats()
    {
        return self::$pathFormatStats;
    }

    public static function changePath($filesToScan, $rootPath = null)
    {
        global $bearsamppRoot, $bearsamppCore;
 
        $result = array(
            'countChangedOcc'   => 0,
            'countChangedFiles' => 0
        );
 
        $rootPath           = $rootPath != null ? $rootPath : Path::getRootPath();
        $unixOldPath        = Path::formatUnixPath($bearsamppCore->getLastPathContent());
        $windowsOldPath     = Path::formatWindowsPath($bearsamppCore->getLastPathContent());
        $unixCurrentPath    = Path::formatUnixPath($rootPath);
        $windowsCurrentPath = Path::formatWindowsPath($rootPath);
 
        foreach ($filesToScan as $fileToScan) {
            $tmpCountChangedOcc = 0;
            $fileContentOr      = file_get_contents($fileToScan);
 
            if ($fileContentOr === false) {
                Log::error("changePath(): Failed to read file: " . $fileToScan);
                continue;
            }
 
            $fileContent = $fileContentOr;
 
            // old path
            if (stripos($fileContent, $unixOldPath) !== false) {
                $fileContent        = str_ireplace($unixOldPath, $unixCurrentPath, $fileContent, $countChanged);
                $tmpCountChangedOcc += $countChanged;
            }
            if (stripos($fileContent, $windowsOldPath) !== false) {
                $fileContent        = str_ireplace($windowsOldPath, $windowsCurrentPath, $fileContent, $countChanged);
                $tmpCountChangedOcc += $countChanged;
            }
 
            // placeholders
            if (strpos($fileContent, Core::PATH_LIN_PLACEHOLDER) !== false) {
                $fileContent        = str_replace(Core::PATH_LIN_PLACEHOLDER, $unixCurrentPath, $fileContent, $countChanged);
                $tmpCountChangedOcc += $countChanged;
            }
            if (strpos($fileContent, Core::PATH_WIN_PLACEHOLDER) !== false) {
                $fileContent        = str_replace(Core::PATH_WIN_PLACEHOLDER, $windowsCurrentPath, $fileContent, $countChanged);
                $tmpCountChangedOcc += $countChanged;
            }
 
            if ($fileContentOr != $fileContent) {
                if (file_put_contents($fileToScan, $fileContent) !== false) {
                    $result['countChangedOcc']   += $tmpCountChangedOcc;
                    $result['countChangedFiles'] += 1;
                } else {
                    Log::error("changePath(): Failed to write to file: " . $fileToScan);
                }
            }
        }
 
        Log::debug('changePath() completed: ' . $result['countChangedFiles'] . ' files changed, ' . $result['countChangedOcc'] . ' total occurrences');
 
        return $result;
    }

    public static function clearPathFormatCache()
    {
        self::$pathFormatCache = [];
        self::$pathFormatStats = [
            'unix_hits'      => 0,
            'unix_misses'    => 0,
            'windows_hits'   => 0,
            'windows_misses' => 0,
        ];
    }

    public static function getPathFormatCacheSize()
    {
        return count(self::$pathFormatCache);
    }

    public static function aetrayPath($path)
    {
        $rootPath = self::getRootPath();
        $path     = str_replace($rootPath, '', $path);
        $path     = ltrim(self::formatUnixPath($path), '/');
 
        return '%AeTrayMenuPath%' . $path;
    }

    public static function getRootPath($aetrayPath = false)
    {
        return $aetrayPath ? self::aetrayPath(self::$rootPath) : self::$rootPath;
    }

    public static function getAjaxPath($aetrayPath = false)
    {
        return self::getHomepagePath($aetrayPath) . '/ajax';
    }

    public static function getAliasPath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/alias';
    }

    public static function getAppsPath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/apps';
    }

    public static function getBatchLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp-batch.log';
    }

    public static function getBinPath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/bin';
    }

    public static function getConfigFilePath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/bearsampp.conf';
    }

    public static function getCorePath($aetrayPath = false)
    {
        return $aetrayPath ? self::aetrayPath(self::$corePath) : self::$corePath;
    }

    public static function getProcessName()
    {
        return 'bearsampp';
    }

    public static function getLocalUrl($request = null)
    {
        global $bearsamppBins;
        $isHttps = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off');
        $scheme  = $isHttps ? 'https://' : 'http://';
        $host    = (isset($_SERVER['SERVER_NAME'])) ? $_SERVER['SERVER_NAME'] : 'localhost';
 
        $port = 80;
        if (isset($bearsamppBins) && $bearsamppBins->getApache() !== null) {
            $port = $isHttps ? $bearsamppBins->getApache()->getSslPort() : $bearsamppBins->getApache()->getPort();
        }
 
        $portSuffix = '';
        if ($isHttps) {
            if ($port != 443) {
                $portSuffix = ':' . $port;
            }
        } else {
            if ($port != 80) {
                $portSuffix = ':' . $port;
            }
        }
 
        return $scheme . $host . $portSuffix . (!empty($request) ? '/' . $request : '');
    }

    public static function getErrorLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp-error.log';
    }

    public static function getExeFilePath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/bearsampp.exe';
    }

    public static function getHomepageFilePath($aetrayPath = false)
    {
        return self::getWwwPath($aetrayPath) . '/index.php';
    }

    public static function getHomepageLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp-homepage.log';
    }

    public static function getHomepagePath($aetrayPath = false)
    {
        return self::getResourcesPath($aetrayPath) . '/homepage';
    }

    public static function getHostsEditorPath($aetrayPath = false)
    {
        return self::getLibsPath($aetrayPath) . '/hostseditor';
    }

    public static function getHostsEditorExe($aetrayPath = false)
    {
        return self::getHostsEditorPath($aetrayPath) . '/' . Core::HOSTSEDITOR_EXE;
    }

    public static function getIconsPath($aetrayPath = false)
    {
        return self::getImagesPath($aetrayPath) . '/icons';
    }

    public static function getImagesPath($aetrayPath = false)
    {
        return self::getHomepagePath($aetrayPath) . '/img';
    }

    public static function getIniFilePath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/bearsampp.ini';
    }

    public static function getisRootFilePath($aetrayPath = false)
    {
        return self::getCorePath($aetrayPath) . '/' . Core::isRoot_FILE;
    }

    public static function getLangsPath($aetrayPath = false)
    {
        return self::getCorePath($aetrayPath) . '/langs';
    }

    public static function getLastPath($aetrayPath = false)
    {
        return self::getResourcesPath($aetrayPath) . '/' . Core::LAST_PATH;
    }

    public static function getLibsPath($aetrayPath = false)
    {
        return self::getCorePath($aetrayPath) . '/libs';
    }

    public static function getLnPath($aetrayPath = false)
    {
        return self::getLibsPath($aetrayPath) . '/ln';
    }

    public static function getLnExe($aetrayPath = false)
    {
        return self::getLnPath($aetrayPath) . '/' . Core::LN_EXE;
    }

    public static function getLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp.log';
    }

    public static function getLogsPath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/logs';
    }

    public static function getNssmPath($aetrayPath = false)
    {
        return self::getLibsPath($aetrayPath) . '/nssm';
    }

    public static function getNssmExe($aetrayPath = false)
    {
        return self::getNssmPath($aetrayPath) . '/' . Core::NSSM_EXE;
    }

    public static function getNssmEnvPaths()
    {
        global $bearsamppBins, $bearsamppTools;
 
        $paths = '';
 
        // Add paths for enabled bins
        if (isset($bearsamppBins)) {
            if ($bearsamppBins->getApache() && $bearsamppBins->getApache()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getApache()) . '/bin;';
            }
            if ($bearsamppBins->getPhp() && $bearsamppBins->getPhp()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getPhp()) . ';';
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getPhp()) . '/pear;';
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getPhp()) . '/deps;';
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getPhp()) . '/imagick;';
            }
            if ($bearsamppBins->getNodejs() && $bearsamppBins->getNodejs()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getNodejs()) . ';';
            }
            if ($bearsamppBins->getMysql() && $bearsamppBins->getMysql()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getMysql()) . '/bin;';
            }
            if ($bearsamppBins->getMariadb() && $bearsamppBins->getMariadb()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getMariadb()) . '/bin;';
            }
            if ($bearsamppBins->getPostgresql() && $bearsamppBins->getPostgresql()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppBins->getPostgresql()) . '/bin;';
            }
        }
 
        // Add paths for enabled tools
        if (isset($bearsamppTools)) {
            if ($bearsamppTools->getComposer() && $bearsamppTools->getComposer()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getComposer()) . ';';
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getComposer()) . '/vendor/bin;';
            }
            if ($bearsamppTools->getGhostscript() && $bearsamppTools->getGhostscript()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getGhostscript()) . '/bin;';
            }
            if ($bearsamppTools->getGit() && $bearsamppTools->getGit()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getGit()) . '/bin;';
            }
            if ($bearsamppTools->getNgrok() && $bearsamppTools->getNgrok()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getNgrok()) . ';';
            }
            if ($bearsamppTools->getPerl() && $bearsamppTools->getPerl()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getPerl()) . '/perl/site/bin;';
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getPerl()) . '/perl/bin;';
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getPerl()) . '/c/bin;';
            }
            if ($bearsamppTools->getPython() && $bearsamppTools->getPython()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getPython()) . '/bin;';
            }
            if ($bearsamppTools->getRuby() && $bearsamppTools->getRuby()->isEnable()) {
                $paths .= self::getModuleSymlinkPath($bearsamppTools->getRuby()) . '/bin;';
            }
        }
 
        return self::formatWindowsPath($paths);
    }

    public static function getNssmLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp-nssm.log';
    }

    public static function getOpenSslConf($aetrayPath = false)
    {
        return self::getOpenSslPath($aetrayPath) . '/' . Core::OPENSSL_CONF;
    }

    public static function getOpenSslExe($aetrayPath = false)
    {
        return self::getOpenSslPath($aetrayPath) . '/' . Core::OPENSSL_EXE;
    }

    public static function getOpenSslPath($aetrayPath = false)
    {
        return self::getLibsPath($aetrayPath) . '/openssl';
    }

    public static function getPhpPath($aetrayPath = false)
    {
        return self::getLibsPath($aetrayPath) . '/php';
    }
 

    public static function getPearPath($aetrayPath = false)
    {
        return self::getPhpPath($aetrayPath) . '/pear';
    }

    public static function getPhpExe($aetrayPath = false)
    {
        return self::getPhpPath($aetrayPath) . '/' . Core::PHP_EXE;
    }

    public static function getPowerShellPath()
    {
        if (is_dir('C:\Windows\System32\WindowsPowerShell')) {
            return Util::findFile('C:\Windows\System32\WindowsPowerShell', 'powershell.exe');
        }
 
        return false;
    }

    public static function findExecutable($name)
    {
        $name = trim($name);
        if ($name == '') {
            return false;
        }
 
        if (is_file($name)) {
            return self::formatWindowsPath($name);
        }
 
        $baseName      = basename($name);
        $hasExtension  = pathinfo($baseName, PATHINFO_EXTENSION) != '';
        $pathExtensions = explode(';', getenv('PATHEXT') !== false ? getenv('PATHEXT') : '.COM;.EXE;.BAT;.CMD');
        $extensions    = $hasExtension ? array('') : $pathExtensions;
 
        // WinBinder file registry
        global $bearsamppWinbinder;
        if (isset($bearsamppWinbinder)) {
            $found = $bearsamppWinbinder->findFile($baseName);
            if ($found !== false && is_file($found)) {
                return self::formatWindowsPath($found);
            }
        }
 
        // App Paths registry (HKCU first, then HKLM)
        foreach (array(Registry::HKEY_CURRENT_USER, Registry::HKEY_LOCAL_MACHINE) as $hive) {
            $appPath = Win32Native::registryGetValue($hive, 'SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\\' . $baseName);
            if (is_string($appPath) && trim($appPath) != '') {
                // App Paths values may include command line arguments after the executable
                $cleanPath = trim(str_replace('"', '', $appPath));
                $appPath   = preg_match('/^.*\.exe\b/i', $cleanPath, $match) ? $match[0] : strtok($cleanPath, " \t");
                if (is_file($appPath)) {
                    return self::formatWindowsPath($appPath);
                }
            }
        }
 
        // Directories listed in the PATH environment variable
        $envPath = getenv('PATH');
        if ($envPath !== false) {
            foreach (explode(';', $envPath) as $dir) {
                $dir = trim($dir);
                if ($dir == '') {
                    continue;
                }
                foreach ($extensions as $extension) {
                    $candidate = $dir . '\\' . $baseName . $extension;
                    if (is_file($candidate)) {
                        return self::formatWindowsPath($candidate);
                    }
                }
            }
        }
 
        // Windows, System32 and SysWOW64 directories
        $systemRoot = getenv('SystemRoot');
        if ($systemRoot !== false) {
            foreach (array('\\System32\\', '\\SysWOW64\\', '\\') as $subDir) {
                foreach ($extensions as $extension) {
                    $candidate = $systemRoot . $subDir . $baseName . $extension;
                    if (is_file($candidate)) {
                        return self::formatWindowsPath($candidate);
                    }
                }
            }
        }
 
        return false;
    }

    public static function getPwgenPath($aetrayPath = false)
    {
        return self::getLibsPath($aetrayPath) . '/pwgen';
    }

    public static function getPwgenExe($aetrayPath = false)
    {
        return self::getPwgenPath($aetrayPath) . '/' . Core::PWGEN_EXE;
    }

    public static function getRegistryLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp-registry.log';
    }

    public static function getStartupLnkPath()
    {
        $startupPath = Win32Native::getSpecialFolderPath('Startup');
 
        return $startupPath ? $startupPath . '/' . APP_TITLE . '.lnk' : false;
    }

    public static function getResourcesPath($aetrayPath = false)
    {
        return self::getCorePath($aetrayPath) . '/resources';
    }

    public static function getScript($type)
    {
        return self::getScriptsPath() . '/' . $type;
    }

    public static function getScriptsPath($aetrayPath = false)
    {
        return self::getCorePath($aetrayPath) . '/scripts';
    }

    public static function getServicesLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp-services.log';
    }

    public static function getSetEnvPath($aetrayPath = false)
    {
        return self::getLibsPath($aetrayPath) . '/setenv';
    }

    public static function getSetEnvExe($aetrayPath = false)
    {
        return self::getSetEnvPath($aetrayPath) . '/' . Core::SETENV_EXE;
    }

    public static function getSslConfPath($aetrayPath = false)
    {
        return self::getSslPath($aetrayPath) . '/openssl.cnf';
    }

    public static function getSslPath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/ssl';
    }

    public static function getStartupLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp-startup.log';
    }

    public static function getTmpPath($aetrayPath = false)
    {
        return self::getCorePath($aetrayPath) . '/tmp';
    }

    public static function getToolsPath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/tools';
    }

    public static function getMkcertPath($aetrayPath = false)
    {
        return self::getLibsPath($aetrayPath) . '/mkcert';
    }

    public static function getMkcertExe($aetrayPath = false)
    {
        return self::getMkcertPath($aetrayPath) . '/mkcert.exe';
    }

    public static function getMkcertRootCaName()
    {
        return 'rootCA.pem';
    }

    public static function getVhostsPath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/vhosts';
    }

    public static function getWebIconsPath()
    {
        return self::getWebImagesPath() . '/icons';
    }

    public static function getWebImagesPath()
    {
        return self::getWebResourcesPath() . '/img';
    }

    public static function getWebResourcesPath()
    {
        return rtrim(md5(APP_TITLE), '/');
    }

    public static function getWebResourcesUrl()
    {
        global $bearsamppBins;
        $request = self::getWebResourcesPath();
        $isHttps = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] !== 'off');
        $scheme  = $isHttps ? 'https://' : 'http://';
        $host    = (isset($_SERVER['SERVER_NAME'])) ? $_SERVER['SERVER_NAME'] : 'localhost';
 
        $port = 80;
        if (isset($bearsamppBins) && $bearsamppBins->getApache() !== null) {
            $port = $isHttps ? $bearsamppBins->getApache()->getSslPort() : $bearsamppBins->getApache()->getPort();
        }
 
        $portSuffix = '';
        if ($isHttps) {
            if ($port != 443) {
                $portSuffix = ':' . $port;
            }
        } else {
            if ($port != 80) {
                $portSuffix = ':' . $port;
            }
        }
 
        return $scheme . $host . $portSuffix . (!empty($request) ? '/' . $request : '');
    }

    public static function getWinbinderLogFilePath($aetrayPath = false)
    {
        return self::getLogsPath($aetrayPath) . '/bearsampp-winbinder.log';
    }

    public static function getWwwPath($aetrayPath = false)
    {
        return self::getRootPath($aetrayPath) . '/www';
    }
}