ActionSwitchVersion Class Reference

Public Member Functions
	__construct ($args)
	processWindow ($window, $id, $ctrl, $param1, $param2)

Data Fields
const	CONFIG_KEY_VERSION = 'version'
const	CONFIG_SECTION_APACHE = 'apache'
const	CONFIG_SECTION_MAILPIT = 'mailpit'
const	CONFIG_SECTION_MARIADB = 'mariadb'
const	CONFIG_SECTION_MEMCACHED = 'memcached'
const	CONFIG_SECTION_MYSQL = 'mysql'
const	CONFIG_SECTION_NODEJS = 'nodejs'
const	CONFIG_SECTION_PHP = 'php'
const	CONFIG_SECTION_POSTGRESQL = 'postgresql'
const	CONFIG_SECTION_XLIGHT = 'xlight'
const	GAUGE_OTHERS = 7
const	GAUGE_SERVICES = 1

Private Member Functions
	updateConfigVersion ()

Private Attributes
	$bearsamppSplash
	$bin
	$boxTitle
	$changePort
	$currentVersion
	$pathsToScan = []
	$service
	$version

Detailed Description

Class ActionSwitchVersion Handles the switching of versions for various services and binaries in the Bearsampp application.

Definition at line 15 of file class.action.switchVersion.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$args

)

ActionSwitchVersion constructor. Initializes the class with the provided arguments and sets up the splash screen.

Parameters

array

$args

Command line arguments for switching versions.

