class.batch.php

Go to the documentation of this file.

<?php
/*
 * Copyright (c) 2021-2024 Bearsampp
 * License:  GNU General Public License version 3 or later; see LICENSE.txt
 * Author: Bear
 * Website: https://bearsampp.com
 * Github: https://github.com/Bearsampp
 */

class Batch
{
    const END_PROCESS_STR = 'FINISHED!';
    const CATCH_OUTPUT_FALSE = 'bearsamppCatchOutputFalse';

    public function __construct()
    {
    }

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

    public static function findExeByPid($pid)
    {
        // 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;
    }

    public static function getProcessUsingPort($port)
    {
        // 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;
    }

    public static function exitApp($restart = false)
    {
        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);
    }

    public static function restartApp()
    {
        self::exitApp(true);
    }

    public static function getPearVersion()
    {
        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;
    }

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

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

    public static function installPostgresqlService()
    {
        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;
    }

    public static function uninstallPostgresqlService()
    {
        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();
    }

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

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

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

    public static function removeSymlink($link)
    {
        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;
        }
    }

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

    public static function setServiceDisplayName($serviceName, $displayName)
    {
        // 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);
    }

    public static function setServiceDescription($serviceName, $desc)
    {
        // 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);
    }

    public static function setServiceStartType($serviceName, $startType)
    {
        // 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);
    }

    public static function execStandalone($basename, $content, $silent = true)
    {
        return self::exec($basename, $content, false, false, true, $silent);
    }

    public static function exec($basename, $content, $timeout = true, $catchOutput = true, $standalone = false, $silent = true, $rebuild = true)
    {
        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;
    }

    private static function getTmpFile($ext, $customName = null)
    {
        global $bearsamppCore;
        return Util::formatWindowsPath($bearsamppCore->getTmpPath() . '/' . (!empty($customName) ? $customName . '-' : '') . Util::random() . $ext);
    }
}