Inheritance diagram for BinApache:

Collaboration diagram for BinApache:

Public Member Functions
	__construct ($id, $type)
	changePort ($port, $checkUsed=false, $wbProgressBar=null)
	checkPort ($port, $ssl=false, $showWindow=false)
	getAccessLog ()
	getAlias ()
	getAliasContent ($name, $dest)
	getCmdLineOutput ($cmd)
	getConf ()
	getErrorLog ()
	getExe ()
	getModules ()
	getModulesFromConf ()
	getModulesLoaded ()
	getModulesPath ()
	getOpensslExe ()
	getPort ()
	getRewriteLog ()
	getService ()
	getSslConf ()
	getSslPort ()
	getVhostContent ($serverName, $documentRoot)
	getVhosts ()
	getVhostsUrl ()
	getWwwDirectories ()
	refreshAlias ($putOnline)
	refreshConf ($putOnline)
	refreshVhosts ($putOnline)
	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	CMD_COMPILE_SETTINGS = '-V'
const	CMD_COMPILED_MODULES = '-l'
const	CMD_CONFIG_DIRECTIVES = '-L'
const	CMD_LOADED_MODULES = '-M'
const	CMD_SYNTAX_CHECK = '-t'
const	CMD_VERSION_NUMBER = '-v'
const	CMD_VHOSTS_SETTINGS = '-S'
const	LOCAL_CFG_CONF = 'apacheConf'
const	LOCAL_CFG_EXE = 'apacheExe'
const	LOCAL_CFG_OPENSSL_EXE = 'apacheOpensslExe'
const	LOCAL_CFG_PORT = 'apachePort'
const	LOCAL_CFG_SSL_PORT = 'apacheSslPort'
const	ROOT_CFG_ENABLE = 'apacheEnable'
const	ROOT_CFG_VERSION = 'apacheVersion'
const	SERVICE_NAME = 'bearsamppapache'
const	SERVICE_PARAMS = '-k runservice'
const	TAG_END_SWITCHONLINE = '# END switchOnline tag - Do not replace!'
const	TAG_START_SWITCHONLINE = '# START switchOnline tag - Do not replace!'
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 Member Functions
	getModulesFromFolder ()
	getOfflineContent ($version=null)
	getOnlineContent ($version=null)
	getRequiredContent ($version=null)

Private Attributes
	$accessLog
	$conf
	$errorLog
	$exe
	$modulesPath
	$opensslExe
	$port
	$rewriteLog
	$service
	$sslConf
	$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 BinApache

This class represents the Apache module in the Bearsampp application. It provides functionalities to manage Apache services, configurations, and modules.

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

Constructor & Destructor Documentation

◆ __construct()

__construct	(		$id,
			$type )

Constructor for the BinApache class.

Parameters

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

Definition at line 148 of file class.bin.apache.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 Apache 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 updating progress.

Returns: bool|string True if the port was changed successfully, or the process using the port if it is in use.

Definition at line 281 of file class.bin.apache.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,
		$ssl = false,
		$showWindow = false )

Checks if a specific port is being used by the Apache service.

Parameters

int	$port	The port number to check.
bool	$ssl	Whether to check for SSL.
bool	$showWindow	Whether to show a window with the result.

Returns: bool True if the port is used by Apache, false otherwise.

