AnimeDb\Bundle\AppBundle\Service\CommandExecutor

Complexity

Total Complexity

19

Size/Duplication

Total Lines	198
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	2

Test Coverage

Coverage

36.51%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	2
A	execute()	0	8	3
A	console()	0	4	1
A	executeCommand()	0	8	2
A	executeCommandInBackground()	0	14	3
A	send()	0	18	3
A	prepare()	0	17	3
A	exec()	0	7	2

<?php
/**
 * AnimeDb package
 *
 * @package   AnimeDb
 * @author    Peter Gribanov <info@peter-gribanov.ru>
 * @copyright Copyright (c) 2011, Peter Gribanov
 * @license   http://opensource.org/licenses/GPL-3.0 GPL v3
 */

namespace AnimeDb\Bundle\AppBundle\Service;

use AnimeDb\Bundle\AppBundle\Service\PhpFinder;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\Process\Process;

/**
 * Command executor
 *
 * Example:
 * <code>
 *   php app/console cache:clear > /dev/null 2>&1
 *   php composer.phar update
 *   ping > ping.log
 * <code>
 *
 * @package AnimeDb\Bundle\AppBundle\Service
 * @author  Peter Gribanov <info@peter-gribanov.ru>
 */
class CommandExecutor
{
    /**
     * Host
     *
     * @var string
     */
    protected $host;

    /**
     * Path
     *
     * @var string
     */
    protected $path;

    /**
     * Working directory
     *
     * @var string
     */
    protected $cwd;

    /**
     * Console
     *
     * @var string
     */
    protected $console;

    /**
     * Php finder
     *
     * @var \AnimeDb\Bundle\AppBundle\Service\PhpFinder
     */
    protected $finder;

    /**
     * Connect timeout
     *
     * @var integer
     */
    const TIMEOUT = 2;

    /**
     * Construct
     *
     * @param \AnimeDb\Bundle\AppBundle\Service\PhpFinder $finder
     * @param \Symfony\Component\Routing\RouterInterface $router
     * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
     * @param string $root_dir
     */
    public function __construct(PhpFinder $finder, RouterInterface $router, RequestStack $request_stack, $root_dir)
    {
        $this->finder = $finder;
        $this->cwd = $root_dir.'/../';
        $this->console = escapeshellarg($root_dir.DIRECTORY_SEPARATOR.'console');
        $this->path = $router->generate('command_exec');
        if ($request = $request_stack->getCurrentRequest()) {
            $this->host = $request->getHost().':'.$request->getPort();
        }
    }

    /**
     * Execute command
     * 
     * @deprecated see self::send()
     *
     * @throws \InvalidArgumentException
     *
     * @param string $command
     */
    public function exec($command)
    {
        if (!$command) {
            throw new \InvalidArgumentException('Unknown command');
        }
        $this->send('php app/console '.$command);
    }

    /**
     * Execute command
     *
     * If timeout <= 0 and callback is null then command will be executed in background
     *
     * @param string $command
     * @param integer $timeout
     * @param callable|null $callback
     */
    public function execute($command, $timeout = 300, $callback = null)
    {
        if ($timeout > 0 || is_callable($callback)) {
            $this->executeCommand($command, $timeout, $callback);
        } else {
            $this->executeCommandInBackground($command);
        }
    }

    /**
     * Execute console command
     *
     * @param string $command
     * @param integer $timeout
     * @param callable|null $callback
     */
    public function console($command, $timeout = 300, $callback = null)
    {
        $this->execute('php app/console '.$command, $timeout, $callback);
    }

    /**
     * Execute command
     *
     * @throws \RuntimeException
     *
     * @param string $command
     * @param integer $timeout
     * @param callable|null $callback
     */
    protected function executeCommand($command, $timeout = 300, $callback = null)
    {
        $process = new Process($this->prepare($command), $this->cwd, null, null, $timeout);
        $process->run($callback);
        if (!$process->isSuccessful()) {
            throw new \RuntimeException(sprintf('An error occurred when executing the "%s" command.', $command));
        }
    }

    /**
     * Execute command in background
     *
     * @param string $command
     */
    protected function executeCommandInBackground($command)
    {
        $cwd = getcwd();
        chdir($this->cwd);

        $command = $this->prepare($command);
        if (defined('PHP_WINDOWS_VERSION_BUILD') && function_exists('popen')) {
            pclose(popen('start /b call '.$command, 'r'));
        } else {
            exec($command.' &');
        }

        chdir($cwd);
    }

    /**
     * Send the command to perform in a new thread
     *
     * @param string $command
     * @param string $host
     */
    public function send($command, $host = '')
    {
        $host = $host ?: $this->host;
        if (!$host) {
            throw new \InvalidArgumentException('Unknown host that will run the command');
        }
        $content = 'command='.urlencode($command);

        $fp = fsockopen($this->host, 80, $errno, $errstr, self::TIMEOUT);
        $request  = "POST ".$this->path." HTTP/1.1\r\n";
        $request .= "Host: ".$host."\r\n";
        $request .= "Content-Type: application/x-www-form-urlencoded\r\n";
        $request .= "Content-Length: ".strlen($content)."\r\n";
        $request .= "Connection: Close\r\n\r\n";
        $request .= $content;
        fwrite($fp, $request);
        fclose($fp);
    }

    /**
     * Prepare command
     *
     * @param string $command
     *
     * @return string
     */
    public function prepare($command)
    {
        // change path for php
        if (substr($command, 0, 4) == 'php ') {
            $command = $this->finder->getPath().substr($command, 3);
        }

        // change path to console
        $command = str_replace(' app/console ', ' '.$this->console.' ', $command);

        // change /dev/null for Windows
        if (defined('PHP_WINDOWS_VERSION_BUILD')) {
            $command = str_replace('/dev/null', 'nul', $command);
        }

        return $command;
    }
}