Inheritance diagram for BinMysql:

Collaboration diagram for BinMysql:

Public Member Functions
	__construct ($id, $type)
	changePort ($port, $checkUsed=false, $wbProgressBar=null)
	changeRootPassword ($currentPwd, $newPwd, $wbProgressBar=null)
	checkPort ($port, $showWindow=false)
	checkRootPassword ($currentPwd=null, $wbProgressBar=null)
	getAdmin ()
	getCliExe ()
	getCmdLineOutput ($cmd)
	getConf ()
	getDataDir ()
	getErrorLog ()
	getExe ()
	getPort ()
	getRootPwd ()
	getRootUser ()
	getService ()
	initData ($path=null, $version=null)
	reload ($id=null, $type=null)
	setEnable ($enabled, $showWindow=false)
	setPort ($port)
	setRootPwd ($rootPwd)
	setRootUser ($rootUser)
	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_SYNTAX_CHECK = '--help --verbose 1>NUL'
const	CMD_VARIABLES = 'variables'
const	CMD_VERSION = '--version'
const	LOCAL_CFG_ADMIN = 'mysqlAdmin'
const	LOCAL_CFG_CLI_EXE = 'mysqlCliExe'
const	LOCAL_CFG_CONF = 'mysqlConf'
const	LOCAL_CFG_EXE = 'mysqlExe'
const	LOCAL_CFG_PORT = 'mysqlPort'
const	LOCAL_CFG_ROOT_PWD = 'mysqlRootPwd'
const	LOCAL_CFG_ROOT_USER = 'mysqlRootUser'
const	ROOT_CFG_ENABLE = 'mysqlEnable'
const	ROOT_CFG_VERSION = 'mysqlVersion'
const	SERVICE_NAME = 'bearsamppmysql'
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
	$admin
	$cliExe
	$conf
	$dataDir
	$errorLog
	$exe
	$port
	$rootPwd
	$rootUser
	$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 BinMysql

This class represents the MySQL binary module in the Bearsampp application. It handles the configuration, management, and operations related to MySQL.

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

Constructor & Destructor Documentation

◆ __construct()

__construct	(		$id,
			$type )

Constructs a BinMysql object and initializes the MySQL module.

Parameters

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

Definition at line 122 of file class.bin.mysql.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 MySQL port and updates the configuration.

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|string True if the port was changed successfully, or an error message if the port is in use.

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

◆ changeRootPassword()

changeRootPassword	(	$currentPwd,
		$newPwd,
		$wbProgressBar = null )

Changes the MySQL root password.

Parameters

string	$currentPwd	The current root password.
string	$newPwd	The new root password.
mixed	$wbProgressBar	The progress bar object for UI updates.

Returns: bool|string True if the password was changed successfully, or an error message if the operation failed.

Definition at line 417 of file class.bin.mysql.php.

    {
        global $bearsamppWinbinder;
        $startTime = microtime(true);
        $error     = null;
        $timeout   = 5; // 5 seconds timeout
 
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        try {
            // Connect using PDO
            $options = [
                \PDO::ATTR_TIMEOUT => $timeout,
                \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION
            ];
 
            $dsn    = 'mysql:host=' . APP_LOCALHOST . ';port=' . $this->port;
            $dbLink = new \PDO($dsn, $this->rootUser, $currentPwd, $options);
 
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            // Determine MySQL version to use appropriate password update syntax
            $stmt    = $dbLink->query('SELECT VERSION()');
            $version = $stmt->fetchColumn();
 
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            // Use appropriate SQL syntax based on MySQL version
            if (version_compare($version, '5.7.6', '>=')) {
                // MySQL 5.7.6 and newer uses ALTER USER
                $sql  = "ALTER USER '{$this->rootUser}'@'localhost' IDENTIFIED BY :password";
                $stmt = $dbLink->prepare($sql);
                $stmt->bindParam(':password', $newPwd);
            } else {
                // Older versions use SET PASSWORD
                $sql  = "SET PASSWORD FOR '{$this->rootUser}'@'localhost' = PASSWORD(:password)";
                $stmt = $dbLink->prepare($sql);
                $stmt->bindParam(':password', $newPwd);
            }
 
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
            $stmt->execute();
 
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
            $dbLink->query('FLUSH PRIVILEGES');
 
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
            $dbLink = null; // Close connection properly
 
        } catch (\PDOException $e) {
            $error = $e->getMessage();
        }
 
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        if (!empty($error)) {
            $totalTime = round(microtime(true) - $startTime, 2);
            Log::trace("MySQL password change failed in {$totalTime}s: " . $error);
 
            return $error;
        }
 
        // bearsampp.conf
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
        $this->setRootPwd($newPwd);
 
        // conf
        $this->update();
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        $totalTime = round(microtime(true) - $startTime, 2);
        Log::trace("MySQL password change completed in {$totalTime}s");
 
        return true;
    }

