Public Member Functions
	__construct ($name)

	create ()

	delete ()

	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 ()

Static Public Member Functions
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	SLEEP_TIME = 500000

const	VBS_DESCRIPTION = 'Description'

const	VBS_DISPLAY_NAME = 'DisplayName'

const	VBS_NAME = 'Name'

const	VBS_PATH_NAME = 'PathName'

const	VBS_STATE = 'State'

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

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 16 of file class.win32service.php.

Constructor & Destructor Documentation

◆ __construct()

Win32Service::__construct ( $name )

Constructor for the Win32Service class.

Parameters

string $name The name of the service.

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

    {
        Util::logInitClass( $this );
        $this->name = $name;
    }

References $name, and Util\logInitClass().

Member Function Documentation

◆ callWin32Service()

Win32Service::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 134 of file class.win32service.php.

    {
        $result = false;
        if ( function_exists( $function ) ) {
            $result = call_user_func( $function, $param );
            if ( $checkError && dechex( $result ) != self::WIN32_NO_ERROR ) {
                $this->latestError = dechex( $result );
            }
        }
 
        return $result;
    }

References $result.

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

Here is the caller graph for this function:

◆ create()

Win32Service::create ( )

Creates the service.

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

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

    {
        global $bearsamppBins;
 
        if ( $this->getName() == BinFilezilla::SERVICE_NAME ) {
            $bearsamppBins->getFilezilla()->rebuildConf();
 
            return Batch::installFilezillaService();
        }
        elseif ( $this->getName() == BinPostgresql::SERVICE_NAME ) {
            $bearsamppBins->getPostgresql()->rebuildConf();
            $bearsamppBins->getPostgresql()->initData();
 
            return Batch::installPostgresqlService();
        }
        if ( $this->getNssm() instanceof Nssm ) {
            $nssmEnvPath = Util::getAppBinsRegKey( false );
            $nssmEnvPath .= Util::getNssmEnvPaths();
            $nssmEnvPath .= '%SystemRoot%/system32;';
            $nssmEnvPath .= '%SystemRoot%;';
            $nssmEnvPath .= '%SystemRoot%/system32/Wbem;';
            $nssmEnvPath .= '%SystemRoot%/system32/WindowsPowerShell/v1.0';
            $this->getNssm()->setEnvironmentExtra( 'PATH=' . $nssmEnvPath );
 
            return $this->getNssm()->create();
        }
 
        $create = dechex( $this->callWin32Service( 'win32_create_service', 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,
        ),                                         true ) );
 
        $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 ) {
            return false;
        }
        elseif ( !$this->isInstalled() ) {
            $this->latestError = self::WIN32_NO_ERROR;
 
            return false;
        }
 
        return true;
    }

References $bearsamppBins, callWin32Service(), Util\getAppBinsRegKey(), getBinPath(), getDisplayName(), getErrorControl(), getName(), getNssm(), Util\getNssmEnvPaths(), getParams(), getStartType(), Batch\installFilezillaService(), Batch\installPostgresqlService(), isInstalled(), SERVER_ERROR_NORMAL, SERVICE_DEMAND_START, BinFilezilla\SERVICE_NAME, BinPostgresql\SERVICE_NAME, status(), WIN32_NO_ERROR, and writeLog().

Referenced by reset().

Here is the caller graph for this function:

◆ delete()

Win32Service::delete ( )

