Every resource of the mail stakeholder belongs to exactly one collection (pool, compose stage, draft, scheduled or sent mail). More...

Inheritance diagram for ilFileDataMail:

Collaboration diagram for ilFileDataMail:

Public Member Functions
	__construct (public int $user_id=0)

	getUploadLimit ()

	getAttachmentsTotalSizeLimit ()

	getMailPath ()

	getAbsoluteAttachmentPoolPathPrefix ()

	getAttachmentPathAndFilenameByMd5Hash (string $md5FileHash, int $mail_id)

	hasLegacyAttachmentDirectory (int $mail_id)

	checkReadWrite ()

	uploadToPool (UploadResult $result)

	getUserPoolRcid ()

	getUserPoolFilesData ()

	isLegacyPoolItemIdentifier (string $identifier)

	legacyPoolFilenameFromIdentifier (string $identifier)

	migrateLegacyPoolFilenameToResource (string $filename)

	resolvePoolIdentifiersToResources (array $identifiers)

	isInUserPool (ResourceIdentification $identification)

	adoptPoolResourcesToCollection (?ResourceCollectionIdentification $rcid, array $resource_identifications)

	removeFromPool (ResourceIdentification $rid)

	poolResourceHash (ResourceIdentification $rid)

	isCollectionReferenced (ResourceCollectionIdentification $rcid)
	A Mail collection is referenced as long as a mail (sent, received, draft, outbox), a compose stage or a user's attachment pool points to it. More...

	releaseCollectionIfUnreferenced (ResourceCollectionIdentification $rcid)
	Removes a Mail collection nobody references anymore, together with its resources. More...

	isCollectionExclusivelyOwnedByMail (ResourceCollectionIdentification $rcid)
	True if the collection can be handed over to delivered mails without copying it: it is Mail-owned and nobody references it. More...

	unlinkFile (string $a_filename)

	getAbsoluteAttachmentPoolPathByFilename (string $filename)
	Resolves a path for a passed filename in regards of a user's mail attachment pool, meaning attachments not being sent. More...

	checkFilesExist (array $a_files)

	assignAttachmentsToCollection (int $mail_id, ResourceCollectionIdentification $rcid)

	replaceMailAttachmentCollection (int $mail_id, ?ResourceCollectionIdentification $rcid)
	Points a mail (draft, outbox) to the passed collection (or to none). More...

	getRcidForMail (int $mail_id)

	deassignAttachmentFromDirectory (int $a_mail_id)

	deliverAttachmentsAsZip (string $basename, int $mail_id, array $files=[], bool $is_draft=false)

	getStakeholder ()

	canUseResourceInCompose (ResourceIdentification $identification)
	The compose form only shows files of the user's compose stage. More...

	addResourceToStage (ResourceIdentification $identification)
	Adds a just uploaded resource to the compose stage. More...

	removeFromStage (ResourceIdentification $identification)

	restrictStageTo (array $rid_strings)
	Removes all files from the compose stage which are not part of the submitted form. More...

	streamFromPath (string $absolute_path, ?string $revision_title=null)

	uploadToIrss (UploadResult $result)

	createCollectionFromPoolFilenames (array $filenames)

	migrateLegacyPoolAttachments (MailAttachments $attachments)

	adoptPoolFilenamesToCollection (?ResourceCollectionIdentification $rcid, array $filenames)

	createStageFromLegacyMailAttachments (int $mail_id, array $filenames)
	Creates a stage collection from a not yet migrated (directory based) mail, e.g. More...

	createCollectionFromContent (string $name, string $content)

	copyCollection (ResourceCollectionIdentification $source)
	Copies all files of the passed collection (of the mail system or of another component) into a new collection of the mail system. More...

	applyPoolSelectionToStage (array $selected_pool_resources)
	Applies a selection of the attachment pool to the compose stage: pool files are matched by their hashed name, selected files missing in the stage are copied into it, deselected ones are removed. More...

	getPoolResourcesInStage (ResourceCollectionIdentification $stage_rcid)

	getCollection (ResourceCollectionIdentification $rcid)

	getResourceIdByHash (ResourceCollectionIdentification $rcid, string $hash)

	getRidsFromCollection (ResourceCollectionIdentification $rcid)

	getAttachmentListing (ResourceCollectionIdentification $rcid)
	Keyed by resource id. More...

	deliverFile (ResourceCollectionIdentification $rcid, string $md5_hash)

	deliverCollectionAsZip (ResourceCollectionIdentification $rcid, string $zip_basename)

	removeCollection (ResourceCollectionIdentification $rcid, bool $delete_resources=false)
	Removes the collection. More...

	releaseSourceCollectionAfterDelivery (ResourceCollectionIdentification $rcid)
	Drops the source collection after it has been delivered. More...

	getIrssMimeAttachments (ResourceCollectionIdentification $rcid)

Public Member Functions inherited from ilFileData
	__construct ()

	checkPath (string $a_path)

	getPath ()

Public Member Functions inherited from ilFile
	deleteTrailingSlash (string $a_path)
	delete trailing slash of path variables More...

Data Fields
const string	POOL_RCID_PREF_KEY = 'mail_attachment_pool_rcid'

const string	LEGACY_POOL_ITEM_PREFIX = 'legacy:'

string	$mail_path

Protected Member Functions
	initAttachmentMaxUploadSize ()

Protected Attributes
int	$mail_max_upload_file_size

Filesystem	$tmp_directory

Filesystem	$storage_directory

ilDBInterface	$db

ILIAS	$ilias

Protected Attributes inherited from ilFile
string	$path

Private Member Functions
	getAttachmentPathByMailId (int $mail_id)

	addResourceToPool (ResourceIdentification $rid)
	Adds a resource to the user's pool. More...

	resolveUserPoolRcid ()

	resolveStageRcid ()

	collectionContainsResource (?ResourceCollectionIdentification $rcid, ResourceIdentification $identification)

	iteratePoolResourceIdentifications (ResourceCollectionIdentification $pool_rcid)

	persistUserPoolRcid (ResourceCollectionIdentification $rcid)

	deleteResource (ResourceIdentification $rid)

	isValidAttachmentPoolFilename (string $filename)

	getRcidForMailOfUser (int $mail_id)

	deleteAttachmentDirectory (string $a_rel_path)

	createCollectionFromResourceIdentifications (array $resource_identifications)

	getUserPoolResources ()

	copyResources (array $resource_identifications)

	loadPoolCollectionForMutation (?ResourceCollectionIdentification $pool_rcid)

	getAssignedRidStrings (ResourceCollectionIdentification $rcid)

	collectionIsKnown (ResourceCollectionIdentification $rcid)

	attachmentHash (ResourceIdentification $identification)
	Unique per resource: equal file names in one collection must stay distinguishable. More...

	resourceIdByHashInCollection (ResourceCollection $collection, string $hash)

	applyResourceFileName (ResourceIdentification $rid, string $file_name)

	resourceHasOnlyMailStakeholder (ResourceIdentification $rid)

Private Attributes
readonly Services	$irss

readonly ilMailAttachmentStakeholder	$stakeholder

Detailed Description

Every resource of the mail stakeholder belongs to exactly one collection (pool, compose stage, draft, scheduled or sent mail).

Collections are copied when they change hands, so releasing a collection that no mail, stage or pool references removes its resources as well.

Definition at line 37 of file class.ilFileDataMail.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileDataMail::__construct ( public int $user_id = 0 )

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

    {
        global $DIC;
 
        if (!defined('MAILPATH')) {
            define('MAILPATH', 'mail');
        }
        parent::__construct();
        $this->mail_path = $this->getPath() . '/' . MAILPATH;
        $this->ilias = $DIC['ilias'];
        $this->db = $DIC->database();
        $this->tmp_directory = $DIC->filesystem()->temp();
        $this->storage_directory = $DIC->filesystem()->storage();
        $this->irss = $DIC->resourceStorage();
        $this->stakeholder = new ilMailAttachmentStakeholder();
        $this->stakeholder->setOwner($this->user_id);
 
        $this->checkReadWrite();
        $this->initAttachmentMaxUploadSize();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), checkReadWrite(), ilFileData\getPath(), initAttachmentMaxUploadSize(), and MAILPATH.

Here is the call graph for this function:

Member Function Documentation

◆ addResourceToPool()

ilFileDataMail::addResourceToPool ( ResourceIdentification $rid )

private

