Static Public Member Functions
static	changePath ($filesToScan, $rootPath=null)
static	clearFileScanCache ()
static	clearFolder ($path, $exclude=array())
static	clearFolders ($paths, $exclude=array())
static	clearLoadingText ()
static	convertEncoding ($data, $direction='to_cp1252')
static	cp1252ToUtf8 ($data)
static	deleteFolder ($path)
static	disableLaunchStartup ()
static	enableLaunchStartup ()
static	findRepos ($initPath, $startPath, $checkFile, $maxDepth=1)
static	getApiJson ($url)
static	getAppBinsRegKey ($fromRegistry=true)
static	getAppPathRegKey ()
static	getChangelogUrl ($utmSource=true)
static	getFileScanCacheDuration ()
static	getFileScanStats ()
static	getFilesToScan ($path=null, $useCache=true, $forceRefresh=false)
static	getFolderList ($path)
static	getGithubUrl ($type='user', $user=APP_GITHUB_USER, $repo=null, $branch=null, $path=null)
static	getGithubUserUrl ()
static	getHeaders ($host, $port, $ssl=false)
static	getLatestVersion ($url)
static	getMicrotime ()
static	getPowerShellPath ()
static	getProcessorRegKey ()
static	getRemoteFilesize ($url, $humanFileSize=true)
static	getStartupLnkPath ()
static	getSysPathRegKey ()
static	getVersionList ($path)
static	getWebsiteUrl ($path='', $fragment='', $utmSource=true)
static	getWebsiteUrlNoUtm ($path='', $fragment='')
static	humanFileSize ($size, $unit='')
static	imgToBase64 ($path)
static	installService ($bin, $port, $syntaxCheckCmd, $showWindow=false)
static	is32BitsOs ()
static	isAdmin ()
static	isLaunchStartup ()
static	isPortInUse ($port)
static	isValidDomainName ($domainName)
static	isValidIp ($ip)
static	isValidPort ($port)
static	openFileContent ($caption, $content)
static	removeService ($service, $name)
static	replaceDefine ($path, $var, $value)
static	replaceInFile ($path, $replaceList)
static	setAppBinsRegKey ($value)
static	setAppPathRegKey ($value)
static	setFileScanCacheDuration ($seconds)
static	setSysPathRegKey ($value)
static	startLoading ()
static	startService ($bin, $syntaxCheckCmd, $showWindow=false)
static	stopLoading ()
static	updateLoadingText ($text)
static	utf8ToCp1252 ($data)

Static Private Member Functions
static	findFile ($startPath, $findFile)
static	findFiles ($startPath, $includes=array(''), $recursive=true)
static	generateCacheHMAC ($data, $cacheKey)
static	getCacheIntegrityKey ()
static	getFileScanCache ($cacheKey)
static	getPathsToScan ()
static	setFileScanCache ($cacheKey, $data)
static	verifyCacheIntegrity ($fileContents, $cacheKey)

Static Private Attributes
static	$cacheIntegrityKey = null
static	$fileScanCache = null
static	$fileScanCacheDuration = 3600
static	$fileScanStats

Detailed Description

Utility class providing a wide range of static methods for various purposes including:

Input cleaning and sanitization have been moved to UtilInput.
See also
UtilInput
String manipulation methods have been moved to UtilString.
See also
UtilString
File and directory management functions for deleting, clearing, or finding files and directories.
System utilities for handling registry operations, managing environment variables, and executing system commands.
Network utilities to validate IPs, domains, and manage HTTP requests.
Helper functions for encoding, decoding, and file operations.

Path formatting (formatWindowsPath / formatUnixPath) has been moved to UtilPath.

See also: UtilPath Logging is handled by the Log class.; Log

This class is designed to be used as a helper or utility class where methods are accessed statically. This means you do not need to instantiate it to use the methods, but can simply call them using the Util::methodName() syntax.

Usage Example:

$cleanedData = UtilInput::cleanGetVar('data', 'text');

$isAvailable = Util::isValidIp('192.168.1.1');

Util\isValidIp

static isValidIp($ip)

Definition class.util.php:198

UtilInput\cleanGetVar

static cleanGetVar($name, $type='text')

Definition class.util.input.php:59

Each method is self-contained and provides specific functionality, making this class a central point for common utility operations needed across a PHP application, especially in environments like web servers or command-line interfaces.

Definition at line 35 of file class.util.php.

Member Function Documentation

◆ changePath()

changePath	(		$filesToScan,
			$rootPath = null )

static

Replaces old path references with new path references in the specified files.

Parameters

array	$filesToScan	Array of file paths to scan and modify.
string \| null	$rootPath	The new root path to replace the old one. If null, uses a default root path.

Returns: array Returns an array with the count of occurrences changed and the count of files changed.

Definition at line 1329 of file class.util.php.

    {
        global $bearsamppRoot, $bearsamppCore;
 
        $result = array(
            'countChangedOcc'   => 0,
            'countChangedFiles' => 0
        );
 
        $rootPath           = $rootPath != null ? $rootPath : $bearsamppRoot->getRootPath();
        $unixOldPath        = UtilPath::formatUnixPath($bearsamppCore->getLastPathContent());
        $windowsOldPath     = UtilPath::formatWindowsPath($bearsamppCore->getLastPathContent());
        $unixCurrentPath    = UtilPath::formatUnixPath($rootPath);
        $windowsCurrentPath = UtilPath::formatWindowsPath($rootPath);
 
        foreach ($filesToScan as $fileToScan) {
            $tmpCountChangedOcc = 0;
            $fileContentOr      = file_get_contents($fileToScan);
            $fileContent        = $fileContentOr;
 
            // old path
            preg_match('#' . $unixOldPath . '#i', $fileContent, $unixMatches);
            if (!empty($unixMatches)) {
                $fileContent        = str_replace($unixOldPath, $unixCurrentPath, $fileContent, $countChanged);
                $tmpCountChangedOcc += $countChanged;
            }
            preg_match('#' . str_replace('\\', '\\\\', $windowsOldPath) . '#i', $fileContent, $windowsMatches);
            if (!empty($windowsMatches)) {
                $fileContent        = str_replace($windowsOldPath, $windowsCurrentPath, $fileContent, $countChanged);
                $tmpCountChangedOcc += $countChanged;
            }
 
            // placeholders
            preg_match('#' . Core::PATH_LIN_PLACEHOLDER . '#i', $fileContent, $unixMatches);
            if (!empty($unixMatches)) {
                $fileContent        = str_replace(Core::PATH_LIN_PLACEHOLDER, $unixCurrentPath, $fileContent, $countChanged);
                $tmpCountChangedOcc += $countChanged;
            }
            preg_match('#' . Core::PATH_WIN_PLACEHOLDER . '#i', $fileContent, $windowsMatches);
            if (!empty($windowsMatches)) {
                $fileContent        = str_replace(Core::PATH_WIN_PLACEHOLDER, $windowsCurrentPath, $fileContent, $countChanged);
                $tmpCountChangedOcc += $countChanged;
            }
 
            if ($fileContentOr != $fileContent) {
                $result['countChangedOcc'] += $tmpCountChangedOcc;
                $result['countChangedFiles'] += 1;
                file_put_contents($fileToScan, $fileContent);
            }
        }
 
        Log::debug('changePath() completed: ' . $result['countChangedFiles'] . ' files changed, ' . $result['countChangedOcc'] . ' total occurrences');
 
        return $result;
    }

References $bearsamppCore, $bearsamppRoot, $result, Log\debug(), UtilPath\formatUnixPath(), UtilPath\formatWindowsPath(), Core\PATH_LIN_PLACEHOLDER, and Core\PATH_WIN_PLACEHOLDER.

Referenced by ActionStartup\changePath(), BinPostgresql\initData(), and ActionSwitchVersion\processWindow().

◆ clearFileScanCache()

clearFileScanCache ( )

static

Clears all file scan caches.

Returns: void

Definition at line 1031 of file class.util.php.

    {
        global $bearsamppRoot;
 
        // Clear memory cache
        self::$fileScanCache = null;
 
        // Clear file caches
        if (isset($bearsamppRoot)) {
            $tmpPath = $bearsamppRoot->getTmpPath();
            $cacheFiles = glob($tmpPath . '/filescan_cache_*.dat');
 
            if ($cacheFiles !== false) {
                foreach ($cacheFiles as $cacheFile) {
                    @unlink($cacheFile);
                }
                Log::info('Cleared ' . count($cacheFiles) . ' file scan cache files');
            }
        }
 
        // Reset stats
        self::$fileScanStats = [
            'hits' => 0,
            'misses' => 0,
            'invalidations' => 0
        ];
    }

References $bearsamppRoot, and Log\info().

◆ clearFolder()

clearFolder	(		$path,
			$exclude = array() )

static

Recursively clears all files and directories within a specified directory, excluding specified items.

Parameters

string	$path	The path of the directory to clear.
array	$exclude	An array of filenames to exclude from deletion.

Returns: array|null Returns an array with the operation status and count of files deleted, or null if the directory cannot be opened.

