BinXlight Class Reference

Inheritance diagram for BinXlight:

Collaboration diagram for BinXlight:

Public Member Functions
	__construct ($id, $type)
	changePort ($port, $checkUsed=false, $wbProgressBar=null)
	checkPort ($port, $showWindow=false)
	getExe ()
	getLog ()
	getPort ()
	getService ()
	getUiPort ()
	rebuildConf ()
	reload ($id=null, $type=null)
	setEnable ($enabled, $showWindow=false)
	setPort ($port)
	setSslPort ($SslPort)
	setVersion ($version)
	switchVersion ($version, $showWindow=false)
Public Member Functions inherited from Module
	__toString ()
	getId ()
	getName ()
	getRelease ()
	getType ()
	getVersion ()
	getVersionList ()
	isEnable ()
	update ($sub=0, $showWindow=false)

Data Fields
const	LOCAL_CFG_EXE = 'xlightExe'
const	LOCAL_CFG_PORT = 'xlightPort'
const	LOCAL_CFG_SSL_PORT = 'xlightSslPort'
const	ROOT_CFG_ENABLE = 'xlightEnable'
const	ROOT_CFG_VERSION = 'xlightVersion'
const	SERVICE_NAME = 'bearsamppxlight'
const	SERVICE_PARAMS = ' -startall'
Data Fields inherited from Module
	$currentPath
	$rootPath
	$symlinkPath

Protected Member Functions
	replaceAll ($params)
	updateConfig ($version=null, $sub=0, $showWindow=false)
Protected Member Functions inherited from Module
	__construct ()
	replace ($key, $value)

Private Attributes
	$exe
	$log
	$port
	$service
	$SslPort

Additional Inherited Members
Static Public Member Functions inherited from Module
static	clearMemoryCache ()
static	invalidateConfigCacheForPath ($sourcePath)
Protected Attributes inherited from Module
	$bearsamppConf
	$bearsamppConfRaw
	$enable
	$name
	$release = 'N/A'
	$version

Detailed Description

Class BinXlight

This class represents the Xlight FTP server module in the Bearsampp application. It handles the configuration, initialization, and management of the Xlight FTP server.

Definition at line 17 of file class.bin.xlight.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$id,
			$type )

Constructs a BinXlight object and initializes the module.

Parameters

string	$id	The ID of the module.
string	$type	The type of the module.

Definition at line 78 of file class.bin.xlight.php.

    {
        Log::initClass($this);
        $this->reload($id, $type);
    }

References Module\$id, Module\$type, Log\initClass(), and reload().

Here is the call graph for this function:

Member Function Documentation

changePort()

changePort	(		$port,
			$checkUsed = false,
			$wbProgressBar = null )

Changes the port used by the Xlight FTP server.

Parameters

int	$port	The new port number.
bool	$checkUsed	Whether to check if the port is already in use.
mixed | null	$wbProgressBar	The progress bar object for UI updates (optional).

Returns

bool|int True if the port was successfully changed, false if invalid, or the process using the port.

Definition at line 218 of file class.bin.xlight.php.

    {
        global $bearsamppWinbinder;
 
        if (!Util::isValidPort($port)) {
            Log::error($this->getName() . ' port not valid: ' . $port);
 
            return false;
        }
 
        $port = intval($port);
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        $isPortInUse = ServiceHelper::isPortInUse($port);
        if (!$checkUsed || $isPortInUse === false) {
            // bearsampp.conf
            $this->setPort($port);
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            // conf
            $this->update();
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            return true;
        }
 
        Log::debug($this->getName() . ' port in used: ' . $port . ' - ' . $isPortInUse);
 
        return $isPortInUse;
    }

References $port, Log\debug(), Log\error(), Module\getName(), ServiceHelper\isPortInUse(), Util\isValidPort(), setPort(), and Module\update().

Here is the call graph for this function:

checkPort()

checkPort	(		$port,
			$showWindow = false )

Checks if a port is used by the Xlight FTP server.

Parameters

int	$port	The port number to check.
bool	$showWindow	Whether to show a message box with the result.

Returns

bool True if the port is used by Xlight, false otherwise.

