ilFileDataMail Class Reference

Class ilFileDataMail. More...

Inheritance diagram for ilFileDataMail:

Collaboration diagram for ilFileDataMail:

Public Member Functions
	__construct ($a_user_id=0)
	Constructor call base constructors checks if directory is writable and sets the optional user_id. More...
	initDirectory ()
	init directory overwritten method public More...
	getUploadLimit ()
	getAttachmentsTotalSizeLimit ()
	getMailPath ()
	get mail path public More...
	getAbsoluteAttachmentPoolPathPrefix ()
	getAttachmentPathAndFilenameByMd5Hash (string $md5FileHash, int $mailId)
	getAttachmentPath ($a_filename, $a_mail_id)
	get the path of a specific attachment More...
	adoptAttachments ($a_attachments, $a_mail_id)
	adopt attachments (in case of forwarding a mail) More...
	checkReadWrite ()
	check if directory is writable overwritten method from base class private More...
	getUserFilesData ()
	storeAsAttachment ($a_filename, $a_content)
	Store content as attachment. More...
	storeUploadedFile ($file)
	copyAttachmentFile ($a_abs_path, $a_new_name)
	Copy files in mail directory. More...
	rotateFiles ($a_path)
	rotate files with same name recursive method More...
	unlinkFiles ($a_filenames)
	unlink files: expects an array of filenames e.g. More...
	unlinkFile ($a_filename)
	unlink one uploaded file expects a filename e.g 'foo' More...
	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 ($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 ($a_mail_id, $a_attachment)
	save attachment file in a specific mail directory .../mail/<calculated_path>/mail_<mail_id>_<user_id>/... More...
	checkFilesExist ($a_files)
	check if files exist More...
	assignAttachmentsToDirectory ($a_mail_id, $a_sent_mail_id)
	assign attachments to mail directory More...
	deassignAttachmentFromDirectory ($a_mail_id)
	dassign attachments from mail directory More...
	__deleteAttachmentDirectory ($a_rel_path)
	deliverAttachmentsAsZip (string $basename, int $mailId, $files=[], $isDraft=false)
Public Member Functions inherited from ilFileData
	__construct ()
	Constructor class bas constructor and read path of directory from ilias.ini setup an mail object public. More...
	checkPath ($a_path)
	check if path exists and is writable More...
	getPath ()
	get Path public More...
Public Member Functions inherited from ilFile
	__construct ()
	Constructor get ilias object public. More...
	deleteTrailingSlash ($a_path)
	delete trailing slash of path variables More...

Static Public Member Functions
static	getStorage ($a_mail_id, $a_usr_id)
static	_lookupDiskUsageOfUser ($user_id)
	Returns the number of bytes used on the harddisk for mail attachments, by the user with the specified user id. More...

Data Fields
	$user_id
	$mail_path
Data Fields inherited from ilFile
	$path
	$ilias

Protected Member Functions
	initAttachmentMaxUploadSize ()

Protected Attributes
	$mail_max_upload_file_size
	$tmpDirectory
	$storageDirectory
	$db

Private Member Functions
	getAttachmentPathByMailId (int $mailId)

Detailed Description

Class ilFileDataMail.

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

Constructor & Destructor Documentation

__construct()

ilFileDataMail::__construct

(

$a_user_id = 0

)

Constructor call base constructors checks if directory is writable and sets the optional user_id.

Parameters

integereger

user_id public

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

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

    {
        global $DIC;

        if (!defined('MAILPATH')) {
            define('MAILPATH', 'mail');
        }
        parent::__construct();
        $this->mail_path = parent::getPath() . "/" . MAILPATH;
        $this->checkReadWrite();
        $this->user_id = $a_user_id;

        $this->db = $DIC->database();
        $this->tmpDirectory = $DIC->filesystem()->temp();
        $this->storageDirectory = $DIC->filesystem()->storage();

        $this->initAttachmentMaxUploadSize();
    }

Here is the call graph for this function:

Member Function Documentation

__deleteAttachmentDirectory()

ilFileDataMail::__deleteAttachmentDirectory

(

$a_rel_path

)

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

References ilUtil\delDir().

Referenced by deassignAttachmentFromDirectory().

    {
        ilUtil::delDir($this->mail_path . "/" . $a_rel_path);
        
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupDiskUsageOfUser()

static ilFileDataMail::_lookupDiskUsageOfUser (   $user_id )

static

Returns the number of bytes used on the harddisk for mail attachments, by the user with the specified user id.

Parameters

int

user id.

Returns

array{'count'=>integer,'size'=>integer} // an associative array with the disk // usage in bytes and the count of attachments.

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

References $DIC, Vendor\Package\$e, $ilDB, ilFile\$path, $query, $res, $size, $user_id, ilUtil\dirsize(), ilDBConstants\FETCHMODE_ASSOC, ilUtil\getDataDir(), and getMailPath().

Referenced by ilObjMailAccess\_lookupDiskUsageOfUser().

    {
        // XXX - This method is extremely slow. We should
        // use a cache to speed it up, for example, we should
        // store the disk space used in table mail_attachment.
        global $DIC;

        $mail_data_dir = ilUtil::getDataDir('filesystem') . DIRECTORY_SEPARATOR . "mail";

        $q = "SELECT path " .
            "FROM mail_attachment ma " .
            "JOIN mail m ON ma.mail_id=m.mail_id " .
            "WHERE m.user_id = " . $DIC->database()->quote($user_id);
        $result_set = $DIC->database()->query($q);
        $size = 0;
        $count = 0;
        while ($row = $result_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
            $attachment_path = $mail_data_dir . DIRECTORY_SEPARATOR . $row['path'];
            $attachment_size = ilUtil::dirsize($attachment_path);
            if ($attachment_size != -1) {
                $size += $attachment_size;
            }
            $count++;
        }
        return array('count' => $count, 'size' => $size);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

adoptAttachments()

ilFileDataMail::adoptAttachments	(		$a_attachments,
			$a_mail_id
	)

adopt attachments (in case of forwarding a mail)

Parameters

array	attachments
integer	mail_id public

Returns

string error message

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

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

    {
        if (is_array($a_attachments)) {
            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";
                }
            }
        } else {
            return "ARRAY REQUIRED";
        }
        return '';
    }

Here is the call graph for this function:

assignAttachmentsToDirectory()

ilFileDataMail::assignAttachmentsToDirectory	(		$a_mail_id,
			$a_sent_mail_id
	)

assign attachments to mail directory

Parameters

integer	mail_id
integer	key for directory assignment public

Returns

bool

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

References $ilDB, and $res.

    {
        global $ilDB;
        
        /*              $query = "INSERT INTO mail_attachment ".
                    "SET mail_id = ".$ilDB->quote($a_mail_id).", ".
                    "path = ".$ilDB->quote($this->user_id."_".$a_sent_mail_id)." ";
                $res = $this->ilias->db->query($query);
        */

        $oStorage = self::getStorage($a_sent_mail_id, $this->user_id);
        $res = $ilDB->manipulateF(
            '
                        INSERT INTO mail_attachment 
                        ( mail_id, path) VALUES (%s, %s)',
            array('integer', 'text'),
            array($a_mail_id, $oStorage->getRelativePathExMailDirectory())
        );
    }

checkFilesExist()

ilFileDataMail::checkFilesExist

(

$a_files

)

check if files exist

Parameters

array

filenames to check public

Returns

bool

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

    {
        if ($a_files) {
            foreach ($a_files as $file) {
                if (!file_exists($this->mail_path . '/' . $this->user_id . '_' . $file)) {
                    return false;
                }
            }
            return true;
        }
        return true;
    }

checkReadWrite()

ilFileDataMail::checkReadWrite

(

)

check if directory is writable overwritten method from base class private

Returns

bool

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

Referenced by __construct().

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

Here is the caller graph for this function:

copyAttachmentFile()

ilFileDataMail::copyAttachmentFile	(		$a_abs_path,
			$a_new_name
	)

Copy files in mail directory.

This is used for sending ILIAS generated mails with attachments

Parameters

array

Array with files. Absolute path required public

Returns

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

References getMailPath().

    {
        @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

(

$a_mail_id

)

dassign attachments from mail directory

Parameters

integer

mail_id public

Returns

bool

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

References $ilDB, ilFile\$path, $res, __deleteAttachmentDirectory(), and ilDBConstants\FETCHMODE_OBJECT.

    {
        global $ilDB;
        // IF IT'S THE LAST MAIL CONTAINING THESE ATTACHMENTS => DELETE ATTACHMENTS
        $res = $ilDB->query("SELECT path FROM mail_attachment
                                WHERE mail_id = " . $ilDB->quote($a_mail_id, 'integer'));
    
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $path = $row->path;
        }
        if ($path) {
            $res = $ilDB->query("SELECT COUNT(mail_id) count_mail_id FROM mail_attachment 
                                        WHERE path = " . $ilDB->quote($path, 'text')) ;
            
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $cnt_mail_id = $row->count_mail_id;
            }
            if ($cnt_mail_id == 1) {
                $this->__deleteAttachmentDirectory($path);
            }
        }

        $res = $ilDB->manipulateF(
            "DELETE FROM mail_attachment 
                                WHERE mail_id = %s",
            array('integer'),
            array($a_mail_id)
        );
        return true;
    }

Here is the call graph for this function:

deliverAttachmentsAsZip()

ilFileDataMail::deliverAttachmentsAsZip	(	string	$basename,
		int	$mailId,
			$files = [],
			$isDraft = false
	)

Parameters

string	$basename
int	$mailId
array	$files
bool	$isDraft

Exceptions

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

References ilFile\$path, $source, ilMimeTypeUtil\APPLICATION__ZIP, ilFileDelivery\DISP_ATTACHMENT, getAbsoluteAttachmentPoolPathByFilename(), ilUtil\getASCIIFilename(), getAttachmentPathByMailId(), ilFileUtils\getValidFilename(), ilUtil\ilTempnam(), MAILPATH, and ilUtil\zip().

    {
        $path = '';
        if (!$isDraft) {
            $path = $this->getAttachmentPathByMailId($mailId);
            if (0 === strlen($path)) {
                throw new \ilException('mail_download_zip_no_attachments');
            }
        }

        $downloadFilename = \ilUtil::getASCIIFilename($basename);
        if (0 === strlen($downloadFilename)) {
            $downloadFilename = 'attachments';
        }

        $processingDirectory = \ilUtil::ilTempnam();
        $relativeProcessingDirectory = basename($processingDirectory);

        $absoluteZipDirectory = $processingDirectory . '/' . $downloadFilename;
        $relativeZipDirectory = $relativeProcessingDirectory . '/' . $downloadFilename;

        $this->tmpDirectory->createDir($relativeZipDirectory);

        foreach ($files as $fileName) {
            if ($isDraft) {
                $source = str_replace(
                    $this->mail_path,
                    MAILPATH,
                    $this->getAbsoluteAttachmentPoolPathByFilename($fileName)
                );
            } else {
                $source = MAILPATH . '/' . $path . '/' . $fileName;
            }

            $source = str_replace('//', '/', $source);
            if (!$this->storageDirectory->has($source)) {
                continue;
            }

            $target = $relativeZipDirectory . '/' . $fileName;

            $stream = $this->storageDirectory->readStream($source);
            $this->tmpDirectory->writeStream($target, $stream);
        }

        $pathToZipFile = $processingDirectory . '/' . $downloadFilename . '.zip';
        \ilUtil::zip($absoluteZipDirectory, $pathToZipFile);

        $this->tmpDirectory->deleteDir($relativeZipDirectory);

        $delivery = new \ilFileDelivery($processingDirectory . '/' . $downloadFilename . '.zip');
        $delivery->setDisposition(\ilFileDelivery::DISP_ATTACHMENT);
        $delivery->setMimeType(\ilMimeTypeUtil::APPLICATION__ZIP);
        $delivery->setConvertFileNameToAsci(true);
        $delivery->setDownloadFileName(\ilFileUtils::getValidFilename($downloadFilename . '.zip'));
        $delivery->setDeleteFile(true);

        $delivery->deliver();
    }

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.

Parameters

string

$fileName

Returns

string

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

References 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

(

)

Returns

string

Definition at line 130 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	(		$a_filename,
			$a_mail_id
	)

get the path of a specific attachment

Parameters

string	filename
integer	mail_id

Returns

string path

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

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

Referenced by adoptAttachments().

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

        if (file_exists($path) && 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	$mailId
	)

Parameters

string	$md5FileHash
int	$mailId

Returns

array array An array containing the 'path' and the 'filename' for the passed MD5 hash

Exceptions

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

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

Referenced by ilMailFolderGUI\deliverFile().

                                                                                            : array
    {
        $res = $this->db->queryF(
            "SELECT path FROM mail_attachment WHERE mail_id = %s",
            ['integer'],
            [$mailId]
        );

        if (1 !== (int) $this->db->numRows($res)) {
            throw new \OutOfBoundsException();
        }

        $row = $this->db->fetchAssoc($res);

        $relativePath = $row['path'];
        $path = $this->getMailPath() . '/' . $row['path'];

        $files = ilUtil::getDir($path);
        foreach ($files as $file) {
            if ($file['type'] === 'file' && md5($file['entry']) === $md5FileHash) {
                return [
                    'path' => $this->getMailPath() . '/' . $relativePath . '/' . $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  $mailId )

private

Parameters

int

$mailId

Returns

string

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

References $query.

Referenced by deliverAttachmentsAsZip(), and getAttachmentPath().

                                                            : string
    {
        $query = $this->db->query(
            "SELECT path FROM mail_attachment WHERE mail_id = " . $this->db->quote($mailId, 'integer')
        );

        while ($row = $this->db->fetchObject($query)) {
            return $row->path;
        }

        return '';
    }

Here is the caller graph for this function:

getAttachmentsTotalSizeLimit()

ilFileDataMail::getAttachmentsTotalSizeLimit

(

)

Returns

float|null

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

    {
        $max_size = $this->ilias->getSetting('mail_maxsize_attach', '');
        if (!strlen($max_size)) {
            return null;
        }

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

getMailPath()

ilFileDataMail::getMailPath

(

)

get mail path public

Returns

string path

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

References $mail_path.

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

    {
        return $this->mail_path;
    }

Here is the caller graph for this function:

getStorage()

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

static

Parameters

$a_mail_id
$a_usr_id

Returns

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

                                                             : \ilFSStorageMail
    {
        static $fsstorage_cache = array();
        
        if (!is_object($fsstorage_cache[$a_mail_id][$a_usr_id])) {
            include_once 'Services/Mail/classes/class.ilFSStorageMail.php';
            $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

(

)

Returns

int

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

References $mail_max_upload_file_size.

Referenced by storeAsAttachment().

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

References $rest, and $user_id.

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

initAttachmentMaxUploadSize()

ilFileDataMail::initAttachmentMaxUploadSize ( )

protected

Todo:

mjansen: Unfortunately we cannot reuse the implementation of ilFileInputGUI

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

Referenced by __construct().

    {
        // 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 = array("K" => 1024, "M" => 1024 * 1024, "G" => 1024 * 1024 * 1024);

        $umf_parts = preg_split("/(\d+)([K|G|M])/", $umf, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
        $pms_parts = preg_split("/(\d+)([K|G|M])/", $pms, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);

        if (count($umf_parts) == 2) {
            $umf = $umf_parts[0] * $multiplier_a[$umf_parts[1]];
        }
        if (count($pms_parts) == 2) {
            $pms = $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);
        }
        // Copy of ilFileInputGUI: end

        $this->mail_max_upload_file_size = $max_filesize;
    }

Here is the caller graph for this function:

initDirectory()

ilFileDataMail::initDirectory

(

)

init directory overwritten method public

Returns

string path

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

References ilFileData\getPath(), and MAILPATH.

    {
        if (is_writable($this->getPath())) {
            if (mkdir($this->getPath() . '/' . MAILPATH)) {
                if (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

(

$a_path

)

rotate files with same name recursive method

Parameters

string

filename private

Returns

bool

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

Referenced by storeAsAttachment(), and storeUploadedFile().

    {
        if (file_exists($a_path)) {
            $this->rotateFiles($a_path . ".old");
            return \ilFileUtils::rename($a_path, $a_path . '.old');
        }
        return true;
    }

Here is the caller graph for this function:

saveFile()

ilFileDataMail::saveFile	(		$a_mail_id,
			$a_attachment
	)

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

Parameters

integer	mail id of mail in sent box
array	filenames to save public

Returns

bool

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

Referenced by saveFiles().

    {
        $oStorage = self::getStorage($a_mail_id, $this->user_id);
        $oStorage->create();
        $storage_directory = $oStorage->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	(		$a_mail_id,
		array	$a_attachments
	)

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

Parameters

integer	$a_mail_id	id of mail in sent box
array	$a_attachments	to save

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

References saveFile().

    {
        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	(		$a_filename,
			$a_content
	)

Store content as attachment.

Parameters

object	$a_filename
object	$a_content

Returns

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

References $name, ilUtil\_sanitizeFilemame(), getMailPath(), getUploadLimit(), and rotateFiles().

Referenced by ilSoapUtils\distributeMails().

    {
        if (strlen($a_content) >= $this->getUploadLimit()) {
            return 1;
        }

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

        $abs_path = $this->getMailPath() . '/' . $this->user_id . '_' . $name;
        
        if (!$fp = @fopen($abs_path, 'w+')) {
            return false;
        }
        if (@fwrite($fp, $a_content) === false) {
            @fclose($fp);
            return false;
        }
        @fclose($fp);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

storeUploadedFile()

ilFileDataMail::storeUploadedFile

(

$file

)

Parameters

array

$file

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

References ilUtil\_sanitizeFilemame(), getMailPath(), ilUtil\moveUploadedFile(), and rotateFiles().

    {
        $file['name'] = ilUtil::_sanitizeFilemame($file['name']);

        $this->rotateFiles($this->getMailPath() . '/' . $this->user_id . '_' . $file['name']);

        ilUtil::moveUploadedFile(
            $file['tmp_name'],
            $file['name'],
            $this->getMailPath() . '/' . $this->user_id . '_' . $file['name']
        );
    }

Here is the call graph for this function:

unlinkFile()

ilFileDataMail::unlinkFile

(

$a_filename

)

unlink one uploaded file expects a filename e.g 'foo'

Parameters

string

filename to delete public

Returns

bool

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

Referenced by unlinkFiles().

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

Here is the caller graph for this function:

unlinkFiles()

ilFileDataMail::unlinkFiles

(

$a_filenames

)

unlink files: expects an array of filenames e.g.

array('foo','bar')

Parameters

array

filenames to delete public

Returns

string error message with filename that couldn't be deleted

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

References unlinkFile().

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

Here is the call graph for this function:

Field Documentation

$db

ilFileDataMail::$db

protected

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

$mail_max_upload_file_size

ilFileDataMail::$mail_max_upload_file_size

protected

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

Referenced by getUploadLimit().

$mail_path

ilFileDataMail::$mail_path

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

Referenced by getMailPath().

$storageDirectory

ilFileDataMail::$storageDirectory

protected

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

$tmpDirectory

ilFileDataMail::$tmpDirectory

protected

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

$user_id

ilFileDataMail::$user_id

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

Referenced by _lookupDiskUsageOfUser(), and getUserFilesData().

---

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

• Services/Mail/classes/class.ilFileDataMail.php