Collaboration diagram for ilFileObjectToStorageMigrationRunner:

Public Member Functions
	__construct (Filesystem $file_system, ilDBInterface $database, string $log_file_path)
	ilFileObjectToStorageMigration constructor. More...

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

	getMigrateToNewObjectId ()

	setMigrateToNewObjectId (?int $migrate_to_new_object_id)

Protected Attributes
	$movement_implementation

	$consumer_factory

	$storage_manager

	$resource_builder

	$migration_log_handle

	$file_system

	$database

	$keep_originals = false

	$migrate_to_new_object_id = null

	$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 21 of file class.ilFileObjectToStorageMigrationRunner.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileObjectToStorageMigrationRunner::__construct	(	Filesystem	$file_system,
		ilDBInterface	$database,
		string	$log_file_path
	)

ilFileObjectToStorageMigration constructor.

Parameters

Filesystem	$file_system
ilDBInterface	$database

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

    {
        $this->file_system = $file_system;
        $this->database = $database;
        $this->migration_log_handle = fopen($log_file_path, 'ab');
 
        $storage_handler = new MaxNestingFileSystemStorageHandler($this->file_system, Location::STORAGE, true);
        $storage_handler_factory = new StorageHandlerFactory([
            $storage_handler
        ]);
 
        $this->movement_implementation = $storage_handler->movementImplementation();
 
        $revisionDBRepository = new RevisionDBRepository($database);
        $resourceDBRepository = new ResourceDBRepository($database);
        $informationDBRepository = new InformationDBRepository($database);
        $stakeholderDBRepository = new StakeholderDBRepository($database);
        $builder = new ResourceBuilder(
            $storage_handler_factory,
            $revisionDBRepository,
            $resourceDBRepository,
            $informationDBRepository,
            $stakeholderDBRepository,
            new LockHandlerilDB($database)
        );
        $this->resource_builder = $builder;
        $this->storage_manager = new Manager($builder, new StandardRepositoryPreloader(
            $resourceDBRepository,
            $revisionDBRepository,
            $informationDBRepository,
            $stakeholderDBRepository
        ));
        $this->consumer_factory = new ConsumerFactory($storage_handler_factory);
        $this->stakeholder = new ilObjFileStakeholder();
    }

References $builder, $database, and $file_system.

Member Function Documentation

◆ getMigrateToNewObjectId()

ilFileObjectToStorageMigrationRunner::getMigrateToNewObjectId ( )

Returns: int|null

Definition at line 210 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 192 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 167 of file class.ilFileObjectToStorageMigrationRunner.php.

      : void {
        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 109 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
        }
 
        if (null === $this->getMigrateToNewObjectId()) {
            $item->tearDown();
        }
    }

References Vendor\Package\$e, 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 219 of file class.ilFileObjectToStorageMigrationRunner.php.

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