class Clipboard in FileField Sources 8

A FileField source plugin to allow transfer of files through the clipboard.

Plugin annotation

@FilefieldSource(
  id = "clipboard",
  name = @Translation("Paste from clipboard (<a href=""http://drupal.org/node/1775902"">limited browser support</a>)"),
  label = @Translation("Clipboard"),
  description = @Translation("Allow users to paste a file directly from the clipboard."),
  weight = 1
)

Hierarchy

• class \Drupal\filefield_sources\Plugin\FilefieldSource\Clipboard implements FilefieldSourceInterface

2 string references to 'Clipboard'

FileFieldSourcesTestBase::enableSources in tests/src/Functional/FileFieldSourcesTestBase.php

Enable file field sources.

filefield_sources.source.clipboard.schema.yml in config/schema/filefield_sources.source.clipboard.schema.yml

config/schema/filefield_sources.source.clipboard.schema.yml

File

src/Plugin/FilefieldSource/Clipboard.php, line 23

Namespace

Drupal\filefield_sources\Plugin\FilefieldSource

class Clipboard implements FilefieldSourceInterface {

  /**
   * {@inheritdoc}
   */
  public static function value(array &$element, &$input, FormStateInterface $form_state) {
    if (isset($input['filefield_clipboard']['contents']) && strlen($input['filefield_clipboard']['contents']) > 0) {

      // 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)) {
        $url = $input['filefield_clipboard']['filename'];
        \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;
      }

      // Split the file information in mimetype and base64 encoded binary.
      $base64_data = $input['filefield_clipboard']['contents'];
      $comma_position = strpos($base64_data, ',');
      $semicolon_position = strpos($base64_data, ';');
      $file_contents = base64_decode(substr($base64_data, $comma_position + 1));
      $mimetype = substr($base64_data, 5, $semicolon_position - 5);
      $extension = \Drupal::service('file.mime_type.guesser.extension')
        ->convertMimeTypeToExtension($mimetype);
      $filename = trim($input['filefield_clipboard']['filename']);
      $filename = preg_replace('/\\.[a-z0-9]{3,4}$/', '', $filename);
      $filename = (empty($filename) ? 'paste_' . REQUEST_TIME : $filename) . '.' . $extension;
      $filepath = \Drupal::service('file_system')
        ->createFilename($filename, $temporary_directory);
      $copy_success = FALSE;
      if ($fp = @fopen($filepath, 'w')) {
        fwrite($fp, $file_contents);
        fclose($fp);
        $copy_success = TRUE;
      }
      if ($copy_success && ($file = filefield_sources_save_file($filepath, $element['#upload_validators'], $element['#upload_location']))) {
        if (!in_array($file
          ->id(), $input['fids'])) {
          $input['fids'][] = $file
            ->id();
        }
      }

      // Remove the temporary file generated from paste.
      @unlink($filepath);
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function process(array &$element, FormStateInterface $form_state, array &$complete_form) {
    $element['filefield_clipboard'] = [
      '#weight' => 100.5,
      '#theme' => 'filefield_sources_element',
      '#source_id' => 'clipboard',
      // Required for proper theming.
      '#filefield_source' => TRUE,
      '#filefield_sources_hint_text' => t('Enter filename then paste.'),
      '#description' => filefield_sources_element_validation_help($element['#upload_validators']),
    ];
    $element['filefield_clipboard']['capture'] = [
      '#type' => 'item',
      '#markup' => '<div class="filefield-source-clipboard-capture" contenteditable="true"><span class="hint">example_filename.png</span></div> <span class="hint">' . t('ctrl + v') . '</span>',
      '#description' => t('Enter a file name and paste an image from the clipboard. This feature only works in <a href="http://drupal.org/node/1775902">limited browsers</a>.'),
    ];
    $element['filefield_clipboard']['filename'] = [
      '#type' => 'hidden',
      '#attributes' => [
        'class' => [
          'filefield-source-clipboard-filename',
        ],
      ],
    ];
    $element['filefield_clipboard']['contents'] = [
      '#type' => 'hidden',
      '#attributes' => [
        'class' => [
          'filefield-source-clipboard-contents',
        ],
      ],
    ];
    $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' => 'throbber',
        'message' => t('Transfering file...'),
      ],
    ];
    $element['filefield_clipboard']['upload'] = [
      '#name' => implode('_', $element['#parents']) . '_clipboard_upload_button',
      '#type' => 'submit',
      '#value' => t('Upload'),
      '#attributes' => [
        'class' => [
          'js-hide',
        ],
      ],
      '#validate' => [],
      '#submit' => [
        'filefield_sources_field_submit',
      ],
      '#limit_validation_errors' => [
        $element['#parents'],
      ],
      '#ajax' => $ajax_settings,
    ];
    return $element;
  }

  /**
   * Theme the output of the clipboard element.
   */
  public static function element($variables) {
    $element = $variables['element'];
    $output = '';
    foreach (Element::children($element) as $key) {
      if (!empty($element[$key])) {
        $output .= \Drupal::service('renderer')
          ->render($element[$key]);
      }
    }
    return '<div class="filefield-source filefield-source-clipboard clear-block">' . $output . '</div>';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Clipboard::element	public static	function	Theme the output of the clipboard element.
Clipboard::process	public static	function	Process callback for file field source plugin. Overrides FilefieldSourceInterface::process
Clipboard::value	public static	function	Value callback for file field source plugin. Overrides FilefieldSourceInterface::value