class.ilObjFile.php

Go to the documentation of this file.

<?php
/*
        +-----------------------------------------------------------------------------+
        | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
        | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
        |                                                                             |
        | This program is free software; you can redistribute it and/or               |
        | modify it under the terms of the GNU General Public License                 |
        | as published by the Free Software Foundation; either version 2              |
        | of the License, or (at your option) any later version.                      |
        |                                                                             |
        | This program is distributed in the hope that it will be useful,             |
        | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
        | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
        | GNU General Public License for more details.                                |
        |                                                                             |
        | You should have received a copy of the GNU General Public License           |
        | along with this program; if not, write to the Free Software                 |
        | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
        +-----------------------------------------------------------------------------+
*/

require_once "./classes/class.ilObject.php";
include_once('Modules/File/classes/class.ilFSStorageFile.php');

class ilObjFile extends ilObject
{
        var $filename;
        var $filetype;
        var $filemaxsize = "20000000";  // not used yet
        var $raise_upload_error;
        var $mode = "object";
        
        private $file_storage = null;


        function ilObjFile($a_id = 0,$a_call_by_reference = true)
        {
                $this->version = 0;
                $this->type = "file";
                $this->raise_upload_error = true;
                $this->ilObject($a_id,$a_call_by_reference);
                
                if($this->getId())
                {
                        $this->initFileStorage();
                }
        }

        function create($a_upload = false)
        {
                $new_id = parent::create();

                //BEGIN WebDAV Move Property creation into a method of its own.
                $this->createProperties($a_upload);
                //END WebDAV Move Property creation into a method of its own.

                return $new_id;         
        }
        //BEGIN WebDAV: Move Property creation into a method of its own.
        function createProperties($a_upload = false)
        {
                global $ilDB,$tree;
                
                // Create file directory
                $this->initFileStorage();
                $this->file_storage->create();
                
                if($a_upload)
                {
                        return true;
                }
                
                // not upload mode
                require_once("classes/class.ilHistory.php");
                ilHistory::_createEntry($this->getId(), "create", $this->getFileName().",1");
                $this->addNewsNotification("file_created");


                require_once("./Services/News/classes/class.ilNewsItem.php");
                $default_visibility = ilNewsItem::_getDefaultVisibilityForRefId($_GET['ref_id']);
                if ($default_visibility == "public")
                {
                        ilBlockSetting::_write("news", "public_notifications",
                                1, 0, $this->getId());
                }

                $q = "INSERT INTO file_data (file_id,file_name,file_type,file_size,version,mode) "
                        ."VALUES (".$ilDB->quote($this->getId()).","
                        .$ilDB->quote($this->getFileName()).","
                        .$ilDB->quote($this->getFileType()).","
                        .$ilDB->quote($this->getFileSize()).","
                        .$ilDB->quote("1").",".$ilDB->quote($this->getMode()).")";
                $this->ilias->db->query($q);
                
                // no meta data handling for file list files
                if ($this->getMode() != "filelist")
                {
                        $this->createMetaData();
                }
        }
        //END WebDAV: Move Property creation into a method of its own.
        
        function createMetaData()
        {
                parent::createMetaData();
                
                // add technical section with file size and format
                $md_obj =& new ilMD($this->getId(),0,$this->getType());
                $technical = $md_obj->addTechnical();
                $technical->setSize($this->getFileSize());
                $technical->save();
                $format = $technical->addFormat();
                $format->setFormat($this->getFileType());
                $format->save();
                $technical->update();
        }
        
        function MDUpdateListener($a_element)
        {
                // handling for general section
                parent::MDUpdateListener($a_element);
                
                // handling for technical section 
                include_once 'Services/MetaData/classes/class.ilMD.php';
//echo "-".$a_element."-";
                switch($a_element)
                {
                        case 'Technical':

                                // Update Format (size is not stored in db)
                                $md = new ilMD($this->getId(),0, $this->getType());
                                if(!is_object($md_technical = $md->getTechnical()))
                                {
                                        return false;
                                }

                                foreach($md_technical->getFormatIds() as $id)
                                {
                                        $md_format = $md_technical->getFormat($id);
                                        ilObjFile::_writeFileType($this->getId(),$md_format->getFormat());
                                        $this->setFileType($md_format->getFormat());
                                        break;
                                }

                                break;

                        default:
                }
                return true;
        }


