class.ilObjFile.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
 
require_once("Services/Object/classes/class.ilObject2.php");
require_once('Modules/File/classes/class.ilFSStorageFile.php');
 
class ilObjFile extends ilObject2 {
 
        var $filename;
        var $filetype;
        var $filemaxsize = "20000000";  // not used yet
        var $raise_upload_error;
        var $mode = "object";
        protected $rating = false;
        
        private $file_storage = null;
        protected $log = null;
 
 
        public function __construct($a_id = 0, $a_call_by_reference = true) {
                $this->version = 0;
                $this->raise_upload_error = true;
 
                $this->log = ilLoggerFactory::getLogger('file');
 
                parent::__construct($a_id,$a_call_by_reference);
                
                if($this->getId())
                {
                        $this->initFileStorage();
                }
        }
 
        function initType()
        {
                $this->type = "file";
        }
 
        protected function doCreate($a_upload = false)
        {
                //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.   
        }
        
        //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("./Services/History/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());
                }
 
                // log creation
                include_once("./Services/Utilities/classes/class.ilStr.php");
                $this->log->debug("ilObjFile::createProperties, ID: ".$this->getId().
                        ", Name: ".$this->getFileName().
                        ", Type: ".$this->getFileType().
                        ", Size: ".$this->getFileSize().
                        ", Mode: ".$this->getMode().
                        ", Name(Bytes): ".implode(":", ilStr::getBytesForString($this->getFileName()))
                );
                $this->log->logStack(ilLogLevel::DEBUG);
 
                $q = "INSERT INTO file_data (file_id,file_name,file_type,file_size,version,f_mode) "
                        ."VALUES (".$ilDB->quote($this->getId() ,'integer').","
                        .$ilDB->quote($this->getFileName() ,'text').","
                        .$ilDB->quote($this->getFileType() ,'text').","
                        .$ilDB->quote((int) $this->getFileSize() ,'integer').","
                        .$ilDB->quote(1 ,'integer').",".$ilDB->quote($this->getMode() ,'text').")";
                $res = $ilDB->manipulate($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.
        
        public function setNoMetaDataCreation($a_status)
        {
                $this->no_meta_data_creation = (bool)$a_status;
        }
        
        protected function beforeCreateMetaData()
        {
                return !(bool)$this->no_meta_data_creation;
        }
        
        protected function beforeUpdateMetaData()
        {
                return !(bool)$this->no_meta_data_creation;
        }
        
        protected function doCreateMetaData()
        {
                // 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();
        }
 
        protected function beforeMDUpdateListener($a_element)
        {
                // Check file extension
                // Removing the file extension is not allowed
                include_once 'Services/MetaData/classes/class.ilMD.php';
                $md = new ilMD($this->getId(),0, $this->getType());
                if(!is_object($md_gen = $md->getGeneral()))
                {
                        return false;
                }
                $title = $this->checkFileExtension($this->getFileName(), $md_gen->getTitle());
                $md_gen->setTitle($title);
                $md_gen->update();
                return true;
        }
 
        protected function doMDUpdateListener($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;
                }
                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, $a_prevent_preview = false, $handle_secure_name = true)
        {
                if ($handle_secure_name) {
                        require_once('./Services/Utilities/classes/class.ilFileUtils.php');
                        $a_filename = ilFileUtils::getValidFilename($a_filename);
                        $this->setFileName($a_filename);
                        //if no title for the file was set use the filename as title
                        if(empty($this->getTitle())) {
                                $this->setTitle($a_filename);
                        }
                        $this->update();
                }
                if($this->version) {
                        $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;
                ilUtil::moveUploadedFile($a_upload_file, $a_filename, $file, $this->raise_upload_error);
 
                $this->handleQuotaUpdate($this);
                
                // create preview?
                if (!$a_prevent_preview)
                {
                        $this->createPreview(false);
                }                       
        }
 
        function replaceFile($a_upload_file, $a_filename)
        {
                $this->getUploadFile($a_upload_file, $a_filename, true);
                
                require_once("./Services/History/classes/class.ilHistory.php");
                ilHistory::_createEntry(
                        $this->getId(),
                        "replace",
                        $a_filename.",".$this->getVersion()
                );
                $this->setFilename($a_filename);
                $this->addNewsNotification("file_updated");
                
                // create preview
                $this->createPreview(true);
        }
        
        
        public function addFileVersion($a_upload_file,$a_filename)
        {
                $this->getUploadFile($a_upload_file, $a_filename, true);
                
                require_once("./Services/History/classes/class.ilHistory.php");
                ilHistory::_createEntry(
                        $this->getId(),
                        "new_version",
                        $a_filename.",".$this->getVersion()
                );
                $this->setFilename($a_filename);
                $this->addNewsNotification("file_updated");
                                
                // create preview
                $this->createPreview($this->getVersion() > 1);
        }
 
 
        function copy($a_source,$a_destination)
        {
                return copy($a_source,$this->getDirectory()."/".$a_destination);
        }
        
        function clearDataDirectory()
        {
                ilUtil::delDir($this->getDirectory());
                $this->createDirectory();
        }
        
        public function deleteVersions($a_hist_entry_ids = null)
        {
                global $ilDB;
                
                require_once("./Services/History/classes/class.ilHistory.php");
                
                if ($a_hist_entry_ids == null || count($a_hist_entry_ids) < 1)
                {
                        $ilDB->manipulate("UPDATE file_data SET version = 1 WHERE file_id = ".$ilDB->quote($this->getId() ,'integer'));
                        $this->setVersion(0);
                        $this->clearDataDirectory();
                
                        ilHistory::_removeEntriesForObject($this->getId());
                        
                        self::handleQuotaUpdate($this);
                }
                else
                {
                        $actualVersionDeleted = false;
                        
                        // get all versions
                        $versions = $this->getVersions();
                        
                        // delete each version
                        foreach ($a_hist_entry_ids as $hist_id)
                        {
                                $entry = null;
                                
                                // get version
                                foreach ($versions as $index => $version)
                                {
                                        if ($version["hist_entry_id"] == $hist_id)      
                                        {
                                                // remove each history entry
                                                ilHistory::_removeEntryByHistoryID($hist_id);
                                
                                                // delete directory                             
                                                $version_dir = $this->getDirectory($version["version"]);
                                                ilUtil::delDir($version_dir);
                                                
                                                // is actual version?
                                                if ($version["version"] == $this->getVersion())
                                                        $actualVersionDeleted = true;
                                                
                                                // remove from array
                                                unset($versions[$index]);                                               
                                                break;
                                        }
                                }
                        }
                        
                        // update actual version if it was deleted before
                        if ($actualVersionDeleted)
                        {                       
                                // get newest version (already sorted by getVersions) 
                                $version = reset($versions);
                                $this->updateWithVersion($version);
                        }
                        else
                        {
                                // updateWithVersion() will trigger quota, too
                                self::handleQuotaUpdate($this);
                        }
                }                               
        }
 
        protected function doRead()
        {
                global $ilDB;
                
                $q = "SELECT * FROM file_data WHERE file_id = ".$ilDB->quote($this->getId() ,'integer');
                $r = $this->ilias->db->query($q);
                $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
                $this->setFileName($row->file_name);
                $this->setFileType($row->file_type);
                $this->setFileSize($row->file_size);
                $this->setVersion($row->version);
                $this->setMode($row->f_mode);
                $this->setRating($row->rating);
                
                $this->initFileStorage();
        }
 
        protected function beforeUpdate()
        {
                // no meta data handling for file list files
                if ($this->getMode() != "filelist")
                {
                        $this->updateMetaData();
                }
                
                return true;
        }
 
        protected function doUpdate()
        {
                global $ilDB, $ilLog;
                
                //$ilLog->write(__METHOD__.' File type: '.$this->getFileType());
                
                $q = "UPDATE file_data SET file_name = ".$ilDB->quote($this->getFileName() ,'text').
                        ", file_type = ".$ilDB->quote($this->getFiletype() ,'text')." ".
                        ", file_size = ".$ilDB->quote((int) $this->getFileSize() ,'integer')." ".
                        ", version = ".$ilDB->quote($this->getVersion() ,'integer')." ".
                        ", f_mode = ".$ilDB->quote($this->getMode() ,'text')." ".
                        ", rating = ".$ilDB->quote($this->hasRating() ,'integer')." ".
                        "WHERE file_id = ".$ilDB->quote($this->getId() ,'integer');
                $res = $ilDB->manipulate($q);
                
                self::handleQuotaUpdate($this);
                
                return true;
        }
        
        protected function doUpdateMetaData()
        {
                // 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;
        }
        function getDiskUsage()
        {
            require_once("./Modules/File/classes/class.ilObjFileAccess.php");
                return ilObjFileAccess::_lookupDiskUsage($this->id);
        }
 
 
        // 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("./Services/History/classes/class.ilHistory.php");
                        $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
                        
                        if ($entry === false)
                        {
                                return false;
                        }
 
                        $data = $this->parseInfoParams($entry);
                        $file = $this->getDirectory($data["version"])."/".$data["filename"];
                }
                return $file;
        }
        // END PATCH WebDAV Encapsulate file access in ilObjFile class.
        
        function setVersion($a_version)
        {
                $this->version = $a_version;
        }
 
        function getVersion()
        {
                return $this->version ? $this->version : 1;
        }
        
        function setMode($a_mode)
        {
                $this->mode = $a_mode;
        }
 
        function getMode()
        {
                return $this->mode;
        }
 
        static function _writeFileType($a_id ,$a_format)
        {
                global $ilDB;
                
                $q = "UPDATE file_data SET ".
                        " file_type = ".$ilDB->quote($a_format ,'text').
                        " WHERE file_id = ".$ilDB->quote($a_id ,'integer');
                $res = $ilDB->manipulate($q);
                
        }
 
        static function _lookupFileName($a_id)
        {
                global $ilDB;
 
                $q = "SELECT * FROM file_data WHERE file_id = ".$ilDB->quote($a_id ,'integer');
                $r = $ilDB->query($q);
                $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
 
                return ilUtil::stripSlashes($row->file_name);
        }
 
 
        static function _lookupFileSize($a_id)
        {
            require_once("./Modules/File/classes/class.ilObjFileAccess.php");
                return ilObjFileAccess::_lookupFileSize($a_id);
        }
        
        static function _lookupVersion($a_id)
        {
                require_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("./Services/History/classes/class.ilHistory.php");
                        $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
                        
                        if ($entry === false)
                        {
                                return false;
                        }
 
                        $data = $this->parseInfoParams($entry);
                        $file = $this->getDirectory($data["version"])."/".$data["filename"];
                }
                if (is_file($file))
                {
                        $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("./Services/History/classes/class.ilHistory.php");
                        $entry = ilHistory::_getEntryByHistoryID($a_hist_entry_id);
                        
                        if ($entry === false)
                        {
                                echo "3";return false;
                        }
 
                        $data = $this->parseInfoParams($entry);
                        $file = $this->getDirectory($data["version"])."/".$data["filename"];
                        
                        // 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))
                {
                        global $ilClientIniFile;
                        require_once('./Services/FileDelivery/classes/class.ilFileDelivery.php');
 
                        $ilFileDelivery = new ilFileDelivery($file);
                        $ilFileDelivery->setDisposition($this->isInline() ? ilFileDelivery::DISP_INLINE : ilFileDelivery::DISP_ATTACHMENT);
                        $ilFileDelivery->setMimeType($this->guessFileType($file));
                        $ilFileDelivery->setConvertFileNameToAsci(true);
 
                        // also returning the 'real' filename if a history file is delivered
                        if ($ilClientIniFile->readVariable('file_access', 'download_with_uploaded_filename') != '1' && is_null($a_hist_entry_id)) {
                                $ilFileDelivery->setDownloadFileName($this->getTitle());
                        } else {
                                // $download_file_name = basename($file);
                                /* FSX Info: basename has a Bug with Japanese and other characters, see:
                                 * http://stackoverflow.com/questions/32115609/basename-fail-when-file-name-start-by-an-accent
                                 * Therefore we can no longer use basename();
                                 */
                                $parts = explode(DIRECTORY_SEPARATOR, $file);
                                $download_file_name = end($parts);
                                $ilFileDelivery->setDownloadFileName($download_file_name);
                        }
                        $ilFileDelivery->deliver();
 
                        return true;
                }
 
                return false;
        }
 
        // BEGIN WebDAV: Get file extension, determine if file is inline, guess file type.
        function getFileExtension() {
                require_once 'Modules/File/classes/class.ilObjFileAccess.php';
                return ilObjFileAccess::_getFileExtension($this->getTitle());
        }
        function isInline() {
                require_once 'Modules/File/classes/class.ilObjFileAccess.php';
                return ilObjFileAccess::_isFileInline($this->getTitle());
        }
        function isHidden() {
                require_once 'Modules/File/classes/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;
*/
        }
        
        protected function doCloneObject($a_new_obj,$a_target_id,$a_copy_id = 0)
        {
                global $ilDB;
 
                $a_new_obj->createDirectory();
                $this->cloneMetaData($a_new_obj);
                
                // Copy all file versions
                ilUtil::rCopy($this->getDirectory(),$a_new_obj->getDirectory());
                
                // object created now copy other settings
                $query = "INSERT INTO file_data (file_id,file_name,file_type,file_size,version,rating,f_mode) VALUES (".
                                $ilDB->quote($a_new_obj->getId() ,'integer').",".
                                $ilDB->quote($this->getFileName() ,'text').",".
                                $ilDB->quote($this->getFileType() ,'text').",".
                                $ilDB->quote((int) $this->getFileSize() ,'integer').", ".
                                $ilDB->quote($this->getVersion() ,'integer').", ".
                                $ilDB->quote($this->hasRating() ,'integer').", ".
                                $ilDB->quote($this->getMode() ,'text').")";
                $res = $ilDB->manipulate($query);
                 
                // copy all previews
                require_once("./Services/Preview/classes/class.ilPreview.php");
                ilPreview::copyPreviews($this->getId(), $a_new_obj->getId());
 
                // copy history entries
                require_once("./Services/History/classes/class.ilHistory.php");
                ilHistory::_copyEntriesForObject($this->getId(),$a_new_obj->getId());
                
                // Copy learning progress settings
                include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
                $obj_settings = new ilLPObjSettings($this->getId());
                $obj_settings->cloneSettings($a_new_obj->getId());
                unset($obj_settings);
                
                // add news notification
                $a_new_obj->addNewsNotification("file_created");
 
                return $a_new_obj;
        }
        
        protected function beforeDelete()
        {
                global $ilDB;
                
                // check, if file is used somewhere
                $usages = $this->getUsages();
                if (count($usages) == 0)
                {
                        return true;
                }
                return false;
        }
 
        protected function doDelete()
        {
                global $ilDB;
                
                // delete file data entry
                $q = "DELETE FROM file_data WHERE file_id = ".$ilDB->quote($this->getId() ,'integer');
                $this->ilias->db->query($q);
 
                // delete history entries
                require_once("./Services/History/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();
                }
                
                self::handleQuotaUpdate($this);
 
                // delete preview
                $this->deletePreview();
        }
 
        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);
        }
 
        static function _deleteAllUsages($a_type, $a_id, $a_usage_hist_nr = 0, $a_usage_lang = "-")
        {
                global $ilDB;
                
                $and_hist = ($a_usage_hist_nr !== false)
                        ? " AND usage_hist_nr = ".$ilDB->quote($a_usage_hist_nr, "integer")
                        : "";
                
                $file_ids = array();
                $set = $ilDB->query("SELECT id FROM file_usage".
                        " WHERE usage_type = ".$ilDB->quote($a_type, "text").
                        " AND usage_id= ".$ilDB->quote($a_id, "integer").
                        " AND usage_lang= ".$ilDB->quote($a_usage_lang, "text").
                        $and_hist);
                while($row = $ilDB->fetchAssoc($set))
                {
                        $file_ids[] = $row["id"];
                }
                
                $ilDB->manipulate("DELETE FROM file_usage WHERE usage_type = ".
                        $ilDB->quote($a_type, "text").
                        " AND usage_id = ".$ilDB->quote((int) $a_id, "integer").
                        " AND usage_lang= ".$ilDB->quote($a_usage_lang, "text").
                        " AND usage_hist_nr = ".$ilDB->quote((int) $a_usage_hist_nr, "integer"));
                
                foreach($file_ids as $file_id)
                {
                        self::handleQuotaUpdate(new self($file_id, false));     
                }
        }
 
        static function _saveUsage($a_file_id, $a_type, $a_id, $a_usage_hist_nr = 0, $a_usage_lang = "-")
        {
                global $ilDB;
 
                // check if file really exists
                if (ilObject::_lookupType($a_file_id) != "file")
                {
                        return;
                }
                // #15143
                $ilDB->replace("file_usage",
                        array(
                                "id" => array("integer", (int) $a_file_id),
                                "usage_type" => array("text", (string) $a_type),
                                "usage_id" => array("integer", (int) $a_id),
                                "usage_hist_nr" => array("integer", (int) $a_usage_hist_nr),
                                "usage_lang" => array("text", $a_usage_lang)
                        ),
                        array()
                );
                
                self::handleQuotaUpdate(new self($a_file_id, false));           
        }
 
        function getUsages()
        {
                global $ilDB;
 
                // get usages in learning modules
                $q = "SELECT * FROM file_usage WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $us_set = $ilDB->query($q);
                $ret = array();
                while($us_rec = $ilDB->fetchAssoc($us_set))
                {
                        $ret[] = array("type" => $us_rec["usage_type"],
                                "id" => $us_rec["usage_id"],
                                "lang" => $us_rec["usage_lang"],
                                "hist_nr" => $us_rec["usage_hist_nr"]);
                }
 
                return $ret;
        }
 
        static function _getFilesOfObject($a_type, $a_id, $a_usage_hist_nr = 0, $a_usage_lang = "-")
        {
                global $ilDB;
 
                $lstr = "";
                if ($a_usage_lang != "")
                {
                        $lstr = "usage_lang = ".$ilDB->quote((string) $a_usage_lang, "text")." AND ";
                }
 
                // get usages in learning modules
                $q = "SELECT * FROM file_usage WHERE ".
                        "usage_id = ".$ilDB->quote((int) $a_id, "integer")." AND ".
                        "usage_type = ".$ilDB->quote((string) $a_type, "text")." AND ".
                        $lstr.
                        "usage_hist_nr = ".$ilDB->quote((int) $a_usage_hist_nr, "integer");
                $file_set = $ilDB->query($q);
                $ret = array();
                while($file_rec = $ilDB->fetchAssoc($file_set))
                {
                        $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)
                {
                        if($this->version) {
                                $this->setVersion($this->version + 1);
                        }
 
                        if (@!is_dir($this->getDirectory($this->getVersion())))
                        {
                                ilUtil::makeDir($this->getDirectory($this->getVersion()));
                        }
 
                        $file = $this->getDirectory($this->getVersion())."/".$a_filename;
                        require_once('./Services/Utilities/classes/class.ilFileUtils.php');
                        ilFileUtils::rename($a_upload_file,  $file);
                        
                        // create preview
                        $this->createPreview();
        }
        
        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;
        }
        
        public function checkFileExtension($new_filename,$new_title)
        {
                include_once './Modules/File/classes/class.ilObjFileAccess.php';
                $fileExtension = ilObjFileAccess::_getFileExtension($new_filename);
                $titleExtension = ilObjFileAccess::_getFileExtension($new_title);
                if ($titleExtension != $fileExtension && strlen($fileExtension) > 0)
                {
                        // remove old extension
                        $pi = pathinfo($this->getFileName());
                        $suffix = $pi["extension"];
                        if ($suffix != "")
                        { 
                                if (substr($new_title,
                                        strlen($new_title) - strlen($suffix) - 1)
                                        == ".".$suffix)
                                {
                                        $new_title = substr($new_title, 0, strlen($new_title) - strlen($suffix) - 1);
                                }
                        }
                        $new_title .= '.'.$fileExtension;
                }
                return $new_title;
        }
        
        public function getVersions($version_ids = null)
        {
                include_once("./Services/History/classes/class.ilHistory.php");
                $versions = ilHistory::_getEntriesForObject($this->getId(), $this->getType());
                
                if ($version_ids != null && count($version_ids) > 0)
                {
                        foreach ($versions as $index => $version) 
                        {
                                if (!in_array($version["hist_entry_id"], $version_ids, true))
                                {
                                        unset($versions[$index]);
                                }
                        }               
                }
                
                // add custom entries
                foreach ($versions as $index => $version) 
                {
                        $params = $this->parseInfoParams($version);
                        $versions[$index] = array_merge($version, $params);
                }
                
                // sort by version number (hist_entry_id will do for that)
                usort($versions, array($this, "compareVersions"));
                
                return $versions;
        }
        
        public function getSpecificVersion($version_id)
        {
                include_once("./Services/History/classes/class.ilHistory.php");
                $version = ilHistory::_getEntryByHistoryID($version_id);
                if ($version === false)
                        return false;
                
                // ilHistory returns different keys in _getEntryByHistoryID and _getEntriesForObject
                // so this makes it the same
                $version["hist_entry_id"] = $version["id"];
                $version["user_id"] = $version["usr_id"];
                $version["date"] = $version["hdate"];
                unset($version["id"], $version["usr_id"], $version["hdate"]);
                
                // parse params
                $params = $this->parseInfoParams($version);
                return array_merge($version, $params);
        }
        
        public function rollback($version_id)
        {
                global $ilDB, $ilUser;
                
                $source = $this->getSpecificVersion($version_id);
                if ($source === false)
                {
                        $this->ilErr->raiseError($this->lng->txt("obj_not_found"), $this->ilErr->MESSAGE);
                }
                
                // get the new version number
                $new_version_nr = $this->getVersion() + 1;
                
                // copy file 
                $source_path = $this->getDirectory($source["version"]) . "/" . $source["filename"];
                $dest_dir = $this->getDirectory($new_version_nr);
                if (@!is_dir($dest_dir))
                        ilUtil::makeDir($dest_dir);
 
                copy($source_path, $dest_dir . "/" . $source["filename"]);
                
                // create new history entry based on the old one
                include_once("./Services/History/classes/class.ilHistory.php");
                ilHistory::_createEntry(
                        $this->getId(), 
                        "rollback", 
                        $source["filename"] . "," . $new_version_nr . "|" . $source["version"] . "|" . $ilUser->getId());
                
                // get id of newest entry
                $new_version = $this->getSpecificVersion($ilDB->getLastInsertId());
                
                // change user back to the original uploader
                ilHistory::_changeUserId($new_version["hist_entry_id"], $source["user_id"]);
                
                // update this file with the new version
                $this->updateWithVersion($new_version);
                
                $this->addNewsNotification("file_updated");
                
                return $new_version;
        }
        
        protected function updateWithVersion($version)
        {
                // update title (checkFileExtension must be called before setFileName!)
                $this->setTitle($this->checkFileExtension($version["filename"], $this->getTitle()));
                
                $this->setVersion($version["version"]);
                $this->setFileName($version["filename"]);
                
                // evaluate mime type (reset file type before)
                $this->setFileType("");
                $this->setFileType($this->guessFileType($version["filename"]));
                
                // set filesize
                $this->determineFileSize();
 
                $this->update();        
                
                // refresh preview
                $this->createPreview(true);
        }
        
        function compareVersions($v1, $v2)
        {
                // v2 - v1 because version should be descending
                return (int)$v2["version"] - (int)$v1["version"];
        }
 
        function parseInfoParams($entry)
        {
                $data = preg_split("/(.*),(.*)/", $entry["info_params"], 0, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
                
                // 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";
                
                $result = array("filename" => $data[0], "version" => $data[1], "rollback_version" => "", "rollback_user_id" => "");
 
                // if rollback, the version contains the rollback version as well
                if ($entry["action"] == "rollback")
                {
                        $tokens = explode("|", $result["version"]);
                        if (count($tokens) > 1)
                        {
                                $result["version"] = $tokens[0];
                                $result["rollback_version"] = $tokens[1];
                                
                                if (count($tokens) > 2)
                                        $result["rollback_user_id"] = $tokens[2];
                        }
                }
                
                return $result;
        }
        
        protected static function handleQuotaUpdate(ilObjFile $a_file)
        {                               
                include_once "Services/MediaObjects/classes/class.ilObjMediaObject.php";        
                $mob = new ilObjMediaObject();
                
                // file itself could be workspace item
                $parent_obj_ids = array($a_file->getId());
                
                foreach($a_file->getUsages() as $item)
                {                                                                               
                        $parent_obj_id = $mob->getParentObjectIdForUsage($item);
                        if($parent_obj_id && 
                                !in_array($parent_obj_id, $parent_obj_ids))
                        {                                       
                                $parent_obj_ids[]= $parent_obj_id;
                        }                                               
                }
                
                include_once "Services/DiskQuota/classes/class.ilDiskQuotaHandler.php";
                ilDiskQuotaHandler::handleUpdatedSourceObject($a_file->getType(), 
                        $a_file->getId(),
                        $a_file->getDiskUsage(), 
                        $parent_obj_ids);       
        }
 
        protected function createPreview($force = false)
        {
                // only normal files are supported
                if ($this->getMode() != "object")
                        return;
                
                require_once("./Services/Preview/classes/class.ilPreview.php");
                ilPreview::createPreview($this, $force);
        }
        
        protected function deletePreview()
        {
                // only normal files are supported
                if ($this->getMode() != "object")
                        return;
                
                require_once("./Services/Preview/classes/class.ilPreview.php");
                ilPreview::deletePreview($this->getId());
        }       
        
        public function setRating($a_value)
        {
                $this->rating = (bool)$a_value;
        }
        
        public function hasRating()
        {
                return $this->rating;
        }
 
} // END class.ilObjFile
?>