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 (int $obj_id, int $draft_id)

	getObjId ()

	setObjId (int $obj_id)

	getDraftId ()

	setDraftId (int $draft_id)

	getDraftsPath ()

	moveFilesOfDraft (string $forum_path, int $new_post_id)

	delete ()

	storeUploadedFile (array $files)

	unlinkFile (string $a_filename)

	getFileDataByMD5Filename (string $hashedFilename)

	unlinkFilesByMD5Filenames ($hashedFilenameOrFilenames)

	checkForumDraftsPath ()

	deliverFile (string $file)

	deliverZipFile ()

	createZipFile ()

Public Member Functions inherited from ilFileData
	__construct ()

	checkPath (string $a_path)

	getPath ()

Public Member Functions inherited from ilFile
	deleteTrailingSlash (string $a_path)
	delete trailing slash of path variables More...

Private Member Functions
	checkReadWrite ()

	initDirectory ()

	rotateFiles (string $a_path)

Private Attributes
int	$obj_id

int	$draft_id

string	$drafts_path

ilLanguage	$lng

ilErrorHandling	$error

ilGlobalTemplateInterface	$main_tpl

Additional Inherited Members
Protected Attributes inherited from ilFile
string	$path

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

Constructor & Destructor Documentation

◆ __construct()

ilFileDataForumDrafts::__construct	(	int	$obj_id,
		int	$draft_id
	)

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

