class.ilFileDataForum.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2012 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilFileDataForum extends ilFileData
{
    public $obj_id;
    public $pos_id;

    public $forum_path;
    
    private $error;

    public function __construct($a_obj_id = 0, $a_pos_id = 0)
    {
        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;
    }

    public function getObjId()
    {
        return $this->obj_id;
    }
    public function getPosId()
    {
        return $this->pos_id;
    }
    public function setPosId($a_id)
    {
        $this->pos_id = $a_id;
    }
    public function getForumPath()
    {
        return $this->forum_path;
    }

    public function getFiles()
    {
        $directory_iterator = new DirectoryIterator($this->forum_path);
        $filter_iterator = new RegexIterator($directory_iterator, "/^{$this->obj_id}_(.+)$/");

        $files = [];
        foreach ($filter_iterator as $file) {
            if (!$file->isFile()) {
                continue;
            }

            list($obj_id, $rest) = explode('_', $file->getFilename(), 2);
            if ($obj_id == $this->obj_id) {
                $files[] = [
                    'path' => $file->getPathname(),
                    'md5' => md5($this->obj_id . '_' . $rest),
                    'name' => $rest,
                    'size' => $file->getSize(),
                    'ctime' => date('Y-m-d H:i:s', $file->getCTime())
                ];
            }
        }

        return $files;
    }

    public function getFilesOfPost()
    {
        $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;
    }

    public function moveFilesOfPost($a_new_frm_id = 0)
    {
        if ($a_new_frm_id) {
            $directory_iterator = new DirectoryIterator($this->forum_path);
            $filter_iterator = new RegexIterator($directory_iterator, "/^{$this->obj_id}_(\d+)_(.+)$/");

            foreach ($filter_iterator as $file) {
                if (!$file->isFile()) {
                    continue;
                }

                [$obj_id, $pos_id, $rest] = explode('_', $file->getFilename(), 3);
                if ((int) $obj_id !== (int) $this->obj_id || (int) $pos_id !== (int) $this->getPosId()) {
                    continue;
                }

                ilFileUtils::rename(
                    $file->getPathname(),
                    $this->forum_path . '/' . $a_new_frm_id . '_' . $this->pos_id . '_' . $rest
                );
            }

            return true;
        }

        return false;
    }

    public function ilClone($a_new_obj_id, $a_new_pos_id)
    {
        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;
    }
    public function delete()
    {
        foreach ($this->getFiles() as $file) {
            if (file_exists($this->getForumPath() . "/" . $this->getObjId() . "_" . $file["name"])) {
                unlink($this->getForumPath() . "/" . $this->getObjId() . "_" . $file["name"]);
            }
        }
        return true;
    }

    public function storeUploadedFile($files)
    {
        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;
    }
    public function unlinkFiles($a_filenames)
    {
        if (is_array($a_filenames)) {
            foreach ($a_filenames as $file) {
                if (!$this->unlinkFile($file)) {
                    return $file;
                }
            }
        }
        return '';
    }
    public function unlinkFile($a_filename)
    {
        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);
        }
    }
    public function getAbsolutePath($a_path)
    {
        return $this->forum_path . '/' . $this->obj_id . '_' . $this->pos_id . "_" . $a_path;
    }
    
    public function getFileDataByMD5Filename($a_md5_filename)
    {
        $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;
    }
    
    public function unlinkFilesByMD5Filenames($a_md5_filename)
    {
        $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;
    }

    public function checkFilesExist($a_files)
    {
        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;
    }

    // PRIVATE METHODS
    public function __checkPath()
    {
        if (!@file_exists($this->getForumPath())) {
            return false;
        }
        $this->__checkReadWrite();

        return true;
    }
    public function __checkReadWrite()
    {
        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);
        }
    }
    public function __initDirectory()
    {
        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;
    }
    public function __rotateFiles($a_path)
    {
        if (file_exists($a_path)) {
            $this->__rotateFiles($a_path . ".old");
            return \ilFileUtils::rename($a_path, $a_path . '.old');
        }
        return true;
    }

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

    public function deliverZipFile()
    {
        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();
        }
    }

    protected function createZipFile()
    {
        $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;
    }
}