You are here

Home » API reference » Opigno module 8 » AddExternalPackageForm.php

class AddExternalPackageForm in Opigno module 8

Same name and namespace in other branches
  1. 3.x src/Form/AddExternalPackageForm.php \Drupal\opigno_module\Form\AddExternalPackageForm

Add External package form.

Hierarchy

Expanded class hierarchy of AddExternalPackageForm

1 string reference to 'AddExternalPackageForm'
opigno_module.routing.yml in ./opigno_module.routing.yml
opigno_module.routing.yml

File

src/Form/AddExternalPackageForm.php, line 14

Namespace

Drupal\opigno_module\Form
View source 
class AddExternalPackageForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $mode = NULL) {
    $is_ppt = $mode && $mode == 'ppt' ? TRUE : FALSE;
    if ($is_ppt) {
      $form_state
        ->set('mode', $mode);
    }
    $form['name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Name'),
      '#required' => TRUE,
    ];
    $form['package'] = [
      '#title' => $this
        ->t('Package'),
      '#type' => 'file',
      '#description' => !$is_ppt ? $this
        ->t('Here you can upload external package. Allowed extensions: zip h5p') : $this
        ->t('Here you can upload PowerPoint presentation file. Allowed extensions: ppt pptx'),
    ];
    $ajax_id = "ajax-form-entity-external-package";
    $form['#attributes']['class'][] = $ajax_id;
    $form['#attached']['library'][] = 'opigno_module/ajax_form';
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Next'),
      '#ajax' => [
        'callback' => 'Drupal\\opigno_module\\Controller\\ExternalPackageController::ajaxFormExternalPackageCallback',
        'wrapper' => $ajax_id,
        'effect' => 'fade',
      ],
    ];
    $form['actions']['submit']['#submit'][] = 'Drupal\\opigno_module\\Controller\\ExternalPackageController::ajaxFormExternalPackageFormSubmit';
    $form['ajax_form_entity'] = [
      '#type' => 'hidden',
      '#value' => [
        'view_mode' => 'default',
        'reload' => TRUE,
        'content_selector' => ".{$ajax_id}",
        'form_selector' => ".{$ajax_id}",
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // Validation is optional.
    $file_field = "package";
    $storage = $form_state
      ->getStorage();
    $is_ppt = isset($storage['mode']) && $storage['mode'] == 'ppt' ? TRUE : FALSE;
    if (empty($_FILES['files']['name'][$file_field])) {

      // Only need to validate if the field actually has a file.
      $form_state
        ->setError($form['package'], $this
        ->t("The file was not uploaded."));
    }

    // Prepare folder.
    $temporary_file_path = !$is_ppt ? 'public://external_packages' : 'public://' . ExternalPackageController::getPptConversionDir();
    \Drupal::service('file_system')
      ->prepareDirectory($temporary_file_path, FileSystemInterface::MODIFY_PERMISSIONS | FileSystemInterface::CREATE_DIRECTORY);

    // Prepare file validators.
    $extensions = !$is_ppt ? [
      'h5p zip',
    ] : [
      'ppt pptx',
    ];
    $validators = [
      'file_validate_extensions' => $extensions,
    ];

    // Validate file.
    if ($is_ppt) {
      $ppt_dir = ExternalPackageController::getPptConversionDir();
      $file_default_scheme = \Drupal::config('system.file')
        ->get('default_scheme');
      $public_files_real_path = \Drupal::service('file_system')
        ->realpath($file_default_scheme . "://");
      $ppt_dir_real_path = $public_files_real_path . '/' . $ppt_dir;
      $file = file_save_upload($file_field, $validators, $temporary_file_path, NULL, FileSystemInterface::EXISTS_REPLACE);

      // Rename uploaded file - remove special chars.
      $file_new = $file[0];
      $filename = $file_new
        ->getFilename();
      $filename_new = preg_replace('/[^a-zA-Z0-9-_\\.]/', '-', $filename);
      $file_new
        ->setFilename($filename_new);
      $file_new
        ->setFileUri($temporary_file_path . '/' . $filename_new);
      $file_new
        ->save();
      rename($ppt_dir_real_path . '/' . $filename, $ppt_dir_real_path . '/' . $filename_new);
      if (!empty($file_new)) {

        // Actions on ppt(x) file upload.
        $ppt_dir = ExternalPackageController::getPptConversionDir();
        $file_default_scheme = \Drupal::config('system.file')
          ->get('default_scheme');
        $public_files_real_path = \Drupal::service('file_system')
          ->realpath($file_default_scheme . "://");
        $ppt_dir_real_path = $public_files_real_path . '/' . $ppt_dir;
        $this
          ->logger('ppt_converter')
          ->notice('$ppt_dir_real_path: ' . $ppt_dir_real_path);
        $images = ExternalPackageController::convertPptSlidesToImages($file_new, $ppt_dir_real_path);
        if ($images) {
          \Drupal::logger('ppt_converter')
            ->notice('$images: <pre><code>' . print_r($images, TRUE) . '</code></pre>');

          // Create H5P package in 'sites/default/files/external_packages_ppt'.
          ExternalPackageController::createH5pCoursePresentationPackage($images, $ppt_dir_real_path, $form_state
            ->getValue('name'));
        }
        if (file_exists($temporary_file_path . '/ppt-content-import.h5p')) {

          // Replace form uploaded file with converted h5p content file.
          $file_new = File::load($file[0]
            ->id());
          $file_new
            ->setFilename('ppt-content-import.h5p');
          $file_new
            ->setFileUri($temporary_file_path . '/ppt-content-import.h5p');
          $file_new
            ->setMimeType('application/octet-stream');
          $file_new
            ->save();
          $file[0] = $file_new;
        }
      }
    }
    else {
      $file = file_save_upload($file_field, $validators, $temporary_file_path, NULL, FileSystemInterface::EXISTS_REPLACE);
    }
    if (!$file[0]) {
      return $form_state
        ->setRebuild();
    }

    // Validate Scorm and Tincan packages.
    $this
      ->validateZipPackage($form, $form_state, $file[0]);

    // Set file id in form state for loading on submit.
    $form_state
      ->set('package', $file[0]
      ->id());
  }
  private function validateZipPackage($form, FormStateInterface $form_state, File $file) {

    /* @var \Drupal\opigno_scorm\OpignoScorm $scorm_controller */
    $scorm_controller = \Drupal::service('opigno_scorm.scorm');
    $file_extension = substr(strrchr($file
      ->getFilename(), '.'), 1);
    if ($file_extension == 'zip') {
      $scorm_controller
        ->unzipPackage($file);
      $extract_dir = 'public://opigno_scorm_extracted/scorm_' . $file
        ->id();

      // This is a standard: these files must always be here.
      $scorm_file = $extract_dir . '/imsmanifest.xml';
      $tincan_file = $extract_dir . '/tincan.xml';
      if (!file_exists($scorm_file) && !file_exists($tincan_file)) {
        $validation = FALSE;
        $files = scandir($extract_dir);
        $count_files = count($files);
        if ($count_files == 3 && is_dir($extract_dir . '/' . $files[2])) {
          $subfolder_files = scandir($extract_dir . '/' . $files[2]);
          if (in_array('imsmanifest.xml', $subfolder_files)) {
            $source = $extract_dir . '/' . $files[2];
            $i = new \RecursiveDirectoryIterator($source);
            foreach ($i as $f) {
              if ($f
                ->isFile()) {
                rename($f
                  ->getPathname(), $extract_dir . '/' . $f
                  ->getFilename());
              }
              else {
                if ($f
                  ->isDir()) {
                  rename($f
                    ->getPathname(), $extract_dir . '/' . $f
                    ->getFilename());
                  unlink($f
                    ->getPathname());
                }
              }
            }
            $validation = TRUE;
          }
        }
        if ($validation == FALSE) {
          $form_state
            ->setError($form['package'], $this
            ->t('Your file is not recognized as a valid SCORM, TinCan, or H5P package.'));
        }
      }
    }
  }

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

}

Members

Namesort descending Modifiers Type Description Overrides
AddExternalPackageForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
AddExternalPackageForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
AddExternalPackageForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
AddExternalPackageForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
AddExternalPackageForm::validateZipPackage private function
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 87
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.