This class handles all operations on files (attachments) in directory ilias_data/mail. 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.
	initDirectory ()
	init directory overwritten method public
	getUploadLimit ()
	getAttachmentsTotalSizeLimit ()
	getMailPath ()
	get mail path public
	getAttachmentPathByMD5Filename ($a_filename, $a_mail_id)
	get the path of a specific attachment
	getAttachmentPath ($a_filename, $a_mail_id)
	get the path of a specific attachment
	adoptAttachments ($a_attachments, $a_mail_id)
	adopt attachments (in case of forwarding a mail)
	checkReadWrite ()
	check if directory is writable overwritten method from base class private
	getUserFilesData ()
	get all attachments of a specific user public
	getUnsentFiles ()
	get all files which are not sent find them in directory data/mail/ private
	storeAsAttachment ($a_filename, $a_content)
	Store content as attachment.
	storeUploadedFile ($file)
	copyAttachmentFile ($a_abs_path, $a_new_name)
	Copy files in mail directory.
	rotateFiles ($a_path)
	rotate files with same name recursive method
	unlinkFiles ($a_filenames)
	unlink files: expects an array of filenames e.g.
	unlinkFile ($a_filename)
	unlink one uploaded file expects a filename e.g 'foo'
	getAbsolutePath ($a_path)
	get absolute path of filename
	saveFiles ($a_mail_id, $a_attachments)
	save all attachment files in a specific mail directory .../mail/<calculated_path>/mail_<mail_id>_<user_id>/...
	saveFile ($a_mail_id, $a_attachment)
	save attachment file in a specific mail directory .../mail/<calculated_path>/mail_<mail_id>_<user_id>/...
	checkFilesExist ($a_files)
	check if files exist
	assignAttachmentsToDirectory ($a_mail_id, $a_sent_mail_id)
	assign attachments to mail directory
	deassignAttachmentFromDirectory ($a_mail_id)
	dassign attachments from mail directory
	__deleteAttachmentDirectory ($a_rel_path)
	_lookupDiskUsageOfUser ($user_id)
	Returns the number of bytes used on the harddisk for mail attachments, by the user with the specified user id.
Public Member Functions inherited from ilFileData
	ilFileData ()
	Constructor class bas constructor and read path of directory from ilias.ini setup an mail object public.
	checkPath ($a_path)
	check if path exists and is writable
	getPath ()
	get Path public
Public Member Functions inherited from ilFile
	ilFile ()
	Constructor get ilias object public.
	deleteTrailingSlash ($a_path)
	delete trailing slash of path variables

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

Data Fields
	$user_id
	$mail_path

Protected Member Functions
	initAttachmentMaxUploadSize ()

Protected Attributes
	$mail_max_upload_file_size

Detailed Description

This class handles all operations on files (attachments) in directory ilias_data/mail.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id:: class.ilFileDataMail.php 54854 2014-11-06 09:45:01Z mjansen

Class ilFileDataMail

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

Constructor & Destructor Documentation

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

References checkReadWrite(), ilFileData\getPath(), and initAttachmentMaxUploadSize().

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

Here is the call graph for this function:

Member Function Documentation

ilFileDataMail::__deleteAttachmentDirectory ( $a_rel_path )

Definition at line 548 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:

ilFileDataMail::_lookupDiskUsageOfUser ( $user_id )

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

