ScpTransporter - Code Metrics - webcreate/conveyor - Measure and Improve Code Quality continuously with Scrutinizer

ScpTransporter A
last analyzed 2016-12-08 12:42 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	267
Duplicated Lines	44.94 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

46.81%

Importance

Changes

Metric	Value
wmc	29
lcom	1
cbo	3
dl	120
loc	267
ccs	44
cts	94
cp	0.4681
rs	10
c	0
b	0
f	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	exists()	13	13	2
A	mkdir()	0	18	3
B	get()	23	23	4
A	put()	21	21	4
A	putContent()	20	20	2
A	symlink()	11	11	2
A	isSymlink()	11	11	2
A	copy()	0	13	3
A	remove()	13	13	3
A	exec()	8	8	2
A	ls()	0	4	1

How to fix Duplicated Code

<?php

/*
 * This file is part of the Conveyor package.
 *
 * (c) Jeroen Fiege <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Webcreate\Conveyor\Transporter;

use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Webcreate\Conveyor\Event\TransporterEvent;
use Webcreate\Conveyor\Event\TransporterEvents;
use Webcreate\Util\Cli;

class ScpTransporter extends AbstractTransporter implements SshCapableTransporterInterface
{
    protected $cli;
    protected $_exists = array();

    public function __construct(EventDispatcherInterface $dispatcher, Cli $cli)
    {
        parent::__construct($dispatcher);

        $this->cli = $cli;
    }

    /**
     * Checks if a file or directory exists on the remote server
     *
     * @param  string $path remote source path
     * @return bool   true when the resource exists, false otherwise
     */
    public function exists($path)

    {
        if (false === isset($this->_exists[$path])) {
            $remoteCommand = sprintf("test -e %s", $path);
            $commandline   = sprintf("ssh %s@%s \"%s\"", $this->getUser(), $this->getHost(), $remoteCommand);

            $exitCode = $this->cli->execute($commandline);

            $this->_exists[$path] = (0 === $exitCode);
        }

        return $this->_exists[$path];
    }

    /**
     * Create a directory on the remote server
     *
     * @param  string            $dest remote path
     * @throws \RuntimeException
     */
    public function mkdir($dest)
    {
        $pwd = dirname($dest);
        if (false === $this->exists($pwd)) {
            $this->mkdir($pwd);
        }

        $remoteCommand = sprintf("mkdir '%s'", $dest);
        $commandline   = sprintf("ssh %s@%s \"%s\"", $this->getUser(), $this->getHost(), $remoteCommand);

        $this->_exists[$dest] = true;

        $this->dispatcher->dispatch(TransporterEvents::TRANSPORTER_MKDIR, new TransporterEvent($this, $dest));

        if ($this->cli->execute($commandline)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new \RuntimeException($this->cli->getErrorOutput());
        }
    }

    /**
     * Retrieve file or directory from remote server
     *
     * @param  string            $src  remote source path
     * @param  string            $dest (optional) local destination path
     * @throws \RuntimeException
     * @return string
     */
    public function get($src, $dest = null)

    {
        $realDest = $dest;

        if (null == $dest) {

            $realDest = tempnam(sys_get_temp_dir(), basename($src));
        }

        $commandline = sprintf("scp %s@%s:%s \"%s\"", $this->getUser(), $this->getHost(), $src, $realDest);

        $this->dispatcher->dispatch(TransporterEvents::TRANSPORTER_GET, new TransporterEvent($this, array('src' => $src, 'dest' => $dest)));

        if ($this->cli->execute($commandline)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new \RuntimeException($this->cli->getErrorOutput());
        }

        if (null == $dest) {

            $content = file_get_contents($realDest);
            unlink($realDest);

            return $content;
        }
    }

    /**
     * Upload a file or directory to remote server
     *
     * @param  string                    $src  local source path
     * @param  string                    $dest remote destination path
     * @throws \RuntimeException
     * @throws \InvalidArgumentException
     */
    public function put($src, $dest)

    {
        if (false === file_exists($src)) {
            throw new \InvalidArgumentException(sprintf('Resource \'%s\' does not exist', $src));
        }

        $pwd = dirname($dest);
        if (false === $this->exists($pwd)) {
            $this->mkdir($pwd);
        }

        $commandline = sprintf("scp \"%s\" '%s@%s:%s'", $src, $this->getUser(), $this->getHost(), $dest);

        $this->_exists[$dest] = true;

        $this->dispatcher->dispatch(TransporterEvents::TRANSPORTER_PUT, new TransporterEvent($this, array('dest' => $dest, 'src' => $src)));

        if ($this->cli->execute($commandline)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new \RuntimeException($this->cli->getErrorOutput());
        }
    }

    /**
     * Upload a string to remote server
     *
     * @param  string            $content content
     * @param  string            $dest    remote destination path
     * @throws \RuntimeException
     */
    public function putContent($content, $dest)

    {
        $temp_file = tempnam(sys_get_temp_dir(), 'rsync' . time());

        file_put_contents($temp_file, $content);

        $commandline = sprintf("scp \"%s\" '%s@%s:%s'", $temp_file, $this->getUser(), $this->getHost(), $dest);

        $this->_exists[$dest] = true;

        $this->dispatcher->dispatch(TransporterEvents::TRANSPORTER_PUT_CONTENT, new TransporterEvent($this, array('dest' => $dest, 'src' => $temp_file, 'content' => $content)));

        if ($this->cli->execute($commandline)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            @unlink($temp_file);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

            throw new \RuntimeException($this->cli->getErrorOutput());
        }

        @unlink($temp_file);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
    }

    /**
     * Creates a symlink on the remote server
     *
     * @param $src
     * @param $dest
     * @throws \RuntimeException
     * @return mixed
     */
    public function symlink($src, $dest)

    {
        $this->dispatcher->dispatch(TransporterEvents::TRANSPORTER_SYMLINK, new TransporterEvent($this, array('dest' => $dest, 'src' => $src)));

        $remoteCommand = sprintf("ln -s %s %s", $src, $dest);
        $commandline   = sprintf("ssh %s@%s \"%s\"", $this->getUser(), $this->getHost(), $remoteCommand);

        if ($this->cli->execute($commandline)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new \RuntimeException($this->cli->getErrorOutput());
        }
    }

    /**
     * Checks for symlink on the remote server
     *
     * @param $dest
     * @return bool
     */
    public function isSymlink($dest)

    {
        $remoteCommand = sprintf("readlink %s", $dest);
        $commandline   = sprintf("ssh %s@%s \"%s\"", $this->getUser(), $this->getHost(), $remoteCommand);

        if ($this->cli->execute($commandline)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            return false;
        }

        return ('' !== trim($this->cli->getOutput()));
    }

    /**
     * Copies a file/directory on the remote host
     *
     * @param  string            $src
     * @param  string            $dest
     * @param  bool              $recursive
     * @throws \RuntimeException
     * @return mixed
     */
    public function copy($src, $dest, $recursive = true)
    {
        $recursiveFlag = ($recursive ? 'r' : '');

        $remoteCommand = sprintf("cp -{$recursiveFlag}f %s %s", $src, $dest);
        $commandline   = sprintf("ssh %s@%s \"%s\"", $this->getUser(), $this->getHost(), $remoteCommand);

        $this->dispatcher->dispatch(TransporterEvents::TRANSPORTER_COPY, new TransporterEvent($this, array('dest' => $dest, 'src' => $src)));

        if ($this->cli->execute($commandline)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new \RuntimeException($this->cli->getErrorOutput());
        }
    }

    /**
     * Removes a file/directory on the remote host
     *
     * @param  string            $path
     * @param  bool              $recursive
     * @throws \RuntimeException
     * @return mixed
     */
    public function remove($path, $recursive = true)

    {
        $recursiveFlag = ($recursive ? 'r' : '');

        $remoteCommand = sprintf("rm -{$recursiveFlag}f %s", $path);
        $commandline   = sprintf("ssh %s@%s \"%s\"", $this->getUser(), $this->getHost(), $remoteCommand);

        $this->dispatcher->dispatch(TransporterEvents::TRANSPORTER_REMOVE, new TransporterEvent($this, array('path' => $path)));

        if ($this->cli->execute($commandline)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new \RuntimeException($this->cli->getErrorOutput());
        }
    }

    /**
     * @todo this is just a simple implementation which should be improved
     *
     * @param $command
     * @param  null              $callback
     * @throws \RuntimeException
     */
    public function exec($command, $callback = null)

    {
        $commandline = sprintf("ssh %s@%s \"%s\"", $this->getUser(), $this->getHost(), $command);

        if ($this->cli->execute($commandline, $callback)) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            throw new \RuntimeException($this->cli->getErrorOutput());
        }
    }

    /**
     * Lists files and directories
     *
     * returns an array with the following format:
     *
     * array(
     *   'filename' => array(
     *     'type' => 'directory', // or 'file'
     *     'mtime' => new \DateTime(),
     *   ),
     * );
     *
     * @param  string            $path
     * @throws \RuntimeException
     * @return array
     */
    public function ls($path)

    {
        throw new \RuntimeException('Listing of files and directories is not supported (yet)');
    }
}


