Batch Class Reference

Public Member Functions
	__construct ()

Static Public Member Functions
static	createSymlink ($src, $dest)
static	exec ($basename, $content, $timeout=true, $catchOutput=true, $standalone=false, $silent=true, $rebuild=true)
static	execStandalone ($basename, $content, $silent=true)
static	exitApp ($restart=false)
static	findExeByPid ($pid)
static	getOsInfo ()
static	getPearVersion ()
static	getProcessUsingPort ($port)
static	initializeMariadb ($path)
static	initializeMysql ($path)
static	initializePostgresql ($path)
static	installPostgresqlService ()
static	refreshEnvVars ()
static	removeSymlink ($link)
static	restartApp ()
static	setServiceDescription ($serviceName, $desc)
static	setServiceDisplayName ($serviceName, $displayName)
static	setServiceStartType ($serviceName, $startType)
static	uninstallPostgresqlService ()

Data Fields
const	CATCH_OUTPUT_FALSE = 'bearsamppCatchOutputFalse'
const	END_PROCESS_STR = 'FINISHED!'

Static Private Member Functions
static	getTmpFile ($ext, $customName=null)
static	writeLog ($log)

Detailed Description

Class Batch

This class provides various utility functions for managing processes, services, and environment variables within the Bearsampp application. It includes methods for finding executables by process ID, checking which process is using a specific port, exiting and restarting the application, managing services, and executing batch scripts.

Key functionalities include:

• Finding executables by process ID.
• Checking which process is using a specific port.
• Exiting and restarting the application.
• Managing services (installing, uninstalling, setting descriptions, etc.).
• Executing batch scripts with optional output capture and timeout.
• Refreshing environment variables.
• Creating and removing symbolic links.
• Retrieving operating system information.

The class utilizes global variables to access application settings and paths, and logs operations for debugging purposes.

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

Constructor & Destructor Documentation

__construct()

__construct

(

)

Constructor for the Batch class.

Definition at line 38 of file class.batch.php.

    {
    }

Member Function Documentation

createSymlink()

createSymlink ( $src, $dest )

static

Creates a symbolic link.

Parameters

string	$src	The source path.
string	$dest	The destination path.

Definition at line 268 of file class.batch.php.

    {
        global $bearsamppCore;
        $src = Util::formatWindowsPath($src);
        $dest = Util::formatWindowsPath($dest);
        self::exec('createSymlink', '"' . $bearsamppCore->getLnExe() . '" --absolute --symbolic --traditional --1023safe "' . $src . '" ' . '"' . $dest . '"', true, false);
    }

References $bearsamppCore, exec(), and Util\formatWindowsPath().

Referenced by Module\createSymlink().

exec()

exec ( $basename, $content, $timeout = true, $catchOutput = true, $standalone = false, $silent = true, $rebuild = true )

static

Executes a batch script.

Parameters

string	$basename	The base name for the script and result files.
string	$content	The content of the batch script.
int | bool	$timeout	The timeout for the script execution in seconds, or true for default timeout, or false for no timeout.
bool	$catchOutput	Whether to capture the output of the script.
bool	$standalone	Whether the script is standalone.
bool	$silent	Whether to execute the script silently.
bool	$rebuild	Whether to rebuild the result array.

Returns

array|false The result of the execution, or false on failure.

