Static Public Member Functions
static	checkInternetState ()
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	findFile ($startPath, $findFile)
static	findRepos ($initPath, $startPath, $checkFile, $maxDepth=1)
static	getApiJson ($url)
static	getCurlHttpHeaders ($url)
static	getFilesToScan ($path=null, $useCache=true, $forceRefresh=false)
static	getFolderList ($path)
static	getFopenHttpHeaders ($url)
static	getGithubUrl ($type='user', $user=APP_GITHUB_USER, $repo=null, $branch=null, $path=null)
static	getGithubUserUrl ()
static	getHeaders ($host, $port, $ssl=false)
static	getHttpHeaders ($pingUrl)
static	getLatestVersion ($url)
static	getMicrotime ()
static	getRemoteFilesize ($url, $humanFileSize=true)
static	getVersionList ($path)
static	getWebsiteUrl ($path='', $fragment='', $utmSource=true)
static	getWebsiteUrlNoUtm ($path='', $fragment='')
static	humanFileSize (int $size, string $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	setupCurlHeaderWithToken ()
static	startLoading ()
static	startService ($bin, $syntaxCheckCmd, $showWindow=false)
static	stopLoading ()
static	updateLoadingText ($text)
static	utf8ToCp1252 ($data)

Static Private Member Functions
static	findFiles ($startPath, $includes=array(''), $recursive=true)
static	getPathsToScan ()

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 Path.

See also: Path 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:188

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

◆ checkInternetState()

checkInternetState ( )

static

Checks the current state of the internet connection.

This method attempts to reach a well-known website (e.g., www.google.com) to determine the state of the internet connection. It returns true if the connection is successful, otherwise it returns false.

Returns: bool True if the internet connection is active, false otherwise.

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

    {
        $connected = @fsockopen('www.google.com', 80);
        if ($connected) {
            fclose($connected);
 
            return true; // Internet connection is active
        } else {
            return false; // Internet connection is not active
        }
    }

◆ 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 64 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 46 of file class.util.php.

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

References $result, and clearFolder().

Here is the call graph for this function:

◆ clearLoadingText()

clearLoadingText ( )

static

Clears the loading status file

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

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

References $bearsamppCore, and Path\getTmpPath().

Referenced by stopLoading().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 494 of file class.util.php.

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

References cp1252ToUtf8(), and utf8ToCp1252().

Here is the call graph for this function:

◆ 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 522 of file class.util.php.

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

Referenced by convertEncoding().

Here is the caller graph for this function:

◆ 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 108 of file class.util.php.

    {
        if (is_dir($path)) {
            $path = rtrim($path, '/\\') . '/';
            $files = glob($path . '*', GLOB_MARK);
 
            if ($files === false) {
                Log::error("deleteFolder(): Failed to glob path: " . $path);
                return;
            }
 
            foreach ($files as $file) {
                $normalizedFile = rtrim($file, '/\\');
 
                if (is_link($normalizedFile)) {
                    if (!@unlink($normalizedFile) && !@rmdir($normalizedFile)) {
                        Log::error("deleteFolder(): Failed to unlink symlink: " . $normalizedFile);
                    }
                } elseif (is_dir($file)) {
                    self::deleteFolder($file);
                } else {
                    if (!@unlink($normalizedFile)) {
                        Log::error("deleteFolder(): Failed to unlink file: " . $normalizedFile);
                    }
                }
            }
 
            if (!@rmdir($path)) {
                // Only log error if directory still exists (might have been deleted by recursion)
                if (is_dir($path)) {
                    Log::error("deleteFolder(): Failed to remove directory: " . $path);
                }
            }
        }
    }

References deleteFolder(), and Log\error().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 418 of file class.util.php.

    {
        $startupLnkPath = Path::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 Path\getStartupLnkPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 396 of file class.util.php.

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

References $bearsamppCore, $bearsamppRoot, APP_TITLE, Win32Native\createShortcut(), Path\getExeFilePath(), Path\getIconsPath(), Path\getRootPath(), and Path\getStartupLnkPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findFile()

findFile	(		$startPath,
			$findFile )

static

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 152 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 = Path::formatUnixPath($startPath . '/' . $file);
                break;
            }
        }
 
        closedir($handle);
 
        return $result;
    }

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