        function getDirectory($a_version = 0)
        {
                $version_subdir = "";

                if ($a_version)
                {
                        // BEGIN WebDAV Avoid double slash before version subdirectory
                        $version_subdir = sprintf("%03d", $a_version);
                        // END WebDAV Avoid  double slash before version subdirectory
                }
                
                if(!is_object($this->file_storage))
                {
                        $this->initFileStorage();
                }
                
                return $this->file_storage->getAbsolutePath().'/'.$version_subdir;
        }

        function createDirectory()
        {
                ilUtil::makeDirParents($this->getDirectory());
        }
        
        function raiseUploadError($a_raise = true)
        {
                $this->raise_upload_error = $a_raise;
        }

        function getUploadFile($a_upload_file, $a_filename)
        {
                $this->setVersion($this->getVersion() + 1);

                if (@!is_dir($this->getDirectory($this->getVersion())))
                {
                        ilUtil::makeDirParents($this->getDirectory($this->getVersion()));
                }

                $file = $this->getDirectory($this->getVersion())."/".$a_filename;
                //move_uploaded_file($a_upload_file, $file);
                ilUtil::moveUploadedFile($a_upload_file, $a_filename, $file, $this->raise_upload_error);
        }

        function replaceFile($a_upload_file, $a_filename)
        {
                //$this->clearDataDirectory();          // ! This has to be changed, if multiple versions should be supported
                $this->getUploadFile($a_upload_file, $a_filename);
                
                require_once("classes/class.ilHistory.php");
                ilHistory::_createEntry($this->getId(), "replace",
                        $a_filename.",".$this->getVersion());
                $this->setFilename($a_filename);
                $this->addNewsNotification("file_updated");
        }


        function copy($a_source,$a_destination)
        {
                return copy($a_source,$this->getDirectory()."/".$a_destination);
        }
        
        function clearDataDirectory()
        {
                ilUtil::delDir($this->getDirectory());
                $this->createDirectory();
        }

        function read()
        {
                global $ilDB;
                
                parent::read();

                $q = "SELECT * FROM file_data WHERE file_id = ".$ilDB->quote($this->getId());
                $r = $this->ilias->db->query($q);
                $row = $r->fetchRow(DB_FETCHMODE_OBJECT);

                $this->setFileName($row->file_name);
                $this->setFileType($row->file_type);
                $this->setFileSize($row->file_size);
                $this->setVersion($row->version);
                $this->setMode($row->mode);
                
                $this->initFileStorage();
        }

        function update()
        {
                global $ilDB;
                
                // no meta data handling for file list files
                if ($this->getMode() != "filelist")
                {
                        $this->updateMetaData();
                }
                parent::update();
                
                global $ilLog;
                
                //$ilLog->write(__METHOD__.' File type: '.$this->getFileType());
                
                $q = "UPDATE file_data SET file_name = ".$ilDB->quote($this->getFileName()).
                        ", file_type = ".$ilDB->quote($this->getFiletype())." ".
                        ", file_size = ".$ilDB->quote($this->getFileSize())." ".
                        ", version = ".$ilDB->quote($this->getVersion())." ".
                        ", mode = ".$ilDB->quote($this->getMode())." ".
                        "WHERE file_id = ".$ilDB->quote($this->getId());
                $this->ilias->db->query($q);
                
                return true;
        }
        
        function updateMetaData()
        {
                parent::updateMetaData();
                
                // add technical section with file size and format
                $md_obj =& new ilMD($this->getId(),0,$this->getType());
                if(!is_object($technical = $md_obj->getTechnical()))
                {
                        $technical = $md_obj->addTechnical();
                        $technical->save();
                }
                $technical->setSize($this->getFileSize());
                
                $format_ids = $technical->getFormatIds();
                if (count($format_ids) > 0)
                {
                        $format = $technical->getFormat($format_ids[0]);
                        $format->setFormat($this->getFileType());
                        $format->update();
                }
                else
                {
                        $format = $technical->addFormat();
                        $format->setFormat($this->getFileType());
                        $format->save();
                }
                $technical->update();
        }

        function setFileName($a_name)
        {
                $this->filename = $a_name;
        }

        function getFileName()
        {
                return $this->filename;
        }

        function setFileType($a_type)
        {
                global $ilLog;
                
                
                $this->filetype = $a_type;
        }

        function getFileType()
        {
                return $this->filetype;
        }

        function setFileSize($a_size)
        {
                $this->filesize = $a_size;
        }

        function getFileSize()
        {
                return $this->filesize;
        }