Definition at line 92 of file class.util.php.

    {
        $result             = array();
        $result['return']   = true;
        $result['nb_files'] = 0;
 
        $handle = @opendir($path);
        if (!$handle) {
            return null;
        }
 
        while (false !== ($file = readdir($handle))) {
            if ($file == '.' || $file == '..' || in_array($file, $exclude)) {
                continue;
            }
            if (is_dir($path . '/' . $file)) {
                $r = self::clearFolder($path . '/' . $file);
                if (!$r) {
                    $result['return'] = false;
 
                    return $result;
                }
            } else {
                $r = @unlink($path . '/' . $file);
                if ($r) {
                    $result['nb_files']++;
                } else {
                    $result['return'] = false;
 
                    return $result;
                }
            }
        }
 
        closedir($handle);
 
        return $result;
    }

References $result, and clearFolder().

Referenced by ActionClearFolders\__construct(), ActionStartup\cleanTmpFolders(), clearFolder(), and clearFolders().

◆ clearFolders()

clearFolders	(		$paths,
			$exclude = array() )

static

Recursively deletes files from a specified directory while excluding certain files.

Parameters

string	$path	The path to the directory to clear.
array	$exclude	An array of filenames to exclude from deletion.

Returns: array Returns an array with the status of the operation and the number of files deleted.

Definition at line 74 of file class.util.php.

    {
        $result = array();
        foreach ($paths as $path) {
            $result[$path] = self::clearFolder($path, $exclude);
        }
 
        return $result;
    }

References $result, and clearFolder().

◆ clearLoadingText()

clearLoadingText ( )

static

Clears the loading status file

Definition at line 773 of file class.util.php.

    {
        global $bearsamppCore;
 
        $statusFile = $bearsamppCore->getTmpPath() . '/loading_status.txt';
        if (file_exists($statusFile)) {
            @unlink($statusFile);
        }
    }

References $bearsamppCore.

Referenced by stopLoading().

◆ convertEncoding()

convertEncoding	(		$data,
			$direction = 'to_cp1252' )

static

Converts data between UTF-8 and Windows-1252 encodings.

Parameters

string	$data	The data to convert.
string	$direction	The conversion direction: 'to_cp1252' or 'to_utf8'. Defaults to 'to_cp1252'.

Returns: string The converted data.

Definition at line 684 of file class.util.php.

    {
        if ($direction === 'to_utf8') {
            return self::cp1252ToUtf8($data);
        } else {
            return self::utf8ToCp1252($data);
        }
    }

References cp1252ToUtf8(), and utf8ToCp1252().

◆ cp1252ToUtf8()

cp1252ToUtf8 ( $data )

static

Converts Windows-1252 encoded data to UTF-8 encoding.

Parameters

string $data The Windows-1252 encoded data.

Returns: string Returns the data encoded in UTF-8.

Definition at line 712 of file class.util.php.

    {
        return iconv('WINDOWS-1252', 'UTF-8//IGNORE', $data);
    }

Referenced by convertEncoding().

◆ deleteFolder()

deleteFolder ( $path )

static

Recursively deletes a directory and all its contents.

Parameters

string $path The path of the directory to delete.

Definition at line 136 of file class.util.php.

    {
        if (is_dir($path)) {
            if (substr($path, strlen($path) - 1, 1) != '/') {
                $path .= '/';
            }
            $files = glob($path . '*', GLOB_MARK);
            foreach ($files as $file) {
                if (is_dir($file)) {
                    self::deleteFolder($file);
                } else {
                    unlink($file);
                }
            }
            rmdir($path);
        }
    }

References deleteFolder().

Referenced by deleteFolder(), and ActionStartup\rotationLogs().

◆ disableLaunchStartup()

disableLaunchStartup ( )

static

Disables launching the application at startup by removing the shortcut from the startup folder.

Returns: bool True on success, false on failure.

Definition at line 595 of file class.util.php.

    {
        $startupLnkPath = self::getStartupLnkPath();
 
        // Check if file exists before attempting to delete
        if (file_exists($startupLnkPath)) {
            return @unlink($startupLnkPath);
        }
 
        // Return true if the file doesn't exist (already disabled)
        return true;
    }

References getStartupLnkPath().

Referenced by ActionLaunchStartup\__construct(), and ActionStartup\checkLaunchStartup().

◆ enableLaunchStartup()

enableLaunchStartup ( )

static

Enables launching the application at startup by creating a shortcut in the startup folder.

Returns: bool True on success, false on failure.

Definition at line 573 of file class.util.php.

    {
        global $bearsamppRoot, $bearsamppCore;
 
        $shortcutPath = self::getStartupLnkPath();
        if (!$shortcutPath) {
            return false;
        }
 
        $targetPath = $bearsamppRoot->getExeFilePath();
        $workingDir = $bearsamppRoot->getRootPath();
        $description = APP_TITLE . ' ' . $bearsamppCore->getAppVersion();
        $iconPath = $bearsamppCore->getIconsPath() . '/app.ico';
 
        return Win32Native::createShortcut($shortcutPath, $targetPath, $workingDir, $description, $iconPath);
    }

References $bearsamppCore, $bearsamppRoot, APP_TITLE, Win32Native\createShortcut(), and getStartupLnkPath().

Referenced by ActionLaunchStartup\__construct(), and ActionStartup\checkLaunchStartup().

◆ findFile()

findFile	(		$startPath,
			$findFile )

staticprivate

Recursively searches for a file starting from a specified directory.

Parameters

string	$startPath	The directory path to start the search.
string	$findFile	The filename to search for.

Returns: string|false Returns the path to the file if found, or false if not found.

Definition at line 162 of file class.util.php.

    {
        $result = false;
 
        $handle = @opendir($startPath);
        if (!$handle) {
            return false;
        }
 
        while (false !== ($file = readdir($handle))) {
            if ($file == '.' || $file == '..') {
                continue;
            }
            if (is_dir($startPath . '/' . $file)) {
                $result = self::findFile($startPath . '/' . $file, $findFile);
                if ($result !== false) {
                    break;
                }
            } elseif ($file == $findFile) {
                $result = UtilPath::formatUnixPath($startPath . '/' . $file);
                break;
            }
        }
 
        closedir($handle);
 
        return $result;
    }

References $result, findFile(), and UtilPath\formatUnixPath().

Referenced by findFile(), and getPowerShellPath().

◆ findFiles()

findFiles	(	$startPath,
		$includes = array(''),
		$recursive = true )

staticprivate

Recursively finds files in a directory that match a set of inclusion patterns.

Parameters

string	$startPath	The directory path to start the search from.
array	$includes	An array of file patterns to include in the search. Patterns starting with '!' are excluded.
bool	$recursive	Determines whether the search should be recursive.

Returns: array An array of files that match the inclusion patterns.

Definition at line 1282 of file class.util.php.

    {
        $result = array();
 
        $handle = @opendir($startPath);
        if (!$handle) {
            return $result;
        }
 
        while (false !== ($file = readdir($handle))) {
            if ($file == '.' || $file == '..') {
                continue;
            }
            if (is_dir($startPath . '/' . $file) && $recursive) {
                $tmpResults = self::findFiles($startPath . '/' . $file, $includes);
                foreach ($tmpResults as $tmpResult) {
                    $result[] = $tmpResult;
                }
            } elseif (is_file($startPath . '/' . $file)) {
                foreach ($includes as $include) {
                    if (UtilString::startWith($include, '!')) {
                        $include = ltrim($include, '!');
                        if (UtilString::startWith($file, '.') && !UtilString::endWith($file, $include)) {
                            $result[] = UtilPath::formatUnixPath($startPath . '/' . $file);
                        } elseif ($file != $include) {
                            $result[] = UtilPath::formatUnixPath($startPath . '/' . $file);
                        }
                    } elseif (UtilString::endWith($file, $include) || $file == $include || empty($include)) {
                        $result[] = UtilPath::formatUnixPath($startPath . '/' . $file);
                    }
                }
            }
        }
 
        closedir($handle);
 
        return $result;
    }

References $result, UtilString\endWith(), findFiles(), UtilPath\formatUnixPath(), and UtilString\startWith().

Referenced by findFiles(), and getFilesToScan().

◆ findRepos()

findRepos	(	$initPath,
		$startPath,
		$checkFile,
		$maxDepth = 1 )

static

Recursively searches for repositories starting from a given path up to a specified depth.

Parameters

string	$initPath	The initial path from where the search begins.
string	$startPath	The current path from where to search.
string	$checkFile	The file name to check for in the directory to consider it a repository.
int	$maxDepth	The maximum depth of directories to search into.

Returns: array Returns an array of paths that contain the specified file.

Definition at line 632 of file class.util.php.

    {
        $depth  = substr_count(str_replace($initPath, '', $startPath), '/');
        $result = array();
 
        $handle = @opendir($startPath);
        if (!$handle) {
            return $result;
        }
 
        while (false !== ($file = readdir($handle))) {
            if ($file == '.' || $file == '..') {
                continue;
            }
            if (is_dir($startPath . '/' . $file) && ($initPath == $startPath || $depth <= $maxDepth)) {
                $tmpResults = self::findRepos($initPath, $startPath . '/' . $file, $checkFile, $maxDepth);
                foreach ($tmpResults as $tmpResult) {
                    $result[] = $tmpResult;
                }
            } elseif (is_file($startPath . '/' . $checkFile) && !in_array($startPath, $result)) {
                $result[] = UtilPath::formatUnixPath($startPath);
            }
        }
 
        closedir($handle);
 
        return $result;
    }

