Inheritance diagram for ilBTControllerGUI:

Collaboration diagram for ilBTControllerGUI:

Public Member Functions
	executeCommand ()

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Static Public Member Functions
static	hash (string $url)

static	unhash (string $url)

Data Fields
const	FROM_URL = 'from_url'

const	OBSERVER_ID = 'observer_id'

const	SELECTED_OPTION = 'selected_option'

const	CMD_ABORT = 'abortBucket'

const	CMD_REMOVE = 'abortBucket'

const	CMD_USER_INTERACTION = 'userInteraction'

const	IS_ASYNC = 'bt_task_is_async'

const	CMD_GET_REPLACEMENT_ITEM = "getAsyncReplacementItem"

Protected Member Functions
	userInteraction ()

	abortBucket ()

	getAsyncReplacementItem ()
	Loads one single aggregate notification item representing a button async to replace an existing one. More...

Private Member Functions
	getFromURL ()

	enforceBucketBelongsToCurrentUser (Bucket $bucket)

	defaultReturnUrl ()

	sendSuccessResponse (Stream $stream)

	redirectToCallerOrClose ()

	respondWithError (int $error_status_code, string $message)

	retrieveSelectedInteractionOption ()

	wasInvokedAsynchronously ()

	retrieveObserverIdFromRequest ()

	retrieveFromUrlFromRequest ()

Detailed Description

Class ilBTControllerGUI.

Author: Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

◆ abortBucket()

ilBTControllerGUI::abortBucket ( )

protected

Definition at line 101 of file class.ilBTControllerGUI.php.

                                    : void
    {
        $observer_id = $this->retrieveObserverIdFromRequest();
        if ($observer_id === null) {
            $this->respondWithError(StatusCode::HTTP_BAD_REQUEST, 'Bad Request');
        }
 
        $bucket = $this->dic()->backgroundTasks()->persistence()->loadBucket($observer_id);
 
        $this->enforceBucketBelongsToCurrentUser($bucket);
 
        $this->dic()->backgroundTasks()->taskManager()->quitBucket($bucket);
 
        $this->redirectToCallerOrClose();
    }

References enforceBucketBelongsToCurrentUser(), redirectToCallerOrClose(), respondWithError(), and retrieveObserverIdFromRequest().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ defaultReturnUrl()

ilBTControllerGUI::defaultReturnUrl ( )

private

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

                                       : string
    {
        return ilUtil::_getHttpPath();
    }

References ilUtil\_getHttpPath().

Referenced by getFromURL(), and respondWithError().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enforceBucketBelongsToCurrentUser()

ilBTControllerGUI::enforceBucketBelongsToCurrentUser ( Bucket $bucket )

private

Definition at line 192 of file class.ilBTControllerGUI.php.

                                                                      : void
    {
        if ($bucket->getUserId() !== $this->user()->getId()) {
            $this->respondWithError(StatusCode::HTTP_FORBIDDEN, 'Forbidden');
        }
    }

References ILIAS\BackgroundTasks\Bucket\getUserId(), and respondWithError().

Referenced by abortBucket(), getAsyncReplacementItem(), and userInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilBTControllerGUI::executeCommand ( )

Definition at line 47 of file class.ilBTControllerGUI.php.

                                    : void
    {
        $cmd = $this->ctrl()->getCmd();
        switch ($cmd) {
            case self::CMD_GET_REPLACEMENT_ITEM:
                $this->getAsyncReplacementItem();
                break;
            case self::CMD_USER_INTERACTION:
                $this->userInteraction();
                break;
            case self::CMD_ABORT:
            case self::CMD_REMOVE:
                $this->abortBucket();
                break;
            default:
                break;
        }
    }

References abortBucket(), CMD_ABORT, CMD_GET_REPLACEMENT_ITEM, CMD_REMOVE, CMD_USER_INTERACTION, ILIAS\Repository\ctrl(), getAsyncReplacementItem(), and userInteraction().

Here is the call graph for this function:

◆ getAsyncReplacementItem()

ilBTControllerGUI::getAsyncReplacementItem ( )

protected

Loads one single aggregate notification item representing a button async to replace an existing one.

