ilFileDataMail Class Reference

Inheritance diagram for ilFileDataMail:

Collaboration diagram for ilFileDataMail:

Public Member Functions
	__construct (public int $user_id=0)
	initDirectory ()
	getUploadLimit ()
	getAttachmentsTotalSizeLimit ()
	getMailPath ()
	getAbsoluteAttachmentPoolPathPrefix ()
	getAttachmentPathAndFilenameByMd5Hash (string $md5FileHash, int $mail_id)
	getAttachmentPath (string $a_filename, int $a_mail_id)
	adoptAttachments (array $a_attachments, int $a_mail_id)
	checkReadWrite ()
	getUserFilesData ()
	storeAsAttachment (string $a_filename, string $a_content)
	storeUploadedFile (UploadResult $result)
	copyAttachmentFile (string $a_abs_path, string $a_new_name)
	unlinkFiles (array $a_filenames)
	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...
	saveFiles (int $a_mail_id, array $a_attachments)
	Saves all attachment files in a specific mail directory .../mail/<calculated_path>/mail_<mail_id>_<user_id>/... More...
	saveFile (int $a_mail_id, string $a_attachment)
	Save attachment file in a specific mail directory .../mail/<calculated_path>/mail_<mail_id>_<user_id>/... More...
	checkFilesExist (array $a_files)
	assignAttachmentsToDirectory (int $a_mail_id, int $a_sent_mail_id)
	deassignAttachmentFromDirectory (int $a_mail_id)
	deliverAttachmentsAsZip (string $basename, int $mail_id, array $files=[], bool $is_draft=false)
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...

Static Public Member Functions
static	getStorage (int $a_mail_id, int $a_usr_id)

Data Fields
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)
	rotateFiles (string $a_path)
	deleteAttachmentDirectory (string $a_rel_path)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilFileDataMail::__construct

(

public int

$user_id = 0

)

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

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

    {
        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->checkReadWrite();
        $this->initAttachmentMaxUploadSize();
    }

Here is the call graph for this function:

Member Function Documentation

adoptAttachments()

ilFileDataMail::adoptAttachments	(	array	$a_attachments,
		int	$a_mail_id
	)

Parameters

list<string>

$a_attachments

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

References ilFile\$path, getAttachmentPath(), and getMailPath().

                                                                          : string
    {
        foreach ($a_attachments as $file) {
            $path = $this->getAttachmentPath($file, $a_mail_id);
            if (!copy($path, $this->getMailPath() . '/' . $this->user_id . '_' . $file)) {
                return 'ERROR: ' . $this->getMailPath() . '/' . $this->user_id . '_' . $file . ' cannot be created';
            }
        }

        return '';
    }

Here is the call graph for this function:

assignAttachmentsToDirectory()

ilFileDataMail::assignAttachmentsToDirectory	(	int	$a_mail_id,
		int	$a_sent_mail_id
	)

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

                                                                                     : void
    {
        $storage = self::getStorage($a_sent_mail_id, $this->user_id);
        $this->db->manipulateF(
            '
                        INSERT INTO mail_attachment 
                        ( mail_id, path) VALUES (%s, %s)',
            ['integer', 'text'],
            [$a_mail_id, $storage->getRelativePathExMailDirectory()]
        );
    }

checkFilesExist()

ilFileDataMail::checkFilesExist

(

array

$a_files

)

Parameters

list<string>

$a_files

Definition at line 365 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 162 of file class.ilFileDataMail.php.

Referenced by __construct().

                                    : 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;
    }

Here is the caller graph for this function:

copyAttachmentFile()

ilFileDataMail::copyAttachmentFile	(	string	$a_abs_path,
		string	$a_new_name
	)

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

References getMailPath().

                                                                              : bool
    {
        @copy($a_abs_path, $this->getMailPath() . '/' . $this->user_id . '_' . $a_new_name);

        return true;
    }

Here is the call graph for this function:

deassignAttachmentFromDirectory()

ilFileDataMail::deassignAttachmentFromDirectory

(

int

$a_mail_id

)

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

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

                                                                   : bool
    {
        $res = $this->db->query(
            'SELECT path FROM mail_attachment WHERE mail_id = ' . $this->db->quote($a_mail_id, 'integer')
        );

        $path = '';
        while ($row = $this->db->fetchObject($res)) {
            $path = (string) $row->path;
        }

        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;
    }

Here is the call graph for this function:

deleteAttachmentDirectory()

ilFileDataMail::deleteAttachmentDirectory ( string  $a_rel_path )

private

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

References ilFileUtils\delDir().

Referenced by deassignAttachmentFromDirectory().

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

Here is the call graph for this function:

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 544 of file class.ilFileDataMail.php.

