SteamServer::uninstallPlugin() - Code Metrics - dedicated-panel/dedipanel - Measure and Improve Code Quality continuously with Scrutinizer

SteamServer::uninstallPlugin() A
last analyzed 2016-08-19 23:54 UTC

↳ Parent: SteamServer
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	2
<?php

/**
 * This file is part of Dedipanel project
 *
 * (c) 2010-2015 Dedipanel <http://www.dedicated-panel.net>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace DP\GameServer\SteamServerBundle\Entity;

use Dedipanel\PHPSeclibWrapperBundle\Connection\Exception\ScreenNotExistException;
use Doctrine\ORM\Mapping as ORM;
use DP\GameServer\GameServerBundle\Entity\GameServer;
use DP\Core\GameBundle\Entity\Plugin;
use DP\Core\CoreBundle\Exception\InstallAlreadyStartedException;
use DP\Core\CoreBundle\Exception\MissingPacketException;
use Dedipanel\PHPSeclibWrapperBundle\Crontab\Crontab;
use Dedipanel\PHPSeclibWrapperBundle\Crontab\CrontabItem;

/**
 * DP\GameServer\SteamServerBundle\Entity\SteamServer
 *
 * @ORM\Table(name="steam_server")
 * @ORM\Entity(repositoryClass="DP\GameServer\GameServerBundle\Entity\GameServerRepository")
 * 
 * @todo: refacto phpseclib
 * @todo: refacto domain logic
 */
class SteamServer extends GameServer
{
    /**
     * @var \DateTime $rebootAt
     *
     * @ORM\Column(name="rebootAt", type="time", nullable=true)
     */
    private $rebootAt;

    /**
     * @var boolean $munin
     *
     * @ORM\Column(name="munin", type="boolean", nullable=true)
     */
    private $munin;

    /**
     * @var string $svPassword
     *
     * @ORM\Column(name="sv_passwd", type="string", length=16, nullable=true)
     */
    private $svPassword;
    
    /**
     * @var string $mode
     * 
     * @ORM\Column(name="mode", type="string", nullable=true)
     */
    private $mode;
    
    
    /**
     * Set rebootAt
     *
     * @param \DateTime $rebootAt
     * 
     * @return SteamServer
     */
    public function setRebootAt($rebootAt)
    {
        $this->rebootAt = $rebootAt;
        
        return $this;
    }

    /**
     * Get rebootAt
     *
     * @return \DateTime
     */
    public function getRebootAt()
    {
        return $this->rebootAt;
    }

    /**
     * Set munin
     *
     * @param boolean $munin
     * 
     * @return SteamServer
     */
    public function setMunin($munin)
    {
        $this->munin = $munin;
        
        return $this;
    }

    /**
     * Get munin
     *
     * @return boolean
     */
    public function getMunin()
    {
        return $this->munin;
    }

    /**
     * Set svPassword
     *
     * @param string $svPassword
     * 
     * @return SteamServer
     */
    public function setSvPassword($svPassword)
    {
        $this->svPassword = $svPassword;
        
        return $this;
    }

    /**
     * Get svPassword
     *
     * @return string
     */
    public function getSvPassword()
    {
        return $this->svPassword;
    }
    
    /**
     * Set game server mode 
     * 
     * @param string $mode
     * 
     * @return SteamServer
     */
    public function setMode($mode)
    {
        $this->mode = $mode;
        
        return $this;
    }
    
    /**
     * Get game server mode
     * 
     * @return string
     */
    public function getMode()
    {
        return $this->mode;
    }
    
    public static function getModeList()
    {
        return array(
            '0;0' => 'Classic Casual', 
            '0;1' => 'Classic Competitive', 
            '1;0' => 'Arms Race', 
            '1;1' => 'Demolition', 
            '1;2' => 'Deathmatch', 
        );
    }

