File storage handling. More...

Inheritance diagram for ilRestFileStorage:

Collaboration diagram for ilRestFileStorage:

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

	getFile (Request $request, Response $response)

	createFile (Request $request, Response $response)
	Create new file from post. More...

	storeFileForRest (string $content)

	getStoredFilePath (string $tmpname)

	deleteDeprecated ()
	Delete deprecated files. More...

	writeToFile ($a_data, $a_absolute_path)

Public Member Functions inherited from ilFileSystemAbstractionStorage
	__construct (int $a_storage_type, bool $a_path_conversion, int $a_container_id)
	Constructor. More...

	fileExists (string $a_absolute_path)

	getContainerId ()

	writeToFile (string $a_data, $a_absolute_path)

	copyFile (string $a_from, string $a_to)

	create ()

	getAbsolutePath ()
	Calculates the full path on the filesystem. More...

	delete ()

	deleteDirectory (string $a_abs_name)

	deleteFile (string $a_abs_name)

	appendToPath (string $a_appendix)

	getStorageType ()

	getPath ()

Protected Member Functions
	checkWebserviceActivation (Request $request, Response $response)

	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

	init ()
	init and create directory More...

	responeNotFound (Response $response)
	Send 403. More...

Protected Member Functions inherited from ilFileSystemAbstractionStorage
	getLegacyFullAbsolutePath (string $relative_path)

	getFileSystemService ()

	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

	getLegacyAbsolutePath ()
	Calculates the absolute filesystem storage location. More...

	init ()

Protected Attributes
ilSetting	$settings

Protected Attributes inherited from ilFileSystemAbstractionStorage
string	$path = null

ILIAS Filesystem Filesystems	$file_system_service

Private Attributes
const	AVAILABILITY_IN_DAYS = 1

	$logger

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemAbstractionStorage
static	createPathFromId (int $a_container_id, string $a_name)

static	_copyDirectory (string $a_sdir, string $a_tdir)

Data Fields inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	STORAGE_SECURED = 3

Detailed Description

File storage handling.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilRestFileStorage::__construct ( )

Constructor.

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\logger(), ILIAS\Repository\settings(), and ilFileSystemAbstractionStorage\STORAGE_DATA.

Here is the call graph for this function:

Member Function Documentation

◆ checkWebserviceActivation()

ilRestFileStorage::checkWebserviceActivation	(	Request	$request,
		Response	$response
	)

protected

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

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

References ILIAS\Repository\logger(), and ILIAS\Repository\settings().

Referenced by createFile(), and getFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createFile()

ilRestFileStorage::createFile	(	Request	$request,
		Response	$response
	)

Create new file from post.

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

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

References ilFileSystemAbstractionStorage\$path, $response, checkWebserviceActivation(), ilFileSystemAbstractionStorage\getPath(), ilFileUtils\ilTempnam(), and writeToFile().

Here is the call graph for this function:

◆ deleteDeprecated()

ilRestFileStorage::deleteDeprecated ( )

Delete deprecated files.

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

                                      : void
    {
        $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());
                }
            }
        }
    }

References Vendor\Package\$e, ilFileSystemAbstractionStorage\getPath(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ getFile()

ilRestFileStorage::getFile	(	Request	$request,
		Response	$response
	)

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

                                                                 : Response
    {
        $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);
 
            return $response
                ->withStatus(\Slim\Http\StatusCode::HTTP_OK)
                ->withHeader('Content-Type', 'application/json')
                ->write($return);
        }
        return $this->responeNotFound($response);
    }

References $response, checkWebserviceActivation(), ilFileSystemAbstractionStorage\getPath(), ILIAS\Repository\logger(), and responeNotFound().

Here is the call graph for this function:

◆ getPathPostfix()

ilRestFileStorage::getPathPostfix ( )

protected

Get directory name.

E.g for files => file Only relative path, no trailing slash '_<obj_id>' will be appended automatically

Reimplemented from ilFileSystemAbstractionStorage.

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

                                       : string
    {
        return 'files';
    }

◆ getPathPrefix()

ilRestFileStorage::getPathPrefix ( )

protected

Get path prefix.

Prefix that will be prepended to the path No trailing slash. E.g ilFiles for files

Reimplemented from ilFileSystemAbstractionStorage.

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

                                      : string
    {
        return 'ilRestFileStorage';
    }

◆ getStoredFilePath()

ilRestFileStorage::getStoredFilePath ( string $tmpname )

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

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

References ilFileSystemAbstractionStorage\getPath().

Here is the call graph for this function:

◆ init()

ilRestFileStorage::init ( )

protected

init and create directory

Reimplemented from ilFileSystemAbstractionStorage.

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

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

References ilFileSystemAbstractionStorage\create().

Here is the call graph for this function:

◆ responeNotFound()

ilRestFileStorage::responeNotFound ( Response $response )

protected

Send 403.

Parameters

\Slim\Http\Response $response

Returns: \Slim\Http\Response $response

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

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

References $response.

Referenced by getFile().

Here is the caller graph for this function:

◆ storeFileForRest()

ilRestFileStorage::storeFileForRest ( string $content )

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

                                                     : string
    {
        $tmpname = ilFileUtils::ilTempnam();
        $path = $this->getPath() . '/' . basename($tmpname);
 
        $this->writeToFile($content, $path);
        return basename($tmpname);
    }

References ilFileSystemAbstractionStorage\$path, ilFileSystemAbstractionStorage\getPath(), ilFileUtils\ilTempnam(), and writeToFile().

Here is the call graph for this function:

◆ writeToFile()

ilRestFileStorage::writeToFile	(	$a_data,
		$a_absolute_path
	)

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

                                                          : bool
    {
        if (!$fp = fopen($a_absolute_path, 'wb+')) {
            return false;
        }
        if (fwrite($fp, $a_data) === false) {
            fclose($fp);
            return false;
        }
        fclose($fp);
        return true;
    }

Referenced by createFile(), and storeFileForRest().

Here is the caller graph for this function:

Field Documentation

◆ $logger

ilRestFileStorage::$logger

private

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

◆ $settings

ilSetting ilRestFileStorage::$settings

protected

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

◆ AVAILABILITY_IN_DAYS

const ilRestFileStorage::AVAILABILITY_IN_DAYS = 1

private

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

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkWebserviceActivation()

◆ createFile()

◆ deleteDeprecated()

◆ getFile()

◆ getPathPostfix()

◆ getPathPrefix()

◆ getStoredFilePath()

◆ init()

◆ responeNotFound()

◆ storeFileForRest()

◆ writeToFile()

Field Documentation

◆ $logger

◆ $settings

◆ AVAILABILITY_IN_DAYS