ilRestFileStorage Class Reference

File storage handling. More...

Inheritance diagram for ilRestFileStorage:

Collaboration diagram for ilRestFileStorage:

Public Member Functions
	__construct ()
	Constructor. More...
	getFile ($name)
	Get file by md5 hash. More...
	createFile ()
	Get file by md5 hash. More...
	storeFileForRest ($content)
	getStoredFilePath ($tmpname)
	deleteDeprecated ()
	Delete deprecated files. More...
Public Member Functions inherited from ilFileSystemStorage
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...
	getContainerId ()
	create ()
	Create directory. More...
	getAbsolutePath ()
	Get absolute path of storage directory. More...
	writeToFile ($a_data, $a_absolute_path)
	Write data to file. More...
	deleteFile ($a_abs_name)
	Delete file. More...
	deleteDirectory ($a_abs_name)
	Delete directory. More...
	delete ()
	Delete complete directory. More...
	copyFile ($a_from, $a_to)
	Copy files. More...
	appendToPath ($a_appendix)
	getStorageType ()
	getPath ()
	Get path. More...
	__construct ($a_storage_type, $a_path_conversion, $a_container_id)
	Constructor. More...
	create ()
	Create directory. More...
	getAbsolutePath ()
	Get absolute path of storage directory. More...
	getShortPath ()
	rename ($from, $to)

Data Fields
const	AVAILABILITY_IN_DAYS = 1
Data Fields inherited from ilFileSystemStorage
const	STORAGE_WEB = 1
const	STORAGE_DATA = 2
const	STORAGE_SECURED = 3
const	FACTOR = 100
const	MAX_EXPONENT = 3
const	SECURED_DIRECTORY = "sec"

Protected Member Functions
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get path prefix. More...
	init ()
	init and create directory More...
	responeNotFound ()
	Send not found response. More...
Protected Member Functions inherited from ilFileSystemStorage
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...
	init ()
	Read path info. More...
	getPathPrefix ()
	Get path prefix. More...
	getPathPostfix ()
	Get directory name. More...

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemStorage
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...
	_copyDirectory ($a_source, $a_target)
	Copy directory and all contents. More...
static	_createPathFromId ($a_container_id, $a_name)
	Create a path from an id: e.g 12345 will be converted to 12/34/<name>_5. More...
Protected Attributes inherited from ilFileSystemStorage
	$path

Detailed Description

File storage handling.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e $Id$

Definition at line 12 of file class.ilRestFileStorage.php.

Constructor & Destructor Documentation

__construct()

ilRestFileStorage::__construct

(

)

Constructor.

Definition at line 20 of file class.ilRestFileStorage.php.

References ilFileSystemStorage\STORAGE_DATA.

        {
                parent::__construct(
                        ilFileSystemStorage::STORAGE_DATA,
                        false,
                        0
                );
        }

Member Function Documentation

createFile()

ilRestFileStorage::createFile

(

)

Get file by md5 hash.

Parameters

<type>

$name

Definition at line 104 of file class.ilRestFileStorage.php.

References $GLOBALS, ilFileSystemStorage\$path, Slim\getInstance(), ilFileSystemStorage\getPath(), ilUtil\ilTempnam(), and ilFileSystemStorage\writeToFile().

        {
                $request = Slim::getInstance()->request();
                $body = $request->post("content");

                $tmpname = ilUtil::ilTempnam();
                $path = $this->getPath().'/'.basename($tmpname);

                $this->writeToFile($body, $path);
                $return = basename($tmpname);

                $GLOBALS['ilLog']->write(__METHOD__.' Writing to path '.$path);

                Slim::getInstance()->response()->header('Content-Type', 'application/json');
                Slim::getInstance()->response()->body($return);
        }

Here is the call graph for this function:

deleteDeprecated()

ilRestFileStorage::deleteDeprecated

(

)

Delete deprecated files.

Definition at line 138 of file class.ilRestFileStorage.php.