    /**
     * Upload & launch game server installation
     *
     * @param \Twig_Environment $twig Used for generate shell script
     */
    public function installServer(\Twig_Environment $twig)
    {
        $conn = $this->getMachine()->getConnection();

        // S'il s'agit d'un serveur 64 bits on commence par vérifier si le paquet ia32-libs est présent
        // (nécessaire pour l'utilisation de l'installateur steam)
        if ($this->machine->is64Bit() === true && $conn->hasCompatLib() == false) {

            throw new MissingPacketException(array('ia32-libs/', 'libc6:i386'));
        }

        $installDir = $this->getAbsoluteDir();
        $scriptPath = $installDir . 'install.sh';
        $screenName = $this->getInstallScreenName();
        $steamCmd = $this->getGame()->getSteamCmd();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $bin = $this->getGame()->getBin();
        $appId = $this->game->getappId();
        $appMod =  $this->game->getappMod();
        $conn->mkdir($installDir);

        $installScript = $twig->render(
            'DPSteamServerBundle:sh:install.sh.twig',
            array('installDir'  => $installDir)
        );

        $conn->upload($scriptPath, $installScript);
        
        $pgrep = '`ps aux | grep SCREEN | grep "' . $screenName . ' " | grep -v grep | wc -l`';
        $screenCmd  = 'if [ ' . $pgrep . ' = "0" ]; then ';
        $screenCmd .= 'screen -dmS "' . $screenName . '" ' . $scriptPath . ' "' . $appId . '" "' . $appMod . '"  "' . $bin . '"; ';
        $screenCmd .= 'else echo "Installation is already in progress."; fi; ';
        $result = $conn->exec($screenCmd);

        if ($result == 'Installation is already in progress.') {
            throw new InstallAlreadyStartedException();
        }

        $this->installationStatus = 0;

        return true;
    }

    public function removeInstallationFiles()
    {
        $installDir = $this->getAbsoluteDir();
        $scriptPath = $installDir . 'install.sh';
        $logPath = $installDir . 'install.log';

        return $this->getMachine()->getConnection()->exec('rm -f ' . $scriptPath . ' ' . $logPath);
    }

    public function getInstallationProgress()
    {
        $absDir = $this->getAbsoluteDir();
        $logPath = $absDir . 'install.log';
        $logCmd = 'if [ -f ' . $logPath . ' ]; then cat ' . $logPath . '; else echo "File not found exception."; fi; ';

        $conn = $this->getMachine()->getConnection();
        $installLog = $conn->exec($logCmd);

        if (strpos($installLog, 'Install ended') !== false) {
            // Si l'installation est terminé, on supprime le fichier de log et le script
            $conn->exec('rm -f ' . $absDir . 'install.log ' . $absDir . 'install.sh');
           // 100 = serveur installé
           // 101 = serveur installé + config uploadé
           return 100;
        }
        elseif (strpos($installLog, 'Install failed') !== false) {
            return null;
        }
        elseif (strpos($installLog, 'Game install') !== false) {
            $screenContent = false;

            try {
                $screenContent = $conn->getScreenContent($this->getInstallScreenName());
            }
            catch (ScreenNotExistException $e) {}

            if ($screenContent == false || $screenContent == 'No screen session found.') return null;

            else {
                // Si on a réussi à récupérer le contenu du screen,
                // On recherche dans chaque ligne en commencant par la fin
                // Un signe "%" afin de connaître le % le plus à jour
                $lines = array_reverse(explode("\n", $screenContent));

                foreach ($lines AS $line) {
                    $line = trim($line);
                    // On passe à la ligne suivante si l'actuelle est vide
                    if (empty($line)) continue;

                    $matches = array();

                    if (preg_match('#^(App|Update) state \(0x\d+\) (downloading|installed), progress: ([\d]+.[\d]+)#', $line ,$matches)) {
                        return ($matches[1] == 'downloading') ? ($matches[2] / 2) : (50 + $matches[2] / 2);
                    }
                }

                // Si arrivé à ce stade aucun pourcentage n'a été détecté
                // C'est surement que l'installation est en train de vérifier les fichiers locaux
                return 3;
            }
        }
        elseif (strpos($installLog, 'Steam updating') !== false) {
            return 2;
        }
        elseif (strpos($installLog, 'DL hldsupdatetool.bin') !== false || strpos($installLog, 'Download steamcmd') !== false) {
            return 1;
        }
        elseif ($installLog == 'File not found exception.') {
            return null;
        }
        else {
            throw new \ErrorException('Impossible de définir le statut de l\'installation du serveur.');
        }
    }