Definition at line 67 of file class.action.switchVersion.php.

    {
        global $bearsamppLang, $bearsamppBins, $bearsamppWinbinder;
 
        if (isset($args[0]) && !empty($args[0]) && isset($args[1]) && !empty($args[1])) {
            $this->pathsToScan = array();
            $this->version     = $args[1];
 
            if ($args[0] == $bearsamppBins->getApache()->getName()) {
                $this->bin            = $bearsamppBins->getApache();
                $this->currentVersion = $bearsamppBins->getApache()->getVersion();
                $this->service        = $bearsamppBins->getApache()->getService();
                $this->changePort     = true;
                $folderList           = Util::getFolderList(Path::getModuleRootPath($bearsamppBins->getApache()));
                foreach ($folderList as $folder) {
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getApache()) . '/' . $folder,
                        'includes'  => array('.ini', '.conf'),
                        'recursive' => true
                    );
                }
            } elseif ($args[0] == $bearsamppBins->getPhp()->getName()) {
                $this->bin            = $bearsamppBins->getPhp();
                $this->currentVersion = $bearsamppBins->getPhp()->getVersion();
                $this->service        = $bearsamppBins->getApache()->getService();
                $this->changePort     = false;
                $folderList           = Util::getFolderList(Path::getModuleRootPath($bearsamppBins->getPhp()));
                foreach ($folderList as $folder) {
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getPhp()) . '/' . $folder,
                        'includes'  => array('.php', '.bat', '.ini', '.reg', '.inc'),
                        'recursive' => true
                    );
                }
            } elseif ($args[0] == $bearsamppBins->getMysql()->getName()) {
                $this->bin            = $bearsamppBins->getMysql();
                $this->currentVersion = $bearsamppBins->getMysql()->getVersion();
                $this->service        = $bearsamppBins->getMysql()->getService();
                $this->changePort     = true;
                $folderList           = Util::getFolderList(Path::getModuleRootPath($bearsamppBins->getMysql()));
                foreach ($folderList as $folder) {
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getMysql()) . '/' . $folder,
                        'includes'  => array('my.ini'),
                        'recursive' => false
                    );
                }
            } elseif ($args[0] == $bearsamppBins->getMariadb()->getName()) {
                $this->bin            = $bearsamppBins->getMariadb();
                $this->currentVersion = $bearsamppBins->getMariadb()->getVersion();
                $this->service        = $bearsamppBins->getMariadb()->getService();
                $this->changePort     = true;
                $folderList           = Util::getFolderList(Path::getModuleRootPath($bearsamppBins->getMariadb()));
                foreach ($folderList as $folder) {
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getMariadb()) . '/' . $folder,
                        'includes'  => array('my.ini'),
                        'recursive' => false
                    );
                }
            } elseif ($args[0] == $bearsamppBins->getPostgresql()->getName()) {
                $this->bin            = $bearsamppBins->getPostgresql();
                $this->currentVersion = $bearsamppBins->getPostgresql()->getVersion();
                $this->service        = $bearsamppBins->getPostgresql()->getService();
                $this->changePort     = true;
                $folderList           = Util::getFolderList(Path::getModuleRootPath($bearsamppBins->getPostgresql()));
                foreach ($folderList as $folder) {
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getPostgresql()) . '/' . $folder,
                        'includes'  => array('.conf', '.bat'),
                        'recursive' => true
                    );
                }
            } elseif ($args[0] == $bearsamppBins->getNodejs()->getName()) {
                $this->bin            = $bearsamppBins->getNodejs();
                $this->currentVersion = $bearsamppBins->getNodejs()->getVersion();
                $this->service        = null;
                $this->changePort     = false;
                $folderList           = Util::getFolderList(Path::getModuleRootPath($bearsamppBins->getNodejs()));
                foreach ($folderList as $folder) {
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getNodejs()) . '/' . $folder . '/etc',
                        'includes'  => array('npmrc'),
                        'recursive' => true
                    );
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getNodejs()) . '/' . $folder . '/node_modules/npm',
                        'includes'  => array('npmrc'),
                        'recursive' => false
                    );
                }
            } elseif ($args[0] == $bearsamppBins->getMemcached()->getName()) {
                $this->bin            = $bearsamppBins->getMemcached();
                $this->currentVersion = $bearsamppBins->getMemcached()->getVersion();
                $this->service        = $bearsamppBins->getMemcached()->getService();
                $this->changePort     = true;
            } elseif ($args[0] == $bearsamppBins->getMailpit()->getName()) {
                $this->bin            = $bearsamppBins->getMailpit();
                $this->currentVersion = $bearsamppBins->getMailpit()->getVersion();
                $this->service        = $bearsamppBins->getMailpit()->getService();
                $this->changePort     = false;
                $folderList           = Util::getFolderList(Path::getModuleRootPath($bearsamppBins->getMailpit()));
                foreach ($folderList as $folder) {
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getMailpit()) . '/' . $folder,
                        'includes'  => array('.conf'),
                        'recursive' => true
                    );
                }
            } elseif ($args[0] == $bearsamppBins->getXlight()->getName()) {
                $this->bin            = $bearsamppBins->getXlight();
                $this->currentVersion = $bearsamppBins->getXlight()->getVersion();
                $this->service        = $bearsamppBins->getXlight()->getService();
                $this->changePort     = true;
                $folderList           = Util::getFolderList(Path::getModuleRootPath($bearsamppBins->getXlight()));
                foreach ($folderList as $folder) {
                    $this->pathsToScan[] = array(
                        'path'      => Path::getModuleRootPath($bearsamppBins->getXlight()) . '/' . $folder,
                        'includes'  => array('.conf, ftpd.hosts, ftpd.option, ftpd.password, ftpd.rules, ftpd.users, .ini'),
                        'recursive' => true
                    );
                }
            }
 
            $this->boxTitle = sprintf($bearsamppLang->getValue(Lang::SWITCH_VERSION_TITLE), $this->bin->getName(), $this->version);
 
            // Start splash screen
            $this->bearsamppSplash = new Splash();
            $this->bearsamppSplash->init(
                $this->boxTitle,
                self::GAUGE_SERVICES * count($bearsamppBins->getServices()) + self::GAUGE_OTHERS,
                $this->boxTitle
            );
 
            $bearsamppWinbinder->setHandler($this->bearsamppSplash->getWbWindow(), $this, 'processWindow', 1000);
            $bearsamppWinbinder->mainLoop();
            $bearsamppWinbinder->reset();
        }
    }

References $bearsamppBins, $bearsamppLang, Util\getFolderList(), Path\getModuleRootPath(), and Lang\SWITCH_VERSION_TITLE.

Here is the call graph for this function:

Member Function Documentation

processWindow()

processWindow	(		$window,
			$id,
			$ctrl,
			$param1,
			$param2 )

Processes the window events for the splash screen.

