Import class. More...

Inheritance diagram for ilImport:

Collaboration diagram for ilImport:

Public Member Functions
	__construct (int $a_target_id=0)

	getConfig (string $a_comp)
	Get configuration (note that configurations are optional, null may be returned!) More...

	getMapping ()

	setEntityTypes (array $a_val)

	getEntityTypes ()

	addSkipEntity (string $a_component, string $a_entity, bool $skip=true)
	Add skip entity. More...

	addSkipImporter (string $a_component, bool $skip=true)

	importEntity (string $a_tmp_file, string $a_filename, string $a_entity, string $a_component, bool $a_copy_file=false)
	Import entity. More...

	importObject (?object $a_new_obj, string $a_tmp_file, string $a_filename, string $a_type, string $a_comp="", bool $a_copy_file=false)

	importFromDirectory (string $dir, string $a_type, string $a_comp)

	getTemporaryImportDir ()
	Get temporary import directory. More...

	processItemXml (string $a_entity, string $a_schema_version, string $a_id, string $a_xml, string $a_install_id, string $a_install_url)
	Process item xml. More...

Protected Member Functions
	validateXMLFiles (SplFileInfo $manifest_spl)

	checkStatuses (ilImportStatusHandlerCollectionInterface $import_status_collection)

	setTemporaryImportDir (string $a_val)
	Set temporary import directory. More...

	doImportObject (string $dir, string $a_type, string $a_component="", string $a_tmpdir="")
	Import repository object export file. More...

Protected Attributes
ilLogger	$log

ilObjectDefinition	$objDefinition

array	$entity_types = []

ilXmlImporter	$importer = null

string	$comp = ''

string	$current_comp = ''

string	$entities = ""

string	$tmp_import_dir = ""

ilImportMapping	$mapping = null

array	$skip_entity = array()

array	$configs = array()

array	$skip_importer = []

Archives	$archives

Filesystems	$filesystem

ilImportFactory	$import

ilImportStatusFactory	$import_status

Detailed Description

Import class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 38 of file class.ilImport.php.

Constructor & Destructor Documentation

◆ __construct()

ilImport::__construct ( int $a_target_id = 0 )

Reimplemented in ilImportContainer.

Definition at line 57 of file class.ilImport.php.

    {
        global $DIC;
        $this->objDefinition = $DIC['objDefinition'];
        $this->mapping = new ilImportMapping();
        $this->mapping->setTargetId($a_target_id);
        $this->log = $DIC->logger()->exp();
        $this->archives = $DIC->archives();
        $this->filesystem = $DIC->filesystem();
        $this->import = new ilImportFactory();
        $this->import_status = new ilImportStatusFactory();
    }

References $DIC, and ILIAS\Repository\filesystem().

Here is the call graph for this function:

Member Function Documentation

◆ addSkipEntity()

ilImport::addSkipEntity	(	string	$a_component,
		string	$a_entity,
		bool	$skip = `true`
	)

Add skip entity.

Definition at line 105 of file class.ilImport.php.

                                                                                           : void
    {
        $this->skip_entity[$a_component][$a_entity] = $skip;
    }

◆ addSkipImporter()

ilImport::addSkipImporter	(	string	$a_component,
		bool	$skip = `true`
	)

Definition at line 110 of file class.ilImport.php.

                                                                           : void
    {
        $this->skip_importer[$a_component] = $skip;
    }

◆ checkStatuses()

ilImport::checkStatuses ( ilImportStatusHandlerCollectionInterface $import_status_collection )

protected

Definition at line 240 of file class.ilImport.php.

                                                                                                        : void
    {
        if ($import_status_collection->hasStatusType(StatusType::FAILED)) {
            throw new ilImportException($import_status_collection
                ->withNumberingEnabled(true)
                ->toString(StatusType::FAILED));
        }
    }

References ILIAS\Export\ImportStatus\FAILED, and ILIAS\Export\ImportHandler\File\XML\Manifest\toString.