Definition at line 321 of file class.bin.apache.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;
        }
 
        // $verify = false: this pings the app's own Apache on localhost, which uses a local
        // self-signed certificate. Certificate verification stays on for all remote fetches.
        $headers = HttpClient::getHttpHeaders('http' . ($ssl ? 's' : '') . '://localhost:' . $port . '/' . Path::getWebResourcesPath() . '/ping.php', false);
        if (!empty($headers)) {
            foreach ($headers as $row) {
                if (UtilString::startWith($row, 'Server: ') || UtilString::startWith($row, 'server: ')) {
                    Log::debug(
                        $this->getName() . ' port ' . $port . ' is used by: ' . $this->getName() . ' ' . str_replace('Server: ', '', str_replace('server: ', '', trim($row)))
                    );
                    if ($showWindow) {
                        $bearsamppWinbinder->messageBoxInfo(
                            sprintf($bearsamppLang->getValue(Lang::PORT_USED_BY), $port, str_replace('Server: ', '', str_replace('server: ', '', trim($row)))),
                            $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, Lang\CHECK_PORT_TITLE, Log\debug(), Log\error(), HttpClient\getHttpHeaders(), Module\getName(), Path\getWebResourcesPath(), Util\isValidPort(), Lang\PORT_NOT_USED, Lang\PORT_NOT_USED_BY, Lang\PORT_USED_BY, and UtilString\startWith().

Here is the call graph for this function:

◆ getAccessLog()

getAccessLog ( )

Gets the access log file path.

Returns: string The access log file path.

Definition at line 1066 of file class.bin.apache.php.

    {
        return $this->accessLog;
    }

References $accessLog.

◆ getAlias()

getAlias ( )

Retrieves the list of alias configurations.

Returns: array The list of alias configurations.

Definition at line 608 of file class.bin.apache.php.

    {
        global $bearsamppRoot;
        $result = array();
 
        $handle = @opendir(Path::getAliasPath());
        if (!$handle) {
            return $result;
        }
 
        while (false !== ($file = readdir($handle))) {
            if ($file != '.' && $file != '..' && UtilString::endWith($file, '.conf')) {
                $result[] = str_replace('.conf', '', $file);
            }
        }
 
        closedir($handle);
        ksort($result);
 
        return $result;
    }

References $bearsamppRoot, $result, UtilString\endWith(), and Path\getAliasPath().

Referenced by refreshAlias().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAliasContent()

getAliasContent	(		$name,
			$dest )

Generates the alias content for the configuration file.

Parameters

string	$name	The name of the alias.
string	$dest	The destination path of the alias.

Returns: string The alias content.

Definition at line 809 of file class.bin.apache.php.

    {
        $dest = Path::formatUnixPath($dest);
 
        return 'Alias /' . $name . ' "' . $dest . '"' . PHP_EOL . PHP_EOL .
            '<Directory "' . $dest . '">' . PHP_EOL .
            '    Options Indexes FollowSymLinks MultiViews' . PHP_EOL .
            '    AllowOverride all' . PHP_EOL .
            $this->getRequiredContent() . PHP_EOL .
            '</Directory>' . PHP_EOL;
    }

References Module\$name, Path\formatUnixPath(), and getRequiredContent().

Here is the call graph for this function:

◆ getCmdLineOutput()

getCmdLineOutput ( $cmd )

Executes a command line and retrieves the output.

Parameters

string $cmd The command to execute.

Returns: array The output of the command.

Definition at line 721 of file class.bin.apache.php.

    {
        $result = array(
            'syntaxOk' => false,
            'content'  => null,
        );
 
        if (file_exists($this->getExe())) {
            $tmpResult = Batch::exec('apacheGetCmdLineOutput', '"' . $this->getExe() . '" ' . $cmd);
            if ($tmpResult !== false && is_array($tmpResult)) {
                $result['syntaxOk'] = trim($tmpResult[count($tmpResult) - 1]) == 'Syntax OK';
                if ($result['syntaxOk']) {
                    unset($tmpResult[count($tmpResult) - 1]);
                }
                $result['content'] = implode(PHP_EOL, $tmpResult);
            }
        }
 
        return $result;
    }

References $result, Batch\exec(), and getExe().

Here is the call graph for this function:

◆ getConf()

getConf ( )

Gets the configuration file path.

Returns: string The configuration file path.

Definition at line 1106 of file class.bin.apache.php.

    {
        return $this->conf;
    }

References $conf.

Referenced by getModulesFromConf(), refreshConf(), and updateConfig().

Here is the caller graph for this function:

◆ getErrorLog()

getErrorLog ( )

Gets the error log file path.

Returns: string The error log file path.

Definition at line 1086 of file class.bin.apache.php.

    {
        return $this->errorLog;
    }

References $errorLog.

◆ getExe()

getExe ( )

Gets the executable file path.

Returns: string The executable file path.

Definition at line 1096 of file class.bin.apache.php.

    {
        return $this->exe;
    }

References $exe.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getModules()

getModules ( )

Retrieves the list of modules by merging the modules from the folder and the configuration file.

Returns: array The list of modules.

Definition at line 511 of file class.bin.apache.php.

    {
        $fromFolder = $this->getModulesFromFolder();
        $fromConf   = $this->getModulesFromConf();
        $result     = array_merge($fromFolder, $fromConf);
        ksort($result);
 
        return $result;
    }

References $result, getModulesFromConf(), and getModulesFromFolder().

Here is the call graph for this function:

◆ getModulesFromConf()

getModulesFromConf ( )

Retrieves the list of modules from the configuration file.

Returns: array The list of modules from the configuration file.

Definition at line 526 of file class.bin.apache.php.

    {
        $result = array();
 
        if (!$this->enable) {
            return $result;
        }
 
        $confContent = file($this->getConf());
        foreach ($confContent as $row) {
            $modMatch = array();
            if (preg_match('/^(#)?LoadModule\s*([a-z0-9_-]+)\s*"?(.*)"?/i', $row, $modMatch)) {
                $name = $modMatch[2];
                //$path = $modMatch[3];
                if (!UtilString::startWith($name, 'php')) {
                    if ($modMatch[1] == '#') {
                        $result[$name] = ActionSwitchApacheModule::SWITCH_OFF;
                    } else {
                        $result[$name] = ActionSwitchApacheModule::SWITCH_ON;
                    }
                }
            }
        }
 
        ksort($result);
 
        return $result;
    }

References Module\$name, $result, getConf(), UtilString\startWith(), ActionSwitchApacheModule\SWITCH_OFF, and ActionSwitchApacheModule\SWITCH_ON.

Referenced by getModules(), and getModulesLoaded().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModulesFromFolder()

getModulesFromFolder ( )

private

Retrieves the list of modules from the modules folder.

Returns: array The list of modules from the modules folder.

Definition at line 577 of file class.bin.apache.php.

    {
        $result = array();
 
        if (!$this->enable) {
            return $result;
        }
 
        $handle = @opendir($this->getModulesPath());
        if (!$handle) {
            return $result;
        }
 
        while (false !== ($file = readdir($handle))) {
            if ($file != '.' && $file != '..' && UtilString::startWith($file, 'mod_') && (UtilString::endWith($file, '.so') || UtilString::endWith($file, '.dll'))) {
                $name          = str_replace(array('mod_', '.so', '.dll'), '', $file) . '_module';
                $result[$name] = ActionSwitchApacheModule::SWITCH_OFF;
            }
        }
 
        closedir($handle);
        ksort($result);
 
        return $result;
    }

References Module\$name, $result, UtilString\endWith(), getModulesPath(), UtilString\startWith(), and ActionSwitchApacheModule\SWITCH_OFF.

Referenced by getModules().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModulesLoaded()

getModulesLoaded ( )

Retrieves the list of loaded modules from the configuration file.

Returns: array The list of loaded modules.

Definition at line 560 of file class.bin.apache.php.

    {
        $result = array();
        foreach ($this->getModulesFromConf() as $name => $status) {
            if ($status == ActionSwitchApacheModule::SWITCH_ON) {
                $result[] = $name;
            }
        }
 
        return $result;
    }

References Module\$name, $result, getModulesFromConf(), and ActionSwitchApacheModule\SWITCH_ON.

Here is the call graph for this function:

◆ getModulesPath()

getModulesPath ( )

Gets the path to the modules.

Returns: string The path to the modules.

Definition at line 1046 of file class.bin.apache.php.

    {
        return $this->modulesPath;
    }

References $modulesPath.

Referenced by getModulesFromFolder().

Here is the caller graph for this function:

◆ getOfflineContent()

getOfflineContent ( $version = null )

private

Generates the offline content for the configuration file.

Parameters

string | null $version The version of the configuration.

Returns: string The offline content.

Definition at line 771 of file class.bin.apache.php.

    {
        $version = $version != null ? $version : $this->getVersion();
        $result  = self::TAG_START_SWITCHONLINE . PHP_EOL;
 
        if (UtilString::startWith($version, '2.4')) {
            $result .= 'Require local' . PHP_EOL;
        } else {
            $result .= 'Order Deny,Allow' . PHP_EOL .
                'Deny from all' . PHP_EOL .
                'Allow from ' . APP_LOCALHOST . ' ::1' . PHP_EOL;
        }
 
        return $result . self::TAG_END_SWITCHONLINE;
    }

References $result, Module\$version, APP_LOCALHOST, Module\getVersion(), and UtilString\startWith().

Referenced by getRequiredContent(), refreshAlias(), refreshConf(), and refreshVhosts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOnlineContent()

getOnlineContent ( $version = null )

private

Generates the online content for the configuration file.

Parameters

string | null $version The version of the configuration.

Returns: string The online content.

Definition at line 749 of file class.bin.apache.php.

    {
        $version = $version != null ? $version : $this->getVersion();
        $result  = self::TAG_START_SWITCHONLINE . PHP_EOL;
 
        if (UtilString::startWith($version, '2.4')) {
            $result .= 'Require all granted' . PHP_EOL;
        } else {
            $result .= 'Order Allow,Deny' . PHP_EOL .
                'Allow from all' . PHP_EOL;
        }
 
        return $result . self::TAG_END_SWITCHONLINE;
    }

References $result, Module\$version, Module\getVersion(), and UtilString\startWith().

Referenced by getRequiredContent(), refreshAlias(), refreshConf(), and refreshVhosts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOpensslExe()

getOpensslExe ( )

Gets the OpenSSL executable file path.

Returns: string The OpenSSL executable file path.

Definition at line 1160 of file class.bin.apache.php.

    {
        return $this->opensslExe;
    }

References $opensslExe.

◆ getPort()

getPort ( )

Gets the port number.

Returns: int The port number.

Definition at line 1116 of file class.bin.apache.php.

    {
        return $this->port;
    }

References $port.

Referenced by getVhostContent().

Here is the caller graph for this function:

◆ getRequiredContent()

getRequiredContent ( $version = null )

private

Generates the required content for the configuration file based on the online status.

Parameters

string | null $version The version of the configuration.

Returns: string The required content.

Definition at line 794 of file class.bin.apache.php.

    {
        global $bearsamppConfig;
 
        return $bearsamppConfig->isOnline() ? $this->getOnlineContent($version) : $this->getOfflineContent($version);
    }

References $bearsamppConfig, Module\$version, getOfflineContent(), and getOnlineContent().

Referenced by getAliasContent(), and getVhostContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRewriteLog()

getRewriteLog ( )

Gets the rewrite log file path.

Returns: string The rewrite log file path.

Definition at line 1076 of file class.bin.apache.php.

    {
        return $this->rewriteLog;
    }

References $rewriteLog.

◆ getService()

getService ( )

Gets the service associated with the module.

Returns: string The service associated with the module.

Definition at line 1036 of file class.bin.apache.php.

    {
        return $this->service;
    }

References $service.

◆ getSslConf()

getSslConf ( )

Gets the SSL configuration file path.

Returns: string The SSL configuration file path.

Definition at line 1056 of file class.bin.apache.php.

    {
        return $this->sslConf;
    }

References $sslConf.

Referenced by refreshConf().

Here is the caller graph for this function:

◆ getSslPort()

getSslPort ( )

Gets the SSL port number.

Returns: int The SSL port number.

Definition at line 1138 of file class.bin.apache.php.

    {
        return $this->sslPort;
    }

References $sslPort.

Referenced by getVhostContent().

Here is the caller graph for this function:

◆ getVhostContent()

getVhostContent	(		$serverName,
			$documentRoot )

Generates the virtual host content for the configuration file.

Parameters

string	$serverName	The server name of the virtual host.
string	$documentRoot	The document root of the virtual host.

Returns: string The virtual host content.

Definition at line 829 of file class.bin.apache.php.

    {
        global $bearsamppRoot;
 
        $documentRoot = Path::formatUnixPath($documentRoot);
 
        return '<VirtualHost *:' . $this->getPort() . '>' . PHP_EOL .
            '    ServerAdmin webmaster@' . $serverName . PHP_EOL .
            '    DocumentRoot "' . $documentRoot . '"' . PHP_EOL .
            '    ServerName ' . $serverName . PHP_EOL .
            '    ErrorLog "' . Path::getLogsPath() . '/' . $serverName . '_error.log"' . PHP_EOL .
            '    CustomLog "' . Path::getLogsPath() . '/' . $serverName . '_access.log" combined' . PHP_EOL . PHP_EOL .
            '    <Directory "' . $documentRoot . '">' . PHP_EOL .
            '        Options Indexes FollowSymLinks MultiViews' . PHP_EOL .
            '        AllowOverride all' . PHP_EOL .
            $this->getRequiredContent() . PHP_EOL .
            '    </Directory>' . PHP_EOL .
            '</VirtualHost>' . PHP_EOL . PHP_EOL .
            '<IfModule ssl_module>' . PHP_EOL .
            '<VirtualHost *:' . $this->getSslPort() . '> #SSL' . PHP_EOL .
            '    DocumentRoot "' . $documentRoot . '"' . PHP_EOL .
            '    ServerName ' . $serverName . PHP_EOL .
            '    ServerAdmin webmaster@' . $serverName . PHP_EOL .
            '    ErrorLog "' . Path::getLogsPath() . '/' . $serverName . '_error.log"' . PHP_EOL .
            '    TransferLog "' . Path::getLogsPath() . '/' . $serverName . '_access.log"' . PHP_EOL . PHP_EOL .
            '    SSLEngine on' . PHP_EOL .
            '    SSLProtocol all -SSLv2' . PHP_EOL .
            '    SSLCipherSuite HIGH:MEDIUM:!aNULL:!MD5' . PHP_EOL .
            '    SSLCertificateFile "' . Path::getSslPath() . '/' . $serverName . '.crt"' . PHP_EOL .
            '    SSLCertificateKeyFile "' . Path::getSslPath() . '/' . $serverName . '.ppk"' . PHP_EOL .
            '    BrowserMatch "MSIE [2-5]" nokeepalive ssl-unclean-shutdown downgrade-1.0 force-response-1.0' . PHP_EOL .
            '    CustomLog "' . Path::getLogsPath() . '/' . $serverName . '_sslreq.log" "%t %h %{SSL_PROTOCOL}x %{SSL_CIPHER}x \"%r\" %b"' . PHP_EOL . PHP_EOL .
            '    <Directory "' . $documentRoot . '">' . PHP_EOL .
            '        SSLOptions +StdEnvVars' . PHP_EOL .
            '        Options Indexes FollowSymLinks MultiViews' . PHP_EOL .
            '        AllowOverride all' . PHP_EOL .
            $this->getRequiredContent() . PHP_EOL .
            '    </Directory>' . PHP_EOL .
            '</VirtualHost>' . PHP_EOL .
            '</IfModule>' . PHP_EOL;
    }

References $bearsamppRoot, Path\formatUnixPath(), Path\getLogsPath(), getPort(), getRequiredContent(), Path\getSslPath(), and getSslPort().

Here is the call graph for this function:

◆ getVhosts()

getVhosts ( )

Retrieves the list of virtual hosts configurations.

Returns: array The list of virtual hosts configurations.

Definition at line 635 of file class.bin.apache.php.

    {
        global $bearsamppRoot;
        $result = array();
 
        $handle = @opendir(Path::getVhostsPath());
        if (!$handle) {
            return $result;
        }
 
        while (false !== ($file = readdir($handle))) {
            if ($file != '.' && $file != '..' && UtilString::endWith($file, '.conf')) {
                $result[] = str_replace('.conf', '', $file);
            }
        }
 
        closedir($handle);
        ksort($result);
 
        return $result;
    }

References $bearsamppRoot, $result, UtilString\endWith(), and Path\getVhostsPath().

Referenced by getVhostsUrl(), refreshVhosts(), and updateConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getVhostsUrl()

getVhostsUrl ( )

Retrieves the URLs of the virtual hosts.

Returns: array The list of virtual hosts URLs.

Definition at line 662 of file class.bin.apache.php.

    {
        global $bearsamppRoot;
        $result = array();
 
        foreach ($this->getVhosts() as $vhost) {
            $vhostContent = file(Path::getVhostsPath() . '/' . $vhost . '.conf');
            foreach ($vhostContent as $vhostLine) {
                $vhostLine = trim($vhostLine);
                $enabled   = !UtilString::startWith($vhostLine, '#');
                if (preg_match_all('/ServerName\s+(.*)/', $vhostLine, $matches)) {
                    foreach ($matches as $match) {
                        $found = isset($match[1]) ? trim($match[1]) : trim($match[0]);
                        if (filter_var('http://' . $found, FILTER_VALIDATE_URL) !== false) {
                            $result[$found] = $enabled;
                            break 2;
                        }
                    }
                }
            }
        }
 
        return $result;
    }

References $bearsamppRoot, $result, getVhosts(), Path\getVhostsPath(), and UtilString\startWith().

Here is the call graph for this function:

◆ getWwwDirectories()

getWwwDirectories ( )

Retrieves the list of directories in the www folder.

Returns: array The list of directories in the www folder.

Definition at line 692 of file class.bin.apache.php.

    {
        global $bearsamppRoot;
        $result = array();
 
        $handle = @opendir(Path::getWwwPath());
        if (!$handle) {
            return $result;
        }
 
        while (false !== ($file = readdir($handle))) {
            if ($file != '.' && $file != '..' && is_dir(Path::getWwwPath() . '/' . $file)) {
                $result[] = $file;
            }
        }
 
        closedir($handle);
        ksort($result);
 
        return $result;
    }

References $bearsamppRoot, $result, and Path\getWwwPath().

Here is the call graph for this function:

◆ refreshAlias()

refreshAlias ( $putOnline )

Refreshes the alias configurations to switch between online and offline modes.

Parameters

bool $putOnline Whether to put the alias configurations online.

Definition at line 917 of file class.bin.apache.php.

    {
        global $bearsamppRoot, $bearsamppHomepage;
 
        if (!$this->enable) {
            return;
        }
 
        $onlineContent  = $this->getOnlineContent();
        $offlineContent = $this->getOfflineContent();
 
        foreach ($this->getAlias() as $alias) {
            $aliasConf = file_get_contents(Path::getAliasPath() . '/' . $alias . '.conf');
            Log::trace('refreshAlias ' . Path::getAliasPath() . '/' . $alias . '.conf');
            preg_match('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $aliasConf, $matches);
            Log::trace(isset($matches[1]) ? print_r($matches[1], true) : 'N/A');
 
            if ($putOnline) {
                $aliasConf = preg_replace('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $onlineContent, $aliasConf, -1, $count);
            } else {
                $aliasConf = preg_replace('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $offlineContent, $aliasConf, -1, $count);
            }
            file_put_contents(Path::getAliasPath() . '/' . $alias . '.conf', $aliasConf);
            Log::debug('Refresh ' . Path::getAliasPath() . '/' . $alias . '.conf: ' . $count . ' occurrence(s) replaced');
        }
 
        // Homepage
        $bearsamppHomepage->refreshAliasContent();
    }

References $bearsamppHomepage, $bearsamppRoot, Log\debug(), getAlias(), Path\getAliasPath(), getOfflineContent(), getOnlineContent(), and Log\trace().

Here is the call graph for this function:

◆ refreshConf()

refreshConf ( $putOnline )

Refreshes the configuration file to switch between online and offline modes.

Parameters

bool $putOnline Whether to put the configuration online.

Definition at line 876 of file class.bin.apache.php.

    {
        if (!$this->enable) {
            return;
        }
 
        $onlineContent  = $this->getOnlineContent();
        $offlineContent = $this->getOfflineContent();
 
        $conf = file_get_contents($this->getConf());
        Log::trace('refreshConf ' . $this->getConf());
        preg_match('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $conf, $matches);
        Log::trace(isset($matches[1]) ? print_r($matches[1], true) : 'N/A');
 
        if ($putOnline) {
            $conf = preg_replace('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $onlineContent, $conf, -1, $count);
        } else {
            $conf = preg_replace('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $offlineContent, $conf, -1, $count);
        }
        file_put_contents($this->getConf(), $conf);
        Log::debug('Refresh ' . $this->getConf() . ': ' . $count . ' occurrence(s) replaced');
 
        $sslConf = file_get_contents($this->getSslConf());
        Log::trace('refreshConf ' . $this->getSslConf());
        preg_match('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $sslConf, $matches);
        Log::trace(isset($matches[1]) ? print_r($matches[1], true) : 'N/A');
 
        if ($putOnline) {
            $sslConf = preg_replace('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $onlineContent, $sslConf, -1, $count);
        } else {
            $sslConf = preg_replace('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $offlineContent, $sslConf, -1, $count);
        }
        file_put_contents($this->getSslConf(), $sslConf);
        Log::debug('Refresh ' . $this->getSslConf() . ': ' . $count . ' occurrence(s) replaced');
    }

References $conf, $sslConf, Log\debug(), getConf(), getOfflineContent(), getOnlineContent(), getSslConf(), and Log\trace().

Here is the call graph for this function:

◆ refreshVhosts()

refreshVhosts ( $putOnline )

Refreshes the virtual host configurations to switch between online and offline modes.

Parameters

bool $putOnline Whether to put the virtual host configurations online.

Definition at line 952 of file class.bin.apache.php.

    {
        global $bearsamppRoot;
 
        if (!$this->enable) {
            return;
        }
 
        $onlineContent  = $this->getOnlineContent();
        $offlineContent = $this->getOfflineContent();
 
        foreach ($this->getVhosts() as $vhost) {
            $vhostConf = file_get_contents(Path::getVhostsPath() . '/' . $vhost . '.conf');
            Log::trace('refreshVhost ' . Path::getVhostsPath() . '/' . $vhost . '.conf');
            preg_match('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $vhostConf, $matches);
            Log::trace(isset($matches[1]) ? print_r($matches[1], true) : 'N/A');
 
            if ($putOnline) {
                $vhostConf = preg_replace('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $onlineContent, $vhostConf, -1, $count);
            } else {
                $vhostConf = preg_replace('/' . self::TAG_START_SWITCHONLINE . '(.*?)' . self::TAG_END_SWITCHONLINE . '/s', $offlineContent, $vhostConf, -1, $count);
            }
            file_put_contents(Path::getVhostsPath() . '/' . $vhost . '.conf', $vhostConf);
            Log::debug('Refresh ' . Path::getVhostsPath() . '/' . $vhost . '.conf: ' . $count . ' occurrence(s) replaced');
        }
    }

References $bearsamppRoot, Log\debug(), getOfflineContent(), getOnlineContent(), getVhosts(), Path\getVhostsPath(), and Log\trace().

Here is the call graph for this function:

◆ 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 160 of file class.bin.apache.php.

    {
        global $bearsamppRoot, $bearsamppConfig, $bearsamppLang;
        Log::reloadClass($this);
 
        $this->name    = $bearsamppLang->getValue(Lang::APACHE);
        $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->modulesPath = $this->symlinkPath . '/modules';
        $this->sslConf     = $this->symlinkPath . '/conf/extra/httpd-ssl.conf';
        $this->accessLog   = Path::getLogsPath() . '/apache_access.log';
        $this->rewriteLog  = Path::getLogsPath() . '/apache_rewrite.log';
        $this->errorLog    = Path::getLogsPath() . '/apache_error.log';
 
        if ($this->bearsamppConfRaw !== false) {
            $this->exe        = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_EXE];
            $this->conf       = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_CONF];
            $this->port       = $this->bearsamppConfRaw[self::LOCAL_CFG_PORT];
            $this->sslPort    = $this->bearsamppConfRaw[self::LOCAL_CFG_SSL_PORT];
            $this->opensslExe = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_OPENSSL_EXE];
        }
 
        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->sslConf)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->sslConf));
 
            return;
        }
        if (!is_file($this->exe)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->exe));
 
            return;
        }
        if (!is_file($this->conf)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->conf));
 
            return;
        }
        if (!is_numeric($this->port) || $this->port <= 0) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_PORT, $this->port));
 
            return;
        }
        if (!is_numeric($this->sslPort) || $this->sslPort <= 0) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_SSL_PORT, $this->sslPort));
 
            return;
        }
        if (!is_file($this->opensslExe)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->opensslExe));
 
            return;
        }
 
        $nssm = new Nssm(self::SERVICE_NAME);
        $nssm->setDisplayName(APP_TITLE . ' ' . $this->getName());
        $nssm->setBinPath($this->exe);
        $nssm->setParams('');
        $nssm->setStart(Nssm::SERVICE_DEMAND_START);
 
        $this->service->setNssm($nssm);
    }