Adds a resource to the user's pool.

A pool file with the same name is replaced, like the legacy pool overwrote files with the same name.

Definition at line 224 of file class.ilFileDataMail.php.

                                                                   : ResourceIdentification
    {
        $pool_rcid = $this->resolveUserPoolRcid();
        if ($pool_rcid !== null) {
            $existing = $this->resourceIdByHashInCollection(
                $this->getCollection($pool_rcid),
                $this->poolResourceHash($rid)
            );
            if ($existing !== null && $existing->serialize() !== $rid->serialize()) {
                $this->removeFromPool($existing);
            }
        }
 
        $updated_rcid = $this->adoptPoolResourcesToCollection($pool_rcid, [$rid]);
        if ($updated_rcid === null) {
            $this->deleteResource($rid);
            throw new RuntimeException('Could not store mail attachment in pool.');
        }
 
        if ($pool_rcid === null || $pool_rcid->serialize() !== $updated_rcid->serialize()) {
            $this->persistUserPoolRcid($updated_rcid);
        }
 
        return $rid;
    }

References adoptPoolResourcesToCollection(), deleteResource(), getCollection(), persistUserPoolRcid(), poolResourceHash(), removeFromPool(), resolveUserPoolRcid(), resourceIdByHashInCollection(), and ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Referenced by uploadToPool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addResourceToStage()

ilFileDataMail::addResourceToStage ( ResourceIdentification $identification )

Adds a just uploaded resource to the compose stage.

The returned collection must be persisted as stage if it was created.

Definition at line 1014 of file class.ilFileDataMail.php.

                                                                              : ResourceCollectionIdentification
    {
        $stage_rcid = $this->resolveStageRcid();
        $collection = $stage_rcid !== null && $this->collectionIsKnown($stage_rcid)
            ? $this->getCollection($stage_rcid)
            : $this->irss->collection()->get($this->irss->collection()->id(null, $this->user_id));
 
        $collection->add($identification);
        $this->irss->collection()->store($collection);
 
        return $collection->getIdentification();
    }

◆ adoptPoolFilenamesToCollection()

ilFileDataMail::adoptPoolFilenamesToCollection	(	?ResourceCollectionIdentification	$rcid,
		array	$filenames
	)

Parameters

list<string> $filenames Pool filenames without user prefix

Definition at line 1136 of file class.ilFileDataMail.php.

     : ?ResourceCollectionIdentification {
        if ($filenames === []) {
            return null;
        }
 
        if ($rcid !== null && $this->irss->collection()->exists($rcid->serialize())) {
            $collection_id = $this->irss->collection()->id($rcid->serialize(), $this->user_id);
        } else {
            $collection_id = $this->irss->collection()->id(null, $this->user_id);
        }
 
        $collection = $this->irss->collection()->get($collection_id);
        $added = false;
 
        foreach ($filenames as $filename) {
            $path = $this->getAbsoluteAttachmentPoolPathByFilename($filename);
            if (!is_file($path)) {
                continue;
            }
 
            $hash = md5($filename);
            if ($this->resourceIdByHashInCollection($collection, $hash) !== null) {
                continue;
            }
 
            $resource_identification = $this->streamFromPath($path, $hash);
            $this->applyResourceFileName($resource_identification, $filename);
            $collection->add($resource_identification);
            $added = true;
        }
 
        if (!$added) {
            return null;
        }
 
        $this->irss->collection()->store($collection);
 
        return $collection->getIdentification();
    }

◆ adoptPoolResourcesToCollection()

ilFileDataMail::adoptPoolResourcesToCollection	(	?ResourceCollectionIdentification	$rcid,
		array	$resource_identifications
	)

Parameters

list<ResourceIdentification> $resource_identifications

Definition at line 420 of file class.ilFileDataMail.php.

     : ?ResourceCollectionIdentification {
        if ($resource_identifications === []) {
            return null;
        }
 
        $collection = $this->loadPoolCollectionForMutation($rcid);
        $added = false;
 
        foreach ($resource_identifications as $resource_identification) {
            $hash = $this->irss->manage()->getCurrentRevision($resource_identification)->getTitle();
            if ($this->resourceIdByHashInCollection($collection, $hash) !== null) {
                continue;
            }
 
            $collection->add($resource_identification);
            $added = true;
        }
 
        if (!$added) {
            return null;
        }
 
        $this->irss->collection()->store($collection);
 
        return $collection->getIdentification();
    }

Referenced by addResourceToPool().

Here is the caller graph for this function:

◆ applyPoolSelectionToStage()

ilFileDataMail::applyPoolSelectionToStage ( array $selected_pool_resources )

Applies a selection of the attachment pool to the compose stage: pool files are matched by their hashed name, selected files missing in the stage are copied into it, deselected ones are removed.

Parameters

list<ResourceIdentification> $selected_pool_resources

Definition at line 1267 of file class.ilFileDataMail.php.

                                                                             : ?ResourceCollectionIdentification
    {
        $pool_hashes = [];
        foreach ($this->getUserPoolResources() as $pool_resource) {
            $pool_hashes[$this->poolResourceHash($pool_resource)] = true;
        }
 
        $selected = [];
        foreach ($selected_pool_resources as $pool_resource) {
            $selected[$this->poolResourceHash($pool_resource)] = $pool_resource;
        }
 
        $stage_rcid = $this->resolveStageRcid();
        $collection = $stage_rcid !== null && $this->collectionIsKnown($stage_rcid)
            ? $this->getCollection($stage_rcid)
            : $this->irss->collection()->get($this->irss->collection()->id(null, $this->user_id));
 
        $removed = [];
        foreach ($collection->getResourceIdentifications() as $identification) {
            $hash = $this->poolResourceHash($identification);
            if (isset($pool_hashes[$hash]) && !isset($selected[$hash])) {
                $collection->remove($identification);
                $removed[] = $identification;
                continue;
            }
            unset($selected[$hash]);
        }
 
        foreach ($this->copyResources(array_values($selected)) as $copy) {
            $collection->add($copy);
        }
 
        $this->irss->collection()->store($collection);
        foreach ($removed as $identification) {
            $this->deleteResource($identification);
        }
 
        return $collection->count() > 0 ? $collection->getIdentification() : null;
    }

◆ applyResourceFileName()

ilFileDataMail::applyResourceFileName	(	ResourceIdentification	$rid,
		string	$file_name
	)

private

Definition at line 1550 of file class.ilFileDataMail.php.

                                                                                          : void
    {
        if ($file_name === '') {
            return;
        }
 
        $revision = $this->irss->manage()->getCurrentRevision($rid);
        $information = $revision->getInformation();
        if (!$information instanceof FileInformation) {
            return;
        }
        $information->setTitle($file_name);
        $suffix = pathinfo($file_name, PATHINFO_EXTENSION);
        if ($suffix !== '') {
            $information->setSuffix($suffix);
        }
        $revision->setInformation($information);
        $this->irss->manage()->updateRevision($revision);
    }

◆ assignAttachmentsToCollection()

ilFileDataMail::assignAttachmentsToCollection	(	int	$mail_id,
		ResourceCollectionIdentification	$rcid
	)

Definition at line 633 of file class.ilFileDataMail.php.

     : void {
        $this->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()]
        );
    }

◆ attachmentHash()

ilFileDataMail::attachmentHash ( ResourceIdentification $identification )

private

Unique per resource: equal file names in one collection must stay distinguishable.

