Push.php

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\Notifications;

use GuzzleHttp\Exception\ClientException;
use GuzzleHttp\Exception\ServerException;
use OC\Authentication\Token\IProvider;
use OC\Security\IdentityProof\Key;
use OC\Security\IdentityProof\Manager;
use OCA\Notifications\Exceptions\InvalidDeviceTokenException;
use OCA\Notifications\Vendor\Minishlink\WebPush\MessageSentReport;
use OCP\AppFramework\Http;
use OCP\AppFramework\Services\IAppConfig;
use OCP\AppFramework\Utility\ITimeFactory;
use OCP\Authentication\Exceptions\InvalidTokenException;
use OCP\Authentication\Token\IToken;
use OCP\DB\QueryBuilder\IQueryBuilder;
use OCP\Http\Client\IClientService;
use OCP\IAppConfig as IGlobalAppConfig;
use OCP\ICache;
use OCP\ICacheFactory;
use OCP\IConfig;
use OCP\IDBConnection;
use OCP\IUser;
use OCP\IUserManager;
use OCP\L10N\IFactory;
use OCP\Notification\AlreadyProcessedException;
use OCP\Notification\IManager as INotificationManager;
use OCP\Notification\IncompleteParsedNotificationException;
use OCP\Notification\INotification;
use OCP\Security\ISecureRandom;
use OCP\UserStatus\IManager as IUserStatusManager;
use OCP\UserStatus\IUserStatus;
use OCP\Util;
use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 *
 */
class Push {
	/**
	 * Only push to devices that were online in the last 60 days
	 */
	public const MAX_PUSH_AGE = 60 * 24 * 60 * 60;

	/**
	 * Only push to the X most recent devices
	 */
	public const DEVICE_LIMIT = 20;

	protected ICache $cache;
	protected ?OutputInterface $output = null;
	protected bool $limitedOutput = true;

	/**
	 * @psalm-var array<string, list<string>>
	 */
	protected array $payloadsToSend = [];
	protected bool $deferPreparing = false;
	protected bool $deferPayloads = false;
	/**
	 * @var array[] $userId => $appId => $notificationIds
	 * @psalm-var array<string|int, array<string, list<int>>>
	 */
	protected array $deletesToPush = [];
	/**
	 * @psalm-var array<string|int, bool>
	 */
	protected array $deleteAllsToPush = [];
	/** @var INotification[] */
	protected array $notificationsToPush = [];

	/**
	 * @psalm-var array<string, ?IUserStatus>
	 */
	protected array $userStatuses = [];
	/**
	 * @psalm-var array<string, list<array{id: int, uid: string, token: int, endpoint: string, ua_public: string, auth: string, app_types: string, activated: bool, activation_token: string}>>
	 */
	protected array $userWebPushDevices = [];
	/**
	 * @psalm-var array<string, list<array{id: int, uid: string, token: int, deviceidentifier: string, devicepublickey: string, devicepublickeyhash: string, pushtokenhash: string, proxyserver: string, apptype: string}>>
	 */
	protected array $userProxyDevices = [];
	/** @var string[] */
	protected array $loadDevicesForUsers = [];
	/** @var string[] */
	protected array $loadStatusForUsers = [];

	public function __construct(
		protected IDBConnection $db,
		protected IUserManager $userManager,
		protected INotificationManager $notificationManager,
		protected IConfig $config,
		protected IAppConfig $appConfig,
		protected IGlobalAppConfig $globalAppConfig,
		protected WebPushClient $wpClient,
		protected IProvider $tokenProvider,
		protected Manager $keyManager,
		protected IClientService $clientService,
		ICacheFactory $cacheFactory,
		protected IUserStatusManager $userStatusManager,
		protected IFactory $l10nFactory,
		protected ITimeFactory $timeFactory,
		protected ISecureRandom $random,
		protected LoggerInterface $log,
	) {
		$this->cache = $cacheFactory->createDistributed('pushtokens');
	}

	public function setOutput(OutputInterface $output, bool $limitedOutput = true): void {
		$this->output = $output;
		$this->limitedOutput = $limitedOutput;
	}

	protected function printInfo(string $message, string $verboseMessage = ''): void {
		if ($this->output) {
			$this->output->writeln($message);
			if ($verboseMessage !== '' && !$this->limitedOutput) {
				$this->output->writeln($verboseMessage);
			}
		}
	}

	public function isDeferring(): bool {
		return $this->deferPayloads;
	}

	public function deferPayloads(): void {
		$this->deferPreparing = true;
		$this->deferPayloads = true;
	}

