File storage handling. More...

Inheritance diagram for ilRestFileStorage:

Collaboration diagram for ilRestFileStorage:

Public Member Functions
	__construct ()
	Constructor. More...

	getFile (\Slim\Http\Request $request, \Slim\Http\Response $response)

	createFile (\Slim\Http\Request $request, \Slim\Http\Response $response)
	Create new file from post. 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
	checkWebserviceActivation (\Slim\Http\Request $request, \Slim\Http\Response $response)

	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get path prefix. More...

	init ()
	init and create directory More...

	responeNotFound (\Slim\Http\Response $response)
	Send 403. 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...

Private Attributes
	$logger = null

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...

static	_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 25 of file class.ilRestFileStorage.php.

References $DIC, and ilFileSystemStorage\STORAGE_DATA.

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->wsrv();
         $this->logger->logStack();
 
         parent::__construct(
             ilFileSystemStorage::STORAGE_DATA,
             false,
             0
         );
     }

Member Function Documentation

◆ checkWebserviceActivation()

ilRestFileStorage::checkWebserviceActivation	(	\Slim\Http\Request	$request,
		\Slim\Http\Response	$response
	)

protected

Parameters

\Slim\Http\Request	$request
\Slim\Http\Response	$response

Returns: | null $response

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

References $DIC, and $response.

Referenced by createFile(), and getFile().

     {
         global $DIC;
 
         $settings = $DIC->settings();
         if (!$settings->get('soap_user_administration', 0)) {
             $this->logger->warning('Webservices disabled in administration.');
 
             $response = $response
                 ->withHeader('Content-Type', 'text/html')
                 ->withStatus(\Slim\Http\StatusCode::HTTP_FORBIDDEN)
                 ->write('Webservice not enabled.');
             return $response;
         }
         return null;
     }

Here is the caller graph for this function:

◆ createFile()

ilRestFileStorage::createFile	(	\Slim\Http\Request	$request,
		\Slim\Http\Response	$response
	)

Create new file from post.

Parameters

\Slim\Http\Request	$request
\Slim\Http\Response	$response

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

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

     {
         $failure = $this->checkWebserviceActivation($request, $response);
         if ($failure instanceof \Slim\Http\Response) {
             return $failure;
         }
 
         $request_body = $request->getParam('content');
 
         $tmpname = ilUtil::ilTempnam();
         $path = $this->getPath() . '/' . basename($tmpname);
 
         $this->writeToFile($request_body, $path);
         $return = basename($tmpname);
 
         $response = $response
             ->withHeader('ContentType', 'application/json')
             ->write($return);
 
         return $response;
     }

Here is the call graph for this function:

◆ deleteDeprecated()

ilRestFileStorage::deleteDeprecated ( )

Delete deprecated files.

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

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

     {
         $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) {
                     $this->logger->warning($e->getMessage());
                 }
             }
         }
     }

Here is the call graph for this function:

◆ getFile()

ilRestFileStorage::getFile	(	\Slim\Http\Request	$request,
		\Slim\Http\Response	$response
	)

Parameters

\Slim\Http\Request	$request
\Slim\Http\Response	$response

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

References $failure, $response, checkWebserviceActivation(), ilFileSystemStorage\getPath(), and responeNotFound().

     {
         $failure = $this->checkWebserviceActivation($request, $response);
         if ($failure instanceof \Slim\Http\Response) {
             return $failure;
         }
 
 
         $file_id = $request->getParam('name');
 
         $this->logger->debug('Original file name: ' . $file_id);
 
         $real_path = realpath($this->getPath() . '/' . $file_id);
         if (!$real_path) {
             $this->logger->warning('No realpath found for ' . $this->getPath() . '/' . $file_id);
             return $this->responeNotFound($response);
         }
         $file_name = basename($real_path);
         $this->logger->debug('Translated name: ' . $this->getPath() . '/' . $file_name);
         if (
             $file_name &&
             is_file($this->getPath() . '/' . $file_name) &&
             file_exists($this->getPath() . '/' . $file_name)
         ) {
             $this->logger->info('Delivering file: ' . $this->getPath() . '/' . $file_name);
             $return = file_get_contents($this->getPath() . '/' . $file_name);
 
             $this->logger->dump($return);
 
             $response = $response
                 ->withStatus(\Slim\Http\StatusCode::HTTP_OK)
                 ->withHeader('Content-Type', 'application/json')
                 ->write($return);
             return $response;
         }
         $this->responeNotFound($response);
     }

Here is the call graph for this function:

◆ getPathPostfix()

ilRestFileStorage::getPathPostfix ( )

protected

Get path prefix.

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

     {
         return 'files';
     }

◆ getPathPrefix()

ilRestFileStorage::getPathPrefix ( )

protected

Get path prefix.

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

     {
         return 'ilRestFileStorage';
     }

◆ getStoredFilePath()

ilRestFileStorage::getStoredFilePath ( $tmpname )

Parameters

$tmpname

Returns: string

Definition at line 185 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 80 of file class.ilRestFileStorage.php.

References ilFileSystemStorage\create().

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

Here is the call graph for this function:

◆ responeNotFound()

ilRestFileStorage::responeNotFound ( \Slim\Http\Response $response )

protected

Send 403.

Parameters

\Slim\Http\Response $response

Returns: $response

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

Referenced by getFile().

     {
         return $response
             ->withHeader('Content-Type', 'text/html')
             ->withStatus(\Slim\Http\StatusCode::HTTP_NOT_FOUND)
             ->write('File not found');
     }

Here is the caller graph for this function:

◆ storeFileForRest()

ilRestFileStorage::storeFileForRest ( $content )

Definition at line 172 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

◆ $logger

ilRestFileStorage::$logger = null

private

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

◆ 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

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkWebserviceActivation()

◆ createFile()

◆ deleteDeprecated()

◆ getFile()

◆ getPathPostfix()

◆ getPathPrefix()

◆ getStoredFilePath()

◆ init()

◆ responeNotFound()

◆ storeFileForRest()

Field Documentation

◆ $logger

◆ AVAILABILITY_IN_DAYS