Definition at line 257 of file class.bin.xlight.php.

    {
        global $bearsamppLang, $bearsamppWinbinder;
        $boxTitle = sprintf($bearsamppLang->getValue(Lang::CHECK_PORT_TITLE), $this->getName(), $port);
 
        if (!Util::isValidPort($port)) {
            Log::error($this->getName() . ' port not valid: ' . $port);
 
            return false;
        }
 
        $headers = HttpClient::getHeaders(APP_LOCALHOST, $port);
        if (!empty($headers)) {
            if (UtilString::contains($headers[0], 'Xlight')) {
                Log::debug($this->getName() . ' port ' . $port . ' is used by: ' . str_replace('220 ', '', $headers[0]));
                if ($showWindow) {
                    $bearsamppWinbinder->messageBoxInfo(
                        sprintf($bearsamppLang->getValue(Lang::PORT_USED_BY), $port, str_replace('220 ', '', $headers[0])),
                        $boxTitle
                    );
                }
 
                return true;
            }
            Log::debug($this->getName() . ' port ' . $port . ' is used by another application');
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxWarning(
                    sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED_BY), $port),
                    $boxTitle
                );
            }
        } else {
            Log::debug($this->getName() . ' port ' . $port . ' is not used');
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED), $port),
                    $boxTitle
                );
            }
        }
 
        return false;
    }

References $bearsamppLang, $port, APP_LOCALHOST, Lang\CHECK_PORT_TITLE, UtilString\contains(), Log\debug(), Log\error(), HttpClient\getHeaders(), Module\getName(), Util\isValidPort(), Lang\PORT_NOT_USED, Lang\PORT_NOT_USED_BY, and Lang\PORT_USED_BY.

Here is the call graph for this function:

getExe()

getExe

(

)

Gets the executable file path for the Xlight FTP server.

Returns

string The executable file path.

Definition at line 441 of file class.bin.xlight.php.

    {
        return $this->exe;
    }

References $exe.

getLog()

getLog

(

)

Gets the log file path for the Xlight FTP server.

Returns

string The log file path.

Definition at line 431 of file class.bin.xlight.php.

    {
        return $this->log;
    }

References $log.

getPort()

getPort

(

)

Gets the port used by the Xlight FTP server.

Returns

int The port number.

Definition at line 471 of file class.bin.xlight.php.

    {
        return $this->port;
    }

References $port.

getService()

getService

(

)

Gets the service object for the Xlight FTP server.

Returns

Win32Service The service object.

Definition at line 388 of file class.bin.xlight.php.

    {
        return $this->service;
    }

References $service.

getUiPort()

getUiPort

(

)

Gets the SSL port used by the Xlight FTP server.

Returns

int The SSL port number.

Definition at line 451 of file class.bin.xlight.php.

    {
        return $this->SslPort;
    }

References $SslPort.

rebuildConf()

rebuildConf

(

)

Rebuilds the configuration in the Windows Registry.

Returns

bool True if the configuration was successfully rebuilt, false otherwise.

Definition at line 188 of file class.bin.xlight.php.

    {
        global $bearsamppRegistry;
 
        $exists = $bearsamppRegistry->exists(
            Registry::HKEY_LOCAL_MACHINE,
            'SYSTEM\CurrentControlSet\Services\\' . self::SERVICE_NAME . '\Parameters',
            Nssm::INFO_APP_PARAMETERS
        );
        if ($exists) {
            return $bearsamppRegistry->setExpandStringValue(
                Registry::HKEY_LOCAL_MACHINE,
                'SYSTEM\CurrentControlSet\Services\\' . self::SERVICE_NAME . '\Parameters',
                Nssm::INFO_APP_PARAMETERS,
                sprintf(self::SERVICE_PARAMS, $this->SslPort, $this->port)
            );
        }
 
        return false;
    }

References Registry\HKEY_LOCAL_MACHINE, and Nssm\INFO_APP_PARAMETERS.

reload()

reload	(		$id = null,
			$type = null )

Reloads the module configuration based on the provided ID and type.

Parameters

string | null	$id	The ID of the module. If null, the current ID is used.
string | null	$type	The type of the module. If null, the current type is used.

Reimplemented from Module.