References $options, $port, Module\$version, APP_LOCALHOST, setRootPwd(), Log\trace(), 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 MySQL.

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 MySQL, false otherwise.

Definition at line 294 of file class.bin.mysql.php.

    {
        global $bearsamppLang, $bearsamppWinbinder;
        $boxTitle  = sprintf($bearsamppLang->getValue(Lang::CHECK_PORT_TITLE), $this->getName(), $port);
        $startTime = microtime(true);
 
        if (!Util::isValidPort($port)) {
            Log::error($this->getName() . ' port not valid: ' . $port);
 
            return false;
        }
 
        // Quick socket check first - much faster than PDO connection
        $timeout = 1; // Reduced timeout for better performance
        $fp      = @fsockopen(APP_LOCALHOST, $port, $errno, $errstr, $timeout);
        if (!$fp) {
            Log::debug($this->getName() . ' port ' . $port . ' is not used');
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxError(
                    sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED), $port),
                    $boxTitle
                );
            }
 
            return false;
        }
        fclose($fp);
 
        // Use cached connection if available for better performance
        static $cachedConnection = null;
        static $lastPort = null;
 
        if ($cachedConnection === null || $lastPort !== $port) {
            try {
                // Use new constant name for PHP 8.5+ while maintaining backward compatibility
                // Check PHP version to avoid deprecation warnings
                if (PHP_VERSION_ID >= 80500) {
                    $initCommandAttr = \Pdo\Mysql::ATTR_INIT_COMMAND;
                } else {
                    $initCommandAttr = \PDO::MYSQL_ATTR_INIT_COMMAND;
                }
 
                $options = [
                    \PDO::ATTR_TIMEOUT => $timeout,
                    \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
                    $initCommandAttr   => "SET SESSION sql_mode=''"
                ];
 
                $dsn              = 'mysql:host=' . APP_LOCALHOST . ';port=' . $port;
                $cachedConnection = new \PDO($dsn, $this->rootUser, $this->rootPwd, $options);
                $lastPort         = $port;
            } catch (\PDOException $e) {
                Log::debug($this->getName() . ' port ' . $port . ' connection failed: ' . $e->getMessage());
                if ($showWindow) {
                    $bearsamppWinbinder->messageBoxWarning(
                        sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED_BY), $port),
                        $boxTitle
                    );
                }
 
                return false;
            }
        }
 
        try {
            // Single optimized query to get both version and type
            $stmt = $cachedConnection->query("SELECT @@version, @@version_comment");
            $row  = $stmt->fetch(\PDO::FETCH_NUM);
 
            if (!$row) {
                return false;
            }
 
            $version = explode('-', $row[0]);
            $version = count($version) > 1 ? $version[0] : $row[0];
            $isMysql = UtilString::startWith(strtolower($row[1]), 'mysql');
 
            if (!$isMysql) {
                Log::debug($this->getName() . ' port used by another DBMS: ' . $port);
                if ($showWindow) {
                    $bearsamppWinbinder->messageBoxWarning(
                        sprintf($bearsamppLang->getValue(Lang::PORT_USED_BY_ANOTHER_DBMS), $port),
                        $boxTitle
                    );
                }
 
                return false;
            }
 
            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
                );
            }
 
            $totalTime = round(microtime(true) - $startTime, 2);
            Log::trace("MySQL port check completed in {$totalTime}s");
 
            return true;
        } catch (\PDOException $e) {
            Log::debug($this->getName() . ' port ' . $port . ' validation error: ' . $e->getMessage());
            if ($showWindow) {
                $bearsamppWinbinder->messageBoxWarning(
                    sprintf($bearsamppLang->getValue(Lang::PORT_NOT_USED_BY), $port),
                    $boxTitle
                );
            }
 
            return false;
        }
    }