References $bearsamppConfig, $bearsamppLang, $bearsamppRoot, Module\$id, Module\$type, Lang\APACHE, 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(), 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 250 of file class.bin.apache.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_PORT:
                    $this->port = $value;
                    break;
                case self::LOCAL_CFG_SSL_PORT:
                    $this->sslPort = $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 )

Sets the enable status of the module.

This method enables or disables the module based on the provided parameter. If enabling the module and the current path does not exist, it logs an error and optionally shows an error message window.

Parameters

bool	$enabled	Whether to enable or disable the module.
bool	$showWindow	Whether to show an error message window if enabling fails.

Definition at line 989 of file class.bin.apache.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, self::CMD_SYNTAX_CHECK, $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 number.

This method updates the port number in the configuration.

Parameters

int $port The port number to set.

Definition at line 1128 of file class.bin.apache.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 number.

This method updates the SSL port number in the configuration.

Parameters

int $sslPort The SSL port number to set.

Definition at line 1150 of file class.bin.apache.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 module.

This method updates the version of the module and reloads its configuration.

Parameters

string $version The version to set for the module.

Reimplemented from Module.

Definition at line 1023 of file class.bin.apache.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 Apache version.

Parameters

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

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

Definition at line 379 of file class.bin.apache.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 Apache configuration with a specific version.

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 window during the update process.

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