	public function flushPayloads(): void {
		$this->deferPreparing = false;

		if (!empty($this->loadDevicesForUsers)) {
			$this->loadDevicesForUsers = array_unique($this->loadDevicesForUsers);
			// Add missing web push devices
			$missingWebPushDevicesFor = array_diff($this->loadDevicesForUsers, array_keys($this->userWebPushDevices));
			$newUserWebPushDevices = $this->getWebPushDevicesForUsers($missingWebPushDevicesFor);
			foreach ($missingWebPushDevicesFor as $userId) {
				$this->userWebPushDevices[$userId] = $newUserWebPushDevices[$userId] ?? [];
			}
			// Add missing proxy devices
			$missingProxyDevicesFor = array_diff($this->loadDevicesForUsers, array_keys($this->userProxyDevices));
			$newUserProxyDevices = $this->getProxyDevicesForUsers($missingProxyDevicesFor);
			foreach ($missingProxyDevicesFor as $userId) {
				$this->userProxyDevices[$userId] = $newUserProxyDevices[$userId] ?? [];
			}
			$this->loadDevicesForUsers = [];
		}

		if (!empty($this->loadStatusForUsers)) {
			$this->loadStatusForUsers = array_unique($this->loadStatusForUsers);
			$missingStatusFor = array_diff($this->loadStatusForUsers, array_keys($this->userStatuses));
			$newUserStatuses = $this->userStatusManager->getUserStatuses($missingStatusFor);
			foreach ($missingStatusFor as $userId) {
				$this->userStatuses[$userId] = $newUserStatuses[$userId] ?? null;
			}
			$this->loadStatusForUsers = [];
		}

		if (!empty($this->notificationsToPush)) {
			foreach ($this->notificationsToPush as $id => $notification) {
				$this->pushToDevice($id, $notification);
			}
			$this->notificationsToPush = [];
		}

		if (!empty($this->deleteAllsToPush)) {
			foreach ($this->deleteAllsToPush as $userId => $bool) {
				$this->pushDeleteToDevice((string)$userId, null);
			}
			$this->deleteAllsToPush = [];
		}

		if (!empty($this->deletesToPush)) {
			foreach ($this->deletesToPush as $userId => $data) {
				foreach ($data as $app => $notificationIds) {
					$this->pushDeleteToDevice((string)$userId, $notificationIds, $app);
				}
			}
			$this->deletesToPush = [];
		}

		$this->deferPayloads = false;
		$this->wpClient->flush(fn ($r) => $this->webPushCallback($r));
		$this->sendNotificationsToProxies();
	}

	/**
	 * @psalm-param list<array{id: int, uid: string, token: int, endpoint: string, ua_public: string, auth: string, app_types: string, activated: bool, activation_token: string}> $devices
	 * @psalm-return list<array{id: int, uid: string, token: int, endpoint: string, ua_public: string, auth: string, app_types: string, activated: bool, activation_token: string}>
	 */
	public function filterWebPushDeviceList(array $devices, string $app): array {
		// Consider all 3 options as 'talk'
		if (\in_array($app, ['spreed', 'talk', 'admin_notification_talk'], true)) {
			$app = 'talk';
		}

		$devices = array_values(array_filter($devices, function ($device) use ($app) {
			$appTypes = explode(',', $device['app_types']);
			return $device['activated'] && (\in_array($app, $appTypes)
				|| (\in_array('all', $appTypes) && !\in_array('-' . $app, $appTypes)));
		}));

		return $this->filterByTokenAge($devices);
	}


	/**
	 * @param array $devices
	 * @psalm-param $devices list<array{id: int, uid: string, token: int, deviceidentifier: string, devicepublickey: string, devicepublickeyhash: string, pushtokenhash: string, proxyserver: string, apptype: string}>
	 * @param string $app
	 * @return array
	 * @psalm-return list<array{id: int, uid: string, token: int, deviceidentifier: string, devicepublickey: string, devicepublickeyhash: string, pushtokenhash: string, proxyserver: string, apptype: string}>
	 */
	public function filterProxyDeviceList(array $devices, string $app): array {
		$isTalkNotification = \in_array($app, ['spreed', 'talk', 'admin_notification_talk'], true);

		$talkDevices = array_filter($devices, static fn ($device) => $device['apptype'] === 'talk');
		$otherDevices = array_filter($devices, static fn ($device) => $device['apptype'] !== 'talk');

		$this->printInfo('Identified ' . count($talkDevices) . ' Talk devices and ' . count($otherDevices) . ' others.');

		if ($isTalkNotification) {
			// If you don't have a talk device, we fall back to the files app.
			$devices = $talkDevices ?: $otherDevices;
		} else {
			// We only send file notifications to the files app.
			// If you don't have such a device, we don't fall back
			$devices = $otherDevices;
		}

		if (empty($devices)) {
			return [];
		}

		return $this->filterByTokenAge(array_values($devices));
	}

	/**
	 * @template H
	 * @param list<H> $devices
	 * @return list<H>
	 */
	protected function filterByTokenAge(array $devices): array {

		// We don't push to devices that are older than 60 days
		$maxAge = $this->timeFactory->getTime() - self::MAX_PUSH_AGE;

		$tokenAgeList = $deviceList = [];
		foreach ($devices as $device) {
			$device['token'] = (int)$device['token'];
			$this->printInfo('');
			$this->printInfo('Device token: ' . $device['token']);

			try {
				$tokenAge = $this->validateTokenAndGetAge($device['token']);
			} catch (InvalidDeviceTokenException) {
				if (isset($device['endpoint'])) {
					$this->deleteWebPushToken($device['token']);
				} else {
					$this->deleteProxyPushToken($device['token']);
				}
				continue;
			}

			if ($tokenAge !== 0 && $tokenAge <= $maxAge) {
				$this->printInfo('<comment>Device token ' . $device['token'] . ' "last checked" is older than 60 days: ' . $tokenAge . '</comment>');
				continue;
			}

			$tokenAgeList[$device['token']] = $tokenAge;
			$deviceList[$device['token']] = $device;
		}

		if (count($deviceList) < self::DEVICE_LIMIT) {
			return array_values($deviceList);
		}

		arsort($tokenAgeList);
		$tokenAgeList = array_slice($tokenAgeList, 0, self::DEVICE_LIMIT);
		$devices = [];
		foreach ($deviceList as $device) {
			if (!isset($tokenAgeList[$device['token']]) && $tokenAgeList[$device['token']] !== 0) {
				$this->printInfo('<comment>Device token ' . $device['token'] . ' is not in the most recent 20 devices: ' . $tokenAgeList[$device['token']] . '</comment>');
				continue;
			}

			$devices[] = $device;
		}

		return $devices;
	}

