Status support - No Push and browser notifications when in DND

docs/ocs-endpoint-v2.md

@@ -26,7 +26,8 @@ In order to find out if notifications is installed/enabled on the server you can
             "delete-all",
             "icons",
             "rich-strings",
-            "action-web"
+            "action-web",
+            "user-status"
           ]
         }
       }
@@ -103,6 +104,13 @@ Status | Explanation
 `204 No Content` | please slow down the polling to once per hour, since there are no apps that can generate notifications
 `304 Not Modified` | The provided `If-None-Match` matches the ETag, response body is empty
 
+### Headers
+
+Status | Explanation
+---|---
+`ETag` | See https://tools.ietf.org/html/rfc7232#section-2.3
+`X-Nextcloud-User-Status` | Only available with the `user-status` capability. The user status (`away`, `dnd`, `offline`, `online`) should be taken into account and in case of `dnd` no notifications should be directly shown.
+
 ### Specification
 
 Optional elements are still set in the array, the value is just empty:

lib/Capabilities.php

@@ -46,6 +46,7 @@ public function getCapabilities(): array {
 					'icons',
 					'rich-strings',
 					'action-web',
+					'user-status',
 				],
 				'push' => [
 					'devices',

lib/Controller/EndpointController.php

@@ -34,6 +34,8 @@
 use OCP\Notification\IAction;
 use OCP\Notification\IManager;
 use OCP\Notification\INotification;
+use OCP\UserStatus\IManager as IUserStatusManager;
+use OCP\UserStatus\IUserStatus;
 
 class EndpointController extends OCSController {
 	/** @var Handler */
@@ -44,6 +46,8 @@ class EndpointController extends OCSController {
 	private $l10nFactory;
 	/** @var IUserSession */
 	private $session;
+	/** @var IUserStatusManager */
+	private $userStatusManager;
 	/** @var Push */
 	private $push;
 
@@ -53,13 +57,15 @@ public function __construct(string $appName,
 								IManager $manager,
 								IFactory $l10nFactory,
 								IUserSession $session,
+								IUserStatusManager $userStatusManager,
 								Push $push) {
 		parent::__construct($appName, $request);
 
 		$this->handler = $handler;
 		$this->manager = $manager;
 		$this->l10nFactory = $l10nFactory;
 		$this->session = $session;
+		$this->userStatusManager = $userStatusManager;
 		$this->push = $push;
 	}
 
@@ -71,10 +77,20 @@ public function __construct(string $appName,
 	 * @return DataResponse
 	 */
 	public function listNotifications(string $apiVersion): DataResponse {
+		$userStatus = $this->userStatusManager->getUserStatuses([
+			$this->getCurrentUser(),
+		]);
+
+		$headers = ['X-Nextcloud-User-Status' => IUserStatus::ONLINE];
+		if (isset($userStatus[$this->getCurrentUser()])) {
+			$userStatus = $userStatus[$this->getCurrentUser()];
+			$headers['X-Nextcloud-User-Status'] = $userStatus->getStatus();
+		}
+
 		// When there are no apps registered that use the notifications
 		// We stop polling for them.
 		if (!$this->manager->hasNotifiers()) {
-			return new DataResponse(null, Http::STATUS_NO_CONTENT);
+			return new DataResponse(null, Http::STATUS_NO_CONTENT, $headers);
 		}
 
 		$filter = $this->manager->createNotification();
@@ -98,11 +114,13 @@ public function listNotifications(string $apiVersion): DataResponse {
 		}
 
 		$eTag = $this->generateETag($notificationIds);
+
+		$headers['ETag'] = $eTag;
 		if ($apiVersion !== 'v1' && $this->request->getHeader('If-None-Match') === $eTag) {
-			return new DataResponse([], Http::STATUS_NOT_MODIFIED);
+			return new DataResponse([], Http::STATUS_NOT_MODIFIED, $headers);
 		}
 
-		return new DataResponse($data, Http::STATUS_OK, ['ETag' => $eTag]);
+		return new DataResponse($data, Http::STATUS_OK, $headers);
 	}
 
 	/**

lib/Push.php

@@ -39,6 +39,8 @@
 use OCP\L10N\IFactory;
 use OCP\Notification\IManager as INotificationManager;
 use OCP\Notification\INotification;
+use OCP\UserStatus\IManager as IUserStatusManager;
+use OCP\UserStatus\IUserStatus;
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Push {
@@ -58,6 +60,8 @@ class Push {
 	protected $clientService;
 	/** @var ICache */
 	protected $cache;
+	/** @var IUserStatusManager */
+	protected $userStatusManager;
 	/** @var IFactory */
 	protected $l10nFactory;
 	/** @var ILogger */
@@ -77,6 +81,7 @@ public function __construct(IDBConnection $connection,
 								IUserManager $userManager,
 								IClientService $clientService,
 								ICacheFactory $cacheFactory,
+								IUserStatusManager $userStatusManager,
 								IFactory $l10nFactory,
 								ILogger $log) {
 		$this->db = $connection;
@@ -87,6 +92,7 @@ public function __construct(IDBConnection $connection,
 		$this->userManager = $userManager;
 		$this->clientService = $clientService;
 		$this->cache = $cacheFactory->createDistributed('pushtokens');
+		$this->userStatusManager = $userStatusManager;
 		$this->l10nFactory = $l10nFactory;
 		$this->log = $log;
 	}
@@ -124,6 +130,18 @@ public function pushToDevice(int $id, INotification $notification, ?OutputInterf
 			return;
 		}
 
+		$userStatus = $this->userStatusManager->getUserStatuses([
+			$notification->getUser(),
+		]);
+
+		if (isset($userStatus[$notification->getUser()])) {
+			$userStatus = $userStatus[$notification->getUser()];
+			if ($userStatus->getStatus() === IUserStatus::DND) {
+				$this->printInfo('User status is set to DND');
+				return;
+			}
+		}
+
 		$devices = $this->getDevicesForUser($notification->getUser());
 		if (empty($devices)) {
 			$this->printInfo('No devices found for user');

src/App.vue

@@ -71,6 +71,7 @@ export default {
 			shutdown: false,
 			notifications: [],
 			lastETag: null,
+			userStatus: null,
 
 			/** @type {number} */
 			pollInterval: 30000, // milliseconds
@@ -99,6 +100,12 @@ export default {
 
 			return imagePath('notifications', iconPath)
 		},
+
+		showBrowserNotifications() {
+			return this.backgroundFetching
+				&& this.webNotificationsGranted
+				&& this.userStatus !== 'dnd'
+		},
 	},
 
 	mounted: function() {
@@ -216,6 +223,7 @@ export default {
 						this._setPollingInterval(300000)
 						return
 					} else if (response.data !== undefined && response.data.ocs !== undefined && response.data.ocs.data !== undefined && Array.isArray(response.data.ocs.data)) {
+						this.userStatus = response.headers['x-nextcloud-user-status']
 						this.lastETag = response.headers.etag
 						this.notifications = response.data.ocs.data
 					} else {

src/Components/Notification.vue

@@ -200,8 +200,7 @@ export default {
 		})
 
 		// Parents: TransitionGroup > NotificationsList
-		if (this.$parent.$parent.backgroundFetching
-			&& this.$parent.$parent.webNotificationsGranted) {
+		if (this.$parent.$parent.showBrowserNotifications) {
 			this._createWebNotification()
 		}
 	},

tests/Unit/CapabilitiesTest.php

@@ -39,6 +39,7 @@ public function testGetCapabilities() {
 					'icons',
 					'rich-strings',
 					'action-web',
+					'user-status',
 				],
 				'push' => [
 					'devices',

tests/Unit/Controller/EndpointControllerTest.php

@@ -37,6 +37,7 @@
 use OCP\Notification\IAction;
 use OCP\Notification\IManager;
 use OCP\Notification\INotification;
+use OCP\UserStatus\IManager as IUserStatusManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use function Sabre\Event\Loop\instance;
 
@@ -55,7 +56,8 @@ class EndpointControllerTest extends TestCase {
 
 	/** @var IUserSession|MockObject */
 	protected $session;
-
+	/** @var IUserStatusManager|MockObject */
+	protected $userStatusManager;
 	/** @var EndpointController */
 	protected $controller;
 
@@ -72,6 +74,7 @@ protected function setUp(): void {
 		$this->manager = $this->createMock(IManager::class);
 		$this->l10nFactory = $this->createMock(IFactory::class);
 		$this->session = $this->createMock(IUserSession::class);
+		$this->userStatusManager = $this->createMock(IUserStatusManager::class);
 		$this->user = $this->createMock(IUser::class);
 		$this->push = $this->createMock(Push::class);
 
@@ -93,6 +96,7 @@ protected function getController(array $methods = [], $username = 'username') {
 				$this->manager,
 				$this->l10nFactory,
 				$this->session,
+				$this->userStatusManager,
 				$this->push
 			);
 		}
@@ -105,6 +109,7 @@ protected function getController(array $methods = [], $username = 'username') {
 				$this->manager,
 				$this->l10nFactory,
 				$this->session,
+				$this->userStatusManager,
 				$this->push,
 			])
 			->setMethods($methods)

tests/Unit/PushTest.php

@@ -42,6 +42,7 @@
 use OCP\L10N\IFactory;
 use OCP\Notification\IManager as INotificationManager;
 use OCP\Notification\INotification;
+use OCP\UserStatus\IManager as IUserStatusManager;
 use PHPUnit\Framework\MockObject\MockObject;
 
 /**
@@ -69,6 +70,8 @@ class PushTest extends TestCase {
 	protected $cacheFactory;
 	/** @var ICache|MockObject */
 	protected $cache;
+	/** @var IUserStatusManager|MockObject */
+	protected $userStatusManager;
 	/** @var IFactory|MockObject */
 	protected $l10nFactory;
 	/** @var ILogger|MockObject */
@@ -86,6 +89,7 @@ protected function setUp(): void {
 		$this->clientService = $this->createMock(IClientService::class);
 		$this->cacheFactory = $this->createMock(ICacheFactory::class);
 		$this->cache = $this->createMock(ICache::class);
+		$this->userStatusManager = $this->createMock(IUserStatusManager::class);
 		$this->l10nFactory = $this->createMock(IFactory::class);
 		$this->logger = $this->createMock(ILogger::class);
 
@@ -110,6 +114,7 @@ protected function getPush(array $methods = []) {
 					$this->userManager,
 					$this->clientService,
 					$this->cacheFactory,
+					$this->userStatusManager,
 					$this->l10nFactory,
 					$this->logger,
 				])
@@ -126,6 +131,7 @@ protected function getPush(array $methods = []) {
 			$this->userManager,
 			$this->clientService,
 			$this->cacheFactory,
+			$this->userStatusManager,
 			$this->l10nFactory,
 			$this->logger
 		);