Collaboration diagram for ilFileObjectToStorageMigrationRunner:

Public Member Functions
	__construct (Filesystem $file_system, ilResourceStorageMigrationHelper $irss_helper, string $log_file_name)

	migrate (ilFileObjectToStorageDirectory $item)
	@inheritDoc More...

	getMigrateToNewObjectId ()

	setMigrateToNewObjectId (?int $migrate_to_new_object_id)

Protected Attributes
string	$movement_implementation = ''

ConsumerFactory	$consumer_factory

Manager	$storage_manager

ResourceBuilder	$resource_builder

	$migration_log_handle

Filesystem	$file_system

ilDBInterface	$database

bool	$keep_originals = false

int	$migrate_to_new_object_id = null

ResourceStakeholder	$stakeholder

Private Member Functions
	logMigratedFile (int $object_id, string $rid, int $version, string $old_path, string $status, string $movement_implementation, string $aditional_info=null)

	getResource (ilFileObjectToStorageDirectory $item)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilFileObjectToStorageMigrationRunner::__construct	(	Filesystem	$file_system,
		ilResourceStorageMigrationHelper	$irss_helper,
		string	$log_file_name
	)

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

      {
        $this->file_system = $file_system;
        $this->database = $irss_helper->getDatabase();
 
        $legacy_directory = $irss_helper->getClientDataDir() . '/ilFile/';
        if (is_dir($legacy_directory)) {
            $this->migration_log_handle = fopen($legacy_directory . $log_file_name, 'ab');
        } else {
            $this->migration_log_handle = false;
        }
 
        $this->resource_builder = $irss_helper->getResourceBuilder();
        $this->storage_manager = $irss_helper->getManager();
        $this->stakeholder = $irss_helper->getStakeholder();
    }

References $file_system, ilResourceStorageMigrationHelper\getClientDataDir(), ilResourceStorageMigrationHelper\getDatabase(), ilResourceStorageMigrationHelper\getManager(), ilResourceStorageMigrationHelper\getResourceBuilder(), and ilResourceStorageMigrationHelper\getStakeholder().

Here is the call graph for this function:

Member Function Documentation

◆ getMigrateToNewObjectId()

ilFileObjectToStorageMigrationRunner::getMigrateToNewObjectId ( )

Returns: int|null

Definition at line 192 of file class.ilFileObjectToStorageMigrationRunner.php.

                                             : ?int
    {
        return $this->migrate_to_new_object_id;
    }

Referenced by migrate().

Here is the caller graph for this function:

◆ getResource()

ilFileObjectToStorageMigrationRunner::getResource ( ilFileObjectToStorageDirectory $item )

private

Parameters

ilFileObjectToStorageDirectory $item

Returns: StorableResource

Exceptions

ILIAS\ResourceStorage\Resource\ResourceNotFoundException

Definition at line 169 of file class.ilFileObjectToStorageMigrationRunner.php.

     : StorableResource {
        $r = $this->database->queryF(
            "SELECT rid FROM file_data WHERE file_id = %s",
            ['integer'],
            [$item->getObjectId()]
        );
        $d = $this->database->fetchObject($r);
 
        if (isset($d->rid) && $d->rid !== '' && ($resource_identification = $this->storage_manager->find(
            $d->rid
        )) && $resource_identification !== null) {
            $resource = $this->resource_builder->get($resource_identification);
        } else {
            $resource = $this->resource_builder->newBlank();
        }
        return $resource;
    }

Referenced by migrate().

Here is the caller graph for this function:

◆ logMigratedFile()

ilFileObjectToStorageMigrationRunner::logMigratedFile	(	int	$object_id,
		string	$rid,
		int	$version,
		string	$old_path,
		string	$status,
		string	$movement_implementation,
		string	$aditional_info = `null`
	)

private

Definition at line 141 of file class.ilFileObjectToStorageMigrationRunner.php.

     : void {
        if (!$this->migration_log_handle) {
            return;
        }
        fputcsv($this->migration_log_handle, [
            $object_id,
            $old_path,
            $rid,
            $version,
            $status,
            $movement_implementation,
            $aditional_info
        ], ";");
    }

Referenced by migrate().

Here is the caller graph for this function:

◆ migrate()

ilFileObjectToStorageMigrationRunner::migrate ( ilFileObjectToStorageDirectory $item )

@inheritDoc

Definition at line 78 of file class.ilFileObjectToStorageMigrationRunner.php.

                                                                 : void
    {
        $resource = $this->getResource($item);
 
        $object_id = $this->getMigrateToNewObjectId() ?? $item->getObjectId();
        foreach ($item->getVersions() as $version) {
            try {
                $status = 'success';
                $aditional_info = '';
 
                $stream = Streams::ofResource(fopen($version->getPath(), 'rb'));
 
                $info_resolver = new ilFileObjectToStorageInfoResolver(
                    $stream,
                    $version->getVersion(),
                    $version->getOwner(),
                    $version->getTitle(),
                    (new DateTimeImmutable())->setTimestamp($version->getCreationDateTimestamp())
                );
 
                $this->resource_builder->appendFromStream(
                    $resource,
                    $stream,
                    $info_resolver,
                    $this->keep_originals
                );
            } catch (Throwable $t) {
                $status = 'failed';
                $aditional_info = $t->getMessage();
            }
 
            $this->logMigratedFile(
                $object_id,
                $resource->getIdentification()->serialize(),
                $version->getVersion(),
                $version->getPath(),
                $status,
                $this->movement_implementation,
                $aditional_info
            );
        }
        $resource->addStakeholder($this->stakeholder);
        try {
            $this->resource_builder->store($resource);
            $this->database->manipulateF(
                'UPDATE file_data SET rid = %s WHERE file_id = %s',
                ['text', 'integer'],
                [$resource->getIdentification()->serialize(), $object_id]
            );
        } catch (FileNamePolicyException $e) {
            // continue
            $this->database->manipulateF(
                'UPDATE file_data SET rid = %s WHERE file_id = %s',
                ['text', 'integer'],
                ['error', $object_id]
            );
        }
 
        if (null === $this->getMigrateToNewObjectId()) {
            $item->tearDown();
        }
    }

References Vendor\Package\$e, $version, getMigrateToNewObjectId(), ilFileObjectToStorageDirectory\getObjectId(), getResource(), ilFileObjectToStorageDirectory\getVersions(), logMigratedFile(), and ilFileObjectToStorageDirectory\tearDown().

Here is the call graph for this function:

◆ setMigrateToNewObjectId()

ilFileObjectToStorageMigrationRunner::setMigrateToNewObjectId ( ?int $migrate_to_new_object_id )

Parameters

int | null $migrate_to_new_object_id

Returns: ilFileObjectToStorageMigrationRunner

Definition at line 201 of file class.ilFileObjectToStorageMigrationRunner.php.

                                                                           : ilFileObjectToStorageMigrationRunner
    {
        $this->migrate_to_new_object_id = $migrate_to_new_object_id;
        $this->keep_originals = true;
        return $this;
    }