	public function pushToDevice(int $id, INotification $notification): void {
		if (!$this->config->getSystemValueBool('has_internet_connection', true)) {
			$this->printInfo('<error>Internet connectivity is disabled in configuration file - no push notifications will be sent</error>');

			return;
		}

		if ($this->deferPreparing) {
			$this->notificationsToPush[$id] = clone $notification;
			$this->loadDevicesForUsers[] = $notification->getUser();
			$this->loadStatusForUsers[] = $notification->getUser();
			return;
		}

		$user = $this->userManager->getExistingUser($notification->getUser());

		if (!array_key_exists($notification->getUser(), $this->userStatuses)) {
			$userStatus = $this->userStatusManager->getUserStatuses([
				$notification->getUser(),
			]);

			$this->userStatuses[$notification->getUser()] = $userStatus[$notification->getUser()] ?? null;
		}

		if (isset($this->userStatuses[$notification->getUser()])) {
			$userStatus = $this->userStatuses[$notification->getUser()];
			if ($userStatus instanceof IUserStatus
				&& $userStatus->getStatus() === IUserStatus::DND
				&& !$notification->isPriorityNotification()) {
				$this->printInfo('<error>User status is set to DND - no push notifications will be sent</error>');
				return;
			}
		}

		if (!array_key_exists($notification->getUser(), $this->userWebPushDevices)) {
			$webPushDevices = $this->getWebPushDevicesForUser($notification->getUser());
			$this->userWebPushDevices[$notification->getUser()] = $webPushDevices;
		} else {
			$webPushDevices = $this->userWebPushDevices[$notification->getUser()];
		}
		if (!array_key_exists($notification->getUser(), $this->userProxyDevices)) {
			$proxyDevices = $this->getProxyDevicesForUser($notification->getUser());
			$this->userProxyDevices[$notification->getUser()] = $proxyDevices;
		} else {
			$proxyDevices = $this->userProxyDevices[$notification->getUser()];
		}

		if (empty($proxyDevices) && empty($webPushDevices)) {
			$this->printInfo('<comment>No devices found for user</comment>');
			return;
		}

		if (!$notification->isValidParsed()) {
			$language = $this->l10nFactory->getUserLanguage($user);
			$this->printInfo('Language is set to ' . $language);

			try {
				$this->notificationManager->setPreparingPushNotification(true);
				$notification = $this->notificationManager->prepare($notification, $language);
			} catch (AlreadyProcessedException|IncompleteParsedNotificationException|\InvalidArgumentException $e) {
				// FIXME remove \InvalidArgumentException in Nextcloud 39
				$this->printInfo('Error when preparing notification for push: ' . get_class($e));
				return;
			} finally {
				$this->notificationManager->setPreparingPushNotification(false);
			}
		}

		$this->webPushToDevice($id, $user, $webPushDevices, $notification);
		$this->proxyPushToDevice($id, $user, $proxyDevices, $notification);
	}

	/**
	 * @param list<array{id: int, uid: string, token: int, endpoint: string, ua_public: string, auth: string, app_types: string, activated: bool, activation_token: string}> $devices
	 */
	public function webPushToDevice(int $id, IUser $user, array $devices, INotification $notification): void {
		if (empty($devices)) {
			$this->printInfo('<comment>No web push devices found for user</comment>');
			return;
		}

		$this->printInfo('');
		$this->printInfo('Found ' . count($devices) . ' devices registered for push notifications');
		$devices = $this->filterWebPushDeviceList($devices, $notification->getApp());
		if (empty($devices)) {
			$this->printInfo('<comment>No devices left after filtering</comment>');
			return;
		}
		$this->printInfo('Trying to push to ' . count($devices) . ' devices');

		foreach ($devices as $device) {
			$device['token'] = (int)$device['token'];
			$this->printInfo('');
			$this->printInfo('Device token: ' . $device['token']);

			// If the endpoint got a 429 TOO_MANY_REQUESTS,
			// we wait for the time sent by the server
			if ($this->cache->get('wp.' . $device['endpoint'])) {
				// It would be better to cache the notification to send it later
				// in this case, but
				// 429 is rare, and ~ an emergency response: dropping the notification
				// is a solution good enough to not overload the push server
				continue;
			}

			try {
				$data = $this->encodeNotif($id, $notification, 3000);
				$urgency = $this->getNotifTopicAndUrgency($data['app'], $data['type'])['urgency'];
				$this->wpClient->enqueue(
					$device['endpoint'],
					$device['ua_public'],
					$device['auth'],
					json_encode($data, JSON_THROW_ON_ERROR),
					urgency: $urgency
				);
			} catch (\JsonException $e) {
				$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
			} catch (\ErrorException $e) {
				$this->log->error('Error while sending push notification: ' . $e->getMessage(), ['exception' => $e]);
			} catch (\InvalidArgumentException) {
				// Failed to encrypt message for device: public key is invalid
				$this->deleteWebPushToken($device['token']);
			}
		}
		$this->printInfo('');

		if (!$this->deferPayloads) {
			$this->wpClient->flush(fn ($r) => $this->webPushCallback($r));
		}
	}