Parameters

mixed	$window	The window handle.
int	$id	The event ID.
mixed	$ctrl	The control handle.
mixed	$param1	The first parameter.
mixed	$param2	The second parameter.

Definition at line 216 of file class.action.switchVersion.php.

    {
        global $bearsamppCore, $bearsamppLang, $bearsamppBins, $bearsamppWinbinder;
 
        if ($this->version == $this->currentVersion) {
            $bearsamppWinbinder->messageBoxWarning(sprintf($bearsamppLang->getValue(Lang::SWITCH_VERSION_SAME_ERROR), $this->bin->getName(), $this->version), $this->boxTitle);
            $bearsamppWinbinder->destroyWindow($window);
        }
 
        // scan folder
        $this->bearsamppSplash->incrProgressBar();
        if (!empty($this->pathsToScan)) {
            Path::changePath(Util::getFilesToScan($this->pathsToScan));
        }
 
        // switch
        $this->bearsamppSplash->incrProgressBar();
        if ($this->bin->switchVersion($this->version, true) === false) {
            $this->bearsamppSplash->incrProgressBar(self::GAUGE_SERVICES * count($bearsamppBins->getServices()) + self::GAUGE_OTHERS);
            $bearsamppWinbinder->destroyWindow($window);
        }
 
        // stop service
        if ($this->service != null) {
            $binName = $this->bin->getName() == $bearsamppLang->getValue(Lang::PHP) ? $bearsamppLang->getValue(Lang::APACHE) : $this->bin->getName();
            $this->bearsamppSplash->setTextLoading(sprintf($bearsamppLang->getValue(Lang::STOP_SERVICE_TITLE), $binName));
            $this->bearsamppSplash->incrProgressBar();
            $this->service->stop();
            // Wait for SCM to stop the service
            usleep(2000000); // 2 seconds
        } else {
            $this->bearsamppSplash->incrProgressBar();
        }
 
        // reload config
        $this->bearsamppSplash->setTextLoading($bearsamppLang->getValue(Lang::SWITCH_VERSION_RELOAD_CONFIG));
        $this->bearsamppSplash->incrProgressBar();
        Root::loadConfig();
 
        // reload bins
        $this->bearsamppSplash->setTextLoading($bearsamppLang->getValue(Lang::SWITCH_VERSION_RELOAD_BINS));
        $this->bearsamppSplash->incrProgressBar();
        $bearsamppBins->reload();
 
        // After reloading bins, get a fresh service reference from the reloaded bin.
        // This ensures we're using the updated service instance with new configuration.
        if ($this->service != null) {
            // PHP is a special case: it runs under Apache's service, not its own.
            if ($this->bin->getName() == $bearsamppBins->getPhp()->getName()) {
                $this->service = $bearsamppBins->getApache()->getService();
                Log::trace("Refreshed service reference from reloaded Apache bin (for PHP)");
            } else {
                $freshBin = $bearsamppBins->getBinByName($this->bin->getName());
                if ($freshBin !== null) {
                    $this->service = $freshBin->getService();
                    Log::trace("Refreshed service reference from reloaded " . $this->bin->getName() . " bin");
                }
            }
        }
 
        // change port
        if ($this->changePort) {
            $this->bin->reload();
            $this->bin->changePort($this->bin->getPort());
        }
 
        // start service
        if ($this->service != null) {
            $binName = $this->bin->getName() == $bearsamppLang->getValue(Lang::PHP) ? $bearsamppLang->getValue(Lang::APACHE) : $this->bin->getName();
            $this->bearsamppSplash->setTextLoading(sprintf($bearsamppLang->getValue(Lang::START_SERVICE_TITLE), $binName));
            $this->bearsamppSplash->incrProgressBar();
            $this->service->start();
        } else {
            $this->bearsamppSplash->incrProgressBar();
        }
 
        $this->bearsamppSplash->incrProgressBar(self::GAUGE_SERVICES * count($bearsamppBins->getServices()) + 1);
 
        // Update configuration file with the new version
        Log::trace('Updating ini & menu...');
        $this->updateConfigVersion();
 
        // Store current registry value for comparison
        global $bearsamppRegistry;
        $currentRegValue = $bearsamppRegistry->getAppBinsRegKey(false);
        $regEntry        = Registry::APP_BINS_REG_ENTRY;
 
        Log::trace(
            sprintf(
                'Starting registry adjustment for key: %s | Current value: %s',
                $regEntry,
                $currentRegValue
            )
        );
 
        // Perform the registry update
        $newRegValue = $bearsamppRegistry->setAppBinsRegKey($currentRegValue);
 
        $this->bearsamppSplash->setTextLoading(
            sprintf(
                $bearsamppLang->getValue(Lang::SWITCH_VERSION_REGISTRY),
                $regEntry
            )
        );
 
        $this->bearsamppSplash->incrProgressBar(2);
        Log::trace(
            sprintf(
                'Registry update completed | Key: %s | New value: %s | Previous value: %s',
                $regEntry,
                $newRegValue,
                $currentRegValue
            )
        );
 
        $this->bearsamppSplash->setTextLoading($bearsamppLang->getValue(Lang::SWITCH_VERSION_RESET_SERVICES));
 
        // For version switches, services are properly restarted above
        // No additional service reset/delete is needed
        // The service is now running with the new version
        Log::trace('Version switch complete - service restarted with new version');
        $this->bearsamppSplash->incrProgressBar();
 
        // Compensate progress bar for all services (none are being reset)
        $remainingServicesCount = count($bearsamppBins->getServices());
        if ($remainingServicesCount > 0) {
            $this->bearsamppSplash->incrProgressBar($remainingServicesCount);
        }
 
        Log::trace('Version switch process completed successfully');
 
        Log::trace('Creating modal...');
        $bearsamppWinbinder->messageBoxInfo(
            sprintf($bearsamppLang->getValue(Lang::SWITCH_VERSION_OK), $this->bin->getName(), $this->version),
            $this->boxTitle
        );
 
        Log::trace('Destroying splash window...');
        $bearsamppWinbinder->destroyWindow($window);
    }

