File upload using SFTP in Drupal's custom form (PHPSeclib library)

By hari, 1 March, 2023

Install phpseclib library into your project by using composer command

$ composer require phpseclib/phpseclib

Then create custom form for store the SFTP credentials and SFTP file button.

Below I have added the custom form code for your reference.

namespace Drupal\custom_module\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use phpseclib3\Net\SFTP;
use Symfony\Component\Finder\Finder;

/**
 * Class SftpForm.
 */
class SftpForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'sftp_form.sftp',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'sftp_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->config('sftp_form.sftp');
    $form = parent::buildForm($form, $form_state);
    $form['ip'] = [
      '#type' => 'textfield',
      '#title' => $this->t('IP'),
      '#maxlength' => 128,
      '#size' => 64,
      '#default_value' => $config->get('ip'),
      '#required' => TRUE,
    ];
    $form['port'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Port'),
      '#maxlength' => 20,
      '#size' => 10,
      '#default_value' => $config->get('port') == '' ? '22' : $config->get('port'),
      '#required' => TRUE,
    ];
    $form['username'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Username'),
      '#maxlength' => 64,
      '#size' => 64,
      '#default_value' => $config->get('username'),
      '#required' => TRUE,
    ];
    $form['password'] = [
      '#type' => 'password',
      '#title' => $this->t('Password'),
      '#maxlength' => 64,
      '#size' => 64,
      '#default_value' => $config->get('password'),
      '#required' => TRUE,
    ];
    $form['source_path'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Source path'),
      '#maxlength' => 128,
      '#size' => 64,
      '#default_value' => $config->get('source_path') == '' ? '/var/www/html/html' : $config->get('source_path'),
      '#required' => TRUE,
    ];
    $form['destination_path'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Destination path'),
      '#maxlength' => 128,
      '#size' => 64,
      '#default_value' => $config->get('destination_path') == '' ? '/var/www/html/' : $config->get('destination_path'),
      '#required' => TRUE,
    ];

    $form['actions']['submit']['#value'] = $this->t('Save SFTP settings');
    $form['actions']['upload_sftp'] = [
      '#type' => 'submit',
      '#value' => $this->t('Upload static HTML'),
      '#submit' => ['::uploadSFTPHandler'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);

    $this->config('sftp_form.sftp')
      ->set('ip', $form_state->getValue('ip'))
      ->set('port', $form_state->getValue('port'))
      ->set('username', $form_state->getValue('username'))
      ->set('password', empty($form_state->getValue('password')) ? $this->config('sftp_form.sftp')->get('password') : $form_state->getValue('password'))
      ->set('source_path', $form_state->getValue('source_path'))
      ->set('destination_path', $form_state->getValue('destination_path'))
      ->save();
  }

  /**
   * Custom submit handler for SFTP.
   */
  public function uploadSFTPHandler(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);

    // Push to SFTP server.
    // connection parameters
    $host = $this->config('sftp_form.sftp')->get('ip');
    $port = $this->config('sftp_form.sftp')->get('port');
    $username = $this->config('sftp_form.sftp')->get('username');
    $password = $this->config('sftp_form.sftp')->get('password');
    //Connect to SFTP host
    $sftp = new SFTP($host, $port);
    try {
      if ($sftp->login($username, $password)) {
        //directory path to source and destination
        $localDirectory = $this->config('sftp_form.sftp')->get('source_path');
        $remoteDirectory = $this->config('sftp_form.sftp')->get('destination_path');
        
        // Delete exiting content.
        $sftp->delete($remoteDirectory, true);

        $finder = new Finder();
        // Directory management.
        $directories = $finder
          ->directories()
          ->in($localDirectory);

        foreach ($directories as $directory) {
          $from = $directory->getRealPath();
          $to = str_replace($localDirectory, '', $from);
          $to = rtrim($remoteDirectory, '/') . '/' . ltrim($to, '/');
          $sftp->mkdir($to);
        }
        // File upload from source to remote.
        $files = $finder
          ->files()
          ->in($localDirectory);
        foreach ($files as $file) {
          $from = $file->getRealPath();
          $to = str_replace($localDirectory, '', $from);
          $to = rtrim($remoteDirectory, '/') . '/' . ltrim($to, '/');
          $sftp->put($to, $from,  SFTP::SOURCE_LOCAL_FILE);
        }
        \Drupal::messenger()->addStatus(t('Files uploaded.'));
        }
    } catch (\Exception $e) {
      \Drupal::logger('SFTP')->error($e->getMessage());
      \Drupal::messenger()->addError($e->getMessage());
    }
  }

}

Small explanation for the above code.

I have uploaded the files form ${SOURCE}/var/www/html/html to /var/www/html using SFTP, and above code will upload all the subfolders and files to destination folder. It is also cleanup destination directory.

For your reference PHPSeclib docs

SFTP login

use phpseclib3\Net\SFTP;

$sftp = new SFTP('localhost');
$sftp->login('username', 'password');

SFTP Upload File

// puts a three-byte file named filename.remote on the SFTP server
$sftp->put('filename.remote', 'xxx');
// puts an x-byte file named filename.remote on the SFTP server,
// where x is the size of filename.local
$sftp->put('filename.remote', 'filename.local', SFTP::SOURCE_LOCAL_FILE);

Reference

https://phpseclib.com/docs/sftp

File upload using SFTP in Drupal's custom form (PHPSeclib library)

Small explanation for the above code.

For your reference PHPSeclib docs

Tags