References $filename, ilFile\$path, ilFileDelivery\deliverFileAttached(), getAbsoluteAttachmentPoolPathByFilename(), ilFileUtils\getASCIIFilename(), getAttachmentPathByMailId(), ilFileUtils\getValidFilename(), ilFileUtils\ilTempnam(), MAILPATH, and ilFileUtils\zip().

     : void {
        $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')
        );
    }

Here is the call graph for this function:

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 314 of file class.ilFileDataMail.php.

References $filename, and getAbsoluteAttachmentPoolPathPrefix().

Referenced by deliverAttachmentsAsZip().

                                                                             : string
    {
        return $this->getAbsoluteAttachmentPoolPathPrefix() . $filename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAbsoluteAttachmentPoolPathPrefix()

ilFileDataMail::getAbsoluteAttachmentPoolPathPrefix

(

)

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

Referenced by getAbsoluteAttachmentPoolPathByFilename().

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

Here is the caller graph for this function:

getAttachmentPath()

ilFileDataMail::getAttachmentPath	(	string	$a_filename,
		int	$a_mail_id
	)

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

References ilFile\$path, getAttachmentPathByMailId(), and getMailPath().

Referenced by adoptAttachments().

                                                                         : string
    {
        $path = $this->getMailPath() . '/' . $this->getAttachmentPathByMailId($a_mail_id) . '/' . $a_filename;

        if (is_readable($path)) {
            return $path;
        }

        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAttachmentPathAndFilenameByMd5Hash()

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

Returns

array{path: string, filename: string} An array containing 'path' and 'filename' for the passed MD5 hash

Exceptions

OutOfBoundsException

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

References ilFile\$path, $res, ilFileUtils\getDir(), and getMailPath().

Referenced by ilMailFolderGUI\deliverFile().

                                                                                            : array
    {
        $res = $this->db->queryF(
            'SELECT path FROM mail_attachment WHERE mail_id = %s',
            ['integer'],
            [$mail_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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAttachmentPathByMailId()

ilFileDataMail::getAttachmentPathByMailId ( int  $mail_id )

private

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

Referenced by deliverAttachmentsAsZip(), and getAttachmentPath().

                                                            : 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 '';
    }

Here is the caller graph for this function:

getAttachmentsTotalSizeLimit()

ilFileDataMail::getAttachmentsTotalSizeLimit

(

)

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

References null.

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

        return (float) $this->ilias->getSetting('mail_maxsize_attach', '0') * 1024;
    }

getMailPath()

ilFileDataMail::getMailPath

(

)

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

References $mail_path.

Referenced by adoptAttachments(), copyAttachmentFile(), getAttachmentPath(), getAttachmentPathAndFilenameByMd5Hash(), initAttachmentMaxUploadSize(), storeAsAttachment(), and storeUploadedFile().

                                 : string
    {
        return $this->mail_path;
    }

Here is the caller graph for this function:

getStorage()

static ilFileDataMail::getStorage ( int  $a_mail_id, int  $a_usr_id  )

static

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

                                                                    : ilFSStorageMail
    {
        static $fsstorage_cache = [];

        $fsstorage_cache[$a_mail_id][$a_usr_id] = new ilFSStorageMail($a_mail_id, $a_usr_id);

        return $fsstorage_cache[$a_mail_id][$a_usr_id];
    }

getUploadLimit()

ilFileDataMail::getUploadLimit

(

)

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

References $mail_max_upload_file_size.

Referenced by storeAsAttachment().

                                    : int
    {
        return $this->mail_max_upload_file_size;
    }

Here is the caller graph for this function:

getUserFilesData()

ilFileDataMail::getUserFilesData

(

)

Returns

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

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

References $user_id.

                                      : array
    {
        return $this->getUnsentFiles();
    }

initAttachmentMaxUploadSize()

ilFileDataMail::initAttachmentMaxUploadSize ( )

protected

Todo:

mjansen: Unfortunately we cannot reuse the implementation of ilFileInputGUI

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

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

Referenced by __construct().

                                                    : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initDirectory()

ilFileDataMail::initDirectory

(

)

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

References ilFileData\getPath(), and MAILPATH.

                                   : bool
    {
        if (is_writable($this->getPath())
            && mkdir($this->getPath() . '/' . MAILPATH)
            && chmod($this->getPath() . '/' . MAILPATH, 0755)) {
            $this->mail_path = $this->getPath() . '/' . MAILPATH;
            return true;
        }

        return false;
    }

Here is the call graph for this function:

rotateFiles()

ilFileDataMail::rotateFiles ( string  $a_path )

private

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

References ilFileUtils\rename().

Referenced by storeAsAttachment(), and storeUploadedFile().

                                                : bool
    {
        if (is_file($a_path)) {
            $this->rotateFiles($a_path . '.old');
            return ilFileUtils::rename($a_path, $a_path . '.old');
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveFile()

ilFileDataMail::saveFile	(	int	$a_mail_id,
		string	$a_attachment
	)

Save attachment file in a specific mail directory .../mail/<calculated_path>/mail_<mail_id>_<user_id>/...

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

Referenced by saveFiles().

                                                                  : bool
    {
        $storage = self::getStorage($a_mail_id, $this->user_id);
        $storage->create();
        $storage_directory = $storage->getAbsolutePath();

        if (!is_dir($storage_directory)) {
            return false;
        }

        return copy(
            $this->mail_path . '/' . $this->user_id . '_' . $a_attachment,
            $storage_directory . '/' . $a_attachment
        );
    }

Here is the caller graph for this function:

saveFiles()

ilFileDataMail::saveFiles	(	int	$a_mail_id,
		array	$a_attachments
	)

Saves all attachment files in a specific mail directory .../mail/<calculated_path>/mail_<mail_id>_<user_id>/...

Parameters

list<string>

$a_attachments

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

References saveFile().

                                                                   : void
    {
        if (!is_numeric($a_mail_id) || $a_mail_id < 1) {
            throw new InvalidArgumentException('The passed mail_id must be a valid integer!');
        }

        foreach ($a_attachments as $attachment) {
            $this->saveFile($a_mail_id, $attachment);
        }
    }

Here is the call graph for this function:

storeAsAttachment()

ilFileDataMail::storeAsAttachment	(	string	$a_filename,
		string	$a_content
	)

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

References ilFileUtils\_sanitizeFilemame(), getMailPath(), getUploadLimit(), and rotateFiles().

                                                                            : string
    {
        if (strlen($a_content) >= $this->getUploadLimit()) {
            throw new DomainException(
                sprintf(
                    'Mail upload limit reached for user with id %s',
                    $this->user_id
                )
            );
        }

        $name = ilFileUtils::_sanitizeFilemame($a_filename);
        $this->rotateFiles($this->getMailPath() . '/' . $this->user_id . '_' . $name);

        $abs_path = $this->getMailPath() . '/' . $this->user_id . '_' . $name;

        $fp = fopen($abs_path, 'wb+');
        if (!is_resource($fp)) {
            throw new RuntimeException(
                sprintf(
                    'Could not read file: %s',
                    $abs_path
                )
            );
        }

        if (fwrite($fp, $a_content) === false) {
            fclose($fp);
            throw new RuntimeException(
                sprintf(
                    'Could not write file: %s',
                    $abs_path
                )
            );
        }

        fclose($fp);

        return $name;
    }

Here is the call graph for this function:

storeUploadedFile()

ilFileDataMail::storeUploadedFile

(

UploadResult

$result

)

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

References $filename, ilFileUtils\_sanitizeFilemame(), getMailPath(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getPath(), ilFileUtils\moveUploadedFile(), and rotateFiles().

                                                           : string
    {
        $filename = ilFileUtils::_sanitizeFilemame(
            $result->getName()
        );

        $this->rotateFiles($this->getMailPath() . '/' . $this->user_id . '_' . $filename);

        ilFileUtils::moveUploadedFile(
            $result->getPath(),
            $filename,
            $this->getMailPath() . '/' . $this->user_id . '_' . $filename
        );

        return $filename;
    }

Here is the call graph for this function:

unlinkFile()

ilFileDataMail::unlinkFile

(

string

$a_filename

)

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

Referenced by unlinkFiles().

                                                  : bool
    {
        if (is_file($this->mail_path . '/' . basename($this->user_id . '_' . $a_filename))) {
            return unlink($this->mail_path . '/' . basename($this->user_id . '_' . $a_filename));
        }

        return false;
    }

Here is the caller graph for this function:

unlinkFiles()

ilFileDataMail::unlinkFiles

(

array

$a_filenames

)

Parameters

list<string>

$a_filenames

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

References unlinkFile().

                                                   : string
    {
        foreach ($a_filenames as $file) {
            if (!$this->unlinkFile($file)) {
                return $file;
            }
        }

        return '';
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilFileDataMail::$db

protected

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

$ilias

ILIAS ilFileDataMail::$ilias

protected

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

$mail_max_upload_file_size

int ilFileDataMail::$mail_max_upload_file_size

protected

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

Referenced by getUploadLimit().

$mail_path

string ilFileDataMail::$mail_path

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

Referenced by getMailPath().

$storage_directory

Filesystem ilFileDataMail::$storage_directory

protected

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

$tmp_directory

Filesystem ilFileDataMail::$tmp_directory

protected

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

---

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

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