Class ilWebAccessCheckerDelivery. More...

Collaboration diagram for ilWebAccessCheckerDelivery:

Public Member Functions
	__construct ($raw_path)
	ilWebAccessCheckerDelivery constructor. More...

Static Public Member Functions
static	run ($raw_path)

Protected Member Functions
	handleRequest ()

	deny ()

	deliverDummyImage ()

	deliverDummyVideo ()

	handleAccessErrors (ilWACException $e)

	handleErrors (ilWACException $e)

	deliver ()

Protected Attributes
	$ilWebAccessChecker = null

Detailed Description

Class ilWebAccessCheckerDelivery.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 11 of file class.ilWebAccessCheckerDelivery.php.

Constructor & Destructor Documentation

◆ __construct()

ilWebAccessCheckerDelivery::__construct ( $raw_path )

ilWebAccessCheckerDelivery constructor.

Parameters

string $raw_path

Definition at line 33 of file class.ilWebAccessCheckerDelivery.php.

                                               {
                $this->ilWebAccessChecker = new ilWebAccessChecker(rawurldecode($raw_path));
        }

Member Function Documentation

◆ deliver()

ilWebAccessCheckerDelivery::deliver ( )

protected

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

                                     {
                if (!$this->ilWebAccessChecker->isChecked()) {
                        throw new ilWACException(ilWACException::ACCESS_WITHOUT_CHECK);
                }
 
                $ilFileDelivery = new ilFileDelivery($this->ilWebAccessChecker->getPathObject()->getPath());
                $ilFileDelivery->setCache(false);
                $ilFileDelivery->setDisposition($this->ilWebAccessChecker->getDisposition());
                ilWACLog::getInstance()->write('Deliver file using ' . $ilFileDelivery->getDeliveryType());
                if ($this->ilWebAccessChecker->getPathObject()->isStreamable()) { // fixed 0016468
                        ilWACLog::getInstance()->write('begin streaming');
                        $ilFileDelivery->stream();
                } else {
                        $ilFileDelivery->deliver();
                }
        }

References ilWACException\ACCESS_WITHOUT_CHECK, ilWebAccessChecker\getDisposition(), ilWACLog\getInstance(), ilWebAccessChecker\getPathObject(), and ilWebAccessChecker\isChecked().

Referenced by handleRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverDummyImage()

ilWebAccessCheckerDelivery::deliverDummyImage ( )

protected

Definition at line 86 of file class.ilWebAccessCheckerDelivery.php.

                                               {
                $ilFileDelivery = new ilFileDelivery('./Services/WebAccessChecker/templates/images/access_denied.png', $this->ilWebAccessChecker->getPathObject()
                                                                                                                                                ->getFileName());
                $ilFileDelivery->setDisposition($this->ilWebAccessChecker->getDisposition());
                $ilFileDelivery->deliver();
        }

References ilWebAccessChecker\getDisposition(), and ilWebAccessChecker\getPathObject().

Referenced by handleAccessErrors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliverDummyVideo()

ilWebAccessCheckerDelivery::deliverDummyVideo ( )

protected

Definition at line 94 of file class.ilWebAccessCheckerDelivery.php.

                                               {
                $ilFileDelivery = new ilFileDelivery('./Services/WebAccessChecker/templates/images/access_denied.mp4', $this->ilWebAccessChecker->getPathObject()
                                                                                                                                                ->getFileName());
                $ilFileDelivery->setDisposition($this->ilWebAccessChecker->getDisposition());
                $ilFileDelivery->stream();
        }

References ilWebAccessChecker\getDisposition(), and ilWebAccessChecker\getPathObject().

Referenced by handleAccessErrors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deny()

ilWebAccessCheckerDelivery::deny ( )

protected

Definition at line 78 of file class.ilWebAccessCheckerDelivery.php.

                                  {
                if (!$this->ilWebAccessChecker->isChecked()) {
                        throw new ilWACException(ilWACException::ACCESS_WITHOUT_CHECK);
                }
                throw new ilWACException(ilWACException::ACCESS_DENIED);
        }

References ilWACException\ACCESS_DENIED, ilWACException\ACCESS_WITHOUT_CHECK, and ilWebAccessChecker\isChecked().

Referenced by handleRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleAccessErrors()

ilWebAccessCheckerDelivery::handleAccessErrors ( ilWACException $e )

protected

Parameters

ilWACException $e