	public function proxyPushToDevice(int $id, IUser $user, array $devices, INotification $notification): void {
		if (empty($devices)) {
			$this->printInfo('<comment>No proxy devices found for user</comment>');
			return;
		}

		$userKey = $this->keyManager->getKey($user);

		$this->printInfo('Private user key size: ' . strlen($userKey->getPrivate()));
		$this->printInfo('Public user key size: ' . strlen($userKey->getPublic()));

		$this->printInfo('');
		$this->printInfo('Found ' . count($devices) . ' devices registered for push notifications');
		$isTalkNotification = \in_array($notification->getApp(), ['spreed', 'talk', 'admin_notification_talk'], true);
		$devices = $this->filterProxyDeviceList($devices, $notification->getApp());
		if (empty($devices)) {
			$this->printInfo('<comment>No devices left after filtering</comment>');
			return;
		}
		$this->printInfo('Trying to push to ' . count($devices) . ' devices');

		foreach ($devices as $device) {
			$device['token'] = (int)$device['token'];
			$this->printInfo('');
			$this->printInfo('Device token: ' . $device['token']);

			try {
				$payload = json_encode($this->encryptAndSign($userKey, $device, $id, $notification, $isTalkNotification), JSON_THROW_ON_ERROR);

				$proxyServer = rtrim($device['proxyserver'], '/');
				if (!isset($this->payloadsToSend[$proxyServer])) {
					$this->payloadsToSend[$proxyServer] = [];
				}
				$this->payloadsToSend[$proxyServer][] = $payload;
			} catch (\JsonException $e) {
				$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
			} catch (\InvalidArgumentException) {
				// Failed to encrypt message for device: public key is invalid
				$this->deleteProxyPushToken($device['token']);
			}
		}
		$this->printInfo('');

		if (!$this->deferPayloads) {
			$this->sendNotificationsToProxies();
		}
	}

	/**
	 * @param string $userId
	 * @param ?int[] $notificationIds
	 * @param string $app
	 */
	public function pushDeleteToDevice(string $userId, ?array $notificationIds, string $app = ''): void {
		if (!$this->config->getSystemValueBool('has_internet_connection', true)) {
			return;
		}

		if ($this->deferPreparing) {
			if ($notificationIds === null) {
				$this->deleteAllsToPush[$userId] = true;
				if (isset($this->deletesToPush[$userId])) {
					unset($this->deletesToPush[$userId]);
				}
			} else {
				if (isset($this->deleteAllsToPush[$userId])) {
					return;
				}

				$isTalkNotification = \in_array($app, ['spreed', 'talk', 'admin_notification_talk'], true);
				$clientGroup = $isTalkNotification ? 'talk' : $app;

				if (!isset($this->deletesToPush[$userId])) {
					$this->deletesToPush[$userId] = [];
				}
				if (!isset($this->deletesToPush[$userId][$clientGroup])) {
					$this->deletesToPush[$userId][$clientGroup] = [];
				}

				foreach ($notificationIds as $notificationId) {
					$this->deletesToPush[$userId][$clientGroup][] = $notificationId;
				}
			}
			$this->loadDevicesForUsers[] = $userId;
			return;
		}

		$deleteAll = $notificationIds === null;

		$user = $this->userManager->getExistingUser($userId);

		if (!array_key_exists($userId, $this->userWebPushDevices)) {
			$webPushDevices = $this->getWebPushDevicesForUser($userId);
			$this->userWebPushDevices[$userId] = $webPushDevices;
		} else {
			$webPushDevices = $this->userWebPushDevices[$userId];
		}
		if (!array_key_exists($userId, $this->userProxyDevices)) {
			$proxyDevices = $this->getProxyDevicesForUser($userId);
			$this->userProxyDevices[$userId] = $proxyDevices;
		} else {
			$proxyDevices = $this->userProxyDevices[$userId];
		}

		if (!$deleteAll) {
			// Only filter when it's not delete-all
			$webPushDevices = $this->filterWebPushDeviceList($webPushDevices, $app);
			$proxyDevices = $this->filterProxyDeviceList($proxyDevices, $app);
		}

		$this->webPushDeleteToDevice($userId, $user, $webPushDevices, $deleteAll, $notificationIds, $app);
		$this->proxyPushDeleteToDevice($userId, $user, $proxyDevices, $deleteAll, $notificationIds, $app);
	}

	/**
	 * @param string $userId
	 * @param IUser $user
	 * @param bool $deleteAll
	 * @param ?int[] $notificationIds
	 * @param string $app
	 */
	public function webPushDeleteToDevice(string $userId, IUser $user, array $devices, bool $deleteAll, ?array $notificationIds, string $app = ''): void {
		if (empty($devices)) {
			return;
		}

		foreach ($devices as $device) {
			$device['token'] = (int)$device['token'];

			// If the endpoint got a 429 TOO_MANY_REQUESTS,
			// we wait for the time sent by the server
			if ($this->cache->get('wp.' . $device['endpoint'])) {
				// It would be better to cache the notification to send it later
				// in this case, but
				// 429 is rare, and ~ an emergency response: dropping the notification
				// is a solution good enough to not overload the push server
				continue;
			}

			try {
				if ($deleteAll) {
					$data = $this->encodeDeleteNotifs(null);
					try {
						$payload = json_encode($data['data'], JSON_THROW_ON_ERROR);
						$this->wpClient->enqueue($device['endpoint'], $device['ua_public'], $device['auth'], $payload);
					} catch (\JsonException $e) {
						$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
					}
				} else {
					$temp = $notificationIds;

					while (!empty($temp)) {
						$data = $this->encodeDeleteNotifs($temp);
						$temp = $data['remaining'];
						try {
							$payload = json_encode($data['data'], JSON_THROW_ON_ERROR);
							$this->wpClient->enqueue($device['endpoint'], $device['ua_public'], $device['auth'], $payload);
						} catch (\JsonException $e) {
							$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
						}
					}
				}
			} catch (\InvalidArgumentException) {
				// Failed to encrypt message for device: public key is invalid
				$this->deleteWebPushToken($device['token']);
			}
		}

		if (!$this->deferPayloads) {
			$this->sendNotificationsToProxies();
		}
	}