References $bearsamppLang, $options, $port, 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, Lang\PORT_USED_BY, Lang\PORT_USED_BY_ANOTHER_DBMS, UtilString\startWith(), and Log\trace().

Here is the call graph for this function:

◆ checkRootPassword()

checkRootPassword	(		$currentPwd = null,
			$wbProgressBar = null )

Checks if the provided root password is correct.

Parameters

string \| null	$currentPwd	The current root password. If null, the stored root password is used.
mixed	$wbProgressBar	The progress bar object for UI updates.

Returns: bool|string True if the password is correct, or an error message if the operation failed.

Definition at line 501 of file class.bin.mysql.php.

    {
        global $bearsamppWinbinder;
        $startTime  = microtime(true);
        $currentPwd = $currentPwd == null ? $this->rootPwd : $currentPwd;
        $error      = null;
        $timeout    = 2; // Reduced timeout for faster validation
 
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        // Use cached connection for password validation if available
        static $passwordCache = [];
        $cacheKey = md5($this->rootUser . ':' . $currentPwd . ':' . $this->port);
 
        if (isset($passwordCache[$cacheKey]) && (time() - $passwordCache[$cacheKey]['time']) < 30) {
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
            $totalTime = round(microtime(true) - $startTime, 2);
            Log::trace("MySQL password check completed from cache in {$totalTime}s");
 
            return $passwordCache[$cacheKey]['result'];
        }
 
        try {
            // Use new constant name for PHP 8.5+ while maintaining backward compatibility
            // Check PHP version to avoid deprecation warnings
            if (PHP_VERSION_ID >= 80500) {
                $initCommandAttr = \Pdo\Mysql::ATTR_INIT_COMMAND;
            } else {
                $initCommandAttr = \PDO::MYSQL_ATTR_INIT_COMMAND;
            }
 
            $options = [
                \PDO::ATTR_TIMEOUT => $timeout,
                \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
                $initCommandAttr   => "SET SESSION sql_mode=''"
            ];
 
            $dsn    = 'mysql:host=' . APP_LOCALHOST . ';port=' . $this->port;
            $dbLink = new \PDO($dsn, $this->rootUser, $currentPwd, $options);
 
            // Quick validation query
            $dbLink->query('SELECT 1');
            $dbLink = null; // Close connection properly
 
            // Cache successful result
            $passwordCache[$cacheKey] = [
                'result' => true,
                'time'   => time()
            ];
        } catch (\PDOException $e) {
            $error = $e->getMessage();
 
            // Cache failed result for shorter time
            $passwordCache[$cacheKey] = [
                'result' => $error,
                'time'   => time() - 25 // Cache for only 5 seconds
            ];
        }
 
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        if (!empty($error)) {
            $totalTime = round(microtime(true) - $startTime, 2);
            Log::trace("MySQL password check failed in {$totalTime}s: " . $error);
 
            return $error;
        }
 
        $totalTime = round(microtime(true) - $startTime, 2);
        Log::trace("MySQL password check completed in {$totalTime}s");
 
        return true;
    }

References $options, $port, APP_LOCALHOST, and Log\trace().

Here is the call graph for this function:

◆ getAdmin()

getAdmin ( )

Retrieves the path to the MySQL admin executable.

Returns: string The path to the admin executable.

Definition at line 962 of file class.bin.mysql.php.

    {
        return $this->admin;
    }

References $admin.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getCliExe()

getCliExe ( )

Retrieves the path to the MySQL CLI executable.

Returns: string The path to the CLI executable.

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

    {
        return $this->cliExe;
    }

References $cliExe.

◆ getCmdLineOutput()

getCmdLineOutput ( $cmd )

Executes a MySQL command and retrieves the output.

Parameters

string $cmd The command to execute.

Returns: array An associative array containing 'syntaxOk' (boolean) and 'content' (string|null).

