Ftp Class Reference

Inheritance diagram for Ftp:

Public Member Functions
	run ()
Public Member Functions inherited from AbstractRollback
	__construct (Filesystem $snapshotObject)
	run ()

Protected Member Functions
	_initFtpClient ()
	_validateFtp ()
	_unpackSnapshot ($tmpDir)
	_createTmpDir ()
	_cleanupFtp ()
	_uploadBackupToFtp ($tmpDir)

Protected Attributes
	$_ftpClient
Protected Attributes inherited from AbstractRollback
	$_snapshot

Detailed Description

Rollback worker for rolling back via ftp

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 20 of file Ftp.php.

Member Function Documentation

_cleanupFtp()

_cleanupFtp ( )

protected

Delete magento and all files from ftp

Returns

void

Definition at line 153 of file Ftp.php.

    {
        $rootDir = $this->_snapshot->getRootDir();

        $filesystemIterator = new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator($rootDir),
            \RecursiveIteratorIterator::CHILD_FIRST
        );

        $iterator = new \Magento\Framework\Backup\Filesystem\Iterator\Filter(
            $filesystemIterator,
            $this->_snapshot->getIgnorePaths()
        );

        foreach ($iterator as $item) {
            $ftpPath = $this->_snapshot->getFtpPath() . '/' . str_replace($rootDir, '', $item->__toString());
            $ftpPath = str_replace('\\', '/', $ftpPath);

            $this->_ftpClient->delete($ftpPath);
        }
    }

_createTmpDir()

_createTmpDir ( )

protected

Returns

string

Exceptions

LocalizedException

Definition at line 133 of file Ftp.php.

    {
        $tmpDir = $this->_snapshot->getBackupsDir() . '/~tmp-' . microtime(true);

        $result = @mkdir($tmpDir);

        if (false === $result) {
            throw new \Magento\Framework\Backup\Exception\NotEnoughPermissions(
                new Phrase('Failed to create directory %1', [$tmpDir])
            );
        }

        return $tmpDir;
    }

_initFtpClient()

_initFtpClient ( )

protected

Initialize ftp client and connect to ftp

Returns

void

Exceptions

FtpConnectionFailed

Definition at line 70 of file Ftp.php.

    {
        try {
            $this->_ftpClient = new \Magento\Framework\System\Ftp();
            $this->_ftpClient->connect($this->_snapshot->getFtpConnectString());
        } catch (\Exception $e) {
            throw new FtpConnectionFailed(
                new Phrase($e->getMessage())
            );
        }
    }

_unpackSnapshot()

_unpackSnapshot (   $tmpDir )

protected

Unpack snapshot

Parameters

string

$tmpDir

Returns

void

Definition at line 121 of file Ftp.php.

    {
        $snapshotPath = $this->_snapshot->getBackupPath();

        $archiver = new \Magento\Framework\Archive();
        $archiver->unpack($snapshotPath, $tmpDir);
    }

_uploadBackupToFtp()

_uploadBackupToFtp (   $tmpDir )

protected

Perform files rollback

Parameters

string

$tmpDir

Returns

void

Exceptions

LocalizedException

@SuppressWarnings(PHPMD.UnusedLocalVariable)

Definition at line 183 of file Ftp.php.

    {
        $filesystemIterator = new \RecursiveIteratorIterator(
            new \RecursiveDirectoryIterator($tmpDir),
            \RecursiveIteratorIterator::SELF_FIRST
        );

        $iterator = new \Magento\Framework\Backup\Filesystem\Iterator\Filter(
            $filesystemIterator,
            $this->_snapshot->getIgnorePaths()
        );

        foreach ($filesystemIterator as $item) {
            $ftpPath = $this->_snapshot->getFtpPath() . '/' . str_replace($tmpDir, '', $item->__toString());
            $ftpPath = str_replace('\\', '/', $ftpPath);

            if ($item->isLink()) {
                continue;
            }

            if ($item->isDir()) {
                $this->_ftpClient->mkdirRecursive($ftpPath);
            } else {
                $result = $this->_ftpClient->put($ftpPath, $item->__toString());
                if (false === $result) {
                    throw new \Magento\Framework\Backup\Exception\NotEnoughPermissions(
                        new Phrase('Failed to upload file %1 to ftp', [$item->__toString()])
                    );
                }
            }
        }
    }

_validateFtp()

_validateFtp ( )

protected

Perform ftp validation. Check whether ftp account provided points to current magento installation

Returns

void

Exceptions

LocalizedException

Definition at line 88 of file Ftp.php.

    {
        $validationFilename = '~validation-' . microtime(true) . '.tmp';
        $validationFilePath = $this->_snapshot->getBackupsDir() . '/' . $validationFilename;

        $fh = @fopen($validationFilePath, 'w');
        @fclose($fh);

        if (!is_file($validationFilePath)) {
            throw new LocalizedException(
                new Phrase('Unable to validate ftp account')
            );
        }

        $rootDir = $this->_snapshot->getRootDir();
        $ftpPath = $this->_snapshot->getFtpPath() . '/' . str_replace($rootDir, '', $validationFilePath);

        $fileExistsOnFtp = $this->_ftpClient->fileExists($ftpPath);
        @unlink($validationFilePath);

        if (!$fileExistsOnFtp) {
            throw new FtpValidationFailed(
                new Phrase('Failed to validate ftp account')
            );
        }
    }

run()

run

(

)

Files rollback implementation via ftp

Returns

void

Exceptions

LocalizedException

See also

AbstractRollback::run()

Definition at line 37 of file Ftp.php.

    {
        $snapshotPath = $this->_snapshot->getBackupPath();

        if (!is_file($snapshotPath) || !is_readable($snapshotPath)) {
            throw new CantLoadSnapshot(
                new Phrase('Can\'t load snapshot archive')
            );
        }

        $this->_initFtpClient();
        $this->_validateFtp();

        $tmpDir = $this->_createTmpDir();
        $this->_unpackSnapshot($tmpDir);

        $fsHelper = new Helper();

        $this->_cleanupFtp();
        $this->_uploadBackupToFtp($tmpDir);

        if ($this->_snapshot->keepSourceFile() === false) {
            $fsHelper->rm($tmpDir, [], true);
            $this->_ftpClient->delete($snapshotPath);
        }
    }

Field Documentation

$_ftpClient

$_ftpClient

protected

Definition at line 27 of file Ftp.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Backup/Filesystem/Rollback/Ftp.php