Public Member Functions
	__construct ($name)
	create ()
	delete ()
	ensureReset ()
	fastServiceCheck ()
	getBinPath ()
	getDisplayName ()
	getError ()
	getErrorControl ()
	getLatestError ()
	getLatestStatus ()
	getName ()
	getNssm ()
	getParams ()
	getStartType ()
	infos ()
	isInstalled ()
	isPaused ()
	isPending ($status)
	isRunning ()
	isStopped ()
	reset ()
	restart ()
	setBinPath ($binPath)
	setDisplayName ($displayName)
	setErrorControl ($errorControl)
	setName ($name)
	setNssm ($nssm)
	setParams ($params)
	setStartType ($startType)
	start ()
	status ($timeout=true)
	stop ()
	waitForServiceDeletion ($maxWaitTime=30)

Static Public Member Functions
static	getServices ($forceRefresh=false)
static	getVbsKeys ()

Data Fields
const	PENDING_TIMEOUT = 20
const	SERVER_ERROR_IGNORE = '0'
const	SERVER_ERROR_NORMAL = '1'
const	SERVICE_AUTO_START = '2'
const	SERVICE_DEMAND_START = '3'
const	SERVICE_DISABLED = '4'
const	SERVICE_STATE = 'State'
const	SLEEP_TIME = 100000
const	VBS_DESCRIPTION = 'Description'
const	VBS_DISPLAY_NAME = 'DisplayName'
const	VBS_NAME = 'Name'
const	VBS_PATH_NAME = 'PathName'
const	WIN32_ERROR_ACCESS_DENIED = '5'
const	WIN32_ERROR_CIRCULAR_DEPENDENCY = '423'
const	WIN32_ERROR_DATABASE_DOES_NOT_EXIST = '429'
const	WIN32_ERROR_DEPENDENT_SERVICES_RUNNING = '41B'
const	WIN32_ERROR_DUPLICATE_SERVICE_NAME = '436'
const	WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT = '427'
const	WIN32_ERROR_INSUFFICIENT_BUFFER = '7A'
const	WIN32_ERROR_INVALID_DATA = 'D'
const	WIN32_ERROR_INVALID_HANDLE = '6'
const	WIN32_ERROR_INVALID_LEVEL = '7C'
const	WIN32_ERROR_INVALID_NAME = '7B'
const	WIN32_ERROR_INVALID_PARAMETER = '57'
const	WIN32_ERROR_INVALID_SERVICE_ACCOUNT = '421'
const	WIN32_ERROR_INVALID_SERVICE_CONTROL = '41C'
const	WIN32_ERROR_PATH_NOT_FOUND = '3'
const	WIN32_ERROR_SERVICE_ALREADY_RUNNING = '420'
const	WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL = '425'
const	WIN32_ERROR_SERVICE_DATABASE_LOCKED = '41F'
const	WIN32_ERROR_SERVICE_DEPENDENCY_DELETED = '433'
const	WIN32_ERROR_SERVICE_DEPENDENCY_FAIL = '42C'
const	WIN32_ERROR_SERVICE_DISABLED = '422'
const	WIN32_ERROR_SERVICE_DOES_NOT_EXIST = '424'
const	WIN32_ERROR_SERVICE_EXISTS = '431'
const	WIN32_ERROR_SERVICE_LOGON_FAILED = '42D'
const	WIN32_ERROR_SERVICE_MARKED_FOR_DELETE = '430'
const	WIN32_ERROR_SERVICE_NO_THREAD = '41E'
const	WIN32_ERROR_SERVICE_NOT_ACTIVE = '426'
const	WIN32_ERROR_SERVICE_REQUEST_TIMEOUT = '41D'
const	WIN32_ERROR_SHUTDOWN_IN_PROGRESS = '45B'
const	WIN32_NO_ERROR = '0'
const	WIN32_SERVICE_CONTINUE_PENDING = '5'
const	WIN32_SERVICE_NA = '0'
const	WIN32_SERVICE_PAUSE_PENDING = '6'
const	WIN32_SERVICE_PAUSED = '7'
const	WIN32_SERVICE_RUNNING = '4'
const	WIN32_SERVICE_START_PENDING = '2'
const	WIN32_SERVICE_STOP_PENDING = '3'
const	WIN32_SERVICE_STOPPED = '1'

Private Member Functions
	callWin32Service ($function, $param, $checkError=false)
	getWin32ErrorCodeDesc ($code)
	getWin32ServiceStatusDesc ($status)
	writeLog ($log)

Private Attributes
	$binPath
	$displayName
	$errorControl
	$latestError
	$latestStatus
	$name
	$nssm
	$params
	$startType

Static Private Attributes
static	$loggedFunctions = array()
static	$serviceListCache = null

Detailed Description

Class Win32Service

This class provides an interface to manage Windows services. It includes methods to create, delete, start, stop, and query the status of services. It also handles logging and error reporting for service operations.

Definition at line 17 of file class.win32service.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $name )

Constructor for the Win32Service class.

Parameters

string $name The name of the service.

Definition at line 99 of file class.win32service.php.

    {
        Log::initClass( $this );
        $this->name = $name;
    }

References $name, and Log\initClass().

Here is the call graph for this function:

Member Function Documentation

◆ callWin32Service()

callWin32Service	(	$function,
		$param,
		$checkError = false )

private

Calls a Win32 service function.

Parameters

string	$function	The function name.
mixed	$param	The parameter to pass to the function.
bool	$checkError	Whether to check for errors.

Returns: mixed The result of the function call.

Definition at line 170 of file class.win32service.php.

                                                                           : mixed
    {
        $result = false;
        if ( function_exists( $function ) ) {
            if (!isset(self::$loggedFunctions[$function])) {
                Log::trace('Win32 function: ' . $function . ' exists');
                self::$loggedFunctions[$function] = true;
            }
 
            // Special handling for win32_query_service_status to prevent hanging
            if ($function === 'win32_query_service_status') {
                Log::trace("Using enhanced handling for win32_query_service_status");
 
                // Set a shorter timeout for this specific function
                $originalTimeout = ini_get('max_execution_time');
                set_time_limit(5); // 5 seconds timeout
 
                try {
                    // Ensure proper parameter handling for PHP 8.5.7 compatibility
                    $result = call_user_func($function, $param);
 
                    // Reset the timeout
                    set_time_limit($originalTimeout);
 
                    if ($checkError && $result !== null) {
                        // Convert to int before using dechex for PHP 8.5.7 compatibility
                        $resultInt = is_numeric($result) ? (int)$result : 0;
                        if (dechex($resultInt) != self::WIN32_NO_ERROR) {
                            $this->latestError = dechex($resultInt);
                        }
                    }
                } catch (\Win32ServiceException $e) {
                    // Reset the timeout
                    set_time_limit($originalTimeout);
 
                    Log::trace("Win32ServiceException caught: " . $e->getMessage());
 
                    // Handle "service does not exist" exception
                    if (strpos($e->getMessage(), 'service does not exist') !== false) {
                        Log::trace("Service does not exist exception handled for: " . $param);
                        // Return the appropriate error code for "service does not exist"
                        $result = hexdec(self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST);
                    } else {
                        // For other exceptions, log and return false
                        Log::trace("Unhandled Win32ServiceException: " . $e->getMessage());
                        $result = false;
                    }
                } catch (\Exception $e) {
                    // Reset the timeout
                    set_time_limit($originalTimeout);
 
                    // Catch any other exceptions to prevent application freeze
                    Log::trace("Exception caught in callWin32Service: " . $e->getMessage());
                    $result = false;
                } catch (\Throwable $e) {
                    // Reset the timeout
                    set_time_limit($originalTimeout);
 
                    // Catch any other throwable (PHP 7+) to prevent application freeze
                    Log::trace("Throwable caught in callWin32Service: " . $e->getMessage());
                    $result = false;
                }
            } else {
                // Standard handling for other functions
                try {
                    // Ensure proper parameter handling for PHP 8.5.7 compatibility
                    $result = call_user_func($function, $param);
                    if ($checkError && $result !== null) {
                        // Convert to int before using dechex for PHP 8.5.7 compatibility
                        $resultInt = is_numeric($result) ? (int)$result : 0;
                        if (dechex($resultInt) != self::WIN32_NO_ERROR) {
                            $this->latestError = dechex($resultInt);
                        }
                    }
                } catch (\Win32ServiceException $e) {
                    Log::trace("Win32ServiceException caught: " . $e->getMessage());
 
                    // Handle "service does not exist" exception
                    if (strpos($e->getMessage(), 'service does not exist') !== false) {
                        Log::trace("Service does not exist exception handled for: " . $param);
                        // Return the appropriate error code for "service does not exist"
                        $result = hexdec(self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST);
                    } else {
                        // For other exceptions, log and return false
                        Log::trace("Unhandled Win32ServiceException: " . $e->getMessage());
                        $result = false;
                    }
                } catch (\Exception $e) {
                    // Catch any other exceptions to prevent application freeze
                    Log::trace("Exception caught in callWin32Service: " . $e->getMessage());
                    $result = false;
                } catch (\Throwable $e) {
                    // Catch any other throwable (PHP 7+) to prevent application freeze
                    Log::trace("Throwable caught in callWin32Service: " . $e->getMessage());
                    $result = false;
                }
            }
        } else {
            if (!isset(self::$loggedFunctions[$function])) {
                Log::trace('Win32 function: ' . $function . ' missing');
                self::$loggedFunctions[$function] = true;
            }
        }
        return $result;
    }

