ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilResourceStorageMigrationHelper Class Reference

Class ilResourceStorageMigrationHelper. More...

+ Collaboration diagram for ilResourceStorageMigrationHelper:

Public Member Functions

 __construct (protected 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
 
Repositories $repositories
 
Manager $manager
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

ilResourceStorageMigrationHelper constructor.

Parameters
string$client_data_dir
ilDBInterface$database

@noinspection PhpFieldAssignmentTypeMismatchInspection

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

63 {
65 $db = $environment->getResource(Environment::RESOURCE_DATABASE);
66 $ilias_ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
67 $client_id = $environment->getResource(Environment::RESOURCE_CLIENT_ID);
68 $data_dir = $ilias_ini->readVariable('clients', 'datadir');
69 $client_data_dir = "{$data_dir}/{$client_id}";
70 if (!defined("CLIENT_WEB_DIR")) {
71 define("CLIENT_WEB_DIR", dirname(__DIR__, 5) . "/public/data/" . $client_id);
72 }
73 if (!defined("ILIAS_WEB_DIR")) {
74 define("ILIAS_WEB_DIR", 'public/data');
75 }
76 if (!defined("CLIENT_ID")) {
77 define("CLIENT_ID", $client_id);
78 }
79 if (!defined("ILIAS_DATA_DIR")) {
80 define("ILIAS_DATA_DIR", $data_dir);
81 }
82 $this->client_data_dir = $client_data_dir;
83 $this->database = $db;
84
85 if (!is_writable("{$data_dir}/{$client_id}/storage/fsv2")) {
86 throw new Exception('storage directory is not writable, abort...');
87 }
88
89 // Build Container
90 $init = new InitResourceStorage();
91 $container = new Container();
92 $container['ilDB'] = $db;
93 $storageConfiguration = new LocalConfig($client_data_dir);
95 $container['filesystem.storage'] = $f->getLocal($storageConfiguration);
96
97 $this->resource_builder = $init->getResourceBuilder($container);
98 $this->flavour_builder = $init->getFlavourBuilder($container);
99 $this->collection_builder = new CollectionBuilder(
100 new CollectionDBRepository($db),
101 new Subject()
102 );
103
104 $this->repositories = $container[InitResourceStorage::D_REPOSITORIES];
105
106 $this->manager = new Manager(
107 $this->resource_builder,
108 $this->collection_builder,
110 );
111 }
Customizing of pimple-DIC for ILIAS.
Definition: Container.php:36
This class is used to configure the local filesystem adapter.
Definition: LocalConfig.php:30
Responsible for loading the Resource Storage into the dependency injection container of ILIAS.
getResource(string $id)
Consumers of this method should check if the result is what they expect, e.g.
$client_id
Definition: ltiauth.php:67
$container
@noRector
Definition: wac.php:37

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

+ Here is the call graph for this function:

Member Function Documentation

◆ buildRecursivePatternIterator()

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

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

370 : RecursiveRegexIterator {
371 return new RecursiveRegexIterator(
372 new RecursiveDirectoryIterator($absolute_base_path),
373 $pattern,
374 RecursiveRegexIterator::MATCH
375 );
376 }

◆ getClientDataDir()

ilResourceStorageMigrationHelper::getClientDataDir ( )

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

128 : string
129 {
131 }

References $client_data_dir.

◆ getCollectionBuilder()

ilResourceStorageMigrationHelper::getCollectionBuilder ( )

◆ getDatabase()

ilResourceStorageMigrationHelper::getDatabase ( )

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

134 {
135 return $this->database;
136 }
Interface ilDBInterface.

References $database.

◆ getFlavourBuilder()

ilResourceStorageMigrationHelper::getFlavourBuilder ( )

◆ getManager()

ilResourceStorageMigrationHelper::getManager ( )

◆ getPreconditions()

static ilResourceStorageMigrationHelper::getPreconditions ( )
static
Returns
\ilDatabaseInitializedObjective[]|\ilDatabaseUpdatedObjective[]|\ilIniFilesLoadedObjective[]

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

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

+ Here is the caller graph for this function:

◆ getResourceBuilder()

ilResourceStorageMigrationHelper::getResourceBuilder ( )

◆ getStakeholder()

ilResourceStorageMigrationHelper::getStakeholder ( )

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

139 {
140 return $this->stakeholder;
141 }

◆ moveDirectoryToContainerResource()

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

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

328 // check if directory exists
329 if (!is_dir($absolute_path_to_directory)) {
330 return null;
331 }
332
333 $zip = new Zip(
334 (new ZipOptions())->withDirectoryHandling(ZipDirectoryHandling::KEEP_STRUCTURE)
335 );
336 $zip->addDirectory($absolute_path_to_directory);
337 try {
338 $zip_stream = $zip->get();
339 } catch (Throwable $e) {
340 $zip->destroy();
341 return null; // could not create zip
342 }
343
344 $resource = $this->resource_builder->newFromStream(
345 $zip_stream,
347 $zip_stream,
348 1,
349 $owner_user_id,
350 basename($absolute_path_to_directory),
351 basename($absolute_path_to_directory)
352 ),
353 true,
355 );
356
357 // add stakeholder and store resource
358 $resource->addStakeholder($this->stakeholder);
359 $this->resource_builder->store($resource);
360
361 // ZIP archive is not needed anymore
362 $zip->destroy();
363
364 return $resource->getIdentification();
365 }