References $lng, $row, $size, $user_id, DB_FETCHMODE_ASSOC, ilUtil\dirsize(), and ilUtil\getDataDir().

        {
                // 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 $ilDB, $lng;
                $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 = ".$ilDB->quote($user_id);
                $result_set = $ilDB->query($q);
                $size = 0;
                $count = 0;
                while($row = $result_set->fetchRow(DB_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:

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

References $file, 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:

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

References $res, and getStorage().

        {
                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())
                ); 
                                
        }

Here is the call graph for this function:

ilFileDataMail::checkFilesExist ( $a_files )

check if files exist

Parameters

array filenames to check public

Returns: bool

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

References $file.

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

ilFileDataMail::checkReadWrite ( )

check if directory is writable overwritten method from base class private

Returns: bool

Definition at line 221 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:

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 329 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:

ilFileDataMail::deassignAttachmentFromDirectory ( $a_mail_id )

dassign attachments from mail directory

Parameters

integer mail_id public

Returns: bool

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

References ilFile\$path, $res, $row, __deleteAttachmentDirectory(), and DB_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(DB_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(DB_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:

ilFileDataMail::getAbsolutePath ( $a_path )

get absolute path of filename

Parameters

string relative path public

Returns: string absolute path

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

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

ilFileDataMail::getAttachmentPath	(	$a_filename,
		$a_mail_id
	)

get the path of a specific attachment

Parameters

string	filename
integer	mail_id public

Returns: string path

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

References ilFile\$path, $query, $row, and getMailPath().

Referenced by adoptAttachments().

        {
                global $ilDB;
                
/*              $query = "SELECT path FROM mail_attachment ".
                        "WHERE mail_id = ".$ilDB->quote($a_mail_id)."";
                
                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);
                $path = $this->getMailPath().'/'.$row->path.'/'.$a_filename;
*/
                $query = $ilDB->query("SELECT path FROM mail_attachment ".
                        "WHERE mail_id = ".$ilDB->quote($a_mail_id, 'integer')."");
                while($row = $ilDB->fetchObject($query))
                {
                        $path = $this->getMailPath().'/'.$row->path.'/'.$a_filename;                    
                }
                        
                if(file_exists($path))
                {
                        if(is_readable($path))
                        {
                                return $path;
                        }
                        return '';
                }
                return '';
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilFileDataMail::getAttachmentPathByMD5Filename	(	$a_filename,
		$a_mail_id
	)

get the path of a specific attachment

Parameters

string	md5 encrypted filename
integer	mail_id public

Returns: string path

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

References $file, ilFile\$path, $query, $row, ilUtil\getDir(), and getMailPath().

        {
                global $ilDB;
                
/*              $query = "SELECT path FROM mail_attachment ".
                        "WHERE mail_id = ".$ilDB->quote($a_mail_id)."";
                
                $row = $this->ilias->db->getRow($query,DB_FETCHMODE_OBJECT);
                $path = $this->getMailPath().'/'.$row->path;
*/
                $query = $ilDB->query("SELECT path FROM mail_attachment 
                                  WHERE mail_id = ".$ilDB->quote($a_mail_id,'integer')."");
                
                $rel_path = "";
                while($row = $ilDB->fetchObject($query))
                {
                        $rel_path = $row->path;
                        $path = $this->getMailPath().'/'.$row->path;
                }
                $files = ilUtil::getDir($path);
                foreach((array)$files as $file)
                {
                        if($file['type'] == 'file' && md5($file['entry']) == $a_filename)
                        {
                                return array(
                                        'path' => $this->getMailPath().'/'.$rel_path.'/'.$file['entry'],
                                        'filename' => $file['entry']
                                );
                        }
                }
                return '';
        }

Here is the call graph for this function:

ilFileDataMail::getAttachmentsTotalSizeLimit ( )

Returns: float|null

Definition at line 89 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;
        }

ilFileDataMail::getMailPath ( )

get mail path public

Returns: string path

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

References $mail_path.

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

        {
                return $this->mail_path;
        }

Here is the caller graph for this function:

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

static

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

Referenced by assignAttachmentsToDirectory(), and saveFile().

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

Here is the caller graph for this function:

ilFileDataMail::getUnsentFiles ( )

get all files which are not sent find them in directory data/mail/ private

Returns: array

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

References $file, and $rest.

Referenced by getUserFilesData().

        {
                $files = array();
                $dp = opendir($this->mail_path);
                while($file = readdir($dp))
                {
                        if(is_dir($file))
                        {
                                continue;
                        }
                        list($uid,$rest) = explode('_',$file,2);
                        if($uid == $this->user_id)
                        {
                                if(!is_dir($this->mail_path.'/'.$file))
                                {
                                        $files[] = array(
                                                'name'     => $rest,
                                                'size'     => filesize($this->mail_path.'/'.$file),
                                                'ctime'    => filectime($this->mail_path.'/'.$file)
                                        );
                                }
                        }
                }
                closedir($dp);
                return $files;
        }

Here is the caller graph for this function:

ilFileDataMail::getUploadLimit ( )

Returns: int

Definition at line 81 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:

ilFileDataMail::getUserFilesData ( )

get all attachments of a specific user public

Returns: array

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

References getUnsentFiles().

        {
                return $files = $this->getUnsentFiles();
        }

Here is the call graph for this function:

ilFileDataMail::initAttachmentMaxUploadSize ( )

protected

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

Definition at line 558 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:

ilFileDataMail::initDirectory ( )

init directory overwritten method public

Returns: string path

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

References ilFileData\getPath().

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

ilFileDataMail::rotateFiles ( $a_path )

rotate files with same name recursive method

Parameters

string filename private

Returns: bool

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

Referenced by storeAsAttachment(), and storeUploadedFile().

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

Here is the caller graph for this function:

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

References getStorage().

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 call graph for this function:

Here is the caller graph for this function:

ilFileDataMail::saveFiles	(	$a_mail_id,
		$a_attachments
	)

save all attachment files 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: string error message

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

References saveFile().

        {
                if(!$a_mail_id)
                {
                        return "INTERNAL HERE ERROR: No valid mail_id given";
                }
                if(is_array($a_attachments))
                {
                        foreach($a_attachments as $attachment)
                        {
                                if(!$this->saveFile($a_mail_id,$attachment))
                                {
                                        return $attachment;
                                }
                        }
                }
                else
                {
                        return "ARRAY REQUIRED";
                }
                return '';
        }

Here is the call graph for this function:

ilFileDataMail::storeAsAttachment	(	$a_filename,
		$a_content
	)

Store content as attachment.

Parameters

object	$a_filename
object	$a_content

Returns

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

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

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

ilFileDataMail::storeUploadedFile ( $file )

Parameters

array $file

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

References $file, 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:

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 380 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:

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

References $file, and unlinkFile().

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