Definition at line 122 of file class.ilBTControllerGUI.php.

                                                : void
    {
        $observer_id = $this->retrieveObserverIdFromRequest();
        if ($observer_id === null) {
            $this->respondWithError(StatusCode::HTTP_BAD_REQUEST, 'Bad Request');
        }
 
        $bucket = $this->dic()->backgroundTasks()->persistence()->loadBucket($observer_id);
 
        $this->enforceBucketBelongsToCurrentUser($bucket);
 
        $item_source = new ilBTPopOverGUI($this->dic());
        $this->dic()->language()->loadLanguageModule('background_tasks');
        $item = $item_source->getItemForObserver($bucket);
 
        $this->sendSuccessResponse(
            Streams::ofString(
                $this->dic()->ui()->renderer()->renderAsync($item)
            )
        );
    }

References enforceBucketBelongsToCurrentUser(), respondWithError(), retrieveObserverIdFromRequest(), sendSuccessResponse(), and ILIAS\Repository\ui().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFromURL()

ilBTControllerGUI::getFromURL ( )

private

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

                                 : URI
    {
        $uri = (new Factory())->uri($this->defaultReturnUrl());
 
        $decoded_from_url = $this->retrieveFromUrlFromRequest();
        if ($decoded_from_url === null || $decoded_from_url === '') {
            return $uri;
        }
 
        $from_url = self::unhash($decoded_from_url);
        if ($from_url === false) {
            return $uri;
        }
 
        $from_url_parts = parse_url($from_url);
        if (!is_array($from_url_parts)) {
            return $uri;
        }
 
        $uri = $uri->withPath(null)->withQuery(null)->withFragment(null);
 
        $mutators = [
            'path' => static fn(URI $u, string $v): URI => $u->withPath($v),
            'query' => static fn(URI $u, string $v): URI => $u->withQuery($v),
            'fragment' => static fn(URI $u, string $v): URI => $u->withFragment($v),
        ];
 
        foreach ($mutators as $key => $apply) {
            $value = $from_url_parts[$key] ?? null;
            if (is_string($value) && $value !== '') {
                $uri = $apply($uri, $value);
            }
        }
 
        return $uri;
    }

References ILIAS\LTI\ToolProvider\$key, defaultReturnUrl(), retrieveFromUrlFromRequest(), unhash(), ILIAS\Data\URI\withFragment(), ILIAS\Data\URI\withPath(), and ILIAS\Data\URI\withQuery().

Referenced by redirectToCallerOrClose().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSafePostCommands()

ilBTControllerGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 75 of file class.ilBTControllerGUI.php.

                                         : array
    {
        return [];
    }

◆ getUnsafeGetCommands()

ilBTControllerGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 66 of file class.ilBTControllerGUI.php.

                                          : array
    {
        return array_unique([
            self::CMD_ABORT,
            self::CMD_REMOVE,
            self::CMD_USER_INTERACTION,
        ]);
    }

◆ hash()

static ilBTControllerGUI::hash ( string $url )

static

Definition at line 182 of file class.ilBTControllerGUI.php.

                                            : string
    {
        return base64_encode($url);
    }

References $url.

Referenced by ilBTPopOverGUI\addFromUrlToNextRequest().

Here is the caller graph for this function:

◆ redirectToCallerOrClose()

ilBTControllerGUI::redirectToCallerOrClose ( )

private

Definition at line 217 of file class.ilBTControllerGUI.php.

                                              : never
    {
        if (!$this->wasInvokedAsynchronously()) {
            $this->ctrl()->redirectToURL((string) $this->getFromURL());
        }
 
        $this->http()->close();
    }

References ILIAS\Repository\ctrl(), getFromURL(), ILIAS\FileDelivery\http(), and wasInvokedAsynchronously().

Referenced by abortBucket(), and userInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ respondWithError()

ilBTControllerGUI::respondWithError	(	int	$error_status_code,
		string	$message
	)

private

Definition at line 226 of file class.ilBTControllerGUI.php.

                                                                              : never
    {
        $response = $this->http()->response()->withStatus($error_status_code, $message);
        if ($error_status_code === StatusCode::HTTP_FORBIDDEN && !$this->wasInvokedAsynchronously()) {
            $this->tpl()->setOnScreenMessage(
                $this->tpl()::MESSAGE_TYPE_FAILURE,
                $this->lng()->txt('permission_denied'),
                true
            );
            $response = $response
                ->withStatus(StatusCode::HTTP_FOUND, 'Found')
                ->withHeader(ResponseHeader::LOCATION, $this->defaultReturnUrl());
        }
 
        $this->http()->saveResponse($response);
        $this->http()->sendResponse();
        $this->http()->close();
    }