Definition at line 90 of file class.bin.xlight.php.

    {
        global $bearsamppRoot, $bearsamppConfig, $bearsamppLang;
        Log::reloadClass($this);
 
        $this->name    = $bearsamppLang->getValue(Lang::XLIGHT);
        $this->version = $bearsamppConfig->getRaw(self::ROOT_CFG_VERSION);
        parent::reload($id, $type);
 
        $this->enable  = $this->enable && $bearsamppConfig->getRaw(self::ROOT_CFG_ENABLE);
        $this->service = new Win32Service(self::SERVICE_NAME);
        $this->log     = Path::getLogsPath() . '/xlight.log';
 
        if ($this->bearsamppConfRaw !== false) {
            $this->exe     = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_EXE];
            $this->SslPort = intval($this->bearsamppConfRaw[self::LOCAL_CFG_SSL_PORT]);
            $this->port    = intval($this->bearsamppConfRaw[self::LOCAL_CFG_PORT]);
        }
 
        if (!$this->enable) {
            Log::info($this->name . ' is not enabled!');
 
            return;
        }
        if (!is_dir($this->currentPath)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_FILE_NOT_FOUND), $this->name . ' ' . $this->version, $this->currentPath));
 
            return;
        }
        if (!is_dir($this->symlinkPath)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_FILE_NOT_FOUND), $this->name . ' ' . $this->version, $this->symlinkPath));
 
            return;
        }
        if (!is_file($this->bearsamppConf)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->bearsamppConf));
 
            return;
        }
        if (!is_file($this->exe)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->exe));
 
            return;
        }
        if (empty($this->SslPort)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_SSL_PORT, $this->SslPort));
 
            return;
        }
        if (empty($this->port)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_PORT, $this->port));
 
            return;
        }
 
        $nssm = new Nssm(self::SERVICE_NAME);
        $nssm->setDisplayName(APP_TITLE . ' ' . $this->getName());
        $nssm->setBinPath($this->exe);
        $nssm->setParams(sprintf(self::SERVICE_PARAMS, $this->SslPort, $this->port));
        $nssm->setStart(Nssm::SERVICE_DEMAND_START);
        $nssm->setStdout(Path::getLogsPath() . '/xlight.log');
        $nssm->setStderr(Path::getLogsPath() . '/xlight.error.log');
 
        $this->service->setNssm($nssm);
    }

References $bearsamppConfig, $bearsamppLang, $bearsamppRoot, Module\$id, Module\$type, APP_TITLE, Log\error(), Lang\ERROR_CONF_NOT_FOUND, Lang\ERROR_EXE_NOT_FOUND, Lang\ERROR_FILE_NOT_FOUND, Lang\ERROR_INVALID_PARAMETER, Path\getLogsPath(), Module\getName(), Log\info(), Log\reloadClass(), Nssm\SERVICE_DEMAND_START, and Lang\XLIGHT.

Referenced by __construct(), setEnable(), and setVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

replaceAll()

replaceAll ( $params )

protected

Replaces multiple key-value pairs in the configuration file.

Parameters

array

$params

An associative array of key-value pairs to replace.

Reimplemented from Module.

Definition at line 161 of file class.bin.xlight.php.

    {
        $content = file_get_contents($this->bearsamppConf);
 
        foreach ($params as $key => $value) {
            $content                      = preg_replace('|' . $key . ' = .*|', $key . ' = ' . '"' . $value . '"', $content);
            $this->bearsamppConfRaw[$key] = $value;
            switch ($key) {
                case self::LOCAL_CFG_SSL_PORT:
                    $this->SslPort = intval($value);
                    break;
                case self::LOCAL_CFG_PORT:
                    $this->port = intval($value);
                    break;
            }
        }
 
        file_put_contents($this->bearsamppConf, $content);
 
        self::invalidateConfigCacheForPath($this->bearsamppConf);
    }

References Module\invalidateConfigCacheForPath().

Here is the call graph for this function:

setEnable()

setEnable	(		$enabled,
			$showWindow = false )

Enables or disables the Xlight FTP server.

Parameters

bool	$enabled	Whether to enable or disable the server.
bool	$showWindow	Whether to show a message box with the result.