References $result, and Log\trace().

Referenced by create(), delete(), start(), status(), and stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

create ( )

Creates the service.

Returns: bool True if the service was created successfully, false otherwise.

Definition at line 382 of file class.win32service.php.

                            : bool
    {
        global $bearsamppBins;
 
        Log::trace("Starting Win32Service::create for service: " . $this->getName());
 
        if ( $this->getName() == BinPostgresql::SERVICE_NAME ) {
            Log::trace("PostgreSQL service detected - using specialized installation");
            $bearsamppBins->getPostgresql()->rebuildConf();
            Log::trace("PostgreSQL configuration rebuilt");
 
            $bearsamppBins->getPostgresql()->initData();
            Log::trace("PostgreSQL data initialized");
 
            $result = Batch::installPostgresqlService();
            Log::trace("PostgreSQL service installation " . ($result ? "succeeded" : "failed"));
            return $result;
        }
 
        if ( $this->getNssm() instanceof Nssm ) {
            Log::trace("Using NSSM for service installation");
 
            // Ensure Tools are loaded before building environment paths
            global $bearsamppTools;
            if (!isset($bearsamppTools)) {
                Log::trace("Tools not loaded, forcing synchronous load");
                Root::loadTools();
            }
 
            global $bearsamppRegistry;
            $nssmEnvPath = $bearsamppRegistry->getAppBinsRegKey( false );
            Log::trace("NSSM environment path (bins): " . $nssmEnvPath);
 
            $nssmEnvPath .= Path::getNssmEnvPaths();
            Log::trace("NSSM environment path (with additional paths): " . $nssmEnvPath);
 
            $nssmEnvPath .= '%SystemRoot%/system32;';
            $nssmEnvPath .= '%SystemRoot%;';
            $nssmEnvPath .= '%SystemRoot%/system32/Wbem;';
            $nssmEnvPath .= '%SystemRoot%/system32/WindowsPowerShell/v1.0';
            Log::trace("NSSM final environment PATH: " . $nssmEnvPath);
 
            $this->getNssm()->setEnvironmentExtra( 'PATH=' . $nssmEnvPath );
            Log::trace("NSSM service parameters:");
            Log::trace("-> Name: " . $this->getNssm()->getName());
            Log::trace("-> DisplayName: " . $this->getNssm()->getDisplayName());
            Log::trace("-> BinPath: " . $this->getNssm()->getBinPath());
            Log::trace("-> Params: " . $this->getNssm()->getParams());
            Log::trace("-> Start: " . $this->getNssm()->getStart());
            Log::trace("-> Stdout: " . $this->getNssm()->getStdout());
            Log::trace("-> Stderr: " . $this->getNssm()->getStderr());
 
            $result = $this->getNssm()->create();
            Log::trace("NSSM service creation " . ($result ? "succeeded" : "failed"));
            if (!$result) {
                Log::trace("NSSM error: " . $this->getNssm()->getLatestError());
            }
            return $result;
        }
 
        Log::trace("Using win32_create_service for service installation");
        $serviceParams = array(
            'service'       => $this->getName(),
            'display'       => $this->getDisplayName(),
            'description'   => $this->getDisplayName(),
            'path'          => $this->getBinPath(),
            'params'        => $this->getParams(),
            'start_type'    => $this->getStartType() != null ? $this->getStartType() : self::SERVICE_DEMAND_START,
            'error_control' => $this->getErrorControl() != null ? $this->getErrorControl() : self::SERVER_ERROR_NORMAL,
        );
 
        Log::trace("win32_create_service parameters:");
        foreach ($serviceParams as $key => $value) {
            Log::trace("-> $key: $value");
        }
 
        $result = $this->callWin32Service( 'win32_create_service', $serviceParams, true );
        // Ensure proper type conversion for PHP 8.5.7 compatibility
        $resultInt = is_numeric($result) ? (int)$result : 0;
        $create = $result !== null ? dechex( $resultInt ) : '0';
        Log::trace("win32_create_service result code: " . $create);
 
        // Retry once if the SCM has the service marked for deletion from a recent delete()
        if ( $create == self::WIN32_ERROR_SERVICE_MARKED_FOR_DELETE ) {
            Log::trace("Service marked for delete, waiting 2s before retry: " . $this->getName());
            usleep( 2000000 );
            $result   = $this->callWin32Service( 'win32_create_service', $serviceParams, true );
            $resultInt = is_numeric($result) ? (int)$result : 0;
            $create   = $result !== null ? dechex( $resultInt ) : '0';
            Log::trace("win32_create_service retry result code: " . $create);
        }
 
        $this->writeLog( 'Create service: ' . $create . ' (status: ' . $this->status() . ')' );
        $this->writeLog( '-> service: ' . $this->getName() );
        $this->writeLog( '-> display: ' . $this->getDisplayName() );
        $this->writeLog( '-> description: ' . $this->getDisplayName() );
        $this->writeLog( '-> path: ' . $this->getBinPath() );
        $this->writeLog( '-> params: ' . $this->getParams() );
        $this->writeLog( '-> start_type: ' . ($this->getStartType() != null ? $this->getStartType() : self::SERVICE_DEMAND_START) );
        $this->writeLog( '-> service: ' . ($this->getErrorControl() != null ? $this->getErrorControl() : self::SERVER_ERROR_NORMAL) );
 
        if ( $create != self::WIN32_NO_ERROR ) {
            Log::trace("Service creation failed with error code: " . $create);
            return false;
        }
        elseif ( !$this->isInstalled() ) {
            Log::trace("Service created but not found as installed");
            $this->latestError = self::WIN32_NO_ERROR;
            return false;
        }
 
        Log::trace("Service created successfully: " . $this->getName());
        return true;
    }

References $bearsamppBins, $result, callWin32Service(), getBinPath(), getDisplayName(), getErrorControl(), getLatestError(), getName(), getNssm(), Path\getNssmEnvPaths(), getParams(), getStartType(), Batch\installPostgresqlService(), isInstalled(), Root\loadTools(), BinPostgresql\SERVICE_NAME, status(), Log\trace(), and writeLog().

Referenced by reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

delete ( )

Deletes the service.

Returns: bool True if the service was deleted successfully, false otherwise.

Definition at line 502 of file class.win32service.php.

                            : bool
    {
        Log::trace("Starting Win32Service::delete for service: " . $this->getName());
        Log::trace("Checking if service is installed: " . $this->getName());
 
        if ( !$this->isInstalled() ) {
            Log::trace("Service is not installed, skipping deletion: " . $this->getName());
            return true;
        }
 
        Log::trace("Stopping service before deletion: " . $this->getName());
        $this->stop();
 
        if ( $this->getNssm() instanceof Nssm ) {
            $childExe = basename( $this->getNssm()->getBinPath() );
            Log::trace("Killing NSSM child process after stop: " . $childExe);
            Win32Ps::killBins( [$childExe] );
        }
 
        if ( $this->getName() == BinPostgresql::SERVICE_NAME ) {
            Log::trace("PostgreSQL service detected - using specialized uninstallation");
            $result = Batch::uninstallPostgresqlService();
            Log::trace("PostgreSQL service uninstallation " . ($result ? "succeeded" : "failed"));
            return $result;
        }
 
        Log::trace("Calling win32_delete_service for service: " . $this->getName());
        $result = $this->callWin32Service( 'win32_delete_service', $this->getName(), true );
        // Ensure proper type conversion for PHP 8.5.7 compatibility
        $resultInt = is_numeric($result) ? (int)$result : 0;
        $delete = $result !== null ? dechex( $resultInt ) : '0';
        Log::trace("Delete service result code: " . $delete);
        $this->writeLog( 'Delete service ' . $this->getName() . ': ' . $delete . ' (status: ' . $this->status() . ')' );
 
        if ( $delete != self::WIN32_NO_ERROR && $delete != self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST ) {
            return false;
        }
        elseif ( $this->isInstalled() ) {
            $this->latestError = self::WIN32_NO_ERROR;
 
            return false;
        }
 
        return true;
    }

References $result, callWin32Service(), getBinPath(), getName(), getNssm(), isInstalled(), Win32Ps\killBins(), BinPostgresql\SERVICE_NAME, status(), stop(), Log\trace(), Batch\uninstallPostgresqlService(), and writeLog().

Here is the call graph for this function:

◆ ensureReset()

ensureReset ( )

Ensures the service is properly reset (deleted and verified deleted). This is more robust than just calling delete() as it waits for confirmation.

Returns: bool True if service was successfully reset, false otherwise

Definition at line 1281 of file class.win32service.php.

                                 : bool
    {
        Log::trace("Starting ensureReset for service: " . $this->getName());
 
        // First, make sure service is stopped
        if ($this->isRunning()) {
            Log::trace("Service is still running, stopping it first");
            if (!$this->stop()) {
                Log::trace("Failed to stop service during ensureReset");
                return false;
            }
            usleep(1000000); // 1 second wait after stop
        }
 
        // Delete the service
        Log::trace("Deleting service");
        if (!$this->delete()) {
            Log::trace("Service deletion failed, but continuing with wait");
        }
 
        // Wait for the service to be completely removed
        if (!$this->waitForServiceDeletion(30)) {
            Log::trace("Service deletion did not complete within timeout, but continuing");
            // Even if we timeout, give it a moment and try to create anyway
            usleep(2000000); // 2 seconds
        }
 
        Log::trace("ensureReset completed for service: " . $this->getName());
        return true;
    }

References getName(), isRunning(), stop(), Log\trace(), and waitForServiceDeletion().

Here is the call graph for this function:

◆ fastServiceCheck()

fastServiceCheck ( )

Fast service check using sc.exe (Windows Service Control utility). This is much faster than WMI/VBS queries and less prone to hanging.

Returns: array|false Service information array or false if service doesn't exist

Definition at line 722 of file class.win32service.php.

    {
        Log::trace("Starting fastServiceCheck for service: " . $this->getName());
 
        $startTime = microtime(true);
 
        // Use sc.exe to query service - this is very fast and reliable
        // Execute with hidden window to prevent command prompt flash
        Log::trace("Executing: sc query " . $this->getName());
 
        $output = CommandRunner::execCombined('sc', ['query', $this->getName()]);
        $duration = round(microtime(true) - $startTime, 3);
 
        Log::trace("sc.exe query completed in " . $duration . "s");
 
        if ($output === null || $output === false) {
            Log::trace("sc.exe returned null/false, service likely doesn't exist");
            return false;
        }
 
        // Check if service doesn't exist
        if (stripos($output, 'does not exist') !== false ||
            stripos($output, 'FAILED') !== false ||
            stripos($output, '1060') !== false) {  // Error code 1060 = service doesn't exist
            Log::trace("Service doesn't exist: " . $this->getName());
            return false;
        }
 
        // Service exists - parse basic info
        $serviceInfo = [];
 
        // Extract service name
        if (preg_match('/SERVICE_NAME:\s*(.+)/i', $output, $matches)) {
            $serviceInfo[self::VBS_NAME] = trim($matches[1]);
        }
 
        // Extract display name
        if (preg_match('/DISPLAY_NAME:\s*(.+)/i', $output, $matches)) {
            $serviceInfo[self::VBS_DISPLAY_NAME] = trim($matches[1]);
        }
 
        // Extract state
        if (preg_match('/STATE\s*:\s*\d+\s+(\w+)/i', $output, $matches)) {
            $state = trim($matches[1]);
            $serviceInfo[self::SERVICE_STATE] = $state;
            Log::trace("Service state: " . $state);
        }
 
        // If we have basic info, service exists - get full details if needed
        if (!empty($serviceInfo)) {
            Log::trace("Service exists, getting full details");
 
            // Use sc qc to get configuration details (including path)
            $configOutput = CommandRunner::execCombined('sc', ['qc', $this->getName()]);
 
            if ($configOutput !== null && $configOutput !== false && preg_match('/BINARY_PATH_NAME\s*:\s*(.+)/i', $configOutput, $matches)) {
                $serviceInfo[self::VBS_PATH_NAME] = trim($matches[1]);
                Log::trace("Service path: " . $serviceInfo[self::VBS_PATH_NAME]);
            }
 
            // Get description if available
            if ($configOutput !== null && $configOutput !== false && preg_match('/DISPLAY_NAME\s*:\s*(.+)/i', $configOutput, $matches)) {
                $serviceInfo[self::VBS_DESCRIPTION] = trim($matches[1]);
            }
 
            Log::trace("Fast service check successful for: " . $this->getName());
            return $serviceInfo;
        }
 
        Log::trace("Could not parse service info from sc.exe output");
        return false;
    }

References CommandRunner\execCombined(), getName(), and Log\trace().

Referenced by infos().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBinPath()

getBinPath ( )

Gets the binary path of the service.

Returns: string The binary path of the service.

Definition at line 1091 of file class.win32service.php.

                                : string
    {
        return $this->binPath;
    }

References $binPath.

Referenced by create(), and delete().

Here is the caller graph for this function:

◆ getDisplayName()

getDisplayName ( )

Gets the display name of the service.

Returns: string The display name of the service.

Definition at line 1071 of file class.win32service.php.

                                    : string
    {
        return $this->displayName;
    }

References $displayName.

Referenced by create().

Here is the caller graph for this function:

◆ getError()

getError ( )

Gets a detailed error message for the latest error encountered by the service.

Returns: string|null The detailed error message, or null if no error.

Definition at line 1217 of file class.win32service.php.

    {
        global $bearsamppLang;
        if ( $this->latestError != self::WIN32_NO_ERROR ) {
            // Ensure proper type conversion for PHP 8.5.7 compatibility
            $errorInt = is_numeric($this->latestError) ? hexdec( $this->latestError ) : 0;
            return $bearsamppLang->getValue( Lang::ERROR ) . ' ' .
                $this->latestError . ' (' . $errorInt . ' : ' . $this->getWin32ErrorCodeDesc( $this->latestError ) . ')';
        }
        elseif ( $this->latestStatus != self::WIN32_SERVICE_NA ) {
            // Ensure proper type conversion for PHP 8.5.7 compatibility
            $statusInt = is_numeric($this->latestStatus) ? hexdec( $this->latestStatus ) : 0;
            return $bearsamppLang->getValue( Lang::STATUS ) . ' ' .
                $this->latestStatus . ' (' . $statusInt . ' : ' . $this->getWin32ServiceStatusDesc( $this->latestStatus ) . ')';
        }
 
        return null;
    }

References $bearsamppLang, Lang\ERROR, getWin32ErrorCodeDesc(), getWin32ServiceStatusDesc(), and Lang\STATUS.

Here is the call graph for this function:

◆ getErrorControl()

getErrorControl ( )