Referenced by findFile(), and Path\getPowerShellPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 835 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[] = Path::formatUnixPath($startPath . '/' . $file);
                        } elseif ($file != $include) {
                            $result[] = Path::formatUnixPath($startPath . '/' . $file);
                        }
                    } elseif (UtilString::endWith($file, $include) || $file == $include || empty($include)) {
                        $result[] = Path::formatUnixPath($startPath . '/' . $file);
                    }
                }
            }
        }
 
        closedir($handle);
 
        return $result;
    }

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

Referenced by findFiles(), and getFilesToScan().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 442 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[] = Path::formatUnixPath($startPath);
            }
        }
 
        closedir($handle);
 
        return $result;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getApiJson()

getApiJson ( $url )

static

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

Parameters

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

Returns: string The trimmed response data from the URL.

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

    {
        $header = self::setupCurlHeaderWithToken();
 
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSv1_2);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_VERBOSE, true);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
        $data = curl_exec($ch);
        if (curl_errno($ch)) {
            Log::error('CURL Error: ' . curl_error($ch));
        }
 
        // curl_close() is deprecated in PHP 8.5+ as it has no effect since PHP 8.0
        // The resource is automatically closed when it goes out of scope
        if (PHP_VERSION_ID < 80500) {
            curl_close($ch);
        }
 
        return trim($data);
    }

References Log\error(), and setupCurlHeaderWithToken().

Referenced by getLatestVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurlHttpHeaders()

getCurlHttpHeaders ( $url )

static

Retrieves HTTP headers from a given URL using cURL.

This method initializes a cURL session, sets various options to fetch headers including disabling SSL peer verification, and executes the request. It logs the raw response for debugging purposes and parses the headers from the response.

Parameters

string $url The URL from which to fetch the headers.

Returns: array An array of headers if successful, otherwise an empty array.

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

    {
        $result = array();
 
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_VERBOSE, true);
        curl_setopt($ch, CURLOPT_HEADER, true);
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
 
        $response = @curl_exec($ch);
        if (empty($response)) {
            return $result;
        }
 
        Log::trace('getCurlHttpHeaders:' . $response);
        $responseHeaders = explode("\r\n\r\n", $response, 2);
        if (!isset($responseHeaders[0]) || empty($responseHeaders[0])) {
            return $result;
        }
 
        return explode("\n", $responseHeaders[0]);
    }

References $response, $result, and Log\trace().

Referenced by getHttpHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 602 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 = Cache::get($cacheKey);
            if ($cachedResult !== false) {
                Cache::recordHit();
                Log::debug('File scan cache HIT (saved expensive scan operation)');
                return $cachedResult;
            }
        }
 
        Cache::recordMiss();
        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) {
            Cache::set($cacheKey, $result);
        }
 
        return $result;
    }

References $result, Log\debug(), findFiles(), Cache\get(), getMicrotime(), getPathsToScan(), Log\info(), Cache\recordHit(), Cache\recordMiss(), and Cache\set().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 1482 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().

Here is the caller graph for this function:

◆ getFopenHttpHeaders()

getFopenHttpHeaders ( $url )

static

Retrieves HTTP headers from a given URL using the fopen function.

This method creates a stream context to disable SSL peer and peer name verification, which allows self-signed certificates. It attempts to open the URL and read the HTTP response headers.

Parameters

string $url The URL from which to fetch the headers.

Returns: array An array of headers if successful, otherwise an empty array.

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

    {
        $result = array();
 
        $context = stream_context_create(array(
            'ssl' => array(
                'verify_peer'       => false,
                'verify_peer_name'  => false,
                'allow_self_signed' => true,
            )
        ));
 
        $fp = @fopen($url, 'r', false, $context);
        if ($fp) {
            $meta   = stream_get_meta_data($fp);
            $result = isset($meta['wrapper_data']) ? $meta['wrapper_data'] : $result;
            fclose($fp);
        }
 
        return $result;
    }

References $result.

Referenced by getHttpHeaders().

Here is the caller graph for this function:

◆ 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 1408 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().

Here is the caller graph for this function:

◆ getGithubUserUrl()

getGithubUserUrl ( )

static

Gets the GitHub user URL for Bearsampp.

Returns: string The GitHub user URL.

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

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

References APP_GITHUB_USER, and getGithubUrl().

Here is the call graph for this function:

◆ 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 similar to getFopenHttpHeaders. 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 1124 of file class.util.php.

    {
        $result  = array();
        $context = stream_context_create(array(
            'ssl' => array(
                'verify_peer'       => false,
                'verify_peer_name'  => false,
                'allow_self_signed' => true,
            )
        ));
 
        $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().

Here is the call graph for this function:

◆ getHttpHeaders()

getHttpHeaders ( $pingUrl )

static

Retrieves HTTP headers from a given URL using either cURL or fopen, depending on availability.

Parameters

string $pingUrl The URL to ping for headers.

Returns: array An array of HTTP headers.

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

    {
        if (function_exists('curl_version')) {
            $result = self::getCurlHttpHeaders($pingUrl);
        } else {
            $result = self::getFopenHttpHeaders($pingUrl);
        }
 
        if (!empty($result)) {
            $rebuildResult = array();
            foreach ($result as $row) {
                $row = trim($row);
                if (!empty($row)) {
                    $rebuildResult[] = $row;
                }
            }
            $result = $rebuildResult;
 
            Log::debug('getHttpHeaders:');
            foreach ($result as $header) {
                Log::debug('-> ' . $header);
            }
        }
 
        return $result;
    }

References $result, Log\debug(), getCurlHttpHeaders(), and getFopenHttpHeaders().

Here is the call graph for this function:

◆ 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' and 'url' if successful, null otherwise.

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

    {
        $result = self::getApiJson($url);
        if (empty($result)) {
            Log::error('Cannot retrieve latest github info for: ' . $result . ' RESULT');
 
            return null;
        }
 
        $resultArray = json_decode($result, 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: ' . $result);
 
            return null;
        }
    }

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

Here is the call graph for this function:

◆ getMicrotime()

getMicrotime ( )

static

Gets the current Unix timestamp with microseconds.

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

Definition at line 371 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().

Here is the caller graph for this function:

◆ 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 671 of file class.util.php.

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

References $bearsamppBins, $bearsamppCore, $bearsamppRoot, Path\getAliasPath(), getFolderList(), Path\getModuleRootPath(), Path\getOpenSslPath(), Path\getResourcesPath(), and Path\getVhostsPath().

Referenced by getFilesToScan().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 956 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().

Here is the call graph for this function:

◆ 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 337 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().

Here is the caller graph for this function:

◆ 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 917 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 getWebsiteUrlNoUtm().

Here is the caller graph for this function:

◆ 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 943 of file class.util.php.

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

References getWebsiteUrl().

Here is the call graph for this function:

◆ humanFileSize()

humanFileSize	(	int	$size,
		string	$unit = '' )

static

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

Uses PHP's native human_readable_size() when no unit is forced. Falls back to manual conversion when a specific unit is requested.

Parameters

int	$size	The file size in bytes.
string	$unit	Optional forced unit ('GB', 'MB', 'KB', or '').

Returns: string The formatted file size.

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

                                                                    : string
    {
        // Forced unit mode
        if ($unit !== '') {
            return match ($unit) {
                'GB' => number_format($size / (1 << 30), 2) . 'GB',
                'MB' => number_format($size / (1 << 20), 2) . 'MB',
                'KB' => number_format($size / (1 << 10), 2) . 'KB',
                default => number_format($size) . ' bytes',
            };
        }
 
        // Native PHP 8.3+ auto-selection
        return human_readable_size($size, precision: 2);
    }

Referenced by HttpClient\getRemoteFilesize(), and getRemoteFilesize().

Here is the caller graph for this function:

◆ 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 478 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 1248 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 1000 of file class.util.php.

    {
        global $bearsamppRegistry;
        $processor = $bearsamppRegistry->getProcessorRegKey();
 
        return UtilString::contains($processor, 'x86');
    }

References UtilString\contains().

Here is the call graph for this function:

◆ 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 212 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().

Here is the call graph for this function:

◆ 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 385 of file class.util.php.

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

References Path\getStartupLnkPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 1200 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 1233 of file class.util.php.

    {
        return filter_var($domainName, FILTER_VALIDATE_DOMAIN, FILTER_FLAG_HOSTNAME) !== false;
    }

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

Here is the caller graph for this function:

◆ 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 188 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 201 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().

Here is the caller graph for this function:

◆ 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 1513 of file class.util.php.

    {
        global $bearsamppCore, $bearsamppConfig;
 
        $tmpFile = Path::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, $bearsamppCore, and Path\getTmpPath().

Referenced by ActionDebugBase\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 1331 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 279 of file class.util.php.

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

References replaceInFile().

Here is the call graph for this function:

◆ 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 292 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)) {
                        $currentReplace = $replace;
                        $countParams = preg_match_all('/{{(\d+)}}/', $currentReplace, $paramsMatches);
                        if ($countParams > 0 && $countParams <= count($matches)) {
                            foreach ($paramsMatches[1] as $paramsMatch) {
                                $currentReplace = str_replace('{{' . $paramsMatch . '}}', $matches[$paramsMatch], $currentReplace);
                            }
                        }
                        Log::trace('Replace in file ' . $path . ' :');
                        Log::trace('## line_num: ' . trim($nb));
                        Log::trace('## old: ' . trim($line));
                        Log::trace('## new: ' . trim($currentReplace));
                        
                        // Preserve original line ending if present in $line
                        $ending = (preg_match("/\r\n$/", $line)) ? "\r\n" : (preg_match("/\n$/", $line) ? "\n" : "");
                        fwrite($fp, rtrim($currentReplace) . $ending);
 
                        $replaceDone = true;
                        break;
                    }
                }
                if (!$replaceDone) {
                    fwrite($fp, $line);
                }
            }
            fclose($fp);
        }
    }

