BinMemcached Class Reference

Inheritance diagram for BinMemcached:

Collaboration diagram for BinMemcached:

Public Member Functions
	__construct ($id, $type)
	changePort ($port, $checkUsed=false, $wbProgressBar=null)
	checkPort ($port, $showWindow=false)
	getExe ()
	getLog ()
	getMemory ()
	getPort ()
	getService ()
	rebuildConf ()
	reload ($id=null, $type=null)
	setEnable ($enabled, $showWindow=false)
	setMemory ($memory)
	setPort ($port)
	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 = 'memcachedExe'
const	LOCAL_CFG_MEMORY = 'memcachedMemory'
const	LOCAL_CFG_PORT = 'memcachedPort'
const	ROOT_CFG_ENABLE = 'memcachedEnable'
const	ROOT_CFG_VERSION = 'memcachedVersion'
const	SERVICE_NAME = 'bearsamppmemcached'
const	SERVICE_PARAMS = '-m %d -p %d -U 0 -vv'
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
	$memory
	$port
	$service

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 BinMemcached

This class represents the Memcached service module in the Bearsampp application. It handles the configuration, initialization, and management of the Memcached service.

Definition at line 16 of file class.bin.memcached.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$id,
			$type )

Constructs a BinMemcached object and initializes the Memcached service.

Parameters

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

Definition at line 77 of file class.bin.memcached.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 for the Memcached service.

Parameters

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

Returns

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

Definition at line 217 of file class.bin.memcached.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 the specified port is in use by the Memcached service.

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 in use by Memcached, false otherwise.

Definition at line 256 of file class.bin.memcached.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;
        }
 
        // Use fsockopen instead of memcache_connect to avoid file descriptor leaks in PHP 8.4+
        $fp = @fsockopen(APP_LOCALHOST, $port, $errno, $errstr, 1);
        if ($fp) {
            // Port is open, verify it's memcached by sending a simple command
            @stream_set_timeout($fp, 1);
            @fwrite($fp, "version\r\n");
            $response = @fgets($fp, 128);
            @fclose($fp);
 
            if ($response && strpos($response, 'VERSION') === 0) {
                // Extract version from response (format: "VERSION x.x.x")
                $version = trim(substr($response, 8));
                Log::debug($this->getName() . ' port ' . $port . ' is used by: ' . $this->getName() . ' ' . $version);
                if ($showWindow) {
                    $bearsamppWinbinder->messageBoxInfo(
                        sprintf($bearsamppLang->getValue(Lang::PORT_USED_BY), $port, $this->getName() . ' ' . $version),
                        $boxTitle
                    );
                }
 
                return true;
            } else {
                // Port is open but not responding as memcached
                Log::debug($this->getName() . ' port ' . $port . ' is open but not responding as memcached');
                if ($showWindow) {
                    $bearsamppWinbinder->messageBoxWarning(
                        sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED_BY), $port),
                        $boxTitle
                    );
                }
 
                return false;
            }
        } else {
            // Port is not open
            Log::debug($this->getName() . ' port ' . $port . ' is not open');
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED), $port),
                    $boxTitle
                );
            }
 
            return false;
        }
    }

References $bearsamppLang, $port, $response, Module\$version, APP_LOCALHOST, Lang\CHECK_PORT_TITLE, Log\debug(), Log\error(), 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

(

)

Retrieves the executable file path for the Memcached service.

Returns

string The executable file path.

Definition at line 454 of file class.bin.memcached.php.

    {
        return $this->exe;
    }

References $exe.

getLog()

getLog

(

)

Retrieves the log file path for the Memcached service.

Returns

string The log file path.

Definition at line 444 of file class.bin.memcached.php.

    {
        return $this->log;
    }

References $log.

getMemory()

getMemory

(

)

Retrieves the memory allocation for the Memcached service.

Returns

int The memory allocation in MB.

Definition at line 464 of file class.bin.memcached.php.

    {
        return $this->memory;
    }

References $memory.

getPort()

getPort

(

)

Retrieves the port number for the Memcached service.

Returns

int The port number.

Definition at line 484 of file class.bin.memcached.php.

    {
        return $this->port;
    }

References $port.

getService()

getService

(

)

Retrieves the service object for the Memcached service.

Returns

Win32Service The service object.

Definition at line 401 of file class.bin.memcached.php.

    {
        return $this->service;
    }

References $service.

rebuildConf()

