Core Class Reference

Public Member Functions
	__construct ()
	__toString ()
	addLoadingPid ($pid)
	getAppVersion ()
	getExec ($aetrayPath=false)
	getFileFromUrl (string $moduleUrl, string $filePath, $progressBar=false)
	getLastPathContent ()
	getLoadingPid ($aetrayPath=false)
	getPreviousExec ()
	setExec ($action)
	unzipFile ($filePath, $destination, $progressCallback=null)

Data Fields
const	APP_VERSION = 'version.dat'
const	EXEC = 'exec.dat'
const	HOSTSEDITOR_EXE = 'hEdit_x64.exe'
const	isRoot_FILE = 'root.php'
const	LAST_PATH = 'lastPath.dat'
const	LN_EXE = 'ln.exe'
const	LOADING_PID = 'loading.pid'
const	NSSM_EXE = 'nssm.exe'
const	OPENSSL_CONF = 'openssl.cfg'
const	OPENSSL_EXE = 'openssl.exe'
const	PATH_LIN_PLACEHOLDER = '~BEARSAMPP_LIN_PATH~'
const	PATH_WIN_PLACEHOLDER = '~BEARSAMPP_WIN_PATH~'
const	PHP_EXE = 'php-win.exe'
const	PWGEN_EXE = "PwTech.exe"
const	SETENV_EXE = 'SetEnv.exe'

Detailed Description

Class Core

This class provides core functionalities and constants for the Bearsampp application. It includes methods for retrieving paths, managing application versions, and handling various executable files and configurations.

Definition at line 18 of file class.core.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Core constructor.

Loads the WinBinder extension if available.

Definition at line 44 of file class.core.php.

    {
        if ( extension_loaded( 'winbinder' ) ) {
            require_once Path::getLibsPath() . '/winbinder/winbinder.php';
        }
    }

References Path\getLibsPath().

Here is the call graph for this function:

Member Function Documentation

__toString()

__toString

(

)

Provides a string representation of the core object.

Returns

string A string describing the core object.

Definition at line 143 of file class.core.php.

    {
        return 'core object';
    }

addLoadingPid()

addLoadingPid

(

$pid

)

Adds a PID to the loading PID file.

Parameters

int

$pid

The PID to add.

Definition at line 133 of file class.core.php.

    {
        file_put_contents( $this->getLoadingPid(), $pid . PHP_EOL, FILE_APPEND );
    }

References getLoadingPid().

Here is the call graph for this function:

getAppVersion()

getAppVersion

(

)

Retrieves the application version.

Returns

string|null The application version or null if not found.

Definition at line 56 of file class.core.php.

    {
        global $bearsamppLang;
 
        $filePath = Path::getResourcesPath() . '/' . self::APP_VERSION;
        if ( !is_file( $filePath ) ) {
            Log::error( sprintf( $bearsamppLang->getValue( Lang::ERROR_CONF_NOT_FOUND ), APP_TITLE, $filePath ) );
 
            return null;
        }
 
        return trim( file_get_contents( $filePath ) );
    }

References $bearsamppLang, APP_TITLE, Log\error(), Lang\ERROR_CONF_NOT_FOUND, and Path\getResourcesPath().

Here is the call graph for this function:

getExec()

getExec

(

$aetrayPath = false

)

Retrieves the path to the exec file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the exec file.

Definition at line 101 of file class.core.php.

    {
        return Path::getTmpPath( $aetrayPath ) . '/' . self::EXEC;
    }

References Path\getTmpPath().

Referenced by getPreviousExec(), and setExec().

Here is the call graph for this function:

Here is the caller graph for this function:

getFileFromUrl()

getFileFromUrl	(	string	$moduleUrl,
		string	$filePath,
			$progressBar = false )

Fetches a file from a given URL and saves it to a specified file path.

This method attempts to retrieve the content from the provided URL and save it to the specified file path. If any error occurs during fetching or saving, it logs the error and returns an error message. If the operation is successful, it returns the file path. The method also logs the file size if the input stream is a valid resource.

Parameters

string	$moduleUrl	The URL from which to fetch the file content.
string	$filePath	The path where the file content should be saved.
bool	$progressBar	Optional. Whether to display a progress bar during the download process. Default is false.

Returns

array Returns the file path if successful, or an array with an error message if an error occurs.