        // END PATCH WebDAV Encapsulate file access in ilObjFile class.
        function getFile($a_hist_entry_id = null)
        {
                if (is_null($a_hist_entry_id))
                {
                        $file = $this->getDirectory($this->getVersion())."/".$this->getFileName();
                }
                else
                {
                        require_once("classes/class.ilHistory.php");
                        $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
                        
                        if ($entry === false)
                        {
                                return false;
                        }

                        $data = explode(",",$entry["info_params"]);
                        
                        // bugfix: first created file had no version number
                        // this is a workaround for all files created before the bug was fixed
                        if (empty($data[1]))
                        {
                                $data[1] = "1";
                        }

                        $file = $this->getDirectory($data[1])."/".$data[0];
                }
                return $file;
        }
        // END PATCH WebDAV Encapsulate file access in ilObjFile class.
        
        function setVersion($a_version)
        {
                $this->version = $a_version;
        }

        function getVersion()
        {
                return $this->version;
        }
        
        function setMode($a_mode)
        {
                $this->mode = $a_mode;
        }

        function getMode()
        {
                return $this->mode;
        }
        
        function _writeFileType($a_id ,$a_format)
        {
                global $ilDB;
                
                $q = "UPDATE file_data SET ".
                        " file_type = ".$ilDB->quote($a_format).
                        " WHERE file_id = ".$ilDB->quote($a_id);
                $ilDB->query($q);
                
        }

        function _lookupFileName($a_id)
        {
                global $ilDB;

                $q = "SELECT * FROM file_data WHERE file_id = ".$ilDB->quote($a_id);
                $r = $ilDB->query($q);
                $row = $r->fetchRow(DB_FETCHMODE_OBJECT);

                return ilUtil::stripSlashes($row->file_name);
        }


        function _lookupFileSize($a_id, $a_as_string = false)
        {
                // BEGIN WebDAV: Use lookupFileSize function of class ilObjFileAccess
            include_once("./Modules/File/classes/class.ilObjFileAccess.php");
                return ilObjFileAccess::_lookupFileSize($a_id, $a_as_string, true);
                // END WebDAV: Use lookupFileSize function of class ilObjFileAccess
        }
        
        function _lookupVersion($a_id)
        {
                include_once("./Modules/File/classes/class.ilObjFileAccess.php");
                return ilObjFileAccess::_lookupVersion($a_id);
        }

        function determineFileSize($a_hist_entry_id = null)
        {
                if (is_null($a_hist_entry_id))
                {
                        $file = $this->getDirectory($this->getVersion())."/".$this->getFileName();
                }
                else
                {
                        require_once("classes/class.ilHistory.php");
                        $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
                        
                        if ($entry === false)
                        {
                                return false;
                        }

                        $data = explode(",",$entry["info_params"]);
                        
                        // bugfix: first created file had no version number
                        // this is a workaround for all files created before the bug was fixed
                        if (empty($data[1]))
                        {
                                $data[1] = "1";
                        }
                        $file = $this->getDirectory($data[1])."/".$data[0];
                }
                $this->setFileSize(filesize($file));
        }
        
        function sendFile($a_hist_entry_id = null)
        {       
                if (is_null($a_hist_entry_id))
                {
                        $file = $this->getDirectory($this->getVersion())."/".$this->getFileName();

                        // if not found lookup for file in file object's main directory for downward c  ompability
                        if (@!is_file($file))
                        {
                                $file = $this->getDirectory()."/".$this->getFileName();
                        }
                }
                else
                {
                        require_once("classes/class.ilHistory.php");
                        $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
                        
                        if ($entry === false)
                        {
                                echo "3";return false;
                        }

                        $data = explode(",",$entry["info_params"]);
                        
                        // bugfix: first created file had no version number
                        // this is a workaround for all files created before the bug was fixed
                        if (empty($data[1]))
                        {
                                $data[1] = "1";
                        }

                        $file = $this->getDirectory($data[1])."/".$data[0];
                        
                        // if not found lookup for file in file object's main directory for downward compability
                        if (@!is_file($file))
                        {
                                $file = $this->getDirectory()."/".$data[0];
                        }

                        // BEGIN WebDAV removed duplicated code
                        // END WebDAV removed duplicated code
                }

                if (@is_file($file))
                {
                        // BEGIN WebDAV: Deliver file with title, file type, and eventually as inline object.
                        ilUtil::deliverFile($file, $this->getTitle(), $this->guessFileType($file), $this->isInline());
                        // END WebDAV: Deliver file with title, file type, and eventually as inline object.
                        return true;
                }

                return false;
        }

