class Local

Defines the local connection class for copying files as the httpd user.

Hierarchy

Expanded class hierarchy of Local

1 file declares its use of Local
update.manager.inc in drupal/core/modules/update/update.manager.inc
Administrative screens and processing functions of the Update Manager module.

File

drupal/core/lib/Drupal/Core/FileTransfer/Local.php, line 16
Definition of Drupal\Core\FileTransfer\Local.

Namespace

Drupal\Core\FileTransfer
View source
class Local extends FileTransfer implements ChmodInterface {

  /**
   * Implements Drupal\Core\FileTransfer\FileTransfer::connect().
   */
  function connect() {

    // No-op
  }

  /**
   * Overrides Drupal\Core\FileTransfer\FileTransfer::factory().
   */
  static function factory($jail, $settings) {
    return new Local($jail);
  }

  /**
   * Implements Drupal\Core\FileTransfer\FileTransfer::copyFileJailed().
   */
  protected function copyFileJailed($source, $destination) {
    if (@(!copy($source, $destination))) {
      throw new FileTransferException('Cannot copy %source to %destination.', NULL, array(
        '%source' => $source,
        '%destination' => $destination,
      ));
    }
  }

  /**
   * Implements Drupal\Core\FileTransfer\FileTransfer::createDirectoryJailed().
   */
  protected function createDirectoryJailed($directory) {
    if (!is_dir($directory) && @(!mkdir($directory, 0777, TRUE))) {
      throw new FileTransferException('Cannot create directory %directory.', NULL, array(
        '%directory' => $directory,
      ));
    }
  }

  /**
   * Implements Drupal\Core\FileTransfer\FileTransfer::removeDirectoryJailed().
   */
  protected function removeDirectoryJailed($directory) {
    if (!is_dir($directory)) {

      // Programmer error assertion, not something we expect users to see.
      throw new FileTransferException('removeDirectoryJailed() called with a path (%directory) that is not a directory.', NULL, array(
        '%directory' => $directory,
      ));
    }
    foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($directory, RecursiveDirectoryIterator::SKIP_DOTS), RecursiveIteratorIterator::CHILD_FIRST) as $filename => $file) {
      if ($file
        ->isDir()) {
        if (@(!drupal_rmdir($filename))) {
          throw new FileTransferException('Cannot remove directory %directory.', NULL, array(
            '%directory' => $filename,
          ));
        }
      }
      elseif ($file
        ->isFile()) {
        if (@(!drupal_unlink($filename))) {
          throw new FileTransferException('Cannot remove file %file.', NULL, array(
            '%file' => $filename,
          ));
        }
      }
    }
    if (@(!drupal_rmdir($directory))) {
      throw new FileTransferException('Cannot remove directory %directory.', NULL, array(
        '%directory' => $directory,
      ));
    }
  }

  /**
   * Implements Drupal\Core\FileTransfer\FileTransfer::removeFileJailed().
   */
  protected function removeFileJailed($file) {
    if (@(!drupal_unlink($file))) {
      throw new FileTransferException('Cannot remove file %file.', NULL, array(
        '%file' => $file,
      ));
    }
  }

  /**
   * Implements Drupal\Core\FileTransfer\FileTransfer::isDirectory().
   */
  public function isDirectory($path) {
    return is_dir($path);
  }

  /**
   * Implements Drupal\Core\FileTransfer\FileTransfer::isFile().
   */
  public function isFile($path) {
    return is_file($path);
  }

  /**
   * Implements Drupal\Core\FileTransfer\ChmodInterface::chmodJailed().
   */
  public function chmodJailed($path, $mode, $recursive) {
    if ($recursive && is_dir($path)) {
      foreach (new RecursiveIteratorIterator(new RecursiveDirectoryIterator($path, RecursiveDirectoryIterator::SKIP_DOTS), RecursiveIteratorIterator::SELF_FIRST) as $filename => $file) {
        if (@(!chmod($filename, $mode))) {
          throw new FileTransferException('Cannot chmod %path.', NULL, array(
            '%path' => $filename,
          ));
        }
      }
    }
    elseif (@(!chmod($path, $mode))) {
      throw new FileTransferException('Cannot chmod %path.', NULL, array(
        '%path' => $path,
      ));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FileTransfer::$hostname protected property The hostname for this file transfer.
FileTransfer::$password protected property The password for this file transfer. 1
FileTransfer::$port protected property The port for this file transfer. 1
FileTransfer::$username protected property The username for this file transfer. 1
FileTransfer::checkPath final protected function Checks that the path is inside the jail and throws an exception if not.
FileTransfer::chmod final public function Changes the permissions of the specified $path (file or directory).
FileTransfer::copyDirectory final public function Copies a directory.
FileTransfer::copyDirectoryJailed protected function Copies a directory. 1
FileTransfer::copyFile final public function Copies a file.
FileTransfer::createDirectory final public function Creates a directory.
FileTransfer::findChroot function Returns the chroot property for this connection.
FileTransfer::fixRemotePath final protected function Returns a modified path suitable for passing to the server.
FileTransfer::getSettingsForm public function Returns a form to collect connection settings credentials. 2
FileTransfer::removeDirectory final public function Removes a directory.
FileTransfer::removeFile final public function Removes a file.
FileTransfer::sanitizePath function Changes backslashes to slashes, also removes a trailing slash.
FileTransfer::setChroot function Sets the chroot and changes the jail to match the correct path scheme.
FileTransfer::__construct function Constructs a Drupal\Core\FileTransfer\FileTransfer object. 3
FileTransfer::__get function Implements the magic __get() method.
Local::chmodJailed public function Implements Drupal\Core\FileTransfer\ChmodInterface::chmodJailed(). Overrides ChmodInterface::chmodJailed
Local::connect function Implements Drupal\Core\FileTransfer\FileTransfer::connect(). Overrides FileTransfer::connect
Local::copyFileJailed protected function Implements Drupal\Core\FileTransfer\FileTransfer::copyFileJailed(). Overrides FileTransfer::copyFileJailed
Local::createDirectoryJailed protected function Implements Drupal\Core\FileTransfer\FileTransfer::createDirectoryJailed(). Overrides FileTransfer::createDirectoryJailed
Local::factory static function Overrides Drupal\Core\FileTransfer\FileTransfer::factory(). Overrides FileTransfer::factory
Local::isDirectory public function Implements Drupal\Core\FileTransfer\FileTransfer::isDirectory(). Overrides FileTransfer::isDirectory
Local::isFile public function Implements Drupal\Core\FileTransfer\FileTransfer::isFile(). Overrides FileTransfer::isFile
Local::removeDirectoryJailed protected function Implements Drupal\Core\FileTransfer\FileTransfer::removeDirectoryJailed(). Overrides FileTransfer::removeDirectoryJailed
Local::removeFileJailed protected function Implements Drupal\Core\FileTransfer\FileTransfer::removeFileJailed(). Overrides FileTransfer::removeFileJailed