    public function uploadShellScripts(\Twig_Environment $twig)
    {
        // Upload du script de gestion du serveur de jeu
        $uploadHlds = $this->uploadHldsScript($twig);

        // Création d'un ficier server.cfg vide (si celui-ci n'existe pas)
        $this->createDefaultServerCfgFile();
        
        if ($this->getGame()->getLaunchName() == 'csgo') {
            $this->modifyGameModesCfg();
        }

        $this->installationStatus = 101;

        return $uploadHlds;
    }

    public function uploadHldsScript(\Twig_Environment $twig)
    {
        $conn = $this->getMachine()->getConnection();
        $game = $this->getGame();
        $hostName = $this->getName();
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        $scriptPath = $this->getAbsoluteHldsScriptPath();
        $isCsgo = $this->getGame()->getLaunchName() == 'csgo';
        $isJustCause = $this->getGame()->getLaunchName() == 'justcause';
        $isNs2 = $this->getGame()->getLaunchName() == 'ns2';
        $isKF = $this->getGame()->getLaunchName() == 'KFmod.KFGameType';
        $gameType = '';
        $gameMode = '';
        $mapGroup = '';
        
        if ($isCsgo) {
            $mode = $this->getMode();
            $mode = !(empty($mode)) ? $mode : '0;0';
            
            list($gameType, $gameMode) = explode(';', $mode);
            
            if ($gameType == 0 && $gameMode == 0) {
                $mapGroup = 'mg_bomb';
            }
            elseif ($gameType == 0 && $gameMode == 1) {
                $mapGroup = 'mg_bomb_se';
            }
            elseif ($gameType == 1 && $gameMode == 0) {
                $mapGroup = 'mg_armsrace';
            }
            elseif ($gameType == 1 && $gameMode == 1) {
                $mapGroup = 'mp_demolition';
            }
            elseif ($gameType == 1 && $gameMode == 2) {
                $mapGroup = 'mg_allclassic';
            }
        }

        $hldsScript = $twig->render('DPSteamServerBundle:sh:hlds.sh.twig', array(
            'screenName'        => $this->getScreenName(),
            'bin'               => $game->getBin(),
            'name'              => $this->getName(),
            'launchName'        => $game->getLaunchName(),
            'ip'                => $this->getMachine()->getPublicIp(),
            'port'              => $this->getPort(),
            'maxplayers'        => $this->getMaxplayers(),
            'startMap'          => $game->getMap(),
            'binDir'            => $this->getAbsoluteBinDir(),
            'core'              => implode(',', $this->getCore()),
            'isCsgo'            => $isCsgo,
            'isJustCause'       => $isJustCause,
            'isNs2'             => $isNs2,
            'isKF'              => $isKF,
            'gameType'          => $gameType,
            'gameMode'          => $gameMode,
            'mapGroup'          => $mapGroup,
        ));

        return $conn->upload($scriptPath, $hldsScript, 0750);
    }

    public function createDefaultServerCfgFile()
    {
        $conn = $this->getMachine()->getConnection();
        $cfgPath = $this->getServerCfgPath();

        if ($this->getGame()->getLaunchName() == 'csgo') {
            $file = $this->getAbsoluteGameContentDir() . 'gamemodes_server.txt';
            
            return $conn->exec('if [ ! -e ' . $file . ' ] && [ -e ' . $file . '.example ]; then mv ' . $file . '.example ' . $file . '; fi');
        }
        else {
            // On créer un fichier server.cfg si aucun n'existe
            return $conn->exec('if [ ! -e ' . $cfgPath . ' ]; then touch ' . $cfgPath . '; fi');
        }
    }

