Amplexor\XConnect\Service\SFtpService

Complexity

Total Complexity

20

Size/Duplication

Total Lines	203
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

87.5%

Importance

Changes	4
Bugs	0	Features	2

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	send()	0	19	2
A	scan()	0	21	4
A	receive()	0	20	2
A	processed()	0	19	2
A	delete()	0	17	2
A	setConnection()	0	4	1
A	getConnection()	0	6	2
A	login()	0	18	3

<?php
/**
 * This file is part of the Amplexor\XConnect library
 *
 * @license http://opensource.org/licenses/MIT
 * @link https://github.com/amplexor-drupal/xconnect/
 * @version 1.0.0
 * @package Amplexor.XConnect
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Amplexor\XConnect\Service;

use Amplexor\XConnect\Request\File\FileInterface;

/**
 * SFTP Service.
 */
class SFtpService extends FtpService
{
    /**
     * The transfer mode.
     *
     * Value is substitute for the NET_SFTP_LOCAL_FILE constant.
     *
     * @var int
     */
    const TRANSFER_MODE = 1;

    /**
     * The SFTP connection.
     *
     * @var \Net_SFTP
     */
    private $sftp;

    /**
     * Is the connection logged in?
     *
     * @var bool
     */
    private $loggedIn = false;


    /**
     * @inheritDoc
     */
    public function __construct(array $config)
    {
        if (!isset($config['port'])) {
            $config['port'] = 22;
        }

        parent::__construct($config);
    }

    /**
     * @inheritDoc
     */
    public function send(FileInterface $file)
    {
        $connection = $this->getConnection();
        $from = $file->getPath();
        $to = $this->getDirectorySend() . '/' . $file->getFileName();

        $result = $connection->put($to, $from, self::TRANSFER_MODE);
        if (!$result) {
            throw new ServiceException(
                sprintf(
                    'File "%s" could not be uploaded to "%s".',
                    $from,
                    $to
                )
            );
        }

        return $result;
    }

    /**
     * @inheritDoc
     */
    public function scan()
    {
        $connection = $this->getConnection();
        $files = array();

        $rawFiles = $connection->rawlist($this->getDirectoryReceive());
        if (empty($rawFiles)) {
            return $files;
        }

        // We only want files, no directories.
        foreach ($rawFiles as $rawFile) {
            if ($rawFile['type'] !== 1) {
                continue;
            }

            $files[] = $rawFile['filename'];
        }

        return $files;
    }

    /**
     * @inheritDoc
     */
    public function receive($fileName, $localDirectory)
    {
        $connection = $this->getConnection();

        $to = $localDirectory . '/' . $fileName;
        $from = $this->getDirectoryReceive() . '/' . $fileName;
        $result = $connection->get($from, $to);

        if (!$result) {
            throw new ServiceException(
                sprintf(
                    'File "%s" could not be downloaded to "%s".',
                    $from,
                    $to
                )
            );
        }

        return $to;
    }

    /**
     * {@inheritdoc}
     */
    public function processed($fileName)
    {
        $connection = $this->getConnection();
        $from = $this->getDirectoryReceive() . '/' . $fileName;
        $to = $this->getDirectoryReceiveProcessed() . '/' . $fileName;

        $result = $connection->rename($from, $to);
        if (!$result) {
            throw new ServiceException(
                sprintf(
                    'File "%s" could not be moved to "%s".',
                    $from,
                    $to
                )
            );
        }

        return $result;
    }

    /**
     * {@inheritdoc}
     */
    public function delete($fileName)
    {
        $connection = $this->getConnection();
        $file = $this->getDirectoryReceive() . '/' . $fileName;

        $result = $connection->delete($file);
        if (!$result) {
            throw new ServiceException(
              sprintf(
                'File "%s" could not be deleted.',
                $from
              )
            );
        }

        return $result;
    }


    /**
     * Inject the connection for testing purpose.
     *
     * @param \Net_SFTP $connection
     *   The connection object.
     */
    public function setConnection(\Net_SFTP $connection)
    {
        $this->sftp = $connection;
    }

    /**
     * Get the connection.
     *
     * @return \Net_SFTP
     */
    protected function getConnection()
    {
        $this->sftp = $this->sftp ?: new \Net_SFTP($this->getHostname(), $this->getPort(), $this->getTimeout());
        $this->login();
        return $this->sftp;
    }

    /**
     * Login to the SFTP service.
     *
     * @throws ServiceException
     *   Whe we can't login to the SFTP server.
     */
    protected function login()
    {
        if ($this->loggedIn) {
            return true;
        }

        $result = $this->sftp->login(
            $this->getUsername(),
            $this->getPassword()
        );
        if (!$result) {
            throw new ServiceException(
                sprintf('Can\'t login with user "%s".', $this->getUsername())
            );
        }

        $this->loggedIn = true;
    }
}