Class ilResourceStorageMigrationHelper. More...

Collaboration diagram for ilResourceStorageMigrationHelper:

Public Member Functions
	__construct (ResourceStakeholder $stakeholder, Environment $environment)
	ilResourceStorageMigrationHelper constructor. More...

	getClientDataDir ()

	getDatabase ()

	getStakeholder ()

	getResourceBuilder ()

	getFlavourBuilder ()

	getCollectionBuilder ()

	getManager ()

	moveResourceToNewStakeholderAndOwner (ResourceIdentification $resource_identification, ResourceStakeholder $old_stakeholder, ResourceStakeholder $new_stakeholder, ?int $new_owner_id=null)

	moveFilesOfPatternToCollection (string $absolute_base_path, string $pattern, int $resource_owner_id, int $collection_owner_user_id=ResourceCollection::NO_SPECIFIC_OWNER, ?Closure $file_name_callback=null, ?Closure $revision_name_callback=null)

	moveFirstFileOfPatternToStorage (string $absolute_base_path, string $pattern, int $resource_owner_id, ?Closure $file_name_callback=null, ?Closure $revision_name_callback=null)

	movePathToStorage (string $absolute_path, int $owner_user_id, ?Closure $file_name_callback=null, ?Closure $revision_name_callback=null, ?bool $copy_instead_of_move=false)

	moveDirectoryToContainerResource (string $absolute_path_to_directory, int $owner_user_id,)

Static Public Member Functions
static	getPreconditions ()

Protected Member Functions
	buildRecursivePatternIterator (string $absolute_base_path, string $pattern='.*')

Protected Attributes
string	$client_data_dir

ilDBInterface	$database

FlavourBuilder	$flavour_builder

ResourceBuilder	$resource_builder

CollectionBuilder	$collection_builder

ResourceStakeholder	$stakeholder

Repositories	$repositories

Manager	$manager

Detailed Description

Class ilResourceStorageMigrationHelper.

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilResourceStorageMigrationHelper::__construct	(	ResourceStakeholder	$stakeholder,
		Environment	$environment
	)

ilResourceStorageMigrationHelper constructor.

Parameters

string	$client_data_dir
ilDBInterface	$database

PhpFieldAssignmentTypeMismatchInspection

Definition at line 64 of file class.ilResourceStorageMigrationHelper.php.

References $client_data_dir, $client_id, $container, $data_dir, Vendor\Package\$f, $stakeholder, InitResourceStorage\D_REPOSITORIES, InitResourceStorage\D_REPOSITORY_PRELOADER, and ILIAS\Setup\Environment\getResource().

       {
         $this->stakeholder = $stakeholder;
         $db = $environment->getResource(Environment::RESOURCE_DATABASE);
         $ilias_ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
         $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);
         $data_dir = $ilias_ini->readVariable('clients', 'datadir');
         $client_data_dir = "{$data_dir}/{$client_id}";
         if (!defined("CLIENT_WEB_DIR")) {
             define("CLIENT_WEB_DIR", dirname(__DIR__, 5) . "/public/data/" . $client_id);
         }
         if (!defined("ILIAS_WEB_DIR")) {
             define("ILIAS_WEB_DIR", 'public/data');
         }
         if (!defined("CLIENT_ID")) {
             define("CLIENT_ID", $client_id);
         }
         if (!defined("ILIAS_DATA_DIR")) {
             define("ILIAS_DATA_DIR", $data_dir);
         }
         $this->client_data_dir = $client_data_dir;
         $this->database = $db;
 
         if (!is_writable("{$data_dir}/{$client_id}/storage/fsv2")) {
             throw new Exception('storage directory is not writable, abort...');
         }
 
         // Build Container
         $init = new InitResourceStorage();
         $container = new Container();
         $container['ilDB'] = $db;
         $storageConfiguration = new LocalConfig($client_data_dir);
         $f = new FlySystemFilesystemFactory();
         $container['filesystem.storage'] = $f->getLocal($storageConfiguration);
 
         $this->resource_builder = $init->getResourceBuilder($container);
         $this->flavour_builder = $init->getFlavourBuilder($container);
         $this->collection_builder = new CollectionBuilder(
             new CollectionDBRepository($db),
             new Subject()
         );
 
         $this->repositories = $container[InitResourceStorage::D_REPOSITORIES];
 
         $this->manager = new Manager(
             $this->resource_builder,
             $this->collection_builder,
             $container[InitResourceStorage::D_REPOSITORY_PRELOADER]
         );
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildRecursivePatternIterator()

ilResourceStorageMigrationHelper::buildRecursivePatternIterator	(	string	$absolute_base_path,
		string	$pattern = `'.*'`
	)

protected

Definition at line 372 of file class.ilResourceStorageMigrationHelper.php.

Referenced by moveFilesOfPatternToCollection(), and moveFirstFileOfPatternToStorage().

      : RecursiveRegexIterator {
         return new RecursiveRegexIterator(
             new RecursiveDirectoryIterator($absolute_base_path),
             $pattern,
             RecursiveRegexIterator::MATCH
         );
     }

