ilWebAccessCheckerDelivery Class Reference

Class ilWebAccessCheckerDelivery. More...

Collaboration diagram for ilWebAccessCheckerDelivery:

Public Member Functions
	__construct (GlobalHttpState $httpState, CookieFactory $cookieFactory)
	ilWebAccessCheckerDelivery constructor. More...

Static Public Member Functions
static	run (GlobalHttpState $httpState, CookieFactory $cookieFactory)

Protected Member Functions
	handleRequest ()
	deny ()
	deliverDummyImage ()
	deliverDummyVideo ()
	handleNotFoundError (ilWACException $e)
	handleAccessErrors (ilWACException $e)
	deliver ()

Private Attributes
	$ilWebAccessChecker = null
	$http

Detailed Description

Class ilWebAccessCheckerDelivery.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilWebAccessCheckerDelivery::__construct	(	GlobalHttpState	$httpState,
		CookieFactory	$cookieFactory
	)

ilWebAccessCheckerDelivery constructor.

Parameters

GlobalHttpState	$httpState
CookieFactory	$cookieFactory

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

References ILIAS\FileDelivery\http().

    {
        $this->ilWebAccessChecker = new ilWebAccessChecker($httpState, $cookieFactory);
        $this->http = $httpState;
    }

Here is the call graph for this function:

Member Function Documentation

deliver()

ilWebAccessCheckerDelivery::deliver ( )

protected

Returns

void

Exceptions

ilWACException

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

References $http, ilWACException\ACCESS_WITHOUT_CHECK, ilWebAccessChecker\getDisposition(), ilWebAccessChecker\getPathObject(), and ilWebAccessChecker\isChecked().

Referenced by handleRequest().

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

        $ilFileDelivery = new Delivery($this->ilWebAccessChecker->getPathObject()->getCleanURLdecodedPath(), $this->http);
        $ilFileDelivery->setCache(true);
        $ilFileDelivery->setDisposition($this->ilWebAccessChecker->getDisposition());
        if ($this->ilWebAccessChecker->getPathObject()->isStreamable()) { // fixed 0016468
            $ilFileDelivery->stream();
        } else {
            $ilFileDelivery->deliver();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deliverDummyImage()

ilWebAccessCheckerDelivery::deliverDummyImage ( )

protected

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

References ilWebAccessChecker\getDisposition(), and ILIAS\FileDelivery\http().

Referenced by handleAccessErrors().

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

Here is the call graph for this function:

Here is the caller graph for this function:

deliverDummyVideo()

ilWebAccessCheckerDelivery::deliverDummyVideo ( )

protected

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

References ilWebAccessChecker\getDisposition(), and ILIAS\FileDelivery\http().

Referenced by handleAccessErrors().

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

Here is the call graph for this function:

Here is the caller graph for this function:

deny()

ilWebAccessCheckerDelivery::deny ( )

protected

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

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

Referenced by handleRequest().

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

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 155 of file class.ilWebAccessCheckerDelivery.php.

References Vendor\Package\$e, $response, deliverDummyImage(), deliverDummyVideo(), ilWebAccessChecker\getPathObject(), ILIAS\FileDelivery\http(), and ilWebAccessChecker\initILIAS().

Referenced by handleRequest().

    {

        //1.5.2017 Http code needs to be 200 because mod_xsendfile ignores the response with an 401 code. (possible leak of web path via xsendfile header)
        $response = $this->http
            ->response()
            ->withStatus(200);

        $this->http->saveResponse($response);

        if ($this->ilWebAccessChecker->getPathObject()->isImage()) {
            $this->deliverDummyImage();
        }
        if ($this->ilWebAccessChecker->getPathObject()->isVideo()) {
            $this->deliverDummyVideo();
        }

        $this->ilWebAccessChecker->initILIAS();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleNotFoundError()

ilWebAccessCheckerDelivery::handleNotFoundError ( ilWACException  $e )

protected

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

References $response, and ILIAS\FileDelivery\http().

Referenced by handleRequest().

                                                              : void
    {
        $response = $this->http
            ->response()
            ->withStatus(404);

        $this->http->saveResponse($response);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleRequest()

ilWebAccessCheckerDelivery::handleRequest ( )

protected

Returns

void

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

References Vendor\Package\$e, 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(), handleNotFoundError(), ILIAS\FileDelivery\http(), ilWACException\INITIALISATION_FAILED, ilWACException\NO_CHECKING_INSTANCE, ilWACException\NOT_FOUND, ilWebAccessChecker\REVALIDATE, ilWebAccessChecker\setDisposition(), ilWebAccessChecker\setRevalidateFolderTokens(), ilWebAccessChecker\setSendStatusCode(), and ilWebAccessChecker\STATUS_CODE.

    {
        // Set errorreporting
        ilInitialisation::handleErrorReporting();
        $queries = $this->http->request()->getQueryParams();

        // Set customizing
        if (isset($queries[ilWebAccessChecker::DISPOSITION])) {
            $this->ilWebAccessChecker->setDisposition($queries[ilWebAccessChecker::DISPOSITION]);
        }
        if (isset($queries[ilWebAccessChecker::STATUS_CODE])) {
            $this->ilWebAccessChecker->setSendStatusCode($queries[ilWebAccessChecker::STATUS_CODE]);
        }
        if (isset($queries[ilWebAccessChecker::REVALIDATE])) {
            $this->ilWebAccessChecker->setRevalidateFolderTokens($queries[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::NOT_FOUND:
                    $this->handleNotFoundError($e);
                    break;
                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;
            }
        }
    }

Here is the call graph for this function:

run()

static ilWebAccessCheckerDelivery::run ( GlobalHttpState  $httpState, CookieFactory  $cookieFactory  )

static

Parameters

GlobalHttpState	$httpState
CookieFactory	$cookieFactory

Returns

void

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

Referenced by ilWACCheckingInstanceTest\setUp().

    {
        $obj = new self($httpState, $cookieFactory);
        $obj->handleRequest();
    }

Here is the caller graph for this function:

Field Documentation

$http

GlobalHttpState ilWebAccessCheckerDelivery::$http

private

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

Referenced by deliver().

$ilWebAccessChecker

ilWebAccessCheckerDelivery::$ilWebAccessChecker = null

private

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

---

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

• Services/WebAccessChecker/classes/class.ilWebAccessCheckerDelivery.php