	/**
	 * @param string $userId
	 * @param IUser $user
	 * @param bool $deleteAll
	 * @param ?int[] $notificationIds
	 * @param string $app
	 */
	public function proxyPushDeleteToDevice(string $userId, IUser $user, array $devices, bool $deleteAll, ?array $notificationIds, string $app = ''): void {
		if (empty($devices)) {
			return;
		}

		$userKey = $this->keyManager->getKey($user);
		foreach ($devices as $device) {
			$device['token'] = (int)$device['token'];
			try {
				$proxyServer = rtrim($device['proxyserver'], '/');
				if (!isset($this->payloadsToSend[$proxyServer])) {
					$this->payloadsToSend[$proxyServer] = [];
				}

				if ($deleteAll) {
					$data = $this->encryptAndSignDelete($userKey, $device, null);
					try {
						$this->payloadsToSend[$proxyServer][] = json_encode($data['payload'], JSON_THROW_ON_ERROR);
					} catch (\JsonException $e) {
						$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
					}
				} else {
					// The nextcloud application, requested with the proxy push,
					// use to not support `delete-multiple`
					if (!\in_array($app, ['spreed', 'talk', 'admin_notification_talk'], true)) {
						foreach ($notificationIds ?? [] as $notificationId) {
							$data = $this->encryptAndSignDelete($userKey, $device, [$notificationId]);
							try {
								$this->payloadsToSend[$proxyServer][] = json_encode($data['payload'], JSON_THROW_ON_ERROR);
							} catch (\JsonException $e) {
								$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
							}
						}
					} else {
						$temp = $notificationIds;
						while (!empty($temp)) {
							$data = $this->encryptAndSignDelete($userKey, $device, $temp);
							$temp = $data['remaining'];
							try {
								$this->payloadsToSend[$proxyServer][] = json_encode($data['payload'], JSON_THROW_ON_ERROR);
							} catch (\JsonException $e) {
								$this->log->error('JSON error while encoding push notification: ' . $e->getMessage(), ['exception' => $e]);
							}
						}
					}
				}
			} catch (\InvalidArgumentException) {
				// Failed to encrypt message for device: public key is invalid
				$this->deleteProxyPushToken($device['token']);
			}
		}

		if (!$this->deferPayloads) {
			$this->sendNotificationsToProxies();
		}
	}

	/**
	 * Delete expired web push subscriptions
	 */
	protected function webPushCallback(MessageSentReport $report): void {
		if ($report->isSubscriptionExpired()) {
			$this->deleteWebPushTokenByEndpoint($report->getEndpoint());
		} elseif ($report->getResponse()?->getStatusCode() === 429) {
			$retryAfter = (int)($report->getResponse()?->getHeader('Retry-After')[0] ?? '60');
			$this->cache->set('wp.' . $report->getEndpoint(), true, $retryAfter);
		}
	}