rebuildConf

(

)

Rebuilds the configuration for the Memcached service in the Windows Registry.

Returns

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

Definition at line 187 of file class.bin.memcached.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->memory, $this->port)
            );
        }
 
        return false;
    }

References Registry\HKEY_LOCAL_MACHINE, and Nssm\INFO_APP_PARAMETERS.

reload()

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

Reloads the configuration and settings for the Memcached service.

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 89 of file class.bin.memcached.php.

    {
        global $bearsamppRoot, $bearsamppConfig, $bearsamppLang;
        Log::reloadClass($this);
 
        $this->name    = $bearsamppLang->getValue(Lang::MEMCACHED);
        $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() . '/memcached.log';
 
        if ($this->bearsamppConfRaw !== false) {
            $this->exe    = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_EXE];
            $this->memory = intval($this->bearsamppConfRaw[self::LOCAL_CFG_MEMORY]);
            $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->memory)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_MEMORY, $this->memory));
 
            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->memory, $this->port));
        $nssm->setStart(Nssm::SERVICE_DEMAND_START);
        $nssm->setStdout(Path::getLogsPath() . '/memcached.out.log');
        $nssm->setStderr(Path::getLogsPath() . '/memcached.err.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(), Lang\MEMCACHED, Log\reloadClass(), and Nssm\SERVICE_DEMAND_START.

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 160 of file class.bin.memcached.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_MEMORY:
                    $this->memory = 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 Memcached service.

Parameters

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

Definition at line 412 of file class.bin.memcached.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:

setMemory()

setMemory

(

$memory

)

Sets the memory allocation for the Memcached service.

Parameters

int

$memory

The memory allocation in MB.

Definition at line 474 of file class.bin.memcached.php.

    {
        $this->replace(self::LOCAL_CFG_MEMORY, $memory);
    }

References $memory, and Module\replace().

Here is the call graph for this function:

setPort()

setPort

(

$port

)

Sets the port number for the Memcached service.

Parameters

int

$port

The port number.

Definition at line 494 of file class.bin.memcached.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:

setVersion()

setVersion

(

$version

)

Sets the version of the Memcached service.

Parameters

string

$version

The version to set.

Reimplemented from Module.

Definition at line 388 of file class.bin.memcached.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 Memcached service.

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 322 of file class.bin.memcached.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 for the Memcached service.

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 338 of file class.bin.memcached.php.

    {
        global $bearsamppLang, $bearsamppApps, $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('memcached' . $this->getVersion(), 'memcached' . $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 61 of file class.bin.memcached.php.

Referenced by getExe().

$log

$log

private

Definition at line 56 of file class.bin.memcached.php.

Referenced by getLog().

$memory

$memory

private

Definition at line 65 of file class.bin.memcached.php.

Referenced by getMemory(), and setMemory().

$port

$port

private

Definition at line 69 of file class.bin.memcached.php.

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

$service

$service

private

Definition at line 52 of file class.bin.memcached.php.

Referenced by getService().

LOCAL_CFG_EXE

const LOCAL_CFG_EXE = 'memcachedExe'

Configuration key for the Memcached executable in the local configuration.

Definition at line 39 of file class.bin.memcached.php.

LOCAL_CFG_MEMORY

const LOCAL_CFG_MEMORY = 'memcachedMemory'

Configuration key for the Memcached memory allocation in the local configuration.

Definition at line 43 of file class.bin.memcached.php.

LOCAL_CFG_PORT

const LOCAL_CFG_PORT = 'memcachedPort'

Configuration key for the Memcached port in the local configuration.

Definition at line 47 of file class.bin.memcached.php.

ROOT_CFG_ENABLE

const ROOT_CFG_ENABLE = 'memcachedEnable'

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

Definition at line 30 of file class.bin.memcached.php.

ROOT_CFG_VERSION

const ROOT_CFG_VERSION = 'memcachedVersion'

Configuration key for the Memcached version in the root configuration.

Definition at line 34 of file class.bin.memcached.php.

SERVICE_NAME

const SERVICE_NAME = 'bearsamppmemcached'

The name of the Windows service.

Definition at line 21 of file class.bin.memcached.php.

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

SERVICE_PARAMS

const SERVICE_PARAMS = '-m %d -p %d -U 0 -vv'

The command line parameters passed to the Memcached service.

Definition at line 25 of file class.bin.memcached.php.

---

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

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