Definition at line 432 of file class.batch.php.

    {
        global $bearsamppConfig, $bearsamppWinbinder;
        $result = false;
 
        $resultFile = self::getTmpFile('.tmp', $basename);
        $scriptPath = self::getTmpFile('.bat', $basename);
        $checkFile = self::getTmpFile('.tmp', $basename);
 
        // Redirect output
        if ($catchOutput) {
            $content .= '> "' . $resultFile . '"' . (!Util::endWith($content, '2') ? ' 2>&1' : '');
        }
 
        // Header
        $header = '@ECHO OFF' . PHP_EOL . PHP_EOL;
 
        // Footer
        $footer = PHP_EOL . (!$standalone ? PHP_EOL . 'ECHO ' . self::END_PROCESS_STR . ' > "' . $checkFile . '"' : '');
 
        // Process
        file_put_contents($scriptPath, $header . $content . $footer);
        $bearsamppWinbinder->exec($scriptPath, null, $silent);
 
        if (!$standalone) {
            $timeout = is_numeric($timeout) ? $timeout : ($timeout === true ? $bearsamppConfig->getScriptsTimeout() : false);
            $maxtime = time() + $timeout;
            $noTimeout = $timeout === false;
            while ($result === false || empty($result)) {
                if (file_exists($checkFile)) {
                    $check = file($checkFile);
                    if (!empty($check) && trim($check[0]) == self::END_PROCESS_STR) {
                        if ($catchOutput && file_exists($resultFile)) {
                            $result = file($resultFile);
                        } else {
                            $result = self::CATCH_OUTPUT_FALSE;
                        }
                    }
                }
                if ($maxtime < time() && !$noTimeout) {
                    break;
                }
            }
        }
 
        self::writeLog('Exec:');
        self::writeLog('-> basename: ' . $basename);
        self::writeLog('-> content: ' . str_replace(PHP_EOL, ' \\\\ ', $content));
        self::writeLog('-> checkFile: ' . $checkFile);
        self::writeLog('-> resultFile: ' . $resultFile);
        self::writeLog('-> scriptPath: ' . $scriptPath);
 
        if ($result !== false && !empty($result) && is_array($result)) {
            if ($rebuild) {
                $rebuildResult = array();
                foreach ($result as $row) {
                    $row = trim($row);
                    if (!empty($row)) {
                        $rebuildResult[] = $row;
                    }
                }
                $result = $rebuildResult;
            }
            self::writeLog('-> result: ' . substr(implode(' \\\\ ', $result), 0, 2048));
        } else {
            self::writeLog('-> result: N/A');
        }
 
        return $result;
    }

References $bearsamppConfig, $result, Util\endWith(), getTmpFile(), and writeLog().

Referenced by OpenSsl\createCrt(), createSymlink(), Nssm\exec(), execStandalone(), findExeByPid(), BinApache\getCmdLineOutput(), BinMariadb\getCmdLineOutput(), BinMysql\getCmdLineOutput(), BinPostgresql\getCmdLineOutput(), getOsInfo(), getPearVersion(), getProcessUsingPort(), BinMariadb\initData(), initializeMariadb(), initializeMysql(), initializePostgresql(), installPostgresqlService(), removeSymlink(), setServiceDescription(), setServiceDisplayName(), setServiceStartType(), and uninstallPostgresqlService().

execStandalone()

execStandalone ( $basename, $content, $silent = true )

static

Executes a standalone batch script.

Parameters

string	$basename	The base name for the script and result files.
string	$content	The content of the batch script.
bool	$silent	Whether to execute the script silently.

Returns

array|false The result of the execution, or false on failure.

Definition at line 415 of file class.batch.php.

    {
        return self::exec($basename, $content, false, false, true, $silent);
    }

References exec().

Referenced by exitApp(), and refreshEnvVars().

exitApp()

exitApp ( $restart = false )

static

Exits the application, optionally restarting it.

Parameters

bool

$restart

Whether to restart the application after exiting.

Definition at line 120 of file class.batch.php.

    {
        global $bearsamppRoot, $bearsamppCore;
 
        $content = 'PING 1.1.1.1 -n 1 -w 2000 > nul' . PHP_EOL;
        $content .= '"' . $bearsamppRoot->getExeFilePath() . '" -quit -id={bearsampp}' . PHP_EOL;
        if ($restart) {
            $basename = 'restartApp';
            Util::logInfo('Restart App');
            $content .= '"' . $bearsamppCore->getPhpExe() . '" "' . Core::isRoot_FILE . '" "' . Action::RESTART . '"' . PHP_EOL;
        } else {
            $basename = 'exitApp';
            Util::logInfo('Exit App');
        }
 
        Win32Ps::killBins();
        self::execStandalone($basename, $content);
    }

References $bearsamppCore, $bearsamppRoot, execStandalone(), Core\isRoot_FILE, Win32Ps\killBins(), Util\logInfo(), and Action\RESTART.

Referenced by ActionExec\__construct(), and restartApp().

findExeByPid()

findExeByPid ( $pid )

static

Finds the executable name by its process ID (PID).

Parameters

int

$pid

The process ID to search for.

Returns

string|false The executable name if found, false otherwise.

Definition at line 59 of file class.batch.php.

    {
        // Sanitize PID to prevent command injection
        $sanitizedPid = Util::sanitizePID($pid);
        if ($sanitizedPid === false) {
            self::writeLog('Invalid PID provided to findExeByPid: ' . var_export($pid, true));
            return false;
        }
 
        $result = self::exec('findExeByPid', 'TASKLIST /FO CSV /NH /FI "PID eq ' . $sanitizedPid . '"', 5);
        if ($result !== false) {
            $expResult = explode('","', $result[0]);
            if (is_array($expResult) && count($expResult) > 2 && isset($expResult[0]) && !empty($expResult[0])) {
                return substr($expResult[0], 1);
            }
        }
 
        return false;
    }