	protected function sendNotificationsToProxies(): void {
		$pushNotifications = $this->payloadsToSend;
		$this->payloadsToSend = [];
		if (empty($pushNotifications)) {
			return;
		}

		if (!$this->notificationManager->isFairUseOfFreePushService()) {
			/**
			 * We want to keep offering our push notification service for free, but large
			 * users overload our infrastructure. For this reason we have to rate-limit the
			 * use of push notifications. If you need this feature, consider using Nextcloud Enterprise.
			 */
			return;
		}

		$subscriptionAwareServer = rtrim($this->appConfig->getAppValueString('subscription_aware_server', 'https://push-notifications.nextcloud.com'), '/');
		if ($subscriptionAwareServer === 'https://push-notifications.nextcloud.com') {
			$subscriptionKey = $this->globalAppConfig->getValueString('support', 'subscription_key');
		} else {
			$subscriptionKey = $this->appConfig->getAppValueString('push_subscription_key');
			if ($subscriptionKey === '') {
				$subscriptionKey = $this->createPushSubscriptionKey();
				$this->appConfig->setAppValueString('push_subscription_key', $subscriptionKey);
			}
		}

		$client = $this->clientService->newClient();
		foreach ($pushNotifications as $proxyServer => $notifications) {
			try {
				$requestData = [
					'body' => [
						'notifications' => $notifications,
					],
				];

				if ($subscriptionKey !== '' && $proxyServer === $subscriptionAwareServer) {
					$requestData['headers']['X-Nextcloud-Subscription-Key'] = $subscriptionKey;
				}

				$postStartTime = microtime(true);
				$response = $client->post($proxyServer . '/notifications', $requestData);
				$postEndTime = microtime(true);

				$this->printInfo('<comment>Request to push proxy [' . $proxyServer . '] took ' . (string)round($postEndTime - $postStartTime, 2) . 's</comment>');

				$status = $response->getStatusCode();
				$body = (string)$response->getBody();
				try {
					$bodyData = json_decode($body, true);
				} catch (\JsonException) {
					$bodyData = null;
				}
			} catch (ClientException $e) {
				// Server responded with 4xx (400 Bad Request mostlikely)
				$response = $e->getResponse();
				$status = $response->getStatusCode();
				$body = $response->getBody()->getContents();
				try {
					$bodyData = json_decode($body, true);
				} catch (\JsonException) {
					$bodyData = null;
				}
			} catch (ServerException $e) {
				// Server responded with 5xx
				$response = $e->getResponse();
				$body = $response->getBody()->getContents();
				$error = \is_string($body) ? $body : ('no reason given (' . $response->getStatusCode() . ')');

				$this->log->debug('Could not send notification to push server [{url}]: {error}', [
					'error' => $error,
					'url' => $proxyServer,
					'app' => 'notifications',
				]);

				$this->printInfo('<error>Could not send notification to push server [' . $proxyServer . ']</error>', '<error>' . $error . '</error>');
				continue;
			} catch (\Exception $e) {
				$this->log->error($e->getMessage(), [
					'exception' => $e,
				]);

				$error = $e->getMessage() ?: 'no reason given';
				$this->printInfo('<error>Could not send notification to push server [' . $e::class . ']</error>', '<error>' . $error . '</error>');
				continue;
			}

			if (is_array($bodyData) && array_key_exists('unknown', $bodyData) && array_key_exists('failed', $bodyData)) {
				if (is_array($bodyData['unknown'])) {
					// Proxy returns null when the array is empty
					foreach ($bodyData['unknown'] as $unknownDevice) {
						$this->printInfo('<comment>Deleting device because it is unknown by the push server [' . $proxyServer . ']: ' . $unknownDevice . '</comment>');
						$this->deleteProxyPushTokenByDeviceIdentifier($proxyServer, $unknownDevice);
					}
				}

				if ($bodyData['failed'] !== 0) {
					$this->printInfo('<comment>Push notification sent, but ' . $bodyData['failed'] . ' failed</comment>');
				} else {
					$this->printInfo('<info>Push notification sent successfully</info>');
				}
			} elseif ($status !== Http::STATUS_OK) {
				if ($status === Http::STATUS_TOO_MANY_REQUESTS) {
					$this->appConfig->setAppValueInt('rate_limit_reached', $this->timeFactory->getTime());
				}
				$error = $body && $bodyData === null ? $body : 'no reason given';
				$this->printInfo('<error>Could not send notification to push server [' . $proxyServer . ']</error>', '<error>' . $error . '</error>');
				$this->log->warning('Could not send notification to push server [{url}]: {error}', [
					'error' => $error,
					'url' => $proxyServer,
					'app' => 'notifications',
				]);
			} else {
				$error = $body && $bodyData === null ? $body : 'no reason given';
				$this->printInfo('<comment>Push notification sent but response was not parsable, using an outdated push proxy? [' . $proxyServer . ']</comment>', '<comment>' . $error . '</comment>');
				$this->log->info('Push notification sent but response was not parsable, using an outdated push proxy? [{url}]: {error}', [
					'error' => $error,
					'url' => $proxyServer,
					'app' => 'notifications',
				]);
			}
		}
	}

	/**
	 * @throws InvalidDeviceTokenException
	 */
	protected function validateTokenAndGetAge(int $tokenId): int {
		// This is a web session token
		if ($tokenId < 0) {
			// Temporarily allowing all
			return 0;
		}

		$age = $this->cache->get('t' . $tokenId);

		if ($age === null) {
			try {
				// Check if the token is still valid...
				$token = $this->tokenProvider->getTokenById($tokenId);
				$type = $this->callSafelyForToken($token, 'getType');
				if ($type === IToken::WIPE_TOKEN) {
					// Token does not exist any more, should drop the push device entry
					$this->printInfo('Device token ' . $tokenId . ' is marked for remote wipe');
					$this->cache->set('t' . $tokenId, 0, 600);
					throw new InvalidDeviceTokenException('wipe');
				}

				$age = $token->getLastCheck();
				$lastActivity = $this->callSafelyForToken($token, 'getLastActivity');
				if ($lastActivity) {
					$age = max($age, $lastActivity);
				}
				$this->cache->set('t' . $tokenId, $age, 600);
			} catch (InvalidTokenException) {
				// Token does not exist any more, should drop the push device entry
				$this->printInfo('<error>InvalidTokenException is thrown for ' . $tokenId . '</error>');
				$this->cache->set('t' . $tokenId, 0, 600);
				throw new InvalidDeviceTokenException('invalid');
			}
		}

		return $age;
	}

	/**
	 * The functions are not part of public API so we are a bit more careful
	 * @param IToken $token
	 * @param 'getLastActivity'|'getType' $method
	 * @return int|null
	 */
	protected function callSafelyForToken(IToken $token, string $method): ?int {
		if (method_exists($token, $method) || method_exists($token, '__call')) {
			try {
				$result = $token->$method();
				if (is_int($result)) {
					return $result;
				}
			} catch (\BadFunctionCallException) {
			}
		}
		return null;
	}

	/**
	 * @param int $id
	 * @param INotification $notification
	 * @param int $maxLength max length of the push notification (shorter than 240 for proxy push, 3993 for webpush)
	 * @return array
	 * @psalm-return array{nid: int, app: string, subject: string, type: string, id: string}
	 */
	protected function encodeNotif(int $id, INotification $notification, int $maxLength): array {
		$data = [
			'nid' => $id,
			'app' => $notification->getApp(),
			'subject' => '',
			'type' => $notification->getObjectType(),
			'id' => $notification->getObjectId(),
		];

		// Max length of encryption is ~240, so we need to make sure the subject is shorter.
		// Also, subtract two for encapsulating quotes will be added.
		$maxDataLength = $maxLength - strlen((string)json_encode($data)) - 2;
		$data['subject'] = Util::shortenMultibyteString($notification->getParsedSubject(), $maxDataLength);
		if ($notification->getParsedSubject() !== $data['subject']) {
			$data['subject'] .= '…';
		}
		return $data;
	}