Deletes the service.

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

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

    {
        if ( !$this->isInstalled() ) {
            return true;
        }
 
        $this->stop();
 
        if ( $this->getName() == BinFilezilla::SERVICE_NAME ) {
            return Batch::uninstallFilezillaService();
        }
        elseif ( $this->getName() == BinPostgresql::SERVICE_NAME ) {
            return Batch::uninstallPostgresqlService();
        }
 
        $delete = dechex( $this->callWin32Service( 'win32_delete_service', $this->getName(), true ) );
        $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 callWin32Service(), getName(), isInstalled(), BinFilezilla\SERVICE_NAME, BinPostgresql\SERVICE_NAME, status(), stop(), Batch\uninstallFilezillaService(), Batch\uninstallPostgresqlService(), WIN32_NO_ERROR, and writeLog().

◆ getBinPath()

Win32Service::getBinPath ( )

Gets the binary path of the service.

Returns: string The binary path of the service.

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

    {
        return $this->binPath;
    }

References $binPath.

Referenced by create().

Here is the caller graph for this function:

◆ getDisplayName()

Win32Service::getDisplayName ( )

Gets the display name of the service.

Returns: string The display name of the service.

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

    {
        return $this->displayName;
    }

References $displayName.

Referenced by create().

Here is the caller graph for this function:

◆ getError()

Win32Service::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 735 of file class.win32service.php.

    {
        global $bearsamppLang;
        if ( $this->latestError != self::WIN32_NO_ERROR ) {
            return $bearsamppLang->getValue( Lang::ERROR ) . ' ' .
                $this->latestError . ' (' . hexdec( $this->latestError ) . ' : ' . $this->getWin32ErrorCodeDesc( $this->latestError ) . ')';
        }
        elseif ( $this->latestStatus != self::WIN32_SERVICE_NA ) {
            return $bearsamppLang->getValue( Lang::STATUS ) . ' ' .
                $this->latestStatus . ' (' . hexdec( $this->latestStatus ) . ' : ' . $this->getWin32ServiceStatusDesc( $this->latestStatus ) . ')';
        }
 
        return null;
    }

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

◆ getErrorControl()

Win32Service::getErrorControl ( )

Gets the error control setting of the service.

Returns: string The error control setting of the service.

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

    {
        return $this->errorControl;
    }

References $errorControl.

Referenced by create().

Here is the caller graph for this function:

◆ getLatestError()

Win32Service::getLatestError ( )

Gets the latest error encountered by the service.

Returns: string The latest error encountered by the service.

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

    {
        return $this->latestError;
    }

References $latestError.

◆ getLatestStatus()

Win32Service::getLatestStatus ( )

Gets the latest status of the service.

Returns: string The latest status of the service.

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

    {
        return $this->latestStatus;
    }

References $latestStatus.

◆ getName()

Win32Service::getName ( )

Gets the name of the service.

Returns: string The name of the service.

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

    {
        return $this->name;
    }

References $name.

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

Here is the caller graph for this function:

◆ getNssm()

Win32Service::getNssm ( )

Gets the NSSM instance associated with the service.

Returns: Nssm The NSSM instance.

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

    {
        return $this->nssm;
    }

References $nssm.

Referenced by create(), and infos().

Here is the caller graph for this function:

◆ getParams()

Win32Service::getParams ( )

Gets the parameters for the service.

Returns: string The parameters for the service.

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

    {
        return $this->params;
    }

References $params.

Referenced by create().

Here is the caller graph for this function:

◆ getStartType()

Win32Service::getStartType ( )

Gets the start type of the service.

Returns: string The start type of the service.

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

    {
        return $this->startType;
    }

References $startType.

Referenced by create().

Here is the caller graph for this function:

◆ getVbsKeys()

static Win32Service::getVbsKeys ( )

static

Returns an array of VBS keys used for service information.

Returns: array The array of VBS keys.

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

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

Referenced by Vbs\getServiceInfos().

Here is the caller graph for this function:

◆ getWin32ErrorCodeDesc()

Win32Service::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 553 of file class.win32service.php.

    {
        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;
        }
    }

References WIN32_ERROR_ACCESS_DENIED.

Referenced by getError().

Here is the caller graph for this function:

◆ getWin32ServiceStatusDesc()

Win32Service::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 505 of file class.win32service.php.

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

References WIN32_SERVICE_CONTINUE_PENDING, WIN32_SERVICE_NA, WIN32_SERVICE_PAUSE_PENDING, WIN32_SERVICE_PAUSED, WIN32_SERVICE_RUNNING, WIN32_SERVICE_START_PENDING, WIN32_SERVICE_STOP_PENDING, and WIN32_SERVICE_STOPPED.