Reimplemented from Module.

Definition at line 395 of file class.bin.apache.php.

    {
        global $bearsamppRoot, $bearsamppLang, $bearsamppBins, $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);
 
        $conf          = str_replace('apache' . $this->getVersion(), 'apache' . $version, $this->getConf());
        $bearsamppConf = str_replace('apache' . $this->getVersion(), 'apache' . $version, $this->bearsamppConf);
 
        $tsDll = $bearsamppBins->getPhp()->getTsDll();
 
        $apachePhpModuleName = null;
        if ($tsDll !== false) {
            $apachemoduleNamePrefix = substr($tsDll, 0, 4);
            $apachePhpModuleName    = ($apachemoduleNamePrefix == 'php8' ? 'php' : $apachemoduleNamePrefix) . '_module';
        }
        $apachePhpModulePath = $bearsamppBins->getPhp()->getApacheModule($version);
        $apachePhpModuleDll  = basename($apachePhpModulePath);
 
        Log::debug(($sub > 0 ? str_repeat(' ', 2 * $sub) : '') . 'PHP TsDll found: ' . $tsDll);
        Log::debug(($sub > 0 ? str_repeat(' ', 2 * $sub) : '') . 'PHP Apache module found: ' . $apachePhpModulePath);
 
        if (!file_exists($conf) || !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;
        }
 
        if ($tsDll === false || $apachePhpModulePath === false) {
            Log::debug($this->getName() . ' ' . $version . ' does not seem to be compatible with PHP ' . $bearsamppBins->getPhp()->getVersion());
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::APACHE_INCPT), $version, $bearsamppBins->getPhp()->getVersion()),
                    $boxTitle
                );
            }
 
            return false;
        }
 
        // httpd.conf
        $this->setVersion($version);
 
        // conf
        Log::debug('httpd.conf = ' . $conf);
        Util::replaceInFile($conf, array(
            // PHP module
            '/^#?PHPIniDir\s.*/'                          => ($bearsamppBins->getPhp()->isEnable() ? '' : '#') . 'PHPIniDir "' . Path::getModuleSymlinkPath(
                    $bearsamppBins->getPhp()
                ) . '"',
            '/^#?LoadFile\s.*php.ts\.dll.*/'              => ($bearsamppBins->getPhp()->isEnable() ? '' : '#') . (!file_exists(
                    Path::getModuleSymlinkPath($bearsamppBins->getPhp()) . '/' . $tsDll
                ) ? '#' : '') . 'LoadFile "' . Path::getModuleSymlinkPath($bearsamppBins->getPhp()) . '/' . $tsDll . '"',
            '/^#?LoadModule\sphp.*/'                      => ($bearsamppBins->getPhp()
                                                                            ->isEnable() ? '' : '#') . 'LoadModule ' . $apachePhpModuleName . ' "' . Path::getModuleSymlinkPath(
                    $bearsamppBins->getPhp()
                ) . '/' . $apachePhpModuleDll . '"',
            '/^#?LoadModule\sphp_*/'                      => ($bearsamppBins->getPhp()
                                                                            ->isEnable() ? '' : '#') . 'LoadModule ' . $apachePhpModuleName . ' "' . Path::getModuleSymlinkPath(
                    $bearsamppBins->getPhp()
                ) . '/' . $apachePhpModuleDll . '"',
 
 
            // Port
            '/^Listen\s(\d+)/'                            => 'Listen ' . $this->port,
            '/^ServerName\s+([a-zA-Z0-9.]+):(\d+)/'       => 'ServerName {{1}}:' . $this->port,
            '/^NameVirtualHost\s+([a-zA-Z0-9.*]+):(\d+)/' => 'NameVirtualHost {{1}}:' . $this->port,
            '/^<VirtualHost\s+([a-zA-Z0-9.*]+):(\d+)>/'   => '<VirtualHost {{1}}:' . $this->port . '>'
        ));
 
        // vhosts
        foreach ($this->getVhosts() as $vhost) {
            Util::replaceInFile(Path::getVhostsPath() . '/' . $vhost . '.conf', array(
                '/^<VirtualHost\s+([a-zA-Z0-9.*]+):(\d+)>$/' => '<VirtualHost {{1}}:' . $this->port . '>$'
            ));
        }
 
        // www .htaccess
        Util::replaceInFile(Path::getWwwPath() . '/.htaccess', array(
            '/(.*)http:\/\/localhost(.*)/' => '{{1}}http://localhost' . ($this->port != 80 ? ':' . $this->port : '') . '/$1 [QSA,R=301,L]',
        ));
 
        return true;
    }

