Inheritance diagram for ilFileDataForumDraftsLegacyImplementation:

Collaboration diagram for ilFileDataForumDraftsLegacyImplementation:

Public Member Functions
	__construct (private readonly int $obj_id, private readonly int $draft_id)

	getObjId ()

	delete (array $posting_ids_to_delete=null)

	storeUploadedFile (array $files)

	unlinkFile (string $filename)

	getFileDataByMD5Filename (string $hashed_filename)

	unlinkFilesByMD5Filenames ($hashedFilenameOrFilenames)

	checkForumDraftsPath ()

	deliverFile (string $file)

	deliverZipFile ()

	getPosId ()

	setPosId (int $posting_id)

	getForumPath ()

	moveFilesOfPost (int $new_frm_id=0)

	ilClone (int $new_obj_id, int $new_posting_id)

	storeUploadedFiles ()

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

Public Member Functions inherited from ilFileDataForumInterface
	getFilesOfPost ()

Private Member Functions
	getDraftsPath ()

	checkReadWrite ()

	initDirectory ()

	rotateFiles (string $a_path)

	createZipFile ()

Private Attributes
string	$drafts_path

ilLanguage	$lng

ilErrorHandling	$error

ilGlobalTemplateInterface	$main_tpl

Additional Inherited Members
Protected Attributes inherited from ilFile
string	$path

Detailed Description

Definition at line 21 of file class.ilFileDataForumDraftsLegacyImplementation.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileDataForumDraftsLegacyImplementation::__construct	(	private readonly int	$obj_id,
		private readonly int	$draft_id
	)

Definition at line 28 of file class.ilFileDataForumDraftsLegacyImplementation.php.

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__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'];
 
         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()

ilFileDataForumDraftsLegacyImplementation::checkForumDraftsPath ( )

Definition at line 205 of file class.ilFileDataForumDraftsLegacyImplementation.php.

References checkReadWrite(), and getDraftsPath().

Referenced by __construct().

                                           : bool
     {
         if (!is_dir($this->getDraftsPath() . '/' . $this->draft_id)) {
             return false;
         }
         $this->checkReadWrite();
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkReadWrite()

ilFileDataForumDraftsLegacyImplementation::checkReadWrite ( )

private

Definition at line 215 of file class.ilFileDataForumDraftsLegacyImplementation.php.

References getDraftsPath().

Referenced by checkForumDraftsPath().

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

ilFileDataForumDraftsLegacyImplementation::createZipFile ( )

private

Definition at line 270 of file class.ilFileDataForumDraftsLegacyImplementation.php.

References getDraftsPath(), ilFileDataForumInterface\getFilesOfPost(), ilFileUtils\makeDirParents(), and ilFileUtils\zip().

Referenced by deliverZipFile().

                                     : ?string
     {
         $filesOfDraft = $this->getFilesOfPost();
         ilFileUtils::makeDirParents($this->getDraftsPath() . '/drafts_zip/' . $this->draft_id);
         $tmp_dir = $this->getDraftsPath() . '/drafts_zip/' . $this->draft_id;
 
         if ($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->draft_id . '.zip')) {
             $zip_file = $this->getDraftsPath() . '/drafts_zip/' . $this->draft_id . '.zip';
         }
 
         return $zip_file;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilFileDataForumDraftsLegacyImplementation::delete ( array $posting_ids_to_delete = null )

Parameters

list<int>|null $posting_ids_to_delete

Implements ilFileDataForumInterface.

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

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

                                                                : bool
     {
         // Each element of $posting_ids_to_delete represents a "Draft Id", NOT a "Posting Id"
         if ($posting_ids_to_delete === null) {
             return true;
         }
 
         foreach ($posting_ids_to_delete as $draft_id) {
             ilFileUtils::delDir($this->getDraftsPath() . '/' . $draft_id);
         }
 
         return true;
     }

Here is the call graph for this function:

◆ deliverFile()

ilFileDataForumDraftsLegacyImplementation::deliverFile ( string $file )

Implements ilFileDataForumInterface.

Definition at line 243 of file class.ilFileDataForumDraftsLegacyImplementation.php.

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

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

◆ deliverZipFile()

ilFileDataForumDraftsLegacyImplementation::deliverZipFile ( )

Implements ilFileDataForumInterface.

Definition at line 252 of file class.ilFileDataForumDraftsLegacyImplementation.php.

References $DIC, $post, createZipFile(), ilFileUtils\delDir(), ilFileDelivery\deliverFileLegacy(), 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->draft_id);
         ilFileDelivery::deliverFileLegacy($zip_file, $post->getPostSubject() . '.zip', '', false, true, false);
         ilFileUtils::delDir($this->getDraftsPath() . '/drafts_zip/' . $this->draft_id);
         $DIC->http()->close();
 
         return true; // never
     }

Here is the call graph for this function:

◆ getDraftsPath()

ilFileDataForumDraftsLegacyImplementation::getDraftsPath ( )

private

Definition at line 48 of file class.ilFileDataForumDraftsLegacyImplementation.php.