Referenced by getError().

Here is the caller graph for this function:

◆ infos()

Win32Service::infos ( )

Retrieves information about the service.

Returns: array The service information.

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

    {
        if ( $this->getNssm() instanceof Nssm ) {
            return $this->getNssm()->infos();
        }
 
        return Vbs::getServiceInfos( $this->getName() );
    }

References getName(), getNssm(), and Vbs\getServiceInfos().

◆ isInstalled()

Win32Service::isInstalled ( )

Checks if the service is installed.

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

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

    {
        $status = $this->status();
        $this->writeLog( 'isInstalled ' . $this->getName() . ': ' . ($status != self::WIN32_SERVICE_NA ? 'YES' : 'NO') . ' (status: ' . $status . ')' );
 
        return $status != self::WIN32_SERVICE_NA;
    }

References getName(), status(), WIN32_SERVICE_NA, and writeLog().

Referenced by create(), and delete().

Here is the caller graph for this function:

◆ isPaused()

Win32Service::isPaused ( )

Checks if the service is paused.

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

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

    {
        $status = $this->status();
        $this->writeLog( 'isPaused ' . $this->getName() . ': ' . ($status == self::WIN32_SERVICE_PAUSED ? 'YES' : 'NO') . ' (status: ' . $status . ')' );
 
        return $status == self::WIN32_SERVICE_PAUSED;
    }

References getName(), status(), WIN32_SERVICE_PAUSED, and writeLog().

◆ isPending()

Win32Service::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 492 of file class.win32service.php.

    {
        return $status == self::WIN32_SERVICE_START_PENDING || $status == self::WIN32_SERVICE_STOP_PENDING
            || $status == self::WIN32_SERVICE_CONTINUE_PENDING || $status == self::WIN32_SERVICE_PAUSE_PENDING;
    }

References WIN32_SERVICE_PAUSE_PENDING.

Referenced by status().

Here is the caller graph for this function:

◆ isRunning()

Win32Service::isRunning ( )

Checks if the service is running.

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

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

    {
        $status = $this->status();
        $this->writeLog( 'isRunning ' . $this->getName() . ': ' . ($status == self::WIN32_SERVICE_RUNNING ? 'YES' : 'NO') . ' (status: ' . $status . ')' );
 
        return $status == self::WIN32_SERVICE_RUNNING;
    }

References getName(), status(), WIN32_SERVICE_RUNNING, and writeLog().

Referenced by start().

Here is the caller graph for this function:

◆ isStopped()

Win32Service::isStopped ( )

Checks if the service is stopped.

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

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

    {
        $status = $this->status();
        $this->writeLog( 'isStopped ' . $this->getName() . ': ' . ($status == self::WIN32_SERVICE_STOPPED ? 'YES' : 'NO') . ' (status: ' . $status . ')' );
 
        return $status == self::WIN32_SERVICE_STOPPED;
    }

References getName(), status(), WIN32_SERVICE_STOPPED, and writeLog().

Referenced by stop().

Here is the caller graph for this function:

◆ reset()

Win32Service::reset ( )

Resets the service by deleting and recreating it.

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

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

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

References create().

◆ restart()

Win32Service::restart ( )

Restarts the service by stopping and then starting it.

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

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

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

References start(), and stop().

◆ setBinPath()

Win32Service::setBinPath ( $binPath )

Sets the binary path of the service.

Parameters

string $binPath The binary path to set.

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

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

References $binPath, and Util\formatWindowsPath().

Referenced by setNssm().

Here is the caller graph for this function:

◆ setDisplayName()

Win32Service::setDisplayName ( $displayName )

Sets the display name of the service.

Parameters

string $displayName The display name to set.

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

    {
        $this->displayName = $displayName;
    }

References $displayName.

Referenced by setNssm().

Here is the caller graph for this function:

◆ setErrorControl()

Win32Service::setErrorControl ( $errorControl )

Sets the error control setting of the service.

