phpbu\App\Backup\Sync\Sftp

Complexity

Total Complexity

16

Size/Duplication

Total Lines	141
Duplicated Lines	14.18 %

Coupling/Cohesion

Components	1
Dependencies	7

Test Coverage

Coverage

66.04%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setup()	0	6	1
A	checkRequirements()	0	6	2
A	getProtocolName()	0	4	1
B	sync()	0	25	4
A	login()	11	21	3
A	getRemoteDirectoryList()	0	13	3
A	cleanup()	9	9	2

<?php
namespace phpbu\App\Backup\Sync;

use phpbu\App\Util\Str;
use phpseclib;
use phpbu\App\Result;
use phpbu\App\Backup\Target;

/**
 * Sftp sync
 *
 * @package    phpbu
 * @subpackage Backup
 * @author     Sebastian Feldmann <sebastian@phpbu.de>
 * @copyright  Sebastian Feldmann <sebastian@phpbu.de>
 * @license    https://opensource.org/licenses/MIT The MIT License (MIT)
 * @link       http://phpbu.de/
 * @since      Class available since Release 1.0.0
 */
class Sftp extends Xtp implements Simulator
{
    /**
     * @var phpseclib\Net\SFTP
     */
    protected $sftp;

    /**
     * (non-PHPDoc)
     *
     * @see    \phpbu\App\Backup\Sync::setup()
     * @param  array $config
     * @throws \phpbu\App\Backup\Sync\Exception
     * @throws \phpbu\App\Exception
     */
    public function setup(array $config)
    {
        parent::setup($config);

        $this->setUpClearable($config);
    }

    /**
     * Check for required loaded libraries or extensions.
     *
     * @throws \phpbu\App\Backup\Sync\Exception
     */
    protected function checkRequirements()
    {
        if (!class_exists('\\phpseclib\\Net\\SFTP')) {
            throw new Exception('phpseclib not installed - use composer to install "phpseclib/phpseclib" version 2.x');
        }
    }

    /**
     * Return implemented (*)TP protocol name.
     *
     * @return string
     */
    protected function getProtocolName()
    {
        return 'SFTP';
    }

    /**
     * (non-PHPDoc)
     *
     * @see    \phpbu\App\Backup\Sync::sync()
     * @param  \phpbu\App\Backup\Target $target
     * @param  \phpbu\App\Result        $result
     * @throws \phpbu\App\Backup\Sync\Exception
     */
    public function sync(Target $target, Result $result)
    {
        $this->sftp     = $this->login();
        $remoteFilename = $target->getFilename();
        $localFile      = $target->getPathname();

        foreach ($this->getRemoteDirectoryList() as $dir) {
            if (!$this->sftp->is_dir($dir)) {
                $result->debug(sprintf('creating remote dir \'%s\'', $dir));
                $this->sftp->mkdir($dir);
            }
            $result->debug(sprintf('change to remote dir \'%s\'', $dir));
            $this->sftp->chdir($dir);
        }

        $result->debug(sprintf('store file \'%s\' as \'%s\'', $localFile, $remoteFilename));
        $result->debug(sprintf('last error \'%s\'', $this->sftp->getLastSFTPError()));

        if (!$this->sftp->put($remoteFilename, $localFile, phpseclib\Net\SFTP::SOURCE_LOCAL_FILE)) {
            throw new Exception(sprintf('error uploading file: %s - %s', $localFile, $this->sftp->getLastSFTPError()));
        }

        // run remote cleanup
        $this->cleanup($target, $result);
    }

    /**
     * Create a sftp handle.
     *
     * @return \phpseclib\Net\SFTP
     * @throws \phpbu\App\Backup\Sync\Exception
     */
    protected function login() : phpseclib\Net\SFTP
    {
        // silence phpseclib
        $old  = error_reporting(0);
        $sftp = new phpseclib\Net\SFTP($this->host);
        if (!$sftp->login($this->user, $this->password)) {
            error_reporting($old);
            throw new Exception(
                sprintf(
                    'authentication failed for %s@%s%s',
                    $this->user,
                    $this->host,
                    empty($this->password) ? '' : ' with password ****'
                )
            );
        }
        // restore old error reporting
        error_reporting($old);

        return $sftp;
    }

    /**
     * Return list of remote directories to travers.
     *
     * @return array
     */
    private function getRemoteDirectoryList() : array
    {
        $remoteDirs = [];
        if (!empty($this->remotePath)) {
            $remoteDirs = explode('/', $this->remotePath);
            // fix empty first array element for absolute path
            if (Str::hasLeadingSlash($this->remotePath)) {
                $remoteDirs[0] = '/';
            }
            $remoteDirs = array_filter($remoteDirs);
        }
        return $remoteDirs;
    }

    /**
     * Execute the remote clean up if needed
     *
     * @param \phpbu\App\Backup\Target $target
     * @param \phpbu\App\Result        $result
     */
    public function cleanup(Target $target, Result $result)
    {
        if (!$this->cleaner) {
            return;
        }

        $collector = new \phpbu\App\Backup\Collector\Sftp($target, $this->sftp, $this->remotePath);
        $this->cleaner->cleanup($target, $collector, $result);
    }
}