References $result, findRepos(), and UtilPath\formatUnixPath().

Referenced by ToolGit\findRepos(), and findRepos().

◆ generateCacheHMAC()

generateCacheHMAC	(		$data,
			$cacheKey )

staticprivate

Generates HMAC for cache data integrity verification.

Parameters

array	$data	The data to generate HMAC for
string	$cacheKey	The cache key

Returns: string The HMAC hash

Definition at line 997 of file class.util.php.

    {
        $key = self::getCacheIntegrityKey();
        $message = serialize($data) . $cacheKey;
        return hash_hmac('sha256', $message, $key);
    }

References getCacheIntegrityKey().

Referenced by setFileScanCache(), and verifyCacheIntegrity().

◆ getApiJson()

getApiJson ( $url )

static

Sends a GET request to the specified URL and returns the response as a JSON string.

Parameters

string $url The URL to send the GET request to.

Returns: string|null The response data as a JSON string from the URL, or null on failure.

Definition at line 1583 of file class.util.php.

    {
        $result = HttpClient::getApiJson($url);
 
        if (isset($result['error'])) {
            return null;
        }
 
        return isset($result['data']) ? $result['data'] : null;
    }

References $result, and HttpClient\getApiJson().

Referenced by getLatestVersion().

◆ getAppBinsRegKey()

getAppBinsRegKey ( $fromRegistry = true )

static

Definition at line 384 of file class.util.php.

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

References $bearsamppBins, Registry\APP_BINS_REG_ENTRY, Log\debug(), Registry\ENV_KEY, UtilPath\formatWindowsPath(), and Registry\HKEY_LOCAL_MACHINE.

Referenced by ActionStartup\checkBinsRegKey(), Win32Service\create(), and ActionSwitchVersion\processWindow().

◆ getAppPathRegKey()

getAppPathRegKey ( )

static

Retrieves the application path from the registry.

Returns: mixed The value of the application path registry key or false on error.

Definition at line 465 of file class.util.php.

    {
        global $bearsamppRegistry;
 
        return $bearsamppRegistry->getValue(
            Registry::HKEY_LOCAL_MACHINE,
            Registry::ENV_KEY,
            Registry::APP_PATH_REG_ENTRY
        );
    }

References Registry\APP_PATH_REG_ENTRY, Registry\ENV_KEY, and Registry\HKEY_LOCAL_MACHINE.

Referenced by ActionStartup\checkPathRegKey().

◆ getCacheIntegrityKey()

getCacheIntegrityKey ( )

staticprivate

Generates or retrieves the cache integrity key. This key is unique per session to prevent cross-session cache tampering.

Returns: string The cache integrity key

Definition at line 950 of file class.util.php.

    {
        if (self::$cacheIntegrityKey === null) {
            global $bearsamppRoot;
 
            // Try to load existing key from session file
            if (isset($bearsamppRoot)) {
                $keyFile = $bearsamppRoot->getTmpPath() . '/cache_integrity.key';
 
                if (file_exists($keyFile)) {
                    $key = @file_get_contents($keyFile);
                    if ($key !== false && strlen($key) === 64) {
                        self::$cacheIntegrityKey = $key;
                        return self::$cacheIntegrityKey;
                    }
                }
 
                // Generate new key if none exists or invalid
                try {
                    self::$cacheIntegrityKey = bin2hex(random_bytes(32));
                    @file_put_contents($keyFile, self::$cacheIntegrityKey, LOCK_EX);
                } catch (Exception $e) {
                    Log::error('Failed to generate cache integrity key: ' . $e->getMessage());
                    // Fallback to a less secure but functional key
                    self::$cacheIntegrityKey = hash('sha256', uniqid('bearsampp_cache_', true));
                }
            } else {
                // Fallback if bearsamppRoot not available
                try {
                    self::$cacheIntegrityKey = bin2hex(random_bytes(32));
                } catch (Exception $e) {
                    self::$cacheIntegrityKey = hash('sha256', uniqid('bearsampp_cache_', true));
                }
            }
        }
 
        return self::$cacheIntegrityKey;
    }

References $bearsamppRoot, and Log\error().

Referenced by generateCacheHMAC().

◆ getChangelogUrl()

getChangelogUrl ( $utmSource = true )

static

Constructs the URL to the changelog page, optionally including UTM parameters.

Parameters

bool $utmSource Whether to include UTM source parameters.

Returns: string The URL to the changelog page.

Definition at line 1466 of file class.util.php.

    {
        return self::getWebsiteUrl('doc/changelog', null, $utmSource);
    }

References getWebsiteUrl().

◆ getFileScanCache()

getFileScanCache ( $cacheKey )

staticprivate

Gets cached file scan results if valid. Includes integrity verification to prevent cache tampering.

Parameters

string $cacheKey The cache key to retrieve.

Returns: array|false Returns cached results or false if cache is invalid/missing.

Definition at line 844 of file class.util.php.

    {
        global $bearsamppRoot;
 
        // Check if we have in-memory cache first
        if (self::$fileScanCache !== null && isset(self::$fileScanCache[$cacheKey])) {
            $cache = self::$fileScanCache[$cacheKey];
 
            // Check if cache is still valid
            if (time() - $cache['timestamp'] < self::$fileScanCacheDuration) {
                return $cache['data'];
            } else {
                self::$fileScanStats['invalidations']++;
                unset(self::$fileScanCache[$cacheKey]);
            }
        }
 
        // Try to load from file cache
        if (!isset($bearsamppRoot)) {
            return false;
        }
 
        $cacheFile = $bearsamppRoot->getTmpPath() . '/filescan_cache_' . $cacheKey . '.dat';
 
        if (file_exists($cacheFile)) {
            $fileContents = @file_get_contents($cacheFile);
 
            if ($fileContents === false) {
                return false;
            }
 
            // Verify file integrity before unserializing
            if (!self::verifyCacheIntegrity($fileContents, $cacheKey)) {
                Log::warning('File scan cache integrity check failed for key: ' . $cacheKey . '. Possible tampering detected.');
                @unlink($cacheFile);
                return false;
            }
 
            $cacheData = @unserialize($fileContents);
 
            if ($cacheData !== false && isset($cacheData['timestamp']) && isset($cacheData['data']) && isset($cacheData['hmac'])) {
                // Check if file cache is still valid
                if (time() - $cacheData['timestamp'] < self::$fileScanCacheDuration) {
                    // Store in memory cache for faster subsequent access
                    if (self::$fileScanCache === null) {
                        self::$fileScanCache = [];
                    }
                    self::$fileScanCache[$cacheKey] = $cacheData;
 
                    return $cacheData['data'];
                } else {
                    // Cache expired, delete file
                    self::$fileScanStats['invalidations']++;
                    @unlink($cacheFile);
                }
            } else {
                // Invalid cache structure, delete file
                Log::warning('Invalid cache structure detected for key: ' . $cacheKey);
                @unlink($cacheFile);
            }
        }
 
        return false;
    }

References $bearsamppRoot, and Log\warning().

Referenced by getFilesToScan().

◆ getFileScanCacheDuration()

getFileScanCacheDuration ( )

static

Gets the current file scan cache duration.

Returns: int Cache duration in seconds

Definition at line 1089 of file class.util.php.

    {
        return self::$fileScanCacheDuration;
    }

◆ getFileScanStats()

getFileScanStats ( )

static

Gets file scan cache statistics.

Returns: array Array containing hits, misses, and invalidations counts

Definition at line 1064 of file class.util.php.

    {
        return self::$fileScanStats;
    }

◆ getFilesToScan()

getFilesToScan	(	$path = null,
		$useCache = true,
		$forceRefresh = false )

static

Retrieves a list of files to scan from specified paths or default paths. Implements caching to avoid repeated expensive file system scans.

Parameters

string \| null	$path	Optional. The path to start scanning from. If null, uses default paths.
bool	$useCache	Whether to use cached results (default: true).
bool	$forceRefresh	Force refresh the cache even if valid (default: false).

Returns: array Returns an array of files found during the scan.

Definition at line 793 of file class.util.php.

    {
        // Generate cache key based on path parameter
        $cacheKey = md5(serialize($path));
 
        // Try to get from cache if enabled and not forcing refresh
        if ($useCache && !$forceRefresh) {
            $cachedResult = self::getFileScanCache($cacheKey);
            if ($cachedResult !== false) {
                self::$fileScanStats['hits']++;
                Log::debug('File scan cache HIT (saved expensive scan operation)');
                return $cachedResult;
            }
        }
 
        self::$fileScanStats['misses']++;
        Log::debug('File scan cache MISS (performing full scan)');
 
        // Perform the actual scan
        $startTime = self::getMicrotime();
        $result      = array();
        $pathsToScan = !empty($path) ? $path : self::getPathsToScan();
 
        foreach ($pathsToScan as $pathToScan) {
            $pathStartTime = self::getMicrotime();
            $findFiles = self::findFiles($pathToScan['path'], $pathToScan['includes'], $pathToScan['recursive']);
            foreach ($findFiles as $findFile) {
                $result[] = $findFile;
            }
            Log::debug($pathToScan['path'] . ' scanned in ' . round(self::getMicrotime() - $pathStartTime, 3) . 's');
        }
 
        $totalTime = round(self::getMicrotime() - $startTime, 3);
        Log::info('Full file scan completed in ' . $totalTime . 's (' . count($result) . ' files found)');
 
        // Store in cache if enabled
        if ($useCache) {
            self::setFileScanCache($cacheKey, $result);
        }
 
        return $result;
    }

