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

Inheritance diagram for ilFileDataForum:

Collaboration diagram for ilFileDataForum:

Public Member Functions
	__construct (int $a_obj_id=0, int $a_pos_id=0)

	getObjId ()

	getPosId ()

	setPosId (int $a_id)

	getForumPath ()

	getFilesOfPost ()

	ilClone (int $a_new_obj_id, int $a_new_pos_id)

	delete ()

	storeUploadedFile (array $files)

	unlinkFile (string $a_filename)

	getFileDataByMD5Filename (string $hashedFilename)

	unlinkFilesByMD5Filenames ($hashedFilenameOrFilenames)

	deliverFile (string $file)

	deliverZipFile ()

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

Protected Member Functions
	createZipFile ()

Private Member Functions
	checkForumPath ()

	checkReadWrite ()

	initDirectory ()

	rotateFiles (string $a_path)

Private Attributes
const	FORUM_PATH = 'forum'

int	$obj_id

int	$pos_id

string	$forum_path

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

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
 
        $this->error = $DIC['ilErr'];
 
        parent::__construct();
        $this->forum_path = $this->getPath() . '/' . self::FORUM_PATH;
 
        if (!$this->checkForumPath()) {
            $this->initDirectory();
        }
        $this->obj_id = $a_obj_id;
        $this->pos_id = $a_pos_id;
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), checkForumPath(), error(), FORUM_PATH, ilFileData\getPath(), and initDirectory().

Here is the call graph for this function:

Member Function Documentation

◆ checkForumPath()

ilFileDataForum::checkForumPath ( )

private

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

                                     : bool
    {
        if (!is_dir($this->getForumPath())) {
            return false;
        }
        $this->checkReadWrite();
 
        return true;
    }

References checkReadWrite(), and getForumPath().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkReadWrite()

ilFileDataForum::checkReadWrite ( )

private

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

                                     : void
    {
        if (!is_writable($this->forum_path) || !is_readable($this->forum_path)) {
            $this->error->raiseError('Forum directory is not readable/writable by webserver', $this->error->FATAL);
        }
    }

References error().

Referenced by checkForumPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createZipFile()

ilFileDataForum::createZipFile ( )

protected

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

                                      : ?string
    {
        $filesOfPost = $this->getFilesOfPost();
        ksort($filesOfPost);
 
        ilFileUtils::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 (ilFileUtils::zip(
            $tmp_dir,
            $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId() . '.zip'
        )) {
            $zip_file = $this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId() . '.zip';
        }
 
        return $zip_file;
    }

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

Referenced by deliverZipFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilFileDataForum::delete ( )

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

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

References getForumPath(), and getObjId().

Here is the call graph for this function:

◆ deliverFile()

ilFileDataForum::deliverFile ( string $file )

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

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

References $DIC, ilFile\$path, ilFileDelivery\deliverFileLegacy(), and getFileDataByMD5Filename().

Here is the call graph for this function:

◆ deliverZipFile()

ilFileDataForum::deliverZipFile ( )

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

                                    : bool
    {
        global $DIC;
 
        $zip_file = $this->createZipFile();
        if (!$zip_file) {
            $this->main_tpl->setOnScreenMessage('failure', $DIC->language()->txt('error_reading_file'), true);
            return false;
        }
 
        $post = new ilForumPost($this->getPosId());
        ilFileDelivery::deliverFileLegacy($zip_file, $post->getSubject() . '.zip', '', false, true, false);
        ilFileUtils::delDir($this->getForumPath() . '/zip/' . $this->getObjId() . '_' . $this->getPosId());
        $DIC->http()->close();
        return true; // never
    }

References $DIC, $post, createZipFile(), ilFileUtils\delDir(), ilFileDelivery\deliverFileLegacy(), getForumPath(), getObjId(), and getPosId().

Here is the call graph for this function:

◆ getFileDataByMD5Filename()

ilFileDataForum::getFileDataByMD5Filename ( string $hashedFilename )

Parameters

string $hashedFilename

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

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

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

References ilFileUtils\getDir().

Referenced by deliverFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilesOfPost()

ilFileDataForum::getFilesOfPost ( )