Definition at line 766 of file class.bin.mysql.php.

    {
        $result = array(
            'syntaxOk' => false,
            'content'  => null,
        );
 
        $bin         = $this->getExe();
        $removeLines = 0;
        $outputFrom  = '';
        if ($cmd == self::CMD_SYNTAX_CHECK) {
            $outputFrom = '2';
        } elseif ($cmd == self::CMD_VARIABLES) {
            $bin = $this->getAdmin();
            $cmd .= ' --user=' . $this->getRootUser();
            if ($this->getRootPwd()) {
                $cmd .= ' --password=' . $this->getRootPwd();
            }
            $removeLines = 2;
        }
 
        if (file_exists($bin)) {
            $tmpResult = Batch::exec('mysqlGetCmdLineOutput', '"' . $bin . '" ' . $cmd . ' ' . $outputFrom, 5);
            if ($tmpResult !== false && is_array($tmpResult)) {
                $result['syntaxOk'] = empty($tmpResult) || !UtilString::contains(trim($tmpResult[count($tmpResult) - 1]), '[ERROR]');
                for ($i = 0; $i < $removeLines; $i++) {
                    unset($tmpResult[$i]);
                }
                $result['content'] = trim(str_replace($bin, '', implode(PHP_EOL, $tmpResult)));
            }
        }
 
        return $result;
    }

References $result, UtilString\contains(), Batch\exec(), getAdmin(), getExe(), getRootPwd(), and getRootUser().

Here is the call graph for this function:

◆ getConf()

getConf ( )

Retrieves the path to the MySQL configuration file.

Returns: string The path to the configuration file.

Definition at line 882 of file class.bin.mysql.php.

    {
        return $this->conf;
    }

References $conf.

Referenced by updateConfig().

Here is the caller graph for this function:

◆ getDataDir()

getDataDir ( )

Retrieves the path to the MySQL data directory.

Returns: string The path to the data directory.

Definition at line 972 of file class.bin.mysql.php.

    {
        return $this->dataDir;
    }

References $dataDir.

◆ getErrorLog()

getErrorLog ( )

Retrieves the path to the MySQL error log.

Returns: string The path to the error log.

Definition at line 862 of file class.bin.mysql.php.

    {
        return $this->errorLog;
    }

References $errorLog.

◆ getExe()

getExe ( )

Retrieves the path to the MySQL executable.

Returns: string The path to the MySQL executable.

Definition at line 872 of file class.bin.mysql.php.

    {
        return $this->exe;
    }

References $exe.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getPort()

getPort ( )

Retrieves the MySQL port number.

Returns: int The port number.

Definition at line 892 of file class.bin.mysql.php.

    {
        return $this->port;
    }

References $port.

◆ getRootPwd()

getRootPwd ( )

Retrieves the MySQL root password.

Returns: string The root password.

Definition at line 932 of file class.bin.mysql.php.

    {
        return $this->rootPwd;
    }

References $rootPwd.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getRootUser()

getRootUser ( )

Retrieves the MySQL root username.

Returns: string The root username.

Definition at line 912 of file class.bin.mysql.php.

    {
        return $this->rootUser;
    }

References $rootUser.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getService()

getService ( )

Retrieves the MySQL service object.

Returns: Win32Service The MySQL service object.

Definition at line 819 of file class.bin.mysql.php.

    {
        return $this->service;
    }

References $service.

◆ initData()

initData	(		$path = null,
			$version = null )

Initializes the MySQL data directory if needed. Triggers reinitialization when the directory exists but is incomplete (e.g., missing performance_schema).

Parameters

string \| null	$path	The path to the MySQL installation. If null, the current path is used.
string \| null	$version	The version of MySQL. If null, the current version is used.

Returns: bool True if initialization was successful or not needed