◆ doImportObject()

ilImport::doImportObject	(	string	$dir,
		string	$a_type,
		string	$a_component = `""`,
		string	$a_tmpdir = `""`
	)

protected

Import repository object export file.

Reimplemented in ilImportContainer.

Definition at line 323 of file class.ilImport.php.

     : array {
        if ($a_component == "") {
            $a_component = ilImportExportFactory::getComponentForExport($a_type);
        }
        $this->comp = $a_component;
 
        // get import class
        $success = true;
 
        // process manifest file
        if (!is_file($dir . "/manifest.xml")) {
            $mess = (DEVMODE)
                ? 'Manifest file not found: "' . $dir . "/manifest.xml" . '".'
                : 'Manifest file not found: "manifest.xml."';
            $e = new ilManifestFileNotFoundImportException($mess);
            $e->setManifestDir($dir);
            $e->setTmpDir($a_tmpdir);
            throw $e;
        }
        $parser = new ilManifestParser($dir . "/manifest.xml");
        $this->mapping->setInstallUrl($parser->getInstallUrl());
        $this->mapping->setInstallId($parser->getInstallId());
 
        // check for correct type
        if ($parser->getMainEntity() != $a_type) {
            throw new ilImportObjectTypeMismatchException(
                "Object type does not match. Import file has type '" .
                $parser->getMainEntity() . "' but import being processed for '" . $a_type . "'."
            );
        }
 
        // process export files
        $expfiles = $parser->getExportFiles();
 
        $all_importers = array();
        foreach ($expfiles as $expfile) {
            $comp = $expfile["component"];
 
            if (isset($this->skip_importer[$comp]) && $this->skip_importer[$comp] === true) {
                continue;
            }
 
            $class = ilImportExportFactory::getImporterClass($comp);
 
            // log a warning for inactive page component plugins, but continue import
            // page content will be imported, but not its additional data
            // (other plugins throw an exception in ilImportExportFactory)
            if ($class == '') {
                $this->log->warning("no class found for component: $comp");
                continue;
            }
 
            $this->log->debug("create new class = $class");
 
            $this->importer = new $class();
            $this->importer->setImport($this);
            $all_importers[] = $this->importer;
            $this->importer->setImportDirectory($dir);
            $this->importer->init();
            $this->current_comp = $comp;
            try {
                $this->log->debug("Process file: " . $dir . "/" . $expfile["path"]);
                $parser = new ilExportFileParser($dir . "/" . $expfile["path"], $this, "processItemXml");
            } catch (Exception $e) {
                $this->log->error("Import failed: " . $e->getMessage());
                $this->log->error('XML failed: ' . file_get_contents($dir . '/' . $expfile['path']));
                throw $e;
            }
        }
 
        // write import ids before(!) final processing
        $obj_map = $this->getMapping()->getMappingsOfEntity('components/ILIAS/Container', 'objs');
        if (is_array($obj_map)) {
            foreach ($obj_map as $obj_id_old => $obj_id_new) {
                ilObject::_writeImportId(
                    (int) $obj_id_new,
                    "il_" . $this->mapping->getInstallId() . "_" . ilObject::_lookupType((int) $obj_id_new) . "_" . $obj_id_old
                );
            }
        }
 
        // final processing
        foreach ($all_importers as $imp) {
            $this->log->debug("Call finalProcessing for: " . get_class($imp));
            $imp->finalProcessing($this->mapping);
        }
 
        // we should only get on mapping here
        $top_mapping = $this->mapping->getMappingsOfEntity($this->comp, $a_type);
 
        $new_id = (int) current($top_mapping);
        return array(
            'new_id' => $new_id,
            'importers' => $all_importers
        );
    }

◆ getConfig()

ilImport::getConfig ( string $a_comp )

Get configuration (note that configurations are optional, null may be returned!)

Definition at line 73 of file class.ilImport.php.

                                             : ilImportConfig
    {
        // if created, return existing config object
        if (isset($this->configs[$a_comp])) {
            return $this->configs[$a_comp];
        }
        // create instance of export config object
        $comp_arr = explode("/", $a_comp);
        $a_class = "il" . ($comp_arr[2] ?? $comp_arr[1]) . "ImportConfig";
        $imp_config = new $a_class();
        $this->configs[$a_comp] = $imp_config;
        return $imp_config;
    }

◆ getEntityTypes()

ilImport::getEntityTypes ( )

final

Definition at line 97 of file class.ilImport.php.

                                          : array
    {
        return $this->entity_types;
    }

References $entity_types.

◆ getMapping()

ilImport::getMapping ( )

Definition at line 87 of file class.ilImport.php.

                                : ilImportMapping
    {
        return $this->mapping;
    }

References $mapping.

◆ getTemporaryImportDir()

ilImport::getTemporaryImportDir ( )

Get temporary import directory.

Returns: string temporary import directory (used to unzip and read import)

Definition at line 315 of file class.ilImport.php.

                                           : string
    {
        return $this->tmp_import_dir;
    }

◆ importEntity()

ilImport::importEntity	(	string	$a_tmp_file,
		string	$a_filename,
		string	$a_entity,
		string	$a_component,
		bool	$a_copy_file = `false`
	)

final

Import entity.

Definition at line 118 of file class.ilImport.php.

     : int {
        return $this->importObject(null, $a_tmp_file, $a_filename, $a_entity, $a_component, $a_copy_file);
    }

◆ importFromDirectory()

ilImport::importFromDirectory	(	string	$dir,
		string	$a_type,
		string	$a_comp
	)

Definition at line 293 of file class.ilImport.php.

                                                                                    : ?int
    {
        $ret = $this->doImportObject($dir, $a_type, $a_comp);
        if (is_array($ret)) {
            return $ret['new_id'];
        }
        return null;
    }

◆ importObject()

ilImport::importObject	(	?object	$a_new_obj,
		string	$a_tmp_file,
		string	$a_filename,
		string	$a_type,
		string	$a_comp = `""`,
		bool	$a_copy_file = `false`
	)

final

Definition at line 249 of file class.ilImport.php.

     : ?int {
        // Unzip
        $status_collection = $this->unzipFile(
            $a_filename,
            $a_tmp_file,
            $a_copy_file
        );
        $this->checkStatuses($status_collection);
        $success_status = $status_collection->getCollectionOfAllByType(StatusType::SUCCESS)->current();
        $target_dir_info = new SplFileInfo($success_status->getContent()->toString());
        $delete_dir_info = new SplFileInfo($target_dir_info->getPath());
        $manifest_spl = new SplFileInfo($target_dir_info->getPathname() . DIRECTORY_SEPARATOR . 'manifest.xml');
        // Validate manifest files
        try {
            $status_collection = $this->validateXMLFiles($manifest_spl);
            $this->checkStatuses($status_collection);
        } catch (Exception $e) {
            $this->filesystem->temp()->deleteDir($delete_dir_info->getFilename());
            throw $e;
        }
        // Import
        try {
            $this->setTemporaryImportDir($target_dir_info->getPathname());
            $ret = $this->doImportObject($target_dir_info->getPathname(), $a_type, $a_comp, $target_dir_info->getPath());
            $new_id = null;
            if (is_array($ret) && array_key_exists('new_id', $ret)) {
                $new_id = $ret['new_id'];
            }
        } catch (Exception $e) {
            $this->filesystem->temp()->deleteDir($delete_dir_info->getFilename());
            throw $e;
        }
        // Delete tmp files
        $this->filesystem->temp()->deleteDir($delete_dir_info->getFilename());
        return $new_id;
    }

◆ processItemXml()

ilImport::processItemXml	(	string	$a_entity,
		string	$a_schema_version,
		string	$a_id,
		string	$a_xml,
		string	$a_install_id,
		string	$a_install_url
	)

Process item xml.

Definition at line 428 of file class.ilImport.php.

     : void {
        // skip
        if (isset($this->skip_entity[$this->current_comp][$a_entity]) &&
            $this->skip_entity[$this->current_comp][$a_entity]) {
            return;
        }
 
        if ($this->objDefinition->isRBACObject($a_entity) &&
            $this->getMapping()->getMapping('components/ILIAS/Container', 'imported', $a_id)) {
            $this->log->info('Ignoring referenced ' . $a_entity . ' with id ' . $a_id);
            return;
        }
        $this->importer->setInstallId($a_install_id);
        $this->importer->setInstallUrl($a_install_url);
        $this->importer->setSchemaVersion($a_schema_version);
        $this->importer->setSkipEntities($this->skip_entity);
        $this->importer->importXmlRepresentation($a_entity, $a_id, $a_xml, $this->mapping);
 
        // Store information about imported obj_ids in mapping to avoid double imports of references
        if ($this->objDefinition->isRBACObject($a_entity)) {
            $this->getMapping()->addMapping('components/ILIAS/Container', 'imported', $a_id, '1');
        }
    }

◆ setEntityTypes()

ilImport::setEntityTypes ( array $a_val )

final

Definition at line 92 of file class.ilImport.php.

                                                      : void
    {
        $this->entity_types = $a_val;
    }

◆ setTemporaryImportDir()

ilImport::setTemporaryImportDir ( string $a_val )

protected

Set temporary import directory.

Parameters

string $a_val temporary import directory (used to unzip and read import)

Definition at line 306 of file class.ilImport.php.

    {
        $this->tmp_import_dir = $a_val;
    }

◆ validateXMLFiles()

ilImport::validateXMLFiles ( SplFileInfo $manifest_spl )

protected

Definition at line 175 of file class.ilImport.php.

                                                                  : ilImportStatusHandlerCollectionInterface
    {
        $export_files = $this->import->file()->xml()->export()->collection();
        $manifest_handlers = $this->import->file()->xml()->manifest()->collection();
        $statuses = $this->import_status->collection();
        // Find export xmls
        try {
            $manifest_handlers = $manifest_handlers->withElement(
                $this->import->file()->xml()->manifest()->handler()->withFileInfo($manifest_spl)
            );
            // VALIDATE 1st manifest file, can be either export-set or export-file
            $statuses = $manifest_handlers->validateElements();
            if ($statuses->hasStatusType(StatusType::FAILED)) {
                return $statuses;
            }
            // If export set look for the export file manifests + VALIDATE
            if ($manifest_handlers->containsExportObjectType(ExportObjectType::EXPORT_SET)) {
                $manifest_handlers = $manifest_handlers->findNextFiles();
                $statuses = $manifest_handlers->validateElements();
            }
            if ($statuses->hasStatusType(StatusType::FAILED)) {
                return $statuses;
            }
            // If export file look for the export xmls
            if ($manifest_handlers->containsExportObjectType(ExportObjectType::EXPORT_FILE)) {
                foreach ($manifest_handlers as $manfiest_file_handler) {
                    $export_files = $export_files->withMerged($manfiest_file_handler->findXMLFileHandlers());
                }
            }
        } catch (ilImportStatusException $e) {
            $this->checkStatuses($e->getStatuses());
        }
        // VALIDATE export xmls
        $path_to_export_item_child = $this->import->path()->handler()
            ->withStartAtRoot(true)
            ->withNode($this->import->path()->node()->simple()->withName('exp:Export'))
            ->withNode($this->import->path()->node()->simple()->withName('exp:ExportItem'))
            ->withNode($this->import->path()->node()->anyNode());
        $component_tree = $this->import->parser()->nodeInfo()->tree()->handler();
        foreach ($export_files as $export_file) {
            if ($export_file->isContainerExportXML()) {
                $component_tree = $component_tree->withRootInFile($export_file, $path_to_export_item_child);
                break;
            }
        }
        foreach ($export_files as $export_file) {
            $found_statuses = $export_file->buildValidationSets();
            if (!$found_statuses->hasStatusType(StatusType::FAILED)) {
                $found_statuses = $this->import->validation()->handler()->validateSets(
                    $export_file->getValidationSets()
                );
            }
            if (!$found_statuses->hasStatusType(StatusType::FAILED)) {
                $statuses = $statuses->getMergedCollectionWith($found_statuses);
                continue;
            }
            $info_str = "<br> Location: " . $export_file->getILIASPath($component_tree) . "<br>";
            $found_statuses = $found_statuses->mergeContentToElements(
                $this->import_status->content()->builder()->string()->withString($info_str)
            );
            $statuses = $statuses->getMergedCollectionWith($found_statuses);
        }
        return $statuses;
    }