References Log\trace().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setupCurlHeaderWithToken()

setupCurlHeaderWithToken ( )

static

Sets up cURL headers with token for API requests.

Returns: array The array of cURL headers.

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

    {
        // Return headers with User-Agent, which is required by GitHub API
        return array(
            'User-Agent: ' . APP_GITHUB_USERAGENT . ' (https://github.com/' . APP_GITHUB_USER . '/' . APP_GITHUB_REPO . ')',
            'Accept: application/vnd.github.v3+json'
        );
    }

References APP_GITHUB_REPO, APP_GITHUB_USER, and APP_GITHUB_USERAGENT.

Referenced by getApiJson().

Here is the caller graph for this function:

◆ startLoading()

startLoading ( )

static

Initiates a loading process using external components.

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

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

References $bearsamppCore, $result, Path\getPhpExe(), 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 1365 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().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stopLoading()

stopLoading ( )

static

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

Definition at line 550 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 ActionCheckVersion\__construct(), ActionEnable\__construct(), ActionLaunchStartup\__construct(), ActionManualRestart\__construct(), ActionRefreshRepos\__construct(), ActionReload\__construct(), ActionService\__construct(), ActionSwitchOnline\__construct(), ActionCheckVersion\showVersionOkMessageBox(), and ActionCheckVersion\showVersionUpdateWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 571 of file class.util.php.

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

References $bearsamppCore, and Path\getTmpPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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 510 of file class.util.php.

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

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

Here is the caller graph for this function:

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

Detailed Description

Member Function Documentation

◆ checkInternetState()

◆ clearFolder()

◆ clearFolders()

◆ clearLoadingText()

◆ convertEncoding()

◆ cp1252ToUtf8()

◆ deleteFolder()

◆ disableLaunchStartup()

◆ enableLaunchStartup()

◆ findFile()

◆ findFiles()

◆ findRepos()

◆ getApiJson()

◆ getCurlHttpHeaders()

◆ getFilesToScan()

◆ getFolderList()

◆ getFopenHttpHeaders()

◆ getGithubUrl()

◆ getGithubUserUrl()

◆ getHeaders()

◆ getHttpHeaders()

◆ getLatestVersion()

◆ getMicrotime()

◆ getPathsToScan()

◆ getRemoteFilesize()

◆ getVersionList()

◆ getWebsiteUrl()

◆ getWebsiteUrlNoUtm()

◆ humanFileSize()

◆ imgToBase64()

◆ installService()

◆ is32BitsOs()

◆ isAdmin()

◆ isLaunchStartup()

◆ isPortInUse()

◆ isValidDomainName()

◆ isValidIp()

◆ isValidPort()

◆ openFileContent()

◆ removeService()

◆ replaceDefine()

◆ replaceInFile()

◆ setupCurlHeaderWithToken()

◆ startLoading()

◆ startService()

◆ stopLoading()

◆ updateLoadingText()

◆ utf8ToCp1252()