References $bearsamppBins, $bearsamppCore, $bearsamppLang, Lang\APACHE, Registry\APP_BINS_REG_ENTRY, Path\changePath(), Util\getFilesToScan(), Root\loadConfig(), Lang\PHP, Lang\START_SERVICE_TITLE, Lang\STOP_SERVICE_TITLE, Lang\SWITCH_VERSION_OK, Lang\SWITCH_VERSION_REGISTRY, Lang\SWITCH_VERSION_RELOAD_BINS, Lang\SWITCH_VERSION_RELOAD_CONFIG, Lang\SWITCH_VERSION_RESET_SERVICES, Lang\SWITCH_VERSION_SAME_ERROR, Log\trace(), and updateConfigVersion().

Here is the call graph for this function:

updateConfigVersion()

updateConfigVersion ( )

private

Updates the configuration file with the new version of the binary This ensures version persistence across restarts

Definition at line 361 of file class.action.switchVersion.php.

                                          : void
    {
        $bearsamppConfig = new Config();
        $configSection   = '';
        $version         = $this->version; // Ensure version is available in scope
 
        // Determine the correct configuration section based on binary type
        if ($this->bin->getName() == $GLOBALS['bearsamppBins']->getApache()->getName()) {
            $configSection = self::CONFIG_SECTION_APACHE;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        } elseif ($this->bin->getName() == $GLOBALS['bearsamppBins']->getPhp()->getName()) {
            $configSection = self::CONFIG_SECTION_PHP;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        } elseif ($this->bin->getName() == $GLOBALS['bearsamppBins']->getMysql()->getName()) {
            $configSection = self::CONFIG_SECTION_MYSQL;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        } elseif ($this->bin->getName() == $GLOBALS['bearsamppBins']->getMariadb()->getName()) {
            $configSection = self::CONFIG_SECTION_MARIADB;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        } elseif ($this->bin->getName() == $GLOBALS['bearsamppBins']->getPostgresql()->getName()) {
            $configSection = self::CONFIG_SECTION_POSTGRESQL;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        } elseif ($this->bin->getName() == $GLOBALS['bearsamppBins']->getNodejs()->getName()) {
            $configSection = self::CONFIG_SECTION_NODEJS;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        } elseif ($this->bin->getName() == $GLOBALS['bearsamppBins']->getMemcached()->getName()) {
            $configSection = self::CONFIG_SECTION_MEMCACHED;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        } elseif ($this->bin->getName() == $GLOBALS['bearsamppBins']->getMailpit()->getName()) {
            $configSection = self::CONFIG_SECTION_MAILPIT;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        } elseif ($this->bin->getName() == $GLOBALS['bearsamppBins']->getXlight()->getName()) {
            $configSection = self::CONFIG_SECTION_XLIGHT;
            Log::trace(sprintf('Switch %s version to %s', $configSection, $version));
        }
 
        // Update the configuration if a valid section was found
        if (!empty($configSection)) {
            Log::trace('Updating .ini file...');
            $bearsamppConfig->replace($configSection, self::CONFIG_KEY_VERSION, $version);
 
            // Update tray menu display if TrayMenu class is available
            Log::trace('Updating TrayMenu...');
            if (class_exists('TrayMenu')) {
                $trayMenu = TrayMenu::getInstance();
                if (method_exists($trayMenu, 'updateSectionVersion')) {
                    $trayMenu->updateSectionVersion(
                        strtoupper($configSection),
                        $version
                    );
                }
            }
        }
        Log::trace('Returning to parent call');
    }