Definition at line 399 of file class.bin.xlight.php.

    {
        global $bearsamppConfig, $bearsamppLang, $bearsamppWinbinder;
 
        if ($enabled == Config::ENABLED && !is_dir($this->currentPath)) {
            Log::debug($this->getName() . ' cannot be enabled because bundle ' . $this->getVersion() . ' does not exist in ' . $this->currentPath);
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::ENABLE_BUNDLE_NOT_EXIST), $this->getName(), $this->getVersion(), $this->currentPath),
                    sprintf($bearsamppLang->getValue(Lang::ENABLE_TITLE), $this->getName())
                );
            }
            $enabled = Config::DISABLED;
        }
 
        Log::info($this->getName() . ' switched to ' . ($enabled == Config::ENABLED ? 'enabled' : 'disabled'));
        $this->enable = $enabled == Config::ENABLED;
        $bearsamppConfig->replace(self::ROOT_CFG_ENABLE, $enabled);
 
        $this->reload();
        if ($this->enable) {
            ServiceHelper::installService($this, $this->port, null, $showWindow);
        } else {
            ServiceHelper::removeService($this->service, $this->name);
        }
    }

References $bearsamppConfig, $bearsamppLang, Log\debug(), Config\DISABLED, Lang\ENABLE_BUNDLE_NOT_EXIST, Lang\ENABLE_TITLE, Config\ENABLED, Module\getName(), Module\getVersion(), Log\info(), ServiceHelper\installService(), reload(), and ServiceHelper\removeService().

Here is the call graph for this function:

setPort()

setPort

(

$port

)

Sets the port for the Xlight FTP server.

Parameters

int

$port

The port number.

Definition at line 481 of file class.bin.xlight.php.

    {
        $this->replace(self::LOCAL_CFG_PORT, $port);
    }

References $port, and Module\replace().

Referenced by changePort().

Here is the call graph for this function:

Here is the caller graph for this function:

setSslPort()

setSslPort

(

$SslPort

)

Sets the SSL port for the Xlight FTP server.

Parameters

int

$SslPort

The SSL port number.

Definition at line 461 of file class.bin.xlight.php.

    {
        $this->replace(self::LOCAL_CFG_SSL_PORT, $SslPort);
    }

References $SslPort, and Module\replace().

Here is the call graph for this function:

setVersion()

setVersion

(

$version

)

Sets the version of the Xlight FTP server.

Parameters

string

$version

The version to set.

Reimplemented from Module.

Definition at line 375 of file class.bin.xlight.php.

    {
        global $bearsamppConfig;
        $this->version = $version;
        $bearsamppConfig->replace(self::ROOT_CFG_VERSION, $version);
        $this->reload();
    }

References $bearsamppConfig, Module\$version, and reload().

Referenced by updateConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

switchVersion()

switchVersion	(		$version,
			$showWindow = false )

Switches the version of the Xlight FTP server.

Parameters

string	$version	The version to switch to.
bool	$showWindow	Whether to show a message box with the result.

Returns

bool True if the version was successfully switched, false otherwise.

Definition at line 309 of file class.bin.xlight.php.

    {
        Log::debug('Switch ' . $this->name . ' version to ' . $version);
 
        return $this->updateConfig($version, 0, $showWindow);
    }

References Module\$version, Log\debug(), and updateConfig().

Here is the call graph for this function:

updateConfig()

updateConfig ( $version = null, $sub = 0, $showWindow = false )

protected

Updates the configuration of the Xlight FTP server.

Parameters

string | null	$version	The version to update to. If null, the current version is used.
int	$sub	The sub-level for logging indentation.
bool	$showWindow	Whether to show a message box with the result.

Returns

bool True if the configuration was successfully updated, false otherwise.

Reimplemented from Module.