References $result, Log\debug(), findFiles(), getFileScanCache(), getMicrotime(), getPathsToScan(), Log\info(), and setFileScanCache().

Referenced by BinPostgresql\initData(), ActionSwitchVersion\processWindow(), and ActionStartup\scanFolders().

◆ getFolderList()

getFolderList ( $path )

static

Gets the list of folders in the specified path.

Parameters

string $path The directory path to scan for folders.

Returns: array|false Returns a sorted array of folder names, or false if the directory cannot be opened.

Definition at line 1867 of file class.util.php.

    {
        $result = array();
 
        $handle = @opendir($path);
        if (!$handle) {
            return false;
        }
 
        while (false !== ($file = readdir($handle))) {
            $filePath = $path . '/' . $file;
            if ($file != '.' && $file != '..' && is_dir($filePath) && $file != 'current') {
                $result[] = $file;
            }
        }
 
        closedir($handle);
        natcasesort($result);
 
        return $result;
    }

References $result.

Referenced by ActionSwitchVersion\__construct(), and getPathsToScan().

◆ getGithubUrl()

getGithubUrl	(	$type = 'user',
		$user = APP_GITHUB_USER,
		$repo = null,
		$branch = null,
		$path = null )

static

Generates various GitHub URLs based on the specified type.

Parameters

string	$type	The type of URL ('user', 'repo', 'raw'). Defaults to 'user'.
string	$user	The GitHub username. Defaults to 'Bearsampp'.
string \| null	$repo	The repository name (required for 'repo' and 'raw' types).
string \| null	$branch	The branch name (required for 'raw' type).
string \| null	$path	The file path (required for 'raw' type).

Returns: string|false The generated URL or false on invalid input.

Definition at line 1813 of file class.util.php.

                                                                                                                   {
        if (empty($user) || !is_string($user)) {
            return false;
        }
 
        // Encode as URL path segment (not query encoding)
        $user = rawurlencode($user);
 
        switch ($type) {
            case 'user':
                return "https://github.com/{$user}";
 
            case 'repo':
                if (empty($repo) || !is_string($repo)) {
                    return false;
                }
                $repo = rawurlencode($repo);
                return "https://github.com/{$user}/{$repo}";
 
            case 'raw':
                if (empty($repo) || empty($branch) || empty($path) || !is_string($repo) || !is_string($branch) || !is_string($path)) {
                    return false;
                }
                $repo = rawurlencode($repo);
                $branch = rawurlencode($branch);
 
                $path = ltrim($path, '/');
                $segments = array_map('rawurlencode', explode('/', $path));
                $pathEncoded = implode('/', $segments);
 
                return "https://raw.githubusercontent.com/{$user}/{$repo}/{$branch}/{$pathEncoded}";
 
            default:
                return false;
        }
    }

References APP_GITHUB_USER.

Referenced by getGithubUserUrl().

◆ getGithubUserUrl()

getGithubUserUrl ( )

static

Gets the GitHub user URL for Bearsampp.

Returns: string The GitHub user URL.

Definition at line 1855 of file class.util.php.

    {
        return self::getGithubUrl('user', APP_GITHUB_USER);
    }

References APP_GITHUB_USER, and getGithubUrl().

Referenced by ActionAbout\__construct(), and ActionAbout\processWindow().

◆ getHeaders()

getHeaders	(	$host,
		$port,
		$ssl = false )

static

Retrieves the initial response line from a specified host and port using a socket connection.

This method optionally uses SSL and creates a stream context with SSL verification enabled for security. It attempts to connect to the host and port, reads the first line of the response, and parses it. Detailed debug information is logged for each header line received.

Parameters

string	$host	The host name or IP address to connect to.
int	$port	The port number to connect to.
bool	$ssl	Whether to use SSL (defaults to false).

Returns: array An array containing the first line of the response, split into parts, or an empty array if unsuccessful.

Definition at line 1539 of file class.util.php.

    {
        $result  = array();
        $context = stream_context_create(array(
            'ssl' => array(
                'verify_peer'       => true,
                'verify_peer_name'  => true,
                'allow_self_signed' => false,
            )
        ));
 
        $fp = @stream_socket_client(($ssl ? 'ssl://' : '') . $host . ':' . $port, $errno, $errstr, 5, STREAM_CLIENT_CONNECT, $context);
        if ($fp) {
            $out    = fgets($fp);
            $result = explode(PHP_EOL, $out);
            @fclose($fp);
        }
 
        if (!empty($result)) {
            $rebuildResult = array();
            foreach ($result as $row) {
                $row = trim($row);
                if (!empty($row)) {
                    $rebuildResult[] = $row;
                }
            }
            $result = $rebuildResult;
 
            Log::debug('getHeaders:');
            foreach ($result as $header) {
                Log::debug('-> ' . $header);
            }
        }
 
        return $result;
    }

References $port, $result, and Log\debug().

Referenced by BinMailpit\checkPort(), and BinXlight\checkPort().

◆ getLatestVersion()

getLatestVersion ( $url )

static

Fetches the latest version information from a given url.

Parameters

string $url The URL to fetch version information from.

Returns: array|null Returns an array with 'version', 'html_url', and 'name' if successful, null otherwise.

Definition at line 1392 of file class.util.php.

    {
        $responseData = self::getApiJson($url);
 
        if (empty($responseData)) {
            Log::error('Cannot retrieve latest github info: empty result or error');
            return null;
        }
 
        // Now decode the JSON string
        $resultArray = json_decode($responseData, true);
 
        if (isset($resultArray['tag_name']) && isset($resultArray['assets'][0]['browser_download_url'])) {
            $tagName     = $resultArray['tag_name'];
            $downloadUrl = $resultArray['assets'][0]['browser_download_url'];
            $name        = $resultArray['name'];
            Log::debug('Latest version tag name: ' . $tagName);
            Log::debug('Download URL: ' . $downloadUrl);
            Log::debug('Name: ' . $name);
 
            return ['version' => $tagName, 'html_url' => $downloadUrl, 'name' => $name];
        } else {
            Log::error('Tag name, download URL, or name not found in the response');
            return null;
        }
    }

References Log\debug(), Log\error(), and getApiJson().

Referenced by ActionCheckVersion\__construct().

◆ getMicrotime()

getMicrotime ( )

static

Gets the current Unix timestamp with microseconds.

Returns: float Returns the current Unix timestamp combined with microseconds.

Definition at line 377 of file class.util.php.

    {
        list($usec, $sec) = explode(' ', microtime());
 
        return ((float)$usec + (float)$sec);
    }

Referenced by ActionStartup\__construct(), getFilesToScan(), ActionStartup\installServicesSequential(), ActionStartup\prepareService(), ActionStartup\processWindow(), and ActionStartup\scanFolders().

◆ getPathsToScan()

getPathsToScan ( )

staticprivate

Retrieves a list of directories and file types to scan within the BEARSAMPP environment.

This method compiles an array of paths from various components of the BEARSAMPP stack, including Apache, PHP, MySQL, MariaDB, PostgreSQL, Node.js, Composer, PowerShell, Python and Ruby. Each path entry includes the directory path, file types to include in the scan, and whether the scan should be recursive.

The method uses global variables to access the root paths of each component. It then dynamically fetches specific subdirectories using the getFolderList method (which is assumed to be defined elsewhere in this class or in the global scope) and constructs an array of path specifications.

Each path specification is an associative array with the following keys:

'path': The full directory path to scan.
'includes': An array of file extensions or filenames to include in the scan.
'recursive': A boolean indicating whether the scan should include subdirectories.

The method is designed to be used for setting up scans of configuration files and other important files within the BEARSAMPP environment, possibly for purposes like configuration management, backup, or security auditing.

Returns: array An array of associative arrays, each containing 'path', 'includes', and 'recursive' keys.