Returns: array<string, array{path: string, md5: string, name: string, size: int, ctime: string}>

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

                                    : array
    {
        $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;
    }

References $obj_id, $pos_id, and $rest.

Referenced by createZipFile(), and ilClone().

Here is the caller graph for this function:

◆ getForumPath()

ilFileDataForum::getForumPath ( )

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

                                  : string
    {
        return $this->forum_path;
    }

References $forum_path.

Referenced by checkForumPath(), createZipFile(), delete(), deliverZipFile(), ilClone(), and storeUploadedFile().

Here is the caller graph for this function:

◆ getObjId()

ilFileDataForum::getObjId ( )

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

                              : int
    {
        return $this->obj_id;
    }

References $obj_id.

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

Here is the caller graph for this function:

◆ getPosId()

ilFileDataForum::getPosId ( )

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

                              : int
    {
        return $this->pos_id;
    }

References $pos_id.

Referenced by createZipFile(), and deliverZipFile().

Here is the caller graph for this function:

◆ ilClone()

ilFileDataForum::ilClone	(	int	$a_new_obj_id,
		int	$a_new_pos_id
	)

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

                                                                 : bool
    {
        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;
    }

References getFilesOfPost(), and getForumPath().

Here is the call graph for this function:

◆ initDirectory()

ilFileDataForum::initDirectory ( )

private

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

                                    : void
    {
        if (is_writable($this->getPath()) && mkdir($this->getPath() . '/' . self::FORUM_PATH) && chmod(
            $this->getPath() . '/' . self::FORUM_PATH,
            0755
        )) {
            $this->forum_path = $this->getPath() . '/' . self::FORUM_PATH;
        }
    }

References FORUM_PATH, and ilFileData\getPath().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rotateFiles()

ilFileDataForum::rotateFiles ( string $a_path )

private

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

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

References ilFileUtils\rename(), and rotateFiles().

Referenced by rotateFiles(), and storeUploadedFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPosId()

ilFileDataForum::setPosId ( int $a_id )

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

                                       : void
    {
        $this->pos_id = $a_id;
    }

◆ storeUploadedFile()

ilFileDataForum::storeUploadedFile ( array $files )

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

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

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

Here is the call graph for this function:

◆ unlinkFile()

ilFileDataForum::unlinkFile ( string $a_filename )

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

                                                  : bool
    {
        if (is_file($this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $a_filename)) {
            return unlink($this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . '_' . $a_filename);
        }
 
        return false;
    }

◆ unlinkFilesByMD5Filenames()

ilFileDataForum::unlinkFilesByMD5Filenames ( $hashedFilenameOrFilenames )

Parameters

string | string[] $hashedFilenameOrFilenames

Returns: bool

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

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

References ilFileUtils\getDir().

Here is the call graph for this function:

Field Documentation

◆ $error

ilErrorHandling ilFileDataForum::$error

private

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

Referenced by storeUploadedFile().

◆ $forum_path

string ilFileDataForum::$forum_path

private

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

Referenced by getForumPath().

◆ $main_tpl

ilGlobalTemplateInterface ilFileDataForum::$main_tpl

private

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

◆ $obj_id

int ilFileDataForum::$obj_id

private

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

Referenced by getFilesOfPost(), and getObjId().

◆ $pos_id

int ilFileDataForum::$pos_id

private

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

Referenced by getFilesOfPost(), and getPosId().

◆ FORUM_PATH

const ilFileDataForum::FORUM_PATH = 'forum'

private

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

Referenced by __construct(), and initDirectory().

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

Modules/Forum/classes/class.ilFileDataForum.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkForumPath()

◆ checkReadWrite()

◆ createZipFile()

◆ delete()

◆ deliverFile()

◆ deliverZipFile()

◆ getFileDataByMD5Filename()

◆ getFilesOfPost()

◆ getForumPath()

◆ getObjId()

◆ getPosId()

◆ ilClone()

◆ initDirectory()

◆ rotateFiles()

◆ setPosId()

◆ storeUploadedFile()

◆ unlinkFile()

◆ unlinkFilesByMD5Filenames()

Field Documentation

◆ $error

◆ $forum_path

◆ $main_tpl

◆ $obj_id

◆ $pos_id

◆ FORUM_PATH