◆ 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 214 of file class.ilResourceStorageMigrationHelper.php.

222 $collection = $this->getCollectionBuilder()->new($collection_owner_user_id);
223
224 $regex_iterator = $this->buildRecursivePatternIterator($absolute_base_path, $pattern);
225
226 foreach ($regex_iterator as $file_info) {
227 if (!$file_info->isFile()) {
228 continue;
229 }
230 $resource_id = $this->movePathToStorage(
231 $file_info->getRealPath(),
232 $resource_owner_id,
233 $file_name_callback,
234 $revision_name_callback
235 );
236 if ($resource_id !== null) {
237 $collection->add($resource_id);
238 }
239 }
240 if ($collection->count() === 0) {
241 return null;
242 }
243
244 if ($this->getCollectionBuilder()->store($collection)) {
245 return $collection->getIdentification();
246 }
247 return null;
248 }
buildRecursivePatternIterator(string $absolute_base_path, string $pattern='.*')
movePathToStorage(string $absolute_path, int $owner_user_id, ?Closure $file_name_callback=null, ?Closure $revision_name_callback=null, ?bool $copy_instead_of_move=false)

◆ 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 250 of file class.ilResourceStorageMigrationHelper.php.

257 $regex_iterator = $this->buildRecursivePatternIterator($absolute_base_path, $pattern);
258
259 foreach ($regex_iterator as $file_info) {
260 if (!$file_info->isFile()) {
261 continue;
262 }
263 $resource_id = $this->movePathToStorage(
264 $file_info->getRealPath(),
265 $resource_owner_id,
266 $file_name_callback,
267 $revision_name_callback
268 );
269 if ($resource_id !== null) {
270 return $resource_id; // stop after first file
271 }
272 }
273
274 return null;
275 }

◆ 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 277 of file class.ilResourceStorageMigrationHelper.php.

284 try {
285 // in some cases fopen throws a warning instead of returning false
286 $open_path = fopen($absolute_path, 'rb');
287 } catch (Throwable) {
288 return null;
289 }
290
291 if ($open_path === false) {
292 return null;
293 }
294 $stream = Streams::ofResource($open_path);
295
296 // create new resource from legacy files stream
297 $revision_title = $revision_name_callback !== null
298 ? $revision_name_callback(basename($absolute_path))
299 : basename($absolute_path);
300
301 $file_name = $file_name_callback !== null
302 ? $file_name_callback(basename($absolute_path))
303 : null;
304
305 $resource = $this->resource_builder->newFromStream(
306 $stream,
308 $stream,
309 1,
310 $owner_user_id,
311 $revision_title,
312 $file_name
313 ),
314 $copy_instead_of_move ?? false
315 );
316
317 // add stakeholder and store resource
318 $resource->addStakeholder($this->stakeholder);
319 $this->resource_builder->store($resource);
320
321 return $resource->getIdentification();
322 }

◆ moveResourceToNewStakeholderAndOwner()

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

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

167 : void {
168 $resource = $this->manager->getResource($resource_identification);
169 $resource->removeStakeholder($old_stakeholder);
170 $this->repositories->getStakeholderRepository()->deregister($resource_identification, $old_stakeholder);
171 $resource->addStakeholder($new_stakeholder);
172 $this->repositories->getStakeholderRepository()->register($resource_identification, $new_stakeholder);
173
174 if ($new_owner_id !== null) {
175 foreach ($resource->getAllRevisionsIncludingDraft() as $revision) {
176 $revision->setOwnerId($new_owner_id);
177 }
178 }
179
180 $this->resource_builder->store($resource);
181 }

Field Documentation

◆ $client_data_dir

string ilResourceStorageMigrationHelper::$client_data_dir
protected

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

Referenced by __construct(), and getClientDataDir().

◆ $collection_builder

CollectionBuilder ilResourceStorageMigrationHelper::$collection_builder
protected

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

Referenced by getCollectionBuilder().

◆ $database

ilDBInterface ilResourceStorageMigrationHelper::$database
protected

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

Referenced by getDatabase().

◆ $flavour_builder

FlavourBuilder ilResourceStorageMigrationHelper::$flavour_builder
protected

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

Referenced by getFlavourBuilder().

◆ $manager

Manager ilResourceStorageMigrationHelper::$manager
protected

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

Referenced by getManager().

◆ $repositories

Repositories ilResourceStorageMigrationHelper::$repositories
protected

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

◆ $resource_builder

ResourceBuilder ilResourceStorageMigrationHelper::$resource_builder
protected

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

Referenced by getResourceBuilder().


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