This is the lowest common denominator of all popular browsers. More...

Inheritance diagram for ILIAS\Notifications\ilNotificationPushHandler:

Collaboration diagram for ILIAS\Notifications\ilNotificationPushHandler:

Public Member Functions
	__construct (PushProviderInterface $provider)

	notify (ilNotificationObject $notification)

	getLastQueueResult ()

Public Member Functions inherited from ILIAS\Notifications\ilNotificationHandler
	notify (ilNotificationObject $notification)

	showSettings (ilPropertyFormGUI $form)

	clear ()

Protected Member Functions
	buildContent (ilNotificationObject $notification)

	handleResponse (int $http_code, string $response, string $auth)

	resetLastQueueResult ()

	setLastQueueResult (PushQueueResult $result)

	validateForUser (ilObjUser $user, string $id)

Protected Attributes
PushRepository	$subscription_repo

ilLogger	$logger

string	$public_key

string	$private_key

string	$sub

bool	$is_enabled

PushQueueResult	$last_queue_result

Private Member Functions
	base64UrlDecode (string $data)

	publicVapidToPEM (string $key)

	hash (string $data, string $key, int $length=PHP_INT_MAX, ?string $preffix=null)

	padKey (string $key)
	The key needs to be preffixed for the request to fit the endpoints requirement. More...

Private Attributes
PushProviderInterface	$provider

Detailed Description

This is the lowest common denominator of all popular browsers.

For more information see:

Definition at line 45 of file ilNotificationPushHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Notifications\ilNotificationPushHandler::__construct ( PushProviderInterface $provider )

Definition at line 56 of file ilNotificationPushHandler.php.

    {
        global $DIC;
        $this->provider = $provider;
        $this->logger = $DIC->logger()->root();
        $this->sub = $DIC->settings()->get('admin_email');
        $this->subscription_repo = new PushRepository($DIC->database(), $DIC->user());
        $settings = new ilSetting('notifications');
        $this->public_key = $settings->get('application_server_key');
        $this->private_key = file_get_contents($settings->get('private_key_path'));
        $this->is_enabled = $settings->get('enable_push') === '1';
    }

References $DIC, ILIAS\Notifications\ilNotificationPushHandler\$provider, ILIAS\Repository\logger(), and ILIAS\UI\examples\Menu\Sub\sub().

Here is the call graph for this function:

Member Function Documentation

◆ base64UrlDecode()

ILIAS\Notifications\ilNotificationPushHandler::base64UrlDecode ( string $data )

private

Definition at line 151 of file ilNotificationPushHandler.php.

                                                  : string
    {
        return base64_decode(str_replace(['-', '_'], ['+', '/'], $data));
    }

References $data.

Referenced by ILIAS\Notifications\ilNotificationPushHandler\notify().

Here is the caller graph for this function:

◆ buildContent()

ILIAS\Notifications\ilNotificationPushHandler::buildContent ( ilNotificationObject $notification )

protected

Returns: string The endpoints expect an encrypted payload that end on an start of text (STX) character. This might be because of an obligation of the special encoding requirement including ECDH.

Definition at line 188 of file ilNotificationPushHandler.php.

                                                                       : string
    {
        $actions = [];
        foreach ($notification->links as $link) {
            $actions[] = [
                'title' => $link->getTitle(),
                'action' => $link->getUrl(),
            ];
        }
 
        return base64_encode(json_encode([
            $notification->title,
            [
                'data' => ['action' => $notification->action ?? '/'],
                'icon' => $notification->iconPath ?: ilUtil::getImagePath('logo/HeaderIconResponsive.svg'),
                'body' => $notification->shortDescription,
                'actions' => $actions
            ]
        ], JSON_THROW_ON_ERROR)) . \chr(2);
    }

References ilUtil\getImagePath().

Referenced by ILIAS\Notifications\ilNotificationPushHandler\notify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastQueueResult()

ILIAS\Notifications\ilNotificationPushHandler::getLastQueueResult ( )

Definition at line 260 of file ilNotificationPushHandler.php.

                                        : PushQueueResult
    {
        return $this->last_queue_result;
    }

References ILIAS\Notifications\ilNotificationPushHandler\$last_queue_result.

◆ handleResponse()

ILIAS\Notifications\ilNotificationPushHandler::handleResponse	(	int	$http_code,
		string	$response,
		string	$auth
	)

protected

