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

Inheritance diagram for ilFileDataForum:

Collaboration diagram for ilFileDataForum:

Public Member Functions
	__construct ($a_obj_id=0, $a_pos_id=0)
	Constructor call base constructors checks if directory is writable and sets the optional obj_id. More...

	getObjId ()

	getPosId ()

	setPosId ($a_id)

	getForumPath ()
	get forum path public More...

	getFilesOfPost ()

	ilClone ($a_new_obj_id, $a_new_pos_id)

	delete ()

	storeUploadedFile ($files)
	Store uploaded files in filesystem. 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...

	getAbsolutePath ($a_path)
	get absolute path of filename More...

	getFileDataByMD5Filename ($a_md5_filename)
	get file data of a specific attachment More...

	unlinkFilesByMD5Filenames ($a_md5_filename)
	get file data of a specific attachment More...

	checkFilesExist ($a_files)
	check if files exist More...

	__checkPath ()

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

	__initDirectory ()
	init directory overwritten method public More...

	__rotateFiles ($a_path)
	rotate files with same name recursive method More...

	deliverFile ($file)

	deliverZipFile ()

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...

Data Fields
	$obj_id

	$pos_id

	$forum_path

Data Fields inherited from ilFile
	$path

	$ilias

Protected Member Functions
	createZipFile ()

Private Attributes
	$error

Detailed Description

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

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

Version: $Id$

Definition at line 12 of file class.ilFileDataForum.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileDataForum::__construct	(	$a_obj_id = `0`,
		$a_pos_id = `0`
	)

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

Parameters

integereger obj_id public

Definition at line 38 of file class.ilFileDataForum.php.

References $DIC, __checkPath(), ILIAS\GlobalScreen\Provider\__construct(), and __initDirectory().

     {
         global $DIC;
         $this->error = $DIC['ilErr'];
         
         define('FORUM_PATH', 'forum');
         parent::__construct();
         $this->forum_path = parent::getPath() . "/" . FORUM_PATH;
         
         // IF DIRECTORY ISN'T CREATED CREATE IT
         if (!$this->__checkPath()) {
             $this->__initDirectory();
         }
         $this->obj_id = $a_obj_id;
         $this->pos_id = $a_pos_id;
     }

Here is the call graph for this function:

Member Function Documentation

◆ __checkPath()

ilFileDataForum::__checkPath ( )

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

References __checkReadWrite(), and getForumPath().