        // BEGIN WebDAV: Get file extension, determine if file is inline, guess file type.
        function getFileExtension() {
                require_once 'class.ilObjFileAccess.php';
                return ilObjFileAccess::_getFileExtension($this->getTitle());
        }
        function isInline() {
                require_once 'class.ilObjFileAccess.php';
                return ilObjFileAccess::_isFileInline($this->getTitle());
        }
        function isHidden() {
                require_once 'class.ilObjFileAccess.php';
                return ilObjFileAccess::_isFileHidden($this->getTitle());
        }
        // END WebDAV: Get file extension, determine if file is inline, guess file type.
        
        function guessFileType($a_file = "") {
                
                $path = pathinfo($a_file);
                if ($path["extension"] != "")
                {
                        $filename = $path["basename"];
                }
                else
                {
                        $filename = "dummy.".$this->getFileExtension();
                }
                include_once("./Services/Utilities/classes/class.ilMimeTypeUtil.php");
                $mime = ilMimeTypeUtil::getMimeType($a_file, $filename, $this->getFileType());
                return $mime;
                
/*
                $fileType = $this->getFileType();
                if (strlen($fileType) == 0) {   
                        $fileType = 'application/octet-stream';
                }

                // Firefox browser assigns 'application/x-pdf' to PDF files, but
                // it can only handle them if the have the mime-type 'application/pdf'.
                if ($fileType == 'application/x-pdf')
                {
                        $fileType = 'application/pdf';
                }

                if ($fileType == 'application/octet-stream')
                {
                        $fileExtension = $this->getFileExtension();
                        $mimeArray = array(
                                'mpeg' => 'video/mpeg',
                                'mp3' => 'audio/mpeg',
                                'pdf' => 'application/pdf',
                                'gif' => 'image/gif',
                                'jpg' => 'image/jpg',
                                'png' => 'image/png',
                                'htm' => 'text/html',
                                'html' => 'text/html',
                                'wma' => 'video/x-ms-wma',
                                'wmv' => 'video/x-ms-wmv',
                                'swf' => 'application/x-shockwave-flash',
                        );
                        if (array_key_exists($fileExtension, $mimeArray))
                        {
                                $fileType = $mimeArray[$fileExtension];
                        }
                }
                return $fileType;
*/
        }
        
        public function cloneObject($a_target_id,$a_copy_id = 0)
        {
                global $ilDB;
                
                $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                $new_obj->createDirectory();
                $this->cloneMetaData($new_obj);
                
                // Copy all file versions
                ilUtil::rCopy($this->getDirectory(),$new_obj->getDirectory());
                
                // object created now copy other settings
                $query = "INSERT INTO file_data (file_id,file_name,file_type,file_size,version,mode) VALUES (".
                                $ilDB->quote($new_obj->getId()).",".
                                $ilDB->quote($this->getFileName()).",".
                                $ilDB->quote($this->getFileType()).",".
                                $ilDB->quote($this->getFileSize()).", ".
                                $ilDB->quote($this->getVersion()).", ".
                                $ilDB->quote($this->getMode()).")";
                $ilDB->query($query);

                // copy history entries
                require_once("classes/class.ilHistory.php");
                ilHistory::_copyEntriesForObject($this->getId(),$new_obj->getId());
                
                // add news notification
                $new_obj->addNewsNotification("file_created");

                return $new_obj;
        }
        

        function delete()
        {
                global $ilDB;
                
                // check, if file is used somewhere
                $usages = $this->getUsages();

                if (count($usages) == 0)
                {
                        // always call parent delete function first!!
                        if (!parent::delete())
                        {
                                return false;
                        }

                        // delete file data entry
                        $q = "DELETE FROM file_data WHERE file_id = ".$ilDB->quote($this->getId());
                        $this->ilias->db->query($q);
                        
                        // delete history entries
                        require_once("classes/class.ilHistory.php");
                        ilHistory::_removeEntriesForObject($this->getId());
                        
                        // delete entire directory and its content
                        if (@is_dir($this->getDirectory()))
                        {
                                ilUtil::delDir($this->getDirectory());
                        }
                        
                        // delete meta data
                        if ($this->getMode() != "filelist")
                        {
                                $this->deleteMetaData();
                        }

                        return true;
                }

                return false;
        }

        function export($a_target_dir)
        {
                $subdir = "il_".IL_INST_ID."_file_".$this->getId();
                ilUtil::makeDir($a_target_dir."/objects/".$subdir);

                $filedir = $this->getDirectory($this->getVersion());
                
                if (@!is_dir($filedir))
                {
                        $filedir = $this->getDirectory();
                }
                
                ilUtil::rCopy($filedir, $a_target_dir."/objects/".$subdir);
        }