Definition at line 325 of file class.bin.xlight.php.

    {
        global $bearsamppLang, $bearsamppWinbinder;
 
        if (!$this->enable) {
            return true;
        }
 
        $version = $version == null ? $this->version : $version;
        Log::debug(($sub > 0 ? str_repeat(' ', 2 * $sub) : '') . 'Update ' . $this->name . ' ' . $version . ' config');
 
        $boxTitle = sprintf($bearsamppLang->getValue(Lang::SWITCH_VERSION_TITLE), $this->getName(), $version);
 
        $bearsamppConf = str_replace('xlight' . $this->getVersion(), 'xlight' . $version, $this->bearsamppConf);
        if (!file_exists($bearsamppConf)) {
            Log::error('bearsampp config files not found for ' . $this->getName() . ' ' . $version);
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::BEARSAMPP_CONF_NOT_FOUND_ERROR), $this->getName() . ' ' . $version),
                    $boxTitle
                );
            }
 
            return false;
        }
 
        $bearsamppConfRaw = parse_ini_file($bearsamppConf);
        if ($bearsamppConfRaw === false || !isset($bearsamppConfRaw[self::ROOT_CFG_VERSION]) || $bearsamppConfRaw[self::ROOT_CFG_VERSION] != $version) {
            Log::error('bearsampp config file malformed for ' . $this->getName() . ' ' . $version);
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::BEARSAMPP_CONF_MALFORMED_ERROR), $this->getName() . ' ' . $version),
                    $boxTitle
                );
            }
 
            return false;
        }
 
        // bearsampp.conf
        $this->setVersion($version);
 
        return true;
    }

References Module\$bearsamppConf, Module\$bearsamppConfRaw, $bearsamppLang, Module\$version, Lang\BEARSAMPP_CONF_MALFORMED_ERROR, Lang\BEARSAMPP_CONF_NOT_FOUND_ERROR, Log\debug(), Log\error(), Module\getName(), Module\getVersion(), setVersion(), and Lang\SWITCH_VERSION_TITLE.

Referenced by switchVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$exe

$exe

private

Definition at line 62 of file class.bin.xlight.php.

Referenced by getExe().

$log

$log

private

Definition at line 57 of file class.bin.xlight.php.

Referenced by getLog().

$port

$port

private

Definition at line 66 of file class.bin.xlight.php.

Referenced by changePort(), checkPort(), getPort(), and setPort().

$service

$service

private

Definition at line 53 of file class.bin.xlight.php.

Referenced by getService().

$SslPort

$SslPort

private

Definition at line 70 of file class.bin.xlight.php.

Referenced by getUiPort(), and setSslPort().

LOCAL_CFG_EXE

const LOCAL_CFG_EXE = 'xlightExe'

Configuration key for the Xlight executable in the local configuration.

Definition at line 40 of file class.bin.xlight.php.

LOCAL_CFG_PORT

const LOCAL_CFG_PORT = 'xlightPort'

Configuration key for the Xlight port in the local configuration.

Definition at line 48 of file class.bin.xlight.php.

LOCAL_CFG_SSL_PORT

const LOCAL_CFG_SSL_PORT = 'xlightSslPort'

Configuration key for the Xlight SSL port in the local configuration.

Definition at line 44 of file class.bin.xlight.php.

ROOT_CFG_ENABLE

const ROOT_CFG_ENABLE = 'xlightEnable'

Configuration key for the Xlight enable flag in the root configuration.

Definition at line 31 of file class.bin.xlight.php.

ROOT_CFG_VERSION

const ROOT_CFG_VERSION = 'xlightVersion'

Configuration key for the Xlight version in the root configuration.

Definition at line 35 of file class.bin.xlight.php.

SERVICE_NAME

const SERVICE_NAME = 'bearsamppxlight'

The name of the Windows service.

Definition at line 22 of file class.bin.xlight.php.

Referenced by ActionService\__construct(), ServiceHelper\forceKillService(), TplAppXlight\getActionInstallXlightService(), TplAppXlight\getActionRemoveXlightService(), ServiceHelper\getAllServiceNames(), ActionQuit\getServiceDisplayName(), Bins\getServices(), ActionQuit\getServiceShutdownOrder(), ActionRestartAllServices\getServiceShutdownOrder(), ActionRestartAllServices\getServiceStartupOrder(), ServiceHelper\initializeMappings(), ActionStartup\prepareService(), and Win32Service\start().

SERVICE_PARAMS

const SERVICE_PARAMS = ' -startall'

The command line parameters passed to the Xlight service.

Definition at line 26 of file class.bin.xlight.php.

---

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

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