Some cleanup, added remove archive in form, reformat validation we now have a trait

Author: Milos Dencev

file_entity.module

@@ -83,16 +83,6 @@ function file_entity_help($route_name, RouteMatchInterface $route_match) {
  * Implements hook_menu().
  */
 function file_entity_menu() {
-  $items['file/add/upload/archive'] = array(
-    'title' => 'Archive',
-    'page callback' => 'drupal_get_form',
-    'page arguments' => array('file_entity_upload_archive_form'),
-    'access arguments' => array('administer files'),
-    'file' => 'file_entity.pages.inc',
-    'type' => MENU_LOCAL_TASK,
-    'weight' => -5,
-  );
-
   // Optional devel module integration
   if (\Drupal::moduleHandler()->moduleExists('devel')) {
     if (\Drupal::moduleHandler()->moduleExists('token')) {

file_entity.routing.yml

@@ -77,16 +77,6 @@ file_entity.file_add_upload_file:
   options:
     _admin_route: TRUE
 
-file_entity.file_add_upload_archive:
-  path: /file/add/upload/archive
-  defaults:
-    _controller: '\Drupal\file_entity\Controller\FileController::FileAddUploadArchive'
-    _title: 'Archive'
-  requirements:
-    _permission: 'administer files'
-  options:
-    _admin_route: TRUE
-
 entity.file.canonical:
   path: /file/{file}
   defaults:
@@ -146,10 +136,10 @@ file_entity.settings:
     _permission: 'administer files'
 
 file_entity.file_add_archive_form:
-  path: /file/add/upload/archive
+  path: admin/content/files/archive
   defaults:
     _form: '\Drupal\file_entity\Form\FileAddArchiveForm'
-    _title: 'Add files'
+    _title: 'Upload archive'
   requirements:
     _permission: 'administer files'
   options:

src/Controller/FileController.php

@@ -36,13 +36,6 @@ public function FileAddUploadFile() {
 
   }
 
-  /**
-   * Archive
-   */
-  public function FileAddUploadArchive() {
-
-  }
-
   /**
    * Usage
    *

src/Form/FileAddArchiveForm.php

@@ -12,14 +12,15 @@
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Component\Utility\Bytes;
 use Drupal\file\Entity\File;
+use Drupal\file_entity\UploadValidatorsTrait;
 
 /**
- * Class FileAddArchiveForm.
- *
- * @package Drupal\file_entity\Form
+ * Form controller for archive type forms.
  */
 class FileAddArchiveForm extends FormBase {
 
+  use UploadValidatorsTrait;
+
   /**
    * {@inheritdoc}
    */
@@ -31,27 +32,38 @@ public function getFormId() {
    * {@inheritdoc}
    */
   public function buildForm(array $form, FormStateInterface $form_state) {
-    $validators = $this->getUploadValidators($form_state->get('options'));
+    $options = [
+      'file_extensions' => archiver_get_extensions(),
+    ];
+    $options = $form_state->get('options') ? $form_state->get('options') : $options;
+    $validators = $this->getUploadValidators($options);
 
     $form['upload'] = array(
       '#type' => 'managed_file',
       '#title' => $this->t('Upload an archive file'),
-      '#upload_location' => NULL,
+      '#upload_location' => 'public://',
       '#progress_indicator' => 'bar',
       '#default_value' => $form_state->has('file') ? array($form_state->get('file')->id()) : NULL,
       '#required' => TRUE,
-      '#description' => 'Files must be less than <strong>' . format_size($validators['file_validate_size'][0]) . '</strong><br> Allowed file types: <strong>' . $validators['file_validate_extensions'][0] . '</strong>',
+      '#description' => $this->t('Files must be less than <strong>' . format_size($validators['file_validate_size'][0]) . '</strong><br> Allowed file types: <strong>' . $validators['file_validate_extensions'][0] . '</strong>'),
       '#upload_validators' => $validators,
     );
 
     $form['pattern'] = array(
       '#type' => 'textfield',
       '#title' => $this->t('Pattern'),
-      '#description' => $this->t('Only files matching this pattern will be imported. For example, to import all jpg and gif files, the pattern would be <em>*.jpg|*.gif</em>. Use <em>.*</em> to extract all files in the archive.'),
+      '#description' => $this->t('Only files matching this pattern will be imported. For example, to import all jpg and gif files, the pattern would be <strong>.*jpg|.*gif</strong>. Use <strong>.*</strong> to extract all files in the archive.'),
       '#default_value' => '.*',
       '#required' => TRUE,
     );
 
+    $form['remove_archive'] = array(
+      '#type' => 'checkbox',
+      '#title' => $this->t('Remove archive'),
+      '#description' => $this->t('Removes archive after extraction.'),
+      '#default_value' => FALSE,
+    );
+
     $form['actions'] = array('#type' => 'actions');
     $form['actions']['submit'] = array(
       '#type' => 'submit',
@@ -91,62 +103,28 @@ public function submitForm(array &$form, FormStateInterface $form_state) {
             ]);
             $file->save();
           }
+          $all_files = file_scan_directory($extract_dir, '/.*/');
+          // Get all files that don't match the pattern so we can remove them.
+          $remainig_files = array_diff_key($all_files, $files);
+          foreach ($remainig_files as $file) {
+            drupal_unlink($file->uri);
+          }
         }
         drupal_set_message($this->t('Extracted %file and added @count new files.', array('%file' => $archive->getFilename(), '@count' => count($files))));
+        if ($form_state->getValue('remove_archive')) {
+          drupal_set_message($this->t('Removed archive.'));
+          $archive->delete();
+        }
+        else {
+          $archive->setPermanent();
+          $archive->save();
+        }
       }
       else {
-        throw new \Exception(t('Cannot extract %file, not a valid archive.', array('%file' => $archive->getFileUri())));
+        $form_state->setErrorByName('', $this->t('Cannot extract %file, not a valid archive.', array('%file' => $archive->getFileUri())));
       }
     }
     $this->redirect('entity.file.collection')->send();
   }
 
-  /**
-   * Retrieves the upload validators for a file.
-   *
-   * @param array $options
-   *   (optional) An array of options for file validation.
-   *
-   * @return array
-   *   An array suitable for passing to file_save_upload() or for a managed_file
-   *   or upload element's '#upload_validators' property.
-   */
-  public function getUploadValidators(array $options = array()) {
-    // Set up file upload validators.
-    $validators = array();
-
-    // Validate file extensions. If there are no file extensions in $params and
-    // there are no Media defaults, there is no file extension validation.
-    if (!empty($options['file_extensions'])) {
-      $validators['file_validate_extensions'] = array($options['file_extensions']);
-    }
-    else {
-      $validators['file_validate_extensions'] = array(archiver_get_extensions());
-    }
-
-    // Cap the upload size according to the system or user defined limit.
-    $max_filesize = file_upload_max_size();
-    $user_max_filesize = Bytes::toInt(\Drupal::config('file_entity.settings')
-      ->get('max_filesize'));
-
-    // If the user defined a size limit, use the smaller of the two.
-    if (!empty($user_max_filesize)) {
-      $max_filesize = min($max_filesize, $user_max_filesize);
-    }
-
-    if (!empty($options['max_filesize']) && $options['max_filesize'] < $max_filesize) {
-      $max_filesize = Bytes::toInt($options['max_filesize']);
-    }
-
-    // There is always a file size limit due to the PHP server limit.
-    $validators['file_validate_size'] = array($max_filesize);
-
-    // Add other custom upload validators from options.
-    if (!empty($options['upload_validators'])) {
-      $validators += $options['upload_validators'];
-    }
-
-    return $validators;
-  }
-
 }

src/Form/FileAddForm.php

@@ -17,12 +17,15 @@
 use Drupal\file\Entity\File;
 use Drupal\file\FileInterface;
 use Drupal\file_entity\Entity\FileType;
+use Drupal\file_entity\UploadValidatorsTrait;
 
 /**
  * Form controller for file type forms.
  */
 class FileAddForm extends FormBase {
 
+  use UploadValidatorsTrait;
+
   /**
    * Returns a unique string identifying the form.
    *
@@ -71,11 +74,18 @@ public function buildForm(array $form, FormStateInterface $form_state, array $op
    *   Returns form data
    */
   function stepUpload(array $form, FormStateInterface $form_state) {
+    $options = [
+      'file_extensions' => \Drupal::config('file_entity.settings')
+        ->get('default_allowed_extensions'),
+    ];
+    $options = $form_state->get('options') ? $form_state->get('options') : $options;
+    $validators = $this->getUploadValidators($options);
+
     $form['upload'] = array(
       '#type' => 'managed_file',
       '#title' => t('Upload a new file'),
       '#upload_location' => $this->getUploadDestinationUri($form_state->get('options')),
-      '#upload_validators' => $this->getUploadValidators($form_state->get('options')),
+      '#upload_validators' => $validators,
       '#progress_indicator' => 'bar',
       '#required' => TRUE,
       '#default_value' => $form_state->has('file') ? array($form_state->get('file')->id()) : NULL,
@@ -124,66 +134,6 @@ function getUploadDestinationUri(array $params, array $data = array()) {
     return $params['uri_scheme'] . '://' . $destination;
   }
 
-  /**
-   * Retrieves the upload validators for a file.
-   *
-   * @param array $options
-   *   (optional) An array of options for file validation.
-   *
-   * @return array
-   *   An array suitable for passing to file_save_upload() or for a managed_file
-   *   or upload element's '#upload_validators' property.
-   */
-  public static function getUploadValidators(array $options = array()) {
-    // Set up file upload validators.
-    $validators = array();
-
-    // Validate file extensions. If there are no file extensions in $params and
-    // there are no Media defaults, there is no file extension validation.
-    if (!empty($options['file_extensions'])) {
-      $validators['file_validate_extensions'] = array($options['file_extensions']);
-    }
-    else {
-      $validators['file_validate_extensions'] = array(
-        \Drupal::config('file_entity.settings')
-          ->get('default_allowed_extensions')
-      );
-    }
-
-    // Cap the upload size according to the system or user defined limit.
-    $max_filesize = Bytes::toInt(file_upload_max_size());
-    $user_max_filesize = Bytes::toInt(\Drupal::config('file_entity.settings')
-      ->get('max_filesize'));
-
-    // If the user defined a size limit, use the smaller of the two.
-    if (!empty($user_max_filesize)) {
-      $max_filesize = min($max_filesize, $user_max_filesize);
-    }
-
-    if (!empty($options['max_filesize']) && $options['max_filesize'] < $max_filesize) {
-      $max_filesize = Bytes::toInt($options['max_filesize']);
-    }
-
-    // There is always a file size limit due to the PHP server limit.
-    $validators['file_validate_size'] = array($max_filesize);
-
-    // Add image validators.
-    $options += array('min_resolution' => 0, 'max_resolution' => 0);
-    if ($options['min_resolution'] || $options['max_resolution']) {
-      $validators['file_validate_image_resolution'] = array(
-        $options['max_resolution'],
-        $options['min_resolution']
-      );
-    }
-
-    // Add other custom upload validators from options.
-    if (!empty($options['upload_validators'])) {
-      $validators += $options['upload_validators'];
-    }
-
-    return $validators;
-  }
-
   /**
    * Form Step 2
    * Select file types.

src/UploadValidatorsTrait.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * @file
+ * Contains \Drupal\file_entity\UploadValidatorsTrait.
+ */
+
+namespace Drupal\file_entity;
+
+use Drupal\Component\Utility\Bytes;
+
+/**
+ * Trait for validating form uploads.
+ */
+trait UploadValidatorsTrait {
+
+  /**
+   * Retrieves the upload validators for a file or archive.
+   *
+   * @param array $options
+   *   (optional) An array of options for file validation.
+   *
+   * @return array
+   *   An array suitable for passing to file_save_upload() or for a managed_file
+   *   or upload element's '#upload_validators' property.
+   */
+  public function getUploadValidators(array $options = array()) {
+    // Set up file upload validators.
+    $validators = array();
+
+    // Validate file extensions. If there are no file extensions in $params and
+    // there are no Media defaults, there is no file extension validation.
+    if (!empty($options['file_extensions'])) {
+      $validators['file_validate_extensions'] = array($options['file_extensions']);
+    }
+
+    // Cap the upload size according to the system or user defined limit.
+    $max_filesize = file_upload_max_size();
+    $user_max_filesize = Bytes::toInt(\Drupal::config('file_entity.settings')
+      ->get('max_filesize'));
+
+    // If the user defined a size limit, use the smaller of the two.
+    if (!empty($user_max_filesize)) {
+      $max_filesize = min($max_filesize, $user_max_filesize);
+    }
+
+    if (!empty($options['max_filesize']) && $options['max_filesize'] < $max_filesize) {
+      $max_filesize = Bytes::toInt($options['max_filesize']);
+    }
+
+    // There is always a file size limit due to the PHP server limit.
+    $validators['file_validate_size'] = array($max_filesize);
+
+    // Add image validators.
+    if ($options['min_resolution'] || $options['max_resolution']) {
+      $validators['file_validate_image_resolution'] = array(
+        $options['max_resolution'],
+        $options['min_resolution'],
+      );
+    }
+
+    // Add other custom upload validators from options.
+    if (!empty($options['upload_validators'])) {
+      $validators += $options['upload_validators'];
+    }
+
+    return $validators;
+  }
+
+}