Gets the error control setting of the service.

Returns: string The error control setting of the service.

Definition at line 1151 of file class.win32service.php.

                                     : string
    {
        return $this->errorControl;
    }

References $errorControl.

Referenced by create().

Here is the caller graph for this function:

◆ getLatestError()

getLatestError ( )

Gets the latest error encountered by the service.

Returns: string The latest error encountered by the service.

Definition at line 1207 of file class.win32service.php.

    {
        return $this->latestError;
    }

References $latestError.

Referenced by create().

Here is the caller graph for this function:

◆ getLatestStatus()

getLatestStatus ( )

Gets the latest status of the service.

Returns: string The latest status of the service.

Definition at line 1197 of file class.win32service.php.

    {
        return $this->latestStatus;
    }

References $latestStatus.

◆ getName()

getName ( )

Gets the name of the service.

Returns: string The name of the service.

Definition at line 1051 of file class.win32service.php.

                             : string
    {
        return $this->name;
    }

References $name.

Referenced by create(), delete(), ensureReset(), fastServiceCheck(), infos(), isInstalled(), isPaused(), isRunning(), isStopped(), start(), status(), stop(), and waitForServiceDeletion().

Here is the caller graph for this function:

◆ getNssm()

getNssm ( )

Gets the NSSM instance associated with the service.

Returns: Nssm The NSSM instance.

Definition at line 1171 of file class.win32service.php.

    {
        return $this->nssm;
    }

References $nssm.

Referenced by create(), delete(), and infos().

Here is the caller graph for this function:

◆ getParams()

getParams ( )

Gets the parameters for the service.

Returns: string The parameters for the service.

Definition at line 1111 of file class.win32service.php.

                               : string
    {
        return $this->params;
    }

References $params.

Referenced by create().

Here is the caller graph for this function:

◆ getServices()

getServices ( $forceRefresh = false )

static

Retrieves all Windows services. Use $forceRefresh to ignore the cache.

Parameters

bool $forceRefresh Whether to force a refresh of the service list.

Returns: array Array of services.

Definition at line 139 of file class.win32service.php.

    {
        if (self::$serviceListCache === null || $forceRefresh) {
            Log::trace('Fetching service list from Windows (COM/WMI)');
            $startTime = microtime(true);
            $services = Win32Native::listServices(self::getVbsKeys());
            
            self::$serviceListCache = [];
            if (is_array($services)) {
                foreach ($services as $service) {
                    if (isset($service[self::VBS_NAME])) {
                        self::$serviceListCache[$service[self::VBS_NAME]] = $service;
                    }
                }
            }
            $duration = round(microtime(true) - $startTime, 3);
            Log::trace('Service list fetched in ' . $duration . 's');
        }
        
        return self::$serviceListCache;
    }

References Win32Native\listServices(), and Log\trace().

Referenced by ActionStartup\checkApacheServiceWithTimeout(), ActionStartup\checkMySQLServiceWithTimeout(), and ActionStartup\installServicesSequential().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStartType()

getStartType ( )

Gets the start type of the service.

Returns: string The start type of the service.

Definition at line 1131 of file class.win32service.php.

                                  : string
    {
        return $this->startType;
    }

References $startType.

Referenced by create().

Here is the caller graph for this function:

◆ getVbsKeys()

getVbsKeys ( )

static

Returns an array of VBS keys used for service information.

Returns: array The array of VBS keys.

Definition at line 121 of file class.win32service.php.

                                       : array
    {
        return array(
            self::VBS_NAME,
            self::VBS_DISPLAY_NAME,
            self::VBS_DESCRIPTION,
            self::VBS_PATH_NAME,
            self::SERVICE_STATE
        );
    }

◆ getWin32ErrorCodeDesc()

getWin32ErrorCodeDesc ( $code )

private

Returns a description of the Win32 error code.

Parameters

string $code The error code.

Returns: string|null The description of the error code, or null if the code is not recognized.

Definition at line 1035 of file class.win32service.php.

                                                 : ?string
    {
        switch ( $code ) {
            case self::WIN32_ERROR_ACCESS_DENIED:
                return 'The handle to the SCM database does not have the appropriate access rights.';
            // ... other cases ...
            default:
                return null;
        }
    }

Referenced by getError().

Here is the caller graph for this function:

◆ getWin32ServiceStatusDesc()

getWin32ServiceStatusDesc ( $status )

private

Returns a description of the Win32 service status.

Parameters

string $status The status code.

Returns: string|null The status description.

Definition at line 996 of file class.win32service.php.

                                                       : ?string
    {
        switch ( $status ) {
            case self::WIN32_SERVICE_CONTINUE_PENDING:
                return 'The service continue is pending.';
 
            case self::WIN32_SERVICE_PAUSE_PENDING:
                return 'The service pause is pending.';
 
            case self::WIN32_SERVICE_PAUSED:
                return 'The service is paused.';
 
            case self::WIN32_SERVICE_RUNNING:
                return 'The service is running.';
 
            case self::WIN32_SERVICE_START_PENDING:
                return 'The service is starting.';
 
            case self::WIN32_SERVICE_STOP_PENDING:
                return 'The service is stopping.';
 
            case self::WIN32_SERVICE_STOPPED:
                return 'The service is not running.';
 
            case self::WIN32_SERVICE_NA:
                return 'Cannot retrieve service status.';
 
            default:
                return null;
        }
    }

Referenced by getError().

Here is the caller graph for this function:

◆ infos()

infos ( )

Retrieves information about the service. Performance optimization: Uses fast sc.exe check first, falls back to VBS if needed.

Returns: array|false The service information, or false on failure.

Definition at line 801 of file class.win32service.php.

    {
        Log::trace("Starting Win32Service::infos for service: " . $this->getName());
 
        try {
            // Set a timeout for the entire operation
            $startTime = microtime(true);
            $timeout = 10; // 10 seconds timeout for the entire operation
 
            if ($this->getNssm() instanceof Nssm) {
                Log::trace("Using NSSM to get service info");
                $result = $this->getNssm()->infos();
                Log::trace("NSSM info retrieval completed in " . round(microtime(true) - $startTime, 2) . " seconds");
                return $result;
            }
 
            // Performance optimization: Try fast sc.exe check first
            Log::trace("Attempting fast service check using sc.exe");
            $fastResult = $this->fastServiceCheck();
 
            if ($fastResult !== false) {
                $duration = round(microtime(true) - $startTime, 3);
                Log::trace("Fast service check succeeded in " . $duration . "s (saved 5-10s)");
                Log::debug("Performance: Fast service check used for " . $this->getName() . ", saved 5-10 seconds");
                return $fastResult;
            }
 
            // Fast check returned false - service doesn't exist
            if ($fastResult === false) {
                $duration = round(microtime(true) - $startTime, 3);
                Log::trace("Fast service check determined service doesn't exist in " . $duration . "s");
                return false;
            }
 
            // Fallback to VBS (should rarely be needed now)
            Log::trace("Falling back to VBS for service info");
 
            // Use set_time_limit to prevent PHP script timeout
            $originalTimeout = ini_get('max_execution_time');
            set_time_limit(15); // 15 seconds timeout
 
            // Create a separate process to get service info with a timeout
            $result = Win32Native::getServiceInfo($this->getName());
 
            // Reset the timeout
            set_time_limit($originalTimeout);
 
            // Check if we've exceeded our timeout
            if (microtime(true) - $startTime > $timeout) {
                Log::trace("Timeout exceeded in infos() method, returning false");
                return false;
            }
 
            Log::trace("VBS info retrieval completed in " . round(microtime(true) - $startTime, 2) . " seconds");
            return $result;
        } catch (\Exception $e) {
            Log::trace("Exception in infos() method: " . $e->getMessage() . ", returning false");
            return false;
        } catch (\Throwable $e) {
            Log::trace("Throwable in infos() method: " . $e->getMessage() . ", returning false");
            return false;
        }
    }

References $result, Log\debug(), fastServiceCheck(), getName(), getNssm(), Win32Native\getServiceInfo(), and Log\trace().

Here is the call graph for this function:

◆ isInstalled()

isInstalled ( )

