class.action.quit.php

Go to the documentation of this file.

<?php
/*
 *
 *  * Copyright (c) 2022-2025 Bearsampp
 *  * License: GNU General Public License version 3 or later; see LICENSE.txt
 *  * Website: https://bearsampp.com
 *  * Github: https://github.com/Bearsampp
 *
 */

class ActionQuit
{
    private $splash;

    const GAUGE_PROCESSES = 1;
    const GAUGE_OTHERS = 1;

    public function __construct($args)
    {
        global $bearsamppCore, $bearsamppLang, $bearsamppBins, $bearsamppWinbinder, $arrayOfCurrents;
 
        Log::info('ActionQuit constructor called - starting exit process');
        Log::debug('Number of services to stop: ' . count($bearsamppBins->getServices()));
 
        // Start splash screen
        $this->splash = new Splash();
        $this->splash->init(
            $bearsamppLang->getValue(Lang::QUIT),
            self::GAUGE_PROCESSES * count($bearsamppBins->getServices()) + self::GAUGE_OTHERS,
            sprintf($bearsamppLang->getValue(Lang::EXIT_LEAVING_TEXT), APP_TITLE . ' ' . $bearsamppCore->getAppVersion())
        );
 
        Log::debug('Splash screen initialized');
 
        // Set handler for the splash screen window
        $bearsamppWinbinder->setHandler($this->splash->getWbWindow(), $this, 'processWindow', 2000);
        Log::debug('Window handler set, starting main loop');
 
        $bearsamppWinbinder->mainLoop();
        Log::debug('Main loop exited');
 
        $bearsamppWinbinder->reset();
        Log::info('ActionQuit constructor completed');
    }
 

    private function getServiceShutdownOrder()
    {
        // Define shutdown order: dependent services first, then core services
        // This prevents connection errors and ensures clean shutdown
        return [
            // Tier 1: Application services (no dependencies on other services)
            BinMailpit::SERVICE_NAME,      // Mail testing tool
            BinMemcached::SERVICE_NAME,    // Caching service
            BinXlight::SERVICE_NAME,       // FTP server
 
            // Tier 2: Database services (web server depends on these)
            BinPostgresql::SERVICE_NAME,   // PostgreSQL database
            BinMariadb::SERVICE_NAME,      // MariaDB database
            BinMysql::SERVICE_NAME,        // MySQL database
 
            // Tier 3: Web server (depends on databases and other services)
            BinApache::SERVICE_NAME,       // Apache web server (stopped last)
        ];
    }

    private function getServiceDisplayName($sName, $service)
    {
        global $bearsamppBins;
 
        $name = '';
 
        if ($sName == BinApache::SERVICE_NAME) {
            $name = $bearsamppBins->getApache()->getName() . ' ' . $bearsamppBins->getApache()->getVersion();
        } elseif ($sName == BinMysql::SERVICE_NAME) {
            $name = $bearsamppBins->getMysql()->getName() . ' ' . $bearsamppBins->getMysql()->getVersion();
        } elseif ($sName == BinMailpit::SERVICE_NAME) {
            $name = $bearsamppBins->getMailpit()->getName() . ' ' . $bearsamppBins->getMailpit()->getVersion();
        } elseif ($sName == BinMariadb::SERVICE_NAME) {
            $name = $bearsamppBins->getMariadb()->getName() . ' ' . $bearsamppBins->getMariadb()->getVersion();
        } elseif ($sName == BinPostgresql::SERVICE_NAME) {
            $name = $bearsamppBins->getPostgresql()->getName() . ' ' . $bearsamppBins->getPostgresql()->getVersion();
        } elseif ($sName == BinMemcached::SERVICE_NAME) {
            $name = $bearsamppBins->getMemcached()->getName() . ' ' . $bearsamppBins->getMemcached()->getVersion();
        } elseif ($sName == BinXlight::SERVICE_NAME) {
            $name = $bearsamppBins->getXlight()->getName() . ' ' . $bearsamppBins->getXlight()->getVersion();
        }
 
        $name .= ' (' . $service->getName() . ')';
 
        return $name;
    }