        function _deleteAllUsages($a_type, $a_id, $a_usage_hist_nr = 0)
        {
                global $ilDB;
                
                $q = "DELETE FROM file_usage WHERE usage_type=".$ilDB->quote($a_type)." AND usage_id=".$ilDB->quote($a_id).
                        " AND usage_hist_nr = ".$ilDB->quote($a_usage_hist_nr);
                $this->ilias->db->query($q);
        }

        function _saveUsage($a_mob_id, $a_type, $a_id, $a_usage_hist_nr = 0)
        {
                global $ilDB;
                
                $q = "REPLACE INTO file_usage (id, usage_type, usage_id, usage_hist_nr) VALUES".
                        " (".$ilDB->quote($a_mob_id).",".$ilDB->quote($a_type).",".$ilDB->quote($a_id).",".
                        $ilDB->quote($a_usage_hist_nr).")";
                $this->ilias->db->query($q);
        }

        function getUsages()
        {
                global $ilDB;

                // get usages in learning modules
                $q = "SELECT * FROM file_usage WHERE id = ".$ilDB->quote($this->getId());
                $us_set = $ilDB->query($q);
                $ret = array();
                while($us_rec = $us_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $ret[] = array("type" => $us_rec["usage_type"],
                                "id" => $us_rec["usage_id"],
                                "hist_nr" => $us_rec["usage_hist_nr"]);
                }

                return $ret;
        }

        function _getFilesOfObject($a_type, $a_id, $a_usage_hist_nr = 0)
        {
                global $ilDB;

                // get usages in learning modules
                $q = "SELECT * FROM file_usage WHERE usage_id = ".$ilDB->quote($a_id).
                        " AND usage_type = ".$ilDB->quote($a_type)." AND ".
                        "usage_hist_nr = ".$ilDB->quote($a_usage_hist_nr);
                $file_set = $ilDB->query($q);
                $ret = array();
                while($file_rec = $file_set->fetchRow(DB_FETCHMODE_ASSOC))
                {
                        $ret[$file_rec["id"]] = $file_rec["id"];
                }

                return $ret;
        }

        // TODO: What is this function good for??
        function getXMLZip()
        {
                global $ilias;

                $zip = PATH_TO_ZIP;

                exec($zip.' '.ilUtil::escapeShellArg($this->getDirectory().'/'.$this->getFileName())." ".
                         ilUtil::escapeShellArg($this->getDirectory().'/'.'1.zip'));

                return $this->getDirectory().'/1.zip';
        }
        
        function addNewsNotification($a_lang_var)
        {
                // BEGIN WebDAV Suppress news notification for hidden files
                if ($this->isHidden()) {
                        return;
                }
                // END WebDAV Suppress news notification for hidden files
                
                global $ilUser;
                
                // Add Notification to news
                include_once("./Services/News/classes/class.ilNewsItem.php");
                include_once("./Modules/File/classes/class.ilObjFileAccess.php");
                $news_item = new ilNewsItem();
                $news_item->setContext($this->getId(), $this->getType());
                $news_item->setPriority(NEWS_NOTICE);
                $news_item->setTitle($a_lang_var);
                $news_item->setContentIsLangVar(true);
                if ($this->getDescription() != "")
                {
                        $news_item->setContent(
                                "<p>".
                                $this->getDescription()."</p>");
                }
                $news_item->setUserId($ilUser->getId());
                $news_item->setVisibility(NEWS_USERS);
                $news_item->create();
        }
        
        public function initFileStorage()
        {
                $this->file_storage = new ilFSStorageFile($this->getId());
                return true;
        }
        function storeUnzipedFile($a_upload_file, $a_filename)
                {
                        $this->setVersion($this->getVersion() + 1);

                        if (@!is_dir($this->getDirectory($this->getVersion())))
                        {
                                ilUtil::makeDir($this->getDirectory($this->getVersion()));
                        }

                        $file = $this->getDirectory($this->getVersion())."/".$a_filename;
                        //move_uploaded_file($a_upload_file, $file);
                        rename($a_upload_file,  $file);
        }
        
        public static function _lookupAbsolutePath ($obj_id, $a_version = null) 
        {
                $file_storage = new ilFSStorageFile($obj_id);
                $filename = ilObjFile::_lookupFileName($obj_id);
                $version_subdir = "";
                
                if (!is_numeric($a_version))
                {
                        $a_version = ilObjFile::_lookupVersion ($obj_id);
                }
                $version_subdir = DIRECTORY_SEPARATOR.sprintf("%03d", $a_version);              
                return $file_storage->getAbsolutePath().$version_subdir.DIRECTORY_SEPARATOR.$filename;
        }


} // END class.ilObjFile
?>