Webcreate\Conveyor\Transporter\FtpTransporter

Complexity

Total Complexity

39

Size/Duplication

Total Lines	262
Duplicated Lines	13.36 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

50%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	connect()	0	12	3
A	login()	0	4	1
A	connectAndLogin()	0	5	1
B	exists()	0	31	6
A	mkdir()	0	11	2
B	get()	23	23	4
C	put()	12	34	7
A	putContent()	0	16	2
A	symlink()	0	4	1
A	isSymlink()	0	4	1
A	copy()	0	4	1
A	remove()	0	4	1
B	ls()	0	41	6
A	__destruct()	0	6	2

<?php

/*
 * This file is part of the Conveyor package.
 *
 * (c) Jeroen Fiege <jeroen@webcreate.nl>
 *
 * 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 Symfony\Component\Finder\Finder;
use Webcreate\Conveyor\Event\TransporterEvent;
use Webcreate\Conveyor\Event\TransporterEvents;

class FtpTransporter extends AbstractTransporter
{
    protected $stream;

    public function __construct(EventDispatcherInterface $dispatcher)
    {
        $this->setDispatcher($dispatcher);
    }

    public function connect()
    {
        $this->dispatcher->dispatch(TransporterEvents::TRANSPORTER_CONNECT, new TransporterEvent($this));

        $port = $this->port ?: 21;

        $this->stream = ftp_connect($this->host, $port);
        if (false == $this->stream) {
            throw new \RuntimeException(sprintf('Could not connect to host %s on port %s', $this->host, $port));
        }
        ftp_pasv($this->stream, true);
    }

    public function login()
    {
        $success = ftp_login($this->stream, $this->username, $this->password);

$success is not used, you could remove the assignment.

    }

    public function connectAndLogin()
    {
        $this->connect();
        $this->login();
    }

    public function exists($path)
    {
        if (!$this->stream) {
            $this->connectAndLogin();
        }

        $pwd = ftp_pwd($this->stream);

        // try to change directory to see if it is an existing directory
        $result = @ftp_chdir($this->stream, $path);
        if (true === $result) {
            ftp_chdir($this->stream, $pwd); // change back to the original directory

            return true;
        } else {
            // list the parent directory and check if the file exists
            $parent = dirname($path);
            $options = '-a'; // list hidden
            $result = ftp_rawlist($this->stream, $options . ' ' . $parent);

            if (false !== $result) {
                foreach ($result as $line) {
                    if (false !== $pos = strrpos($line, basename($path))) {
                        return true;
                    }
                }
            }
        }

        return false;
    }

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

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

        ftp_mkdir($this->stream, $dest);
    }

    public function get($src, $dest = null)

This method seems to be duplicated in your project.

    {
        if (!$this->stream) {
            $this->connectAndLogin();
        }

        $realDest = $dest;

        if (null == $dest) {

It seems like you are loosely comparing $dest of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

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

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

        $succes = ftp_get($this->stream, $realDest, $src, FTP_BINARY);

$succes is not used, you could remove the assignment.

        if (null == $dest) {

It seems like you are loosely comparing $dest of type string|null against null; this is ambiguous if the string can be empty. Consider using a strict comparison === instead.

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

            return $content;
        }
    }

    public function put($src, $dest)
    {
        if (!$this->stream) {
            $this->connectAndLogin();
        }

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

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

            $file = new \SplFileInfo($src);

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

            ftp_put($this->stream, $dest, $file->getPathname(), FTP_BINARY);
        } else {

This code seems to be duplicated across your project.

            if (!$this->exists($dest)) {
                $this->mkdir($dest);
            }

            $finder = new Finder();
            $test = $finder->in($src)->depth('== 0');

            foreach ($test as $file) {
                $this->put(rtrim($src, '/') . '/' . $file->getFilename(), rtrim($dest, '/')  . '/' . $file->getFilename());
            }
        }
    }

    public function putContent($content, $dest)
    {
        if (!$this->stream) {
            $this->connectAndLogin();
        }

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

        $tempfile = tempnam(sys_get_temp_dir(), 'conveyor');

        file_put_contents($tempfile, $content);

        ftp_put($this->stream, $dest, $tempfile, FTP_BINARY);

        unlink($tempfile);
    }

    /**
     * Creates a symlink on the remote server
     *
     * @param $src
     * @param $dest
     * @throws \RuntimeException
     * @return mixed
     */
    public function symlink($src, $dest)
    {
        throw new \RuntimeException('Symlinking not supported');
    }

    /**
     * Checks for symlink on the remote server
     *
     * @param $dest
     * @throws \RuntimeException
     * @return bool
     */
    public function isSymlink($dest)
    {
        throw new \RuntimeException('Symlinking not supported');
    }

    /**
     * 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)
    {
        throw new \RuntimeException('Copy (yet) not supported');
    }

    /**
     * Removes a file/directory on the remote host
     *
     * @param  string            $path
     * @param  bool              $recursive
     * @throws \RuntimeException
     * @return mixed
     */
    public function remove($path, $recursive = true)
    {
        throw new \RuntimeException('Remove (yet) not supported');
    }

    /**
     * Lists files and directories
     *
     * @todo WARNING: this is untested code!!
     *
     * @param  string $path
     * @return mixed
     */
    public function ls($path)

This method's name is shorter than the configured minimum length of 3 characters.

    {
        if (!$this->stream) {
            $this->connectAndLogin();
        }

        $list = ftp_rawlist($this->stream, $path);

        $retval = array();

        foreach ($list as $info) {
            $item = array();
            $chunks = preg_split('/\s+/', $info);

            list(
                $item['rights'],
                $item['number'],
                $item['user'],
                $item['group'],
                $item['size'],
                $item['month'],
                $item['day'],
                $item['time']) = $chunks;

            $item['type'] = $chunks[0]{0} === 'd' ? 'directory' : 'file';

            array_splice($chunks, 0, 8);
            $fileOrDirectory = implode(" ", $chunks);

            if ('..' === $fileOrDirectory || '.' === $fileOrDirectory) {
                continue;
            }

            $retval[$fileOrDirectory] = array(
                'type' => $item['type'],
                'mtime' => new \DateTime(sprintf('%s %s %s', $item['month'], $item['day'], $item['time'])),
            );
        }

        return $retval;
    }

    public function __destruct()
    {
        if ($this->stream) {
            ftp_close($this->stream);
        }
    }
}