class.ilFileSystemStorage.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. |
    +-----------------------------------------------------------------------------+
*/

abstract class ilFileSystemStorage
{
    const STORAGE_WEB = 1;
    const STORAGE_DATA = 2;
    const STORAGE_SECURED = 3;
    
    const FACTOR = 100;
    const MAX_EXPONENT = 3;
    const SECURED_DIRECTORY = "sec";
    
    private $container_id;
    private $storage_type;
    private $path_conversion = false;

    protected $path;
    
    public function __construct($a_storage_type, $a_path_conversion, $a_container_id)
    {
        $this->storage_type = $a_storage_type;
        $this->path_conversion = $a_path_conversion;
        $this->container_id = $a_container_id;

        // Get path info
        $this->init();
    }
    
    public function getContainerId()
    {
        return $this->container_id;
    }
    
    public static function _createPathFromId($a_container_id, $a_name)
    {
        $path = array();
        $found = false;
        $num = $a_container_id;
        for ($i = self::MAX_EXPONENT; $i > 0;$i--) {
            $factor = pow(self::FACTOR, $i);
            if (($tmp = (int) ($num / $factor)) or $found) {
                $path[] = $tmp;
                $num = $num % $factor;
                $found = true;
            }
        }

        if (count($path)) {
            $path_string = (implode('/', $path) . '/');
        }
        return $path_string . $a_name . '_' . $a_container_id;
    }
    
    abstract protected function getPathPrefix();
    
    abstract protected function getPathPostfix();
    
    public function create()
    {
        if (!file_exists($this->path)) {
            ilUtil::makeDirParents($this->path);
        }
        return true;
    }
    
    
    public function getAbsolutePath()
    {
        return $this->path;
    }
    
    protected function init()
    {
        switch ($this->storage_type) {
            case self::STORAGE_DATA:
                $this->path = ilUtil::getDataDir();
                break;
                
            case self::STORAGE_WEB:
                $this->path = ilUtil::getWebspaceDir();
                break;
            
            case self::STORAGE_SECURED:
                $this->path = ilUtil::getWebspaceDir();
                $this->path = ilUtil::removeTrailingPathSeparators($this->path);
                $this->path .= '/' . self::SECURED_DIRECTORY;
                break;
        }
        $this->path = ilUtil::removeTrailingPathSeparators($this->path);
        $this->path .= '/';
        
        // Append path prefix
        $this->path .= ($this->getPathPrefix() . '/');
        
        if ($this->path_conversion) {
            $this->path .= self::_createPathFromId($this->container_id, $this->getPathPostfix());
        } else {
            $this->path .= ($this->getPathPostfix() . '_' . $this->container_id);
        }
        return true;
    }
    
    public function writeToFile($a_data, $a_absolute_path)
    {
        if (!$fp = @fopen($a_absolute_path, 'w+')) {
            return false;
        }
        if (@fwrite($fp, $a_data) === false) {
            @fclose($fp);
            return false;
        }
        @fclose($fp);
        return true;
    }
    
    public function deleteFile($a_abs_name)
    {
        if (@file_exists($a_abs_name)) {
            @unlink($a_abs_name);
            return true;
        }
        return false;
    }
    
    public function deleteDirectory($a_abs_name)
    {
        if (@file_exists($a_abs_name)) {
            ilUtil::delDir($a_abs_name);
            return true;
        }
        return false;
    }
    
    
    public function delete()
    {
        return ilUtil::delDir($this->getAbsolutePath());
    }
    
    
    public function copyFile($a_from, $a_to)
    {
        if (@file_exists($a_from)) {
            @copy($a_from, $a_to);
            return true;
        }
        return false;
    }
    
    public static function _copyDirectory($a_source, $a_target)
    {
        return ilUtil::rCopy($a_source, $a_target);
    }
    
    public function appendToPath($a_appendix)
    {
        $this->path .= $a_appendix;
    }
    
    public function getStorageType()
    {
        return $this->storage_type;
    }
    
    public function getPath()
    {
        return $this->path;
    }
}