Here is the caller graph for this function:

◆ getClientDataDir()

ilResourceStorageMigrationHelper::getClientDataDir ( )

Definition at line 133 of file class.ilResourceStorageMigrationHelper.php.

References $client_data_dir.

                                       : string
     {
         return $this->client_data_dir;
     }

◆ getCollectionBuilder()

ilResourceStorageMigrationHelper::getCollectionBuilder ( )

Definition at line 157 of file class.ilResourceStorageMigrationHelper.php.

References $collection_builder.

Referenced by moveFilesOfPatternToCollection(), and moveResourceToNewStakeholderAndOwner().

                                           : CollectionBuilder
     {
         return $this->collection_builder;
     }

Here is the caller graph for this function:

◆ getDatabase()

ilResourceStorageMigrationHelper::getDatabase ( )

Definition at line 138 of file class.ilResourceStorageMigrationHelper.php.

References $database.

                                  : ilDBInterface
     {
         return $this->database;
     }

◆ getFlavourBuilder()

ilResourceStorageMigrationHelper::getFlavourBuilder ( )

Definition at line 152 of file class.ilResourceStorageMigrationHelper.php.

References $flavour_builder.

                                        : FlavourBuilder
     {
         return $this->flavour_builder;
     }

◆ getManager()

ilResourceStorageMigrationHelper::getManager ( )

Definition at line 162 of file class.ilResourceStorageMigrationHelper.php.

References $manager.

                                 : Manager
     {
         return $this->manager;
     }

◆ getPreconditions()

static ilResourceStorageMigrationHelper::getPreconditions ( )

static

Returns: []|[]|[]

Definition at line 121 of file class.ilResourceStorageMigrationHelper.php.

Referenced by ilTestQuestionPoolFileUploadQuestionMigration\getPreconditions(), ilExportFilesToIRSSMigration\getPreconditions(), ilStyleIRSSMigration\getPreconditions(), ilMobMigration\getPreconditions(), ilHTLMMigration\getPreconditions(), ilBadgeTemplatesFilesMigration\getPreconditions(), ilBadgesFilesMigration\getPreconditions(), ilDataCollectionStorageMigration\getPreconditions(), and ILIAS\File\Icon\ilObjFileDefaultIconsObjective\getPreconditions().

                                              : array
     {
         return [
             new ilIniFilesLoadedObjective(),
             new ilDatabaseInitializedObjective(),
             new ilDatabaseUpdatedObjective(),
             new ilDatabaseUpdateStepsExecutedObjective(new ilResourceStorageDB80()),
             new ilDatabaseUpdateStepsExecutedObjective(new ilResourceStorageDB90()),
             new ilStorageContainersExistingObjective()
         ];
     }

Here is the caller graph for this function:

◆ getResourceBuilder()

ilResourceStorageMigrationHelper::getResourceBuilder ( )

Definition at line 148 of file class.ilResourceStorageMigrationHelper.php.

References $resource_builder.

                                         : ResourceBuilder
     {
         return $this->resource_builder;
     }

◆ getStakeholder()

ilResourceStorageMigrationHelper::getStakeholder ( )

Definition at line 143 of file class.ilResourceStorageMigrationHelper.php.

References $stakeholder.

                                     : ResourceStakeholder
     {
         return $this->stakeholder;
     }

◆ moveDirectoryToContainerResource()

ilResourceStorageMigrationHelper::moveDirectoryToContainerResource	(	string	$absolute_path_to_directory,
		int	$owner_user_id
	)

Definition at line 329 of file class.ilResourceStorageMigrationHelper.php.

References Vendor\Package\$e, and ILIAS\ResourceStorage\Resource\CONTAINER.

      : ?ResourceIdentification {
         // check if directory exists
         if (!is_dir($absolute_path_to_directory)) {
             return null;
         }
 
         $zip = new Zip(
             (new ZipOptions())->withDirectoryHandling(ZipDirectoryHandling::KEEP_STRUCTURE)
         );
         $zip->addDirectory($absolute_path_to_directory);
         try {
             $zip_stream = $zip->get();
         } catch (Throwable $e) {
             $zip->destroy();
             return null; // could not create zip
         }
 
         $resource = $this->resource_builder->newFromStream(
             $zip_stream,
             new StreamInfoResolver(
                 $zip_stream,
                 1,
                 $owner_user_id,
                 basename($absolute_path_to_directory),
                 basename($absolute_path_to_directory)
             ),
             true,
             ResourceType::CONTAINER
         );
 
         // add stakeholder and store resource
         $resource->addStakeholder($this->stakeholder);
         $this->resource_builder->store($resource);
 
         // ZIP archive is not needed anymore
         $zip->destroy();
 
         return $resource->getIdentification();
     }

◆ moveFilesOfPatternToCollection()