Definition at line 674 of file class.bin.mysql.php.

    {
        Log::trace('Starting MySQL data initialization');
        $startTime = microtime(true);
 
        $path          = $path != null ? $path : Path::getModuleCurrentPath($this);
        $version       = $version != null ? $version : $this->getVersion();
        $dataDir       = $path . '/data';
        $perfSchemaDir = $dataDir . '/performance_schema';
 
        if (version_compare($version, '5.7.0', '<')) {
            Log::trace('MySQL version below 5.7.0, skipping initialization');
 
            return true;
        }
 
        $needsInit = false;
 
        if (!is_dir($dataDir)) {
            Log::trace('MySQL data directory does not exist; initialization required');
            $needsInit = true;
        } else {
            if (!is_dir($perfSchemaDir)) {
                Log::trace('performance_schema directory missing; reinitialization required');
                $needsInit = true;
            }
        }
 
        if (!$needsInit) {
            Log::trace('MySQL data directory already initialized');
 
            return true;
        }
 
        // Prepare a clean data directory (mysqld --initialize-insecure requires an empty/nonexistent directory)
        if (is_dir($dataDir)) {
            $backupDir = $dataDir . '_bak_' . date('Ymd_His');
            if (@rename($dataDir, $backupDir)) {
                Log::trace('Backed up existing data directory to: ' . $backupDir);
            } else {
                Log::trace('Failed to backup existing data directory; attempting to clear it');
                try {
                    $it    = new \RecursiveDirectoryIterator($dataDir, \FilesystemIterator::SKIP_DOTS);
                    $files = new \RecursiveIteratorIterator($it, \RecursiveIteratorIterator::CHILD_FIRST);
                    foreach ($files as $file) {
                        if ($file->isDir()) {
                            @rmdir($file->getPathname());
                        } else {
                            @unlink($file->getPathname());
                        }
                    }
                    @rmdir($dataDir);
                } catch (\Throwable $t) {
                    Log::trace('Error clearing data directory: ' . $t->getMessage());
                }
            }
        }
 
        if (!is_dir($dataDir)) {
            @mkdir($dataDir, 0777, true);
            Log::trace('Created clean MySQL data directory');
        }
 
        // Use Bearsampp built-in initialization (init.bat via Batch)
        try {
            Batch::initializeMysql($path);
        } catch (\Throwable $e) {
            Log::trace('Error during MySQL initialization via Batch: ' . $e->getMessage());
 
            return false;
        }
 
        // Verify initialization by checking performance_schema existence
        if (!is_dir($perfSchemaDir)) {
            Log::trace('MySQL initialization appears to have failed: performance_schema still missing');
 
            return false;
        }
 
        $totalTime = round(microtime(true) - $startTime, 2);
        Log::trace("MySQL initialization completed in {$totalTime}s");
 
        return true;
    }

References $dataDir, Module\$version, Path\getModuleCurrentPath(), Module\getVersion(), Batch\initializeMysql(), and Log\trace().

Referenced by updateConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reload()

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

Reloads the MySQL 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 134 of file class.bin.mysql.php.

    {
        global $bearsamppRoot, $bearsamppConfig, $bearsamppLang;
        Log::reloadClass($this);
 
        $this->name    = $bearsamppLang->getValue(Lang::MYSQL);
        $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->errorLog = Path::getLogsPath() . '/mysql.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->rootUser = isset($this->bearsamppConfRaw[self::LOCAL_CFG_ROOT_USER]) ? $this->bearsamppConfRaw[self::LOCAL_CFG_ROOT_USER] : 'root';
            $this->rootPwd  = isset($this->bearsamppConfRaw[self::LOCAL_CFG_ROOT_PWD]) ? $this->bearsamppConfRaw[self::LOCAL_CFG_ROOT_PWD] : '';
            $this->cliExe   = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_CLI_EXE];
            $this->admin    = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_ADMIN];
            $this->dataDir  = $this->symlinkPath . '/data';
        }
 
        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 (!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 (empty($this->rootUser)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_INVALID_PARAMETER), self::LOCAL_CFG_ROOT_USER, $this->rootUser));
 
            return;
        }
        if (!is_file($this->cliExe)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->cliExe));
 
            return;
        }
        if (!is_file($this->admin)) {
            Log::error(sprintf($bearsamppLang->getValue(Lang::ERROR_EXE_NOT_FOUND), $this->name . ' ' . $this->version, $this->admin));
 
            return;
        }
 
        $this->service->setDisplayName(APP_TITLE . ' ' . $this->getName());
        $this->service->setBinPath($this->exe);
        $this->service->setParams(self::SERVICE_NAME);
        $this->service->setStartType(Win32Service::SERVICE_DEMAND_START);
        $this->service->setErrorControl(Win32Service::SERVER_ERROR_NORMAL);
    }

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\MYSQL, Log\reloadClass(), Win32Service\SERVER_ERROR_NORMAL, and Win32Service\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 221 of file class.bin.mysql.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_ROOT_USER:
                    $this->rootUser = $value;
                    break;
                case self::LOCAL_CFG_ROOT_PWD:
                    $this->rootPwd = $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 MySQL module and updates the configuration.

Parameters

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

Definition at line 830 of file class.bin.mysql.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 MySQL port number and updates the configuration.

Parameters

int $port The port number to set.

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

◆ setRootPwd()

setRootPwd ( $rootPwd )