Definition at line 1443 of file class.ilFileDataMail.php.

                                                                           : string
    {
        return md5($identification->serialize());
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Here is the call graph for this function:

◆ canUseResourceInCompose()

ilFileDataMail::canUseResourceInCompose ( ResourceIdentification $identification )

The compose form only shows files of the user's compose stage.

Definition at line 1005 of file class.ilFileDataMail.php.

                                                                                   : bool
    {
        return $this->collectionContainsResource($this->resolveStageRcid(), $identification);
    }

◆ checkFilesExist()

ilFileDataMail::checkFilesExist ( array $a_files )

Parameters

list<string> $a_files

Definition at line 620 of file class.ilFileDataMail.php.

                                                   : bool
    {
        if ($a_files !== []) {
            foreach ($a_files as $file) {
                if (!is_file($this->mail_path . '/' . $this->user_id . '_' . $file)) {
                    return false;
                }
            }
        }
 
        return true;
    }

◆ checkReadWrite()

ilFileDataMail::checkReadWrite ( )

Definition at line 171 of file class.ilFileDataMail.php.

                                    : bool
    {
        if (is_writable($this->mail_path) && is_readable($this->mail_path)) {
            return true;
        }
 
        $this->ilias->raiseError(
            'Mail directory is not readable/writable by webserver: ' .
            $this->mail_path,
            $this->ilias->error_obj->FATAL
        );
 
        return false;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ collectionContainsResource()

ilFileDataMail::collectionContainsResource	(	?ResourceCollectionIdentification	$rcid,
		ResourceIdentification	$identification
	)

private

Definition at line 295 of file class.ilFileDataMail.php.

     : bool {
        if ($rcid === null) {
            return false;
        }
 
        return in_array($identification->serialize(), $this->getAssignedRidStrings($rcid), true);
    }

◆ collectionIsKnown()

ilFileDataMail::collectionIsKnown ( ResourceCollectionIdentification $rcid )

private

Definition at line 1406 of file class.ilFileDataMail.php.

                                                                              : bool
    {
        return $this->irss->collection()->exists($rcid->serialize());
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Referenced by resolveUserPoolRcid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyCollection()

ilFileDataMail::copyCollection ( ResourceCollectionIdentification $source )

Copies all files of the passed collection (of the mail system or of another component) into a new collection of the mail system.

The source stays untouched.

Definition at line 1247 of file class.ilFileDataMail.php.

                                                                            : ?ResourceCollectionIdentification
    {
        if (!$this->collectionIsKnown($source)) {
            return null;
        }
 
        $copies = $this->copyResources(array_values($this->getCollection($source)->getResourceIdentifications()));
        if ($copies === []) {
            return null;
        }
 
        return $this->createCollectionFromResourceIdentifications($copies);
    }

◆ copyResources()

ilFileDataMail::copyResources ( array $resource_identifications )

private

Parameters

list<ResourceIdentification> $resource_identifications

Returns: list<ResourceIdentification>

Definition at line 1347 of file class.ilFileDataMail.php.

                                                                   : array
    {
        $copies = [];
        foreach ($resource_identifications as $source) {
            $revision = $this->irss->manage()->getCurrentRevision($source);
            $stream = $this->irss->consume()->stream($source);
            $copy = $this->irss->manage()->stream(
                $stream->getStream(),
                $this->stakeholder,
                $revision->getTitle()
            );
            $this->applyResourceFileName($copy, $revision->getInformation()->getTitle());
            $copies[] = $copy;
        }
 
        return $copies;
    }

◆ createCollectionFromContent()

ilFileDataMail::createCollectionFromContent	(	string	$name,
		string	$content
	)

Definition at line 1217 of file class.ilFileDataMail.php.

                                                                              : ?ResourceCollectionIdentification
    {
        if ($name === '' || $content === '') {
            return null;
        }
 
        if (strlen($content) >= $this->getUploadLimit()) {
            throw new DomainException(
                sprintf(
                    'Mail upload limit reached for user with id %s',
                    $this->user_id
                )
            );
        }
 
        $sanitized_name = ilFileUtils::_sanitizeFilemame($name);
        $resource_identification = $this->irss->manage()->stream(
            Streams::ofString($content),
            $this->stakeholder,
            md5($sanitized_name)
        );
        $this->applyResourceFileName($resource_identification, $sanitized_name);
 
        return $this->createCollectionFromResourceIdentifications([$resource_identification]);
    }

References ilFileUtils\_sanitizeFilemame().

Here is the call graph for this function:

◆ createCollectionFromPoolFilenames()

ilFileDataMail::createCollectionFromPoolFilenames ( array $filenames )

Parameters

list<string> $filenames Pool filenames without user prefix

Definition at line 1113 of file class.ilFileDataMail.php.

                                                                       : ?ResourceCollectionIdentification
    {
        return $this->adoptPoolFilenamesToCollection(null, $filenames);
    }

◆ createCollectionFromResourceIdentifications()

ilFileDataMail::createCollectionFromResourceIdentifications ( array $resource_identifications )

private

Parameters

list<ResourceIdentification> $resource_identifications Resources not yet part of any collection

Definition at line 1097 of file class.ilFileDataMail.php.

     : ResourceCollectionIdentification {
        $rcid = $this->irss->collection()->id(null, $this->user_id);
        $collection = $this->irss->collection()->get($rcid);
        foreach ($resource_identifications as $resource_identification) {
            $collection->add($resource_identification);
        }
        $this->irss->collection()->store($collection);
 
        return $collection->getIdentification();
    }

◆ createStageFromLegacyMailAttachments()

ilFileDataMail::createStageFromLegacyMailAttachments	(	int	$mail_id,
		array	$filenames
	)

Creates a stage collection from a not yet migrated (directory based) mail, e.g.

when forwarding it.

Parameters

list<string> $filenames

Definition at line 1184 of file class.ilFileDataMail.php.

                                                                                        : MailAttachments
    {
        // Without a directory the files are gone, the names must not resolve to the forwarding user's pool
        if (!$this->hasLegacyAttachmentDirectory($mail_id)) {
            return MailAttachments::empty();
        }
 
        $resource_identifications = [];
        foreach ($filenames as $filename) {
            try {
                $file = $this->getAttachmentPathAndFilenameByMd5Hash(md5($filename), $mail_id);
            } catch (OutOfBoundsException) {
                continue;
            }
 
            if (isset($file['rcid']) && $file['rcid'] instanceof ResourceCollectionIdentification) {
                $rcid = $this->copyCollection($file['rcid']);
 
                return $rcid !== null ? MailAttachments::fromIrss($rcid) : MailAttachments::empty();
            }
 
            if (is_file($file['path'])) {
                $resource_identifications[] = $this->streamFromPath($file['path'], md5($file['filename']));
            }
        }
 
        if ($resource_identifications === []) {
            return MailAttachments::empty();
        }
 
        return MailAttachments::fromIrss($this->createCollectionFromResourceIdentifications($resource_identifications));
    }

References $filename.

◆ deassignAttachmentFromDirectory()

ilFileDataMail::deassignAttachmentFromDirectory ( int $a_mail_id )

Definition at line 710 of file class.ilFileDataMail.php.

                                                                   : bool
    {
        $res = $this->db->query(
            'SELECT path, rcid FROM mail_attachment WHERE mail_id = ' . $this->db->quote($a_mail_id, 'integer')
        );
 
        $path = '';
        $rcid = '';
        while ($row = $this->db->fetchObject($res)) {
            $path = (string) $row->path;
            $rcid = (string) ($row->rcid ?? '');
        }
 
        if ($rcid !== '' && $rcid !== '-') {
            $this->db->manipulateF(
                'DELETE FROM mail_attachment WHERE mail_id = %s',
                ['integer'],
                [$a_mail_id]
            );
            $this->releaseCollectionIfUnreferenced(new ResourceCollectionIdentification($rcid));
 
            return true;
        }
 
        if ($path !== '') {
            $res = $this->db->query(
                'SELECT COUNT(mail_id) count_mail_id FROM mail_attachment WHERE path = ' .
                $this->db->quote($path, 'text')
            );
 
            $cnt_mail_id = 0;
            while ($row = $this->db->fetchObject($res)) {
                $cnt_mail_id = (int) $row->count_mail_id;
            }
 
            if ($cnt_mail_id === 1) {
                $this->deleteAttachmentDirectory($path);
            }
        }
 
        $this->db->manipulateF(
            'DELETE FROM mail_attachment WHERE mail_id = %s',
            ['integer'],
            [$a_mail_id]
        );
 
        return true;
    }

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

Here is the call graph for this function:

◆ deleteAttachmentDirectory()

ilFileDataMail::deleteAttachmentDirectory ( string $a_rel_path )

private

Definition at line 759 of file class.ilFileDataMail.php.

                                                                  : void
    {
        ilFileUtils::delDir($this->mail_path . '/' . $a_rel_path);
    }

References ilFileUtils\delDir().

Here is the call graph for this function:

◆ deleteResource()

ilFileDataMail::deleteResource ( ResourceIdentification $rid )

private

Definition at line 551 of file class.ilFileDataMail.php.

                                                                : void
    {
        $this->irss->manage()->remove($rid, $this->stakeholder);
    }

Referenced by addResourceToPool().

Here is the caller graph for this function:

◆ deliverAttachmentsAsZip()

ilFileDataMail::deliverAttachmentsAsZip	(	string	$basename,
		int	$mail_id,
		array	$files = `[]`,
		bool	$is_draft = `false`
	)

Parameters

list<string> $files

Definition at line 930 of file class.ilFileDataMail.php.

     : void {
        $rcid = $this->getRcidForMail($mail_id);
        if ($rcid !== null && !$is_draft) {
            $this->deliverCollectionAsZip($rcid, $basename);
 
            return;
        }
 
        $path = '';
        if (!$is_draft) {
            $path = $this->getAttachmentPathByMailId($mail_id);
            if ($path === '') {
                throw new ilMailException('mail_download_zip_no_attachments');
            }
        }
 
        $download_filename = ilFileUtils::getASCIIFilename($basename);
        if ($download_filename === '') {
            $download_filename = 'attachments';
        }
 
        $processing_directory = ilFileUtils::ilTempnam();
        $relative_processing_directory = basename($processing_directory);
 
        $absolute_zip_directory = $processing_directory . '/' . $download_filename;
        $relative_zip_directory = $relative_processing_directory . '/' . $download_filename;
 
        $this->tmp_directory->createDir($relative_zip_directory);
 
        foreach ($files as $filename) {
            if ($is_draft) {
                $source = str_replace(
                    $this->mail_path,
                    MAILPATH,
                    $this->getAbsoluteAttachmentPoolPathByFilename($filename)
                );
            } else {
                $source = MAILPATH . '/' . $path . '/' . $filename;
            }
 
            $source = str_replace('//', '/', $source);
            if (!$this->storage_directory->has($source)) {
                continue;
            }
 
            $target = $relative_zip_directory . '/' . $filename;
 
            $stream = $this->storage_directory->readStream($source);
            $this->tmp_directory->writeStream($target, $stream);
        }
 
        $path_to_zip_file = $processing_directory . '/' . $download_filename . '.zip';
        ilFileUtils::zip($absolute_zip_directory, $path_to_zip_file);
 
        $this->tmp_directory->deleteDir($relative_zip_directory);
 
        ilFileDelivery::deliverFileAttached(
            $processing_directory . '/' . $download_filename . '.zip',
            ilFileUtils::getValidFilename($download_filename . '.zip')
        );
    }

◆ deliverCollectionAsZip()

ilFileDataMail::deliverCollectionAsZip	(	ResourceCollectionIdentification	$rcid,
		string	$zip_basename
	)

Definition at line 1513 of file class.ilFileDataMail.php.

                                                                                                        : void
    {
        $zip_filename = FileDelivery::returnASCIIFileName($zip_basename . '.zip');
        $this->irss
            ->consume()
            ->downloadCollection($rcid, $zip_filename)
            ->useRevisionTitlesForFileNames(false)
            ->run();
    }

◆ deliverFile()

ilFileDataMail::deliverFile	(	ResourceCollectionIdentification	$rcid,
		string	$md5_hash
	)

Definition at line 1503 of file class.ilFileDataMail.php.

                                                                                         : void
    {
        $resource_identification = $this->getResourceIdByHash($rcid, $md5_hash);
        if ($resource_identification === null) {
            throw new OutOfBoundsException('mail_error_reading_attachment');
        }
 
        $this->irss->consume()->download($resource_identification)->run();
    }

◆ getAbsoluteAttachmentPoolPathByFilename()

ilFileDataMail::getAbsoluteAttachmentPoolPathByFilename ( string $filename )

Resolves a path for a passed filename in regards of a user's mail attachment pool, meaning attachments not being sent.

Definition at line 600 of file class.ilFileDataMail.php.

                                                                             : string
    {
        if (!$this->isValidAttachmentPoolFilename($filename)) {
            throw new InvalidArgumentException('The passed filename must not contain path separators.');
        }
 
        return $this->getAbsoluteAttachmentPoolPathPrefix() . $filename;
    }

References $filename.

◆ getAbsoluteAttachmentPoolPathPrefix()

ilFileDataMail::getAbsoluteAttachmentPoolPathPrefix ( )

Definition at line 92 of file class.ilFileDataMail.php.

                                                         : string
    {
        return $this->mail_path . '/' . $this->user_id . '_';
    }

◆ getAssignedRidStrings()

ilFileDataMail::getAssignedRidStrings ( ResourceCollectionIdentification $rcid )

private

Returns: list<string>

Definition at line 1394 of file class.ilFileDataMail.php.

                                                                                  : array
    {
        if (!$this->collectionIsKnown($rcid)) {
            return [];
        }
 
        return array_values(array_map(
            static fn(ResourceIdentification $identification): string => $identification->serialize(),
            $this->irss->collection()->get($rcid)->getResourceIdentifications()
        ));
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Here is the call graph for this function:

◆ getAttachmentListing()

ilFileDataMail::getAttachmentListing ( ResourceCollectionIdentification $rcid )

Keyed by resource id.

Equal display titles must not collapse two download hashes.

Returns: array<string, array{md5: string, name: string, size: int, ctime: string}>

Definition at line 1480 of file class.ilFileDataMail.php.

                                                                                : array
    {
        $files = [];
        foreach ($this->getAssignedRidStrings($rcid) as $rid) {
            $resource_identification = $this->irss->manage()->find($rid);
            if ($resource_identification === null) {
                continue;
            }
 
            $revision = $this->irss->manage()->getCurrentRevision($resource_identification);
            $info = $revision->getInformation();
            $file_title = $info->getTitle();
            $files[$resource_identification->serialize()] = [
                'md5' => $this->attachmentHash($resource_identification),
                'name' => $file_title,
                'size' => $info->getSize(),
                'ctime' => $info->getCreationDate()->format('Y-m-d H:i:s'),
            ];
        }
 
        return $files;
    }

References $files, and $info.

Referenced by ilMailFolderGUI\getAttachmentHashes().

Here is the caller graph for this function:

◆ getAttachmentPathAndFilenameByMd5Hash()

ilFileDataMail::getAttachmentPathAndFilenameByMd5Hash	(	string	$md5FileHash,
		int	$mail_id
	)

Returns: array{path: string, filename: string, rcid?: ResourceCollectionIdentification, md5?: string} An array containing 'path' and 'filename' for the passed MD5 hash

Exceptions

OutOfBoundsException

Definition at line 101 of file class.ilFileDataMail.php.

                                                                                            : array
    {
        $rcid = $this->getRcidForMailOfUser($mail_id);
        if ($rcid !== null) {
            $resource_identification = $this->getResourceIdByHash($rcid, $md5FileHash);
            if ($resource_identification === null) {
                throw new OutOfBoundsException();
            }
            $info = $this->irss->manage()->getCurrentRevision($resource_identification)->getInformation();
 
            return [
                'path' => '',
                'filename' => $info->getTitle(),
                'rcid' => $rcid,
                'md5' => $md5FileHash,
            ];
        }
 
        $res = $this->db->queryF(
            '
                SELECT mail_attachment.path
                FROM mail_attachment
                INNER JOIN mail ON mail.mail_id = mail_attachment.mail_id
                WHERE mail_attachment.mail_id = %s
                AND mail.user_id = %s
            ',
            ['integer', 'integer'],
            [$mail_id, $this->user_id]
        );
 
        if ($this->db->numRows($res) !== 1) {
            throw new OutOfBoundsException();
        }
 
        $row = $this->db->fetchAssoc($res);
 
        $relative_path = $row['path'];
        $path = $this->getMailPath() . '/' . $row['path'];
 
        $files = ilFileUtils::getDir($path);
        foreach ($files as $file) {
            if ($file['type'] === 'file' && md5($file['entry']) === $md5FileHash) {
                return [
                    'path' => $this->getMailPath() . '/' . $relative_path . '/' . $file['entry'],
                    'filename' => $file['entry'],
                ];
            }
        }
 
        throw new OutOfBoundsException();
    }

References $files, $info, ilFile\$path, $res, ilFileUtils\getDir(), getMailPath(), getRcidForMailOfUser(), and getResourceIdByHash().

Here is the call graph for this function:

◆ getAttachmentPathByMailId()

ilFileDataMail::getAttachmentPathByMailId ( int $mail_id )

private

Definition at line 153 of file class.ilFileDataMail.php.

                                                            : string
    {
        $query = $this->db->query(
            'SELECT path FROM mail_attachment WHERE mail_id = ' . $this->db->quote($mail_id, 'integer')
        );
 
        while ($row = $this->db->fetchObject($query)) {
            return $row->path;
        }
 
        return '';
    }

Referenced by hasLegacyAttachmentDirectory().

Here is the caller graph for this function:

◆ getAttachmentsTotalSizeLimit()

ilFileDataMail::getAttachmentsTotalSizeLimit ( )

Definition at line 77 of file class.ilFileDataMail.php.

                                                  : ?float
    {
        $max_size = $this->ilias->getSetting('mail_maxsize_attach', '');
        if ($max_size === '') {
            return null;
        }
 
        return (float) $this->ilias->getSetting('mail_maxsize_attach', '0') * 1024;
    }

◆ getCollection()

ilFileDataMail::getCollection ( ResourceCollectionIdentification $rcid )

Definition at line 1365 of file class.ilFileDataMail.php.

                                                                         : ResourceCollection
    {
        if (!$this->collectionIsKnown($rcid)) {
            throw new OutOfBoundsException(
                sprintf('Mail attachment collection "%s" does not exist.', $rcid->serialize())
            );
        }
 
        $this->irss->preloadCollections([$rcid->serialize()]);
 
        return $this->irss->collection()->get($rcid, $this->user_id);
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Referenced by addResourceToPool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIrssMimeAttachments()

ilFileDataMail::getIrssMimeAttachments ( ResourceCollectionIdentification $rcid )

Returns: list<array{rid: string, name: string}>

Definition at line 1586 of file class.ilFileDataMail.php.

                                                                                  : array
    {
        $attachments = [];
        foreach ($this->getAssignedRidStrings($rcid) as $rid) {
            $resource_identification = $this->irss->manage()->find($rid);
            if ($resource_identification === null) {
                continue;
            }
 
            $info = $this->irss->manage()->getCurrentRevision($resource_identification)->getInformation();
            $attachments[] = [
                'rid' => $rid,
                'name' => $info->getTitle(),
            ];
        }
 
        return $attachments;
    }

References $info.

◆ getMailPath()

ilFileDataMail::getMailPath ( )

Definition at line 87 of file class.ilFileDataMail.php.

                                 : string
    {
        return $this->mail_path;
    }

References $mail_path.

Referenced by getAttachmentPathAndFilenameByMd5Hash().

Here is the caller graph for this function:

◆ getPoolResourcesInStage()

ilFileDataMail::getPoolResourcesInStage ( ResourceCollectionIdentification $stage_rcid )

Returns: list<string> Resource ids of the pool files the compose stage contains a copy of

Definition at line 1310 of file class.ilFileDataMail.php.

                                                                                         : array
    {
        $stage_hashes = [];
        foreach ($this->getRidsFromCollection($stage_rcid) as $rid_string) {
            $identification = $this->irss->manage()->find($rid_string);
            if ($identification !== null) {
                $stage_hashes[$this->poolResourceHash($identification)] = true;
            }
        }
 
        $pool_resources = [];
        foreach ($this->getUserPoolResources() as $pool_resource) {
            if (isset($stage_hashes[$this->poolResourceHash($pool_resource)])) {
                $pool_resources[] = $pool_resource->serialize();
            }
        }
 
        return $pool_resources;
    }

◆ getRcidForMail()

ilFileDataMail::getRcidForMail ( int $mail_id )

Definition at line 689 of file class.ilFileDataMail.php.

                                                : ?ResourceCollectionIdentification
    {
        $res = $this->db->queryF(
            'SELECT rcid FROM mail_attachment WHERE mail_id = %s',
            ['integer'],
            [$mail_id]
        );
 
        if ($this->db->numRows($res) !== 1) {
            return null;
        }
 
        $row = $this->db->fetchAssoc($res);
        $rcid = (string) ($row['rcid'] ?? '');
        if ($rcid === '' || $rcid === '-') {
            return null;
        }
 
        return new ResourceCollectionIdentification($rcid);
    }

References $res.

◆ getRcidForMailOfUser()

ilFileDataMail::getRcidForMailOfUser ( int $mail_id )

private

Definition at line 674 of file class.ilFileDataMail.php.

                                                       : ?ResourceCollectionIdentification
    {
        $res = $this->db->queryF(
            'SELECT mail_attachment.rcid FROM mail_attachment
             INNER JOIN mail ON mail.mail_id = mail_attachment.mail_id
             WHERE mail_attachment.mail_id = %s AND mail.user_id = %s',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_INTEGER],
            [$mail_id, $this->user_id]
        );
        $row = $this->db->fetchAssoc($res);
        $rcid = is_array($row) ? (string) ($row['rcid'] ?? '') : '';
 
        return $rcid !== '' && $rcid !== '-' ? new ResourceCollectionIdentification($rcid) : null;
    }

References $res, and ilDBConstants\T_INTEGER.

Referenced by getAttachmentPathAndFilenameByMd5Hash().

Here is the caller graph for this function:

◆ getResourceIdByHash()

ilFileDataMail::getResourceIdByHash	(	ResourceCollectionIdentification	$rcid,
		string	$hash
	)

Definition at line 1411 of file class.ilFileDataMail.php.

     : ?ResourceIdentification {
        if (!$this->collectionIsKnown($rcid)) {
            return null;
        }
 
        // Mails whose column still lists legacy filenames address their files by the hashed name (revision title)
        $title_match = null;
        foreach ($this->getAssignedRidStrings($rcid) as $rid) {
            $resource_identification = $this->irss->manage()->find($rid);
            if ($resource_identification === null) {
                continue;
            }
 
            if ($this->attachmentHash($resource_identification) === $hash) {
                return $resource_identification;
            }
 
            if ($title_match === null
                && $this->irss->manage()->getCurrentRevision($resource_identification)->getTitle() === $hash) {
                $title_match = $resource_identification;
            }
        }
 
        return $title_match;
    }

Referenced by getAttachmentPathAndFilenameByMd5Hash().

Here is the caller graph for this function:

◆ getRidsFromCollection()

ilFileDataMail::getRidsFromCollection ( ResourceCollectionIdentification $rcid )

Returns: list<string>

Definition at line 1463 of file class.ilFileDataMail.php.

                                                                                 : array
    {
        $rids = [];
        foreach ($this->getAssignedRidStrings($rcid) as $rid) {
            if ($this->irss->manage()->find($rid) !== null) {
                $rids[] = $rid;
            }
        }
 
        return $rids;
    }

◆ getStakeholder()

ilFileDataMail::getStakeholder ( )

Definition at line 997 of file class.ilFileDataMail.php.

                                    : ilMailAttachmentStakeholder
    {
        return $this->stakeholder;
    }

◆ getUploadLimit()

ilFileDataMail::getUploadLimit ( )

Definition at line 72 of file class.ilFileDataMail.php.

                                    : int
    {
        return $this->mail_max_upload_file_size;
    }

References $mail_max_upload_file_size.

◆ getUserPoolFilesData()

ilFileDataMail::getUserPoolFilesData ( )

Returns: list<array{rid: string, name: string, size: int, ctime: int, md5: string}>

Definition at line 322 of file class.ilFileDataMail.php.

                                          : array
    {
        $files = [];
 
        $pool_rcid = $this->resolveUserPoolRcid();
        if ($pool_rcid !== null) {
            foreach ($this->iteratePoolResourceIdentifications($pool_rcid) as $resource_identification) {
                $revision = $this->irss->manage()->getCurrentRevision($resource_identification);
                $info = $revision->getInformation();
                $files[] = [
                    'rid' => $resource_identification->serialize(),
                    'name' => $info->getTitle(),
                    'size' => $info->getSize(),
                    'ctime' => $info->getCreationDate()->getTimestamp(),
                    'md5' => $revision->getTitle(),
                ];
            }
        }
 
        foreach ($this->getUnsentFiles() as $file) {
            $files[] = [
                'rid' => self::LEGACY_POOL_ITEM_PREFIX . $file['name'],
                'name' => $file['name'],
                'size' => (int) $file['size'],
                'ctime' => (int) $file['ctime'],
                'md5' => md5($file['name']),
            ];
        }
 
        return $files;
    }

References $files, $info, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getUserPoolRcid()

ilFileDataMail::getUserPoolRcid ( )

Definition at line 250 of file class.ilFileDataMail.php.

                                     : ResourceCollectionIdentification
    {
        $pool_rcid = $this->resolveUserPoolRcid();
        if ($pool_rcid === null) {
            throw new RuntimeException('Mail attachment pool does not exist.');
        }
 
        return $pool_rcid;
    }

References resolveUserPoolRcid().

Here is the call graph for this function:

◆ getUserPoolResources()

ilFileDataMail::getUserPoolResources ( )

private

Returns: list<ResourceIdentification>

Definition at line 1333 of file class.ilFileDataMail.php.

                                           : array
    {
        $pool_rcid = $this->resolveUserPoolRcid();
        if ($pool_rcid === null) {
            return [];
        }
 
        return iterator_to_array($this->iteratePoolResourceIdentifications($pool_rcid), false);
    }

◆ hasLegacyAttachmentDirectory()

ilFileDataMail::hasLegacyAttachmentDirectory ( int $mail_id )

Definition at line 166 of file class.ilFileDataMail.php.

                                                              : bool
    {
        return $this->getAttachmentPathByMailId($mail_id) !== '';
    }

References getAttachmentPathByMailId().

Here is the call graph for this function:

◆ initAttachmentMaxUploadSize()

ilFileDataMail::initAttachmentMaxUploadSize ( )

protected

Todo:: mjansen: Unfortunately we cannot reuse the implementation of ilFileInputGUI

Definition at line 764 of file class.ilFileDataMail.php.

                                                    : void
    {
        // Copy of ilFileInputGUI: begin
        // get the value for the maximal uploadable filesize from the php.ini (if available)
        $umf = ini_get('upload_max_filesize');
        // get the value for the maximal post data from the php.ini (if available)
        $pms = ini_get('post_max_size');
 
        // convert from short-string representation to "real" bytes
        $multiplier_a = ['K' => 1024, 'M' => 1024 * 1024, 'G' => 1024 * 1024 * 1024];
 
        $umf_parts = preg_split(
            "/(\d+)([K|G|M])/",
            (string) $umf,
            -1,
            PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
        );
        $pms_parts = preg_split(
            "/(\d+)([K|G|M])/",
            (string) $pms,
            -1,
            PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
        );
 
        if ((is_countable($umf_parts) ? count($umf_parts) : 0) === 2) {
            $umf = (float) $umf_parts[0] * $multiplier_a[$umf_parts[1]];
        }
        if ((is_countable($pms_parts) ? count($pms_parts) : 0) === 2) {
            $pms = (float) $pms_parts[0] * $multiplier_a[$pms_parts[1]];
        }
 
        // use the smaller one as limit
        $max_filesize = min($umf, $pms);
 
        if (!$max_filesize) {
            $max_filesize = max($umf, $pms);
        }
 
        $this->mail_max_upload_file_size = (int) $max_filesize;
    }

References ILIAS\Repository\int().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCollectionExclusivelyOwnedByMail()

ilFileDataMail::isCollectionExclusivelyOwnedByMail ( ResourceCollectionIdentification $rcid )

True if the collection can be handed over to delivered mails without copying it: it is Mail-owned and nobody references it.

Definition at line 560 of file class.ilFileDataMail.php.

                                                                                              : bool
    {
        if ($this->isCollectionReferenced($rcid) || !$this->collectionIsKnown($rcid)) {
            return false;
        }
 
        $rid_strings = $this->getRidsFromCollection($rcid);
        if ($rid_strings === []) {
            return false;
        }
 
        foreach ($rid_strings as $rid_string) {
            $resource_identification = $this->irss->manage()->find($rid_string);
            if ($resource_identification === null
                || !$this->resourceHasOnlyMailStakeholder($resource_identification)) {
                return false;
            }
        }
 
        return true;
    }

◆ isCollectionReferenced()

ilFileDataMail::isCollectionReferenced ( ResourceCollectionIdentification $rcid )

A Mail collection is referenced as long as a mail (sent, received, draft, outbox), a compose stage or a user's attachment pool points to it.

Definition at line 491 of file class.ilFileDataMail.php.

                                                                                  : bool
    {
        $serialized = $rcid->serialize();
 
        $this->db->setLimit(1, 0);
        $res = $this->db->queryF(
            'SELECT 1 FROM mail_attachment WHERE rcid = %s',
            [ilDBConstants::T_TEXT],
            [$serialized]
        );
        if ($this->db->numRows($res) > 0) {
            return true;
        }
 
        $this->db->setLimit(1, 0);
        $res = $this->db->queryF(
            'SELECT 1 FROM mail_saved WHERE attachments = %s',
            [ilDBConstants::T_TEXT],
            [$serialized]
        );
        if ($this->db->numRows($res) > 0) {
            return true;
        }
 
        $res = $this->db->queryF(
            'SELECT value FROM usr_pref WHERE usr_id = %s AND keyword = %s',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT],
            [$this->user_id, self::POOL_RCID_PREF_KEY]
        );
        $row = $this->db->fetchAssoc($res);
 
        return is_array($row) && (string) $row['value'] === $serialized;
    }

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

Here is the call graph for this function:

◆ isInUserPool()

ilFileDataMail::isInUserPool ( ResourceIdentification $identification )

Definition at line 412 of file class.ilFileDataMail.php.

                                                                        : bool
    {
        return $this->collectionContainsResource($this->resolveUserPoolRcid(), $identification);
    }

◆ isLegacyPoolItemIdentifier()

ilFileDataMail::isLegacyPoolItemIdentifier ( string $identifier )

Definition at line 354 of file class.ilFileDataMail.php.

                                                                  : bool
    {
        return str_starts_with($identifier, self::LEGACY_POOL_ITEM_PREFIX);
    }

◆ isValidAttachmentPoolFilename()

ilFileDataMail::isValidAttachmentPoolFilename ( string $filename )

private

Definition at line 609 of file class.ilFileDataMail.php.

                                                                    : bool
    {
        return $filename !== '' &&
            !str_contains($filename, "\0") &&
            !str_contains($filename, '/') &&
            !str_contains($filename, '\\');
    }

References $filename.

◆ iteratePoolResourceIdentifications()

ilFileDataMail::iteratePoolResourceIdentifications ( ResourceCollectionIdentification $pool_rcid )

private

Returns: \Generator<int, ResourceIdentification>

Definition at line 309 of file class.ilFileDataMail.php.

                                                                                                    : Generator
    {
        foreach ($this->getAssignedRidStrings($pool_rcid) as $rid_string) {
            $resource_identification = $this->irss->manage()->find($rid_string);
            if ($resource_identification !== null) {
                yield $resource_identification;
            }
        }
    }

◆ legacyPoolFilenameFromIdentifier()

ilFileDataMail::legacyPoolFilenameFromIdentifier ( string $identifier )

Definition at line 359 of file class.ilFileDataMail.php.

                                                                        : string
    {
        return substr($identifier, strlen(self::LEGACY_POOL_ITEM_PREFIX));
    }

◆ loadPoolCollectionForMutation()

ilFileDataMail::loadPoolCollectionForMutation ( ?ResourceCollectionIdentification $pool_rcid )

private

Definition at line 1378 of file class.ilFileDataMail.php.

                                                                                                : ResourceCollection
    {
        if ($pool_rcid !== null && $this->collectionIsKnown($pool_rcid)) {
            $this->irss->preloadCollections([$pool_rcid->serialize()]);
 
            return $this->irss->collection()->get($pool_rcid, $this->user_id);
        }
 
        $collection_id = $this->irss->collection()->id(null, $this->user_id);
 
        return $this->irss->collection()->get($collection_id, $this->user_id);
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Here is the call graph for this function:

◆ migrateLegacyPoolAttachments()

ilFileDataMail::migrateLegacyPoolAttachments ( MailAttachments $attachments )

Definition at line 1118 of file class.ilFileDataMail.php.

                                                                              : ?MailAttachments
    {
        if (!$attachments->isLegacy()) {
            return $attachments;
        }
 
        if (!$this->checkFilesExist($attachments->legacyFilenames())) {
            return null;
        }
 
        $rcid = $this->createCollectionFromPoolFilenames($attachments->legacyFilenames());
 
        return $rcid !== null ? MailAttachments::fromIrss($rcid) : null;
    }

References ILIAS\Mail\Attachments\MailAttachments\isLegacy(), and ILIAS\Mail\Attachments\MailAttachments\legacyFilenames().

Here is the call graph for this function:

◆ migrateLegacyPoolFilenameToResource()

ilFileDataMail::migrateLegacyPoolFilenameToResource ( string $filename )

Definition at line 364 of file class.ilFileDataMail.php.

                                                                         : ?ResourceIdentification
    {
        $path = $this->getAbsoluteAttachmentPoolPathByFilename($filename);
        if (!is_file($path)) {
            return null;
        }
 
        $rid = $this->streamFromPath($path, md5($filename));
        $this->applyResourceFileName($rid, $filename);
        try {
            $rid = $this->addResourceToPool($rid);
        } catch (RuntimeException) {
            return null;
        }
 
        $this->unlinkFile($filename);
 
        return $rid;
    }

References $filename.

◆ persistUserPoolRcid()

ilFileDataMail::persistUserPoolRcid ( ResourceCollectionIdentification $rcid )

private

Definition at line 473 of file class.ilFileDataMail.php.

                                                                                : void
    {
        $this->db->replace(
            'usr_pref',
            [
                'usr_id' => [ilDBConstants::T_INTEGER, $this->user_id],
                'keyword' => [ilDBConstants::T_TEXT, self::POOL_RCID_PREF_KEY],
            ],
            [
                'value' => [ilDBConstants::T_TEXT, $rcid->serialize()],
            ]
        );
    }

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

Referenced by addResourceToPool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ poolResourceHash()

ilFileDataMail::poolResourceHash ( ResourceIdentification $rid )

Definition at line 468 of file class.ilFileDataMail.php.

                                                                 : string
    {
        return $this->irss->manage()->getCurrentRevision($rid)->getTitle();
    }

Referenced by addResourceToPool().

Here is the caller graph for this function:

◆ releaseCollectionIfUnreferenced()

ilFileDataMail::releaseCollectionIfUnreferenced ( ResourceCollectionIdentification $rcid )

Removes a Mail collection nobody references anymore, together with its resources.

Collections containing resources of other components are never touched.

Definition at line 529 of file class.ilFileDataMail.php.

                                                                                           : void
    {
        $serialized = $rcid->serialize();
        if ($serialized === '' || $serialized === '-') {
            return;
        }
 
        if ($this->isCollectionReferenced($rcid) || !$this->collectionIsKnown($rcid)) {
            return;
        }
 
        foreach ($this->getRidsFromCollection($rcid) as $rid_string) {
            $resource_identification = $this->irss->manage()->find($rid_string);
            if ($resource_identification !== null
                && !$this->resourceHasOnlyMailStakeholder($resource_identification)) {
                return;
            }
        }
 
        $this->removeCollection($rcid, true);
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Here is the call graph for this function:

◆ releaseSourceCollectionAfterDelivery()

ilFileDataMail::releaseSourceCollectionAfterDelivery ( ResourceCollectionIdentification $rcid )

Drops the source collection after it has been delivered.

Foreign collections (Exercise, Test, …), the user pool and collections still referenced by mails or a compose stage stay untouched.

Definition at line 1545 of file class.ilFileDataMail.php.

                                                                                                : void
    {
        $this->releaseCollectionIfUnreferenced($rcid);
    }

◆ removeCollection()

ilFileDataMail::removeCollection	(	ResourceCollectionIdentification	$rcid,
		bool	$delete_resources = `false`
	)

Removes the collection.

Resources are only deleted if explicitly requested; prefer releaseCollectionIfUnreferenced() which respects references of mails, stage and pool.

Definition at line 1527 of file class.ilFileDataMail.php.

                                                                                                            : void
    {
        if (!$this->irss->collection()->exists($rcid->serialize())) {
            return;
        }
 
        $this->irss->collection()->remove(
            $rcid,
            $this->stakeholder,
            $delete_resources
        );
    }

References ILIAS\ResourceStorage\Identification\AbstractIdentification\serialize().

Here is the call graph for this function:

◆ removeFromPool()

ilFileDataMail::removeFromPool ( ResourceIdentification $rid )

Definition at line 450 of file class.ilFileDataMail.php.

                                                               : void
    {
        $pool_rcid = $this->resolveUserPoolRcid();
        if ($pool_rcid === null) {
            return;
        }
 
        $collection = $this->getCollection($pool_rcid);
        if (!$collection->isIn($rid)) {
            return;
        }
 
        $collection->remove($rid);
        $this->irss->collection()->store($collection);
 
        $this->deleteResource($rid);
    }

Referenced by addResourceToPool().

Here is the caller graph for this function:

◆ removeFromStage()

ilFileDataMail::removeFromStage ( ResourceIdentification $identification )

Definition at line 1027 of file class.ilFileDataMail.php.

                                                                           : bool
    {
        $stage_rcid = $this->resolveStageRcid();
        if (!$this->collectionContainsResource($stage_rcid, $identification)) {
            return false;
        }
 
        $collection = $this->getCollection($stage_rcid);
        $collection->remove($identification);
        $this->irss->collection()->store($collection);
        $this->deleteResource($identification);
 
        return true;
    }

◆ replaceMailAttachmentCollection()

ilFileDataMail::replaceMailAttachmentCollection	(	int	$mail_id,
		?ResourceCollectionIdentification	$rcid
	)

Points a mail (draft, outbox) to the passed collection (or to none).

A previously referenced collection is released if nothing else references it anymore.

Definition at line 648 of file class.ilFileDataMail.php.

                                                                                                          : void
    {
        if ($this->hasLegacyAttachmentDirectory($mail_id)) {
            return;
        }
 
        $previous_rcid = $this->getRcidForMail($mail_id);
        if ($previous_rcid !== null && $rcid !== null && $previous_rcid->serialize() === $rcid->serialize()) {
            return;
        }
 
        $this->db->manipulateF(
            'DELETE FROM mail_attachment WHERE mail_id = %s AND (path IS NULL OR path = %s)',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT],
            [$mail_id, '']
        );
 
        if ($rcid !== null) {
            $this->assignAttachmentsToCollection($mail_id, $rcid);
        }
 
        if ($previous_rcid !== null) {
            $this->releaseCollectionIfUnreferenced($previous_rcid);
        }
    }

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

Here is the call graph for this function:

◆ resolvePoolIdentifiersToResources()

ilFileDataMail::resolvePoolIdentifiersToResources ( array $identifiers )

Parameters

list<string> $identifiers

Returns: list<ResourceIdentification>

Definition at line 388 of file class.ilFileDataMail.php.

                                                                         : array
    {
        $resource_identifications = [];
 
        foreach ($identifiers as $identifier) {
            if ($this->isLegacyPoolItemIdentifier($identifier)) {
                $resource_identification = $this->migrateLegacyPoolFilenameToResource(
                    $this->legacyPoolFilenameFromIdentifier($identifier)
                );
            } else {
                $resource_identification = $this->irss->manage()->find($identifier);
                if ($resource_identification !== null && !$this->isInUserPool($resource_identification)) {
                    $resource_identification = null;
                }
            }
 
            if ($resource_identification !== null) {
                $resource_identifications[] = $resource_identification;
            }
        }
 
        return $resource_identifications;
    }

◆ resolveStageRcid()

ilFileDataMail::resolveStageRcid ( )

private

Definition at line 275 of file class.ilFileDataMail.php.

                                       : ?ResourceCollectionIdentification
    {
        $res = $this->db->queryF(
            'SELECT attachments FROM mail_saved WHERE user_id = %s',
            [ilDBConstants::T_INTEGER],
            [$this->user_id]
        );
        $row = $this->db->fetchAssoc($res);
        if (!is_array($row)) {
            return null;
        }
 
        $stage = MailAttachments::fromDb(is_string($row['attachments'] ?? null) ? $row['attachments'] : null);
        if ($stage === null || !$stage->isIrss()) {
            return null;
        }
 
        return $stage->rcid();
    }

References $res, and ilDBConstants\T_INTEGER.

◆ resolveUserPoolRcid()

ilFileDataMail::resolveUserPoolRcid ( )

private

Definition at line 260 of file class.ilFileDataMail.php.

                                          : ?ResourceCollectionIdentification
    {
        $pref = ilObjUser::_lookupPref($this->user_id, self::POOL_RCID_PREF_KEY);
        if (!is_string($pref) || $pref === '') {
            return null;
        }
 
        $rcid = new ResourceCollectionIdentification($pref);
        if (!$this->collectionIsKnown($rcid)) {
            return null;
        }
 
        return $rcid;
    }

References ilObjUser\_lookupPref(), and collectionIsKnown().

Referenced by addResourceToPool(), and getUserPoolRcid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resourceHasOnlyMailStakeholder()

ilFileDataMail::resourceHasOnlyMailStakeholder ( ResourceIdentification $rid )

private

Definition at line 1570 of file class.ilFileDataMail.php.

                                                                                : bool
    {
        $has_mail = false;
        foreach ($this->irss->manage()->getResource($rid)->getStakeholders() as $stakeholder) {
            if ($stakeholder->getId() !== $this->stakeholder->getId()) {
                return false;
            }
            $has_mail = true;
        }
 
        return $has_mail;
    }

◆ resourceIdByHashInCollection()

ilFileDataMail::resourceIdByHashInCollection	(	ResourceCollection	$collection,
		string	$hash
	)

private

Definition at line 1448 of file class.ilFileDataMail.php.

                                                                                               : ?ResourceIdentification
    {
        foreach ($collection->getResourceIdentifications() as $resource_identification) {
            $revision = $this->irss->manage()->getCurrentRevision($resource_identification);
            if ($revision->getTitle() === $hash) {
                return $resource_identification;
            }
        }
 
        return null;
    }

References ILIAS\ResourceStorage\Collection\ResourceCollection\getResourceIdentifications().

Referenced by addResourceToPool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restrictStageTo()

ilFileDataMail::restrictStageTo ( array $rid_strings )

Removes all files from the compose stage which are not part of the submitted form.

Parameters

list<string> $rid_strings

Definition at line 1047 of file class.ilFileDataMail.php.

                                                       : ?ResourceCollectionIdentification
    {
        $stage_rcid = $this->resolveStageRcid();
        if ($stage_rcid === null || !$this->collectionIsKnown($stage_rcid)) {
            return null;
        }
 
        $kept = array_flip($rid_strings);
        $collection = $this->getCollection($stage_rcid);
        $removed = [];
        foreach ($collection->getResourceIdentifications() as $identification) {
            if (!isset($kept[$identification->serialize()])) {
                $collection->remove($identification);
                $removed[] = $identification;
            }
        }
 
        if ($removed !== []) {
            $this->irss->collection()->store($collection);
            foreach ($removed as $identification) {
                $this->deleteResource($identification);
            }
        }
 
        return $collection->count() > 0 ? $collection->getIdentification() : null;
    }

◆ streamFromPath()

ilFileDataMail::streamFromPath	(	string	$absolute_path,
		?string	$revision_title = `null`
	)

Definition at line 1074 of file class.ilFileDataMail.php.

                                                                                         : ResourceIdentification
    {
        $stream = Streams::ofResource(fopen($absolute_path, 'rb'));
 
        return $this->irss->manage()->stream(
            $stream,
            $this->stakeholder,
            $revision_title ?? md5(basename($absolute_path))
        );
    }

◆ unlinkFile()

ilFileDataMail::unlinkFile ( string $a_filename )

Definition at line 582 of file class.ilFileDataMail.php.

                                                  : bool
    {
        if (!$this->isValidAttachmentPoolFilename($a_filename)) {
            return false;
        }
 
        $path = $this->getAbsoluteAttachmentPoolPathByFilename($a_filename);
        if (is_file($path)) {
            return unlink($path);
        }
 
        return false;
    }

◆ uploadToIrss()

ilFileDataMail::uploadToIrss ( UploadResult $result )

Definition at line 1085 of file class.ilFileDataMail.php.

                                                      : ResourceIdentification
    {
        return $this->irss->manage()->upload(
            $result,
            $this->stakeholder,
            md5($result->getName())
        );
    }

References ILIAS\FileUpload\DTO\UploadResult\getName().

Referenced by uploadToPool().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uploadToPool()

ilFileDataMail::uploadToPool ( UploadResult $result )

Definition at line 213 of file class.ilFileDataMail.php.

                                                      : ResourceIdentification
    {
        $rid = $this->uploadToIrss($result);
 
        return $this->addResourceToPool($rid);
    }

References addResourceToPool(), and uploadToIrss().

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilFileDataMail::$db

protected

Definition at line 46 of file class.ilFileDataMail.php.

◆ $ilias

ILIAS ilFileDataMail::$ilias

protected

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

◆ $irss

readonly Services ilFileDataMail::$irss

private

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

◆ $mail_max_upload_file_size

int ilFileDataMail::$mail_max_upload_file_size

protected

Definition at line 43 of file class.ilFileDataMail.php.

Referenced by getUploadLimit().

◆ $mail_path

string ilFileDataMail::$mail_path

Definition at line 42 of file class.ilFileDataMail.php.

Referenced by getMailPath().

◆ $stakeholder

readonly ilMailAttachmentStakeholder ilFileDataMail::$stakeholder

private

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

◆ $storage_directory

Filesystem ilFileDataMail::$storage_directory

protected

Definition at line 45 of file class.ilFileDataMail.php.

◆ $tmp_directory

Filesystem ilFileDataMail::$tmp_directory

protected

Definition at line 44 of file class.ilFileDataMail.php.

◆ LEGACY_POOL_ITEM_PREFIX

const string ilFileDataMail::LEGACY_POOL_ITEM_PREFIX = 'legacy:'

Definition at line 40 of file class.ilFileDataMail.php.

◆ POOL_RCID_PREF_KEY

const string ilFileDataMail::POOL_RCID_PREF_KEY = 'mail_attachment_pool_rcid'

Definition at line 39 of file class.ilFileDataMail.php.

Referenced by ilMailAttachmentStakeholder\collectionsOfUser().

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

components/ILIAS/Mail/classes/class.ilFileDataMail.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addResourceToPool()

◆ addResourceToStage()

◆ adoptPoolFilenamesToCollection()

◆ adoptPoolResourcesToCollection()

◆ applyPoolSelectionToStage()

◆ applyResourceFileName()

◆ assignAttachmentsToCollection()

◆ attachmentHash()

◆ canUseResourceInCompose()

◆ checkFilesExist()

◆ checkReadWrite()

◆ collectionContainsResource()

◆ collectionIsKnown()

◆ copyCollection()

◆ copyResources()

◆ createCollectionFromContent()

◆ createCollectionFromPoolFilenames()

◆ createCollectionFromResourceIdentifications()

◆ createStageFromLegacyMailAttachments()

◆ deassignAttachmentFromDirectory()

◆ deleteAttachmentDirectory()

◆ deleteResource()

◆ deliverAttachmentsAsZip()

◆ deliverCollectionAsZip()

◆ deliverFile()

◆ getAbsoluteAttachmentPoolPathByFilename()

◆ getAbsoluteAttachmentPoolPathPrefix()

◆ getAssignedRidStrings()

◆ getAttachmentListing()

◆ getAttachmentPathAndFilenameByMd5Hash()

◆ getAttachmentPathByMailId()

◆ getAttachmentsTotalSizeLimit()

◆ getCollection()

◆ getIrssMimeAttachments()

◆ getMailPath()

◆ getPoolResourcesInStage()

◆ getRcidForMail()

◆ getRcidForMailOfUser()

◆ getResourceIdByHash()

◆ getRidsFromCollection()

◆ getStakeholder()

◆ getUploadLimit()

◆ getUserPoolFilesData()

◆ getUserPoolRcid()

◆ getUserPoolResources()

◆ hasLegacyAttachmentDirectory()

◆ initAttachmentMaxUploadSize()

◆ isCollectionExclusivelyOwnedByMail()

◆ isCollectionReferenced()

◆ isInUserPool()

◆ isLegacyPoolItemIdentifier()

◆ isValidAttachmentPoolFilename()

◆ iteratePoolResourceIdentifications()

◆ legacyPoolFilenameFromIdentifier()

◆ loadPoolCollectionForMutation()

◆ migrateLegacyPoolAttachments()

◆ migrateLegacyPoolFilenameToResource()

◆ persistUserPoolRcid()

◆ poolResourceHash()

◆ releaseCollectionIfUnreferenced()

◆ releaseSourceCollectionAfterDelivery()

◆ removeCollection()

◆ removeFromPool()

◆ removeFromStage()

◆ replaceMailAttachmentCollection()

◆ resolvePoolIdentifiersToResources()

◆ resolveStageRcid()

◆ resolveUserPoolRcid()

◆ resourceHasOnlyMailStakeholder()

◆ resourceIdByHashInCollection()