Definition at line 1118 of file class.util.php.

    {
        global $bearsamppRoot, $bearsamppCore, $bearsamppBins, $bearsamppApps, $bearsamppTools;
        $paths = array();
 
        // Alias
        $paths[] = array(
            'path'      => $bearsamppRoot->getAliasPath(),
            'includes'  => array(''),
            'recursive' => false
        );
 
        // Vhosts
        $paths[] = array(
            'path'      => $bearsamppRoot->getVhostsPath(),
            'includes'  => array(''),
            'recursive' => false
        );
 
        // OpenSSL
        $paths[] = array(
            'path'      => $bearsamppCore->getOpenSslPath(),
            'includes'  => array('openssl.cfg'),
            'recursive' => false
        );
 
        // Homepage
        $paths[] = array(
            'path'      => $bearsamppCore->getResourcesPath() . '/homepage',
            'includes'  => array('alias.conf'),
            'recursive' => false
        );
 
        // Apache
        $folderList = self::getFolderList($bearsamppBins->getApache()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppBins->getApache()->getRootPath() . '/' . $folder,
                'includes'  => array('.ini', '.conf'),
                'recursive' => true
            );
        }
 
        // PHP
        $folderList = self::getFolderList($bearsamppBins->getPhp()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppBins->getPhp()->getRootPath() . '/' . $folder,
                'includes'  => array('.php', '.bat', '.ini', '.reg', '.inc'),
                'recursive' => true
            );
        }
 
        // MySQL
        $folderList = self::getFolderList($bearsamppBins->getMysql()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppBins->getMysql()->getRootPath() . '/' . $folder,
                'includes'  => array('my.ini'),
                'recursive' => false
            );
        }
 
        // MariaDB
        $folderList = self::getFolderList($bearsamppBins->getMariadb()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppBins->getMariadb()->getRootPath() . '/' . $folder,
                'includes'  => array('my.ini'),
                'recursive' => false
            );
            // Also scan data directory for my.ini (created during initialization)
            $dataPath = $bearsamppBins->getMariadb()->getRootPath() . '/' . $folder . '/data';
            if (is_dir($dataPath)) {
                $paths[] = array(
                    'path'      => $dataPath,
                    'includes'  => array('my.ini'),
                    'recursive' => false
                );
            }
        }
 
        // PostgreSQL
        $folderList = self::getFolderList($bearsamppBins->getPostgresql()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppBins->getPostgresql()->getRootPath() . '/' . $folder,
                'includes'  => array( '.conf', '.bat', '.ber'),
                'recursive' => true
            );
        }
 
        // Node.js
        $folderList = self::getFolderList($bearsamppBins->getNodejs()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppBins->getNodejs()->getRootPath() . '/' . $folder . '/etc',
                'includes'  => array('npmrc'),
                'recursive' => true
            );
            $paths[] = array(
                'path'      => $bearsamppBins->getNodejs()->getRootPath() . '/' . $folder . '/node_modules/npm',
                'includes'  => array('npmrc'),
                'recursive' => false
            );
        }
 
        // Composer
        $folderList = self::getFolderList($bearsamppTools->getComposer()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppTools->getComposer()->getRootPath() . '/' . $folder,
                'includes'  => array('giscus.json'),
                'recursive' => false
            );
        }
 
        // PowerShell
        $folderList = self::getFolderList($bearsamppTools->getPowerShell()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppTools->getPowerShell()->getRootPath() . '/' . $folder,
                'includes'  => array('console.xml', '.ini', '.btm'),
                'recursive' => true
            );
        }
 
        // Python
        $folderList = self::getFolderList($bearsamppTools->getPython()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppTools->getPython()->getRootPath() . '/' . $folder . '/bin',
                'includes'  => array('.bat'),
                'recursive' => false
            );
            $paths[] = array(
                'path'      => $bearsamppTools->getPython()->getRootPath() . '/' . $folder . '/settings',
                'includes'  => array('winpython.ini'),
                'recursive' => false
            );
        }
 
        // Ruby
        $folderList = self::getFolderList($bearsamppTools->getRuby()->getRootPath());
        foreach ($folderList as $folder) {
            $paths[] = array(
                'path'      => $bearsamppTools->getRuby()->getRootPath() . '/' . $folder . '/bin',
                'includes'  => array('!.dll', '!.exe'),
                'recursive' => false
            );
        }
 
        return $paths;
    }

References $bearsamppBins, $bearsamppCore, $bearsamppRoot, and getFolderList().

Referenced by getFilesToScan().

◆ getPowerShellPath()

getPowerShellPath ( )

static

Finds the path to the PowerShell executable in the Windows System32 directory.

Returns: string|false Returns the path to powershell.exe if found, otherwise false.

Definition at line 613 of file class.util.php.

    {
        if (is_dir('C:\Windows\System32\WindowsPowerShell')) {
            return self::findFile('C:\Windows\System32\WindowsPowerShell', 'powershell.exe');
        }
 
        return false;
    }

References findFile().

Referenced by TplPowerShell\getTabPowerShellSection().

◆ getProcessorRegKey()

getProcessorRegKey ( )

static

Retrieves the processor identifier from the registry.

Returns: mixed The value of the processor identifier registry key or false on error.

Definition at line 535 of file class.util.php.

    {
        global $bearsamppRegistry;
 
        return $bearsamppRegistry->getValue(
            Registry::HKEY_LOCAL_MACHINE,
            Registry::PROCESSOR_REG_SUBKEY,
            Registry::PROCESSOR_REG_ENTRY
        );
    }

References Registry\HKEY_LOCAL_MACHINE, Registry\PROCESSOR_REG_ENTRY, and Registry\PROCESSOR_REG_SUBKEY.

Referenced by is32BitsOs().

◆ getRemoteFilesize()

getRemoteFilesize	(		$url,
			$humanFileSize = true )

static

Retrieves the file size of a remote file.

Parameters

string	$url	The URL of the remote file.
bool	$humanFileSize	Whether to return the size in a human-readable format.

Returns: mixed The file size, either in bytes or as a formatted string.

Definition at line 1479 of file class.util.php.

    {
        $size = 0;
 
        $data = get_headers($url, true);
        if (isset($data['Content-Length'])) {
            $size = intval($data['Content-Length']);
        }
 
        return $humanFileSize ? self::humanFileSize($size) : $size;
    }

References humanFileSize().

◆ getStartupLnkPath()

getStartupLnkPath ( )

static

Retrieves the path for the startup link file.

Returns: string The full path to the startup link file.

Definition at line 551 of file class.util.php.

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

References APP_TITLE, and Win32Native\getSpecialFolderPath().

Referenced by disableLaunchStartup(), enableLaunchStartup(), and isLaunchStartup().

◆ getSysPathRegKey()

getSysPathRegKey ( )

static

Retrieves the system path from the registry.

Returns: mixed The value of the system path registry key or false on error.

Definition at line 500 of file class.util.php.

    {
        global $bearsamppRegistry;
 
        return $bearsamppRegistry->getValue(
            Registry::HKEY_LOCAL_MACHINE,
            Registry::ENV_KEY,
            Registry::SYSPATH_REG_ENTRY
        );
    }

References Registry\ENV_KEY, Registry\HKEY_LOCAL_MACHINE, and Registry\SYSPATH_REG_ENTRY.

Referenced by ActionStartup\checkSystemPathRegKey().

◆ getVersionList()

getVersionList ( $path )

static

Gets the list of version directories in the specified path. Returns version suffixes by stripping the common prefix (basename of path) if present.

Parameters

string $path The directory path to scan for version directories.

Returns: array|false Returns a sorted array of version suffixes, or false if the directory cannot be opened.

Definition at line 343 of file class.util.php.

    {
        $result = array();
 
        $handle = @opendir($path);
        if (!$handle) {
            return false;
        }
 
        $prefix = basename($path);
 
        while (false !== ($file = readdir($handle))) {
            $filePath = $path . '/' . $file;
            if ($file != '.' && $file != '..' && is_dir($filePath) && $file != 'current') {
                if (strpos($file, $prefix) === 0) {
                    $version = substr($file, strlen($prefix));
                } else {
                    $version = $file;
                }
                $result[] = $version;
            }
        }
 
        closedir($handle);
        natcasesort($result);
 
        return $result;
    }

References $result.

Referenced by Module\getVersionList().

◆ getWebsiteUrl()

getWebsiteUrl	(	$path = '',
		$fragment = '',
		$utmSource = true )

static

Constructs a complete website URL with optional path, fragment, and UTM source parameters.

Parameters

string	$path	Optional path to append to the base URL.
string	$fragment	Optional fragment to append to the URL.
bool	$utmSource	Whether to include UTM source parameters. Defaults to true.

Returns: string The constructed URL.

Definition at line 1428 of file class.util.php.

    {
        global $bearsamppCore;
 
        $url = APP_WEBSITE;
        if (!empty($path)) {
            $url .= '/' . ltrim($path, '/');
        }
        if ($utmSource) {
            $url = rtrim($url, '/') . '/?utm_source=bearsampp-' . $bearsamppCore->getAppVersion();
        }
        if (!empty($fragment)) {
            $url .= $fragment;
        }
 
        return $url;
    }

References $bearsamppCore, and APP_WEBSITE.

Referenced by getChangelogUrl(), TplAppApache\getMenuApache(), TplAppMailpit\getMenuMailpit(), TplAppMariadb\getMenuMariadb(), TplAppMemcached\getMenuMemcached(), TplAppMysql\getMenuMysql(), TplAppNodejs\getMenuNodejs(), TplAppPhp\getMenuPhp(), TplAppPostgresql\getMenuPostgresql(), TplAppXlight\getMenuXlight(), QuickPick\getQuickpickMenu(), TplApp\getSectionMenuRight(), getWebsiteUrlNoUtm(), and ActionAbout\processWindow().

◆ getWebsiteUrlNoUtm()

getWebsiteUrlNoUtm	(		$path = '',
			$fragment = '' )

static

Constructs a website URL without UTM parameters.

Parameters

string	$path	Optional path to append to the base URL.
string	$fragment	Optional fragment to append to the URL.

Returns: string The constructed URL without UTM parameters.

Definition at line 1454 of file class.util.php.

    {
        return self::getWebsiteUrl($path, $fragment, false);
    }

References getWebsiteUrl().

Referenced by ActionAbout\__construct().

◆ humanFileSize()

humanFileSize	(		$size,
			$unit = '' )

static

Converts a file size in bytes to a human-readable format.

Parameters

int	$size	The file size in bytes.
string	$unit	The unit to convert to ('GB', 'MB', 'KB', or ''). If empty, auto-selects the unit.