References $bearsamppBins, Module\$bearsamppConf, Module\$bearsamppConfRaw, $bearsamppLang, $bearsamppRoot, $conf, Module\$version, Lang\APACHE_INCPT, Lang\BEARSAMPP_CONF_MALFORMED_ERROR, Lang\BEARSAMPP_CONF_NOT_FOUND_ERROR, Log\debug(), Log\error(), getConf(), Path\getModuleSymlinkPath(), Module\getName(), Module\getVersion(), getVhosts(), Path\getVhostsPath(), Path\getWwwPath(), Util\replaceInFile(), 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

◆ $accessLog

$accessLog

private

Definition at line 111 of file class.bin.apache.php.

Referenced by getAccessLog().

◆ $conf

$conf

private

Definition at line 128 of file class.bin.apache.php.

Referenced by getConf(), refreshConf(), and updateConfig().

◆ $errorLog

$errorLog

private

Definition at line 119 of file class.bin.apache.php.

Referenced by getErrorLog().

◆ $exe

$exe

private

Definition at line 124 of file class.bin.apache.php.

Referenced by getExe().

◆ $modulesPath

$modulesPath

private

Definition at line 103 of file class.bin.apache.php.

Referenced by getModulesPath().

◆ $opensslExe

$opensslExe

private

Definition at line 140 of file class.bin.apache.php.

