Static Public Member Functions
static	checkInternetState ()
static	getApiJson ($url)
static	getChangelogUrl ($utmSource=true)
static	getCurlHttpHeaders ($url)
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	getRemoteFilesize ($url, $humanFileSize=true)
static	getWebsiteUrl ($path='', $fragment='', $utmSource=true)
static	getWebsiteUrlNoUtm ($path='', $fragment='')
static	setupCurlHeaderWithToken ()

Detailed Description

Definition at line 19 of file class.httpclient.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 409 of file class.httpclient.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
        }
    }

Referenced by QuickPick\getQuickpickMenu(), and QuickPick\installModule().

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 298 of file class.httpclient.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, false); // Set to false to avoid polluting logs unless needed
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
        curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
        $data = curl_exec($ch);
        if (curl_errno($ch)) {
            Log::error('CURL Error (' . curl_errno($ch) . '): ' . curl_error($ch) . ' (URL: ' . $url . ')');
        }
 
        $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
        if ($httpCode >= 400) {
            Log::error('HTTP Error ' . $httpCode . ' for URL: ' . $url);
        }
 
        // 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 $data === false ? '' : 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:

◆ 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 172 of file class.httpclient.php.

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

References getWebsiteUrl().

Here is the call 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 99 of file class.httpclient.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);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 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:

◆ 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 66 of file class.httpclient.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 187 of file class.httpclient.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 'issues':
                if (empty($repo) || !is_string($repo)) {
                    return false;
                }
                $repo = rawurlencode($repo);
                return "https://github.com/{$user}/{$repo}/issues";
 
            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 236 of file class.httpclient.php.

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

References APP_GITHUB_USER, and getGithubUrl().

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

Here is the call graph for this function:

Here is the caller 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 254 of file class.httpclient.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().

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

Here is the call graph for this function:

Here is the caller 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 28 of file class.httpclient.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().

Referenced by BinApache\checkPort().

Here is the call graph for this function:

Here is the caller 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 336 of file class.httpclient.php.

    {
        $result = self::getApiJson($url);
        if (empty($result)) {
            Log::error('Cannot retrieve latest github info: empty result or error for URL: ' . $url);
 
            return null;
        }
 
        $resultArray = json_decode($result, true);
        if ($resultArray === null) {
            Log::error('Failed to decode JSON response from: ' . $url . '. Response snippet: ' . substr($result, 0, 100));
            return null;
        }
 
        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().

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

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 389 of file class.httpclient.php.

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

References Util\humanFileSize().

Here is the call 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 134 of file class.httpclient.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().

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 160 of file class.httpclient.php.

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

References getWebsiteUrl().

Referenced by ActionAbout\__construct().

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 372 of file class.httpclient.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:

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

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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ checkInternetState()

◆ getApiJson()

◆ getChangelogUrl()

◆ getCurlHttpHeaders()

◆ getFopenHttpHeaders()

◆ getGithubUrl()

◆ getGithubUserUrl()

◆ getHeaders()

◆ getHttpHeaders()

◆ getLatestVersion()

◆ getRemoteFilesize()

◆ getWebsiteUrl()

◆ getWebsiteUrlNoUtm()

◆ setupCurlHeaderWithToken()