ilWebAccessCheckerDelivery Class Reference

Class ilWebAccessCheckerDelivery. More...

Collaboration diagram for ilWebAccessCheckerDelivery:

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

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

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

Private Attributes
ilWebAccessChecker	$wac
Services	$http
string	$img_dir

Detailed Description

Class ilWebAccessCheckerDelivery.

Author

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

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

Constructor & Destructor Documentation

__construct()

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

ilWebAccessCheckerDelivery constructor.

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

References ILIAS\FileDelivery\http().

    {
        $this->wac = new ilWebAccessChecker($httpState, $cookieFactory);
        $this->http = $httpState;
        $this->img_dir = realpath(__DIR__ . '/../templates/images');
    }

Here is the call graph for this function:

Member Function Documentation

deliver()

ilWebAccessCheckerDelivery::deliver ( )

protected

Exceptions

ilWACException

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

References $data_dir, $ini, $path, $token, ilWACException\ACCESS_WITHOUT_CHECK, CLIENT_DATA_DIR, and ILIAS\FileDelivery\http().

Referenced by handleRequest().

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

        $path = $this->wac->getPathObject();
        // This is currently the place where WAC handles things from the ResourceStorageService.
        if ($path->getModuleType() === 'rs') {
            // initialize constants
            if (!defined('CLIENT_DATA_DIR')) {
                $ini = new ilIniFile("./ilias.ini.php");
                $ini->read();
                $data_dir = rtrim($ini->readVariable("clients", "datadir"), '/');
                $client_data_dir = $data_dir . "/" . $path->getClient();
            } else {
                $client_data_dir = CLIENT_DATA_DIR;
            }

            $token_factory = new TokenFactory($client_data_dir);
            $token = $token_factory->check($path->getFileName());
            $path_to_file = $token->resolveStream(); // FileStream
        } else {
            $path_to_file = $path->getCleanURLdecodedPath();
        }

        $real_path_to_file = realpath(__DIR__ . '/../../../../public/' . $path_to_file);

        $ilFileDelivery = new Delivery($real_path_to_file, $this->http);
        $ilFileDelivery->setCache(true);
        $ilFileDelivery->setDisposition($this->wac->getDisposition());
        if ($path->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 103 of file class.ilWebAccessCheckerDelivery.php.

References ILIAS\FileDelivery\http().

Referenced by handleAccessErrors().

                                          : void
    {
        $ilFileDelivery = new Delivery($this->img_dir . '/access_denied.png', $this->http);
        $ilFileDelivery->setDisposition($this->wac->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 111 of file class.ilWebAccessCheckerDelivery.php.

References ILIAS\FileDelivery\http().

Referenced by handleAccessErrors().

                                          : void
    {
        $ilFileDelivery = new Delivery($this->img_dir . '/access_denied.mp4', $this->http);
        $ilFileDelivery->setDisposition($this->wac->getDisposition());
        $ilFileDelivery->stream();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deny()

ilWebAccessCheckerDelivery::deny ( )

protected

Exceptions

ilWACException

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

References ilWACException\ACCESS_DENIED, and ilWACException\ACCESS_WITHOUT_CHECK.

Referenced by handleRequest().

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

Here is the caller graph for this function:

handleAccessErrors()

ilWebAccessCheckerDelivery::handleAccessErrors ( ilWACException  $e )

protected

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

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

Referenced by handleRequest().

                                                            : void
    {
        //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->wac->getPathObject()->isVideo()) {
            $this->deliverDummyVideo();
        }

        $this->deliverDummyImage();

        $this->wac->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 118 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

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

References Vendor\Package\$e, ilWACException\ACCESS_DENIED, ilWACException\ACCESS_DENIED_NO_LOGIN, ilWACException\ACCESS_DENIED_NO_PUB, deliver(), deny(), ilWebAccessChecker\DISPOSITION, handleAccessErrors(), ilInitialisation\handleErrorReporting(), handleNotFoundError(), ILIAS\FileDelivery\http(), ilWACException\NOT_FOUND, ilWebAccessChecker\REVALIDATE, and ilWebAccessChecker\STATUS_CODE.

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

        // Set customizing
        if (isset($queries[ilWebAccessChecker::DISPOSITION])) {
            $this->wac->setDisposition($queries[ilWebAccessChecker::DISPOSITION]);
        }
        if (isset($queries[ilWebAccessChecker::STATUS_CODE])) {
            $this->wac->setSendStatusCode($queries[ilWebAccessChecker::STATUS_CODE]);
        }
        if (isset($queries[ilWebAccessChecker::REVALIDATE])) {
            $this->wac->setRevalidateFolderTokens($queries[ilWebAccessChecker::REVALIDATE]);
        }

        // Check if File can be delivered
        try {
            if ($this->wac->check()) {
                $this->deliver();
            } else {
                $this->deny();
            }
        } catch (ilWACException $e) {
            match ($e->getCode()) {
                ilWACException::NOT_FOUND => $this->handleNotFoundError($e),
                ilWACException::ACCESS_DENIED,
                ilWACException::ACCESS_DENIED_NO_PUB,
                ilWACException::ACCESS_DENIED_NO_LOGIN => $this->handleAccessErrors($e),
                default => $this->handleErrors($e),
            };
        }
    }

Here is the call graph for this function:

run()

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

static

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

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

Field Documentation

$http

Services ilWebAccessCheckerDelivery::$http

private

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

$img_dir

string ilWebAccessCheckerDelivery::$img_dir

private

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

$wac

ilWebAccessChecker ilWebAccessCheckerDelivery::$wac

private

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

---

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

• components/ILIAS/WebAccessChecker/classes/class.ilWebAccessCheckerDelivery.php