This class handles all operations on files for the exercise object. More...

Inheritance diagram for ilFileDataImportMail:

Collaboration diagram for ilFileDataImportMail:

Public Member Functions
	__construct ()
	Constructor call base constructors checks if directory is writable and sets the optional obj_id. More...

	getFiles ()

	getXMLFile ()

	storeUploadedFile ($a_http_post_file)
	store uploaded file in filesystem More...

	findXMLFile ($a_dir='')

	unzip ()

	getPath ()
	get exercise path public More...

	unlinkLast ()

	__readFiles ($a_dir='')

	__checkReadWrite ()
	check if directory is writable overwritten method from base class private More...

Public Member Functions inherited from ilFileDataImport
	__construct ()
	Constructor call base constructors. More...

	getPath ()
	get exercise path public More...

	__checkPath ()

	__checkReadWrite ()
	check if directory is writable overwritten method from base class private More...

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
	_initDirectory ()
	init directory overwritten method public More...

Static Public Member Functions inherited from ilFileDataImport
	_initDirectory ()
	init directory overwritten method public More...

Data Fields
	$mail_path

	$files

	$xml_file

Data Fields inherited from ilFileDataImport
	$import_path

Data Fields inherited from ilFile
	$path

	$ilias

Detailed Description

This class handles all operations on files for the exercise object.

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

Version: $Id

Id: class.ilFileDataImportMail.php,v 1.1 2004/03/31 13:42:19 smeyer Exp

Definition at line 14 of file class.ilFileDataImportMail.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileDataImportMail::__construct ( )

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

Parameters

integereger obj_id public

Definition at line 34 of file class.ilFileDataImportMail.php.

References __readFiles(), and _initDirectory().

     {
         define('MAIL_IMPORT_PATH', 'mail');
         parent::__construct();
         $this->mail_path = parent::getPath() . "/" . MAIL_IMPORT_PATH;
 
         // IF DIRECTORY ISN'T CREATED CREATE IT
         // CALL STTIC TO AVOID OVERWRITE PROBLEMS
         ilFileDataImportMail::_initDirectory();
         $this->__readFiles();
     }

Here is the call graph for this function:

Member Function Documentation

◆ __checkReadWrite()

ilFileDataImportMail::__checkReadWrite ( )

check if directory is writable overwritten method from base class private

Returns: bool

Definition at line 167 of file class.ilFileDataImportMail.php.

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

◆ __readFiles()

ilFileDataImportMail::__readFiles ( $a_dir = '' )

Definition at line 138 of file class.ilFileDataImportMail.php.

References $file, array, files, and getPath().

Referenced by __construct(), findXMLFile(), and storeUploadedFile().

     {
         $a_dir = $a_dir ? $a_dir : $this->getPath();
 
         $this->files = array();
         $dp = opendir($a_dir);
 
         while ($file = readdir($dp)) {
             if ($file == "." or $file == "..") {
                 continue;
             }
             $this->files[] = array(
                 'name'                  => $file,
                 'abs_path'              => $a_dir . "/" . $file,
                 'size'                  => filesize($a_dir . "/" . $file),
                 'ctime'                 => filectime($a_dir . '/' . $file)
             );
         }
         closedir($dp);
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _initDirectory()

ilFileDataImportMail::_initDirectory ( )

static

init directory overwritten method public

Returns: boolean

Definition at line 182 of file class.ilFileDataImportMail.php.

References ilUtil\makeDir().

Referenced by __construct().

     {
         if (!@file_exists($this->mail_path)) {
             ilUtil::makeDir($this->mail_path);
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findXMLFile()

ilFileDataImportMail::findXMLFile ( $a_dir = '' )

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

References $xml_file, __readFiles(), getFiles(), and getPath().

     {
         $a_dir = $a_dir ? $a_dir : $this->getPath();
 
         $this->__readFiles($a_dir);
 
         foreach ($this->getFiles() as $file_data) {
             if (is_dir($file_data["abs_path"])) {
                 $this->findXMLFile($file_data["abs_path"]);
             }
             if (($tmp = explode(".", $file_data["name"])) !== false) {
                 if ($tmp[count($tmp) - 1] == "xml") {
                     return $this->xml_file = $file_data["abs_path"];
                 }
             }
         }
         return $this->xml_file;
     }

Here is the call graph for this function:

◆ getFiles()

ilFileDataImportMail::getFiles ( )

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

References array, and files.

Referenced by findXMLFile(), unlinkLast(), and unzip().

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

Here is the caller graph for this function:

◆ getPath()

ilFileDataImportMail::getPath ( )

get exercise path public

Returns: string path

Definition at line 121 of file class.ilFileDataImportMail.php.

References $mail_path.

Referenced by __readFiles(), findXMLFile(), and storeUploadedFile().

     {
         return $this->mail_path;
     }

Here is the caller graph for this function:

◆ getXMLFile()

ilFileDataImportMail::getXMLFile ( )

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

References $xml_file.

     {
         return $this->xml_file;
     }

◆ storeUploadedFile()

ilFileDataImportMail::storeUploadedFile ( $a_http_post_file )

store uploaded file in filesystem

Parameters

array HTTP_POST_FILES public

Returns: bool

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

References __readFiles(), getPath(), and unlinkLast().

     {
         // TODO:
         // CHECK UPLOAD LIMIT
         //
 
         if (isset($a_http_post_file) && $a_http_post_file['size']) {
             // DELETE OLD FILES
             $this->unlinkLast();
 
             // CHECK IF FILE WITH SAME NAME EXISTS
             ilUtil::moveUploadedFile(
                 $a_http_post_file['tmp_name'],
                 $a_http_post_file['name'],
                 $this->getPath() . '/' . $a_http_post_file['name']
             );
             //move_uploaded_file($a_http_post_file['tmp_name'],$this->getPath().'/'.$a_http_post_file['name']);
 
             // UPDATE FILES LIST
             $this->__readFiles();
             return true;
         } else {
             return false;
         }
     }

Here is the call graph for this function:

◆ unlinkLast()

ilFileDataImportMail::unlinkLast ( )

Definition at line 126 of file class.ilFileDataImportMail.php.

References ilUtil\delDir(), and getFiles().

Referenced by storeUploadedFile().

     {
         foreach ($this->getFiles() as $file_data) {
             if (is_dir($file_data["abs_path"])) {
                 ilUtil::delDir($file_data["abs_path"]);
             } else {
                 unlink($file_data["abs_path"]);
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unzip()

ilFileDataImportMail::unzip ( )

Definition at line 106 of file class.ilFileDataImportMail.php.

References getFiles(), and ilUtil\unzip().

     {
         foreach ($this->getFiles() as $file_data) {
             ilUtil::unzip($file_data["abs_path"]);
             
             return true;
         }
         return false;
     }