References $message, $response, defaultReturnUrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and wasInvokedAsynchronously().

Referenced by abortBucket(), enforceBucketBelongsToCurrentUser(), getAsyncReplacementItem(), and userInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveFromUrlFromRequest()

ilBTControllerGUI::retrieveFromUrlFromRequest ( )

private

Definition at line 278 of file class.ilBTControllerGUI.php.

                                                 : ?string
    {
        return $this->http()->wrapper()->query()->retrieve(
            self::FROM_URL,
            $this->dic()->refinery()->byTrying([
                $this->dic()->refinery()->kindlyTo()->string(),
                $this->dic()->refinery()->always(null)
            ])
        );
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by getFromURL().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveObserverIdFromRequest()

ilBTControllerGUI::retrieveObserverIdFromRequest ( )

private

Definition at line 267 of file class.ilBTControllerGUI.php.

                                                    : ?int
    {
        return $this->http()->wrapper()->query()->retrieve(
            self::OBSERVER_ID,
            $this->dic()->refinery()->byTrying([
                $this->dic()->refinery()->kindlyTo()->int(),
                $this->dic()->refinery()->always(null)
            ])
        );
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by abortBucket(), getAsyncReplacementItem(), and userInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveSelectedInteractionOption()

ilBTControllerGUI::retrieveSelectedInteractionOption ( )

private

Definition at line 245 of file class.ilBTControllerGUI.php.

                                                        : ?string
    {
        return $this->http()->wrapper()->query()->retrieve(
            self::SELECTED_OPTION,
            $this->dic()->refinery()->byTrying([
                $this->dic()->refinery()->kindlyTo()->string(),
                $this->dic()->refinery()->always(null)
            ])
        );
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by userInteraction().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendSuccessResponse()

ilBTControllerGUI::sendSuccessResponse ( Stream $stream )

private

Definition at line 204 of file class.ilBTControllerGUI.php.

                                                        : void
    {
        $response = $this->http()->response()
                                 ->withStatus(StatusCode::HTTP_OK, 'OK')
                                 ->withBody($stream);
        $this->http()->saveResponse($response);
 
        if ($this->wasInvokedAsynchronously()) {
            $this->http()->sendResponse();
            $this->http()->close();
        }
    }

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

Referenced by getAsyncReplacementItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unhash()

static ilBTControllerGUI::unhash ( string $url )

static

Definition at line 187 of file class.ilBTControllerGUI.php.

                                              : mixed
    {
        return base64_decode($url);
    }

References $url.

Referenced by getFromURL().

Here is the caller graph for this function:

◆ userInteraction()

ilBTControllerGUI::userInteraction ( )

protected

Definition at line 80 of file class.ilBTControllerGUI.php.

                                        : void
    {
        $observer_id = $this->retrieveObserverIdFromRequest();
        $selected_option = $this->retrieveSelectedInteractionOption();
        if ($observer_id === null || $selected_option === null) {
            $this->respondWithError(StatusCode::HTTP_BAD_REQUEST, 'Bad Request');
        }
 
        $bucket = $this->dic()->backgroundTasks()->persistence()->loadBucket($observer_id);
 
        $this->enforceBucketBelongsToCurrentUser($bucket);
 
        $this->dic()->backgroundTasks()->taskManager()->continueTask(
            $bucket,
            new UserInteractionOption('', $selected_option)
        );
 
        $this->redirectToCallerOrClose();
    }

References enforceBucketBelongsToCurrentUser(), redirectToCallerOrClose(), respondWithError(), retrieveObserverIdFromRequest(), and retrieveSelectedInteractionOption().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wasInvokedAsynchronously()

ilBTControllerGUI::wasInvokedAsynchronously ( )

private

Definition at line 256 of file class.ilBTControllerGUI.php.

                                               : bool
    {
        return $this->http()->wrapper()->query()->retrieve(
            self::IS_ASYNC,
            $this->dic()->refinery()->byTrying([
                $this->dic()->refinery()->kindlyTo()->bool(),
                $this->dic()->refinery()->always(false)
            ])
        );
    }