    public function uploadDefaultServerConfigurationFile()
    {
        $template = $this->getGame()->getConfigTemplate();

        if (!empty($template)) {
            $conn = $this->getMachine()->getConnection();
            $cfgPath = $this->getServerCfgPath();

            $env = new \Twig_Environment(new \Twig_Loader_String());

            $cfgFile = $env->render($template, array(
                'hostname' => $this->getFullName(),
                'rconPassword' => $this->getRconPassword(), 
                'svPassword' => $this->getSvPassword(), 
            ));

            return $conn->upload($cfgPath, $cfgFile, 0750);
        }

        return false;
    }

    public function modifyServerCfgFile()
    {
        $conn = $this->getMachine()->getConnection();
        $cfgPath = $this->getServerCfgPath();

        $remoteFile = $conn->download($cfgPath);
        $fileLines = explode("\n", $remoteFile);
        
        $patterns = array(
            '#^hostname#' => 'hostname "' . $this->getFullName() . '"',
            '#^rcon_password#' => 'rcon_password "' . $this->getRconPassword() . '"', 
            '#^sv_password#' => 'sv_password "' . $this->getSvPassword() . '"', 
        );
        $matched = array();

        foreach ($fileLines AS &$line) {
            if ($line == '' || substr($line, 0, 2) == '//') continue;

            // Vérifie tous les patterns fournis
            foreach ($patterns AS $pattern => $replacement) {
                // Si le pattern est trouvé, le replacement est effectué
                // Et la ligne est ajouté à l'array des lignes détectés
                if (preg_match($pattern, $line)) {
                    $line = $replacement;
                    
                    $matched[$pattern] = $replacement;
                }
            }
        }
        // Suppression de la référence
        unset($line);
        
        // Ajoute les lignes non matchées
        $delta = array_diff($patterns, $matched);
        foreach ($delta AS $toAdd) {
            $fileLines[] = $toAdd;
        }

        // Upload du nouveau fichier
        return $conn->upload($cfgPath, implode("\n", $fileLines));
    }

    /**
     * @var string $state
     */
    public function changeState($state)
    {
        return $this
                ->getMachine()
                ->getConnection()
                ->exec($this->getAbsoluteHldsScriptPath() . ' ' . $state)
        ;
    }
    
    public function installPlugin(\Twig_Environment $twig, Plugin $plugin)
    {
        return $this->execPluginScript($twig, $plugin, 'install');
    }
    
    public function uninstallPlugin(\Twig_Environment $twig, Plugin $plugin)
    {
        return $this->execPluginScript($twig, $plugin, 'uninstall');
    }

    /**
     * @param string $action
     */
    public function execPluginScript(\Twig_Environment $twig, Plugin $plugin, $action)
    {
        if ($action != 'install' && $action != 'uninstall' && $action != 'activate' && $action != 'deactivate') {
            throw new \BadMethodCallException('Only actions available for SteamServers plugin scripts are : install, uninstall, activate and deactivate.');
        }

        $conn = $this->getMachine()->getConnection();

        // En cas d'installation, vérification des dépendances du plugin
        if ($action == 'install') {
            $packetDependencies = $plugin->getPacketDependencies();

            if (!empty($packetDependencies)) {
                $missingPackets = array();

                foreach ($packetDependencies AS $dep) {
                    if (!$conn->isInstalled($dep)) {
                        $missingPackets[] = $dep;
                    }
                }

                if (!empty($missingPackets)) {
                    throw new MissingPacketException($missingPackets);
                }
            }
        }

        $dir = $this->getAbsoluteGameContentDir();
        $scriptName = $plugin->getScriptName();
        $scriptPath = $dir . $scriptName . '.sh';

        $pluginScript = $twig->render(
            'DPSteamServerBundle:sh:Plugin/' . $scriptName . '.sh.twig', array('gameDir' => $dir));
        $conn->upload($scriptPath, $pluginScript);

        $screenName = $this->getPluginInstallScreenName($scriptName);
        $screenCmd  = 'screen -dmS ' . $screenName . ' ' . $scriptPath . ' ' . $action;

        if ($action == 'install') {
            $screenCmd .= ' "' . $plugin->getDownloadUrl() . '"';
        }

        $conn->exec($screenCmd);
    }