Parameters

string $errorControl The error control setting to set.

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

    {
        $this->errorControl = $errorControl;
    }

References $errorControl.

◆ setName()

Win32Service::setName ( $name )

Sets the name of the service.

Parameters

string $name The name to set.

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

    {
        $this->name = $name;
    }

References $name.

◆ setNssm()

Win32Service::setNssm ( $nssm )

Sets the NSSM instance associated with the service.

Parameters

Nssm $nssm The NSSM instance to set.

Definition at line 699 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().

◆ setParams()

Win32Service::setParams ( $params )

Sets the parameters for the service.

Parameters

string $params The parameters to set.

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

    {
        $this->params = $params;
    }

References $params.

Referenced by setNssm().

Here is the caller graph for this function:

◆ setStartType()

Win32Service::setStartType ( $startType )

Sets the start type of the service.

Parameters

string $startType The start type to set.

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

    {
        $this->startType = $startType;
    }

References $startType.

Referenced by setNssm().

Here is the caller graph for this function:

◆ start()

Win32Service::start ( )

Starts the service.

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

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

    {
        global $bearsamppBins;
 
        Util::logInfo('Attempting to start service: ' . $this->getName());
 
        if ( $this->getName() == BinFilezilla::SERVICE_NAME ) {
            $bearsamppBins->getFilezilla()->rebuildConf();
        }
        elseif ( $this->getName() == BinMysql::SERVICE_NAME ) {
            $bearsamppBins->getMysql()->initData();
        }
        elseif ( $this->getName() == BinMailhog::SERVICE_NAME ) {
            $bearsamppBins->getMailhog()->rebuildConf();
        }
        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();
        }
 
 
        $start = dechex( $this->callWin32Service( 'win32_start_service', $this->getName(), true ) );
        Util::logDebug( '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
            Util::logError('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;
        }
        elseif ( !$this->isRunning() ) {
            $this->latestError = self::WIN32_NO_ERROR;
            Util::logError('Service ' . $this->getName() . ' is not running after start attempt.');
            $this->latestError = null;
            return false;
        }
 
        Util::logInfo('Service ' . $this->getName() . ' started successfully.');
        return true;
    }

References $bearsamppBins, callWin32Service(), BinApache\CMD_SYNTAX_CHECK, BinMariadb\CMD_SYNTAX_CHECK, BinMysql\CMD_SYNTAX_CHECK, getName(), isRunning(), Util\logDebug(), Util\logError(), Util\logInfo(), BinApache\SERVICE_NAME, BinFilezilla\SERVICE_NAME, BinMailhog\SERVICE_NAME, BinMailpit\SERVICE_NAME, BinMariadb\SERVICE_NAME, BinMemcached\SERVICE_NAME, BinMysql\SERVICE_NAME, BinPostgresql\SERVICE_NAME, BinXlight\SERVICE_NAME, status(), and WIN32_NO_ERROR.

Referenced by restart().

Here is the caller graph for this function:

◆ status()

Win32Service::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 154 of file class.win32service.php.

    {
        usleep( self::SLEEP_TIME );
 
        $this->latestStatus = self::WIN32_SERVICE_NA;
        $maxtime            = time() + self::PENDING_TIMEOUT;
 
        while ( $this->latestStatus == self::WIN32_SERVICE_NA || $this->isPending( $this->latestStatus ) ) {
            $this->latestStatus = $this->callWin32Service( 'win32_query_service_status', $this->getName() );
            if ( is_array( $this->latestStatus ) && isset( $this->latestStatus['CurrentState'] ) ) {
                $this->latestStatus = dechex( $this->latestStatus['CurrentState'] );
            }
            elseif ( dechex( $this->latestStatus ) == self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST ) {
                $this->latestStatus = dechex( $this->latestStatus );
            }
            if ( $timeout && $maxtime < time() ) {
                break;
            }
        }
 
        if ( $this->latestStatus == self::WIN32_ERROR_SERVICE_DOES_NOT_EXIST ) {
            $this->latestError  = $this->latestStatus;
            $this->latestStatus = self::WIN32_SERVICE_NA;
        }
 
        return $this->latestStatus;
    }

