class H5PValidatorImport in Opigno module 3.x

This class is used for validating H5P files.

Hierarchy

• class \Drupal\opigno_module\H5PImportClasses\H5PValidatorImport extends \Drupal\opigno_module\H5PImportClasses\H5PValidator

File

src/H5PImportClasses/H5PValidatorImport.php, line 8

Namespace

Drupal\opigno_module\H5PImportClasses

class H5PValidatorImport extends \H5PValidator {

  /**
   * Validates a .h5p file.
   *
   * @param bool $skipContent
   *   Skip package content.
   * @param bool $upgradeOnly
   *   Only update library flag.
   *
   * @return bool
   *   TRUE if the .h5p file is valid.
   */
  public function isValidPackage($skipContent = FALSE, $upgradeOnly = FALSE) {

    // Check dependencies, make sure Zip is present.
    if (!class_exists('ZipArchive')) {
      $this->h5pF
        ->setErrorMessage($this->h5pF
        ->t('Your PHP version does not support ZipArchive.'), 'zip-archive-unsupported');
      return FALSE;
    }

    // Create a temporary dir to extract package in.
    $tmpDir = $this->h5pF
      ->getUploadedH5pFolderPath();
    $tmpPath = $this->h5pF
      ->getUploadedH5pPath();

    // Extract and then remove the package file.
    $zip = new \ZipArchive();

    // Only allow files with the .h5p extension:
    if (strtolower(substr($tmpPath, -3)) !== 'h5p') {
      $this->h5pF
        ->setErrorMessage($this->h5pF
        ->t('The file you uploaded is not a valid HTML5 Package (It does not have the .h5p file extension)'), 'missing-h5p-extension');
      H5PStorageImport::deleteFileTree($tmpDir);
      return FALSE;
    }
    if ($zip
      ->open($tmpPath) === TRUE) {
      $zip
        ->extractTo($tmpDir);
      $zip
        ->close();
    }
    else {
      $this->h5pF
        ->setErrorMessage($this->h5pF
        ->t('The file you uploaded is not a valid HTML5 Package (We are unable to unzip it)'), 'unable-to-unzip');
      H5PStorageImport::deleteFileTree($tmpDir);
      return FALSE;
    }
    unlink($tmpPath);

    // Process content and libraries.
    $valid = TRUE;
    $libraries = [];
    $files = scandir($tmpDir);
    foreach ($files as $file) {
      if (in_array(substr($file, 0, 1), [
        '.',
        '_',
      ])) {
        continue;
      }
      $filePath = $tmpDir . DIRECTORY_SEPARATOR . $file;
      if (strtolower($file) != 'h5p.json' && $file != 'content') {
        $libraryH5PData = $this
          ->getLibraryData($file, $filePath, $tmpDir);
        if ($libraryH5PData !== FALSE) {
          $libraryH5PData['uploadDirectory'] = $filePath;
          $libraries[self::libraryToString($libraryH5PData)] = $libraryH5PData;
        }
        else {
          $valid = FALSE;
        }
      }
    }
    if ($valid) {
      $this->h5pC->librariesJsonData = $libraries;
    }
    if (!$valid) {
      H5PStorageImport::deleteFileTree($tmpDir);
    }
    return $valid;
  }

  /**
   * Writes library data as string {machineName} {majorVersion}.{minorVersion}.
   *
   * @param array $library
   *   With keys machineName, majorVersion and minorVersion.
   * @param bool $folderName
   *   Use hyphen instead of space in returned string.
   *
   * @return string
   *   On the form {machineName} {majorVersion}.{minorVersion}
   */
  public static function libraryToString(array $library, $folderName = FALSE) {
    return (isset($library['machineName']) ? $library['machineName'] : $library['name']) . ($folderName ? '-' : ' ') . $library['majorVersion'] . '.' . $library['minorVersion'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
H5PValidatorImport::isValidPackage	public	function	Validates a .h5p file.
H5PValidatorImport::libraryToString	public static	function	Writes library data as string {machineName} {majorVersion}.{minorVersion}.