Definition at line 105 of file class.ilWebAccessCheckerDelivery.php.

                                                                 {
                if ($this->ilWebAccessChecker->isSendStatusCode()) {
                        ilHTTP::status(401);
                }
                if ($this->ilWebAccessChecker->getPathObject()->isImage()) {
                        $this->deliverDummyImage();
                }
                if ($this->ilWebAccessChecker->getPathObject()->isVideo()) {
                        $this->deliverDummyVideo();
                }
                try {
                        $this->ilWebAccessChecker->initILIAS();
                } catch (ilWACException $ilWACException) {
                }
 
                global $tpl, $ilLog;
                $ilLog->write($e->getMessage());
                $tpl->setVariable('BASE', strstr($_SERVER['REQUEST_URI'], '/data', true) . '/');
                ilUtil::sendFailure($e->getMessage());
                $tpl->getStandardTemplate();
                $tpl->show();
        }

References $_SERVER, $ilLog, $tpl, deliverDummyImage(), deliverDummyVideo(), ilWebAccessChecker\getPathObject(), ilWebAccessChecker\initILIAS(), ilWebAccessChecker\isSendStatusCode(), ilUtil\sendFailure(), and ilHTTP\status().

Referenced by handleRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleErrors()

ilWebAccessCheckerDelivery::handleErrors ( ilWACException $e )

protected

Parameters

ilWACException $e

Definition at line 132 of file class.ilWebAccessCheckerDelivery.php.

                                                           {
                ilHTTP::status(500);
                echo $e->getMessage();
        }

References ilHTTP\status().

Referenced by handleRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleRequest()

ilWebAccessCheckerDelivery::handleRequest ( )

protected

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

                                           {
                // Set errorreporting
                ilInitialisation::handleErrorReporting();
 
                // Set customizing
                if (isset($_GET[ilWebAccessChecker::DISPOSITION])) {
                        $this->ilWebAccessChecker->setDisposition($_GET[ilWebAccessChecker::DISPOSITION]);
                }
                if (isset($_GET[ilWebAccessChecker::STATUS_CODE])) {
                        $this->ilWebAccessChecker->setSendStatusCode($_GET[ilWebAccessChecker::STATUS_CODE]);
                }
                if (isset($_GET[ilWebAccessChecker::REVALIDATE])) {
                        $this->ilWebAccessChecker->setRevalidateFolderTokens($_GET[ilWebAccessChecker::REVALIDATE]);
                }
 
                // Check if File can be delivered
                try {
                        if ($this->ilWebAccessChecker->check()) {
                                $this->deliver();
                        } else {
                                $this->deny();
                        }
                } catch (ilWACException $e) {
                        switch ($e->getCode()) {
                                case ilWACException::ACCESS_DENIED:
                                case ilWACException::ACCESS_DENIED_NO_PUB:
                                case ilWACException::ACCESS_DENIED_NO_LOGIN:
                                        $this->handleAccessErrors($e);
                                        break;
                                case ilWACException::ACCESS_WITHOUT_CHECK:
                                case ilWACException::INITIALISATION_FAILED:
                                case ilWACException::NO_CHECKING_INSTANCE:
                                default:
                                        $this->handleErrors($e);
                                        break;
                        }
                }
        }

References $_GET, ilWACException\ACCESS_DENIED, ilWACException\ACCESS_DENIED_NO_LOGIN, ilWACException\ACCESS_DENIED_NO_PUB, ilWACException\ACCESS_WITHOUT_CHECK, ilWebAccessChecker\check(), deliver(), deny(), ilWebAccessChecker\DISPOSITION, handleAccessErrors(), ilInitialisation\handleErrorReporting(), handleErrors(), ilWACException\INITIALISATION_FAILED, ilWACException\NO_CHECKING_INSTANCE, ilWebAccessChecker\REVALIDATE, ilWebAccessChecker\setDisposition(), ilWebAccessChecker\setRevalidateFolderTokens(), ilWebAccessChecker\setSendStatusCode(), and ilWebAccessChecker\STATUS_CODE.

Here is the call graph for this function:

◆ run()

static ilWebAccessCheckerDelivery::run ( $raw_path )

static

Parameters

$raw_path

Definition at line 22 of file class.ilWebAccessCheckerDelivery.php.

                                              {
                $obj = new self($raw_path);
                $obj->handleRequest();
        }

Referenced by ilWACCheckingInstanceTest\tetDeliver().

Here is the caller graph for this function:

Field Documentation

◆ $ilWebAccessChecker

ilWebAccessCheckerDelivery::$ilWebAccessChecker = null

protected

Definition at line 16 of file class.ilWebAccessCheckerDelivery.php.

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

Services/WebAccessChecker/classes/class.ilWebAccessCheckerDelivery.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deliver()

◆ deliverDummyImage()

◆ deliverDummyVideo()

◆ deny()

◆ handleAccessErrors()

◆ handleErrors()

◆ handleRequest()

◆ run()

Field Documentation

◆ $ilWebAccessChecker