class ImportModuleForm in Opigno module 8

Import Module form.

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\opigno_module\Form\ImportModuleForm

1 string reference to 'ImportModuleForm'

opigno_module.routing.yml in ./opigno_module.routing.yml

opigno_module.routing.yml

File

src/Form/ImportModuleForm.php, line 24

Namespace

Drupal\opigno_module\Form

class ImportModuleForm extends FormBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $mode = NULL) {
    $form['module_opi'] = [
      '#title' => $this
        ->t('Module'),
      '#type' => 'file',
      '#description' => $this
        ->t('Here you can import module. Allowed extension: opi'),
    ];
    $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('Import'),
    ];
    return $form;
  }

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

    // Validation is optional.
    if (empty($_FILES['files']['name']['module_opi'])) {

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

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

    // Prepare folder.
    $temporary_file_path = 'public://opigno-import';
    \Drupal::service('file_system')
      ->deleteRecursive($temporary_file_path);
    \Drupal::service('file_system')
      ->prepareDirectory($temporary_file_path, FileSystemInterface::MODIFY_PERMISSIONS | FileSystemInterface::CREATE_DIRECTORY);

    // Prepare file validators.
    $extensions = [
      'opi',
    ];
    $validators = [
      'file_validate_extensions' => $extensions,
    ];
    $files = [];
    $file = file_save_upload('module_opi', $validators, $temporary_file_path, NULL, FileSystemInterface::EXISTS_REPLACE);
    if (!empty($file[0])) {
      $path = \Drupal::service('file_system')
        ->realpath($file[0]
        ->getFileUri());
      $folder = DRUPAL_ROOT . '/sites/default/files/opigno-import';
      $zip = new \ZipArchive();
      $result = $zip
        ->open($path);
      if ($zip
        ->locateName('.htaccess') !== false) {
        \Drupal::messenger()
          ->addMessage(t('Unsafe files detected.'), 'error');
        $zip
          ->close();
        \Drupal::service('file_system')
          ->delete($path);
        \Drupal::service('file_system')
          ->deleteRecursive($temporary_file_path);
        return;
      }
      if ($result === TRUE) {
        $zip
          ->extractTo($folder);
        $zip
          ->close();
      }
      \Drupal::service('file_system')
        ->delete($path);
      $files = scandir($folder);
    }
    if (in_array('list_of_files.json', $files)) {
      $file_path = $temporary_file_path . '/list_of_files.json';
      $real_path = \Drupal::service('file_system')
        ->realpath($file_path);
      $file = file_get_contents($real_path);
      $format = 'json';
      $serializer = \Drupal::service('serializer');
      $content = $serializer
        ->decode($file, $format);
      if (empty($content['module'])) {
        \Drupal::messenger()
          ->addMessage(t('Incorrect archive structure.'), 'error');
        return;
      }
      $file_path = $temporary_file_path . '/' . $content['module'];
      $real_path = \Drupal::service('file_system')
        ->realpath($file_path);
      $file = file_get_contents($real_path);
      $module_content_array = $serializer
        ->decode($file, $format);
      $module_content = reset($module_content_array);
      $new_module = OpignoModule::create([
        'type' => 'opigno_module',
        'langcode' => $module_content['langcode'][0]['value'],
        'name' => $module_content['name'][0]['value'],
        'status' => $module_content['status'][0]['value'],
        'random_activity_score' => $module_content['random_activity_score'][0]['value'],
        'allow_resume' => $module_content['allow_resume'][0]['value'],
        'backwards_navigation' => $module_content['backwards_navigation'][0]['value'],
        'randomization' => $module_content['randomization'][0]['value'],
        'random_activities' => $module_content['random_activities'][0]['value'],
        'takes' => $module_content['takes'][0]['value'],
        'show_attempt_stats' => $module_content['show_attempt_stats'][0]['value'],
        'keep_results' => $module_content['keep_results'][0]['value'],
        'hide_results' => $module_content['hide_results'][0]['value'],
        'badge_active' => $module_content['badge_active'][0]['value'],
        'badge_criteria' => $module_content['badge_criteria'][0]['value'],
      ]);
      if ($module_content['badge_active'][0]['value'] == 1) {
        $new_module->badge_name->value = $module_content['badge_name'][0]['value'];
        $new_module->badge_description->value = $module_content['badge_description'][0]['value'];
      }
      if (!empty($module_content['description'][0])) {
        $new_module->description->value = $module_content['description'][0]['value'];
        $new_module->description->format = $module_content['description'][0]['format'];
      }
      $new_module
        ->save();
      $add_activities = [];
      prepare_directory_structure_for_import();
      foreach ($content['activities'] as $activity_file_name) {
        $file_path = $temporary_file_path . '/' . $activity_file_name;
        $real_path = \Drupal::service('file_system')
          ->realpath($file_path);
        $file = file_get_contents($real_path);
        try {
          $activity_content_array = $serializer
            ->decode($file, $format);
          $activity_content = reset($activity_content_array);
        } catch (\Exception $e) {
          continue;
        }
        $new_activity = OpignoActivity::create([
          'type' => $activity_content['type'][0]['target_id'],
        ]);
        $new_activity
          ->setName($activity_content['name'][0]['value']);
        $new_activity
          ->set('langcode', $activity_content['langcode'][0]['value']);
        $new_activity
          ->set('status', $activity_content['status'][0]['value']);
        switch ($activity_content['type'][0]['target_id']) {
          case 'opigno_long_answer':
            $new_activity->opigno_body->value = $activity_content['opigno_body'][0]['value'];
            $new_activity->opigno_body->format = $activity_content['opigno_body'][0]['format'];
            $new_activity->opigno_evaluation_method->value = $activity_content['opigno_evaluation_method'][0]['value'];
            break;
          case 'opigno_file_upload':
            $new_activity->opigno_body->value = $activity_content['opigno_body'][0]['value'];
            $new_activity->opigno_body->format = $activity_content['opigno_body'][0]['format'];
            $new_activity->opigno_evaluation_method->value = $activity_content['opigno_evaluation_method'][0]['value'];
            $new_activity->opigno_allowed_extension->value = $activity_content['opigno_allowed_extension'][0]['value'];
            break;
          case 'opigno_scorm':
            foreach ($activity_content['files'] as $file_key => $file_content) {
              $scorm_file_path = $temporary_file_path . '/' . $file_key;
              $uri = \Drupal::service('file_system')
                ->copy($scorm_file_path, 'public://opigno_scorm/' . $file_content['file_name'], FileSystemInterface::EXISTS_RENAME);
              $file = File::Create([
                'uri' => $uri,
                'uid' => $this
                  ->currentUser()
                  ->id(),
                'status' => $file_content['status'],
              ]);
              $file
                ->save();
              $fid = $file
                ->id();
              $new_activity->opigno_scorm_package->target_id = $fid;
              $new_activity->opigno_scorm_package->display = 1;
            }
            break;
          case 'opigno_tincan':
            foreach ($activity_content['files'] as $file_key => $file_content) {
              $tincan_file_path = $temporary_file_path . '/' . $file_key;
              $uri = \Drupal::service('file_system')
                ->copy($tincan_file_path, 'public://opigno_tincan/' . $file_content['file_name'], FileSystemInterface::EXISTS_RENAME);
              $file = File::Create([
                'uri' => $uri,
                'uid' => $this
                  ->currentUser()
                  ->id(),
                'status' => $file_content['status'],
              ]);
              $file
                ->save();
              $fid = $file
                ->id();
              $new_activity->opigno_tincan_package->target_id = $fid;
              $new_activity->opigno_tincan_package->display = 1;
            }
            break;
          case 'opigno_slide':
            foreach ($activity_content['files'] as $file_key => $file_content) {
              $slide_file_path = $temporary_file_path . '/' . $file_key;
              $current_timestamp = \Drupal::time()
                ->getCurrentTime();
              $date = date('Y-m', $current_timestamp);
              $uri = \Drupal::service('file_system')
                ->copy($slide_file_path, 'public://' . $date . '/' . $file_content['file_name'], FileSystemInterface::EXISTS_RENAME);
              $file = File::Create([
                'uri' => $uri,
                'uid' => $this
                  ->currentUser()
                  ->id(),
                'status' => $file_content['status'],
              ]);
              $file
                ->save();
              $media = Media::create([
                'bundle' => $file_content['bundle'],
                'name' => $file_content['file_name'],
                'field_media_file' => [
                  'target_id' => $file
                    ->id(),
                ],
              ]);
              $media
                ->save();
              $new_activity->opigno_slide_pdf->target_id = $media
                ->id();
              $new_activity->opigno_slide_pdf->display = 1;
            }
            break;
          case 'opigno_video':
            foreach ($activity_content['files'] as $file_key => $file_content) {
              $video_file_path = $temporary_file_path . '/' . $file_key;
              $current_timestamp = \Drupal::time()
                ->getCurrentTime();
              $date = date('Y-m', $current_timestamp);
              $uri = \Drupal::service('file_system')
                ->copy($video_file_path, 'public://video-thumbnails/' . $date . '/' . $file_content['file_name'], FileSystemInterface::EXISTS_RENAME);
              $file = File::Create([
                'uri' => $uri,
                'uid' => $this
                  ->currentUser()
                  ->id(),
                'status' => $file_content['status'],
              ]);
              $file
                ->save();
              $new_activity->field_video->target_id = $file
                ->id();
            }
            break;
          case 'opigno_h5p':
            $h5p_content_id = $activity_content['opigno_h5p'][0]['h5p_content_id'];
            $file = $folder . "/interactive-content-{$h5p_content_id}.h5p";
            $interface = H5PDrupal::getInstance();
            if ($file) {
              $file_service = \Drupal::service('file_system');
              $dir = $file_service
                ->realpath($temporary_file_path . '/h5p');
              $interface
                ->getUploadedH5pFolderPath($dir);
              $interface
                ->getUploadedH5pPath($folder . "/interactive-content-{$h5p_content_id}.h5p");
              $editor = H5PEditorUtilities::getInstance();
              $h5pEditorAjax = new H5PEditorAjaxImport($editor->ajax->core, $editor, $editor->ajax->storage);
              if ($h5pEditorAjax
                ->isValidPackage(TRUE)) {

                // Add new libraries from file package.
                $storage = new H5PStorageImport($h5pEditorAjax->core->h5pF, $h5pEditorAjax->core);

                // Serialize metadata array in libraries.
                if (!empty($storage->h5pC->librariesJsonData)) {
                  foreach ($storage->h5pC->librariesJsonData as &$library) {
                    if (array_key_exists('metadataSettings', $library) && is_array($library['metadataSettings'])) {
                      $metadataSettings = serialize($library['metadataSettings']);
                      $library['metadataSettings'] = $metadataSettings;
                    }
                  }
                }
                $storage
                  ->saveLibraries();
                $h5p_json = $dir . '/h5p.json';
                $real_path = \Drupal::service('file_system')
                  ->realpath($h5p_json);
                $h5p_json = file_get_contents($real_path);
                $format = 'json';
                $serializer = \Drupal::service('serializer');
                $h5p_json = $serializer
                  ->decode($h5p_json, $format);
                $dependencies = $h5p_json['preloadedDependencies'];
                $database = \Drupal::database();

                // Get ID of main library.
                foreach ($h5p_json['preloadedDependencies'] as $dependency) {
                  if ($dependency['machineName'] == $h5p_json['mainLibrary']) {
                    $h5p_json['majorVersion'] = $dependency['majorVersion'];
                    $h5p_json['minorVersion'] = $dependency['minorVersion'];
                  }
                }
                $query = $database
                  ->select('h5p_libraries', 'h_l');
                $query
                  ->condition('machine_name', $h5p_json['mainLibrary'], '=');
                $query
                  ->condition('major_version', $h5p_json['majorVersion'], '=');
                $query
                  ->condition('minor_version', $h5p_json['minorVersion'], '=');
                $query
                  ->fields('h_l', [
                  'library_id',
                ]);
                $query
                  ->orderBy('patch_version', 'DESC');
                $main_library_id = $query
                  ->execute()
                  ->fetchField();
                if (!$main_library_id) {
                  $query = $database
                    ->select('h5p_libraries', 'h_l');
                  $query
                    ->condition('machine_name', $h5p_json['mainLibrary'], '=');
                  $query
                    ->fields('h_l', [
                    'library_id',
                  ]);
                  $query
                    ->orderBy('major_version', 'DESC');
                  $query
                    ->orderBy('minor_version', 'DESC');
                  $query
                    ->orderBy('patch_version', 'DESC');
                  $main_library_id = $query
                    ->execute()
                    ->fetchField();
                }
                $content_json = $dir . '/content/content.json';
                $real_path = \Drupal::service('file_system')
                  ->realpath($content_json);
                $content_json = file_get_contents($real_path);
                $fields = [
                  'library_id' => $main_library_id,
                  'title' => $h5p_json['title'],
                  'parameters' => $content_json,
                  'filtered_parameters' => $content_json,
                  'disabled_features' => 0,
                  'authors' => '[]',
                  'changes' => '[]',
                  'license' => 'U',
                ];
                $h5p_content = H5PContent::create($fields);
                $h5p_content
                  ->save();
                $new_activity
                  ->set('opigno_h5p', $h5p_content
                  ->id());
                $h5p_dest_path = \Drupal::config('h5p.settings')
                  ->get('h5p_default_path');
                $h5p_dest_path = !empty($h5p_dest_path) ? $h5p_dest_path : 'h5p';
                $dest_folder = DRUPAL_ROOT . '/sites/default/files/' . $h5p_dest_path . '/content/' . $h5p_content
                  ->id();
                $source_folder = DRUPAL_ROOT . '/sites/default/files/opigno-import/h5p/content/*';
                \Drupal::service('file_system')
                  ->prepareDirectory($dest_folder, FileSystemInterface::MODIFY_PERMISSIONS | FileSystemInterface::CREATE_DIRECTORY);
                shell_exec('rm ' . $dest_folder . '/content.json');
                shell_exec('cp -r ' . $source_folder . ' ' . $dest_folder);

                // Clean up.
                $h5pEditorAjax->storage
                  ->removeTemporarilySavedFiles($h5pEditorAjax->core->h5pF
                  ->getUploadedH5pFolderPath());
                foreach ($dependencies as $dependency_key => $dependency) {
                  $query = $database
                    ->select('h5p_libraries', 'h_l');
                  $query
                    ->condition('machine_name', $dependency['machineName'], '=');
                  $query
                    ->condition('major_version', $dependency['majorVersion'], '=');
                  $query
                    ->condition('minor_version', $dependency['minorVersion'], '=');
                  $query
                    ->fields('h_l', [
                    'library_id',
                  ]);
                  $query
                    ->orderBy('patch_version', 'DESC');
                  $library_id = $query
                    ->execute()
                    ->fetchField();
                  if (!$library_id) {
                    $query = $database
                      ->select('h5p_libraries', 'h_l');
                    $query
                      ->condition('machine_name', $dependency['machineName'], '=');
                    $query
                      ->fields('h_l', [
                      'library_id',
                    ]);
                    $query
                      ->orderBy('major_version', 'DESC');
                    $query
                      ->orderBy('minor_version', 'DESC');
                    $query
                      ->orderBy('patch_version', 'DESC');
                    $library_id = $query
                      ->execute()
                      ->fetchField();
                  }
                  if ($h5p_json['mainLibrary'] == $dependency['machineName']) {
                    $main_library_values = [
                      'content_id' => $h5p_content
                        ->id(),
                      'library_id' => $library_id,
                      'dependency_type' => 'preloaded',
                      'drop_css' => 0,
                      'weight' => count($dependencies) + 1,
                    ];
                    continue;
                  }
                  if ($library_id) {
                    $database
                      ->insert('h5p_content_libraries')
                      ->fields([
                      'content_id',
                      'library_id',
                      'dependency_type',
                      'drop_css',
                      'weight',
                    ])
                      ->values([
                      'content_id' => $h5p_content
                        ->id(),
                      'library_id' => $library_id,
                      'dependency_type' => 'preloaded',
                      'drop_css' => 0,
                      'weight' => $dependency_key + 1,
                    ])
                      ->execute();
                  }
                }
                if (!empty($main_library_values)) {
                  $database
                    ->insert('h5p_content_libraries')
                    ->fields([
                    'content_id',
                    'library_id',
                    'dependency_type',
                    'drop_css',
                    'weight',
                  ])
                    ->values($main_library_values)
                    ->execute();
                }
              }
            }
            break;
        }
        $new_activity
          ->save();
        $add_activities[] = $new_activity;
      }
      $opigno_module_obj = \Drupal::service('opigno_module.opigno_module');
      $opigno_module_obj
        ->activitiesToModule($add_activities, $new_module);
      $route_parameters = [
        'opigno_module' => $new_module
          ->id(),
      ];
      \Drupal::messenger()
        ->addMessage(t('Imported module %module', [
        '%module' => Link::createFromRoute($new_module
          ->label(), 'entity.opigno_module.canonical', $route_parameters)
          ->toString(),
      ]));
      $form_state
        ->setRedirect('entity.opigno_module.collection');
    }
    \Drupal::service('file_system')
      ->deleteRecursive($temporary_file_path);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.
ImportModuleForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
ImportModuleForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ImportModuleForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ImportModuleForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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.