class Remote in FileField Sources 8

A FileField source plugin to allow downloading a file from a remote server.

Plugin annotation


@FilefieldSource(
  id = "remote",
  name = @Translation("Remote URL textfield"),
  label = @Translation("Remote URL"),
  description = @Translation("Download a file from a remote server.")
)

Hierarchy

class \Drupal\filefield_sources\Plugin\FilefieldSource\Remote implements FilefieldSourceInterface

Expanded class hierarchy of Remote

File

src/Plugin/FilefieldSource/Remote.php, line 26

Namespace

Drupal\filefield_sources\Plugin\FilefieldSource

View source

class Remote implements FilefieldSourceInterface {

  /**
   * {@inheritdoc}
   */
  public static function value(array &$element, &$input, FormStateInterface $form_state) {
    if (isset($input['filefield_remote']['url']) && strlen($input['filefield_remote']['url']) > 0 && UrlHelper::isValid($input['filefield_remote']['url']) && $input['filefield_remote']['url'] != FILEFIELD_SOURCE_REMOTE_HINT_TEXT) {
      $field = \Drupal::entityTypeManager()
        ->getStorage('field_config')
        ->load($element['#entity_type'] . '.' . $element['#bundle'] . '.' . $element['#field_name']);
      $url = $input['filefield_remote']['url'];

      // Check that the destination is writable.
      $temporary_directory = 'temporary://';
      if (!\Drupal::service('file_system')
        ->prepareDirectory($temporary_directory, FileSystemInterface::MODIFY_PERMISSIONS)) {
        \Drupal::logger('filefield_sources')
          ->log(E_NOTICE, 'The directory %directory is not writable, because it does not have the correct permissions set.', [
          '%directory' => \Drupal::service('file_system')
            ->realpath($temporary_directory),
        ]);
        \Drupal::messenger()
          ->addError(t('The file could not be transferred because the temporary directory is not writable.'), 'error');
        return;
      }

      // Check that the destination is writable.
      $directory = $element['#upload_location'];
      $mode = Settings::get('file_chmod_directory', FileSystem::CHMOD_DIRECTORY);

      // This first chmod check is for other systems such as S3, which don't
      // work with file_prepare_directory().
      if (!\Drupal::service('file_system')
        ->chmod($directory, $mode) && !\Drupal::service('file_system')
        ->prepareDirectory($directory, FileSystemInterface::CREATE_DIRECTORY)) {
        \Drupal::logger('filefield_sources')
          ->log(E_NOTICE, 'File %file could not be copied, because the destination directory %destination is not configured correctly.', [
          '%file' => $url,
          '%destination' => \Drupal::service('file_system')
            ->realpath($directory),
        ]);
        \Drupal::messenger()
          ->addError(t('The specified file %file could not be copied, because the destination directory is not properly configured. This may be caused by a problem with file or directory permissions. More information is available in the system log.', [
          '%file' => $url,
        ]), 'error');
        return;
      }

      // Check the headers to make sure it exists and is within the allowed
      // size.
      $ch = curl_init();
      curl_setopt($ch, CURLOPT_URL, $url);
      curl_setopt($ch, CURLOPT_HEADER, TRUE);
      curl_setopt($ch, CURLOPT_NOBODY, TRUE);
      curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
      curl_setopt($ch, CURLOPT_HEADERFUNCTION, [
        get_called_class(),
        'parseHeader',
      ]);

      // Causes a warning if PHP safe mode is on.
      @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
      curl_exec($ch);
      $info = curl_getinfo($ch);
      if ($info['http_code'] != 200) {
        curl_setopt($ch, CURLOPT_HTTPGET, TRUE);
        $file_contents = curl_exec($ch);
        $info = curl_getinfo($ch);
      }
      curl_close($ch);
      if ($info['http_code'] != 200) {
        switch ($info['http_code']) {
          case 403:
            $form_state
              ->setError($element, t('The remote file could not be transferred because access to the file was denied.'));
            break;
          case 404:
            $form_state
              ->setError($element, t('The remote file could not be transferred because it was not found.'));
            break;
          default:
            $form_state
              ->setError($element, t('The remote file could not be transferred due to an HTTP error (@code).', [
              '@code' => $info['http_code'],
            ]));
        }
        return;
      }

      // Update the $url variable to reflect any redirects.
      $url = $info['url'];
      $url_info = parse_url($url);

      // Determine the proper filename by reading the filename given in the
      // Content-Disposition header. If the server fails to send this header,
      // fall back on the basename of the URL.
      //
      // We prefer to use the Content-Disposition header, because we can then
      // use URLs like http://example.com/get_file/23 which would otherwise be
      // rejected because the URL basename lacks an extension.

      /** @var \Drupal\Core\File\FileSystem $filesystem */
      $filesystem = \Drupal::service('file_system');
      $filename = static::filename();
      if (empty($filename)) {
        $filename = rawurldecode($filesystem
          ->basename($url_info['path']));
      }
      $filename = \Drupal::transliteration()
        ->transliterate($filename);
      $pathinfo = pathinfo($filename);

      // Create the file extension from the MIME header if all else has failed.
      if (empty($pathinfo['extension']) && ($extension = static::mimeExtension())) {
        $filename = $filename . '.' . $extension;
        $pathinfo = pathinfo($filename);
      }
      $filename = filefield_sources_clean_filename($filename, $field
        ->getSetting('file_extensions'));
      $filepath = \Drupal::service('file_system')
        ->createFilename($filename, $temporary_directory);
      if (empty($pathinfo['extension'])) {
        $form_state
          ->setError($element, t('The remote URL must be a file and have an extension.'));
        return;
      }

      // Perform basic extension check on the file before trying to transfer.
      $extensions = $field
        ->getSetting('file_extensions');
      $regex = '/\\.(' . preg_replace('/[ +]/', '|', preg_quote($extensions)) . ')$/i';
      if (!empty($extensions) && !preg_match($regex, $filename)) {
        $form_state
          ->setError($element, t('Only files with the following extensions are allowed: %files-allowed.', [
          '%files-allowed' => $extensions,
        ]));
        return;
      }

      // Check file size based off of header information.
      if (!empty($element['#upload_validators']['file_validate_size'][0])) {
        $max_size = $element['#upload_validators']['file_validate_size'][0];
        $file_size = $info['download_content_length'];
        if ($file_size > $max_size) {
          $form_state
            ->setError($element, t('The remote file is %filesize exceeding the maximum file size of %maxsize.', [
            '%filesize' => format_size($file_size),
            '%maxsize' => format_size($max_size),
          ]));
          return;
        }
      }

      // Set progress bar information.
      $options = [
        'key' => $element['#entity_type'] . '_' . $element['#bundle'] . '_' . $element['#field_name'] . '_' . $element['#delta'],
        'filepath' => $filepath,
      ];
      static::setTransferOptions($options);
      $transfer_success = FALSE;

      // If we've already downloaded the entire file because the
      // header-retrieval failed, just ave the contents we have.
      if (isset($file_contents)) {
        if ($fp = @fopen($filepath, 'w')) {
          fwrite($fp, $file_contents);
          fclose($fp);
          $transfer_success = TRUE;
        }
      }
      else {
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $url);
        curl_setopt($ch, CURLOPT_HEADER, FALSE);
        curl_setopt($ch, CURLOPT_WRITEFUNCTION, [
          get_called_class(),
          'curlWrite',
        ]);

        // Causes a warning if PHP safe mode is on.
        @curl_setopt($ch, CURLOPT_FOLLOWLOCATION, TRUE);
        $transfer_success = curl_exec($ch);
        curl_close($ch);
      }
      if ($transfer_success && ($file = filefield_sources_save_file($filepath, $element['#upload_validators'], $element['#upload_location']))) {
        if (!in_array($file
          ->id(), $input['fids'])) {
          $input['fids'][] = $file
            ->id();
        }
      }

      // Delete the temporary file.
      @unlink($filepath);
    }
  }

  /**
   * Set a transfer key that can be retreived by the progress function.
   */
  protected static function setTransferOptions($options = NULL) {
    static $current = FALSE;
    if (isset($options)) {
      $current = $options;
    }
    return $current;
  }

  /**
   * Get a transfer key that can be retrieved by the progress function.
   */
  protected static function getTransferOptions() {
    return static::setTransferOptions();
  }

  /**
   * Save the file to disk. Also updates progress bar.
   */
  protected static function curlWrite(&$ch, $data) {
    $progress_update = 0;
    $options = static::getTransferOptions();

    // Get the current progress and update the progress value.
    // Only update every 64KB to reduce Drupal::cache()->set() calls.
    // cURL usually writes in 16KB chunks.
    if (curl_getinfo($ch, CURLINFO_SIZE_DOWNLOAD) / 65536 > $progress_update) {
      $progress_update++;
      $progress = [
        'current' => curl_getinfo($ch, CURLINFO_SIZE_DOWNLOAD),
        'total' => curl_getinfo($ch, CURLINFO_CONTENT_LENGTH_DOWNLOAD),
      ];

      // Set a cache so that we can retrieve this value from the progress bar.
      $cid = 'filefield_transfer:' . session_id() . ':' . $options['key'];
      if ($progress['current'] != $progress['total']) {
        \Drupal::cache()
          ->set($cid, $progress, time() + 300);
      }
      else {
        \Drupal::cache()
          ->delete($cid);
      }
    }
    $data_length = 0;
    if ($fp = @fopen($options['filepath'], 'a')) {
      fwrite($fp, $data);
      fclose($fp);
      $data_length = strlen($data);
    }
    return $data_length;
  }

  /**
   * Parse cURL header and record the filename specified in Content-Disposition.
   */
  protected static function parseHeader(&$ch, $header) {
    if (preg_match('/Content-Disposition:.*?filename="(.+?)"/', $header, $matches)) {

      // Content-Disposition: attachment; filename="FILE NAME HERE".
      static::filename($matches[1]);
    }
    elseif (preg_match('/Content-Disposition:.*?filename=([^; ]+)/', $header, $matches)) {

      // Content-Disposition: attachment; filename=file.ext.
      $uri = trim($matches[1]);
      static::filename($uri);
    }
    elseif (preg_match('/Content-Type:[ ]*([a-z0-9_\\-]+\\/[a-z0-9_\\-]+)/i', $header, $matches)) {
      $mime_type = $matches[1];
      static::mimeExtension($mime_type);
    }

    // This is required by cURL.
    return strlen($header);
  }

  /**
   * Get/set the remote file extension in a static variable.
   */
  protected static function mimeExtension($curl_mime_type = NULL) {
    static $extension = NULL;
    $mimetype = mb_strtolower($curl_mime_type);
    $result = \Drupal::service('file.mime_type.guesser.extension')
      ->convertMimeTypeToMostCommonExtension($mimetype);
    if ($result) {
      $extension = $result;
    }
    return $extension;
  }

  /**
   * Get/set the remote file name in a static variable.
   */
  protected static function filename($curl_filename = NULL) {
    static $filename = NULL;
    if (isset($curl_filename)) {
      $filename = $curl_filename;
    }
    return $filename;
  }

  /**
   * {@inheritdoc}
   */
  public static function process(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $element['filefield_remote'] = [
      '#weight' => 100.5,
      '#theme' => 'filefield_sources_element',
      '#source_id' => 'remote',
      // Required for proper theming.
      '#filefield_source' => TRUE,
      '#filefield_sources_hint_text' => FILEFIELD_SOURCE_REMOTE_HINT_TEXT,
    ];
    $element['filefield_remote']['url'] = [
      '#type' => 'textfield',
      '#description' => filefield_sources_element_validation_help($element['#upload_validators']),
      '#maxlength' => NULL,
    ];
    $class = '\\Drupal\\file\\Element\\ManagedFile';
    $ajax_settings = [
      'callback' => [
        $class,
        'uploadAjaxCallback',
      ],
      'options' => [
        'query' => [
          'element_parents' => implode('/', $element['#array_parents']),
        ],
      ],
      'wrapper' => $element['upload_button']['#ajax']['wrapper'],
      'effect' => 'fade',
      'progress' => [
        'type' => 'bar',
        'path' => 'file/remote/progress/' . $element['#entity_type'] . '/' . $element['#bundle'] . '/' . $element['#field_name'] . '/' . $element['#delta'],
        'message' => t('Starting transfer...'),
      ],
    ];
    $element['filefield_remote']['transfer'] = [
      '#name' => implode('_', $element['#parents']) . '_transfer',
      '#type' => 'submit',
      '#value' => t('Transfer'),
      '#validate' => [],
      '#submit' => [
        'filefield_sources_field_submit',
      ],
      '#limit_validation_errors' => [
        $element['#parents'],
      ],
      '#ajax' => $ajax_settings,
    ];
    return $element;
  }

  /**
   * Theme the output of the remote element.
   */
  public static function element($variables) {
    $element = $variables['element'];
    $element['url']['#field_suffix'] = \Drupal::service('renderer')
      ->render($element['transfer']);
    return '<div class="filefield-source filefield-source-remote clear-block">' . \Drupal::service('renderer')
      ->render($element['url']) . '</div>';
  }

  /**
   * Menu callback; progress.js callback to return upload progress.
   */
  public static function progress($entity_type, $bundle_name, $field_name, $delta) {
    $key = $entity_type . '_' . $bundle_name . '_' . $field_name . '_' . $delta;
    $progress = [
      'message' => t('Starting transfer...'),
      'percentage' => -1,
    ];
    if ($cache = \Drupal::cache()
      ->get('filefield_transfer:' . session_id() . ':' . $key)) {
      $current = $cache->data['current'];
      $total = $cache->data['total'];
      $progress['message'] = t('Transferring... (@current of @total)', [
        '@current' => format_size($current),
        '@total' => format_size($total),
      ]);
      $progress['percentage'] = round(100 * $current / $total);
    }
    return new JsonResponse($progress);
  }

  /**
   * Define routes for Remote source.
   *
   * @return array
   *   Array of routes.
   */
  public static function routes() {
    $routes = [];
    $routes['filefield_sources.remote'] = new Route('/file/remote/progress/{entity_type}/{bundle_name}/{field_name}/{delta}', [
      '_controller' => get_called_class() . '::progress',
    ], [
      '_access' => 'TRUE',
    ]);
    return $routes;
  }

  /**
   * Implements hook_filefield_source_settings().
   */
  public static function settings(WidgetInterface $plugin) {
    $return = [];

    // Add settings to the FileField widget form.
    if (!filefield_sources_curl_enabled()) {
      \Drupal::messenger()
        ->addError(t('<strong>Filefield sources:</strong> remote plugin will be disabled without php-curl extension.'), 'warning');
    }
    return $return;
  }

}

Members

Name	Modifiers	Type	Description
Remote::curlWrite	protected static	function	Save the file to disk. Also updates progress bar.
Remote::element	public static	function	Theme the output of the remote element.
Remote::filename	protected static	function	Get/set the remote file name in a static variable.
Remote::getTransferOptions	protected static	function	Get a transfer key that can be retrieved by the progress function.
Remote::mimeExtension	protected static	function	Get/set the remote file extension in a static variable.
Remote::parseHeader	protected static	function	Parse cURL header and record the filename specified in Content-Disposition.
Remote::process	public static	function	Process callback for file field source plugin. Overrides FilefieldSourceInterface::process
Remote::progress	public static	function	Menu callback; progress.js callback to return upload progress.
Remote::routes	public static	function	Define routes for Remote source.
Remote::settings	public static	function	Implements hook_filefield_source_settings().
Remote::setTransferOptions	protected static	function	Set a transfer key that can be retreived by the progress function.
Remote::value	public static	function	Value callback for file field source plugin. Overrides FilefieldSourceInterface::value

You are here

class Remote in FileField Sources 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation