ilExportFilesToIRSSMigration Class Reference

Inheritance diagram for ilExportFilesToIRSSMigration:

Collaboration diagram for ilExportFilesToIRSSMigration:

Public Member Functions
	getLabel ()
	getDefaultAmountOfStepsPerRun ()
	Tell the default amount of steps to be executed for one run of the migration. More...
	getPreconditions (Environment $environment)
	Objectives the migration depend on. More...
	prepare (Environment $environment)
	Prepare the migration by means of some environment. More...
	step (Environment $environment)
	Run one step of the migration. More...
	getRemainingAmountOfSteps ()
	Count up how many "things" need to be migrated. More...

Protected Member Functions
	updateMigrated (int $obj_id, string $export_type, string $filename)
	updateMigratedUnsupportedObjectType (int $obj_id, string $export_type, string $filename)
	getExportDirectory (string $class_name, bool $is_plugin, string $location, string $component_for_type, int $a_obj_id, string $a_type="xml", string $a_obj_type="", string $a_entity="")
	createPathFromId (int $a_container_id, string $a_name)
	getExporterClass (string $a_type, bool $is_plugin, string $class_name, string $location, string $component_for_type)

Protected Attributes
ilDBInterface	$db

Additional Inherited Members
Data Fields inherited from ILIAS\Setup\Migration
const	INFINITE = -1

Detailed Description

Definition at line 25 of file ilExportFilesToIRSSMigration.php.

Member Function Documentation

createPathFromId()

ilExportFilesToIRSSMigration::createPathFromId ( int  $a_container_id, string  $a_name  )

protected

Definition at line 210 of file ilExportFilesToIRSSMigration.php.

References $path.

Referenced by getExportDirectory().

                                                                            : string
    {
        $max_exponent = 3;
        $factor = 100;
        $path = [];
        $found = false;
        $num = $a_container_id;
        $path_string = '';
        for ($i = $max_exponent; $i > 0; $i--) {
            $factor = pow($factor, $i);
            if (($tmp = (int) ($num / $factor)) or $found) {
                $path[] = $tmp;
                $num = $num % $factor;
                $found = true;
            }
        }
        if (count($path)) {
            $path_string = (implode('/', $path) . '/');
        }
        return $path_string . $a_name . '_' . $a_container_id;
    }

Here is the caller graph for this function:

getDefaultAmountOfStepsPerRun()

ilExportFilesToIRSSMigration::getDefaultAmountOfStepsPerRun

(

)

Tell the default amount of steps to be executed for one run of the migration.

Return Migration::INFINITE if all units should be migrated at once.

Implements ILIAS\Setup\Migration.

Definition at line 34 of file ilExportFilesToIRSSMigration.php.

                                                   : int
    {
        return 5;
    }

getExportDirectory()

ilExportFilesToIRSSMigration::getExportDirectory ( string  $class_name, bool  $is_plugin, string  $location, string  $component_for_type, int  $a_obj_id, string  $a_type = "xml", string  $a_obj_type = "", string  $a_entity = ""  )

protected

Definition at line 165 of file ilExportFilesToIRSSMigration.php.

References ilObject\_lookupType(), createPathFromId(), ilFileUtils\getDataDir(), and getExporterClass().

Referenced by step().

     : string {
        $ent = ($a_entity == "")
            ? ""
            : "_" . $a_entity;
        if ($a_obj_type == "") {
            $a_obj_type = ilObject::_lookupType($a_obj_id);
        }
        $new_file_structure = [
            'cat', 'exc', 'crs', 'sess',
            'file', 'grp', 'frm', 'usr',
            'catr', 'crsr', 'grpr'
        ];
        if (in_array($a_obj_type, $new_file_structure)) {
            $dir = ilFileUtils::getDataDir() . DIRECTORY_SEPARATOR;
            $dir .= 'il' . $class_name . $ent . DIRECTORY_SEPARATOR;
            $dir .= $this->createPathFromId($a_obj_id, $a_obj_type) . DIRECTORY_SEPARATOR;
            $dir .= ($a_type == 'xml' ? 'export' : 'export_' . $a_type);
            return $dir;
        }
        $exporter_class = $this->getExporterClass(
            $a_obj_type,
            $is_plugin,
            $class_name,
            $location,
            $component_for_type
        );
        $export_dir = call_user_func(
            array($exporter_class, 'lookupExportDirectory'),
            $a_obj_type,
            $a_obj_id,
            $a_type,
            $a_entity
        );
        return $export_dir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExporterClass()

ilExportFilesToIRSSMigration::getExporterClass ( string  $a_type, bool  $is_plugin, string  $class_name, string  $location, string  $component_for_type  )

protected

Definition at line 232 of file ilExportFilesToIRSSMigration.php.

Referenced by getExportDirectory().

     : string {
        if ($is_plugin) {
            $classname = 'il' . $class_name . 'Exporter';
            if (include_once $location . '/class.' . $classname . '.php') {
                return $classname;
            }
        } else {
            $comp = $component_for_type;
            $componentParts = explode("/", $comp);
            $class = array_pop($componentParts);
            $class = "il" . $class . "Exporter";
            // page component plugin exporter classes are already included
            // the component is not registered by ilObjDefinition
            if (class_exists($class)) {
                return $class;
            }
            // the next line had a "@" in front of the include_once
            // I removed this because it tages ages to track down errors
            // if the include class contains parse errors.
            // Alex, 20 Jul 2012
            if (include_once "./" . $comp . "/classes/class." . $class . ".php") {
                return $class;
            }
        }
        throw new InvalidArgumentException('Invalid exporter type given');
    }

Here is the caller graph for this function:

getLabel()

ilExportFilesToIRSSMigration::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 29 of file ilExportFilesToIRSSMigration.php.

                              : string
    {
        return "ilExportFilesToIRSSMigration";
    }

getPreconditions()

ilExportFilesToIRSSMigration::getPreconditions

(

Environment

$environment

)

Objectives the migration depend on.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Migration.

Definition at line 39 of file ilExportFilesToIRSSMigration.php.

References ilResourceStorageMigrationHelper\getPreconditions().

                                                              : array
    {
        return array_merge(
            ilResourceStorageMigrationHelper::getPreconditions(),
            [
                new ilIniFilesLoadedObjective(),
                new ilDatabaseInitializedObjective(),
                new ilDatabaseUpdatedObjective()
            ]
        );
    }

Here is the call graph for this function:

getRemainingAmountOfSteps()

ilExportFilesToIRSSMigration::getRemainingAmountOfSteps

(

)

Count up how many "things" need to be migrated.

This helps the admin to decide how big he can create the steps and also how long a migration takes

Implements ILIAS\Setup\Migration.

Definition at line 128 of file ilExportFilesToIRSSMigration.php.

References $res.

                                               : int
    {
        $query = "SELECT COUNT(*) as count FROM export_file_info where migrated = 0";
        $res = $this->db->query($query);
        $row = $res->fetchAssoc();
        if (is_null($row)) {
            return 0;
        }
        return (int) $row['count'];
    }

prepare()

ilExportFilesToIRSSMigration::prepare

(

Environment

$environment

)

Prepare the migration by means of some environment.

This is not supposed to modify the environment, but will be run to prime the migration object to run step and getRemainingAmountOfSteps afterwards.

Implements ILIAS\Setup\Migration.

Definition at line 51 of file ilExportFilesToIRSSMigration.php.

References ILIAS\Setup\Environment\getResource().

                                                     : void
    {
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
    }

Here is the call graph for this function:

step()

ilExportFilesToIRSSMigration::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 56 of file ilExportFilesToIRSSMigration.php.

References $filename, $location, getExportDirectory(), ILIAS\Repository\int(), ilDBConstants\T_DATE, ilDBConstants\T_INTEGER, ilDBConstants\T_TEXT, updateMigrated(), and updateMigratedUnsupportedObjectType().

                                                  : void
    {
        $res_export_file_info = $this->db->query(
            "SELECT obj_id, export_type, filename, create_date FROM export_file_info WHERE migrated = 0 LIMIT 1"
        );
        $row_export_file_info = $res_export_file_info->fetchAssoc();
        if (is_null($row_export_file_info)) {
            return;
        }
        $obj_id = (int) $row_export_file_info['obj_id'];
        $export_type = $row_export_file_info['export_type'];
        $filename = $row_export_file_info['filename'];
        $res_object_data = $this->db->query(
            "SELECT type FROM object_data WHERE obj_id = " . $this->db->quote((int) $row_export_file_info['obj_id'], ilDBConstants::T_INTEGER)
        );
        $row_object_data = $res_object_data->fetchAssoc();
        # Export does not exist anymore, mark as migrated
        if (is_null($row_object_data)) {
            $this->updateMigrated($obj_id, $export_type, $filename);
            return;
        }
        $res_il_object_def = $this->db->query(
            "SELECT class_name, component, location, id FROM il_object_def where id = " . $this->db->quote($row_object_data['type'], ilDBConstants::T_TEXT)
        );
        $row_il_object_def = $this->db->fetchAssoc($res_il_object_def);
        # Object type is not defined or plugin and cannot be migrated, mark as such
        if (is_null($row_il_object_def)) {
            $this->updateMigratedUnsupportedObjectType($obj_id, $export_type, $filename);
            return;
        }
        $res_il_plugin = $this->db->query("SELECT plugin_id FROM il_plugin");
        $plugin_ids = [];
        while ($row_il_plugin = $res_il_plugin->fetchAssoc()) {
            $plugin_ids[] = $row_il_plugin['plugin_id'];
        }
        $classname = $row_il_object_def['class_name'];
        $create_date = $row_export_file_info['create_date'];
        $type = $row_object_data['type'];
        $component_for_type = $row_il_object_def['component'];
        $is_plugin = in_array($row_il_object_def["id"], $plugin_ids);
        $location = $row_il_object_def['location'];
        $export_dir = $this->getExportDirectory(
            $classname,
            $is_plugin,
            $location,
            $component_for_type,
            $obj_id,
            $export_type,
            $type
        );
        $file_path = $export_dir . DIRECTORY_SEPARATOR . $filename;
        # Export file was deleted, mark as migrated
        if (!file_exists($file_path)) {
            $this->updateMigrated($obj_id, $export_type, $filename);
            return;
        }
        $irss_helper = new ilResourceStorageMigrationHelper(new ResourceStakeholder(), $environment);
        $rid = $irss_helper->movePathToStorage($file_path, 6, null, null, false);
        if (is_null($rid)) {
            throw new \Exception('Could not store:' . $file_path);
        }
        $this->db->manipulate(
            "INSERT INTO export_files (object_id, rid, owner_id, timestamp) VALUES ("
            . $this->db->quote($obj_id, ilDBConstants::T_INTEGER) . ", "
            . $this->db->quote($rid->serialize(), ilDBConstants::T_TEXT) . ", "
            . $this->db->quote(6, ilDBConstants::T_INTEGER) . ", "
            . $this->db->quote($create_date, ilDBConstants::T_DATE) . ")"
        );
        # Export file was moved to irss, mark as migrated
        $this->updateMigrated($obj_id, $export_type, $filename);
    }

Here is the call graph for this function:

updateMigrated()

ilExportFilesToIRSSMigration::updateMigrated ( int  $obj_id, string  $export_type, string  $filename  )

protected

Definition at line 139 of file ilExportFilesToIRSSMigration.php.

References ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by step().

     : void {
        $this->db->manipulate(
            "UPDATE export_file_info SET migrated = 1 WHERE"
            . " obj_id = " . $this->db->quote($obj_id, ilDBConstants::T_INTEGER)
            . " AND export_type = " . $this->db->quote($export_type, ilDBConstants::T_TEXT)
            . " AND filename = " . $this->db->quote($filename, ilDBConstants::T_TEXT)
        );
    }

Here is the caller graph for this function:

updateMigratedUnsupportedObjectType()

ilExportFilesToIRSSMigration::updateMigratedUnsupportedObjectType ( int  $obj_id, string  $export_type, string  $filename  )

protected

Definition at line 152 of file ilExportFilesToIRSSMigration.php.

References ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by step().

     : void {
        $this->db->manipulate(
            "UPDATE export_file_info SET migrated = 2 WHERE"
            . " obj_id = " . $this->db->quote($obj_id, ilDBConstants::T_INTEGER)
            . " AND export_type = " . $this->db->quote($export_type, ilDBConstants::T_TEXT)
            . " AND filename = " . $this->db->quote($filename, ilDBConstants::T_TEXT)
        );
    }

Here is the caller graph for this function:

Field Documentation

$db

ilDBInterface ilExportFilesToIRSSMigration::$db

protected

Definition at line 27 of file ilExportFilesToIRSSMigration.php.

---

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

• components/ILIAS/Export/classes/Setup/ilExportFilesToIRSSMigration.php