Sets the MySQL root password and updates the configuration.

Parameters

string $rootPwd The root password to set.

Definition at line 942 of file class.bin.mysql.php.

    {
        $this->replace(self::LOCAL_CFG_ROOT_PWD, $rootPwd);
    }

References $rootPwd, and Module\replace().

Referenced by changeRootPassword().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRootUser()

setRootUser ( $rootUser )

Sets the MySQL root username and updates the configuration.

Parameters

string $rootUser The root username to set.

Definition at line 922 of file class.bin.mysql.php.

    {
        $this->replace(self::LOCAL_CFG_ROOT_USER, $rootUser);
    }

References $rootUser, and Module\replace().

Here is the call graph for this function:

◆ setVersion()

setVersion ( $version )

Sets the MySQL version and reloads the configuration.

Parameters

string $version The version to set.

Reimplemented from Module.

Definition at line 806 of file class.bin.mysql.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 MySQL version and updates the configuration.

Parameters

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

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

Definition at line 583 of file class.bin.mysql.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 MySQL 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 message box with the result.

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

Reimplemented from Module.

Definition at line 599 of file class.bin.mysql.php.

    {
        global $bearsamppLang, $bearsamppBins, $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);
 
        $currentPath   = str_replace('mysql' . $this->getVersion(), 'mysql' . $version, Path::getModuleCurrentPath($this));
        $conf          = str_replace('mysql' . $this->getVersion(), 'mysql' . $version, $this->getConf());
        $bearsamppConf = str_replace('mysql' . $this->getVersion(), 'mysql' . $version, $this->bearsamppConf);
 
        if ($this->version != $version) {
            $this->initData($currentPath, $version);
        }
 
        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;
        }
 
        // bearsampp.conf
        $this->setVersion($version);
 
        // Invalidate cache for the new version's config
        self::invalidateConfigCacheForPath($bearsamppConf);
 
        // conf
        Util::replaceInFile($this->getConf(), array(
            '/^port(.*?)=(.*?)(\d+)/' => 'port = ' . $this->port
        ));
 
        // phpmyadmin
        $bearsamppApps->getPhpmyadmin()->update($sub + 1);
 
        // php
        $bearsamppBins->getPhp()->update($sub + 1);
 
        return true;
    }

References $bearsamppBins, Module\$bearsamppConf, Module\$bearsamppConfRaw, $bearsamppLang, $conf, Module\$currentPath, Module\$version, Lang\BEARSAMPP_CONF_MALFORMED_ERROR, Lang\BEARSAMPP_CONF_NOT_FOUND_ERROR, Log\debug(), Log\error(), getConf(), Path\getModuleCurrentPath(), Module\getName(), Module\getVersion(), initData(), Module\invalidateConfigCacheForPath(), 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

◆ $admin

$admin

private

Definition at line 110 of file class.bin.mysql.php.

Referenced by getAdmin().

◆ $cliExe

$cliExe

private

Definition at line 106 of file class.bin.mysql.php.

Referenced by getCliExe().

◆ $conf

$conf

private

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

Referenced by getConf(), and updateConfig().

◆ $dataDir

$dataDir

private

Definition at line 114 of file class.bin.mysql.php.

Referenced by getDataDir(), and initData().

◆ $errorLog

$errorLog

private

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

Referenced by getErrorLog().

◆ $exe

$exe

private

Definition at line 86 of file class.bin.mysql.php.

Referenced by getExe().

◆ $port

$port

private

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

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

◆ $rootPwd

$rootPwd

private

Definition at line 102 of file class.bin.mysql.php.

Referenced by getRootPwd(), and setRootPwd().

◆ $rootUser

$rootUser

private

Definition at line 98 of file class.bin.mysql.php.

Referenced by getRootUser(), and setRootUser().

◆ $service

$service

private

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

Referenced by getService().

◆ CMD_SYNTAX_CHECK

const CMD_SYNTAX_CHECK = '--help --verbose 1>NUL'

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

Definition at line 72 of file class.bin.mysql.php.

Referenced by ActionService\__construct(), ActionDebugMysql\getCommandMapping(), TplAppMysql\getMenuMysqlDebug(), ServiceHelper\hasSyntaxCheck(), ServiceHelper\initializeMappings(), ActionStartup\prepareService(), and Win32Service\start().

◆ CMD_VARIABLES