1			<?php
2
3			/*
4			* This file is part of the Conveyor package.
5			*
6			* (c) Jeroen Fiege <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Webcreate\Conveyor\Transporter;
13
14			use Symfony\Component\EventDispatcher\EventDispatcherInterface;
15			use Webcreate\Conveyor\Event\TransporterEvent;
16			use Webcreate\Conveyor\Event\TransporterEvents;
17			use Webcreate\Util\Cli;
18
19			class ScpTransporter extends AbstractTransporter implements SshCapableTransporterInterface
20			{
21			protected $cli;
22			protected $_exists = array();
23
24	6		public function __construct(EventDispatcherInterface $dispatcher, Cli $cli)
25			{
26	6		parent::__construct($dispatcher);
27
28	6		$this->cli = $cli;
29	6		}
30
31			/**
32			* Checks if a file or directory exists on the remote server
33			*
34			* @param string $path remote source path
35			* @return bool true when the resource exists, false otherwise
36			*/
37		View Code Duplication	public function exists($path)
			0 ignored issues – show Duplication introduced 2016-01-14 09:42 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
38			{
39			if (false === isset($this->_exists[$path])) {

webcreate / conveyor

ScpTransporter A last analyzed 2016-12-08 12:42 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

12 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

ScpTransporter A
last analyzed 2016-12-08 12:42 UTC