References $file, $GLOBALS, and ilFileSystemStorage\getPath().

        {
                $max_age = time() - self::AVAILABILITY_IN_DAYS * 24 * 60 * 60;
                $ite = new DirectoryIterator($this->getPath());
                foreach($ite as $file)
                {
                        if($file->getCTime() <= $max_age)
                        {
                                try {
                                        @unlink($file->getPathname());
                                }
                                catch(Exception $e) {
                                        $GLOBALS['ilLog']->write(__METHOD__.' '. $e->getMessage());
                                }
                        }
                }
        }

Here is the call graph for this function:

getFile()

ilRestFileStorage::getFile

(

$name

)

Get file by md5 hash.

Parameters

<type>

$name

Definition at line 58 of file class.ilRestFileStorage.php.

References $GLOBALS, Slim\getInstance(), ilFileSystemStorage\getPath(), and responeNotFound().

        {
                $GLOBALS['ilLog']->write(__METHOD__.' original name: '.$this->getPath().'/'.$name);
                
                $real_path = realpath($this->getPath().'/'.$name);
                if(!$real_path)
                {
                        $GLOBALS['ilLog']->write(__METHOD__.' no realpath found for: '.$this->getPath().'/'.$name);
                        $this->responeNotFound();
                        return;
                }
                $file_name = basename($real_path);
                $GLOBALS['ilLog']->write(__METHOD__.' translated name: '.$this->getPath().'/'.$file_name);
                if(
                        $file_name &&
                        is_file($this->getPath().'/'.$file_name) && 
                        file_exists($this->getPath().'/'.$file_name)
                )
                {
                        $GLOBALS['ilLog']->write(__METHOD__.' delivering file: ' . $this->getPath().'/'.$file_name);
                        $return = file_get_contents($this->getPath().'/'.$file_name);
                        // Response header
                        Slim::getInstance()->response()->header('Content-Type', 'application/json');
                        Slim::getInstance()->response()->body($return);
                        return;
                }
                
                $this->responeNotFound();
        }

Here is the call graph for this function:

getPathPostfix()

ilRestFileStorage::getPathPostfix ( )

protected

Get path prefix.

Definition at line 40 of file class.ilRestFileStorage.php.

        {
                return 'files';
        }

getPathPrefix()

ilRestFileStorage::getPathPrefix ( )

protected

Get path prefix.

Definition at line 32 of file class.ilRestFileStorage.php.

        {
                return 'ilRestFileStorage';
        }

getStoredFilePath()

ilRestFileStorage::getStoredFilePath

(

$tmpname

)

Definition at line 130 of file class.ilRestFileStorage.php.

References ilFileSystemStorage\getPath().

        {
                return $this->getPath().'/'.$tmpname;
        }

Here is the call graph for this function:

init()

ilRestFileStorage::init ( )

protected

init and create directory

Definition at line 48 of file class.ilRestFileStorage.php.

References ilFileSystemStorage\create().

        {
                parent::init();
                $this->create();
        }

Here is the call graph for this function:

responeNotFound()

ilRestFileStorage::responeNotFound ( )

protected

Send not found response.

Definition at line 92 of file class.ilRestFileStorage.php.

References $GLOBALS, and Slim\getInstance().

Referenced by getFile().

        {
                $GLOBALS['ilLog']->write(__METHOD__.' file not found.');
                Slim::getInstance()->response()->header('Content-Type','text/html');
                Slim::getInstance()->response()->status(404);
                Slim::getInstance()->response()->body('Not found');
        }

Here is the call graph for this function:

Here is the caller graph for this function:

storeFileForRest()

ilRestFileStorage::storeFileForRest

(

$content

)

Definition at line 121 of file class.ilRestFileStorage.php.

References ilFileSystemStorage\$path, ilFileSystemStorage\getPath(), ilUtil\ilTempnam(), and ilFileSystemStorage\writeToFile().

        {
                $tmpname = ilUtil::ilTempnam();
                $path = $this->getPath().'/'.basename($tmpname);

                $this->writeToFile($content, $path);
                return basename($tmpname);
        }

Here is the call graph for this function:

Field Documentation

AVAILABILITY_IN_DAYS

const ilRestFileStorage::AVAILABILITY_IN_DAYS = 1

Definition at line 14 of file class.ilRestFileStorage.php.

---

The documentation for this class was generated from the following file:

• Services/WebServices/Rest/classes/class.ilRestFileStorage.php