Checks if the service is installed.

Returns: bool True if the service is installed, false otherwise.

Definition at line 870 of file class.win32service.php.

                                 : bool
    {
        Log::trace("Checking if service is installed: " . $this->getName());
 
        try {
            // Set a timeout for the entire operation
            $startTime = microtime(true);
            $timeout = 15; // 15 seconds timeout for the entire operation
 
            // Call status() with a try-catch to ensure we don't get stuck
            $status = $this->status();
 
            // Check if we've exceeded our timeout
            if (microtime(true) - $startTime > $timeout) {
                Log::trace("Timeout exceeded in isInstalled() method, assuming service is not installed");
                $this->writeLog('isInstalled ' . $this->getName() . ': NO (timeout exceeded)');
                return false;
            }
 
            $isInstalled = $status != self::WIN32_SERVICE_NA;
 
            Log::trace("Service " . $this->getName() . " installation status: " . ($isInstalled ? "YES" : "NO") . " (status code: " . $status . ")");
            $this->writeLog('isInstalled ' . $this->getName() . ': ' . ($isInstalled ? 'YES' : 'NO') . ' (status: ' . $status . ')');
 
            return $isInstalled;
        } catch (\Exception $e) {
            Log::trace("Exception in isInstalled() method: " . $e->getMessage() . ", assuming service is not installed");
            $this->writeLog('isInstalled ' . $this->getName() . ': NO (exception: ' . $e->getMessage() . ')');
            return false;
        } catch (\Throwable $e) {
            Log::trace("Throwable in isInstalled() method: " . $e->getMessage() . ", assuming service is not installed");
            $this->writeLog('isInstalled ' . $this->getName() . ': NO (throwable: ' . $e->getMessage() . ')');
            return false;
        }
    }

References getName(), status(), Log\trace(), and writeLog().

Referenced by create(), and delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isPaused()

isPaused ( )

Checks if the service is paused.

Returns: bool True if the service is paused, false otherwise.

Definition at line 947 of file class.win32service.php.

                              : bool
    {
        Log::trace("Checking if service is paused: " . $this->getName());
 
        $status = $this->status();
        $isPaused = $status == self::WIN32_SERVICE_PAUSED;
 
        Log::trace("Service " . $this->getName() . " paused status: " . ($isPaused ? "YES" : "NO") . " (status code: " . $status . ")");
        $this->writeLog( 'isPaused ' . $this->getName() . ': ' . ($isPaused ? 'YES' : 'NO') . ' (status: ' . $status . ')' );
 
        return $isPaused;
    }

References getName(), status(), Log\trace(), and writeLog().

Here is the call graph for this function:

◆ isPending()

isPending ( $status )

Checks if the service is in a pending state.

Parameters

string $status The status to check.

Returns: bool True if the service is in a pending state, false otherwise.

Definition at line 967 of file class.win32service.php.

                                      : bool
    {
        $isPending = $status == self::WIN32_SERVICE_START_PENDING || $status == self::WIN32_SERVICE_STOP_PENDING
            || $status == self::WIN32_SERVICE_CONTINUE_PENDING || $status == self::WIN32_SERVICE_PAUSE_PENDING;
 
        Log::trace("Checking if status is pending: " . $status . " - Result: " . ($isPending ? "YES" : "NO"));
 
        if ($isPending) {
            if ($status == self::WIN32_SERVICE_START_PENDING) {
                Log::trace("Service is in START_PENDING state");
            } else if ($status == self::WIN32_SERVICE_STOP_PENDING) {
                Log::trace("Service is in STOP_PENDING state");
            } else if ($status == self::WIN32_SERVICE_CONTINUE_PENDING) {
                Log::trace("Service is in CONTINUE_PENDING state");
            } else if ($status == self::WIN32_SERVICE_PAUSE_PENDING) {
                Log::trace("Service is in PAUSE_PENDING state");
            }
        }
 
        return $isPending;
    }

References Log\trace().

Referenced by start(), status(), and stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRunning()

isRunning ( )

Checks if the service is running.

Returns: bool True if the service is running, false otherwise.

Definition at line 911 of file class.win32service.php.

                               : bool
    {
        Log::trace("Checking if service is running: " . $this->getName());
 
        $status = $this->status();
        $isRunning = $status == self::WIN32_SERVICE_RUNNING;
 
        Log::trace("Service " . $this->getName() . " running status: " . ($isRunning ? "YES" : "NO") . " (status code: " . $status . ")");
        $this->writeLog( 'isRunning ' . $this->getName() . ': ' . ($isRunning ? 'YES' : 'NO') . ' (status: ' . $status . ')' );
 
        return $isRunning;
    }

References getName(), status(), Log\trace(), and writeLog().

Referenced by ensureReset(), and start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isStopped()

isStopped ( )

Checks if the service is stopped.

Returns: bool True if the service is stopped, false otherwise.

Definition at line 929 of file class.win32service.php.

                               : bool
    {
        Log::trace("Checking if service is stopped: " . $this->getName());
 
        $status = $this->status();
        $isStopped = $status == self::WIN32_SERVICE_STOPPED;
 
        Log::trace("Service " . $this->getName() . " stopped status: " . ($isStopped ? "YES" : "NO") . " (status code: " . $status . ")");
        $this->writeLog( 'isStopped ' . $this->getName() . ': ' . ($isStopped ? 'YES' : 'NO') . ' (status: ' . $status . ')' );
 
        return $isStopped;
    }

References getName(), status(), Log\trace(), and writeLog().

Referenced by stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

reset ( )

Resets the service by deleting and recreating it.

Returns: bool True if the service was reset successfully, false otherwise.

Definition at line 553 of file class.win32service.php.

                           : bool
    {
        if ( $this->delete() ) {
            usleep( self::SLEEP_TIME );
 
            return $this->create();
        }
 
        return false;
    }

References create().

Here is the call graph for this function:

◆ restart()

restart ( )

Restarts the service by stopping and then starting it.

Returns: bool True if the service was restarted successfully, false otherwise.

Definition at line 707 of file class.win32service.php.

                             : bool
    {
        if ( $this->stop() ) {
            return $this->start();
        }
 
        return false;
    }

References start(), and stop().

Here is the call graph for this function:

◆ setBinPath()

setBinPath ( $binPath )

Sets the binary path of the service.

Parameters

string $binPath The binary path to set.

Definition at line 1101 of file class.win32service.php.

                                        : void
    {
        $this->binPath = str_replace( '"', '', Path::formatWindowsPath( $binPath ) );
    }

References $binPath, and Path\formatWindowsPath().

Referenced by setNssm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDisplayName()

setDisplayName ( $displayName )

Sets the display name of the service.

Parameters

string $displayName The display name to set.

Definition at line 1081 of file class.win32service.php.

                                                : void
    {
        $this->displayName = $displayName;
    }

References $displayName.

Referenced by setNssm().

Here is the caller graph for this function:

◆ setErrorControl()

setErrorControl ( $errorControl )

Sets the error control setting of the service.

Parameters

string $errorControl The error control setting to set.

Definition at line 1161 of file class.win32service.php.

                                                  : void
    {
        $this->errorControl = $errorControl;
    }

References $errorControl.

◆ setName()

setName ( $name )

Sets the name of the service.

Parameters

string $name The name to set.

Definition at line 1061 of file class.win32service.php.

                                  : void
    {
        $this->name = $name;
    }

References $name.

◆ setNssm()

setNssm ( $nssm )

Sets the NSSM instance associated with the service.

Parameters

Nssm $nssm The NSSM instance to set.

Definition at line 1181 of file class.win32service.php.

    {
        if ( $nssm instanceof Nssm ) {
            $this->setDisplayName( $nssm->getDisplayName() );
            $this->setBinPath( $nssm->getBinPath() );
            $this->setParams( $nssm->getParams() );
            $this->setStartType( $nssm->getStart() );
            $this->nssm = $nssm;
        }
    }

References $nssm, setBinPath(), setDisplayName(), setParams(), and setStartType().

Here is the call graph for this function:

◆ setParams()

setParams ( $params )

Sets the parameters for the service.

Parameters