Definition at line 209 of file ilNotificationPushHandler.php.

                                                                                     : PushQueueResult
    {
        if ($response !== '') {
            $this->logger->info("Push notification [$auth] response: $response");
        }
        switch ($http_code) {
            case StatusCode::HTTP_OK:
            case StatusCode::HTTP_CREATED:
                $this->logger->debug("Push notification [$auth] successful.");
                return PushQueueResult::SUCCEEDED;
            case StatusCode::HTTP_BAD_REQUEST:
            case StatusCode::HTTP_UNAUTHORIZED:
            case StatusCode::HTTP_FORBIDDEN:
                $this->logger->error("Push notification [$auth] request was invalid.");
                return PushQueueResult::FAILED;
            case StatusCode::HTTP_NOT_FOUND:
            case StatusCode::HTTP_GONE:
                $this->subscription_repo->deleteSubscription($auth);
                $this->logger->debug("Push notification [$auth] endpoint outdated. Subscription removed.");
                return PushQueueResult::FAILED;
            case StatusCode::HTTP_REQUEST_ENTITY_TOO_LARGE:
            case StatusCode::HTTP_TOO_MANY_REQUESTS:
                $this->logger->debug("Push notification [$auth] endpoint blocked due to heavy usage or spam.");
                return PushQueueResult::FAILED;
            default:
                $this->logger->info("Push notification [$auth] went into unkown/browser-specific handling.");
                return PushQueueResult::UNKNOWN;
        }
    }

References $response, ILIAS\Export\ImportStatus\FAILED, ILIAS\HTTP\StatusCode\HTTP_BAD_REQUEST, ILIAS\HTTP\StatusCode\HTTP_CREATED, ILIAS\HTTP\StatusCode\HTTP_FORBIDDEN, ILIAS\HTTP\StatusCode\HTTP_GONE, ILIAS\HTTP\StatusCode\HTTP_NOT_FOUND, ILIAS\HTTP\StatusCode\HTTP_OK, ILIAS\HTTP\StatusCode\HTTP_REQUEST_ENTITY_TOO_LARGE, ILIAS\HTTP\StatusCode\HTTP_TOO_MANY_REQUESTS, ILIAS\HTTP\StatusCode\HTTP_UNAUTHORIZED, ILIAS\Repository\logger(), and ILIAS\Notifications\Model\Push\SUCCEEDED.

Referenced by ILIAS\Notifications\ilNotificationPushHandler\notify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hash()

ILIAS\Notifications\ilNotificationPushHandler::hash	(	string	$data,
		string	$key,
		int	$length = `PHP_INT_MAX`,
		?string	$preffix = `null`
	)

private

Parameters

string $preffix If a info preffix is set it is required by the endpoint to be padded

Definition at line 167 of file ilNotificationPushHandler.php.

                                                                                                        : string
    {
        if ($preffix !== null) {
            $data = $preffix . \chr(0) . $data . \chr(1);
        }
        return mb_substr(hash_hmac('sha256', $data, $key, true), 0, $length, '8bit');
    }

References $data.

Referenced by ILIAS\Notifications\ilNotificationPushHandler\notify().

Here is the caller graph for this function:

◆ notify()

ILIAS\Notifications\ilNotificationPushHandler::notify ( ilNotificationObject $notification )

Parameters

bool $force The use of this parameter is explicitly not recommended! Forced notifications are distributed to a user without agknowledgement of their preferences and should therefore be used with care!

Reimplemented from ILIAS\Notifications\ilNotificationHandler.