ilResourceStorageMigrationHelper::moveFilesOfPatternToCollection	(	string	$absolute_base_path,
		string	$pattern,
		int	$resource_owner_id,
		int	$collection_owner_user_id = `ResourceCollection::NO_SPECIFIC_OWNER`,
		?Closure	$file_name_callback = `null`,
		?Closure	$revision_name_callback = `null`
	)

Definition at line 219 of file class.ilResourceStorageMigrationHelper.php.

References buildRecursivePatternIterator(), getCollectionBuilder(), and movePathToStorage().

      : ?ResourceCollectionIdentification {
         $collection = $this->getCollectionBuilder()->new($collection_owner_user_id);
 
         $regex_iterator = $this->buildRecursivePatternIterator($absolute_base_path, $pattern);
 
         foreach ($regex_iterator as $file_info) {
             if (!$file_info->isFile()) {
                 continue;
             }
             $resource_id = $this->movePathToStorage(
                 $file_info->getRealPath(),
                 $resource_owner_id,
                 $file_name_callback,
                 $revision_name_callback
             );
             if ($resource_id !== null) {
                 $collection->add($resource_id);
             }
         }
         if ($collection->count() === 0) {
             return null;
         }
 
         if ($this->getCollectionBuilder()->store($collection)) {
             return $collection->getIdentification();
         }
         return null;
     }

Here is the call graph for this function:

◆ moveFirstFileOfPatternToStorage()

ilResourceStorageMigrationHelper::moveFirstFileOfPatternToStorage	(	string	$absolute_base_path,
		string	$pattern,
		int	$resource_owner_id,
		?Closure	$file_name_callback = `null`,
		?Closure	$revision_name_callback = `null`
	)

Definition at line 255 of file class.ilResourceStorageMigrationHelper.php.

References buildRecursivePatternIterator(), and movePathToStorage().

      : ?ResourceIdentification {
         $regex_iterator = $this->buildRecursivePatternIterator($absolute_base_path, $pattern);
 
         foreach ($regex_iterator as $file_info) {
             if (!$file_info->isFile()) {
                 continue;
             }
             $resource_id = $this->movePathToStorage(
                 $file_info->getRealPath(),
                 $resource_owner_id,
                 $file_name_callback,
                 $revision_name_callback
             );
             if ($resource_id !== null) {
                 return $resource_id; // stop after first file
             }
         }
 
         return null;
     }

Here is the call graph for this function:

◆ movePathToStorage()

ilResourceStorageMigrationHelper::movePathToStorage	(	string	$absolute_path,
		int	$owner_user_id,
		?Closure	$file_name_callback = `null`,
		?Closure	$revision_name_callback = `null`,
		?bool	$copy_instead_of_move = `false`
	)

Definition at line 282 of file class.ilResourceStorageMigrationHelper.php.

References Vendor\Package\$e.

Referenced by moveFilesOfPatternToCollection(), moveFirstFileOfPatternToStorage(), and moveResourceToNewStakeholderAndOwner().

      : ?ResourceIdentification {
         try {
             // in some cases fopen throws a warning instead of returning false
             $open_path = fopen($absolute_path, 'rb');
         } catch (Throwable $e) {
             return null;
         }
 
         if ($open_path === false) {
             return null;
         }
         $stream = Streams::ofResource($open_path);
 
         // create new resource from legacy files stream
         $revision_title = $revision_name_callback !== null
             ? $revision_name_callback(basename($absolute_path))
             : basename($absolute_path);
 
         $file_name = $file_name_callback !== null
             ? $file_name_callback(basename($absolute_path))
             : null;
 
         $resource = $this->resource_builder->newFromStream(
             $stream,
             new StreamInfoResolver(
                 $stream,
                 1,
                 $owner_user_id,
                 $revision_title,
                 $file_name
             ),
             $copy_instead_of_move ?? false
         );
 
         // add stakeholder and store resource
         $resource->addStakeholder($this->stakeholder);
         $this->resource_builder->store($resource);
 
         return $resource->getIdentification();
     }

Here is the caller graph for this function:

◆ moveResourceToNewStakeholderAndOwner()

ilResourceStorageMigrationHelper::moveResourceToNewStakeholderAndOwner	(	ResourceIdentification	$resource_identification,
		ResourceStakeholder	$old_stakeholder,
		ResourceStakeholder	$new_stakeholder,
		?int	$new_owner_id = `null`
	)

Definition at line 167 of file class.ilResourceStorageMigrationHelper.php.

References getCollectionBuilder(), and movePathToStorage().

      : void {
         $resource = $this->manager->getResource($resource_identification);
         $resource->removeStakeholder($old_stakeholder);
         $this->repositories->getStakeholderRepository()->deregister($resource_identification, $old_stakeholder);
         $resource->addStakeholder($new_stakeholder);
         $this->repositories->getStakeholderRepository()->register($resource_identification, $new_stakeholder);
 
         if ($new_owner_id !== null) {
             foreach ($resource->getAllRevisionsIncludingDraft() as $revision) {
                 $revision->setOwnerId($new_owner_id);
             }
         }
 
         $this->resource_builder->store($resource);
     }