References $result, exec(), Util\sanitizePID(), and writeLog().

Referenced by getProcessUsingPort().

getOsInfo()

getOsInfo ( )

static

Gets the operating system information.

Returns

string The operating system information.

Definition at line 322 of file class.batch.php.

    {
        $result = self::exec('getOsInfo', 'ver', 5);
        if (is_array($result)) {
            foreach ($result as $row) {
                if (Util::startWith($row, 'Microsoft')) {
                    return trim($row);
                }
            }
        }
        return '';
    }

References $result, exec(), and Util\startWith().

Referenced by ActionStartup\sysInfos().

getPearVersion()

getPearVersion ( )

static

Gets the version of PEAR installed.

Returns

string|null The PEAR version if found, null otherwise.

Definition at line 152 of file class.batch.php.

    {
        global $bearsamppBins;
 
        $result = self::exec('getPearVersion', 'CMD /C "' . $bearsamppBins->getPhp()->getPearExe() . '" -V', 5);
        if (is_array($result)) {
            foreach ($result as $row) {
                if (Util::startWith($row, 'PEAR Version:')) {
                    $expResult = explode(' ', $row);
                    if (count($expResult) == 3) {
                        return trim($expResult[2]);
                    }
                }
            }
        }
 
        return null;
    }

References $bearsamppBins, $result, exec(), and Util\startWith().

Referenced by BinPhp\getPearVersion().

getProcessUsingPort()

getProcessUsingPort ( $port )

static

Gets the process using a specific port.

Parameters

int

$port

The port number to check.

Returns

string|int|null The executable name and PID if found, the PID if executable not found, or null if no process is using the port.

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

    {
        // Sanitize port to prevent command injection
        $sanitizedPort = Util::sanitizePort($port);
        if ($sanitizedPort === false) {
            self::writeLog('Invalid port provided to getProcessUsingPort: ' . var_export($port, true));
            return null;
        }
 
        $result = self::exec('getProcessUsingPort', 'NETSTAT -aon', 4);
        if ($result !== false) {
            foreach ($result as $row) {
                if (!Util::startWith($row, 'TCP')) {
                    continue;
                }
                $rowExp = explode(' ', preg_replace('/\s+/', ' ', $row));
                if (count($rowExp) == 5 && Util::endWith($rowExp[1], ':' . $sanitizedPort) && $rowExp[3] == 'LISTENING') {
                    $pid = intval($rowExp[4]);
                    $exe = self::findExeByPid($pid);
                    if ($exe !== false) {
                        return $exe . ' (' . $pid . ')';
                    }
                    return $pid;
                }
            }
        }
 
        return null;
    }

References $port, $result, Util\endWith(), exec(), findExeByPid(), Util\sanitizePort(), Util\startWith(), and writeLog().

Referenced by Util\isPortInUse().

getTmpFile()

getTmpFile ( $ext, $customName = null )

staticprivate

Gets a temporary file path with a specified extension and optional custom name.

Parameters

string	$ext	The file extension.
string | null	$customName	An optional custom name for the file.

Returns

string The temporary file path.

Definition at line 510 of file class.batch.php.

    {
        global $bearsamppCore;
        return Util::formatWindowsPath($bearsamppCore->getTmpPath() . '/' . (!empty($customName) ? $customName . '-' : '') . Util::random() . $ext);
    }

References $bearsamppCore, Util\formatWindowsPath(), and Util\random().

Referenced by exec().

initializeMariadb()

initializeMariadb ( $path )

static

Initializes MariaDB using a specified path.

Parameters

string

$path

The path to the MariaDB initialization script.

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

    {
        if (!file_exists($path . '/init.bat')) {
            Util::logWarning($path . '/init.bat does not exist');
            return;
        }
        self::exec('initializeMariadb', 'CMD /C "' . $path . '/init.bat"', 60);
    }

References exec(), and Util\logWarning().

Referenced by BinMariadb\initData().

initializeMysql()

initializeMysql ( $path )

static

Initializes MySQL using a specified path.

Parameters

string

$path

The path to the MySQL initialization script.

Definition at line 185 of file class.batch.php.

    {
        if (!file_exists($path . '/init.bat')) {
            Util::logWarning($path . '/init.bat does not exist');
            return;
        }
        self::exec('initializeMysql', 'CMD /C "' . $path . '/init.bat"', 60);
    }

References exec(), and Util\logWarning().

Referenced by BinMysql\initData().

initializePostgresql()

initializePostgresql ( $path )

static

Initializes PostgreSQL using a specified path.

Parameters

