ILIAS\components\WOPI\Handler\RequestHandler Class Reference

Collaboration diagram for ILIAS\components\WOPI\Handler\RequestHandler:

Public Member Functions
	__construct ()
	handleRequest ()

Data Fields
const	WOPI_BASE_URL = '/wopi/index.php/'
const	NAMESPACE_FILES = 'files'
const	HEADER_X_WOPI_OVERRIDE = 'X-WOPI-Override'
const	HEADER_X_WOPI_LOCK = 'X-WOPI-Lock'
const	HEADER_X_WOPI_FILE_CONVERSION = 'X-WOPI-FileConversion'

Protected Member Functions
	checkAuth ()

Private Attributes
const	HEADER_X_REQUEST_ID = 'X-Request-ID'
const	HEADER_AUTHORIZATION = 'Authorization'
const	HEADER_AUTHORIZATION_BEARER = 'Bearer'
Services	$http
ILIAS ResourceStorage Services	$irss
DataSigner	$data_signer
int	$token_user_id = null
string	$token_resource_id = null
ResourceStakeholder	$stakeholder
int	$saving_interval = 0
bool	$editable = false

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 32 of file RequestHandler.php.

Constructor & Destructor Documentation

__construct()

ILIAS\components\WOPI\Handler\RequestHandler::__construct

(

)

Definition at line 78 of file RequestHandler.php.

References $DIC, ILIAS\FileDelivery\http(), and ILIAS\Repository\int().

    {
        global $DIC;
        $this->http = $DIC->http();
        $this->data_signer = $DIC['file_delivery.data_signer'];
        $this->irss = $DIC->resourceStorage();
        $this->saving_interval = (int) $DIC->settings()->get('saving_interval');
    }

Here is the call graph for this function:

Member Function Documentation

checkAuth()

ILIAS\components\WOPI\Handler\RequestHandler::checkAuth ( )

protected

Definition at line 87 of file RequestHandler.php.

References ILIAS\FileDelivery\http(), ILIAS\Repository\int(), and null.