Definition at line 253 of file class.core.php.

    {
        // Open the URL for reading
        $inputStream = @fopen( $moduleUrl, 'rb' );
        if ( $inputStream === false ) {
            Log::error( 'Error fetching content from URL: ' . $moduleUrl );
 
            return ['error' => 'Error fetching module'];
        }
 
        // Open the file for writing
        $outputStream = @fopen( $filePath, 'wb' );
        if ( $outputStream === false ) {
            Log::error( 'Error opening file for writing: ' . $filePath );
            fclose( $inputStream );
 
            return ['error' => 'Error saving module'];
        }
 
        // Read and write in chunks to avoid memory overload
        $bufferSize = 8096; // 8KB
        $chunksRead = 0;
 
        while ( !feof( $inputStream ) ) {
            $buffer = fread( $inputStream, $bufferSize );
            fwrite( $outputStream, $buffer );
            $chunksRead++;
 
            // Send progress update
            if ( $progressBar ) {
                $progress = $chunksRead;
                echo json_encode( ['progress' => $progress] ) . PHP_EOL;
 
                // Check if output buffering is active before calling ob_flush()
                if ( ob_get_length() !== false ) {
                    ob_flush();
                }
                flush();
            }
        }
 
        fclose( $inputStream );
        fclose( $outputStream );
 
        return ['success' => true];
    }

References Log\error().

Here is the call graph for this function:

getLastPathContent()

getLastPathContent

(

)

Retrieves the content of the last path file.

Returns

string|false The content of the last path file or false on failure.

Definition at line 75 of file class.core.php.

    {
        return @file_get_contents( Path::getLastPath() );
    }

References Path\getLastPath().

Here is the call graph for this function:

getLoadingPid()

getLoadingPid

(

$aetrayPath = false

)

Retrieves the path to the loading PID file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the loading PID file.

Definition at line 123 of file class.core.php.

    {
        return Path::getResourcesPath( $aetrayPath ) . '/' . self::LOADING_PID;
    }

References Path\getResourcesPath().

Referenced by addLoadingPid().

Here is the call graph for this function:

Here is the caller graph for this function:

getPreviousExec()

getPreviousExec

(

)

Retrieves the content of the exec file without unlinking it.

Returns

string|false The content of the exec file or false if it doesn't exist.

Definition at line 85 of file class.core.php.

    {
        $file = $this->getExec();
        if (file_exists($file)) {
            return trim(file_get_contents($file));
        }
        return false;
    }

References getExec().

Here is the call graph for this function:

setExec()

setExec

(

$action

)

Sets the content of the exec file.

Parameters

string

$action

The content to set in the exec file.

Definition at line 111 of file class.core.php.

    {
        file_put_contents( $this->getExec(), $action );
    }

References getExec().

Here is the call graph for this function:

unzipFile()

unzipFile	(		$filePath,
			$destination,
			$progressCallback = null )

Unzips a file to the specified directory and provides progress updates.

This method uses the 7-Zip command-line tool to extract the contents of a zip file. It first tests the archive to determine the number of files to be extracted, then proceeds with the extraction while providing progress updates via a callback function.

Parameters

string	$filePath	The path to the zip file.
string	$destination	The directory to extract the files to.
callable | null	$progressCallback	A callback function to report progress. The callback receives two parameters: int $currentFile: The current file number being extracted. int $totalFiles: The total number of files to be extracted.

@global object $bearsamppRoot Global object to get core paths.

Returns

array|false An array containing the result of the extraction on success or failure:

• On success: ['success' => true, 'numFiles' => int]
• On failure: ['error' => string, 'numFiles' => int]
• Returns false if the 7-Zip executable is not found.