Referenced by __construct().

     {
         if (!@file_exists($this->getForumPath())) {
             return false;
         }
         $this->__checkReadWrite();
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkReadWrite()

ilFileDataForum::__checkReadWrite ( )

check if directory is writable overwritten method from base class private

Returns: bool

Definition at line 356 of file class.ilFileDataForum.php.

Referenced by __checkPath().

     {
         if (is_writable($this->forum_path) && is_readable($this->forum_path)) {
             return true;
         } else {
             $this->error->raiseError("Forum directory is not readable/writable by webserver", $this->error->FATAL);
         }
     }

Here is the caller graph for this function:

◆ __initDirectory()

ilFileDataForum::__initDirectory ( )

init directory overwritten method public

Returns: string path

Definition at line 370 of file class.ilFileDataForum.php.

References ilFileData\getPath().

Referenced by __construct().

     {
         if (is_writable($this->getPath())) {
             if (mkdir($this->getPath() . '/' . FORUM_PATH)) {
                 if (chmod($this->getPath() . '/' . FORUM_PATH, 0755)) {
                     $this->forum_path = $this->getPath() . '/' . FORUM_PATH;
                     return true;
                 }
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __rotateFiles()

ilFileDataForum::__rotateFiles ( $a_path )

rotate files with same name recursive method

Parameters

string filename private

Returns: bool

Definition at line 389 of file class.ilFileDataForum.php.

Referenced by 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:

◆ checkFilesExist()

ilFileDataForum::checkFilesExist ( $a_files )

check if files exist

Parameters

array filenames to check public

Returns: bool

Definition at line 327 of file class.ilFileDataForum.php.

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

◆ createZipFile()

ilFileDataForum::createZipFile ( )

protected

Returns: null|string

Definition at line 433 of file class.ilFileDataForum.php.

References getFilesOfPost(), getForumPath(), getObjId(), getPosId(), ilUtil\makeDirParents(), and ilUtil\zip().

Referenced by deliverZipFile().

     {
         $filesOfPost = $this->getFilesOfPost();
         ksort($filesOfPost);
 
         ilUtil::makeDirParents($this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId());
         $tmp_dir = $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId();
         foreach ($filesOfPost as $file) {
             @copy($file['path'], $tmp_dir . '/' . $file['name']);
         }
 
         $zip_file = null;
         if (ilUtil::zip($tmp_dir, $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId() . '.zip')) {
             $zip_file = $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId() . '.zip';
         }
 
         return $zip_file;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilFileDataForum::delete ( )

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

References getForumPath(), and getObjId().

Referenced by ilObjForumGUI\publishDraftObject().

     {
         foreach ($this->getFiles() as $file) {
             if (file_exists($this->getForumPath() . "/" . $this->getObjId() . "_" . $file["name"])) {
                 unlink($this->getForumPath() . "/" . $this->getObjId() . "_" . $file["name"]);
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverFile()

ilFileDataForum::deliverFile ( $file )

Parameters

$file

Returns: bool|void

Definition at line 402 of file class.ilFileDataForum.php.

References ilFile\$path, ilUtil\deliverFile(), getFileDataByMD5Filename(), and ilUtil\sendFailure().

     {
         if (!$path = $this->getFileDataByMD5Filename($file)) {
             return ilUtil::sendFailure($this->lng->txt('error_reading_file'), true);
         } else {
             return ilUtil::deliverFile($path['path'], $path['clean_filename']);
         }
     }

Here is the call graph for this function:

◆ deliverZipFile()

ilFileDataForum::deliverZipFile ( )

Definition at line 414 of file class.ilFileDataForum.php.

References $DIC, createZipFile(), ilUtil\delDir(), ilUtil\deliverFile(), getForumPath(), getObjId(), getPosId(), and ilUtil\sendFailure().

     {
         global $DIC;
         
         $zip_file = $this->createZipFile();
         if (!$zip_file) {
             ilUtil::sendFailure($DIC->language()->txt('error_reading_file'), true);
             return false;
         } else {
             $post = new ilForumPost($this->getPosId());
             ilUtil::deliverFile($zip_file, $post->getSubject() . '.zip', '', false, true, false);
             ilUtil::delDir($this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId());
             $DIC->http()->close();
         }
     }

Here is the call graph for this function:

◆ getAbsolutePath()

ilFileDataForum::getAbsolutePath ( $a_path )

get absolute path of filename

Parameters

string relative path public

Returns: string absolute path

Definition at line 266 of file class.ilFileDataForum.php.

     {
         return $this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . "_" . $a_path;
     }

◆ getFileDataByMD5Filename()

ilFileDataForum::getFileDataByMD5Filename ( $a_md5_filename )

get file data of a specific attachment

Parameters

string md5 encrypted filename public

Returns: array filedata

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

References ilUtil\getDir().

Referenced by deliverFile().

     {
         $files = ilUtil::getDir($this->forum_path);
         foreach ((array) $files as $file) {
             if ($file['type'] == 'file' && md5($file['entry']) == $a_md5_filename) {
                 return array(
                     'path' => $this->forum_path . '/' . $file['entry'],
                     'filename' => $file['entry'],
                     'clean_filename' => str_replace($this->obj_id . '_' . $this->pos_id . '_', '', $file['entry'])
                 );
             }
         }
         
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilesOfPost()

ilFileDataForum::getFilesOfPost ( )

Returns: array

Definition at line 110 of file class.ilFileDataForum.php.

References $obj_id, $pos_id, $rest, getPosId(), and ilFileUtils\rename().

Referenced by createZipFile(), ilClone(), ilObjForumNotificationDataProvider\readAttachments(), and ilObjForumGUI\renderPostContent().

     {
         $directoryIterator = new DirectoryIterator($this->forum_path);
         $filterIterator = new RegexIterator($directoryIterator, "/^{$this->obj_id}_{$this->getPosId()}_(.+)$/");
 
         $files = array();
         foreach ($filterIterator as $file) {
             if ($file->isFile()) {
                 list($obj_id, $pos_id, $rest) = explode('_', $file->getFilename(), 3);
                 $files[$rest] = array(
                     'path' => $file->getPathname(),
                     'md5' => md5($this->obj_id . '_' . $this->pos_id . '_' . $rest),
                     'name' => $rest,
                     'size' => $file->getSize(),
                     'ctime' => date('Y-m-d H:i:s', $file->getCTime())
                 );
             }
         }
 
         return $files;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getForumPath()

ilFileDataForum::getForumPath ( )

get forum path public

Returns: string path

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

References $forum_path, $obj_id, and $rest.

Referenced by __checkPath(), createZipFile(), delete(), deliverZipFile(), ilForumXMLParser\handlerEndTag(), ilClone(), and storeUploadedFile().

     {
         return $this->forum_path;
     }

Here is the caller graph for this function:

◆ getObjId()

ilFileDataForum::getObjId ( )

Definition at line 55 of file class.ilFileDataForum.php.

References $obj_id.

Referenced by createZipFile(), delete(), and deliverZipFile().

     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getPosId()

ilFileDataForum::getPosId ( )

Definition at line 59 of file class.ilFileDataForum.php.

References $pos_id.

Referenced by createZipFile(), deliverZipFile(), and getFilesOfPost().

     {
         return $this->pos_id;
     }

Here is the caller graph for this function:

◆ ilClone()

ilFileDataForum::ilClone	(	$a_new_obj_id,
		$a_new_pos_id
	)

Definition at line 165 of file class.ilFileDataForum.php.

References getFilesOfPost(), and getForumPath().

     {
         foreach ($this->getFilesOfPost() as $file) {
             @copy(
                 $this->getForumPath() . "/" . $this->obj_id . "_" . $this->pos_id . "_" . $file["name"],
                 $this->getForumPath() . "/" . $a_new_obj_id . "_" . $a_new_pos_id . "_" . $file["name"]
             );
         }
         return true;
     }

Here is the call graph for this function:

◆ setPosId()

ilFileDataForum::setPosId ( $a_id )

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

     {
         $this->pos_id = $a_id;
     }

◆ storeUploadedFile()

ilFileDataForum::storeUploadedFile ( $files )

Store uploaded files in filesystem.

Parameters

array $files Copy of $_FILES array, public

Returns: bool

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

References $error, $filename, $index, $name, ilFile\$path, __rotateFiles(), ilUtil\_sanitizeFilemame(), getForumPath(), and ilUtil\moveUploadedFile().

Referenced by ilObjForumGUI\publishDraftObject().

     {
         if (isset($files['name']) && is_array($files['name'])) {
             foreach ($files['name'] as $index => $name) {
                 // remove trailing '/'
                 $name = rtrim($name, '/');
 
                 $filename = ilUtil::_sanitizeFilemame($name);
                 $temp_name = $files['tmp_name'][$index];
                 $error = $files['error'][$index];
                 
                 if (strlen($filename) && strlen($temp_name) && $error == 0) {
                     $path = $this->getForumPath() . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $filename;
                     
                     $this->__rotateFiles($path);
                     ilUtil::moveUploadedFile($temp_name, $filename, $path);
                 }
             }
             
             return true;
         } elseif (isset($files['name']) && is_string($files['name'])) {
             // remove trailing '/'
             $files['name'] = rtrim($files['name'], '/');
                 
             $filename = ilUtil::_sanitizeFilemame($files['name']);
             $temp_name = $files['tmp_name'];
             
             $path = $this->getForumPath() . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $filename;
             
             $this->__rotateFiles($path);
             ilUtil::moveUploadedFile($temp_name, $filename, $path);
             
             return true;
         }
         
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unlinkFile()

ilFileDataForum::unlinkFile ( $a_filename )

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

Parameters

string filename to delete public

Returns: bool

Definition at line 254 of file class.ilFileDataForum.php.

Referenced by unlinkFiles().

     {
         if (file_exists($this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $a_filename)) {
             return unlink($this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . "_" . $a_filename);
         }
     }

Here is the caller graph for this function:

◆ unlinkFiles()

ilFileDataForum::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 237 of file class.ilFileDataForum.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:

◆ unlinkFilesByMD5Filenames()

ilFileDataForum::unlinkFilesByMD5Filenames ( $a_md5_filename )

get file data of a specific attachment

Parameters

string|array md5 encrypted filename or array of multiple md5 encrypted files public

Returns: boolean status

Definition at line 299 of file class.ilFileDataForum.php.

References ilUtil\getDir().

     {
         $files = ilUtil::getDir($this->forum_path);
         if (is_array($a_md5_filename)) {
             foreach ((array) $files as $file) {
                 if ($file['type'] == 'file' && in_array(md5($file['entry']), $a_md5_filename)) {
                     unlink($this->forum_path . '/' . $file['entry']);
                 }
             }
             
             return true;
         } else {
             foreach ((array) $files as $file) {
                 if ($file['type'] == 'file' && md5($file['entry']) == $a_md5_filename) {
                     return unlink($this->forum_path . '/' . $file['entry']);
                 }
             }
         }
         
         return false;
     }

Here is the call graph for this function:

Field Documentation

◆ $error

ilFileDataForum::$error

private

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

Referenced by storeUploadedFile().

◆ $forum_path

ilFileDataForum::$forum_path

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

Referenced by getForumPath().

◆ $obj_id

ilFileDataForum::$obj_id

Definition at line 19 of file class.ilFileDataForum.php.

Referenced by getFilesOfPost(), getForumPath(), and getObjId().

◆ $pos_id

ilFileDataForum::$pos_id

Definition at line 20 of file class.ilFileDataForum.php.

Referenced by getFilesOfPost(), and getPosId().

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

Modules/Forum/classes/class.ilFileDataForum.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __checkPath()

◆ __checkReadWrite()

◆ __initDirectory()

◆ __rotateFiles()

◆ checkFilesExist()

◆ createZipFile()

◆ delete()

◆ deliverFile()

◆ deliverZipFile()

◆ getAbsolutePath()

◆ getFileDataByMD5Filename()

◆ getFilesOfPost()

◆ getForumPath()

◆ getObjId()

◆ getPosId()

◆ ilClone()

◆ setPosId()

◆ storeUploadedFile()

◆ unlinkFile()

◆ unlinkFiles()

◆ unlinkFilesByMD5Filenames()

Field Documentation

◆ $error

◆ $forum_path

◆ $obj_id

◆ $pos_id