References $latestStatus, callWin32Service(), getName(), isPending(), PENDING_TIMEOUT, and WIN32_SERVICE_NA.

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

Here is the caller graph for this function:

◆ stop()

Win32Service::stop ( )

Stops the service.

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

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

    {
        $stop = dechex( $this->callWin32Service( 'win32_stop_service', $this->getName(), true ) );
        $this->writeLog( 'Stop service ' . $this->getName() . ': ' . $stop . ' (status: ' . $this->status() . ')' );
 
        if ( $stop != self::WIN32_NO_ERROR ) {
            return false;
        }
        elseif ( !$this->isStopped() ) {
            $this->latestError = self::WIN32_NO_ERROR;
 
            return false;
        }
 
        return true;
    }

References callWin32Service(), getName(), isStopped(), status(), WIN32_NO_ERROR, and writeLog().

Referenced by delete(), and restart().

Here is the caller graph for this function:

◆ writeLog()

Win32Service::writeLog ( $log )

private

Writes a log entry.

Parameters

string $log The log message.

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

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

References $bearsamppRoot, and Util\logDebug().

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

Here is the caller graph for this function:

Field Documentation

◆ $binPath

Win32Service::$binPath

private

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

Referenced by getBinPath(), and setBinPath().

◆ $displayName

Win32Service::$displayName

private

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

Referenced by getDisplayName(), and setDisplayName().

◆ $errorControl

Win32Service::$errorControl

private

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

Referenced by getErrorControl(), and setErrorControl().

◆ $latestError

Win32Service::$latestError

private

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

Referenced by getLatestError().

◆ $latestStatus

Win32Service::$latestStatus

private

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

Referenced by getLatestStatus(), and status().

◆ $name

Win32Service::$name

private

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

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

◆ $nssm

Win32Service::$nssm

private

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

Referenced by getNssm(), and setNssm().

◆ $params

Win32Service::$params

private

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

Referenced by getParams(), and setParams().

◆ $startType

Win32Service::$startType

private

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

Referenced by getStartType(), and setStartType().

◆ PENDING_TIMEOUT

const Win32Service::PENDING_TIMEOUT = 20

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

Referenced by status().

◆ SERVER_ERROR_IGNORE

const Win32Service::SERVER_ERROR_IGNORE = '0'

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

◆ SERVER_ERROR_NORMAL

const Win32Service::SERVER_ERROR_NORMAL = '1'

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

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

◆ SERVICE_AUTO_START

const Win32Service::SERVICE_AUTO_START = '2'

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

◆ SERVICE_DEMAND_START

const Win32Service::SERVICE_DEMAND_START = '3'

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

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

◆ SERVICE_DISABLED

const Win32Service::SERVICE_DISABLED = '4'

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

◆ SLEEP_TIME

const Win32Service::SLEEP_TIME = 500000

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

◆ VBS_DESCRIPTION

const Win32Service::VBS_DESCRIPTION = 'Description'

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

◆ VBS_DISPLAY_NAME

const Win32Service::VBS_DISPLAY_NAME = 'DisplayName'

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

◆ VBS_NAME

const Win32Service::VBS_NAME = 'Name'

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

◆ VBS_PATH_NAME

const Win32Service::VBS_PATH_NAME = 'PathName'

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

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

◆ VBS_STATE

const Win32Service::VBS_STATE = 'State'

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

◆ WIN32_ERROR_ACCESS_DENIED

const Win32Service::WIN32_ERROR_ACCESS_DENIED = '5'

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

Referenced by getWin32ErrorCodeDesc().

◆ WIN32_ERROR_CIRCULAR_DEPENDENCY

const Win32Service::WIN32_ERROR_CIRCULAR_DEPENDENCY = '423'

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

◆ WIN32_ERROR_DATABASE_DOES_NOT_EXIST