Returns: string The formatted file size.

Definition at line 1499 of file class.util.php.

    {
        if ((!$unit && $size >= 1 << 30) || $unit == 'GB') {
            return number_format($size / (1 << 30), 2) . 'GB';
        }
        if ((!$unit && $size >= 1 << 20) || $unit == 'MB') {
            return number_format($size / (1 << 20), 2) . 'MB';
        }
        if ((!$unit && $size >= 1 << 10) || $unit == 'KB') {
            return number_format($size / (1 << 10), 2) . 'KB';
        }
 
        return number_format($size) . ' bytes';
    }

Referenced by getRemoteFilesize().

◆ imgToBase64()

imgToBase64 ( $path )

static

Converts an image file to a base64 encoded string.

Parameters

string $path The path to the image file.

Returns: string Returns the base64 encoded string of the image.

Definition at line 668 of file class.util.php.

    {
        $type = pathinfo($path, PATHINFO_EXTENSION);
        $data = file_get_contents($path);
 
        return 'data:image/' . $type . ';base64,' . base64_encode($data);
    }

◆ installService()

installService	(	$bin,
		$port,
		$syntaxCheckCmd,
		$showWindow = false )

static

Attempts to install and start a service on a specific port, with optional syntax checking and user notifications.

Parameters

object	$bin	An object containing the binary information and methods related to the service.
int	$port	The port number on which the service should run.
string	$syntaxCheckCmd	The command to execute for syntax checking of the service configuration.
bool	$showWindow	Optional. Whether to show message boxes for information, warnings, and errors. Defaults to false.

Returns: bool Returns true if the service is successfully installed and started, false otherwise.

Definition at line 1653 of file class.util.php.

    {
        global $bearsamppLang, $bearsamppWinbinder;
 
        if (method_exists($bin, 'initData')) {
            $bin->initData();
        }
 
        $name     = $bin->getName();
        $service  = $bin->getService();
        $boxTitle = sprintf($bearsamppLang->getValue(Lang::INSTALL_SERVICE_TITLE), $name);
 
        $isPortInUse = self::isPortInUse($port);
        if ($isPortInUse === false) {
            if (!$service->isInstalled()) {
                $service->create();
                if ($service->start()) {
                    Log::info(sprintf('%s service successfully installed. (name: %s ; port: %s)', $name, $service->getName(), $port));
                    if ($showWindow) {
                        $bearsamppWinbinder->messageBoxInfo(
                            sprintf($bearsamppLang->getValue(Lang::SERVICE_INSTALLED), $name, $service->getName(), $port),
                            $boxTitle
                        );
                    }
 
                    return true;
                } else {
                    $serviceError    = sprintf($bearsamppLang->getValue(Lang::SERVICE_INSTALL_ERROR), $name);
                    $serviceErrorLog = sprintf('Error during the installation of %s service', $name);
                    if (!empty($syntaxCheckCmd)) {
                        $cmdSyntaxCheck = $bin->getCmdLineOutput($syntaxCheckCmd);
                        if (!$cmdSyntaxCheck['syntaxOk']) {
                            $serviceError    .= PHP_EOL . sprintf($bearsamppLang->getValue(Lang::STARTUP_SERVICE_SYNTAX_ERROR), $cmdSyntaxCheck['content']);
                            $serviceErrorLog .= sprintf(' (conf errors detected : %s)', $cmdSyntaxCheck['content']);
                        }
                    }
                    Log::error($serviceErrorLog);
                    if ($showWindow) {
                        $bearsamppWinbinder->messageBoxError($serviceError, $boxTitle);
                    }
                }
            } else {
                Log::warning(sprintf('%s service already installed', $name));
                if ($showWindow) {
                    $bearsamppWinbinder->messageBoxWarning(
                        sprintf($bearsamppLang->getValue(Lang::SERVICE_ALREADY_INSTALLED), $name),
                        $boxTitle
                    );
                }
 
                return true;
            }
        } elseif ($service->isRunning()) {
            Log::warning(sprintf('%s service already installed and running', $name));
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxWarning(
                    sprintf($bearsamppLang->getValue(Lang::SERVICE_ALREADY_INSTALLED), $name),
                    $boxTitle
                );
            }
 
            return true;
        } else {
            Log::error(sprintf('Port %s is used by an other application : %s', $port, $isPortInUse));
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED_BY), $port, $isPortInUse),
                    $boxTitle
                );
            }
        }
 
        return false;
    }

References $bearsamppLang, $port, Log\error(), Log\info(), Lang\INSTALL_SERVICE_TITLE, isPortInUse(), Lang\PORT_NOT_USED_BY, Lang\SERVICE_ALREADY_INSTALLED, Lang\SERVICE_INSTALL_ERROR, Lang\SERVICE_INSTALLED, Lang\STARTUP_SERVICE_SYNTAX_ERROR, and Log\warning().

Referenced by ActionService\install(), BinApache\setEnable(), BinMailpit\setEnable(), BinMariadb\setEnable(), BinMemcached\setEnable(), BinMysql\setEnable(), BinPostgresql\setEnable(), and BinXlight\setEnable().

◆ is32BitsOs()

is32BitsOs ( )

static

Checks if the operating system is 32-bit.

Returns: bool True if the OS is 32-bit, false otherwise.

Definition at line 1519 of file class.util.php.

    {
        $processor = self::getProcessorRegKey();
 
        return UtilString::contains($processor, 'x86');
    }

References UtilString\contains(), and getProcessorRegKey().

◆ isAdmin()

isAdmin ( )

static

Checks if the current process is running with administrator/elevated privileges. This is essential for operations that require admin rights, such as installing Windows services.

Returns: bool True if running as administrator, false otherwise.

Definition at line 222 of file class.util.php.

    {
        // Only applicable on Windows
        if (strtoupper(substr(PHP_OS, 0, 3)) !== 'WIN') {
            // On non-Windows systems, check if running as root
            if (function_exists('posix_geteuid')) {
                return posix_geteuid() === 0;
            }
            // If we can't determine on non-Windows, assume true to avoid blocking
            return true;
        }
 
        // Method 1: Try using shell_exec with 'net session' command
        // This command only succeeds when run with admin privileges
        $output = CommandRunner::shellExec('net session 2>&1');
        if ($output !== null) {
            // Check for access denied errors
            if (stripos($output, 'Access is denied') !== false ||
                stripos($output, 'System error 5') !== false ||
                stripos($output, 'Zugriff verweigert') !== false) { // German
                // Explicitly denied - not admin
                return false;
            }
 
            // If we got output without errors, we likely have admin rights
            if (stripos($output, 'There are no entries') !== false ||
                stripos($output, 'These workstations') !== false ||
                preg_match('/\\\\\\\\/', $output)) {
                return true;
            }
        }
 
        // Method 2: Check using whoami command (Windows Vista and later)
        $output = CommandRunner::shellExec('whoami /groups 2>&1');
        if ($output !== null && !empty($output)) {
            // Look for the Administrators group or High Mandatory Level
            if (stripos($output, 'S-1-16-12288') !== false || // High Mandatory Level
                stripos($output, 'S-1-5-32-544') !== false) {  // Administrators group
                return true;
            }
 
            // If we got output but no admin indicators, we're not admin
            if (stripos($output, 'S-1-16-8192') !== false) { // Medium Mandatory Level (not admin)
                return false;
            }
        }
 
        // Method 3: Try to write to a system directory
        // This is a fallback method that checks if we can write to Windows directory
        $testFile = getenv('SystemRoot') . '\\Temp\\bearsampp_admin_test_' . uniqid() . '.tmp';
        $result = @file_put_contents($testFile, 'test');
        if ($result !== false) {
            @unlink($testFile);
            return true;
        }
 
        // If all methods fail or indicate no admin, return false
        return false;
    }

References $result, and CommandRunner\shellExec().

◆ isLaunchStartup()

isLaunchStartup ( )

static

Checks if the application is set to launch at startup.

Returns: bool True if the startup link exists, false otherwise.

Definition at line 562 of file class.util.php.

    {
        $lnk = self::getStartupLnkPath();
        return $lnk ? file_exists($lnk) : false;
    }

References getStartupLnkPath().

Referenced by ActionReload\__construct(), and TplAppLaunchStartup\process().

◆ isPortInUse()

isPortInUse ( $port )

static

Checks if a specific port is in use.

Parameters

int $port The port number to check

Returns: mixed False if the port is not in use, otherwise returns the process using the port

Definition at line 1601 of file class.util.php.

    {
        // Set localIP statically
        $localIP = '127.0.0.1';
 
        // Save current error reporting level
        $errorReporting = error_reporting();
 
        // Disable error reporting temporarily
        error_reporting(0);
 
        $connection = @fsockopen($localIP, $port);
 
        // Restore original error reporting level
        error_reporting($errorReporting);
 
        if (is_resource($connection)) {
            fclose($connection);
            $process = Batch::getProcessUsingPort($port);
 
            return $process != null ? $process : 'N/A';
        }
 
        return false;
    }

References $port, and Batch\getProcessUsingPort().

Referenced by BinApache\changePort(), BinMailpit\changePort(), BinMariadb\changePort(), BinMemcached\changePort(), BinMysql\changePort(), BinPostgresql\changePort(), BinXlight\changePort(), BinPostgresql\handleNonPostgresUsage(), installService(), and ActionStartup\prepareService().

