Core Class Reference

Public Member Functions
	__construct ()
	__toString ()
	addLoadingPid ($pid)
	getAjaxPath ($aetrayPath=false)
	getAppVersion ()
	getExec ($aetrayPath=false)
	getFileFromUrl (string $moduleUrl, string $filePath, $progressBar=false)
	getHomepagePath ($aetrayPath=false)
	getHostsEditorExe ($aetrayPath=false)
	getHostsEditorPath ($aetrayPath=false)
	getIconsPath ($aetrayPath=false)
	getImagesPath ($aetrayPath=false)
	getisRootFilePath ($aetrayPath=false)
	getLangsPath ($aetrayPath=false)
	getLastPath ($aetrayPath=false)
	getLastPathContent ()
	getLibsPath ($aetrayPath=false)
	getLnExe ($aetrayPath=false)
	getLnPath ($aetrayPath=false)
	getLoadingPid ($aetrayPath=false)
	getNssmExe ($aetrayPath=false)
	getNssmPath ($aetrayPath=false)
	getOpenSslConf ($aetrayPath=false)
	getOpenSslExe ($aetrayPath=false)
	getOpenSslPath ($aetrayPath=false)
	getPhpExe ($aetrayPath=false)
	getPhpPath ($aetrayPath=false)
	getPreviousExec ()
	getPwgenExe ($aetrayPath=false)
	getPwgenPath ($aetrayPath=false)
	getResourcesPath ($aetrayPath=false)
	getScript ($type)
	getScriptsPath ($aetrayPath=false)
	getSetEnvExe ($aetrayPath=false)
	getSetEnvPath ($aetrayPath=false)
	getTmpPath ($aetrayPath=false)
	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 = "PWGenPortable.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 $this->getLibsPath() . '/winbinder/winbinder.php';
        }
    }

References getLibsPath().

Member Function Documentation

__toString()

__toString

(

)

Provides a string representation of the core object.

Returns

string A string describing the core object.

Definition at line 467 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 277 of file class.core.php.

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

References getLoadingPid().

getAjaxPath()

getAjaxPath

(

$aetrayPath = false

)

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

    {
        return $this->getHomepagePath( $aetrayPath ) . '/ajax';
    }

References getHomepagePath().

getAppVersion()

getAppVersion

(

)

Retrieves the application version.

Returns

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

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

    {
        global $bearsamppLang;
 
        $filePath = $this->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 getResourcesPath().

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 245 of file class.core.php.

    {
        return $this->getTmpPath( $aetrayPath ) . '/' . self::EXEC;
    }

References getTmpPath().

Referenced by getPreviousExec(), and setExec().

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 567 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] );
 
                // 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().

getHomepagePath()

getHomepagePath

(

$aetrayPath = false

)

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

    {
        return $this->getResourcesPath( $aetrayPath ) . '/homepage';
    }

References getResourcesPath().

Referenced by getAjaxPath().

getHostsEditorExe()

getHostsEditorExe

(

$aetrayPath = false

)

Retrieves the path to the HostsEditor executable.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the HostsEditor executable.

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

    {
        return $this->getHostsEditorPath( $aetrayPath ) . '/' . self::HOSTSEDITOR_EXE;
    }

References getHostsEditorPath().

getHostsEditorPath()

getHostsEditorPath

(

$aetrayPath = false

)

Retrieves the path to the HostsEditor directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the HostsEditor directory.

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

    {
        return $this->getLibsPath( $aetrayPath ) . '/hostseditor';
    }

References getLibsPath().

Referenced by getHostsEditorExe().

getIconsPath()

getIconsPath

(

$aetrayPath = false

)

Retrieves the path to the icons.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the icons.

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

    {
        return $this->getImagesPath($aetrayPath) . '/icons';
    }

References getImagesPath().

getImagesPath()

getImagesPath

(

$aetrayPath = false

)

Retrieves the path to the images.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the images.

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

    {
        global $bearsamppCore;
 
        return $bearsamppCore->getHomepagePath($aetrayPath) . '/img';
    }

References $bearsamppCore.

Referenced by getIconsPath().

getisRootFilePath()

getisRootFilePath

(

$aetrayPath = false

)