Referenced by getOpensslExe().

◆ $port

$port

private

Definition at line 132 of file class.bin.apache.php.

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

◆ $rewriteLog

$rewriteLog

private

Definition at line 115 of file class.bin.apache.php.

Referenced by getRewriteLog().

◆ $service

$service

private

Definition at line 99 of file class.bin.apache.php.

Referenced by getService().

◆ $sslConf

$sslConf

private

Definition at line 107 of file class.bin.apache.php.

Referenced by getSslConf(), and refreshConf().

◆ $sslPort

$sslPort

private

Definition at line 136 of file class.bin.apache.php.

Referenced by getSslPort(), and setSslPort().

◆ CMD_COMPILE_SETTINGS

const CMD_COMPILE_SETTINGS = '-V'

Command line option to display Apache compile settings.

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

Referenced by ActionDebugApache\getCommandMapping(), and TplAppApache\getMenuApacheDebug().

◆ CMD_COMPILED_MODULES

const CMD_COMPILED_MODULES = '-l'

Command line option to display compiled Apache modules.

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

Referenced by ActionDebugApache\getCommandMapping(), and TplAppApache\getMenuApacheDebug().

◆ CMD_CONFIG_DIRECTIVES

const CMD_CONFIG_DIRECTIVES = '-L'

Command line option to display Apache configuration directives.

