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

Inheritance diagram for ilFileDataForumDrafts:

Collaboration diagram for ilFileDataForumDrafts:

Public Member Functions
	__construct ($obj_id=0, $draft_id)

	getObjId ()

	setObjId ($obj_id)

	getDraftId ()

	setDraftId ($draft_id)

	getDraftsPath ()

	moveFilesOfDraft ($forum_path, $new_post_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 ()

	createZipFile ()

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

Protected Attributes
	$obj_id = 0

	$draft_id = 0

	$drafts_path = ''

Private Attributes
	$lng

	$error

Additional Inherited Members
Data Fields inherited from ilFile
	$path

	$ilias

Detailed Description

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

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 11 of file class.ilFileDataForumDrafts.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileDataForumDrafts::__construct	(	$obj_id = `0`,
		$draft_id
	)

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

References $DIC, $draft_id, $obj_id, __checkPath(), and __initDirectory().

     {
         global $DIC;
         $this->lng = $DIC->language();
         $this->error = $DIC['ilErr'];
         
         $this->obj_id = $obj_id;
         $this->draft_id = $draft_id;
         
         define('FORUM_DRAFTS_PATH', 'forum/drafts');
         parent::__construct();
         $this->drafts_path = parent::getPath() . "/" . FORUM_DRAFTS_PATH;
         
         // IF DIRECTORY ISN'T CREATED CREATE IT
         if (!$this->__checkPath()) {
             $this->__initDirectory();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ __checkPath()

ilFileDataForumDrafts::__checkPath ( )

Definition at line 313 of file class.ilFileDataForumDrafts.php.

References __checkReadWrite(), getDraftId(), and getDraftsPath().

Referenced by __construct().

     {
         if (!@file_exists($this->getDraftsPath() . '/' . $this->getDraftId())) {
             return false;
         }
         $this->__checkReadWrite();
         
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __checkReadWrite()

ilFileDataForumDrafts::__checkReadWrite ( )

check if directory is writable overwritten method from base class private

Returns: bool

Definition at line 328 of file class.ilFileDataForumDrafts.php.

References getDraftId(), and getDraftsPath().

Referenced by __checkPath().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __initDirectory()

ilFileDataForumDrafts::__initDirectory ( )

init directory overwritten method public

Returns: string path

Definition at line 342 of file class.ilFileDataForumDrafts.php.

References getDraftId(), getDraftsPath(), ilFileData\getPath(), and ilUtil\makeDirParents().

Referenced by __construct().

     {
         if (is_writable($this->getPath())) {
             if (ilUtil::makeDirParents($this->getDraftsPath() . "/" . $this->getDraftId())) {
                 if (chmod($this->getDraftsPath() . "/" . $this->getDraftId(), 0755)) {
                     return true;
                 }
             }
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __rotateFiles()

ilFileDataForumDrafts::__rotateFiles ( $a_path )

rotate files with same name recursive method

Parameters

string filename private

Returns: bool

Definition at line 360 of file class.ilFileDataForumDrafts.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()

ilFileDataForumDrafts::checkFilesExist ( $a_files )

check if files exist

Parameters

array filenames to check public

Returns: bool

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

References getDraftId(), and getDraftsPath().

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

Here is the call graph for this function:

◆ createZipFile()

ilFileDataForumDrafts::createZipFile ( )

Returns: null|string

Definition at line 399 of file class.ilFileDataForumDrafts.php.

References getDraftId(), getDraftsPath(), ilUtil\makeDirParents(), and ilUtil\zip().

Referenced by deliverZipFile().

     {
         $filesOfDraft = $this->getFilesOfPost();
         if (count($filesOfDraft)) {
             ksort($filesOfDraft);
 
             ilUtil::makeDirParents($this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId());
             $tmp_dir = $this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId();
             foreach ($filesOfDraft as $file) {
                 @copy($file['path'], $tmp_dir . '/' . $file['name']);
             }
         }
 
         $zip_file = null;
         if (ilUtil::zip($tmp_dir, $this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId() . '.zip')) {
             $zip_file = $this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId() . '.zip';
         }
 
         return $zip_file;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilFileDataForumDrafts::delete ( )

Returns: bool

Definition at line 149 of file class.ilFileDataForumDrafts.php.

References ilUtil\delDir(), getDraftId(), and getDraftsPath().

Referenced by ilObjForumGUI\deleteSelectedDraft().

     {
         ilUtil::delDir($this->getDraftsPath() . '/' . $this->getDraftId());
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverFile()

ilFileDataForumDrafts::deliverFile ( $file )

Parameters

$file $_GET['file']

Returns: bool|void

Definition at line 373 of file class.ilFileDataForumDrafts.php.

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

Referenced by ilObjForumGUI\getForumObjects().

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

Here is the caller graph for this function:

◆ deliverZipFile()

ilFileDataForumDrafts::deliverZipFile ( )

Definition at line 382 of file class.ilFileDataForumDrafts.php.

References $post, createZipFile(), ilUtil\delDir(), ilUtil\deliverFile(), exit, getDraftId(), getDraftsPath(), ilForumPostDraft\newInstanceByDraftId(), and ilUtil\sendFailure().

     {
         $zip_file = $this->createZipFile();
         if (!$zip_file) {
             ilUtil::sendFailure($this->lng->txt('error_reading_file'), true);
             return false;
         } else {
             $post = ilForumPostDraft::newInstanceByDraftId($this->getDraftId());
             ilUtil::deliverFile($zip_file, $post->getPostSubject() . '.zip', '', false, true, false);
             ilUtil::delDir($this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId());
             exit();
         }
     }

Here is the call graph for this function:

◆ getAbsolutePath()

ilFileDataForumDrafts::getAbsolutePath ( $a_path )

get absolute path of filename

Parameters

string relative path public

Returns: string absolute path

Definition at line 238 of file class.ilFileDataForumDrafts.php.

References getDraftId(), and getDraftsPath().

     {
         return $this->getDraftsPath() . '/' . $this->getDraftId();
     }

Here is the call graph for this function:

◆ getDraftId()

ilFileDataForumDrafts::getDraftId ( )

Returns: int

Definition at line 57 of file class.ilFileDataForumDrafts.php.

References $draft_id.

Referenced by __checkPath(), __checkReadWrite(), __initDirectory(), checkFilesExist(), createZipFile(), delete(), deliverZipFile(), getAbsolutePath(), getDraftsPath(), getFileDataByMD5Filename(), storeUploadedFile(), unlinkFile(), and unlinkFilesByMD5Filenames().

     {
         return $this->draft_id;
     }

Here is the caller graph for this function:

◆ getDraftsPath()

ilFileDataForumDrafts::getDraftsPath ( )

Returns: string

Definition at line 73 of file class.ilFileDataForumDrafts.php.

References $drafts_path, $files, and getDraftId().

Referenced by __checkPath(), __checkReadWrite(), __initDirectory(), checkFilesExist(), createZipFile(), delete(), deliverZipFile(), getAbsolutePath(), getFileDataByMD5Filename(), storeUploadedFile(), unlinkFile(), and unlinkFilesByMD5Filenames().

     {
         return $this->drafts_path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileDataByMD5Filename()

ilFileDataForumDrafts::getFileDataByMD5Filename ( $a_md5_filename )

get file data of a specific attachment

Parameters

string md5 encrypted filename public

Returns: array filedata

Definition at line 249 of file class.ilFileDataForumDrafts.php.

References $files, ilUtil\getDir(), getDraftId(), and getDraftsPath().

Referenced by deliverFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilFileDataForumDrafts::getObjId ( )

Returns: int

Definition at line 41 of file class.ilFileDataForumDrafts.php.

References $obj_id.

     {
         return $this->obj_id;
     }

◆ moveFilesOfDraft()

ilFileDataForumDrafts::moveFilesOfDraft	(	$forum_path,
		$new_post_id
	)

Definition at line 135 of file class.ilFileDataForumDrafts.php.

     {
         foreach ($this->getFilesOfPost() as $file) {
             @copy(
                 $file['path'],
                 $forum_path . '/' . $this->obj_id . '_' . $new_post_id . '_' . $file['name']
             );
         }
         return true;
     }

◆ setDraftId()

ilFileDataForumDrafts::setDraftId ( $draft_id )

Parameters

int $draft_id

Definition at line 65 of file class.ilFileDataForumDrafts.php.

References $draft_id.

     {
         $this->draft_id = $draft_id;
     }

◆ setObjId()

ilFileDataForumDrafts::setObjId ( $obj_id )

Parameters

int $obj_id

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

References $obj_id.

     {
         $this->obj_id = $obj_id;
     }

◆ storeUploadedFile()

ilFileDataForumDrafts::storeUploadedFile ( $files )

Store uploaded files in filesystem.

Parameters

array $files Copy of $_FILES array, public

Returns: bool

Definition at line 164 of file class.ilFileDataForumDrafts.php.

References $error, $filename, $files, $index, $name, ilFile\$path, __rotateFiles(), ilUtil\_sanitizeFilemame(), getDraftId(), and getDraftsPath().

Referenced by ilObjForumGUI\updateThreadDraftObject().

     {
         if (isset($files['name']) && is_array($files['name'])) {
             foreach ($files['name'] as $index => $name) {
                 // remove trailing '/'
                 while (substr($name, -1) == '/') {
                     $name = substr($name, 0, -1);
                 }
                 $filename = ilUtil::_sanitizeFilemame($name);
                 $temp_name = $files['tmp_name'][$index];
                 $error = $files['error'][$index];
                 
                 if (strlen($filename) && strlen($temp_name) && $error == 0) {
                     $path = $this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $filename;
                     
                     $this->__rotateFiles($path);
                     ilUtil::moveUploadedFile($temp_name, $filename, $path);
                 }
             }
             
             return true;
         } elseif (isset($files['name']) && is_string($files['name'])) {
             // remove trailing '/'
             while (substr($files['name'], -1) == '/') {
                 $files['name'] = substr($files['name'], 0, -1);
             }
             $filename = ilUtil::_sanitizeFilemame($files['name']);
             $temp_name = $files['tmp_name'];
             
             $path = $this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $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()

ilFileDataForumDrafts::unlinkFile ( $a_filename )

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

Parameters

string filename to delete public

Returns: bool

Definition at line 226 of file class.ilFileDataForumDrafts.php.

References getDraftId(), and getDraftsPath().

Referenced by unlinkFiles().

     {
         if (file_exists($this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $a_filename)) {
             return unlink($this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $a_filename);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unlinkFiles()

ilFileDataForumDrafts::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 209 of file class.ilFileDataForumDrafts.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()

ilFileDataForumDrafts::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 271 of file class.ilFileDataForumDrafts.php.

References $files, ilUtil\getDir(), getDraftId(), and getDraftsPath().

Referenced by ilObjForumGUI\editDraftObject().

     {
         $files = ilUtil::getDir($this->getDraftsPath() . '/' . $this->getDraftId());
         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->getDraftsPath() . '/' . $this->getDraftId() . '/' . $file['entry']);
                 }
             }
             
             return true;
         } else {
             foreach ((array) $files as $file) {
                 if ($file['type'] == 'file' && md5($file['entry']) == $a_md5_filename) {
                     return unlink($this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $file['entry']);
                 }
             }
         }
         
         return false;
     }