    public function processWindow($window, $id, $ctrl, $param1, $param2)
    {
        global $bearsamppBins, $bearsamppLang, $bearsamppWinbinder;
 
        Log::info('Starting graceful shutdown process with optimized service order');
 
        // Get all available services
        $allServices = $bearsamppBins->getServices();
 
        // Get optimal shutdown order
        $shutdownOrder = $this->getServiceShutdownOrder();
 
        Log::debug('Service shutdown order: ' . implode(' -> ', $shutdownOrder));
 
        // Stop services in optimal order
        foreach ($shutdownOrder as $sName) {
            // Check if this service exists and is installed
            if (!isset($allServices[$sName])) {
                Log::debug('Service not found in available services: ' . $sName);
                continue;
            }
 
            $service     = $allServices[$sName];
            $displayName = $this->getServiceDisplayName($sName, $service);
 
            Log::info('Stopping service: ' . $displayName);
 
            $this->splash->incrProgressBar();
            $this->splash->setTextLoading(sprintf($bearsamppLang->getValue(Lang::EXIT_REMOVE_SERVICE_TEXT), $displayName));
 
            // Delete (stop and remove) the service
            $result = $service->delete();
 
            if ($result) {
                Log::info('Successfully stopped and removed service: ' . $displayName);
            } else {
                Log::warning('Failed to stop/remove service: ' . $displayName . ' (may not be installed)');
            }
        }
 
        // Handle any services not in the shutdown order (for extensibility)
        foreach ($allServices as $sName => $service) {
            if (!in_array($sName, $shutdownOrder)) {
                $displayName = $this->getServiceDisplayName($sName, $service);
                Log::warning('Stopping unlisted service: ' . $displayName);
 
                $this->splash->incrProgressBar();
                $this->splash->setTextLoading(sprintf($bearsamppLang->getValue(Lang::EXIT_REMOVE_SERVICE_TEXT), $displayName));
                $service->delete();
            }
        }
 
        Log::info('All services stopped successfully');
 
        // Purge "current" symlinks
        $this->splash->setTextLoading('Removing symlinks...');
        Symlinks::deleteCurrentSymlinks();
 
        // Stop other processes
        $this->splash->incrProgressBar();
        $this->splash->setTextLoading($bearsamppLang->getValue(Lang::EXIT_STOP_OTHER_PROCESS_TEXT));
        Win32Ps::killBins(true);
 
        // Explicitly kill NodeJS if still running (it's not a Windows service)
        Log::trace('Explicitly terminating NodeJS processes');
        Win32Ps::killBins(['node.exe']);
 
        // Perform cleanup verification in background (non-blocking)
        $this->splash->setTextLoading('Performing cleanup verification...');
        $this->performQuickCleanupVerification($allServices);
 
        // Terminate any remaining processes
        // Final termination sequence
        $this->splash->setTextLoading('Completing shutdown...');
        if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
            $currentPid = Win32Ps::getCurrentPid();
 
            // Terminate PHP processes with a timeout of 15 seconds
            self::terminatePhpProcesses($currentPid, $window, $this->splash, 15);
 
            // Force exit if still running
            exit(0);
        }
 