Definition at line 73 of file ilNotificationPushHandler.php.

                                                              : void
    {
        $this->resetLastQueueResult();
 
        if (!$this->is_enabled) {
            $this->logger->debug('Notifications are globaly disabled.');
            $this->setLastQueueResult(PushQueueResult::FAILED);
            return;
        }
 
        if (!$this->provider instanceof InternalPushProvider) {
            $id = $notification->handlerParams['setting']['user_pref'];
            if (!$this->validateForUser($notification->user, $id)) {
                $this->logger->debug('Notification for ' . $id . ' not send due to user preferences.');
                $this->setLastQueueResult(PushQueueResult::FAILED);
                return;
            }
        }
 
        $subscriptions = $this->subscription_repo->getUserSubscriptions($notification->user->getId());
        if ($subscriptions === []) {
            $this->logger->debug('User ' . $notification->user->getId() . ' has no active Subscriptions');
            $this->setLastQueueResult(PushQueueResult::FAILED);
            return;
        }
 
        $salt = (new Randomizer())->getBytes(16);
        $local_key = $this->base64UrlDecode($this->public_key);
        $content = $this->buildContent($notification);
        $ttl = $notification->handlerParams['setting']['ttl'] ?? 60;
        foreach ($subscriptions as $subscription) {
            $url_parts = parse_url($subscription->getEndpoint());
            $data = [
                'sub' => 'mailto:' . $this->sub,
                'aud' => $url_parts['scheme'] . '://' . $url_parts['host'],
                'exp' => time() + (int) $ttl
            ];
 
            $user_key = $this->base64UrlDecode($subscription->getP256dh());
            $pre_key = $this->hash(
                openssl_pkey_derive($this->publicVapidToPEM($user_key), $this->private_key, 256),
                $this->base64UrlDecode($subscription->getAuth())
            );
            $key = $this->hash($this->hash($user_key . $local_key, $pre_key, 32, 'WebPush: info'), $salt);
            $encryptedText = openssl_encrypt(
                $content,
                'aes-128-gcm',
                $this->hash('', $key, 16, 'Content-Encoding: aes128gcm'),
                OPENSSL_RAW_DATA,
                $this->hash('', $key, 12, 'Content-Encoding: nonce'),
                $tag
            );
            $post = $salt . $this->padKey($local_key) . $encryptedText . $tag;
 
            $curl = new ilCurlConnection($subscription->getEndpoint());
            $curl->init();
            $curl->setOpt(CURLOPT_HTTPHEADER, [
                'Content-Encoding: aes128gcm',
                'Authorization: vapid t=' . JWT::encode($data, $this->private_key, 'ES256') . ', k=' . $this->public_key,
                'Ttl: ' . $ttl
            ]);
            $curl->setOpt(CURLOPT_POST, 1);
            $curl->setOpt(CURLOPT_RETURNTRANSFER, 1);
            $curl->setOpt(CURLOPT_POSTFIELDS, $post);
            $response = $curl->exec();
 
            if ($response === false) {
                $this->logger->error('Push notification [' . $subscription->getAuth() . '] request failed.');
                $this->setLastQueueResult(PushQueueResult::FAILED);
            } else {
                $this->setLastQueueResult(
                    $this->handleResponse($curl->getInfo(CURLINFO_HTTP_CODE), $response, $subscription->getAuth())
                );
            }
            $curl->close();
        }
    }

Here is the call graph for this function:

◆ padKey()

ILIAS\Notifications\ilNotificationPushHandler::padKey ( string $key )

private

The key needs to be preffixed for the request to fit the endpoints requirement.

This might be due to the key conversion and url encoding.

Definition at line 179 of file ilNotificationPushHandler.php.

                                        : string
    {
        return pack('N*', 4096) . pack('C*', mb_strlen($key, '8bit')) . $key;
    }

Referenced by ILIAS\Notifications\ilNotificationPushHandler\notify().

Here is the caller graph for this function:

◆ publicVapidToPEM()

ILIAS\Notifications\ilNotificationPushHandler::publicVapidToPEM ( string $key )

private

Definition at line 156 of file ilNotificationPushHandler.php.

                                                  : string
    {
        $der_key = pack('H*', '3059301306072a8648ce3d020106082a8648ce3d030107034200') . $key;
        return "-----BEGIN PUBLIC KEY-----\n" .
            chunk_split(base64_encode($der_key), 64, "\n") .
            "-----END PUBLIC KEY-----\n";
    }

Referenced by ILIAS\Notifications\ilNotificationPushHandler\notify().

Here is the caller graph for this function:

◆ resetLastQueueResult()

ILIAS\Notifications\ilNotificationPushHandler::resetLastQueueResult ( )

protected

Definition at line 239 of file ilNotificationPushHandler.php.

                                             : void
    {
        $this->last_queue_result = null;
    }

Referenced by ILIAS\Notifications\ilNotificationPushHandler\notify().

Here is the caller graph for this function:

◆ setLastQueueResult()

ILIAS\Notifications\ilNotificationPushHandler::setLastQueueResult ( PushQueueResult $result )

protected

Definition at line 244 of file ilNotificationPushHandler.php.

                                                                  : void
    {
        if (
            $this->last_queue_result === null ||
            $this->last_queue_result === PushQueueResult::FAILED ||
            $result === PushQueueResult::SUCCEEDED
        ) {
            $this->last_queue_result = $result;
        }
    }

References ILIAS\Export\ImportStatus\FAILED, and ILIAS\Notifications\Model\Push\SUCCEEDED.

Referenced by ILIAS\Notifications\ilNotificationPushHandler\notify().

Here is the caller graph for this function:

◆ validateForUser()

ILIAS\Notifications\ilNotificationPushHandler::validateForUser	(	ilObjUser	$user,
		string	$id
	)

protected

Definition at line 255 of file ilNotificationPushHandler.php.

                                                                   : bool
    {
        return \in_array($id, json_decode($user->getPref('push_notification_provider') ?? '[]'), true);
    }