string $params The parameters to set.

Definition at line 1121 of file class.win32service.php.

                                      : void
    {
        $this->params = $params;
    }

References $params.

Referenced by setNssm().

Here is the caller graph for this function:

◆ setStartType()

setStartType ( $startType )

Sets the start type of the service.

Parameters

string $startType The start type to set.

Definition at line 1141 of file class.win32service.php.

                                            : void
    {
        $this->startType = $startType;
    }

References $startType.

Referenced by setNssm().

Here is the caller graph for this function:

◆ start()

start ( )

Starts the service.

Returns: bool True if the service was started successfully, false otherwise.

Definition at line 569 of file class.win32service.php.

                           : bool
    {
        global $bearsamppBins;
 
        Log::info('Attempting to start service: ' . $this->getName());
 
        if ( $this->getName() == BinMysql::SERVICE_NAME ) {
            $bearsamppBins->getMysql()->initData();
        }
        elseif ( $this->getName() == BinMariadb::SERVICE_NAME ) {
            $bearsamppBins->getMariadb()->initData();
        }
        elseif ( $this->getName() == BinMailpit::SERVICE_NAME ) {
            $bearsamppBins->getMailpit()->rebuildConf();
        }
        elseif ( $this->getName() == BinMemcached::SERVICE_NAME ) {
            $bearsamppBins->getMemcached()->rebuildConf();
        }
        elseif ( $this->getName() == BinPostgresql::SERVICE_NAME ) {
            $bearsamppBins->getPostgresql()->rebuildConf();
            $bearsamppBins->getPostgresql()->initData();
        }
        elseif ( $this->getName() == BinXlight::SERVICE_NAME ) {
            $bearsamppBins->getXlight()->rebuildConf();
        }
 
 
        $result = $this->callWin32Service( 'win32_start_service', $this->getName(), true );
        // Ensure proper type conversion for PHP 8.5.7 compatibility
        $resultInt = is_numeric($result) ? (int)$result : 0;
        $start = $result !== null ? dechex( $resultInt ) : '0';
        Log::debug( 'Start service ' . $this->getName() . ': ' . $start . ' (status: ' . $this->status() . ')' );
 
        if ( $start != self::WIN32_NO_ERROR && $start != self::WIN32_ERROR_SERVICE_ALREADY_RUNNING ) {
 
            // Write error to log
            Log::error('Failed to start service: ' . $this->getName() . ' with error code: ' . $start);
 
            if ( $this->getName() == BinApache::SERVICE_NAME ) {
                $cmdOutput = $bearsamppBins->getApache()->getCmdLineOutput( BinApache::CMD_SYNTAX_CHECK );
                if ( !$cmdOutput['syntaxOk'] ) {
                    file_put_contents(
                        $bearsamppBins->getApache()->getErrorLog(),
                        '[' . date( 'Y-m-d H:i:s', time() ) . '] [error] ' . $cmdOutput['content'] . PHP_EOL,
                        FILE_APPEND
                    );
                }
            }
            elseif ( $this->getName() == BinMysql::SERVICE_NAME ) {
                $cmdOutput = $bearsamppBins->getMysql()->getCmdLineOutput( BinMysql::CMD_SYNTAX_CHECK );
                if ( !$cmdOutput['syntaxOk'] ) {
                    file_put_contents(
                        $bearsamppBins->getMysql()->getErrorLog(),
                        '[' . date( 'Y-m-d H:i:s', time() ) . '] [error] ' . $cmdOutput['content'] . PHP_EOL,
                        FILE_APPEND
                    );
                }
            }
            elseif ( $this->getName() == BinMariadb::SERVICE_NAME ) {
                $cmdOutput = $bearsamppBins->getMariadb()->getCmdLineOutput( BinMariadb::CMD_SYNTAX_CHECK );
                if ( !$cmdOutput['syntaxOk'] ) {
                    file_put_contents(
                        $bearsamppBins->getMariadb()->getErrorLog(),
                        '[' . date( 'Y-m-d H:i:s', time() ) . '] [error] ' . $cmdOutput['content'] . PHP_EOL,
                        FILE_APPEND
                    );
                }
            }
 
            return false;
        }
 
        // Wait for the service to actually start before checking if it's running
        // We use a timeout to avoid hanging if the service fails to start properly
        $maxtime = time() + self::PENDING_TIMEOUT;
        while ($this->isPending($this->status(false)) && time() < $maxtime) {
            usleep(self::SLEEP_TIME);
        }
 
        if ( !$this->isRunning() ) {
            $this->latestError = self::WIN32_NO_ERROR;
            Log::error('Service ' . $this->getName() . ' is not running after start attempt (status: ' . $this->status() . ').');
            $this->latestError = null;
            return false;
        }
 
        Log::info('Service ' . $this->getName() . ' started successfully.');
        return true;
    }

References $bearsamppBins, $result, callWin32Service(), BinApache\CMD_SYNTAX_CHECK, BinMariadb\CMD_SYNTAX_CHECK, BinMysql\CMD_SYNTAX_CHECK, Log\debug(), Log\error(), getName(), Log\info(), isPending(), isRunning(), BinApache\SERVICE_NAME, BinMailpit\SERVICE_NAME, BinMariadb\SERVICE_NAME, BinMemcached\SERVICE_NAME, BinMysql\SERVICE_NAME, BinPostgresql\SERVICE_NAME, BinXlight\SERVICE_NAME, and status().

Referenced by restart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ status()

status ( $timeout = true )

Queries the status of the service.

Parameters

bool $timeout Whether to use a timeout.

Returns: string The status of the service.

Definition at line 283 of file class.win32service.php.

                                         : string
    {
        $this->latestStatus = self::WIN32_SERVICE_NA;
        $maxtime            = time() + self::PENDING_TIMEOUT;
 
        Log::trace("Querying status for service: " . $this->getName() . " (timeout: " . ($timeout ? "enabled" : "disabled") . ")");
        if ($timeout) {
            Log::trace("Max timeout time set to: " . date('Y-m-d H:i:s', $maxtime));
        }
 
        // Add a safety counter to prevent infinite loops
        $loopCount = 0;
        $maxLoops = 5; // Maximum number of attempts
        $startTime = microtime(true);
 
        try {
            while ( ($this->latestStatus == self::WIN32_SERVICE_NA || $this->isPending( $this->latestStatus )) && $loopCount < $maxLoops ) {
                $loopCount++;
                Log::trace("Calling win32_query_service_status for service: " . $this->getName() . " (attempt " . $loopCount . " of " . $maxLoops . ")");
 
                // Add a timeout check before making the call
                if (microtime(true) - $startTime > 10) { // 10 seconds overall timeout
                    Log::trace("Overall timeout reached before making service status call");
                    break;
                }
 
                $this->latestStatus = $this->callWin32Service( 'win32_query_service_status', $this->getName() );
 
                if ( is_array( $this->latestStatus ) && isset( $this->latestStatus['CurrentState'] ) ) {
                    // Ensure proper type conversion for PHP 8.5.7 compatibility
                    $stateInt = is_numeric($this->latestStatus['CurrentState']) ? (int)$this->latestStatus['CurrentState'] : 0;
                    $this->latestStatus = dechex( $stateInt );
                    Log::trace("Service status returned as array, CurrentState: " . $this->latestStatus);
                }
                elseif ( $this->latestStatus !== null ) {
                    // Ensure proper type conversion for PHP 8.5.7 compatibility
                    $statusInt = is_numeric($this->latestStatus) ? (int)$this->latestStatus : 0;
                    $statusHex = dechex( $statusInt );
                    Log::trace("Service status returned as value: " . $statusHex);
 
                    if ( $statusHex == self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST ) {
                        $this->latestStatus = $statusHex;
                        Log::trace("Service does not exist, breaking loop");
                        break; // Exit the loop immediately if service doesn't exist
                    }
                } else {
                    Log::trace("Service status query returned null");
                    // If we get a null result, assume service does not exist to avoid hanging
                    if ($loopCount >= 2) // Only do this after at least one retry
                    {
                        Log::trace("Multiple null results, assuming service does not exist");
                        $this->latestStatus = self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST;
                        break;
                    }
                }
 
                if ( $timeout && $maxtime < time() ) {
                    Log::trace("Timeout reached while querying service status");
                    break;
                }
 
                // Only sleep if we're going to loop again
                if ($loopCount < $maxLoops && ($this->latestStatus == self::WIN32_SERVICE_NA || $this->isPending($this->latestStatus))) {
                    Log::trace("Sleeping before next status check attempt");
                    usleep(self::SLEEP_TIME);
                }
            }
        } catch (\Exception $e) {
            Log::trace("Exception in status method: " . $e->getMessage());
            // If an exception occurs, assume service does not exist
            $this->latestStatus = self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST;
        } catch (\Throwable $e) {
            Log::trace("Throwable in status method: " . $e->getMessage());
            // If a throwable occurs, assume service does not exist
            $this->latestStatus = self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST;
        }
 
        if ($loopCount >= $maxLoops) {
            Log::trace("Maximum query attempts reached for service: " . $this->getName());
        }
 
        $elapsedTime = microtime(true) - $startTime;
        Log::trace("Status check completed in " . round($elapsedTime, 2) . " seconds after " . $loopCount . " attempts");
 
        if ( $this->latestStatus == self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST ) {
            $this->latestError  = $this->latestStatus;
            $this->latestStatus = self::WIN32_SERVICE_NA;
            Log::trace("Service does not exist, setting status to NA");
        }
 
        Log::trace("Final status for service " . $this->getName() . ": " . $this->latestStatus);
        return $this->latestStatus;
    }