	/**
	 * @param ?int[] $ids
	 * @return array
	 * @psalm-return array{data: array{'delete-all'?: true, 'delete-multiple'?: true, delete?: true, nid?: int, nids?: int[]}, remaining: int[]}
	 */
	protected function encodeDeleteNotifs(?array $ids): array {
		$remainingIds = [];
		if ($ids === null) {
			$data = [
				'delete-all' => true,
			];
		} elseif (count($ids) === 1) {
			$data = [
				'nid' => array_pop($ids),
				'delete' => true,
			];
		} else {
			$remainingIds = array_splice($ids, 10);
			$data = [
				'nids' => $ids,
				'delete-multiple' => true,
			];
		}
		return [
			'remaining' => $remainingIds,
			'data' => $data
		];
	}

	/**
	 * Get notification urgency (priority) and topic, the urgency is compatible with
	 * [RFC8030's Urgency](https://www.rfc-editor.org/rfc/rfc8030#section-5.3)
	 *
	 *
	 * @param string app
	 * @param string type
	 * @return array
	 * @psalm-return array{urgency: string, type: string}
	 */
	protected function getNotifTopicAndUrgency(string $app, string $type): array {
		$res = [];
		if (\in_array($app, ['spreed', 'talk', 'admin_notification_talk'], true)) {
			$res['urgency'] = 'high';
			$res['type'] = $type === 'call' ? 'voip' : 'alert';
		} elseif ($app === 'twofactor_nextcloud_notification' || $app === 'phonetrack') {
			$res['urgency'] = 'high';
			$res['type'] = 'alert';
		} else {
			$res['urgency'] = 'normal';
			$res['type'] = 'alert';
		}
		return $res;
	}

	/**
	 * @param Key $userKey
	 * @param array $device
	 * @param int $id
	 * @param INotification $notification
	 * @param bool $isTalkNotification
	 * @return array
	 * @psalm-return array{deviceIdentifier: string, pushTokenHash: string, subject: string, signature: string, priority: string, type: string}
	 * @throws InvalidTokenException
	 * @throws \InvalidArgumentException
	 */
	protected function encryptAndSign(Key $userKey, array $device, int $id, INotification $notification, bool $isTalkNotification): array {
		$data = $this->encodeNotif($id, $notification, 200);
		$ret = $this->getNotifTopicAndUrgency($data['app'], $data['type']);
		$priority = $ret['urgency'];
		$type = $ret['type'];

		$this->printInfo('Device public key size: ' . strlen($device['devicepublickey']));
		$this->printInfo('Data to encrypt is: ' . json_encode($data));

		if (!openssl_public_encrypt(json_encode($data), $encryptedSubject, $device['devicepublickey'], OPENSSL_PKCS1_PADDING)) {
			$error = openssl_error_string();
			$this->log->error($error, ['app' => 'notifications']);
			$this->printInfo('<error>Error while encrypting data: "' . $error . '"</error>');
			throw new \InvalidArgumentException('Failed to encrypt message for device');
		}

		if (openssl_sign($encryptedSubject, $signature, $userKey->getPrivate(), OPENSSL_ALGO_SHA512)) {
			$this->printInfo('Signed encrypted push subject');
		} else {
			$this->printInfo('<error>Failed to signed encrypted push subject</error>');
		}
		$base64EncryptedSubject = base64_encode($encryptedSubject);
		$base64Signature = base64_encode($signature);

		return [
			'deviceIdentifier' => $device['deviceidentifier'],
			'pushTokenHash' => $device['pushtokenhash'],
			'subject' => $base64EncryptedSubject,
			'signature' => $base64Signature,
			'priority' => $priority,
			'type' => $type,
		];
	}

	/**
	 * @param Key $userKey
	 * @param array $device
	 * @param ?int[] $ids
	 * @return array
	 * @psalm-return array{remaining: list<int>, payload: array{deviceIdentifier: string, pushTokenHash: string, subject: string, signature: string, priority: string, type: string}}
	 * @throws InvalidTokenException
	 * @throws \InvalidArgumentException
	 */
	protected function encryptAndSignDelete(Key $userKey, array $device, ?array $ids): array {
		$ret = $this->encodeDeleteNotifs($ids);
		$remainingIds = $ret['remaining'];
		$data = $ret['data'];

		if (!openssl_public_encrypt(json_encode($data), $encryptedSubject, $device['devicepublickey'], OPENSSL_PKCS1_PADDING)) {
			$this->log->error(openssl_error_string(), ['app' => 'notifications']);
			throw new \InvalidArgumentException('Failed to encrypt message for device');
		}

		openssl_sign($encryptedSubject, $signature, $userKey->getPrivate(), OPENSSL_ALGO_SHA512);
		$base64EncryptedSubject = base64_encode($encryptedSubject);
		$base64Signature = base64_encode($signature);

		return [
			'remaining' => $remainingIds,
			'payload' => [
				'deviceIdentifier' => $device['deviceidentifier'],
				'pushTokenHash' => $device['pushtokenhash'],
				'subject' => $base64EncryptedSubject,
				'signature' => $base64Signature,
				'priority' => 'normal',
				'type' => 'background',
			]
		];
	}

