Migrates mail attachments to the IRSS, the attachments of the most recently sent mails first, because these are the ones users access most (e.g. More...

Inheritance diagram for ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS:

Collaboration diagram for ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS:

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...

	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...

Private Member Functions
	migrateSentAttachmentDirectories ()
	Sent and received mails share one directory per sending process. More...

	copyDirectoryToCollection (string $absolute_path, array $filenames, int $owner_id)
	Files stay on disk until the collection is stored and the mail rows point at it. More...

	discardResources (array $resource_ids)
	Copies of a directory that could not be migrated completely are removed, the next run copies it again. More...

	listDirectoryFiles (string $absolute_path)

	deleteMigratedDirectory (string $absolute_path)

	nextUnmigratedPaths ()

	skipPath (string $relative_path, string $reason)

	mailIdsOfPath (string $relative_path)

	migrateSerializedMailAttachments ()
	Drafts and scheduled mails reference files of the user's attachment pool. More...

	migrateSerializedMail (int $mail_id, int $user_id, string $raw_attachments, string $mail_path, bool $references_pool)

	migratePoolFilenamesToCollection (array $filenames, int $user_id, string $mail_path, int $mail_id)
	Pool files are copied, not moved: The same pool file may be referenced by several drafts and stays available in the user's pool, where it is migrated when it is used the next time. More...

	markConfidential (ResourceIdentification $identification)

	markCollectionResourcesConfidential (ResourceCollectionIdentification $rcid)

	clearMailAttachmentsColumn (int $mail_id)

	resolveOwnerIdForPath (string $relative_path)

	assignRcidToPath (string $relative_path, ResourceCollectionIdentification $rcid)

	updateMailAttachmentFields (string $relative_path, ResourceCollectionIdentification $rcid)

	markPathAsSkipped (string $relative_path)

	resolveAdminInteraction (Environment $environment)

	count (string $key, int $amount=1)

	info (string $message, array $context=[])

	warning (string $message, array $context=[])

	error (string $message, array $context=[], ?Throwable $exception=null)

	report (string $level, string $message, array $context)

Private Attributes
const int	PATHS_PER_STEP = 25

const int	MAILS_PER_STEP = 50

const string	SKIPPED_MARKER = '-'

ilResourceStorageMigrationHelper	$helper = null

AdminInteraction	$io = null

int	$step_number = 0

array	$statistics = []

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

Detailed Description

Migrates mail attachments to the IRSS, the attachments of the most recently sent mails first, because these are the ones users access most (e.g.

the first page of their inbox).

Definition at line 41 of file MigrateMailAttachmentsToIRSS.php.

Member Function Documentation

◆ assignRcidToPath()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::assignRcidToPath	(	string	$relative_path,
		ResourceCollectionIdentification	$rcid
	)

private

Definition at line 518 of file MigrateMailAttachmentsToIRSS.php.

                                                                                                    : void
    {
        $this->helper->getDatabase()->manipulateF(
            'UPDATE mail_attachment SET rcid = %s WHERE path = %s',
            [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
            [$rcid->serialize(), $relative_path]
        );
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize(), and ilDBConstants\T_TEXT.

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearMailAttachmentsColumn()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::clearMailAttachmentsColumn ( int $mail_id )

private

Definition at line 449 of file MigrateMailAttachmentsToIRSS.php.

                                                             : void
    {
        $this->helper->getDatabase()->update(
            'mail',
            [
                'attachments' => [ilDBConstants::T_CLOB, ''],
            ],
            [
                'mail_id' => [ilDBConstants::T_INTEGER, $mail_id],
            ]
        );
    }

References ilDBConstants\T_CLOB, and ilDBConstants\T_INTEGER.

◆ copyDirectoryToCollection()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::copyDirectoryToCollection	(	string	$absolute_path,
		array	$filenames,
		int	$owner_id
	)

private

Files stay on disk until the collection is stored and the mail rows point at it.

A rerun can therefore still read them when this step stops in between.

Parameters

list<string> $filenames

Definition at line 163 of file MigrateMailAttachmentsToIRSS.php.

     : ?ResourceCollectionIdentification {
        $collection = $this->helper->getCollectionBuilder()->new($owner_id);
        $copies = [];
        foreach ($filenames as $file_name) {
            $resource_id = $this->helper->movePathToStorage(
                $absolute_path . '/' . $file_name,
                $owner_id,
                null,
                static fn(string $name): string => md5($name),
                true
            );
            if (!$resource_id instanceof ResourceIdentification) {
                $this->discardResources($copies);
 
                return null;
            }
            $copies[] = $resource_id;
            $collection->add($resource_id);
        }
 
        if ($collection->count() !== count($filenames)
            || !$this->helper->getCollectionBuilder()->store($collection)) {
            $this->discardResources($copies);
 
            return null;
        }
 
        return $collection->getIdentification();
    }

References ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\discardResources().

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ count()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::count	(	string	$key,
		int	$amount = `1`
	)

private

Definition at line 558 of file MigrateMailAttachmentsToIRSS.php.

                                                        : void
    {
        $this->statistics[$key] = ($this->statistics[$key] ?? 0) + $amount;
    }

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the caller graph for this function:

◆ deleteMigratedDirectory()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::deleteMigratedDirectory ( string $absolute_path )

private

Definition at line 226 of file MigrateMailAttachmentsToIRSS.php.

                                                                   : void
    {
        foreach ($this->listDirectoryFiles($absolute_path) as $file_name) {
            unlink($absolute_path . '/' . $file_name);
        }
        rmdir($absolute_path);
    }

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the caller graph for this function:

◆ discardResources()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::discardResources ( array $resource_ids )

private

Copies of a directory that could not be migrated completely are removed, the next run copies it again.

Parameters

list<ResourceIdentification> $resource_ids

Definition at line 202 of file MigrateMailAttachmentsToIRSS.php.

                                                          : void
    {
        foreach ($resource_ids as $resource_id) {
            $this->helper->getManager()->remove($resource_id, $this->helper->getStakeholder());
        }
    }

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\copyDirectoryToCollection().

Here is the caller graph for this function:

◆ error()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::error	(	string	$message,
		array	$context = `[]`,
		?Throwable	$exception = `null`
	)

private

Parameters

array<string,mixed> $context

Definition at line 582 of file MigrateMailAttachmentsToIRSS.php.

                                                                                              : void
    {
        if ($exception !== null) {
            $context['exception'] = $exception::class . ': ' . $exception->getMessage() .
                ' (' . $exception->getFile() . ':' . $exception->getLine() . ')';
        }
 
        $this->report('ERROR', $message, $context);
    }

References $message.

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\step().

Here is the caller graph for this function:

◆ getDefaultAmountOfStepsPerRun()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::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 59 of file MigrateMailAttachmentsToIRSS.php.

◆ getLabel()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::getLabel ( )

Returns: string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

Definition at line 54 of file MigrateMailAttachmentsToIRSS.php.

                              : string
    {
        return 'Migrate Mail Attachments to IRSS';
    }

◆ getPreconditions()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::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 64 of file MigrateMailAttachmentsToIRSS.php.

                                                              : array
    {
        return array_merge(
            ilResourceStorageMigrationHelper::getPreconditions(),
            [new ilDatabaseUpdateStepsExecutedObjective(new MailDBUpdateSteps12())]
        );
    }

References ilResourceStorageMigrationHelper\getPreconditions().

Here is the call graph for this function:

◆ getRemainingAmountOfSteps()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::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 462 of file MigrateMailAttachmentsToIRSS.php.

                                               : int
    {
        $db = $this->helper->getDatabase();
 
        $path_count = (int) $db->fetchAssoc(
            $db->query(
                'SELECT COUNT(DISTINCT path) cnt FROM mail_attachment
                 WHERE (rcid IS NULL OR rcid = "")
                 AND path IS NOT NULL AND path != ""'
            )
        )['cnt'];
 
        $mail_count = (int) $db->fetchAssoc(
            $db->query(
                'SELECT COUNT(m.mail_id) cnt FROM mail m
                 LEFT JOIN mail_attachment ma ON ma.mail_id = m.mail_id
                 WHERE ma.mail_id IS NULL
                 AND m.attachments LIKE ' . $db->quote('a:%', ilDBConstants::T_TEXT)
            )
        )['cnt'];
 
        $remaining = max(
            (int) ceil($path_count / self::PATHS_PER_STEP),
            (int) ceil($mail_count / self::MAILS_PER_STEP)
        );
 
        $this->info('Remaining', [
            'directories' => $path_count,
            'drafts' => $mail_count,
            'steps' => $remaining,
        ]);
 
        return $remaining;
    }

References ILIAS\UI\examples\MessageBox\Info\info(), ILIAS\Repository\int(), and ilDBConstants\T_TEXT.

Here is the call graph for this function:

◆ info()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::info	(	string	$message,
		array	$context = `[]`
	)

private

Parameters

array<string,mixed> $context

Definition at line 566 of file MigrateMailAttachmentsToIRSS.php.

                                                               : void
    {
        $this->report('INFO', $message, $context);
    }

References $message.

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\step().

Here is the caller graph for this function:

◆ listDirectoryFiles()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::listDirectoryFiles ( string $absolute_path )

private

Returns: list<string>

Definition at line 212 of file MigrateMailAttachmentsToIRSS.php.

                                                              : array
    {
        $filenames = [];
        foreach (new \DirectoryIterator($absolute_path) as $file_info) {
            if (!$file_info->isFile()) {
                continue;
            }
            $filenames[] = $file_info->getFilename();
        }
        sort($filenames);
 
        return $filenames;
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort().

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mailIdsOfPath()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::mailIdsOfPath ( string $relative_path )

private

Returns: list<int>

Definition at line 274 of file MigrateMailAttachmentsToIRSS.php.

                                                         : array
    {
        $db = $this->helper->getDatabase();
        $res = $db->queryF(
            'SELECT mail_id FROM mail_attachment WHERE path = %s',
            [ilDBConstants::T_TEXT],
            [$relative_path]
        );
 
        $mail_ids = [];
        while ($row = $db->fetchAssoc($res)) {
            $mail_ids[] = (int) $row['mail_id'];
        }
 
        return $mail_ids;
    }

References ILIAS\$db, $res, ILIAS\Repository\int(), and ilDBConstants\T_TEXT.

Here is the call graph for this function:

◆ markCollectionResourcesConfidential()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::markCollectionResourcesConfidential ( ResourceCollectionIdentification $rcid )

private

Definition at line 442 of file MigrateMailAttachmentsToIRSS.php.

                                                                                                : void
    {
        foreach ($this->helper->getCollectionBuilder()->get($rcid)->getResourceIdentifications() as $identification) {
            $this->markConfidential($identification);
        }
    }

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the caller graph for this function:

◆ markConfidential()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::markConfidential ( ResourceIdentification $identification )

private

Definition at line 437 of file MigrateMailAttachmentsToIRSS.php.

                                                                             : void
    {
        $this->helper->getManager()->setConfidential($identification, true);
    }

◆ markPathAsSkipped()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::markPathAsSkipped ( string $relative_path )

private

Definition at line 542 of file MigrateMailAttachmentsToIRSS.php.

                                                             : void
    {
        $this->helper->getDatabase()->manipulateF(
            'UPDATE mail_attachment SET rcid = %s WHERE path = %s',
            [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
            [self::SKIPPED_MARKER, $relative_path]
        );
    }

References ilDBConstants\T_TEXT.

◆ migratePoolFilenamesToCollection()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::migratePoolFilenamesToCollection	(	array	$filenames,
		int	$user_id,
		string	$mail_path,
		int	$mail_id
	)

private

Pool files are copied, not moved: The same pool file may be referenced by several drafts and stays available in the user's pool, where it is migrated when it is used the next time.

Parameters

list<string> $filenames

Definition at line 390 of file MigrateMailAttachmentsToIRSS.php.

     : ?ResourceCollectionIdentification {
        $collection = $this->helper->getCollectionBuilder()->new($user_id);
 
        foreach ($filenames as $filename) {
            $absolute_path = $mail_path . '/' . $user_id . '_' . $filename;
            if ($filename === '' || str_contains($filename, '/') || str_contains($filename, '\\') || !is_file($absolute_path)) {
                $this->warning('Pool file referenced by the mail does not exist', [
                    'mail_id' => $mail_id,
                    'file' => $filename,
                ]);
 
                continue;
            }
 
            // Pool files are stored as "<user_id>_<name>" on disk, the users only know the name
            $resource_id = $this->helper->movePathToStorage(
                $absolute_path,
                $user_id,
                static fn(): string => $filename,
                static fn(): string => md5($filename),
                true
            );
 
            if ($resource_id instanceof ResourceIdentification) {
                $this->markConfidential($resource_id);
                $collection->add($resource_id);
            }
        }
 
        if ($collection->count() === 0) {
            return null;
        }
 
        if (!$this->helper->getCollectionBuilder()->store($collection)) {
            $this->discardResources(array_values($collection->getResourceIdentifications()));
 
            return null;
        }
 
        return $collection->getIdentification();
    }

References $filename, and $user_id.

◆ migrateSentAttachmentDirectories()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::migrateSentAttachmentDirectories ( )

private

Sent and received mails share one directory per sending process.

All mails referencing a directory get the same collection, the mail_attachment rows are used for reference counting.

Definition at line 113 of file MigrateMailAttachmentsToIRSS.php.

                                                       : void
    {
        $mail_path = rtrim($this->helper->getClientDataDir(), '/') . '/mail';
 
        foreach ($this->nextUnmigratedPaths() as $relative_path) {
            $absolute_path = $mail_path . '/' . $relative_path;
            if (trim($relative_path, '/. ') === '' || str_contains($relative_path, '..')) {
                $this->skipPath($relative_path, 'Invalid directory name');
 
                continue;
            }
 
            if (!is_dir($absolute_path)) {
                $this->skipPath($relative_path, 'Directory does not exist');
 
                continue;
            }
 
            $filenames = $this->listDirectoryFiles($absolute_path);
            if ($filenames === []) {
                $this->skipPath($relative_path, 'No file of the directory could be stored');
 
                continue;
            }
 
            $owner_id = $this->resolveOwnerIdForPath($relative_path);
            $rcid = $this->copyDirectoryToCollection($absolute_path, $filenames, $owner_id);
            if ($rcid === null) {
                $this->warning('Directory was not migrated because not every file could be stored', [
                    'path' => $relative_path,
                    'files' => count($filenames),
                ]);
 
                continue;
            }
 
            $this->markCollectionResourcesConfidential($rcid);
            $this->assignRcidToPath($relative_path, $rcid);
            $this->updateMailAttachmentFields($relative_path, $rcid);
            $this->deleteMigratedDirectory($absolute_path);
            $this->count('directories_migrated');
        }
    }

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\step().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ migrateSerializedMail()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::migrateSerializedMail	(	int	$mail_id,
		int	$user_id,
		string	$raw_attachments,
		string	$mail_path,
		bool	$references_pool
	)

private

Definition at line 328 of file MigrateMailAttachmentsToIRSS.php.

     : void {
        $attachments = MailAttachments::fromDb($raw_attachments);
        if ($attachments === null || !$attachments->isLegacy()) {
            if ($attachments === null) {
                $this->warning('Attachments of mail could not be read and have been removed', [
                    'mail_id' => $mail_id,
                    'value' => substr($raw_attachments, 0, 200),
                ]);
            }
            $this->clearMailAttachmentsColumn($mail_id);
 
            return;
        }
 
        // Sent and received mails reference a directory. Without one, files of the owner's pool must not be attached.
        if (!$references_pool) {
            $this->warning('Mail outside drafts and outbox has no attachment directory, its attachments have been removed', [
                'mail_id' => $mail_id,
                'files' => $attachments->legacyFilenames(),
            ]);
            $this->clearMailAttachmentsColumn($mail_id);
 
            return;
        }
 
        $rcid = $this->migratePoolFilenamesToCollection($attachments->legacyFilenames(), $user_id, $mail_path, $mail_id);
        if ($rcid === null) {
            $this->warning('None of the pool files referenced by the mail exists, its attachments have been removed', [
                'mail_id' => $mail_id,
                'files' => $attachments->legacyFilenames(),
            ]);
            $this->clearMailAttachmentsColumn($mail_id);
 
            return;
        }
 
        $db = $this->helper->getDatabase();
        $db->manipulateF(
            'INSERT INTO mail_attachment (mail_id, path, rcid) VALUES (%s, %s, %s)',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
            [$mail_id, '', $rcid->serialize()]
        );
        $db->update(
            'mail',
            ['attachments' => [ilDBConstants::T_CLOB, $rcid->serialize()]],
            ['mail_id' => [ilDBConstants::T_INTEGER, $mail_id]]
        );
        $this->count('drafts_migrated');
    }

◆ migrateSerializedMailAttachments()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::migrateSerializedMailAttachments ( )

private

Drafts and scheduled mails reference files of the user's attachment pool.

Mails referencing a directory are handled by migrateSentAttachmentDirectories() and must never be treated as pool references.

Definition at line 299 of file MigrateMailAttachmentsToIRSS.php.

                                                       : void
    {
        $db = $this->helper->getDatabase();
        $db->setLimit(self::MAILS_PER_STEP);
        $res = $db->query(
            'SELECT m.mail_id, m.user_id, m.attachments, fo.m_type FROM mail m
             LEFT JOIN mail_attachment ma ON ma.mail_id = m.mail_id
             LEFT JOIN mail_obj_data fo ON fo.obj_id = m.folder_id
             WHERE ma.mail_id IS NULL
             AND m.attachments LIKE ' . $db->quote('a:%', ilDBConstants::T_TEXT) . '
             ORDER BY m.send_time DESC, m.mail_id DESC'
        );
 
        $mail_path = rtrim($this->helper->getClientDataDir(), '/') . '/mail';
        while ($row = $db->fetchAssoc($res)) {
            $this->migrateSerializedMail(
                (int) $row['mail_id'],
                (int) $row['user_id'],
                (string) $row['attachments'],
                $mail_path,
                in_array(
                    $row['m_type'] ?? null,
                    [MailFolderType::DRAFTS->value, MailFolderType::OUTBOX->value],
                    true
                )
            );
        }
    }

References ILIAS\$db, $res, ILIAS\Mail\Folder\OUTBOX, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\step().

Here is the caller graph for this function:

◆ nextUnmigratedPaths()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::nextUnmigratedPaths ( )

private

Returns: list<string> Paths of the most recently sent mails first

Definition at line 237 of file MigrateMailAttachmentsToIRSS.php.

                                          : array
    {
        $db = $this->helper->getDatabase();
        $db->setLimit(self::PATHS_PER_STEP);
        $res = $db->query(
            'SELECT ma.path FROM mail_attachment ma
             LEFT JOIN mail m ON m.mail_id = ma.mail_id
             WHERE (ma.rcid IS NULL OR ma.rcid = "")
             AND ma.path IS NOT NULL AND ma.path != ""
             GROUP BY ma.path
             ORDER BY MAX(m.send_time) DESC'
        );
 
        $paths = [];
        while ($row = $db->fetchAssoc($res)) {
            $paths[] = (string) $row['path'];
        }
 
        return $paths;
    }

References ILIAS\$db, and $res.

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the caller graph for this function:

◆ prepare()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::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 72 of file MigrateMailAttachmentsToIRSS.php.

                                                     : void
    {
        $this->io = $this->resolveAdminInteraction($environment);
        $this->helper = new ilResourceStorageMigrationHelper(
            new ilMailAttachmentStakeholder(),
            $environment
        );
    }

References ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\resolveAdminInteraction().

Here is the call graph for this function:

◆ report()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::report	(	string	$level,
		string	$message,
		array	$context
	)

private

Parameters

array<string,mixed> $context

Definition at line 595 of file MigrateMailAttachmentsToIRSS.php.

                                                                           : void
    {
        $this->io?->inform(sprintf(
            '[%s] Mail attachment migration %s: %s%s',
            date('Y-m-d H:i:s'),
            $level,
            $message,
            $context !== []
                ? ' ' . json_encode($context, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PARTIAL_OUTPUT_ON_ERROR)
                : ''
        ));
    }

References $message, and ILIAS\UI\examples\Symbol\Glyph\Date\date().

Here is the call graph for this function:

◆ resolveAdminInteraction()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::resolveAdminInteraction ( Environment $environment )

private

Definition at line 551 of file MigrateMailAttachmentsToIRSS.php.

                                                                      : ?AdminInteraction
    {
        $io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
 
        return $io instanceof AdminInteraction ? $io : null;
    }

References ILIAS\Setup\Environment\getResource().

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\prepare(), and ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\step().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolveOwnerIdForPath()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::resolveOwnerIdForPath ( string $relative_path )

private

Definition at line 497 of file MigrateMailAttachmentsToIRSS.php.

                                                                 : int
    {
        $db = $this->helper->getDatabase();
        $db->setLimit(1, 0);
        $res = $db->queryF(
            'SELECT m.sender_id FROM mail_attachment ma
             INNER JOIN mail m ON m.mail_id = ma.mail_id
             WHERE ma.path = %s
             ORDER BY m.send_time ASC',
            [ilDBConstants::T_TEXT],
            [$relative_path]
        );
 
        $row = $db->fetchAssoc($res);
        if (is_array($row) && (int) $row['sender_id'] > 0) {
            return (int) $row['sender_id'];
        }
 
        return defined('SYSTEM_USER_ID') ? (int) SYSTEM_USER_ID : 6;
    }

References $res, ILIAS\Repository\int(), SYSTEM_USER_ID, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ skipPath()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::skipPath	(	string	$relative_path,
		string	$reason
	)

private

Definition at line 258 of file MigrateMailAttachmentsToIRSS.php.

                                                                    : void
    {
        $mail_ids = $this->mailIdsOfPath($relative_path);
        $this->markPathAsSkipped($relative_path);
        $this->count('directories_skipped');
 
        $this->warning('Directory skipped: ' . $reason, [
            'path' => $relative_path,
            'mails' => count($mail_ids),
            'mail_ids' => array_slice($mail_ids, 0, 20),
        ]);
    }

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the caller graph for this function:

◆ step()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 81 of file MigrateMailAttachmentsToIRSS.php.

                                                  : void
    {
        $this->io ??= $this->resolveAdminInteraction($environment);
        $this->step_number++;
        $this->statistics = [];
        $started = microtime(true);
 
        try {
            $this->migrateSentAttachmentDirectories();
            $this->migrateSerializedMailAttachments();
        } catch (Throwable $e) {
            $this->error('Migration aborted', ['step' => $this->step_number], $e);
 
            throw $e;
        }
 
        if ($this->statistics !== []) {
            $this->info('Step finished', array_merge(
                ['step' => $this->step_number, 'seconds' => round(microtime(true) - $started, 2)],
                $this->statistics
            ));
        }
    }

References Vendor\Package\$e, ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\error(), ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\info(), ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories(), ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSerializedMailAttachments(), and ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\resolveAdminInteraction().

Here is the call graph for this function:

◆ updateMailAttachmentFields()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::updateMailAttachmentFields	(	string	$relative_path,
		ResourceCollectionIdentification	$rcid
	)

private

Definition at line 527 of file MigrateMailAttachmentsToIRSS.php.

                                                                                                              : void
    {
        $mail_ids = $this->mailIdsOfPath($relative_path);
        if ($mail_ids === []) {
            return;
        }
 
        $db = $this->helper->getDatabase();
        $db->manipulateF(
            'UPDATE mail SET attachments = %s WHERE ' . $db->in('mail_id', $mail_ids, false, ilDBConstants::T_INTEGER),
            [ilDBConstants::T_TEXT],
            [$rcid->serialize()]
        );
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ warning()

ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::warning	(	string	$message,
		array	$context = `[]`
	)

private

Parameters

array<string,mixed> $context

Definition at line 574 of file MigrateMailAttachmentsToIRSS.php.

                                                                  : void
    {
        $this->report('WARNING', $message, $context);
    }

References $message.

Referenced by ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS\migrateSentAttachmentDirectories().

Here is the caller graph for this function:

Field Documentation

◆ $helper

ilResourceStorageMigrationHelper ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::$helper = null

private

Definition at line 47 of file MigrateMailAttachmentsToIRSS.php.

◆ $io

AdminInteraction ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::$io = null

private

Definition at line 48 of file MigrateMailAttachmentsToIRSS.php.

◆ $statistics

array ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::$statistics = []

private

Definition at line 52 of file MigrateMailAttachmentsToIRSS.php.

◆ $step_number

int ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::$step_number = 0

private

Definition at line 49 of file MigrateMailAttachmentsToIRSS.php.

◆ MAILS_PER_STEP

const int ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::MAILS_PER_STEP = 50

private

Definition at line 44 of file MigrateMailAttachmentsToIRSS.php.

◆ PATHS_PER_STEP

const int ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::PATHS_PER_STEP = 25

private

Definition at line 43 of file MigrateMailAttachmentsToIRSS.php.

◆ SKIPPED_MARKER

const string ILIAS\Mail\Setup\Migration\MigrateMailAttachmentsToIRSS::SKIPPED_MARKER = '-'

private

Definition at line 45 of file MigrateMailAttachmentsToIRSS.php.

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

components/ILIAS/Mail/src/Setup/Migration/MigrateMailAttachmentsToIRSS.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ assignRcidToPath()

◆ clearMailAttachmentsColumn()

◆ copyDirectoryToCollection()

◆ count()

◆ deleteMigratedDirectory()

◆ discardResources()

◆ error()

◆ getDefaultAmountOfStepsPerRun()

◆ getLabel()

◆ getPreconditions()

◆ getRemainingAmountOfSteps()

◆ info()

◆ listDirectoryFiles()

◆ mailIdsOfPath()

◆ markCollectionResourcesConfidential()

◆ markConfidential()

◆ markPathAsSkipped()

◆ migratePoolFilenamesToCollection()

◆ migrateSentAttachmentDirectories()

◆ migrateSerializedMail()

◆ migrateSerializedMailAttachments()

◆ nextUnmigratedPaths()

◆ prepare()

◆ report()

◆ resolveAdminInteraction()

◆ resolveOwnerIdForPath()

◆ skipPath()

◆ step()

◆ updateMailAttachmentFields()

◆ warning()

Field Documentation

◆ $helper

◆ $io

◆ $statistics

◆ $step_number

◆ MAILS_PER_STEP

◆ PATHS_PER_STEP

◆ SKIPPED_MARKER