◆ isValidDomainName()

isValidDomainName ( $domainName )

static

Validates a domain name based on specific criteria.

Parameters

string $domainName The domain name to validate.

Returns: bool Returns true if the domain name is valid, false otherwise.

Definition at line 1634 of file class.util.php.

    {
        // This will return the string if valid, or FALSE if not.
        // It checks syntax rules (RFC 1034/1035) but doesn't check if the domain is "real."
        $isValidSyntax = filter_var($domainName, FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME);
 
        return $isValidSyntax;
    }

Referenced by ActionAddVhost\validateInput(), and ActionEditVhost\validateInput().

◆ isValidIp()

isValidIp ( $ip )

static

Validates an IP address.

Parameters

string $ip The IP address to validate.

Returns: bool Returns true if the IP address is valid, otherwise false.

Definition at line 198 of file class.util.php.

    {
        return filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)
            || filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6);
    }

◆ isValidPort()

isValidPort ( $port )

static

Validates a port number.

Parameters

int $port The port number to validate.

Returns: bool Returns true if the port number is valid and within the range of 1 to 65535, otherwise false.

Definition at line 211 of file class.util.php.

    {
        return is_numeric($port) && ($port > 0 && $port <= 65535);
    }

References $port.

Referenced by BinApache\changePort(), BinMailpit\changePort(), BinMariadb\changePort(), BinMemcached\changePort(), BinMysql\changePort(), BinPostgresql\changePort(), BinXlight\changePort(), BinApache\checkPort(), BinMailpit\checkPort(), BinMariadb\checkPort(), BinMemcached\checkPort(), BinMysql\checkPort(), BinPostgresql\checkPort(), and BinXlight\checkPort().

◆ openFileContent()

openFileContent	(		$caption,
			$content )

static

Opens the given content in a temporary file using the editor configured in bearsampp.conf.

Parameters

string	$caption	The caption/title for the temporary file.
string	$content	The content to write to the temporary file.

Returns: void

Definition at line 1897 of file class.util.php.

    {
        global $bearsamppCore, $bearsamppConfig;
 
        $tmpFile = $bearsamppCore->getTmpPath() . '/' . $caption . '.txt';
        file_put_contents($tmpFile, $content);
 
        // Open the file with the configured editor from bearsampp.conf
        $editor = $bearsamppConfig->getNotepad();
        $bearsamppCore->getWinbinder()->exec($editor, '"' . $tmpFile . '"');
    }

References $bearsamppConfig, and $bearsamppCore.

Referenced by ActionDebugBase\__construct().

◆ removeService()

removeService	(		$service,
			$name )

static

Removes a service if it is installed.

Parameters

Win32Service	$service	The service object to be removed.
string	$name	The name of the service.

Returns: bool Returns true if the service is successfully removed, false otherwise.

Definition at line 1736 of file class.util.php.

    {
        if (!($service instanceof Win32Service)) {
            Log::error('$service not an instance of Win32Service');
 
            return false;
        }
 
        if ($service->isInstalled()) {
            if ($service->delete()) {
                Log::info(sprintf('%s service successfully removed', $name));
 
                return true;
            } else {
                Log::error(sprintf('Error during the uninstallation of %s service', $name));
 
                return false;
            }
        } else {
            Log::warning(sprintf('%s service does not exist', $name));
        }
 
        return true;
    }

References Log\error(), Log\info(), and Log\warning().

Referenced by ActionService\remove(), BinApache\setEnable(), BinMailpit\setEnable(), BinMariadb\setEnable(), BinMemcached\setEnable(), BinMysql\setEnable(), BinPostgresql\setEnable(), and BinXlight\setEnable().

◆ replaceDefine()

replaceDefine	(	$path,
		$var,
		$value )

static

Replaces a defined constant in a file with a new value.

Parameters

string	$path	The file path where the constant is defined.
string	$var	The name of the constant.
mixed	$value	The new value for the constant.

Definition at line 289 of file class.util.php.

    {
        self::replaceInFile($path, array(
            '/^define\‍((.*?)' . $var . '(.*?),/' => 'define(\'' . $var . '\', ' . (is_int($value) ? $value : '\'' . $value . '\'') . ');'
        ));
    }

References replaceInFile().

◆ replaceInFile()

replaceInFile	(		$path,
			$replaceList )

static

Performs replacements in a file based on a list of regular expression patterns.

Parameters

string	$path	The path to the file where replacements are to be made.
array	$replaceList	An associative array where keys are regex patterns and values are replacement strings.

Definition at line 302 of file class.util.php.

    {
        if (file_exists($path)) {
            $lines = file($path);
            $fp    = fopen($path, 'w');
            foreach ($lines as $nb => $line) {
                $replaceDone = false;
                foreach ($replaceList as $regex => $replace) {
                    if (preg_match($regex, $line, $matches)) {
                        $countParams = preg_match_all('/{{(\d+)}}/', $replace, $paramsMatches);
                        if ($countParams > 0 && $countParams <= count($matches)) {
                            foreach ($paramsMatches[1] as $paramsMatch) {
                                $replace = str_replace('{{' . $paramsMatch . '}}', $matches[$paramsMatch], $replace);
                            }
                        }
                        Log::trace('Replace in file ' . $path . ' :');
                        Log::trace('## line_num: ' . trim($nb));
                        Log::trace('## old: ' . trim($line));
                        Log::trace('## new: ' . trim($replace));
                        fwrite($fp, $replace . PHP_EOL);
 
                        $replaceDone = true;
                        break;
                    }
                }
                if (!$replaceDone) {
                    fwrite($fp, $line);
                }
            }
            fclose($fp);
        }
    }

References Log\trace().

Referenced by BinPostgresql\rebuildConf(), Homepage\refreshCommonsJsContent(), replaceDefine(), ToolGit\setScanStartup(), AppPhpmyadmin\updateConfig(), AppPhppgadmin\updateConfig(), BinApache\updateConfig(), BinMariadb\updateConfig(), BinMysql\updateConfig(), BinPhp\updateConfig(), and BinPostgresql\updateConfig().

◆ setAppBinsRegKey()

setAppBinsRegKey ( $value )

static

Retrieves or generates the application binaries registry key.

Parameters

bool $fromRegistry Determines whether to retrieve the key from the registry or generate it.

Returns: string Returns the application binaries registry key.

Definition at line 448 of file class.util.php.

    {
        global $bearsamppRegistry;
 
        return $bearsamppRegistry->setStringValue(
            Registry::HKEY_LOCAL_MACHINE,
            Registry::ENV_KEY,
            Registry::APP_BINS_REG_ENTRY,
            $value
        );
    }

References Registry\APP_BINS_REG_ENTRY, Registry\ENV_KEY, and Registry\HKEY_LOCAL_MACHINE.

Referenced by ActionStartup\checkBinsRegKey(), and ActionSwitchVersion\processWindow().

◆ setAppPathRegKey()

setAppPathRegKey ( $value )

static

Sets the application path in the registry.

Parameters

string $value The new value for the application path.

Returns: bool True on success, false on failure.

Definition at line 483 of file class.util.php.

    {
        global $bearsamppRegistry;
 
        return $bearsamppRegistry->setStringValue(
            Registry::HKEY_LOCAL_MACHINE,
            Registry::ENV_KEY,
            Registry::APP_PATH_REG_ENTRY,
            $value
        );
    }

References Registry\APP_PATH_REG_ENTRY, Registry\ENV_KEY, and Registry\HKEY_LOCAL_MACHINE.

Referenced by ActionStartup\checkPathRegKey().

◆ setFileScanCache()

setFileScanCache	(		$cacheKey,
			$data )

staticprivate

Stores file scan results in cache with integrity protection.

Parameters

string	$cacheKey	The cache key to store under.
array	$data	The scan results to cache.

Returns: void

Definition at line 917 of file class.util.php.

    {
        global $bearsamppRoot;
 
        // Generate HMAC for integrity verification
        $hmac = self::generateCacheHMAC($data, $cacheKey);
 
        $cacheData = [
            'timestamp' => time(),
            'data' => $data,
            'hmac' => $hmac
        ];
 
        // Store in memory cache
        if (self::$fileScanCache === null) {
            self::$fileScanCache = [];
        }
        self::$fileScanCache[$cacheKey] = $cacheData;
 
        // Store in file cache
        if (isset($bearsamppRoot)) {
            $cacheFile = $bearsamppRoot->getTmpPath() . '/filescan_cache_' . $cacheKey . '.dat';
            @file_put_contents($cacheFile, serialize($cacheData), LOCK_EX);
            Log::debug('File scan results cached to: ' . $cacheFile);
        }
    }

References $bearsamppRoot, Log\debug(), and generateCacheHMAC().

Referenced by getFilesToScan().

◆ setFileScanCacheDuration()

setFileScanCacheDuration ( $seconds )

static

Sets the file scan cache duration.

Parameters

int $seconds Cache duration in seconds (default: 3600 = 1 hour).

Returns: void

Definition at line 1076 of file class.util.php.

    {
        if ($seconds > 0 && $seconds <= 86400) { // Max 24 hours
            self::$fileScanCacheDuration = $seconds;
            Log::debug('File scan cache duration set to ' . $seconds . ' seconds');
        }
    }