        // Non-Windows fallback
        $bearsamppWinbinder->destroyWindow($window);
        exit(0);
    }

    public static function terminatePhpProcesses($excludePid, $window = null, $splash = null, $timeout = 10)
    {
        global $bearsamppWinbinder, $bearsamppCore;
 
        $currentPid = Win32Ps::getCurrentPid();
        $startTime  = microtime(true);
 
        Log::trace('Starting PHP process termination (excluding PID: ' . $excludePid . ')');
 
        // Get list of loading PIDs to exclude from termination
        $loadingPids = array();
        if (file_exists($bearsamppCore->getLoadingPid())) {
            $pids = file($bearsamppCore->getLoadingPid());
            foreach ($pids as $pid) {
                $loadingPids[] = intval(trim($pid));
            }
            Log::trace('Loading PIDs to preserve: ' . implode(', ', $loadingPids));
        }
 
        $targets = ['php-win.exe', 'php.exe'];
        foreach (Win32Ps::getListProcs() as $proc) {
            // Check if we've exceeded our timeout
            if (microtime(true) - $startTime > $timeout) {
                Log::trace('Process termination timeout exceeded, continuing with remaining operations');
                break;
            }
 
            $exe = strtolower(basename($proc[Win32Ps::EXECUTABLE_PATH]));
            $pid = $proc[Win32Ps::PROCESS_ID];
 
            // Skip if this is the excluded PID or a loading window PID
            if (in_array($exe, $targets) && $pid != $excludePid && !in_array($pid, $loadingPids)) {
                Log::trace('Terminating PHP process: ' . $pid);
                Win32Ps::kill($pid);
                usleep(100000); // 100ms delay between terminations
            } elseif (in_array($pid, $loadingPids)) {
                Log::trace('Preserving loading window process: ' . $pid);
            }
        }
 
        // Initiate self-termination with timeout
        if ($splash !== null) {
            $splash->setTextLoading('Final cleanup...');
        }
 
        try {
            Log::trace('Initiating self-termination for PID: ' . $currentPid);
            // Add a timeout wrapper around the killProc call
            $killSuccess = Win32Native::killProcess($currentPid);
            if (!$killSuccess) {
                Log::trace('Self-termination via Win32Native::killProcess failed, using alternative method');
            }
        } catch (\Exception $e) {
            Log::trace('Exception during self-termination: ' . $e->getMessage());
        }
 
        // Destroy window after process termination
        // Fix for PHP 8.2: Check if window is not null before destroying
        if ($window && $bearsamppWinbinder) {
            try {
                Log::trace('Destroying window');
                $bearsamppWinbinder->destroyWindow($window);
            } catch (\Exception $e) {
                Log::trace('Exception during window destruction: ' . $e->getMessage());
            }
        }
 
        // Force exit if still running after timeout
        if (microtime(true) - $startTime > $timeout * 1.5) {
            Log::trace('Forcing exit due to timeout');
            exit(0);
        }
    }

    private function verifyServicesStoppedAndCleanup($services)
    {
        Log::info('Verifying all services are stopped...');
 
        $results = [
            'all_stopped'         => true,
            'services'            => [],
            'still_running'       => [],
            'verification_failed' => []
        ];
 
        foreach ($services as $sName => $service) {
            $displayName = $this->getServiceDisplayName($sName, $service);
 
            try {
                // Check if service is still installed/running
                $isInstalled = $service->isInstalled();
                $isRunning   = $isInstalled ? $service->isRunning() : false;
 
                $results['services'][$sName] = [
                    'name'      => $displayName,
                    'installed' => $isInstalled,
                    'running'   => $isRunning
                ];
 
                if ($isRunning) {
                    Log::warning('Service still running after shutdown: ' . $displayName);
                    $results['still_running'][] = $displayName;
                    $results['all_stopped']     = false;
 
                    // Attempt to force stop
                    Log::info('Attempting to force stop: ' . $displayName);
                    $service->stop();
                    usleep(500000); // Wait 500ms
 
                    // Verify again
                    if ($service->isRunning()) {
                        Log::error('Failed to force stop service: ' . $displayName);
                    } else {
                        Log::info('Successfully force stopped service: ' . $displayName);
                    }
                } elseif ($isInstalled) {
                    Log::debug('Service stopped but still installed: ' . $displayName);
                } else {
                    Log::debug('Service verified stopped and removed: ' . $displayName);
                }
            } catch (\Exception $e) {
                Log::error('Failed to verify service status for ' . $displayName . ': ' . $e->getMessage());
                $results['verification_failed'][] = $displayName;
                $results['all_stopped']           = false;
            }
        }
 
        if ($results['all_stopped']) {
            Log::info('All services verified stopped successfully');
        } else {
            Log::warning('Some services could not be verified as stopped');
        }
 
        return $results;
    }

    private function verifySymlinksRemoved()
    {
        global $bearsamppRoot;
 
        Log::info('Verifying symlinks are removed...');
 
        $results = [
            'success'   => true,
            'remaining' => []
        ];
 
        // Check common symlink locations
        $symlinkPaths = [
            Path::getRootPath() . '/apache',
            Path::getRootPath() . '/php',
            Path::getRootPath() . '/mysql',
            Path::getRootPath() . '/mariadb',
            Path::getRootPath() . '/postgresql',
            Path::getRootPath() . '/nodejs',
            Path::getRootPath() . '/memcached',
            Path::getRootPath() . '/mailpit',
            Path::getRootPath() . '/xlight'
        ];
 
        foreach ($symlinkPaths as $path) {
            if (file_exists($path) || is_link($path)) {
                Log::warning('Symlink still exists: ' . $path);
                $results['remaining'][] = basename($path);
                $results['success']     = false;
 
                // Attempt to remove it using robust method
                try {
                    $removed = \Symlinks::safeRemoveSymlink($path);
 
                    // Verify removal
                    if ($removed && !file_exists($path) && !is_link($path)) {
                        Log::info('Successfully removed remaining symlink: ' . $path);
                        $results['remaining'] = array_diff($results['remaining'], [basename($path)]);
                        if (empty($results['remaining'])) {
                            $results['success'] = true;
                        }
                    }
                } catch (\Exception $e) {
                    Log::error('Failed to remove symlink ' . $path . ': ' . $e->getMessage());
                }
            }
        }
 
        if ($results['success']) {
            Log::info('All symlinks verified removed');
        } else {
            Log::warning('Some symlinks could not be removed: ' . implode(', ', $results['remaining']));
        }
 
        return $results;
    }

    private function cleanupTemporaryFiles()
    {
        global $bearsamppCore;
 
        Log::info('Cleaning up temporary files...');
 
        $results = [
            'success'    => true,
            'cleaned'    => 0,
            'failed'     => [],
            'size_freed' => 0
        ];
 
        $tmpPath = Path::getTmpPath();
 
        if (!is_dir($tmpPath)) {
            Log::debug('Temp directory does not exist: ' . $tmpPath);
 
            return $results;
        }
 
        try {
            $files = glob($tmpPath . '/*');
 
            if ($files === false) {
                Log::warning('Failed to list temporary files');
 
                return $results;
            }
 
            foreach ($files as $file) {
                // Skip certain files that should be preserved
                $basename = basename($file);
                if (in_array($basename, ['.', '..', '.gitkeep', 'README.md'])) {
                    continue;
                }
 
                try {
                    $size = is_file($file) ? filesize($file) : 0;
 
                    if (is_link($file)) {
                        if (@unlink($file) || @rmdir($file)) {
                            $results['cleaned']++;
                            $results['size_freed'] += $size;
                            Log::debug('Removed temp symlink: ' . $basename);
                        } else {
                            $results['failed'][] = $basename;
                            $results['success']  = false;
                            Log::warning('Failed to remove temp symlink: ' . $basename);
                        }
                    } elseif (is_file($file)) {
                        if (@unlink($file)) {
                            $results['cleaned']++;
                            $results['size_freed'] += $size;
                            Log::debug('Removed temp file: ' . $basename);
                        } else {
                            $results['failed'][] = $basename;
                            $results['success']  = false;
                            Log::warning('Failed to remove temp file: ' . $basename);
                        }
                    } elseif (is_dir($file)) {
                        Util::deleteFolder($file);
                        if (!file_exists($file)) {
                            $results['cleaned']++;
                            Log::debug('Removed temp directory: ' . $basename);
                        } else {
                            $results['failed'][] = $basename;
                            $results['success']  = false;
                            Log::warning('Failed to remove temp directory: ' . $basename);
                        }
                    }
                } catch (\Exception $e) {
                    $results['failed'][] = $basename;
                    $results['success']  = false;
                    Log::error('Error removing temp file ' . $basename . ': ' . $e->getMessage());
                }
            }
 
            $sizeMB = round($results['size_freed'] / 1024 / 1024, 2);
            Log::info('Cleaned up ' . $results['cleaned'] . ' temporary files (' . $sizeMB . ' MB freed)');
 
            if (!empty($results['failed'])) {
                Log::warning('Failed to clean up ' . count($results['failed']) . ' files');
            }
        } catch (\Exception $e) {
            Log::error('Error during temp file cleanup: ' . $e->getMessage());
            $results['success'] = false;
        }
 
        return $results;
    }

    private function checkForOrphanedProcesses()
    {
        global $bearsamppRoot;
 
        Log::info('Checking for orphaned processes...');
 
        $orphaned = [
            'found'     => false,
            'processes' => []
        ];
 
        try {
            $procs         = Win32Ps::getListProcs();
            $bearsamppPath = strtolower(Path::formatUnixPath(Path::getRootPath()));
            $currentPid    = Win32Ps::getCurrentPid();
 
            foreach ($procs as $proc) {
                $exePath = strtolower(Path::formatUnixPath($proc[Win32Ps::EXECUTABLE_PATH]));
                $pid     = $proc[Win32Ps::PROCESS_ID];
 
                // Skip current process
                if ($pid == $currentPid) {
                    continue;
                }
 
                // Check if process is from Bearsampp directory
                if (strpos($exePath, $bearsamppPath) === 0) {
                    $processName = basename($exePath);
 
                    // Skip www directory processes (user applications)
                    if (strpos($exePath, $bearsamppPath . '/www/') === 0) {
                        continue;
                    }
 
                    // Skip the main Bearsampp executable
                    if (strtolower($processName) === 'bearsampp.exe') {
                        Log::debug('Skipping main Bearsampp process: ' . $processName . ' (PID: ' . $pid . ')');
                        continue;
                    }
 
                    // These are orphaned Bearsampp processes
                    $orphaned['found']       = true;
                    $orphaned['processes'][] = [
                        'pid'  => $pid,
                        'name' => $processName,
                        'path' => $exePath
                    ];
 
                    Log::warning('Found orphaned process: ' . $processName . ' (PID: ' . $pid . ')');
 
                    // Attempt to kill orphaned process
                    try {
                        Win32Ps::kill($pid);
                        Log::info('Terminated orphaned process: ' . $processName . ' (PID: ' . $pid . ')');
                    } catch (\Exception $e) {
                        Log::error('Failed to terminate orphaned process ' . $processName . ': ' . $e->getMessage());
                    }
                }
            }
 
            if (!$orphaned['found']) {
                Log::info('No orphaned processes found');
            } else {
                Log::warning('Found ' . count($orphaned['processes']) . ' orphaned process(es)');
            }
        } catch (\Exception $e) {
            Log::error('Error checking for orphaned processes: ' . $e->getMessage());
        }
 
        return $orphaned;
    }

    private function generateCleanupReport($serviceVerification, $symlinkVerification, $tempCleanup, $orphanedProcesses)
    {
        $report = [
            'success'  => true,
            'warnings' => [],
            'errors'   => [],
            'summary'  => []
        ];
 
        // Service verification
        if (!$serviceVerification['all_stopped']) {
            $report['success'] = false;
 
            if (!empty($serviceVerification['still_running'])) {
                $report['errors'][] = 'Services still running: ' . implode(', ', $serviceVerification['still_running']);
            }
 
            if (!empty($serviceVerification['verification_failed'])) {
                $report['warnings'][] = 'Could not verify status of: ' . implode(', ', $serviceVerification['verification_failed']);
            }
        }
 
        $report['summary'][] = 'Services checked: ' . count($serviceVerification['services']);
 
        // Symlink verification
        if (!$symlinkVerification['success']) {
            $report['warnings'][] = 'Symlinks not fully removed: ' . implode(', ', $symlinkVerification['remaining']);
        }
 
        // Temp file cleanup
        if ($tempCleanup['cleaned'] > 0) {
            $sizeMB              = round($tempCleanup['size_freed'] / 1024 / 1024, 2);
            $report['summary'][] = 'Temp files cleaned: ' . $tempCleanup['cleaned'] . ' (' . $sizeMB . ' MB)';
        }
 
        if (!empty($tempCleanup['failed'])) {
            $report['warnings'][] = 'Failed to clean ' . count($tempCleanup['failed']) . ' temp file(s)';
        }
 
        // Orphaned processes
        if ($orphanedProcesses['found']) {
            $report['warnings'][] = 'Found ' . count($orphanedProcesses['processes']) . ' orphaned process(es)';
            foreach ($orphanedProcesses['processes'] as $proc) {
                $report['summary'][] = 'Orphaned: ' . $proc['name'] . ' (PID: ' . $proc['pid'] . ')';
            }
        }
 
        return $report;
    }

    private function performQuickCleanupVerification($services)
    {
        Log::info('Performing quick cleanup verification...');
 
        $startTime = microtime(true);
        $maxTime   = 2; // Maximum 2 seconds for verification
 
        try {
            // Quick temp file cleanup (non-blocking)
            $tempCleanup = $this->cleanupTemporaryFiles();
 
            // Check if we're running out of time
            if (microtime(true) - $startTime > $maxTime) {
                Log::debug('Cleanup verification timeout reached, skipping remaining checks');
 
                return;
            }
 
            // Quick orphaned process check (non-blocking)
            $orphanedProcesses = $this->checkForOrphanedProcesses();
 
            // Log summary
            if ($tempCleanup['cleaned'] > 0) {
                $sizeMB = round($tempCleanup['size_freed'] / 1024 / 1024, 2);
                Log::info('Quick cleanup: ' . $tempCleanup['cleaned'] . ' temp files removed (' . $sizeMB . ' MB freed)');
            }
 
            if ($orphanedProcesses['found']) {
                Log::info('Quick cleanup: ' . count($orphanedProcesses['processes']) . ' orphaned process(es) terminated');
            }
 
            $duration = round(microtime(true) - $startTime, 2);
            Log::info('Quick cleanup verification completed in ' . $duration . ' seconds');
        } catch (\Exception $e) {
            Log::warning('Quick cleanup verification failed: ' . $e->getMessage());
        }
    }
}