References $drafts_path, and ilFileDataForumInterface\getFilesOfPost().

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

                                     : string
     {
         return $this->drafts_path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileDataByMD5Filename()

ilFileDataForumDraftsLegacyImplementation::getFileDataByMD5Filename ( string $hashed_filename )

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

Implements ilFileDataForumInterface.

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

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

Referenced by deliverFile().

                                                                      : ?array
     {
         $files = ilFileUtils::getDir($this->getDraftsPath() . '/' . $this->draft_id);
         foreach ($files as $file) {
             if ($file['type'] === 'file' && md5($file['entry']) === $hashed_filename) {
                 return [
                     'path' => $this->getDraftsPath() . '/' . $this->draft_id . '/' . $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:

◆ getForumPath()

ilFileDataForumDraftsLegacyImplementation::getForumPath ( )

Implements ilFileDataForumInterface.

Definition at line 301 of file class.ilFileDataForumDraftsLegacyImplementation.php.

                                   : string
     {
         return '';
     }

◆ getObjId()

ilFileDataForumDraftsLegacyImplementation::getObjId ( )

Implements ilFileDataForumInterface.

Definition at line 43 of file class.ilFileDataForumDraftsLegacyImplementation.php.

                               : int
     {
         return $this->obj_id;
     }

◆ getPosId()

ilFileDataForumDraftsLegacyImplementation::getPosId ( )

Implements ilFileDataForumInterface.

Definition at line 292 of file class.ilFileDataForumDraftsLegacyImplementation.php.

                               : int
     {
         return $this->draft_id;
     }

◆ ilClone()

ilFileDataForumDraftsLegacyImplementation::ilClone	(	int	$new_obj_id,
		int	$new_posting_id
	)

Implements ilFileDataForumInterface.

Definition at line 311 of file class.ilFileDataForumDraftsLegacyImplementation.php.

                                                                  : bool
     {
         return true;
     }

◆ initDirectory()

ilFileDataForumDraftsLegacyImplementation::initDirectory ( )

private

Definition at line 223 of file class.ilFileDataForumDraftsLegacyImplementation.php.

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

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ moveFilesOfPost()

ilFileDataForumDraftsLegacyImplementation::moveFilesOfPost ( int $new_frm_id = 0 )

Implements ilFileDataForumInterface.

Definition at line 306 of file class.ilFileDataForumDraftsLegacyImplementation.php.

                                                         : bool
     {
         return true;
     }

◆ rotateFiles()

ilFileDataForumDraftsLegacyImplementation::rotateFiles ( string $a_path )

private

Definition at line 235 of file class.ilFileDataForumDraftsLegacyImplementation.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:

◆ setPosId()

ilFileDataForumDraftsLegacyImplementation::setPosId ( int $posting_id )

Implements ilFileDataForumInterface.

Definition at line 297 of file class.ilFileDataForumDraftsLegacyImplementation.php.

                                              : void
     {
     }

◆ storeUploadedFile()

ilFileDataForumDraftsLegacyImplementation::storeUploadedFile ( array $files )

Definition at line 120 of file class.ilFileDataForumDraftsLegacyImplementation.php.

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

                                                    : 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->draft_id . '/' . $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->draft_id . '/' . $filename;
 
             $this->rotateFiles($path);
             ilFileUtils::moveUploadedFile($temp_name, $filename, $path);
 
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

◆ storeUploadedFiles()

ilFileDataForumDraftsLegacyImplementation::storeUploadedFiles ( )

Implements ilFileDataForumInterface.

Definition at line 316 of file class.ilFileDataForumDraftsLegacyImplementation.php.

                                         : bool
     {
         throw new DomainException('Not implemented');
     }

◆ unlinkFile()

ilFileDataForumDraftsLegacyImplementation::unlinkFile ( string $filename )

Implements ilFileDataForumInterface.

Definition at line 156 of file class.ilFileDataForumDraftsLegacyImplementation.php.

                                                 : bool
     {
         throw new DomainException('Not implemented');
     }

◆ unlinkFilesByMD5Filenames()

ilFileDataForumDraftsLegacyImplementation::unlinkFilesByMD5Filenames ( $hashedFilenameOrFilenames )

Parameters

string|string[] $hashedFilenameOrFilenames

Implements ilFileDataForumInterface.

Definition at line 183 of file class.ilFileDataForumDraftsLegacyImplementation.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $drafts_path

string ilFileDataForumDraftsLegacyImplementation::$drafts_path

private

Definition at line 23 of file class.ilFileDataForumDraftsLegacyImplementation.php.

Referenced by getDraftsPath().

◆ $error

ilErrorHandling ilFileDataForumDraftsLegacyImplementation::$error

private

Definition at line 25 of file class.ilFileDataForumDraftsLegacyImplementation.php.

◆ $lng

ilLanguage ilFileDataForumDraftsLegacyImplementation::$lng

private

Definition at line 24 of file class.ilFileDataForumDraftsLegacyImplementation.php.

◆ $main_tpl

ilGlobalTemplateInterface ilFileDataForumDraftsLegacyImplementation::$main_tpl

private

Definition at line 26 of file class.ilFileDataForumDraftsLegacyImplementation.php.

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

Modules/Forum/classes/Files/class.ilFileDataForumDraftsLegacyImplementation.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkForumDraftsPath()

◆ checkReadWrite()

◆ createZipFile()

◆ delete()

◆ deliverFile()

◆ deliverZipFile()

◆ getDraftsPath()

◆ getFileDataByMD5Filename()

◆ getForumPath()

◆ getObjId()

◆ getPosId()

◆ ilClone()

◆ initDirectory()

◆ moveFilesOfPost()

◆ rotateFiles()

◆ setPosId()

◆ storeUploadedFile()

◆ storeUploadedFiles()

◆ unlinkFile()

◆ unlinkFilesByMD5Filenames()

Field Documentation

◆ $drafts_path

◆ $error

◆ $lng

◆ $main_tpl