class.serviceHelper.php

Go to the documentation of this file.

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

class ServiceHelper
{
    private static $serviceMap = null;

    private static $syntaxCheckMap = null;

    private static function initializeMappings($bearsamppBins)
    {
        if (self::$serviceMap === null) {
            self::$serviceMap = [
                BinApache::SERVICE_NAME => $bearsamppBins->getApache(),
                BinMysql::SERVICE_NAME => $bearsamppBins->getMysql(),
                BinMariadb::SERVICE_NAME => $bearsamppBins->getMariadb(),
                BinMailpit::SERVICE_NAME => $bearsamppBins->getMailpit(),
                BinMemcached::SERVICE_NAME => $bearsamppBins->getMemcached(),
                BinPostgresql::SERVICE_NAME => $bearsamppBins->getPostgresql(),
                BinXlight::SERVICE_NAME => $bearsamppBins->getXlight(),
            ];
        }
 
        if (self::$syntaxCheckMap === null) {
            self::$syntaxCheckMap = [
                BinApache::SERVICE_NAME => BinApache::CMD_SYNTAX_CHECK,
                BinMysql::SERVICE_NAME => BinMysql::CMD_SYNTAX_CHECK,
                BinMariadb::SERVICE_NAME => BinMariadb::CMD_SYNTAX_CHECK,
            ];
        }
    }

    public static function getBinFromServiceName($serviceName, $bearsamppBins)
    {
        self::initializeMappings($bearsamppBins);
        return isset(self::$serviceMap[$serviceName]) ? self::$serviceMap[$serviceName] : null;
    }

    public static function getSyntaxCheckCmd($serviceName, $bearsamppBins = null)
    {
        if ($bearsamppBins !== null) {
            self::initializeMappings($bearsamppBins);
        }
        return isset(self::$syntaxCheckMap[$serviceName]) ? self::$syntaxCheckMap[$serviceName] : null;
    }

    public static function getServiceDisplayName($bin, $service)
    {
        return $bin->getName() . ' ' . $bin->getVersion() . ' (' . $service->getName() . ')';
    }

    public static function processServices($bearsamppBins, callable $callback)
    {
        self::initializeMappings($bearsamppBins);
 
        foreach ($bearsamppBins->getServices() as $serviceName => $service) {
            $bin = self::getBinFromServiceName($serviceName, $bearsamppBins);
            $syntaxCheckCmd = self::getSyntaxCheckCmd($serviceName);
 
            if ($bin !== null) {
                $callback($serviceName, $service, $bin, $syntaxCheckCmd);
            }
        }
    }

    public static function startService($bin, $syntaxCheckCmd = null, $showErrors = true)
    {
        return Util::startService($bin, $syntaxCheckCmd, $showErrors);
    }

    public static function stopService($service)
    {
        return $service->stop();
    }

    public static function restartService($service)
    {
        return $service->restart();
    }

    public static function getAllServiceNames()
    {
        return [
            BinApache::SERVICE_NAME,
            BinMysql::SERVICE_NAME,
            BinMariadb::SERVICE_NAME,
            BinMailpit::SERVICE_NAME,
            BinMemcached::SERVICE_NAME,
            BinPostgresql::SERVICE_NAME,
            BinXlight::SERVICE_NAME,
        ];
    }

    public static function hasSyntaxCheck($serviceName)
    {
        if (self::$syntaxCheckMap === null) {
            // Initialize with dummy bins object if needed
            self::$syntaxCheckMap = [
                BinApache::SERVICE_NAME => BinApache::CMD_SYNTAX_CHECK,
                BinMysql::SERVICE_NAME => BinMysql::CMD_SYNTAX_CHECK,
                BinMariadb::SERVICE_NAME => BinMariadb::CMD_SYNTAX_CHECK,
            ];
        }
        return isset(self::$syntaxCheckMap[$serviceName]);
    }

    public static function getServicePort($serviceName, $bearsamppBins)
    {
        $bin = self::getBinFromServiceName($serviceName, $bearsamppBins);
        if ($bin === null) {
            return 0;
        }
 
        // Different services have different methods to get port
        if (method_exists($bin, 'getPort')) {
            return $bin->getPort();
        } elseif (method_exists($bin, 'getSmtpPort')) {
            return $bin->getSmtpPort();
        }
 
        return 0;
    }
}