const Win32Service::WIN32_ERROR_DATABASE_DOES_NOT_EXIST = '429'

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

◆ WIN32_ERROR_DEPENDENT_SERVICES_RUNNING

const Win32Service::WIN32_ERROR_DEPENDENT_SERVICES_RUNNING = '41B'

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

◆ WIN32_ERROR_DUPLICATE_SERVICE_NAME

const Win32Service::WIN32_ERROR_DUPLICATE_SERVICE_NAME = '436'

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

◆ WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT

const Win32Service::WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT = '427'

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

◆ WIN32_ERROR_INSUFFICIENT_BUFFER

const Win32Service::WIN32_ERROR_INSUFFICIENT_BUFFER = '7A'

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

◆ WIN32_ERROR_INVALID_DATA

const Win32Service::WIN32_ERROR_INVALID_DATA = 'D'

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

◆ WIN32_ERROR_INVALID_HANDLE

const Win32Service::WIN32_ERROR_INVALID_HANDLE = '6'

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

◆ WIN32_ERROR_INVALID_LEVEL

const Win32Service::WIN32_ERROR_INVALID_LEVEL = '7C'

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

◆ WIN32_ERROR_INVALID_NAME

const Win32Service::WIN32_ERROR_INVALID_NAME = '7B'

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

◆ WIN32_ERROR_INVALID_PARAMETER

const Win32Service::WIN32_ERROR_INVALID_PARAMETER = '57'

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

◆ WIN32_ERROR_INVALID_SERVICE_ACCOUNT

const Win32Service::WIN32_ERROR_INVALID_SERVICE_ACCOUNT = '421'

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

◆ WIN32_ERROR_INVALID_SERVICE_CONTROL

const Win32Service::WIN32_ERROR_INVALID_SERVICE_CONTROL = '41C'

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

◆ WIN32_ERROR_PATH_NOT_FOUND

const Win32Service::WIN32_ERROR_PATH_NOT_FOUND = '3'

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

◆ WIN32_ERROR_SERVICE_ALREADY_RUNNING

const Win32Service::WIN32_ERROR_SERVICE_ALREADY_RUNNING = '420'

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

◆ WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL

const Win32Service::WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL = '425'

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

◆ WIN32_ERROR_SERVICE_DATABASE_LOCKED

const Win32Service::WIN32_ERROR_SERVICE_DATABASE_LOCKED = '41F'

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

◆ WIN32_ERROR_SERVICE_DEPENDENCY_DELETED

const Win32Service::WIN32_ERROR_SERVICE_DEPENDENCY_DELETED = '433'

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

◆ WIN32_ERROR_SERVICE_DEPENDENCY_FAIL

const Win32Service::WIN32_ERROR_SERVICE_DEPENDENCY_FAIL = '42C'

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

◆ WIN32_ERROR_SERVICE_DISABLED

const Win32Service::WIN32_ERROR_SERVICE_DISABLED = '422'

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

◆ WIN32_ERROR_SERVICE_DOES_NOT_EXIST

const Win32Service::WIN32_ERROR_SERVICE_DOES_NOT_EXIST = '424'

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

◆ WIN32_ERROR_SERVICE_EXISTS

const Win32Service::WIN32_ERROR_SERVICE_EXISTS = '431'

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

◆ WIN32_ERROR_SERVICE_LOGON_FAILED

const Win32Service::WIN32_ERROR_SERVICE_LOGON_FAILED = '42D'

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

◆ WIN32_ERROR_SERVICE_MARKED_FOR_DELETE

const Win32Service::WIN32_ERROR_SERVICE_MARKED_FOR_DELETE = '430'

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

◆ WIN32_ERROR_SERVICE_NO_THREAD

const Win32Service::WIN32_ERROR_SERVICE_NO_THREAD = '41E'

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

◆ WIN32_ERROR_SERVICE_NOT_ACTIVE

const Win32Service::WIN32_ERROR_SERVICE_NOT_ACTIVE = '426'

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

◆ WIN32_ERROR_SERVICE_REQUEST_TIMEOUT