	/**
	 * @param string $uid
	 * @return array[]
	 * @psalm-return list<array{id: int, uid: string, token: int, deviceidentifier: string, devicepublickey: string, devicepublickeyhash: string, pushtokenhash: string, proxyserver: string, apptype: string}>
	 */
	protected function getProxyDevicesForUser(string $uid): array {
		$query = $this->db->getQueryBuilder();
		$query->select('*')
			->from('notifications_pushhash')
			->where($query->expr()->eq('uid', $query->createNamedParameter($uid)));

		$result = $query->executeQuery();
		$devices = $result->fetchAll();
		$result->closeCursor();

		return $devices;
	}

	/**
	 * @param string[] $userIds
	 * @return array<string, list<array{id: int, uid: string, token: int, deviceidentifier: string, devicepublickey: string, devicepublickeyhash: string, pushtokenhash: string, proxyserver: string, apptype: string}>>
	 */
	protected function getProxyDevicesForUsers(array $userIds): array {
		$query = $this->db->getQueryBuilder();
		$query->select('*')
			->from('notifications_pushhash')
			->where($query->expr()->in('uid', $query->createNamedParameter($userIds, IQueryBuilder::PARAM_STR_ARRAY)));

		$devices = [];
		$result = $query->executeQuery();
		while ($row = $result->fetch()) {
			if (!isset($devices[$row['uid']])) {
				$devices[$row['uid']] = [];
			}
			$devices[$row['uid']][] = $row;
		}

		$result->closeCursor();

		return $devices;
	}


	/**
	 * @param string $uid
	 * @return list<array{id: int, uid: string, token: int, endpoint: string, ua_public: string, auth: string, app_types: string, activated: bool, activation_token: string}>
	 */
	protected function getWebPushDevicesForUser(string $uid): array {
		if (!$this->appConfig->getAppValueBool('webpush_enabled')) {
			return [];
		}

		$query = $this->db->getQueryBuilder();
		$query->select('*')
			->from('notifications_webpush')
			->where($query->expr()->eq('uid', $query->createNamedParameter($uid)));

		$result = $query->executeQuery();
		/** @var list<array{id: int, uid: string, token: int, endpoint: string, ua_public: string, auth: string, app_types: string, activated: bool, activation_token: string}> $devices */
		$devices = $result->fetchAll();
		$result->closeCursor();

		return $devices;
	}

	/**
	 * @param string[] $userIds
	 * @return array<string, list<array{id: int, uid: string, token: int, endpoint: string, ua_public: string, auth: string, app_types: string, activated: bool, activation_token: string}>>
	 */
	protected function getWebPushDevicesForUsers(array $userIds): array {
		if (!$this->appConfig->getAppValueBool('webpush_enabled')) {
			return [];
		}

		$query = $this->db->getQueryBuilder();
		$query->select('*')
			->from('notifications_webpush')
			->where($query->expr()->in('uid', $query->createNamedParameter($userIds, IQueryBuilder::PARAM_STR_ARRAY)));

		$devices = [];
		$result = $query->executeQuery();
		while ($row = $result->fetch()) {
			/** @psalm-var array{id: int, uid: string, token: int, endpoint: string, ua_public: string, auth: string, app_types: string, activated: bool, activation_token: string} $row */
			if (!isset($devices[$row['uid']])) {
				$devices[$row['uid']] = [];
			}
			$devices[$row['uid']][] = $row;
		}

		$result->closeCursor();

		return $devices;
	}

	/**
	 * @param int $tokenId
	 * @return bool
	 */
	protected function deleteWebPushToken(int $tokenId): bool {
		$query = $this->db->getQueryBuilder();
		$query->delete('notifications_webpush')
			->where($query->expr()->eq('token', $query->createNamedParameter($tokenId, IQueryBuilder::PARAM_INT)));

		return $query->executeStatement() !== 0;
	}

	/**
	 * @param string $endpoint
	 * @return bool
	 */
	protected function deleteWebPushTokenByEndpoint(string $endpoint): bool {
		$query = $this->db->getQueryBuilder();
		$query->delete('notifications_webpush')
			->where($query->expr()->eq('endpoint', $query->createNamedParameter($endpoint)));

		return $query->executeStatement() !== 0;
	}

	/**
	 * @param int $tokenId
	 * @return bool
	 */
	protected function deleteProxyPushToken(int $tokenId): bool {
		$query = $this->db->getQueryBuilder();
		$query->delete('notifications_pushhash')
			->where($query->expr()->eq('token', $query->createNamedParameter($tokenId, IQueryBuilder::PARAM_INT)));

		return $query->executeStatement() !== 0;
	}

	/**
	 * @param string $deviceIdentifier
	 * @return bool
	 */
	protected function deleteProxyPushTokenByDeviceIdentifier(string $proxyServer, string $deviceIdentifier): bool {
		$query = $this->db->getQueryBuilder();
		$query->delete('notifications_pushhash')
			->where($query->expr()->eq('proxyserver', $query->createNamedParameter($proxyServer)))
			->andWhere($query->expr()->eq('deviceidentifier', $query->createNamedParameter($deviceIdentifier)));

		return $query->executeStatement() !== 0;
	}

	protected function createPushSubscriptionKey(): string {
		$key = $this->random->generate(25, ISecureRandom::CHAR_ALPHANUMERIC);
		return implode('-', str_split($key, 5));
	}
}