References $DIC, $draft_id, $obj_id, ILIAS\GlobalScreen\Provider\__construct(), checkForumDraftsPath(), ilFileData\getPath(), initDirectory(), and ILIAS\Repository\lng().

     {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
 
         $this->lng = $DIC->language();
         $this->error = $DIC['ilErr'];
 
         $this->obj_id = $obj_id;
         $this->draft_id = $draft_id;
 
         parent::__construct();
         $this->drafts_path = $this->getPath() . '/forum/drafts';
 
         if (!$this->checkForumDraftsPath()) {
             $this->initDirectory();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ checkForumDraftsPath()

ilFileDataForumDrafts::checkForumDraftsPath ( )

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

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

Referenced by __construct().

                                           : bool
     {
         if (!is_dir($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 ( )

private

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

References getDraftId(), and getDraftsPath().

Referenced by checkForumDraftsPath().

                                      : void
     {
         if (
             !is_writable($this->getDraftsPath() . '/' . $this->getDraftId()) ||
             !is_readable($this->getDraftsPath() . '/' . $this->getDraftId())
         ) {
             $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:

◆ createZipFile()

ilFileDataForumDrafts::createZipFile ( )

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

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

Referenced by deliverZipFile().

                                    : ?string
     {
         $filesOfDraft = $this->getFilesOfPost();
         ilFileUtils::makeDirParents($this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId());
         $tmp_dir = $this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId();
 
         if (count($filesOfDraft)) {
             ksort($filesOfDraft);
 
             foreach ($filesOfDraft as $file) {
                 copy($file['path'], $tmp_dir . '/' . $file['name']);
             }
         }
 
         $zip_file = null;
         if (ilFileUtils::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 ( )

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

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

Referenced by ilObjForumGUI\deleteSelectedDraft(), and ilObjForumGUI\deleteThreadDraftsObject().

                             : bool
     {
         ilFileUtils::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 ( string $file )

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

References ilFile\$path, ilFileDelivery\deliverFileLegacy(), getFileDataByMD5Filename(), and ILIAS\Repository\lng().

Referenced by ilObjForumGUI\viewThreadObject().

                                              : void
     {
         if (($path = $this->getFileDataByMD5Filename($file)) !== null) {
             ilFileDelivery::deliverFileLegacy($path['path'], $path['clean_filename']);
         } else {
             $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('error_reading_file'), true);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverZipFile()

ilFileDataForumDrafts::deliverZipFile ( )

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

References $DIC, $post, createZipFile(), ilFileUtils\delDir(), ilFileDelivery\deliverFileLegacy(), getDraftId(), getDraftsPath(), ILIAS\Repository\lng(), and ilForumPostDraft\newInstanceByDraftId().

                                     : bool
     {
         global $DIC;
 
         $zip_file = $this->createZipFile();
         if (!$zip_file) {
             $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('error_reading_file'), true);
             return false;
         }
 
         $post = ilForumPostDraft::newInstanceByDraftId($this->getDraftId());
         ilFileDelivery::deliverFileLegacy($zip_file, $post->getPostSubject() . '.zip', '', false, true, false);
         ilFileUtils::delDir($this->getDraftsPath() . '/drafts_zip/' . $this->getDraftId());
         $DIC->http()->close();
         return true; // never
     }

Here is the call graph for this function:

◆ getDraftId()

ilFileDataForumDrafts::getDraftId ( )

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

References $draft_id.

Referenced by checkForumDraftsPath(), checkReadWrite(), createZipFile(), delete(), deliverZipFile(), getDraftsPath(), getFileDataByMD5Filename(), initDirectory(), storeUploadedFile(), unlinkFile(), and unlinkFilesByMD5Filenames().

                                 : int
     {
         return $this->draft_id;
     }

Here is the caller graph for this function:

◆ getDraftsPath()

ilFileDataForumDrafts::getDraftsPath ( )

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

References $drafts_path, and getDraftId().

Referenced by checkForumDraftsPath(), checkReadWrite(), createZipFile(), delete(), deliverZipFile(), getFileDataByMD5Filename(), initDirectory(), storeUploadedFile(), unlinkFile(), and unlinkFilesByMD5Filenames().

                                    : string
     {
         return $this->drafts_path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileDataByMD5Filename()

ilFileDataForumDrafts::getFileDataByMD5Filename ( string $hashedFilename )

Parameters

string $hashedFilename

Returns: array{path: string, filename: string, clean_filename: string}|null

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

References ilFileUtils\getDir(), getDraftId(), and getDraftsPath().

Referenced by deliverFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjId()

ilFileDataForumDrafts::getObjId ( )

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

References $obj_id.

                               : int
     {
         return $this->obj_id;
     }

◆ initDirectory()

ilFileDataForumDrafts::initDirectory ( )

private

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

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

Referenced by __construct().

                                     : void
     {
         if (is_writable($this->getPath()) && ilFileUtils::makeDirParents($this->getDraftsPath() . '/' . $this->getDraftId()) && chmod(
             $this->getDraftsPath() . '/' . $this->getDraftId(),
             0755
         )) {
             // Empty, whyever @nmatuschek?
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moveFilesOfDraft()

ilFileDataForumDrafts::moveFilesOfDraft	(	string	$forum_path,
		int	$new_post_id
	)

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

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

◆ rotateFiles()

ilFileDataForumDrafts::rotateFiles ( string $a_path )

private

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

References ilFileUtils\rename().

Referenced by storeUploadedFile().

                                                 : void
     {
         if (is_file($a_path)) {
             $this->rotateFiles($a_path . '.old');
             ilFileUtils::rename($a_path, $a_path . '.old');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDraftId()

ilFileDataForumDrafts::setDraftId ( int $draft_id )

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

References $draft_id.

                                              : void
     {
         $this->draft_id = $draft_id;
     }

◆ setObjId()

ilFileDataForumDrafts::setObjId ( int $obj_id )

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

References $obj_id.

                                          : void
     {
         $this->obj_id = $obj_id;
     }

◆ storeUploadedFile()

ilFileDataForumDrafts::storeUploadedFile ( array $files )

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

References $filename, $index, $name, ilFile\$path, ilFileUtils\_sanitizeFilemame(), getDraftId(), getDraftsPath(), ilFileUtils\moveUploadedFile(), and rotateFiles().

Referenced by ilObjForumGUI\saveAsDraftObject().

                                                    : bool
     {
         if (isset($files['name']) && is_array($files['name'])) {
             foreach ($files['name'] as $index => $name) {
                 $name = rtrim($name, '/');
                 $filename = ilFileUtils::_sanitizeFilemame($name);
                 $temp_name = $files['tmp_name'][$index];
                 $error = $files['error'][$index];
 
                 if ($filename !== '' && $temp_name !== '' && (int) $error === 0) {
                     $path = $this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $filename;
 
                     $this->rotateFiles($path);
                     ilFileUtils::moveUploadedFile($temp_name, $filename, $path);
                 }
             }
 
             return true;
         }
 
         if (isset($files['name']) && is_string($files['name'])) {
             $files['name'] = rtrim($files['name'], '/');
             $filename = ilFileUtils::_sanitizeFilemame($files['name']);
             $temp_name = $files['tmp_name'];
 
             $path = $this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $filename;
 
             $this->rotateFiles($path);
             ilFileUtils::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 ( string $a_filename )

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

References getDraftId(), and getDraftsPath().

                                                   : bool
     {
         if (is_file($this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $a_filename)) {
             return unlink($this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $a_filename);
         }
 
         return false;
     }

Here is the call graph for this function:

◆ unlinkFilesByMD5Filenames()

ilFileDataForumDrafts::unlinkFilesByMD5Filenames ( $hashedFilenameOrFilenames )

Parameters

string|string[] $hashedFilenameOrFilenames

Returns: bool

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

References ilFileUtils\getDir(), getDraftId(), and getDraftsPath().

Referenced by ilObjForumGUI\saveThreadAsDraftObject(), ilObjForumGUI\updateDraftObject(), and ilObjForumGUI\updateThreadDraftObject().

                                                                          : bool
     {
         $files = ilFileUtils::getDir($this->getDraftsPath() . '/' . $this->getDraftId());
         if (is_array($hashedFilenameOrFilenames)) {
             foreach ($files as $file) {
                 if ($file['type'] === 'file' && in_array(md5($file['entry']), $hashedFilenameOrFilenames, true)) {
                     unlink($this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $file['entry']);
                 }
             }
 
             return true;
         }
 
         foreach ($files as $file) {
             if ($file['type'] === 'file' && md5($file['entry']) === $hashedFilenameOrFilenames) {
                 return unlink($this->getDraftsPath() . '/' . $this->getDraftId() . '/' . $file['entry']);
             }
         }
 
         return false;
     }