Retrieves the path to the root file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the root file.

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

    {
        global $bearsamppRoot;
 
        return $bearsamppRoot->getCorePath( $aetrayPath ) . '/' . self::isRoot_FILE;
    }

References $bearsamppRoot.

getLangsPath()

getLangsPath

(

$aetrayPath = false

)

Retrieves the path to the language files.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the language files.

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

    {
        global $bearsamppRoot;
 
        return $bearsamppRoot->getCorePath( $aetrayPath ) . '/langs';
    }

References $bearsamppRoot.

getLastPath()

getLastPath

(

$aetrayPath = false

)

Retrieves the path to the last path file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the last path file.

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

    {
        return $this->getResourcesPath( $aetrayPath ) . '/' . self::LAST_PATH;
    }

References getResourcesPath().

Referenced by getLastPathContent().

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 219 of file class.core.php.

    {
        return @file_get_contents( $this->getLastPath() );
    }

References getLastPath().

getLibsPath()

getLibsPath

(

$aetrayPath = false

)

Retrieves the path to the libraries.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the libraries.

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

    {
        global $bearsamppRoot;
 
        return $bearsamppRoot->getCorePath( $aetrayPath ) . '/libs';
    }

References $bearsamppRoot.

Referenced by __construct(), getHostsEditorPath(), getLnPath(), getNssmPath(), getOpenSslPath(), getPhpPath(), getPwgenPath(), getSetEnvPath(), and unzipFile().

getLnExe()

getLnExe

(

$aetrayPath = false

)

Retrieves the path to the LN executable.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the LN executable.

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

    {
        return $this->getLnPath( $aetrayPath ) . '/' . self::LN_EXE;
    }

References getLnPath().

getLnPath()

getLnPath

(

$aetrayPath = false

)

Retrieves the path to the LN directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the LN directory.

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

    {
        return $this->getLibsPath( $aetrayPath ) . '/ln';
    }

References getLibsPath().

Referenced by getLnExe().

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 267 of file class.core.php.

    {
        return $this->getResourcesPath( $aetrayPath ) . '/' . self::LOADING_PID;
    }

References getResourcesPath().

Referenced by addLoadingPid().

getNssmExe()

getNssmExe

(

$aetrayPath = false

)

Retrieves the path to the NSSM executable.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the NSSM executable.

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

    {
        return $this->getNssmPath( $aetrayPath ) . '/' . self::NSSM_EXE;
    }

References getNssmPath().

getNssmPath()

getNssmPath

(

$aetrayPath = false

)

Retrieves the path to the NSSM directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the NSSM directory.

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

    {
        return $this->getLibsPath( $aetrayPath ) . '/nssm';
    }

References getLibsPath().

Referenced by getNssmExe().

getOpenSslConf()

getOpenSslConf

(

$aetrayPath = false

)

Retrieves the path to the OpenSSL configuration file.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the OpenSSL configuration file.

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

    {
        return $this->getOpenSslPath( $aetrayPath ) . '/' . self::OPENSSL_CONF;
    }

References getOpenSslPath().

getOpenSslExe()

getOpenSslExe

(

$aetrayPath = false

)

Retrieves the path to the OpenSSL executable.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the OpenSSL executable.

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

    {
        return $this->getOpenSslPath( $aetrayPath ) . '/' . self::OPENSSL_EXE;
    }

References getOpenSslPath().

getOpenSslPath()

getOpenSslPath

(

$aetrayPath = false

)

Retrieves the path to the OpenSSL directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the OpenSSL directory.

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

    {
        return $this->getLibsPath( $aetrayPath ) . '/openssl';
    }

References getLibsPath().

Referenced by getOpenSslConf(), and getOpenSslExe().

getPhpExe()

getPhpExe

(

$aetrayPath = false

)

Retrieves the path to the PHP executable.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the PHP executable.

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

    {
        return $this->getPhpPath( $aetrayPath ) . '/' . self::PHP_EXE;
    }

References getPhpPath().

getPhpPath()

getPhpPath

(

$aetrayPath = false

)

Retrieves the path to the PHP directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the PHP directory.

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

    {
        return $this->getLibsPath( $aetrayPath ) . '/php';
    }

References getLibsPath().

Referenced by getPhpExe().

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 229 of file class.core.php.

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

References getExec().

getPwgenExe()