References $bearsamppConfig, $GLOBALS, $version, and Log\trace().

Referenced by processWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$bearsamppSplash

$bearsamppSplash

private

Definition at line 18 of file class.action.switchVersion.php.

$bin

$bin

private

Definition at line 24 of file class.action.switchVersion.php.

$boxTitle

$boxTitle

private

Definition at line 36 of file class.action.switchVersion.php.

$changePort

$changePort

private

Definition at line 33 of file class.action.switchVersion.php.

$currentVersion

$currentVersion

private

Definition at line 27 of file class.action.switchVersion.php.

$pathsToScan

$pathsToScan = []

private

Definition at line 39 of file class.action.switchVersion.php.

$service

$service

private

Definition at line 30 of file class.action.switchVersion.php.

$version

$version

private

Definition at line 21 of file class.action.switchVersion.php.

Referenced by updateConfigVersion().

CONFIG_KEY_VERSION

const CONFIG_KEY_VERSION = 'version'

Definition at line 59 of file class.action.switchVersion.php.

CONFIG_SECTION_APACHE

const CONFIG_SECTION_APACHE = 'apache'

Definition at line 48 of file class.action.switchVersion.php.

CONFIG_SECTION_MAILPIT

const CONFIG_SECTION_MAILPIT = 'mailpit'

Definition at line 55 of file class.action.switchVersion.php.

CONFIG_SECTION_MARIADB

const CONFIG_SECTION_MARIADB = 'mariadb'

Definition at line 51 of file class.action.switchVersion.php.

CONFIG_SECTION_MEMCACHED

const CONFIG_SECTION_MEMCACHED = 'memcached'

Definition at line 54 of file class.action.switchVersion.php.

CONFIG_SECTION_MYSQL

const CONFIG_SECTION_MYSQL = 'mysql'

Definition at line 50 of file class.action.switchVersion.php.

CONFIG_SECTION_NODEJS

const CONFIG_SECTION_NODEJS = 'nodejs'

Definition at line 53 of file class.action.switchVersion.php.

CONFIG_SECTION_PHP

const CONFIG_SECTION_PHP = 'php'

Definition at line 49 of file class.action.switchVersion.php.

CONFIG_SECTION_POSTGRESQL

const CONFIG_SECTION_POSTGRESQL = 'postgresql'

Definition at line 52 of file class.action.switchVersion.php.

CONFIG_SECTION_XLIGHT

const CONFIG_SECTION_XLIGHT = 'xlight'

Definition at line 56 of file class.action.switchVersion.php.

GAUGE_OTHERS

const GAUGE_OTHERS = 7

Definition at line 45 of file class.action.switchVersion.php.

GAUGE_SERVICES

const GAUGE_SERVICES = 1

Definition at line 42 of file class.action.switchVersion.php.

---

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

• E:/Bearsampp-development/sandbox/core/classes/actions/class.action.switchVersion.php