const CMD_VARIABLES = 'variables'

Command line option to display MySQL server variables.

Definition at line 68 of file class.bin.mysql.php.

Referenced by ActionDebugMysql\getCommandMapping(), and TplAppMysql\getMenuMysqlDebug().

◆ CMD_VERSION

const CMD_VERSION = '--version'

Command line option to display the MySQL version.

Definition at line 64 of file class.bin.mysql.php.

Referenced by ActionDebugMysql\getCommandMapping(), and TplAppMysql\getMenuMysqlDebug().

◆ LOCAL_CFG_ADMIN

const LOCAL_CFG_ADMIN = 'mysqlAdmin'

Configuration key for the MySQL admin executable in the local configuration.

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

◆ LOCAL_CFG_CLI_EXE

const LOCAL_CFG_CLI_EXE = 'mysqlCliExe'

Configuration key for the MySQL CLI executable in the local configuration.

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

◆ LOCAL_CFG_CONF

const LOCAL_CFG_CONF = 'mysqlConf'

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

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

◆ LOCAL_CFG_EXE

const LOCAL_CFG_EXE = 'mysqlExe'

Configuration key for the MySQL executable in the local configuration.

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

◆ LOCAL_CFG_PORT

const LOCAL_CFG_PORT = 'mysqlPort'

Configuration key for the MySQL port in the local configuration.

Definition at line 51 of file class.bin.mysql.php.

◆ LOCAL_CFG_ROOT_PWD

const LOCAL_CFG_ROOT_PWD = 'mysqlRootPwd'

Configuration key for the MySQL root password in the local configuration.

Definition at line 59 of file class.bin.mysql.php.

◆ LOCAL_CFG_ROOT_USER

const LOCAL_CFG_ROOT_USER = 'mysqlRootUser'

Configuration key for the MySQL root user in the local configuration.

Definition at line 55 of file class.bin.mysql.php.

◆ ROOT_CFG_ENABLE

const ROOT_CFG_ENABLE = 'mysqlEnable'

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

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

◆ ROOT_CFG_VERSION

const ROOT_CFG_VERSION = 'mysqlVersion'

Configuration key for the MySQL version in the root configuration.

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

◆ SERVICE_NAME

const SERVICE_NAME = 'bearsamppmysql'

The name of the Windows service.

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

Referenced by ActionReload\__construct(), ActionService\__construct(), ServiceHelper\forceKillService(), TplAppMysql\getActionInstallMysqlService(), TplAppMysql\getActionRemoveMysqlService(), ServiceHelper\getAllServiceNames(), ActionQuit\getServiceDisplayName(), Bins\getServices(), ActionQuit\getServiceShutdownOrder(), ActionRestartAllServices\getServiceShutdownOrder(), ActionRestartAllServices\getServiceStartupOrder(), ServiceHelper\hasSyntaxCheck(), ServiceHelper\initializeMappings(), ActionStartup\prepareService(), and Win32Service\start().

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

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

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ changePort()

◆ changeRootPassword()

◆ checkPort()

◆ checkRootPassword()

◆ getAdmin()

◆ getCliExe()

◆ getCmdLineOutput()

◆ getConf()

◆ getDataDir()

◆ getErrorLog()

◆ getExe()

◆ getPort()

◆ getRootPwd()

◆ getRootUser()

◆ getService()

◆ initData()

◆ reload()

◆ replaceAll()

◆ setEnable()

◆ setPort()

◆ setRootPwd()

◆ setRootUser()

◆ setVersion()

◆ switchVersion()

◆ updateConfig()

Field Documentation

◆ $admin

◆ $cliExe

◆ $conf

◆ $dataDir

◆ $errorLog

◆ $exe

◆ $port

◆ $rootPwd

◆ $rootUser

◆ $service

◆ CMD_SYNTAX_CHECK

◆ CMD_VARIABLES

◆ CMD_VERSION

◆ LOCAL_CFG_ADMIN

◆ LOCAL_CFG_CLI_EXE

◆ LOCAL_CFG_CONF

◆ LOCAL_CFG_EXE

◆ LOCAL_CFG_PORT

◆ LOCAL_CFG_ROOT_PWD

◆ LOCAL_CFG_ROOT_USER

◆ ROOT_CFG_ENABLE

◆ ROOT_CFG_VERSION

◆ SERVICE_NAME