getPwgenExe

(

$aetrayPath = false

)

Retrieves the path to the PWGen executable.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the PWGen executable.

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

    {
        return $this->getPwgenPath( $aetrayPath ) . '/' . self::PWGEN_EXE;
    }

References getPwgenPath().

getPwgenPath()

getPwgenPath

(

$aetrayPath = false

)

Retrieves the path to the PWGen directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the PWGen directory.

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

    {
        return $this->getLibsPath( $aetrayPath ) . '/pwgen';
    }

References getLibsPath().

Referenced by getPwgenExe().

getResourcesPath()

getResourcesPath

(

$aetrayPath = false

)

Retrieves the path to the resources.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the resources.

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

    {
        global $bearsamppRoot;
 
        return $bearsamppRoot->getCorePath( $aetrayPath ) . '/resources';
    }

References $bearsamppRoot.

Referenced by getAppVersion(), getHomepagePath(), getLastPath(), and getLoadingPid().

getScript()

getScript

(

$type

)

Retrieves the path to a specific script.

Parameters

string

$type

The type of script.

Returns

string The path to the script.

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

    {
        return $this->getScriptsPath() . '/' . $type;
    }

References getScriptsPath().

getScriptsPath()

getScriptsPath

(

$aetrayPath = false

)

Retrieves the path to the scripts.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the scripts.

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

    {
        global $bearsamppRoot;
 
        return $bearsamppRoot->getCorePath( $aetrayPath ) . '/scripts';
    }

References $bearsamppRoot.

Referenced by getScript().

getSetEnvExe()

getSetEnvExe

(

$aetrayPath = false

)

Retrieves the path to the SetEnv executable.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the SetEnv executable.

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

    {
        return $this->getSetEnvPath( $aetrayPath ) . '/' . self::SETENV_EXE;
    }

References getSetEnvPath().

getSetEnvPath()

getSetEnvPath

(

$aetrayPath = false

)

Retrieves the path to the SetEnv directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the SetEnv directory.

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

    {
        return $this->getLibsPath( $aetrayPath ) . '/setenv';
    }

References getLibsPath().

Referenced by getSetEnvExe().

getTmpPath()

getTmpPath

(

$aetrayPath = false

)

Retrieves the path to the temporary directory.

Parameters

bool

$aetrayPath

Whether to format the path for AeTrayMenu.

Returns

string The path to the temporary directory.

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

    {
        global $bearsamppRoot;
 
        return $bearsamppRoot->getCorePath( $aetrayPath ) . '/tmp';
    }

References $bearsamppRoot.

Referenced by getExec().

setExec()

setExec

(

$action

)

Sets the content of the exec file.

Parameters

string

$action

The content to set in the exec file.

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

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

References getExec().

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 492 of file class.core.php.

    {
        global $bearsamppRoot;
 
        $sevenZipPath = $this->getLibsPath() . '/7zip/7za.exe';
 
        if ( !file_exists( $sevenZipPath ) ) {
            Log::error( '7za.exe not found at: ' . $sevenZipPath );
 
            return false;
        }
 
        // Test the archive to determine the number of files
        $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);
 
        // 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(), getLibsPath(), CommandRunner\stream(), and Log\trace().

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.

isRoot_FILE

const isRoot_FILE = 'root.php'

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

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

LAST_PATH

const LAST_PATH = 'lastPath.dat'

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

LN_EXE

const LN_EXE = 'ln.exe'

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

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.

OPENSSL_CONF

const OPENSSL_CONF = 'openssl.cfg'

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

OPENSSL_EXE

const OPENSSL_EXE = 'openssl.exe'

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

PATH_LIN_PLACEHOLDER

const PATH_LIN_PLACEHOLDER = '~BEARSAMPP_LIN_PATH~'

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

Referenced by Util\changePath().

PATH_WIN_PLACEHOLDER

const PATH_WIN_PLACEHOLDER = '~BEARSAMPP_WIN_PATH~'

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

Referenced by Util\changePath().

PHP_EXE

const PHP_EXE = 'php-win.exe'

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

PWGEN_EXE

const PWGEN_EXE = "PWGenPortable.exe"

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

SETENV_EXE

const SETENV_EXE = 'SetEnv.exe'

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

---

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

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