diecoding\flysystem\SftpComponent

Complexity

Total Complexity

12

Size/Duplication

Total Lines	140
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	13	6
A	initAdapter()	0	19	4
A	checksum()	0	7	2

<?php

namespace diecoding\flysystem;

use diecoding\flysystem\traits\UrlGeneratorTrait;
use League\Flysystem\ChecksumAlgoIsNotSupported;
use League\Flysystem\ChecksumProvider;
use League\Flysystem\Config;
use League\Flysystem\PathPrefixing\PathPrefixedAdapter;
use League\Flysystem\PhpseclibV3\SftpAdapter;
use League\Flysystem\PhpseclibV3\SftpConnectionProvider;
use League\Flysystem\UrlGeneration\PublicUrlGenerator;
use League\Flysystem\UrlGeneration\TemporaryUrlGenerator;
use Yii;
use yii\base\InvalidConfigException;

/**
 * Interacting with an sftp filesystem
 * This implementation uses version 3 of phpseclib
 * ! Notice
 * It's important to know this adapter does not fully comply with the adapter contract. The difference(s) is/are:
 * - Checksum setting or retrieving is not supported.
 * @see https://flysystem.thephpleague.com/docs/adapter/sftp-v3/
 * 
 * ```php
 * 'components' => [
 *     'fs' => [
 *         'class' => \diecoding\flysystem\SftpComponent::class,
 *         'host' => 'hostname',
 *         'username' => 'username',
 *         'password' => null, // password (optional, default: null) set to null if privateKey is used
 *         'privateKey' => '/path/to/my/private_key', // private key (optional, default: null) can be used instead of password, set to null if password is set
 *         'passphrase' => 'super-secret-password', // passphrase (optional, default: null), set to null if privateKey is not used or has no passphrase
 *         'port' => 22,
 *         'useAgent' => true,
 *         'timeout' => 10,
 *         'maxTries' => 4,
 *         'hostFingerprint' => null,
 *         'connectivityChecker' => null, // connectivity checker (must be an implementation of `League\Flysystem\PhpseclibV2\ConnectivityChecker` to check if a connection can be established (optional, omit if you don't need some special handling for setting reliable connections)
 *         'preferredAlgorithms' => [],
 *         'root' => '/root/path/', // or you can use @alias
 *         'action' => '/site/file',
 *         'prefix' => '', 
 *     ],
 * ],
 * ```
 * 
 * @link      https://sugengsulistiyawan.my.id/
 * @author    Sugeng Sulistiyawan <sugeng.sulistiyawan@gmail.com>
 * @copyright Copyright (c) 2023
 */
class SftpComponent extends AbstractComponent implements PublicUrlGenerator, TemporaryUrlGenerator, ChecksumProvider
{
    use UrlGeneratorTrait;

    /**
     * @var string
     */
    public $host;

    /**
     * @var string
     */
    public $username;

    /**
     * @var string
     */
    public $password;

    /**
     * @var string
     */
    public $privateKey;

    /**
     * @var string
     */
    public $passphrase;

    /**
     * @var int
     */
    public $port;

    /**
     * @var bool
     */
    public $useAgent;

    /**
     * @var int
     */
    public $timeout;
    /**
     * @var int
     */
    public $maxTries;

    /**
     * @var string
     */
    public $hostFingerprint;

    /**
     * @var \League\Flysystem\PhpseclibV3\ConnectivityChecker
     */
    public $connectivityChecker;

    /**
     * @var array
     */
    public $preferredAlgorithms;

    /**
     * @var string
     */
    public $root;

    /**
     * @var array
     */
    protected $_availableOptions = [
        'host',
        'username',
        'password',
        'privateKey',
        'passphrase',
        'port',
        'useAgent',
        'timeout',
        'maxTries',
        'hostFingerprint',
        'connectivityChecker',
        'preferredAlgorithms',
    ];

    /**
     * @var SftpConnectionProvider
     */
    protected $_connectionProvider;

    /**
     * @inheritdoc
     */
    public function init()
    {
        if (empty($this->path)) {

The property path does not exist on diecoding\flysystem\SftpComponent. Since you implemented __get, consider adding a @property annotation.

            throw new InvalidConfigException('The "host" property must be set.');
        }
        if (empty($this->secret)) {

The property secret does not exist on diecoding\flysystem\SftpComponent. Since you implemented __get, consider adding a @property annotation.

            throw new InvalidConfigException('The "username" property must be set.');
        }

        $this->passphrase = $this->passphrase ?: ($this->password ?: ($this->username ?: Yii::$app->id));
        $this->initEncrypter($this->passphrase);

        parent::init();
    }

    /**
     * @return SftpAdapter|PathPrefixedAdapter
     */
    protected function initAdapter()
    {
        $this->root = (string) Yii::getAlias($this->root);

        $options = [];
        foreach ($this->_availableOptions as $property) {
            if ($this->$property !== null) {
                $options[$property] = $this->$property;
            }
        }

        $this->_connectionProvider = SftpConnectionProvider::fromArray($options);

        $adapter = new SftpAdapter($this->_connectionProvider, $this->root);
        if ($this->prefix) {
            $adapter = new PathPrefixedAdapter($adapter, $this->prefix);
        }

        return $adapter;
    }

    public function checksum(string $path, Config $config): string
    {
        if ($this->debug) {
            throw new ChecksumAlgoIsNotSupported('SftpComponent does not support this operation.');
        }

        return '';
    }
}