string

$path

The path to the PostgreSQL initialization script.

Definition at line 239 of file class.batch.php.

    {
        if (!file_exists($path . '/init.bat')) {
            Util::logWarning($path . '/init.bat does not exist');
            return;
        }
        self::exec('initializePostgresql', 'CMD /C "' . $path . '/init.bat"', 15);
    }

References exec(), and Util\logWarning().

Referenced by BinPostgresql\initData().

installPostgresqlService()

installPostgresqlService ( )

static

Installs the PostgreSQL service.

Returns

bool True if the service was installed successfully, false otherwise.

Definition at line 199 of file class.batch.php.

    {
        global $bearsamppBins;
 
        $cmd = '"' . Util::formatWindowsPath($bearsamppBins->getPostgresql()->getCtlExe()) . '" register -N "' . BinPostgresql::SERVICE_NAME . '"';
        $cmd .= ' -U "LocalSystem" -D "' . Util::formatWindowsPath($bearsamppBins->getPostgresql()->getSymlinkPath()) . '\\data"';
        $cmd .= ' -l "' . Util::formatWindowsPath($bearsamppBins->getPostgresql()->getErrorLog()) . '" -w';
        self::exec('installPostgresqlService', $cmd, true, false);
 
        if (!$bearsamppBins->getPostgresql()->getService()->isInstalled()) {
            return false;
        }
 
        self::setServiceDisplayName(BinPostgresql::SERVICE_NAME, $bearsamppBins->getPostgresql()->getService()->getDisplayName());
        self::setServiceDescription(BinPostgresql::SERVICE_NAME, $bearsamppBins->getPostgresql()->getService()->getDisplayName());
        self::setServiceStartType(BinPostgresql::SERVICE_NAME, "demand");
 
        return true;
    }

References $bearsamppBins, exec(), Util\formatWindowsPath(), BinPostgresql\SERVICE_NAME, setServiceDescription(), setServiceDisplayName(), and setServiceStartType().

Referenced by Win32Service\create().

refreshEnvVars()

refreshEnvVars ( )

static

Refreshes the environment variables.

Definition at line 174 of file class.batch.php.

    {
        global $bearsamppRoot, $bearsamppCore;
        self::execStandalone('refreshEnvVars', '"' . $bearsamppCore->getSetEnvExe() . '" -a ' . Registry::APP_PATH_REG_ENTRY . ' "' . Util::formatWindowsPath($bearsamppRoot->getRootPath()) . '"');
    }

References $bearsamppCore, $bearsamppRoot, Registry\APP_PATH_REG_ENTRY, execStandalone(), and Util\formatWindowsPath().

Referenced by Registry\setValue().

removeSymlink()

removeSymlink ( $link )

static

Removes a symbolic link.

Parameters

string

$link

The path to the symbolic link.

Returns

bool True if the symlink was removed successfully, false otherwise.

Definition at line 282 of file class.batch.php.

    {
        if (!file_exists($link)) {
            self::writeLog('-> removeSymlink: Link does not exist: ' . $link);
            return true; // If the link doesn't exist, nothing to do
        }
 
        // Check if it's a directory symlink
        $isDirectory = is_dir($link);
        $formattedLink = Util::formatWindowsPath($link);
 
        try {
            // Use different commands based on whether it's a directory or file symlink
            if ($isDirectory) {
                // For directory symlinks
                self::exec('removeSymlink', 'rmdir /Q "' . $formattedLink . '"', true, false);
            } else {
                // For file symlinks
                self::exec('removeSymlink', 'del /F /Q "' . $formattedLink . '"', true, false);
            }
 
            // Check if removal was successful
            if (file_exists($link)) {
                self::writeLog('-> removeSymlink: Failed to remove symlink: ' . $link);
                return false;
            }
 
            self::writeLog('-> removeSymlink: Successfully removed symlink: ' . $link);
            return true;
        } catch (Exception $e) {
            self::writeLog('-> removeSymlink: Exception: ' . $e->getMessage());
            return false;
        }
    }

References exec(), Util\formatWindowsPath(), and writeLog().

Referenced by Module\createSymlink().

restartApp()

restartApp ( )

static

Restarts the application.

Definition at line 142 of file class.batch.php.

    {
        self::exitApp(true);
    }

References exitApp().

Referenced by ActionExec\__construct().

setServiceDescription()

setServiceDescription ( $serviceName, $desc )

static

Sets the description of a service.

Parameters

string	$serviceName	The name of the service.
string	$desc	The description to set.