const Win32Service::WIN32_ERROR_SERVICE_REQUEST_TIMEOUT = '41D'

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

◆ WIN32_ERROR_SHUTDOWN_IN_PROGRESS

const Win32Service::WIN32_ERROR_SHUTDOWN_IN_PROGRESS = '45B'

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

◆ WIN32_NO_ERROR

const Win32Service::WIN32_NO_ERROR = '0'

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

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

◆ WIN32_SERVICE_CONTINUE_PENDING

const Win32Service::WIN32_SERVICE_CONTINUE_PENDING = '5'

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

Referenced by getWin32ServiceStatusDesc().

◆ WIN32_SERVICE_NA

const Win32Service::WIN32_SERVICE_NA = '0'

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

Referenced by getWin32ServiceStatusDesc(), isInstalled(), and status().

◆ WIN32_SERVICE_PAUSE_PENDING

const Win32Service::WIN32_SERVICE_PAUSE_PENDING = '6'

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

Referenced by getWin32ServiceStatusDesc(), and isPending().

◆ WIN32_SERVICE_PAUSED

const Win32Service::WIN32_SERVICE_PAUSED = '7'

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

Referenced by getWin32ServiceStatusDesc(), and isPaused().

◆ WIN32_SERVICE_RUNNING

const Win32Service::WIN32_SERVICE_RUNNING = '4'

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

Referenced by getWin32ServiceStatusDesc(), and isRunning().

◆ WIN32_SERVICE_START_PENDING

const Win32Service::WIN32_SERVICE_START_PENDING = '2'

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

Referenced by getWin32ServiceStatusDesc().

◆ WIN32_SERVICE_STOP_PENDING

const Win32Service::WIN32_SERVICE_STOP_PENDING = '3'

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

Referenced by getWin32ServiceStatusDesc().

◆ WIN32_SERVICE_STOPPED

const Win32Service::WIN32_SERVICE_STOPPED = '1'

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

Referenced by getWin32ServiceStatusDesc(), and isStopped().

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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ callWin32Service()

◆ create()

◆ delete()

◆ getBinPath()

◆ getDisplayName()

◆ getError()

◆ getErrorControl()

◆ getLatestError()

◆ getLatestStatus()

◆ getName()

◆ getNssm()

◆ getParams()

◆ getStartType()

◆ getVbsKeys()

◆ getWin32ErrorCodeDesc()

◆ getWin32ServiceStatusDesc()

◆ infos()

◆ isInstalled()

◆ isPaused()

◆ isPending()

◆ isRunning()

◆ isStopped()

◆ reset()

◆ restart()

◆ setBinPath()

◆ setDisplayName()

◆ setErrorControl()

◆ setName()

◆ setNssm()

◆ setParams()

◆ setStartType()

◆ start()

◆ status()

◆ stop()

◆ writeLog()

Field Documentation

◆ $binPath

◆ $displayName

◆ $errorControl

◆ $latestError

◆ $latestStatus

◆ $name

◆ $nssm

◆ $params

◆ $startType

◆ PENDING_TIMEOUT

◆ SERVER_ERROR_IGNORE

◆ SERVER_ERROR_NORMAL

◆ SERVICE_AUTO_START

◆ SERVICE_DEMAND_START

◆ SERVICE_DISABLED

◆ SLEEP_TIME

◆ VBS_DESCRIPTION

◆ VBS_DISPLAY_NAME

◆ VBS_NAME

◆ VBS_PATH_NAME

◆ VBS_STATE

◆ 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

◆ WIN32_ERROR_INVALID_DATA

◆ WIN32_ERROR_INVALID_HANDLE

◆ WIN32_ERROR_INVALID_LEVEL

◆ WIN32_ERROR_INVALID_NAME

◆ WIN32_ERROR_INVALID_PARAMETER

◆ WIN32_ERROR_INVALID_SERVICE_ACCOUNT

◆ WIN32_ERROR_INVALID_SERVICE_CONTROL