References Log\debug().

◆ setSysPathRegKey()

setSysPathRegKey ( $value )

static

Sets the system path in the registry.

Parameters

string $value The new value for the system path.

Returns: bool True on success, false on failure.

Definition at line 518 of file class.util.php.

    {
        global $bearsamppRegistry;
 
        return $bearsamppRegistry->setExpandStringValue(
            Registry::HKEY_LOCAL_MACHINE,
            Registry::ENV_KEY,
            Registry::SYSPATH_REG_ENTRY,
            $value
        );
    }

References Registry\ENV_KEY, Registry\HKEY_LOCAL_MACHINE, and Registry\SYSPATH_REG_ENTRY.

Referenced by ActionStartup\checkSystemPathRegKey().

◆ startLoading()

startLoading ( )

static

Initiates a loading process using external components.

Definition at line 720 of file class.util.php.

    {
        global $bearsamppCore, $bearsamppWinbinder;
 
        Log::trace('startLoading() called');
        Log::trace('PHP executable: ' . $bearsamppCore->getPhpExe());
        Log::trace('Root file: ' . Core::isRoot_FILE);
        Log::trace('Action: ' . Action::LOADING);
 
        $command = Core::isRoot_FILE . ' ' . Action::LOADING;
        Log::trace('Executing command: ' . $bearsamppCore->getPhpExe() . ' ' . $command);
 
        $result = $bearsamppWinbinder->exec($bearsamppCore->getPhpExe(), $command);
        Log::trace('exec() returned: ' . var_export($result, true));
 
        Log::trace('startLoading() completed');
    }

References $bearsamppCore, $result, Core\isRoot_FILE, Action\LOADING, and Log\trace().

Referenced by ActionCheckVersion\__construct(), ActionEnable\__construct(), ActionLaunchStartup\__construct(), ActionManualRestart\__construct(), ActionRefreshRepos\__construct(), ActionReload\__construct(), ActionService\__construct(), ActionSwitchOnline\__construct(), and ActionStartup\processWindow().

◆ startService()

startService	(	$bin,
		$syntaxCheckCmd,
		$showWindow = false )

static

Attempts to start a service and performs a syntax check if required.

Parameters

object	$bin	An object containing service details.
string	$syntaxCheckCmd	Command to check syntax errors.
bool	$showWindow	Whether to show error messages in a window.

Returns: bool Returns true if the service starts successfully, false otherwise.

Definition at line 1770 of file class.util.php.

    {
        global $bearsamppLang, $bearsamppWinbinder;
 
        if (method_exists($bin, 'initData')) {
            $bin->initData();
        }
 
        $name     = $bin->getName();
        $service  = $bin->getService();
        $boxTitle = sprintf($bearsamppLang->getValue(Lang::START_SERVICE_TITLE), $name);
 
        if (!$service->start()) {
            $serviceError    = sprintf($bearsamppLang->getValue(Lang::START_SERVICE_ERROR), $name);
            $serviceErrorLog = sprintf('Error while starting the %s service', $name);
            if (!empty($syntaxCheckCmd)) {
                $cmdSyntaxCheck = $bin->getCmdLineOutput($syntaxCheckCmd);
                if (!$cmdSyntaxCheck['syntaxOk']) {
                    $serviceError    .= PHP_EOL . sprintf($bearsamppLang->getValue(Lang::STARTUP_SERVICE_SYNTAX_ERROR), $cmdSyntaxCheck['content']);
                    $serviceErrorLog .= sprintf(' (conf errors detected : %s)', $cmdSyntaxCheck['content']);
                }
            }
            Log::error($serviceErrorLog);
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError($serviceError, $boxTitle);
            }
 
            return false;
        }
 
        return true;
    }

References $bearsamppLang, Log\error(), Lang\START_SERVICE_ERROR, Lang\START_SERVICE_TITLE, and Lang\STARTUP_SERVICE_SYNTAX_ERROR.

Referenced by BinPhp\setEnable(), ActionService\start(), and ServiceHelper\startService().

◆ stopLoading()

stopLoading ( )

static

Stops a previously started loading process and cleans up related resources.

Definition at line 741 of file class.util.php.

    {
        global $bearsamppCore;
        if (file_exists($bearsamppCore->getLoadingPid())) {
            $pids = file($bearsamppCore->getLoadingPid());
            foreach ($pids as $pid) {
                Win32Ps::kill($pid);
            }
            @unlink($bearsamppCore->getLoadingPid());
        }
 
        // Clean up status file
        self::clearLoadingText();
    }

References $bearsamppCore, clearLoadingText(), and Win32Ps\kill().

Referenced by ActionManualRestart\__construct(), ActionService\__construct(), ActionCheckVersion\showVersionOkMessageBox(), and ActionCheckVersion\showVersionUpdateWindow().

◆ updateLoadingText()

updateLoadingText ( $text )

static

Updates the loading screen text (if loading screen is active) This allows dynamic updates to show which service is being processed

Parameters

string $text The text to display on the loading screen

Definition at line 762 of file class.util.php.

    {
        global $bearsamppCore;
 
        $statusFile = $bearsamppCore->getTmpPath() . '/loading_status.txt';
        file_put_contents($statusFile, json_encode(['text' => $text]));
    }

References $bearsamppCore.

Referenced by ActionChangePort\processWindow(), ActionService\restart(), ActionService\start(), and ActionService\stop().

◆ utf8ToCp1252()

utf8ToCp1252 ( $data )

static

Converts UTF-8 encoded data to Windows-1252 encoding.

Parameters

string $data The UTF-8 encoded data.

Returns: string Returns the data encoded in Windows-1252.

Definition at line 700 of file class.util.php.

    {
        return iconv('UTF-8', 'WINDOWS-1252//IGNORE', $data);
    }

Referenced by ActionReload\__construct(), and convertEncoding().

◆ verifyCacheIntegrity()

verifyCacheIntegrity	(		$fileContents,
			$cacheKey )

staticprivate

Verifies cache file integrity using HMAC.

Parameters

string	$fileContents	The serialized cache file contents
string	$cacheKey	The cache key

Returns: bool True if integrity check passes, false otherwise

Definition at line 1012 of file class.util.php.

    {
        $cacheData = @unserialize($fileContents);
 
        if ($cacheData === false || !isset($cacheData['hmac']) || !isset($cacheData['data'])) {
            return false;
        }
 
        $expectedHmac = self::generateCacheHMAC($cacheData['data'], $cacheKey);
 
        // Use hash_equals to prevent timing attacks
        return hash_equals($expectedHmac, $cacheData['hmac']);
    }

References generateCacheHMAC().

Field Documentation

◆ $cacheIntegrityKey

$cacheIntegrityKey = null

staticprivate

Definition at line 64 of file class.util.php.

◆ $fileScanCache

$fileScanCache = null

staticprivate

Definition at line 41 of file class.util.php.

◆ $fileScanCacheDuration

$fileScanCacheDuration = 3600

staticprivate

Definition at line 47 of file class.util.php.

◆ $fileScanStats

$fileScanStats

staticprivate

Initial value:

                              = [
    'hits' => 0,
    'misses' => 0,
    'invalidations' => 0
]

Definition at line 53 of file class.util.php.

The documentation for this class was generated from the following file:

E:/Bearsampp-development/sandbox/core/classes/class.util.php

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ changePath()

◆ clearFileScanCache()

◆ clearFolder()

◆ clearFolders()

◆ clearLoadingText()

◆ convertEncoding()

◆ cp1252ToUtf8()

◆ deleteFolder()

◆ disableLaunchStartup()

◆ enableLaunchStartup()

◆ findFile()

◆ findFiles()

◆ findRepos()

◆ generateCacheHMAC()

◆ getApiJson()

◆ getAppBinsRegKey()

◆ getAppPathRegKey()

◆ getCacheIntegrityKey()

◆ getChangelogUrl()

◆ getFileScanCache()

◆ getFileScanCacheDuration()

◆ getFileScanStats()

◆ getFilesToScan()

◆ getFolderList()

◆ getGithubUrl()

◆ getGithubUserUrl()

◆ getHeaders()

◆ getLatestVersion()

◆ getMicrotime()

◆ getPathsToScan()

◆ getPowerShellPath()

◆ getProcessorRegKey()

◆ getRemoteFilesize()

◆ getStartupLnkPath()

◆ getSysPathRegKey()

◆ getVersionList()

◆ getWebsiteUrl()

◆ getWebsiteUrlNoUtm()

◆ humanFileSize()

◆ imgToBase64()

◆ installService()

◆ is32BitsOs()

◆ isAdmin()

◆ isLaunchStartup()

◆ isPortInUse()

◆ isValidDomainName()

◆ isValidIp()

◆ isValidPort()

◆ openFileContent()

◆ removeService()

◆ replaceDefine()

◆ replaceInFile()

◆ setAppBinsRegKey()

◆ setAppPathRegKey()

◆ setFileScanCache()

◆ setFileScanCacheDuration()

◆ setSysPathRegKey()

◆ startLoading()

◆ startService()

◆ stopLoading()

◆ updateLoadingText()

◆ utf8ToCp1252()

◆ verifyCacheIntegrity()

Field Documentation

◆ $cacheIntegrityKey

◆ $fileScanCache

◆ $fileScanCacheDuration

◆ $fileScanStats