Definition at line 168 of file class.core.php.

    {
        global $bearsamppRoot;
 
        $sevenZipPath = Path::getLibsPath() . '/7zip/7za.exe';
 
        if ( !file_exists( $sevenZipPath ) ) {
            Log::error( '7za.exe not found at: ' . $sevenZipPath );
 
            return false;
        }
 
        if ($progressCallback) {
            call_user_func($progressCallback, 'Initializing archive test...');
        }
 
        // Test the archive to determine the number of files
        if ($progressCallback) {
            call_user_func($progressCallback, 'Analyzing archive...');
        }
        $testOutput = CommandRunner::exec($sevenZipPath, ['t', $filePath, '-y', '-bsp1']);
        preg_match('/Files: (\d+)/', $testOutput !== false ? $testOutput : '', $matches);
        $numFiles = isset($matches[1]) ? (int) $matches[1] : 0;
        Log::trace('Number of files to be extracted: ' . $numFiles);
 
        if ($progressCallback) {
            call_user_func($progressCallback, 'Initializing extraction...');
        }
        // Extract the archive, streaming progress line-by-line
        $returnVar = CommandRunner::stream(
            $sevenZipPath,
            ['x', $filePath, '-y', '-bsp1', '-bb0', '-o' . $destination],
            function (string $line) use ($progressCallback) {
                Log::trace("Processing line: $line");
                if ($line === 'Everything is Ok') {
                    if ($progressCallback) {
                        Log::trace('Extraction progress: 100%');
                        call_user_func($progressCallback, 100);
                    }
                } elseif ($progressCallback && preg_match('/(?:^|\s)(\d+)%/', $line, $matches)) {
                    $currentPercentage = intval($matches[1]);
                    Log::trace("Extraction progress: $currentPercentage%");
                    call_user_func($progressCallback, $currentPercentage);
                } else {
                    Log::trace("Line did not match pattern: $line");
                }
            }
        );
 
        if ($returnVar === false) {
            Log::error('Failed to open process for: ' . $sevenZipPath);
            return ['error' => 'Failed to open process', 'numFiles' => $numFiles];
        }
 
        Log::trace('Command return value: ' . $returnVar);
 
        if ($returnVar === 0 && $progressCallback) {
            Log::trace('Extraction completed successfully. Setting progress to 100%');
            call_user_func($progressCallback, 100);
            usleep(100000); // 100 milliseconds
        }
 
        if ($returnVar === 0) {
            Log::debug('Successfully unzipped file to: ' . $destination);
            return ['success' => true, 'numFiles' => $numFiles];
        }
 
        Log::error('Failed to unzip file. Command return value: ' . $returnVar);
        return ['error' => 'Failed to unzip file', 'numFiles' => $numFiles];
    }

References $bearsamppRoot, Log\debug(), Log\error(), CommandRunner\exec(), Path\getLibsPath(), CommandRunner\stream(), and Log\trace().

Here is the call graph for this function:

Field Documentation

APP_VERSION

const APP_VERSION = 'version.dat'

Definition at line 34 of file class.core.php.

EXEC

const EXEC = 'exec.dat'

Definition at line 36 of file class.core.php.

HOSTSEDITOR_EXE

const HOSTSEDITOR_EXE = 'hEdit_x64.exe'

Definition at line 30 of file class.core.php.

Referenced by Path\getHostsEditorExe().

isRoot_FILE

const isRoot_FILE = 'root.php'

Definition at line 21 of file class.core.php.

Referenced by Batch\exitApp(), TplApp\getActionRun(), Path\getisRootFilePath(), and Util\startLoading().

LAST_PATH

const LAST_PATH = 'lastPath.dat'

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

Referenced by Path\getLastPath().

LN_EXE

const LN_EXE = 'ln.exe'

Definition at line 31 of file class.core.php.

Referenced by Path\getLnExe().

LOADING_PID

const LOADING_PID = 'loading.pid'

Definition at line 37 of file class.core.php.

NSSM_EXE

const NSSM_EXE = 'nssm.exe'

Definition at line 27 of file class.core.php.

Referenced by Path\getNssmExe().

OPENSSL_CONF

const OPENSSL_CONF = 'openssl.cfg'

Definition at line 29 of file class.core.php.

Referenced by Path\getOpenSslConf().

OPENSSL_EXE

const OPENSSL_EXE = 'openssl.exe'

Definition at line 28 of file class.core.php.

Referenced by Path\getOpenSslExe().

PATH_LIN_PLACEHOLDER

const PATH_LIN_PLACEHOLDER = '~BEARSAMPP_LIN_PATH~'

Definition at line 23 of file class.core.php.

Referenced by Path\changePath().

PATH_WIN_PLACEHOLDER

const PATH_WIN_PLACEHOLDER = '~BEARSAMPP_WIN_PATH~'

Definition at line 22 of file class.core.php.

Referenced by Path\changePath().

PHP_EXE

const PHP_EXE = 'php-win.exe'

Definition at line 25 of file class.core.php.

Referenced by Path\getPhpExe().

PWGEN_EXE

const PWGEN_EXE = "PwTech.exe"

Definition at line 32 of file class.core.php.

Referenced by Path\getPwgenExe().

SETENV_EXE

const SETENV_EXE = 'SetEnv.exe'

Definition at line 26 of file class.core.php.

Referenced by Path\getSetEnvExe().

---

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

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