Definition at line 364 of file class.batch.php.

    {
        // Sanitize service name to prevent command injection
        $sanitizedName = Util::sanitizeServiceName($serviceName);
        if ($sanitizedName === false) {
            self::writeLog('Invalid service name provided to setServiceDescription: ' . $serviceName);
            return;
        }
 
        // Remove quotes and dangerous characters from description
        $sanitizedDesc = str_replace('"', '', $desc);
        $sanitizedDesc = preg_replace('/[<>|&^]/', '', $sanitizedDesc);
 
        $cmd = 'sc description ' . $sanitizedName . ' "' . $sanitizedDesc . '"';
        self::exec('setServiceDescription', $cmd, true, false);
    }

References exec(), Util\sanitizeServiceName(), and writeLog().

Referenced by installPostgresqlService().

setServiceDisplayName()

setServiceDisplayName ( $serviceName, $displayName )

static

Sets the display name of a service.

Parameters

string	$serviceName	The name of the service.
string	$displayName	The display name to set.

Definition at line 341 of file class.batch.php.

    {
        // Sanitize service name to prevent command injection
        $sanitizedName = Util::sanitizeServiceName($serviceName);
        if ($sanitizedName === false) {
            self::writeLog('Invalid service name provided to setServiceDisplayName: ' . $serviceName);
            return;
        }
 
        // Remove quotes and dangerous characters from display name
        $sanitizedDisplayName = str_replace('"', '', $displayName);
        $sanitizedDisplayName = preg_replace('/[<>|&^]/', '', $sanitizedDisplayName);
 
        $cmd = 'sc config ' . $sanitizedName . ' DisplayName= "' . $sanitizedDisplayName . '"';
        self::exec('setServiceDisplayName', $cmd, true, false);
    }

References exec(), Util\sanitizeServiceName(), and writeLog().

Referenced by installPostgresqlService().

setServiceStartType()

setServiceStartType ( $serviceName, $startType )

static

Sets the start type of a service.

Parameters

string	$serviceName	The name of the service.
string	$startType	The start type to set (e.g., "auto", "demand").

Definition at line 387 of file class.batch.php.

    {
        // Sanitize service name to prevent command injection
        $sanitizedName = Util::sanitizeServiceName($serviceName);
        if ($sanitizedName === false) {
            self::writeLog('Invalid service name provided to setServiceStartType: ' . $serviceName);
            return;
        }
 
        // Validate start type (only allow known values)
        $allowedStartTypes = ['auto', 'demand', 'disabled', 'delayed-auto'];
        if (!in_array(strtolower($startType), $allowedStartTypes, true)) {
            self::writeLog('Invalid start type provided: ' . $startType);
            return;
        }
 
        $cmd = 'sc config ' . $sanitizedName . ' start= ' . strtolower($startType);
        self::exec('setServiceStartType', $cmd, true, false);
    }

References exec(), Util\sanitizeServiceName(), and writeLog().

Referenced by installPostgresqlService().

uninstallPostgresqlService()

uninstallPostgresqlService ( )

static

Uninstalls the PostgreSQL service.

Returns

bool True if the service was uninstalled successfully, false otherwise.

Definition at line 224 of file class.batch.php.

    {
        global $bearsamppBins;
 
        $cmd = '"' . Util::formatWindowsPath($bearsamppBins->getPostgresql()->getCtlExe()) . '" unregister -N "' . BinPostgresql::SERVICE_NAME . '"';
        $cmd .= ' -l "' . Util::formatWindowsPath($bearsamppBins->getPostgresql()->getErrorLog()) . '" -w';
        self::exec('uninstallPostgresqlService', $cmd, true, false);
        return !$bearsamppBins->getPostgresql()->getService()->isInstalled();
    }

References $bearsamppBins, exec(), Util\formatWindowsPath(), and BinPostgresql\SERVICE_NAME.

Referenced by Win32Service\delete().

writeLog()

writeLog ( $log )

staticprivate

Writes a log entry to the batch log file.

Parameters

string

$log

The log message to write.

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

    {
        global $bearsamppRoot;
        Util::logDebug($log, $bearsamppRoot->getBatchLogFilePath());
    }

References $bearsamppRoot, and Util\logDebug().

Referenced by exec(), findExeByPid(), getProcessUsingPort(), removeSymlink(), setServiceDescription(), setServiceDisplayName(), and setServiceStartType().

Field Documentation

CATCH_OUTPUT_FALSE

const CATCH_OUTPUT_FALSE = 'bearsamppCatchOutputFalse'

Definition at line 33 of file class.batch.php.

END_PROCESS_STR

const END_PROCESS_STR = 'FINISHED!'

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

---

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

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