References $latestStatus, callWin32Service(), getName(), isPending(), and Log\trace().

Referenced by create(), delete(), isInstalled(), isPaused(), isRunning(), isStopped(), start(), stop(), and waitForServiceDeletion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stop()

stop ( )

Stops the service.

Returns: bool True if the service was stopped successfully, false otherwise.

Definition at line 664 of file class.win32service.php.

                          : bool
    {
        Log::trace("Starting Win32Service::stop for service: " . $this->getName());
 
        Log::trace("Calling win32_stop_service for service: " . $this->getName());
        $result = $this->callWin32Service( 'win32_stop_service', $this->getName(), true );
 
        // Ensure proper type conversion for PHP 8.5.7 compatibility
        $resultInt = is_numeric($result) ? (int)$result : 0;
        $stop = $result !== null ? dechex( $resultInt ) : '0';
        Log::trace("Stop service result code: " . $stop);
 
        Log::trace("Checking current status after stop attempt");
        $currentStatus = $this->status();
        Log::trace("Current status: " . $currentStatus);
 
        $this->writeLog( 'Stop service ' . $this->getName() . ': ' . $stop . ' (status: ' . $currentStatus . ')' );
 
        if ( $stop != self::WIN32_NO_ERROR ) {
            return false;
        }
 
        // Wait for the service to actually stop before checking if it's stopped
        $maxtime = time() + self::PENDING_TIMEOUT;
        while ($this->isPending($this->status(false)) && time() < $maxtime) {
            usleep(self::SLEEP_TIME);
        }
 
        if ( !$this->isStopped() ) {
            $this->latestError = self::WIN32_NO_ERROR;
            Log::error('Service ' . $this->getName() . ' is still running after stop attempt (status: ' . $this->status() . ').');
            $this->latestError = null;
            return false;
        }
 
        return true;
    }

References $result, callWin32Service(), Log\error(), getName(), isPending(), isStopped(), status(), Log\trace(), and writeLog().

Referenced by delete(), ensureReset(), and restart().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ waitForServiceDeletion()

waitForServiceDeletion ( $maxWaitTime = 30 )

Waits for the service to be completely removed from the SCM database. This is important after deletion because the SCM marks services for deletion but they remain visible briefly, preventing re-creation.

Parameters

int $maxWaitTime Maximum time to wait in seconds (default 30)

Returns: bool True if service is confirmed deleted, false on timeout

Definition at line 1245 of file class.win32service.php.

                                                           : bool
    {
        $startTime = time();
        $maxTime = $startTime + $maxWaitTime;
        $checkCount = 0;
 
        Log::trace("Waiting for service deletion: " . $this->getName() . " (max wait: " . $maxWaitTime . "s)");
 
        while (time() < $maxTime) {
            $checkCount++;
            $status = $this->status(false);
            Log::trace("Service deletion check #" . $checkCount . " - Status: " . $status . " at " . date('Y-m-d H:i:s'));
 
            // Service doesn't exist or is definitely not there
            if ($status == self::WIN32_SERVICE_NA ||
                $status == self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST) {
                $elapsedTime = time() - $startTime;
                Log::trace("Service deletion confirmed after " . $elapsedTime . " seconds");
                return true;
            }
 
            // Wait a bit before checking again
            usleep(500000); // 0.5 seconds
        }
 
        $totalWaitTime = time() - $startTime;
        Log::trace("Service deletion timeout after " . $totalWaitTime . " seconds - service still exists: " . $this->getName());
        return false;
    }

References getName(), status(), and Log\trace().

Referenced by ensureReset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeLog()

writeLog ( $log )

private

Writes a log entry.

Parameters

string $log The log message.

Definition at line 110 of file class.win32service.php.

                                   : void
    {
        global $bearsamppRoot;
        Log::debug( $log, Path::getServicesLogFilePath() );
    }

References $bearsamppRoot, Log\debug(), and Path\getServicesLogFilePath().

Referenced by create(), delete(), isInstalled(), isPaused(), isRunning(), isStopped(), and stop().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $binPath

$binPath

private

Definition at line 79 of file class.win32service.php.

Referenced by getBinPath(), and setBinPath().

◆ $displayName

$displayName

private

Definition at line 78 of file class.win32service.php.

Referenced by getDisplayName(), and setDisplayName().

◆ $errorControl

$errorControl

private

Definition at line 82 of file class.win32service.php.

Referenced by getErrorControl(), and setErrorControl().

◆ $latestError

$latestError

private

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

Referenced by getLatestError().

◆ $latestStatus

$latestStatus

private

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

Referenced by getLatestStatus(), and status().

◆ $loggedFunctions

$loggedFunctions = array()

staticprivate

Definition at line 92 of file class.win32service.php.

◆ $name

$name

private

Definition at line 77 of file class.win32service.php.

Referenced by __construct(), getName(), and setName().

◆ $nssm

$nssm

private

Definition at line 83 of file class.win32service.php.

Referenced by getNssm(), and setNssm().

◆ $params

$params

private

Definition at line 80 of file class.win32service.php.

Referenced by getParams(), and setParams().

◆ $serviceListCache

$serviceListCache = null

staticprivate

Definition at line 89 of file class.win32service.php.

◆ $startType

$startType

private

Definition at line 81 of file class.win32service.php.

Referenced by getStartType(), and setStartType().

◆ PENDING_TIMEOUT

const PENDING_TIMEOUT = 20

Definition at line 68 of file class.win32service.php.

◆ SERVER_ERROR_IGNORE

const SERVER_ERROR_IGNORE = '0'

Definition at line 61 of file class.win32service.php.

◆ SERVER_ERROR_NORMAL

const SERVER_ERROR_NORMAL = '1'

Definition at line 62 of file class.win32service.php.

Referenced by BinMariadb\reload(), BinMysql\reload(), and BinPostgresql\reload().

◆ SERVICE_AUTO_START

const SERVICE_AUTO_START = '2'

Definition at line 64 of file class.win32service.php.

◆ SERVICE_DEMAND_START

const SERVICE_DEMAND_START = '3'

Definition at line 65 of file class.win32service.php.

Referenced by BinMariadb\reload(), BinMysql\reload(), and BinPostgresql\reload().

◆ SERVICE_DISABLED

const SERVICE_DISABLED = '4'

Definition at line 66 of file class.win32service.php.

◆ SERVICE_STATE

const SERVICE_STATE = 'State'

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

Referenced by ActionStartup\prepareService().

◆ SLEEP_TIME

const SLEEP_TIME = 100000

Definition at line 69 of file class.win32service.php.

◆ VBS_DESCRIPTION

