Inheritance diagram for BinMariadb:

Collaboration diagram for BinMariadb:

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 = 'mariadbAdmin'
const	LOCAL_CFG_CLI_EXE = 'mariadbCliExe'
const	LOCAL_CFG_CONF = 'mariadbConf'
const	LOCAL_CFG_EXE = 'mariadbExe'
const	LOCAL_CFG_PORT = 'mariadbPort'
const	LOCAL_CFG_ROOT_PWD = 'mariadbRootPwd'
const	LOCAL_CFG_ROOT_USER = 'mariadbRootUser'
const	ROOT_CFG_ENABLE = 'mariadbEnable'
const	ROOT_CFG_VERSION = 'mariadbVersion'
const	SERVICE_NAME = 'bearsamppmariadb'
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
	$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 BinMariadb

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

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

Constructor & Destructor Documentation

◆ __construct()

__construct	(		$id,
			$type )

Constructs a BinMariadb object and initializes the module.

Parameters

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

Definition at line 118 of file class.bin.mariadb.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 MariaDB.

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 the process using the port if it is in use.

Definition at line 250 of file class.bin.mariadb.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 root password for MariaDB.

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 it failed.

Definition at line 378 of file class.bin.mariadb.php.

    {
        global $bearsamppWinbinder;
 
        $error  = null;
        $dbLink = false;
 
        try {
            // Connect
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            // Since PHP 8.1 mysqli defaults to exception mode (MYSQLI_REPORT_STRICT),
            // so a failed auth throws mysqli_sql_exception instead of returning false.
            // Reset to OFF so calls return false and mysqli_connect_error() is set,
            // keeping the documented bool|string contract and avoiding an uncaught
            // exception that would freeze the WinBinder GUI thread.
            mysqli_report(MYSQLI_REPORT_OFF);
 
            $dbLink = mysqli_init();
            mysqli_options($dbLink, MYSQLI_OPT_CONNECT_TIMEOUT, 5);
            if (!mysqli_real_connect($dbLink, APP_LOCALHOST, $this->rootUser, $currentPwd, null, $this->port)) {
                throw new \RuntimeException(mysqli_connect_error());
            }
 
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            // Bound metadata-lock/table-lock waits so a password change can
            // never freeze the UI: any lock contention times out in seconds
            // instead of waiting for the server's default (often very large)
            // lock_wait_timeout.
            mysqli_query($dbLink, 'SET SESSION lock_wait_timeout = 5');
            mysqli_query($dbLink, 'SET SESSION innodb_lock_wait_timeout = 5');
 
            // ALTER USER works reliably across MariaDB 10.3+ and avoids
            // known SET PASSWORD bugs (MDEV-16774, MDEV-17136) and
            // metadata lock contention on the mysql.user table in 10.3.
            // The user and host are given explicitly (not CURRENT_USER()).
            // The password is escaped so an empty (blank) password is
            // allowed: IDENTIFIED BY '' sets a blank password.
            $escapedUser = mysqli_real_escape_string($dbLink, $this->rootUser);
            $escapedPwd  = mysqli_real_escape_string($dbLink, $newPwd);
            $sql         = "ALTER USER '" . $escapedUser . "'@'localhost' IDENTIFIED BY '" . $escapedPwd . "'";
 
            if (mysqli_query($dbLink, $sql) === false) {
                throw new \RuntimeException(mysqli_error($dbLink));
            }
 
            // Preserve the existing progress-step count.
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
            mysqli_close($dbLink);
            $dbLink = false;
 
            $bearsamppWinbinder->incrProgressBar($wbProgressBar);
        } catch (\Throwable $e) {
            $error = $e->getMessage();
 
            if ($dbLink) {
                @mysqli_close($dbLink);
            }
        }
 
        if (!empty($error)) {
            return $error;
        }
 
        // bearsampp.conf
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
        $this->setRootPwd($newPwd);
 
        // conf
        $this->update();
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        return true;
    }

References APP_LOCALHOST, setRootPwd(), and Module\update().

Here is the call graph for this function:

◆ checkPort()

checkPort	(		$port,
			$showWindow = false )

Checks if the specified port is used by MariaDB.

Parameters

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

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