Definition at line 73 of file class.bin.apache.php.

Referenced by ActionDebugApache\getCommandMapping(), and TplAppApache\getMenuApacheDebug().

◆ CMD_LOADED_MODULES

const CMD_LOADED_MODULES = '-M'

Command line option to display loaded Apache modules.

Definition at line 81 of file class.bin.apache.php.

Referenced by ActionDebugApache\getCommandMapping(), and TplAppApache\getMenuApacheDebug().

◆ CMD_SYNTAX_CHECK

const CMD_SYNTAX_CHECK = '-t'

Command line option to perform a syntax check on the Apache configuration.

Definition at line 85 of file class.bin.apache.php.

Referenced by ActionService\__construct(), ActionDebugApache\getCommandMapping(), TplAppApache\getMenuApacheDebug(), ServiceHelper\hasSyntaxCheck(), ServiceHelper\initializeMappings(), ActionStartup\prepareService(), BinPhp\setEnable(), and Win32Service\start().

◆ CMD_VERSION_NUMBER

const CMD_VERSION_NUMBER = '-v'

Command line option to display the Apache version number.

Definition at line 61 of file class.bin.apache.php.

Referenced by ActionDebugApache\getCommandMapping(), and TplAppApache\getMenuApacheDebug().

◆ CMD_VHOSTS_SETTINGS