Referenced by ILIAS\components\WOPI\Handler\RequestHandler\handleRequest().

                                  : void
    {
        $auth = $this->http->request()->getHeader(self::HEADER_AUTHORIZATION)[0] ?? '';
        // spit and check bearer token
        $bearer = explode(' ', $auth);
        if ($auth !== '' && ($bearer[0] ?? '') !== self::HEADER_AUTHORIZATION_BEARER) {
            throw new \InvalidArgumentException();
        }
        $bearer_token = $bearer[1] ?? '';
        if ($auth === '' && $bearer_token === '') {
            // we try to get the token from GET
            $bearer_token = $this->http->request()->getQueryParams()['access_token'] ?? '';
        }
        if ($bearer_token === '') {
            throw new \InvalidArgumentException();
        }
        if (($token_data = $this->data_signer->verify($bearer_token, 'wopi')) === null) {
            throw new \InvalidArgumentException();
        }

        $this->token_user_id = (int) ($token_data['user_id'] ?? 0);
        $this->token_resource_id = (string) ($token_data['resource_id'] ?? '');
        $this->editable = (bool) ($token_data['editable'] ?? '');
        $stakeholder = $token_data['stakeholder'] ?? null;
        if ($stakeholder !== null) {
            try {
                $this->stakeholder = new WOPIStakeholderWrapper();
                $this->stakeholder->init($stakeholder, $this->token_user_id);
            } catch (\Throwable) {
                $this->stakeholder = new WOPIUnknownStakeholder($this->token_user_id);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleRequest()

ILIAS\components\WOPI\Handler\RequestHandler::handleRequest

(

)

Returns

never

Definition at line 124 of file RequestHandler.php.

References $message, $response, ILIAS\components\WOPI\Handler\RequestHandler\checkAuth(), ILIAS\FileDelivery\http(), null, and ILIAS\Filesystem\Stream\Streams\ofString().

                                   : void
    {
        try {
            $this->checkAuth();

            $uri = $this->http->request()->getUri()->getPath();
            $request = substr($uri, strpos($uri, self::WOPI_BASE_URL) + strlen(self::WOPI_BASE_URL));
            $request = explode('/', $request);
            $method = $this->http->request()->getMethod();

            $resource_id = $request[1];
            $action = $request[2] ?? '';

            // check resource_id
            if ($this->token_resource_id !== $resource_id) {
                $this->http->close();
            }

            $resource_id = $this->irss->manage()->find($resource_id);
            if (!$resource_id instanceof ResourceIdentification) {
                $this->http->close();
            }
            $resource = $this->irss->manage()->getResource($resource_id);
            $current_revision = $this->editable ? $resource->getCurrentRevisionIncludingDraft() : $resource->getCurrentRevision();

            $method_override = $this->http->request()->getHeader(self::HEADER_X_WOPI_OVERRIDE)[0] ?? null;
            $is_file_convertion = (bool) ($this->http->request()->getHeader(
                self::HEADER_X_WOPI_FILE_CONVERSION
            )[0] ?? false);

            // GET
            switch ($method_override ?? $method) {
                case 'GET':
                    switch ($action) {
                        case '':
                            // CheckFileInfo
                            $response = new GetFileInfoResponse(
                                $current_revision,
                                $this->token_user_id,
                                $this->editable
                            );
                            $this->http->saveResponse(
                                $this->http->response()->withBody(
                                    Streams::ofString(json_encode($response, JSON_THROW_ON_ERROR))
                                )
                            );

                            break;
                        case 'contents':
                            // GetFile
                            $stream = $this->irss->consume()->stream($resource_id)->setRevisionNumber(
                                $current_revision->getVersionNumber()
                            )->getStream();
                            $this->http->saveResponse(
                                $this->http->response()->withBody($stream)
                            );

                            break;
                    }
                    break;
                case 'PUT_RELATIVE':
                    if (!$is_file_convertion) {
                        throw new \InvalidArgumentException();
                    }
                    // no break
                case 'PUT':
                    switch ($action) {
                        case 'contents':
                            // PutFile
                            $body_stream = $this->http->request()->getBody();
                            $body = $body_stream->getContents();
                            $file_stream = Streams::ofString($body);

                            $draft = true;

                            if ($this->saving_interval > 0) {
                                $latest_revision = $resource->getCurrentRevision();
                                $creation_time = $latest_revision->getInformation()->getCreationDate()->getTimestamp();
                                $current_time = time();
                                $time_diff = $current_time - $creation_time;
                                if ($time_diff > $this->saving_interval) {
                                    $this->irss->manage()->publish($resource_id);
                                }
                            }

                            $new_revision = $this->irss->manage()->appendNewRevisionFromStream(
                                $resource_id,
                                $file_stream,
                                $this->stakeholder,
                                $current_revision->getTitle(),
                                $draft
                            );

                            // CheckFileInfo
                            $response = new GetFileInfoResponse(
                                $new_revision,
                                $this->token_user_id
                            );
                            $this->http->saveResponse(
                                $this->http->response()->withBody(
                                    Streams::ofString(json_encode($response, JSON_THROW_ON_ERROR))
                                )
                            );

                            break;
                        case '': // if we want to create new files in the future, this will be a separate case
                            break;
                    }
                    break;
                case 'POST':
                    switch ($action) {
                        case 'contents':
                            $this->http->saveResponse(
                                $this->http->response()->withBody(
                                    Streams::ofString('')
                                )
                            );

                            break;
                        case '':
                            // Lock
                            $lock = $this->http->request()->getHeader(self::HEADER_X_WOPI_LOCK)[0] ?? null;
                            $this->http->saveResponse(
                                $this->http->response()->withBody(
                                    Streams::ofString('')
                                )
                            );
                    }
                    break;
            }
        } catch (\Throwable $t) {
            $message = $t->getMessage();
            // append simple stacktrace
            $trace = array_map(
                static fn(array $trace): string => $trace['file'] . ':' . $trace['line'],
                $t->getTrace()
            );

            $message .= "\n" . implode("\n", $trace);

            $this->http->saveResponse(
                $this->http->response()
                           ->withBody(Streams::ofString($message))
                           ->withStatus(500)
                           ->withHeader('X-WOPI-ServerError', $t->getMessage())
            );
        }
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

Field Documentation

$data_signer

DataSigner ILIAS\components\WOPI\Handler\RequestHandler::$data_signer

private

Definition at line 71 of file RequestHandler.php.

$editable

bool ILIAS\components\WOPI\Handler\RequestHandler::$editable = false

private

Definition at line 76 of file RequestHandler.php.

$http

Services ILIAS\components\WOPI\Handler\RequestHandler::$http

private

Definition at line 69 of file RequestHandler.php.

$irss

ILIAS ResourceStorage Services ILIAS\components\WOPI\Handler\RequestHandler::$irss

private

Definition at line 70 of file RequestHandler.php.

$saving_interval

int ILIAS\components\WOPI\Handler\RequestHandler::$saving_interval = 0

private

Definition at line 75 of file RequestHandler.php.

$stakeholder

ResourceStakeholder ILIAS\components\WOPI\Handler\RequestHandler::$stakeholder

private

Definition at line 74 of file RequestHandler.php.

$token_resource_id

string ILIAS\components\WOPI\Handler\RequestHandler::$token_resource_id = null

private

Definition at line 73 of file RequestHandler.php.

$token_user_id

int ILIAS\components\WOPI\Handler\RequestHandler::$token_user_id = null

private

Definition at line 72 of file RequestHandler.php.

HEADER_AUTHORIZATION

const ILIAS\components\WOPI\Handler\RequestHandler::HEADER_AUTHORIZATION = 'Authorization'

private

Definition at line 51 of file RequestHandler.php.

HEADER_AUTHORIZATION_BEARER

const ILIAS\components\WOPI\Handler\RequestHandler::HEADER_AUTHORIZATION_BEARER = 'Bearer'

private

Definition at line 55 of file RequestHandler.php.

HEADER_X_REQUEST_ID

const ILIAS\components\WOPI\Handler\RequestHandler::HEADER_X_REQUEST_ID = 'X-Request-ID'

private

Definition at line 47 of file RequestHandler.php.

HEADER_X_WOPI_FILE_CONVERSION

const ILIAS\components\WOPI\Handler\RequestHandler::HEADER_X_WOPI_FILE_CONVERSION = 'X-WOPI-FileConversion'

Definition at line 67 of file RequestHandler.php.

HEADER_X_WOPI_LOCK

const ILIAS\components\WOPI\Handler\RequestHandler::HEADER_X_WOPI_LOCK = 'X-WOPI-Lock'

Definition at line 63 of file RequestHandler.php.

HEADER_X_WOPI_OVERRIDE

const ILIAS\components\WOPI\Handler\RequestHandler::HEADER_X_WOPI_OVERRIDE = 'X-WOPI-Override'

Definition at line 59 of file RequestHandler.php.

NAMESPACE_FILES

const ILIAS\components\WOPI\Handler\RequestHandler::NAMESPACE_FILES = 'files'

Definition at line 41 of file RequestHandler.php.

Referenced by ILIAS\components\WOPI\Embed\EmbeddedApplication\getActionLauncherURL().

WOPI_BASE_URL

const ILIAS\components\WOPI\Handler\RequestHandler::WOPI_BASE_URL = '/wopi/index.php/'

Definition at line 37 of file RequestHandler.php.

Referenced by ILIAS\components\WOPI\Embed\EmbeddedApplication\getActionLauncherURL().

---

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

• components/ILIAS/WOPI/classes/Handler/RequestHandler.php