    public function getAbsoluteGameContentDir()
    {
        return $this->getAbsoluteBinDir() . $this->game->getLaunchName() . '/';
    }

    public function getAbsoluteHldsScriptPath()
    {
        return $this->getAbsoluteDir() . 'hlds.sh';
    }

    public function getRebootCommand()
    {
        return $this->getAbsoluteHldsScriptPath() . ' restart >> ' .
            $this->getAbsoluteDir() . 'cron-dp.log';
    }

    public function addAutoReboot()

    {
        $rebootTime = $this->getRebootAt();
        $script = $this->getRebootCommand();
        $item =  new CrontabItem($script, $rebootTime->format('i'), $rebootTime->format('H'));
        $crontab =  new Crontab($this->getMachine()->getConnection());
        $crontab->addItem($item);

        return $crontab->update();

    }

    public function removeAutoReboot($rebootTime)

    {

        $script = $this->getRebootCommand();
        $item =  new CrontabItem($script, $rebootTime->format('i'), $rebootTime->format('H'));
        $crontab =  new Crontab($this->getMachine()->getConnection());
        $crontab->removeItem($item);

        return $crontab->update();
    }

    public function getServerCfgPath()
    {
        return $this->getAbsoluteBinDir() . $this->getGame()->getCfgPath();
    }

    public function removeFromServer()

    {
        $screenName = $this->getScreenName();
        $scriptPath = $this->getAbsoluteHldsScriptPath();
        $serverPath = $this->getAbsoluteDir();

        $conn = $this->getMachine()->getConnection();

        // On commence par vérifier que le serveur n'est pas lancé (sinon on l'arrête)
        $pgrep   = '`ps aux | grep SCREEN | grep "' . $screenName . ' " | grep -v grep | wc -l`';
        $stopCmd = 'if [ ' . $pgrep . ' != "0" ]; then ' . $scriptPath . ' stop; fi; ';
        $conn->exec($stopCmd);

        // Puis on supprime complètement le dossier du serveur
        $delCmd  = 'rm -Rf ' . $serverPath;

        return $conn->exec($delCmd);
    }
    
    public function modifyGameModesCfg()
    {
        $conn = $this->getMachine()->getConnection();
        $file = $this->getAbsoluteGameContentDir() . 'gamemodes_server.txt';
        
        $content = $conn->download($file);
        $fileLines = explode("\r\n", $content);
        
        foreach ($fileLines AS &$line) {
            // On ignore la ligne vide et les commentaires
            if (empty($line) || substr($line, 0, 2) == '//') continue;
            
            if (preg_match('#"maxplayers"[ \t]+"[\d]+"#', $line)) {
                $line = preg_replace('#^([ \t]+)"maxplayers"([ \t]+)"[\d]+"(.*)$#', '$1"maxplayers"$2"' . $this->maxplayers . '"$3', $line);
            }
        }
        
        // Upload du nouveau fichier
        return $conn->upload($file, implode("\r\n", $fileLines));
    }
    
    public function regenerateScripts(\Twig_Environment $twig)
    {
        $this->uploadHldsScript($twig);
        
        if ($this->getGame()->getLaunchName() == 'csgo') {
            $this->modifyGameModesCfg();
        }
    }
}

dedicated-panel / dedipanel

SteamServer::uninstallPlugin() A last analyzed 2016-08-19 23:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SteamServer::uninstallPlugin() A
last analyzed 2016-08-19 23:54 UTC