References Vendor\Package\$e, and ILIAS\Export\ImportStatus\FAILED.

Field Documentation

◆ $archives

Archives ilImport::$archives

protected

Definition at line 52 of file class.ilImport.php.

◆ $comp

string ilImport::$comp = ''

protected

Definition at line 44 of file class.ilImport.php.

◆ $configs

array ilImport::$configs = array()

protected

Definition at line 50 of file class.ilImport.php.

◆ $current_comp

string ilImport::$current_comp = ''

protected

Definition at line 45 of file class.ilImport.php.

◆ $entities

string ilImport::$entities = ""

protected

Definition at line 46 of file class.ilImport.php.

◆ $entity_types

array ilImport::$entity_types = []

protected

Definition at line 42 of file class.ilImport.php.

Referenced by getEntityTypes().

◆ $filesystem

Filesystems ilImport::$filesystem

protected

Definition at line 53 of file class.ilImport.php.

◆ $import

ilImportFactory ilImport::$import

protected

Definition at line 54 of file class.ilImport.php.

◆ $import_status

ilImportStatusFactory ilImport::$import_status

protected

Definition at line 55 of file class.ilImport.php.

◆ $importer

ilXmlImporter ilImport::$importer = null

protected

Definition at line 43 of file class.ilImport.php.

◆ $log

ilLogger ilImport::$log

protected

Definition at line 40 of file class.ilImport.php.

◆ $mapping

ilImportMapping ilImport::$mapping = null

protected

Definition at line 48 of file class.ilImport.php.

Referenced by getMapping().

◆ $objDefinition

ilObjectDefinition ilImport::$objDefinition

protected

Definition at line 41 of file class.ilImport.php.

◆ $skip_entity

array ilImport::$skip_entity = array()

protected

Definition at line 49 of file class.ilImport.php.

◆ $skip_importer

array ilImport::$skip_importer = []

protected

Definition at line 51 of file class.ilImport.php.

◆ $tmp_import_dir

string ilImport::$tmp_import_dir = ""

protected

Definition at line 47 of file class.ilImport.php.

The documentation for this class was generated from the following file:

components/ILIAS/Export/classes/class.ilImport.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addSkipEntity()

◆ addSkipImporter()

◆ checkStatuses()

◆ doImportObject()

◆ getConfig()

◆ getEntityTypes()

◆ getMapping()

◆ getTemporaryImportDir()

◆ importEntity()

◆ importFromDirectory()

◆ importObject()

◆ processItemXml()

◆ setEntityTypes()

◆ setTemporaryImportDir()

◆ validateXMLFiles()

Field Documentation

◆ $archives

◆ $comp

◆ $configs

◆ $current_comp

◆ $entities

◆ $entity_types

◆ $filesystem

◆ $import

◆ $import_status

◆ $importer

◆ $log

◆ $mapping

◆ $objDefinition

◆ $skip_entity

◆ $skip_importer

◆ $tmp_import_dir