Definition at line 289 of file class.bin.mariadb.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;
        }
 
        $fp = @fsockopen(APP_LOCALHOST, $port, $errno, $errstr, 5);
        if ($fp) {
            // Reset mysqli to non-exception mode so connect/query failures
            // return false instead of throwing an uncaught mysqli_sql_exception
            // that would freeze the WinBinder GUI thread.
            mysqli_report(MYSQLI_REPORT_OFF);
 
            $dbLink    = mysqli_connect(APP_LOCALHOST . ':' . $port, $this->rootUser, $this->rootPwd);
            $isMariadb = false;
            $version   = false;
 
            if ($dbLink) {
                $result = mysqli_query($dbLink, 'SHOW VARIABLES');
                if ($result) {
                    while (false !== ($row = mysqli_fetch_array($result, MYSQLI_NUM))) {
                        if ($row[0] == 'version') {
                            $version = explode('-', $row[1]);
                            $version = count($version) > 1 ? $version[0] : $row[1];
                        }
                        if ($row[0] == 'version_comment' && UtilString::startWith(strtolower($row[1]), 'mariadb')) {
                            $isMariadb = true;
                        }
                        if ($isMariadb && $version !== false) {
                            break;
                        }
                    }
                    if (!$isMariadb) {
                        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
                            );
                        }
                    } else {
                        Log::debug($this->getName() . ' port ' . $port . ' is used by: ' . $this->getName() . ' ' . $version);
                        if ($showWindow) {
                            $bearsamppWinbinder->messageBoxInfo(
                                sprintf($bearsamppLang->getValue(Lang::PORT_USED_BY), $port, $this->getName() . ' ' . $version),
                                $boxTitle
                            );
                        }
 
                        return true;
                    }
                }
                mysqli_close($dbLink);
            } else {
                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, $result, 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, and UtilString\startWith().

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 it is incorrect.

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

    {
        global $bearsamppWinbinder;
        $currentPwd = $currentPwd == null ? $this->rootPwd : $currentPwd;
        $error      = null;
 
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
 
        // Reset mysqli to non-exception mode so a bad password returns false
        // (with mysqli_connect_error() set) instead of throwing an uncaught
        // mysqli_sql_exception that would freeze the WinBinder GUI thread.
        mysqli_report(MYSQLI_REPORT_OFF);
 
        $dbLink = mysqli_init();
        mysqli_options($dbLink, MYSQLI_OPT_CONNECT_TIMEOUT, 5);
        if (!mysqli_real_connect($dbLink, APP_LOCALHOST, $this->rootUser, $currentPwd, null, $this->port)) {
            $error = mysqli_connect_error();
        }
 
        $bearsamppWinbinder->incrProgressBar($wbProgressBar);
        if ($dbLink) {
            mysqli_close($dbLink);
        }
 
        if (!empty($error)) {
            return $error;
        }
 
        return true;
    }

References APP_LOCALHOST.

◆ getAdmin()

getAdmin ( )

Retrieves the admin executable path for the module.

Returns: string The admin executable path.

Definition at line 779 of file class.bin.mariadb.php.

    {
        return $this->admin;
    }

References $admin.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getCliExe()

getCliExe ( )

Retrieves the CLI executable path for the module.

Returns: string The CLI executable path.

Definition at line 769 of file class.bin.mariadb.php.

    {
        return $this->cliExe;
    }

References $cliExe.

◆ getCmdLineOutput()

getCmdLineOutput ( $cmd )

Retrieves the command line output for a given command.

Parameters

string $cmd The command to execute.

Returns

array An associative array containing:

'syntaxOk' (bool): Whether the command executed without syntax errors.
'content' (string|null): The output content of the command.

Definition at line 583 of file class.bin.mariadb.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('mariadbGetCmdLineOutput', '"' . $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 configuration file path for the module.

Returns: string The configuration file path.

Definition at line 699 of file class.bin.mariadb.php.

    {
        return $this->conf;
    }

References $conf.

Referenced by updateConfig().

Here is the caller graph for this function:

◆ getDataDir()

getDataDir ( )

Retrieves the data directory path for MariaDB.

Returns: string The data directory path.

Definition at line 789 of file class.bin.mariadb.php.

    {
        return $this->currentPath . '/data';
    }

◆ getErrorLog()

getErrorLog ( )

Retrieves the error log path for the module.

Returns: string The error log path.

Definition at line 679 of file class.bin.mariadb.php.

    {
        return $this->errorLog;
    }

References $errorLog.

◆ getExe()

getExe ( )

Retrieves the executable path for the module.

Returns: string The executable path.

Definition at line 689 of file class.bin.mariadb.php.

    {
        return $this->exe;
    }

References $exe.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getPort()

getPort ( )

Retrieves the port number for the module.

Returns: int The port number.

Definition at line 709 of file class.bin.mariadb.php.

    {
        return $this->port;
    }

References $port.

◆ getRootPwd()

getRootPwd ( )

Retrieves the root password for the module.

Returns: string The root password.

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

    {
        return $this->rootPwd;
    }

References $rootPwd.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getRootUser()

getRootUser ( )

Retrieves the root user for the module.

Returns: string The root user.

Definition at line 729 of file class.bin.mariadb.php.

    {
        return $this->rootUser;
    }

References $rootUser.

Referenced by getCmdLineOutput().

Here is the caller graph for this function:

◆ getService()

getService ( )

Retrieves the service associated with the module.

Returns: Win32Service The service object.

Definition at line 636 of file class.bin.mariadb.php.

    {
        return $this->service;
    }

References $service.

◆ initData()

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

Initializes the MariaDB data directory if needed.

Parameters

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

Returns: bool True if initialization was successful or not needed

Definition at line 802 of file class.bin.mariadb.php.

    {
        Log::trace('Starting MariaDB data initialization');
        $startTime = microtime(true);
 
        $path    = $path != null ? $path : Path::getModuleCurrentPath($this);
        $version = $version != null ? $version : $this->getVersion();
        $dataDir = $path . '/data';
 
        if (is_dir($dataDir . '/mysql')) {
            Log::trace('MariaDB data directory already initialized');
 
            return true;
        }
 
        if (!is_dir($dataDir)) {
            @mkdir($dataDir, 0777, true);
            Log::trace('Created MariaDB data directory');
        }
 
        // Check for init.bat first
        if (file_exists($path . '/init.bat')) {
            Log::trace('Initializing MariaDB via init.bat');
            try {
                Batch::initializeMariadb($path);
            } catch (\Throwable $e) {
                Log::trace('Error during MariaDB initialization via Batch: ' . $e->getMessage());
 
                return false;
            }
        } else {
            // Use mariadb-install-db.exe
            Log::trace('Initializing MariaDB via mariadb-install-db.exe');
            $installDbExe = $path . '/bin/mariadb-install-db.exe';
            if (!file_exists($installDbExe)) {
                $installDbExe = $path . '/bin/mysql_install_db.exe';
            }
 
            if (file_exists($installDbExe)) {
                $cmd = '"' . Path::formatWindowsPath($installDbExe) . '"';
                $cmd .= ' --datadir="' . Path::formatWindowsPath($dataDir) . '"';
 
                try {
                    Batch::exec('initializeMariadb', $cmd, 60);
                } catch (\Throwable $e) {
                    Log::trace('Error during MariaDB initialization via mariadb-install-db: ' . $e->getMessage());
 
                    return false;
                }
            } else {
                Log::error('MariaDB initialization failed: No init.bat or mariadb-install-db.exe found');
 
                return false;
            }
        }
 
        // Verify initialization
        if (!is_dir($dataDir . '/mysql')) {
            Log::trace('MariaDB initialization appears to have failed: mysql directory still missing');
 
            return false;
        }
 
        $totalTime = round(microtime(true) - $startTime, 2);
        Log::trace("MariaDB initialization completed in {$totalTime}s");
 
        return true;
    }

References Module\$version, Log\error(), Batch\exec(), Path\formatWindowsPath(), Path\getModuleCurrentPath(), Module\getVersion(), Batch\initializeMariadb(), 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 130 of file class.bin.mariadb.php.

    {
        global $bearsamppRoot, $bearsamppConfig, $bearsamppLang;
        Log::reloadClass($this);
 
        $this->name    = $bearsamppLang->getValue(Lang::MARIADB);
        $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() . '/mariadb.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];
        }
 
        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('--defaults-file="' . Path::formatWindowsPath($this->conf) . '" ' . 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\formatWindowsPath(), Path\getLogsPath(), Module\getName(), Log\info(), Lang\MARIADB, 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 216 of file class.bin.mariadb.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 module.

Parameters

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

Definition at line 647 of file class.bin.mariadb.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 for the module.

Parameters

int $port The port number to set.

Definition at line 719 of file class.bin.mariadb.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 root password for the module.

Parameters

string $rootPwd The root password to set.

Definition at line 759 of file class.bin.mariadb.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 root user for the module.

Parameters

string $rootUser The root user to set.

Definition at line 739 of file class.bin.mariadb.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 version of the module.

Parameters

string $version The version to set.

Reimplemented from Module.

Definition at line 623 of file class.bin.mariadb.php.

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

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

Referenced by updateConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ switchVersion()

switchVersion	(		$version,
			$showWindow = false )

Switches the version of MariaDB.

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 503 of file class.bin.mariadb.php.

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

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

Here is the call graph for this function:

◆ updateConfig()

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

protected

Updates the configuration for the specified 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 with the result.

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

Reimplemented from Module.

Definition at line 519 of file class.bin.mariadb.php.

    {
        global $bearsamppLang, $bearsamppApps, $bearsamppWinbinder;
 
        if (!$this->enable) {
            return true;
        }
 
        $version = $version == null ? $this->version : $version;
        Log::debug(($sub > 0 ? str_repeat(' ', 2 * $sub) : '') . 'Update ' . $this->name . ' ' . $version . ' config');
 
        $boxTitle = sprintf($bearsamppLang->getValue(Lang::SWITCH_VERSION_TITLE), $this->getName(), $version);
 
        $conf          = str_replace('mariadb' . $this->getVersion(), 'mariadb' . $version, $this->getConf());
        $bearsamppConf = str_replace('mariadb' . $this->getVersion(), 'mariadb' . $version, $this->bearsamppConf);
 
        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);
 
        // conf
        Util::replaceInFile($this->getConf(), array(
            '/^port(.*?)=(.*?)(\d+)/' => 'port = ' . $this->port
        ));
 
        // phpmyadmin
        $bearsamppApps->getPhpmyadmin()->update($sub + 1);
 
        return true;
    }

References Module\$bearsamppConf, Module\$bearsamppConfRaw, $bearsamppLang, $conf, Module\$version, Lang\BEARSAMPP_CONF_MALFORMED_ERROR, Lang\BEARSAMPP_CONF_NOT_FOUND_ERROR, Log\debug(), Log\error(), getConf(), Module\getName(), Module\getVersion(), 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.mariadb.php.

Referenced by getAdmin().

◆ $cliExe

$cliExe

private

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

Referenced by getCliExe().

◆ $conf

$conf

private

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

Referenced by getConf(), and updateConfig().

◆ $errorLog

$errorLog

private

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

Referenced by getErrorLog().

◆ $exe

$exe

private

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

Referenced by getExe().

◆ $port

$port

private

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

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

◆ $rootPwd

$rootPwd

private

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

Referenced by getRootPwd(), and setRootPwd().

◆ $rootUser

$rootUser

private

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

Referenced by getRootUser(), and setRootUser().

◆ $service

$service

private

Definition at line 77 of file class.bin.mariadb.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.mariadb.php.

Referenced by ActionService\__construct(), ActionDebugMariadb\getCommandMapping(), TplAppMariadb\getMenuMariadbDebug(), ServiceHelper\hasSyntaxCheck(), ServiceHelper\initializeMappings(), ActionStartup\prepareService(), and Win32Service\start().

◆ CMD_VARIABLES

const CMD_VARIABLES = 'variables'

Command line option to display MariaDB server variables.

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

Referenced by ActionDebugMariadb\getCommandMapping(), and TplAppMariadb\getMenuMariadbDebug().

◆ CMD_VERSION

const CMD_VERSION = '--version'

Command line option to display the MariaDB version.

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

Referenced by ActionDebugMariadb\getCommandMapping(), and TplAppMariadb\getMenuMariadbDebug().

◆ LOCAL_CFG_ADMIN

const LOCAL_CFG_ADMIN = 'mariadbAdmin'

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

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

◆ LOCAL_CFG_CLI_EXE

const LOCAL_CFG_CLI_EXE = 'mariadbCliExe'

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

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

◆ LOCAL_CFG_CONF

const LOCAL_CFG_CONF = 'mariadbConf'

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

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

◆ LOCAL_CFG_EXE

const LOCAL_CFG_EXE = 'mariadbExe'

Configuration key for the MariaDB executable in the local configuration.

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

◆ LOCAL_CFG_PORT

const LOCAL_CFG_PORT = 'mariadbPort'

Configuration key for the MariaDB port in the local configuration.

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

◆ LOCAL_CFG_ROOT_PWD

const LOCAL_CFG_ROOT_PWD = 'mariadbRootPwd'

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

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

◆ LOCAL_CFG_ROOT_USER

const LOCAL_CFG_ROOT_USER = 'mariadbRootUser'

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

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

◆ ROOT_CFG_ENABLE

const ROOT_CFG_ENABLE = 'mariadbEnable'

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

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

◆ ROOT_CFG_VERSION

const ROOT_CFG_VERSION = 'mariadbVersion'

Configuration key for the MariaDB version in the root configuration.

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

◆ SERVICE_NAME

const SERVICE_NAME = 'bearsamppmariadb'

The name of the Windows service.

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

Referenced by ActionReload\__construct(), ActionService\__construct(), ServiceHelper\forceKillService(), TplAppMariadb\getActionInstallMariadbService(), TplAppMariadb\getActionRemoveMariadbService(), 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.mariadb.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

◆ $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