class.ilFileDataForumDrafts.php

Go to the documentation of this file.

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

require_once("./Services/FileSystem/classes/class.ilFileData.php");
require_once("./Services/Utilities/classes/class.ilFileUtils.php");

class ilFileDataForumDrafts extends ilFileData
{
        protected $obj_id = 0;
        protected $draft_id = 0;
        protected $drafts_path = '';

        public function __construct($obj_id = 0, $draft_id)
        {
                $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();
                }
        }
        
        public function getObjId()
        {
                return $this->obj_id;
        }
        
        public function setObjId($obj_id)
        {
                $this->obj_id = $obj_id;
        }
        
        public function getDraftId()
        {
                return $this->draft_id;
        }
        
        public function setDraftId($draft_id)
        {
                $this->draft_id = $draft_id;
        }
        
        public function getDraftsPath()
        {
                return $this->drafts_path;
        }
        
                
        public function getFiles()
        {
                $files = array();
                
                foreach(new DirectoryIterator($this->getDraftsPath().'/'.$this->getDraftId()) as $file)
                {
                        if($file->isDir())
                        {
                                continue;
                        }

                        $files[] = array(
                                'path'  => $file->getPathname(),
                                'md5'   => md5($file->getFilename()),
                                'name'  => $file->getFilename(),
                                'size'  => $file->getSize(),
                                'ctime' => date('Y-m-d H:i:s', $file->getCTime())
                        );
                }
                
                return $files;
        }
        
        public function getFilesOfPost()
        {
                $files = array();
                
                foreach(new DirectoryIterator($this->getDraftsPath().'/'.$this->getDraftId()) as $file)
                {
                        if($file->isDir())
                        {
                                continue;
                        }

                        $files[$file->getFilename()] = array(
                                'path'  => $file->getPathname(),
                                'md5'   => md5($file->getFilename()),
                                'name'  => $file->getFilename(),
                                'size'  => $file->getSize(),
                                'ctime' => date('Y-m-d H:i:s', $file->getCTime())
                        );
                }
                
                return $files;
        }
        
        public function moveFilesOfDraft($forum_path, $new_post_id)
        {
                foreach($this->getFilesOfPost() as $file)
                {
                        @copy($file['path'],
                                $forum_path.'/'.$this->obj_id.'_'.$new_post_id.'_'.$file['name']);
                }
                return true;
        }
        
        public function delete()
        {
                ilUtil::delDir($this->getDraftsPath().'/'.$this->getDraftId());
                return true;
        }
        
        function storeUploadedFile($files)
        {
                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;
                }
                else if(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;
        }
        function unlinkFiles($a_filenames)
        {
                if(is_array($a_filenames))
                {
                        foreach($a_filenames as $file)
                        {
                                if(!$this->unlinkFile($file))
                                {
                                        return $file;
                                }
                        }
                }
                return '';
        }
        function unlinkFile($a_filename)
        {
                if(file_exists($this->getDraftsPath().'/'.$this->getDraftId().'/'.$a_filename))
                {
                        return unlink($this->getDraftsPath().'/'.$this->getDraftId().'/'.$a_filename);
                }
        }
        function getAbsolutePath($a_path)
        {
                return $this->getDraftsPath().'/'.$this->getDraftId();
        }
        
        public function getFileDataByMD5Filename($a_md5_filename)
        {
                $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;
        }
        
        function unlinkFilesByMD5Filenames($a_md5_filename)
        {
                $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;
        }
        
        function checkFilesExist($a_files)
        {
                if($a_files)
                {
                        foreach($a_files as $file)
                        {
                                if(!file_exists($this->getDraftsPath().'/'.$this->getDraftId().'/'.$file))
                                {
                                        return false;
                                }
                        }
                        return true;
                }
                return true;
        }
        
        // PRIVATE METHODS
        function __checkPath()
        {
                if(!@file_exists($this->getDraftsPath().'/'.$this->getDraftId()))
                {
                        return false;
                }
                $this->__checkReadWrite();
                
                return true;
        }
        function __checkReadWrite()
        {
                if(is_writable($this->getDraftsPath().'/'.$this->getDraftId()) && is_readable($this->getDraftsPath().'/'.$this->getDraftId()))
                {
                        return true;
                }
                else
                {
                        $this->ilias->raiseError("Forum directory is not readable/writable by webserver",$this->ilias->error_obj->FATAL);
                }
        }
        function __initDirectory()
        {
                if(is_writable($this->getPath()))
                {
                        if(ilUtil::makeDirParents($this->getDraftsPath()."/".$this->getDraftId()))
                        {
                                if(chmod($this->getDraftsPath()."/".$this->getDraftId(),0755))
                                {
                                        return true;
                                }
                        }
                }
                return false;
        }
        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))
                {
                        global $lng;
                        return ilUtil::sendFailure($lng->txt('error_reading_file'), true);
                }
                else
                {
                        return ilUtil::deliverFile($path['path'], $path['clean_filename']);
                }
        }

        public function deliverZipFile()
        {
                global $lng, $ilUser;

                $zip_file = $this->createZipFile();
                if(!$zip_file)
                {
                        ilUtil::sendFailure($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();
                }
        }

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