const VBS_DESCRIPTION = 'Description'

Definition at line 73 of file class.win32service.php.

◆ VBS_DISPLAY_NAME

const VBS_DISPLAY_NAME = 'DisplayName'

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

◆ VBS_NAME

const VBS_NAME = 'Name'

Definition at line 71 of file class.win32service.php.

◆ VBS_PATH_NAME

const VBS_PATH_NAME = 'PathName'

Definition at line 74 of file class.win32service.php.

Referenced by Nssm\infos(), and ActionStartup\prepareService().

◆ WIN32_ERROR_ACCESS_DENIED

const WIN32_ERROR_ACCESS_DENIED = '5'

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

◆ WIN32_ERROR_CIRCULAR_DEPENDENCY

const WIN32_ERROR_CIRCULAR_DEPENDENCY = '423'

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

◆ WIN32_ERROR_DATABASE_DOES_NOT_EXIST

const WIN32_ERROR_DATABASE_DOES_NOT_EXIST = '429'

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

◆ WIN32_ERROR_DEPENDENT_SERVICES_RUNNING

const WIN32_ERROR_DEPENDENT_SERVICES_RUNNING = '41B'

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

◆ WIN32_ERROR_DUPLICATE_SERVICE_NAME

const WIN32_ERROR_DUPLICATE_SERVICE_NAME = '436'

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

◆ WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT

const WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT = '427'

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

◆ WIN32_ERROR_INSUFFICIENT_BUFFER

const WIN32_ERROR_INSUFFICIENT_BUFFER = '7A'

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

◆ WIN32_ERROR_INVALID_DATA

const WIN32_ERROR_INVALID_DATA = 'D'

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

◆ WIN32_ERROR_INVALID_HANDLE

const WIN32_ERROR_INVALID_HANDLE = '6'

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

◆ WIN32_ERROR_INVALID_LEVEL

const WIN32_ERROR_INVALID_LEVEL = '7C'

Definition at line 39 of file class.win32service.php.

◆ WIN32_ERROR_INVALID_NAME

const WIN32_ERROR_INVALID_NAME = '7B'

Definition at line 40 of file class.win32service.php.

◆ WIN32_ERROR_INVALID_PARAMETER

const WIN32_ERROR_INVALID_PARAMETER = '57'

Definition at line 41 of file class.win32service.php.

◆ WIN32_ERROR_INVALID_SERVICE_ACCOUNT

const WIN32_ERROR_INVALID_SERVICE_ACCOUNT = '421'

Definition at line 42 of file class.win32service.php.

◆ WIN32_ERROR_INVALID_SERVICE_CONTROL

const WIN32_ERROR_INVALID_SERVICE_CONTROL = '41C'

Definition at line 43 of file class.win32service.php.

◆ WIN32_ERROR_PATH_NOT_FOUND

const WIN32_ERROR_PATH_NOT_FOUND = '3'

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

◆ WIN32_ERROR_SERVICE_ALREADY_RUNNING

const WIN32_ERROR_SERVICE_ALREADY_RUNNING = '420'

Definition at line 45 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL

const WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL = '425'

Definition at line 46 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_DATABASE_LOCKED

const WIN32_ERROR_SERVICE_DATABASE_LOCKED = '41F'

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

◆ WIN32_ERROR_SERVICE_DEPENDENCY_DELETED

const WIN32_ERROR_SERVICE_DEPENDENCY_DELETED = '433'

Definition at line 48 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_DEPENDENCY_FAIL

const WIN32_ERROR_SERVICE_DEPENDENCY_FAIL = '42C'

Definition at line 49 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_DISABLED

const WIN32_ERROR_SERVICE_DISABLED = '422'

Definition at line 50 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_DOES_NOT_EXIST

const WIN32_ERROR_SERVICE_DOES_NOT_EXIST = '424'

Definition at line 51 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_EXISTS

const WIN32_ERROR_SERVICE_EXISTS = '431'

Definition at line 52 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_LOGON_FAILED

const WIN32_ERROR_SERVICE_LOGON_FAILED = '42D'

Definition at line 53 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_MARKED_FOR_DELETE

const WIN32_ERROR_SERVICE_MARKED_FOR_DELETE = '430'

Definition at line 54 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_NO_THREAD

const WIN32_ERROR_SERVICE_NO_THREAD = '41E'

Definition at line 55 of file class.win32service.php.

◆ WIN32_ERROR_SERVICE_NOT_ACTIVE

const WIN32_ERROR_SERVICE_NOT_ACTIVE = '426'

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

◆ WIN32_ERROR_SERVICE_REQUEST_TIMEOUT

const WIN32_ERROR_SERVICE_REQUEST_TIMEOUT = '41D'

Definition at line 57 of file class.win32service.php.

◆ WIN32_ERROR_SHUTDOWN_IN_PROGRESS

const WIN32_ERROR_SHUTDOWN_IN_PROGRESS = '45B'

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

◆ WIN32_NO_ERROR

const WIN32_NO_ERROR = '0'

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

◆ WIN32_SERVICE_CONTINUE_PENDING

const WIN32_SERVICE_CONTINUE_PENDING = '5'

Definition at line 20 of file class.win32service.php.

◆ WIN32_SERVICE_NA

const WIN32_SERVICE_NA = '0'

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

◆ WIN32_SERVICE_PAUSE_PENDING

const WIN32_SERVICE_PAUSE_PENDING = '6'

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

◆ WIN32_SERVICE_PAUSED

const WIN32_SERVICE_PAUSED = '7'

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

◆ WIN32_SERVICE_RUNNING

const WIN32_SERVICE_RUNNING = '4'

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

Referenced by ActionStartup\prepareService().

◆ WIN32_SERVICE_START_PENDING

const WIN32_SERVICE_START_PENDING = '2'

Definition at line 24 of file class.win32service.php.

◆ WIN32_SERVICE_STOP_PENDING

const WIN32_SERVICE_STOP_PENDING = '3'

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

◆ WIN32_SERVICE_STOPPED

const WIN32_SERVICE_STOPPED = '1'

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

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ callWin32Service()

◆ create()

◆ delete()

◆ ensureReset()

◆ fastServiceCheck()

◆ getBinPath()

◆ getDisplayName()

◆ getError()

◆ getErrorControl()

◆ getLatestError()

◆ getLatestStatus()

◆ getName()

◆ getNssm()

◆ getParams()

◆ getServices()

◆ getStartType()

◆ getVbsKeys()

◆ getWin32ErrorCodeDesc()

◆ getWin32ServiceStatusDesc()

◆ infos()

◆ isInstalled()

◆ isPaused()

◆ isPending()

◆ isRunning()

◆ isStopped()

◆ reset()

◆ restart()

◆ setBinPath()

◆ setDisplayName()

◆ setErrorControl()

◆ setName()

◆ setNssm()

◆ setParams()

◆ setStartType()

◆ start()

◆ status()

◆ stop()

◆ waitForServiceDeletion()

◆ writeLog()

Field Documentation

◆ $binPath

◆ $displayName

◆ $errorControl

◆ $latestError

◆ $latestStatus

◆ $loggedFunctions

◆ $name

◆ $nssm

◆ $params

◆ $serviceListCache

◆ $startType

◆ PENDING_TIMEOUT

◆ SERVER_ERROR_IGNORE

◆ SERVER_ERROR_NORMAL

◆ SERVICE_AUTO_START

◆ SERVICE_DEMAND_START

◆ SERVICE_DISABLED

◆ SERVICE_STATE

◆ SLEEP_TIME

◆ VBS_DESCRIPTION

◆ VBS_DISPLAY_NAME

◆ VBS_NAME

◆ VBS_PATH_NAME

◆ WIN32_ERROR_ACCESS_DENIED

◆ WIN32_ERROR_CIRCULAR_DEPENDENCY

◆ WIN32_ERROR_DATABASE_DOES_NOT_EXIST

◆ WIN32_ERROR_DEPENDENT_SERVICES_RUNNING

◆ WIN32_ERROR_DUPLICATE_SERVICE_NAME

◆ WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT

◆ WIN32_ERROR_INSUFFICIENT_BUFFER