const CMD_VHOSTS_SETTINGS = '-S'

Command line option to display Apache virtual host settings.

Definition at line 77 of file class.bin.apache.php.

Referenced by ActionDebugApache\getCommandMapping(), and TplAppApache\getMenuApacheDebug().

◆ LOCAL_CFG_CONF

const LOCAL_CFG_CONF = 'apacheConf'

Configuration key for the Apache configuration file in the local configuration.

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

◆ LOCAL_CFG_EXE

const LOCAL_CFG_EXE = 'apacheExe'

Configuration key for the Apache executable in the local configuration.

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

◆ LOCAL_CFG_OPENSSL_EXE

const LOCAL_CFG_OPENSSL_EXE = 'apacheOpensslExe'

Configuration key for the Apache OpenSSL executable in the local configuration.

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

◆ LOCAL_CFG_PORT

const LOCAL_CFG_PORT = 'apachePort'

Configuration key for the Apache port in the local configuration.

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

◆ LOCAL_CFG_SSL_PORT

const LOCAL_CFG_SSL_PORT = 'apacheSslPort'

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

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

◆ ROOT_CFG_ENABLE

const ROOT_CFG_ENABLE = 'apacheEnable'

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

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

◆ ROOT_CFG_VERSION

const ROOT_CFG_VERSION = 'apacheVersion'

Configuration key for the Apache version in the root configuration.

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

◆ SERVICE_NAME

const SERVICE_NAME = 'bearsamppapache'

◆ SERVICE_PARAMS

const SERVICE_PARAMS = '-k runservice'

The command line parameters passed to the Apache service.

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

◆ TAG_END_SWITCHONLINE

const TAG_END_SWITCHONLINE = '# END switchOnline tag - Do not replace!'

The end tag marker for the switchOnline section in the configuration file.

Definition at line 94 of file class.bin.apache.php.

◆ TAG_START_SWITCHONLINE

const TAG_START_SWITCHONLINE = '# START switchOnline tag - Do not replace!'

The start tag marker for the switchOnline section in the configuration file.

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

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

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

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ changePort()

◆ checkPort()

◆ getAccessLog()

◆ getAlias()

◆ getAliasContent()

◆ getCmdLineOutput()

◆ getConf()

◆ getErrorLog()

◆ getExe()

◆ getModules()

◆ getModulesFromConf()

◆ getModulesFromFolder()

◆ getModulesLoaded()

◆ getModulesPath()

◆ getOfflineContent()

◆ getOnlineContent()

◆ getOpensslExe()

◆ getPort()

◆ getRequiredContent()

◆ getRewriteLog()

◆ getService()

◆ getSslConf()

◆ getSslPort()

◆ getVhostContent()

◆ getVhosts()

◆ getVhostsUrl()

◆ getWwwDirectories()

◆ refreshAlias()

◆ refreshConf()

◆ refreshVhosts()

◆ reload()

◆ replaceAll()

◆ setEnable()

◆ setPort()

◆ setSslPort()

◆ setVersion()

◆ switchVersion()

◆ updateConfig()

Field Documentation

◆ $accessLog

◆ $conf

◆ $errorLog

◆ $exe

◆ $modulesPath

◆ $opensslExe

◆ $port

◆ $rewriteLog

◆ $service

◆ $sslConf

◆ $sslPort

◆ CMD_COMPILE_SETTINGS

◆ CMD_COMPILED_MODULES

◆ CMD_CONFIG_DIRECTIVES

◆ CMD_LOADED_MODULES

◆ CMD_SYNTAX_CHECK

◆ CMD_VERSION_NUMBER

◆ CMD_VHOSTS_SETTINGS

◆ LOCAL_CFG_CONF

◆ LOCAL_CFG_EXE

◆ LOCAL_CFG_OPENSSL_EXE

◆ LOCAL_CFG_PORT

◆ LOCAL_CFG_SSL_PORT

◆ ROOT_CFG_ENABLE

◆ ROOT_CFG_VERSION

◆ SERVICE_NAME

◆ SERVICE_PARAMS

◆ TAG_END_SWITCHONLINE

◆ TAG_START_SWITCHONLINE