fix(calls): Make starting a call an explicit event

Signed-off-by: Joas Schilling <[email protected]>

docs/events.md

@@ -34,6 +34,14 @@ See the general [Nextcloud Developers - Events](https://docs.nextcloud.com/serve
 * After event: `OCA\Talk\Events\LobbyModifiedEvent`
 * Since: 18.0.0
 
+### Call started
+
+* Before event: `OCA\Talk\Events\BeforeCallStartedEvent`
+* After event: `OCA\Talk\Events\CallStartedEvent`
+  The after event might be skipped if the request lost the race to update the database.
+  A parallel request will have triggered the before and after events in the meantime.
+* Since: 20.0.0
+
 ### Call ended for everyone
 
 * Before event: `OCA\Talk\Events\BeforeCallEndedForEveryoneEvent`
@@ -47,12 +55,6 @@ Allows to verify a password and set a redirect URL for the invalid case
 * Event: `OCA\Talk\Events\RoomPasswordVerifyEvent`
 * Since: 18.0.0
 
-### Active since modified
-
-* Before event: `OCA\Talk\Events\BeforeActiveSinceModifiedEvent`
-* After event: `OCA\Talk\Events\ActiveSinceModifiedEvent`
-* Since: 20.0.0
-
 ## Participant related events
 
 ### Attendees added

lib/Activity/Listener.php

@@ -61,32 +61,13 @@ public function handle(Event $event): void {
 		};
 	}
 
-	protected function setActive(ParticipantModifiedEvent $event): void {
-		if ($event->getProperty() !== AParticipantModifiedEvent::PROPERTY_IN_CALL) {
-			return;
-		}
-
-		if ($event->getOldValue() !== Participant::FLAG_DISCONNECTED
-			|| $event->getNewValue() === Participant::FLAG_DISCONNECTED) {
-			return;
-		}
-
-		$participant = $event->getParticipant();
-		$this->roomService->setActiveSince(
-			$event->getRoom(),
-			$this->timeFactory->getDateTime(),
-			$participant->getSession() ? $participant->getSession()->getInCall() : Participant::FLAG_DISCONNECTED
-		);
-	}
-
 	protected function handleParticipantModified(ParticipantModifiedEvent $event): void {
 		if ($event->getProperty() !== AParticipantModifiedEvent::PROPERTY_IN_CALL) {
 			return;
 		}
 
 		if ($event->getOldValue() === Participant::FLAG_DISCONNECTED
 			|| $event->getNewValue() !== Participant::FLAG_DISCONNECTED) {
-			$this->setActive($event);
 			return;
 		}
 

lib/AppInfo/Application.php

@@ -30,7 +30,8 @@
 use OCA\Talk\Config;
 use OCA\Talk\Dashboard\TalkWidget;
 use OCA\Talk\Deck\DeckPluginLoader;
-use OCA\Talk\Events\ActiveSinceModifiedEvent;
+use OCA\Talk\Events\BeforeCallStartedEvent;
+use OCA\Talk\Events\CallStartedEvent;
 use OCA\Talk\Events\AttendeeRemovedEvent;
 use OCA\Talk\Events\AttendeesAddedEvent;
 use OCA\Talk\Events\AttendeesRemovedEvent;
@@ -246,8 +247,8 @@ public function register(IRegistrationContext $context): void {
 
 		// Notification listeners
 		$context->registerEventListener(AttendeesAddedEvent::class, NotificationListener::class);
-		$context->registerEventListener(ActiveSinceModifiedEvent::class, NotificationListener::class);
-		$context->registerEventListener(BeforeParticipantModifiedEvent::class, NotificationListener::class);
+		$context->registerEventListener(BeforeCallStartedEvent::class, NotificationListener::class);
+		$context->registerEventListener(CallStartedEvent::class, NotificationListener::class);
 		$context->registerEventListener(CallNotificationSendEvent::class, NotificationListener::class);
 		$context->registerEventListener(ParticipantModifiedEvent::class, NotificationListener::class);
 		$context->registerEventListener(UserJoinedRoomEvent::class, NotificationListener::class);
@@ -265,7 +266,7 @@ public function register(IRegistrationContext $context): void {
 
 		// Federation listeners
 		$context->registerEventListener(BeforeRoomDeletedEvent::class, TalkV1BeforeRoomDeletedListener::class);
-		$context->registerEventListener(ActiveSinceModifiedEvent::class, TalkV1RoomModifiedListener::class);
+		$context->registerEventListener(CallStartedEvent::class, TalkV1RoomModifiedListener::class);
 		$context->registerEventListener(LobbyModifiedEvent::class, TalkV1RoomModifiedListener::class);
 		$context->registerEventListener(RoomModifiedEvent::class, TalkV1RoomModifiedListener::class);
 		$context->registerEventListener(ChatMessageSentEvent::class, TalkV1MessageSentListener::class);

lib/Controller/CallController.php

@@ -163,10 +163,11 @@ public function joinCall(?int $flags = null, ?int $forcePermissions = null, bool
 			$this->roomService->setPermissions($this->room, 'call', Attendee::PERMISSIONS_MODIFY_SET, $forcePermissions, true);
 		}
 
-		$joined = $this->participantService->changeInCall($this->room, $this->participant, $flags, false, $silent);
-
-		if (!$joined) {
-			return new DataResponse([], Http::STATUS_BAD_REQUEST);
+		try {
+			$this->participantService->changeInCall($this->room, $this->participant, $flags, silent: $silent);
+			$this->roomService->setActiveSince($this->room, $this->participant, $this->timeFactory->getDateTime(), $flags, silent: $silent);
+		} catch (\InvalidArgumentException $e) {
+			return new DataResponse(['error' => $e->getMessage()], Http::STATUS_BAD_REQUEST);
 		}
 		return new DataResponse();
 	}
@@ -226,8 +227,10 @@ public function joinFederatedCall(string $sessionId, ?int $flags = null, bool $s
 			return new DataResponse(['error' => 'consent'], Http::STATUS_BAD_REQUEST);
 		}
 
-		$joined = $this->participantService->changeInCall($this->room, $this->participant, $flags, false, $silent);
-		if (!$joined) {
+		try {
+			$this->participantService->changeInCall($this->room, $this->participant, $flags, false, $silent);
+			$this->roomService->setActiveSince($this->room, $this->participant, $this->timeFactory->getDateTime(), $flags, silent: $silent);
+		} catch (\InvalidArgumentException $e) {
 			return new DataResponse([], Http::STATUS_BAD_REQUEST);
 		}
 

lib/Events/AActiveSinceModifiedEvent.php → lib/Events/ACallStartedEvent.php

@@ -8,29 +8,37 @@
 
 namespace OCA\Talk\Events;
 
+use OCA\Talk\Participant;
 use OCA\Talk\Room;
 
-abstract class AActiveSinceModifiedEvent extends ARoomModifiedEvent {
+abstract class ACallStartedEvent extends ARoomModifiedEvent {
+	/**
+	 * @param array<AParticipantModifiedEvent::DETAIL_*, bool> $details
+	 */
 	public function __construct(
 		Room $room,
 		?\DateTime $newValue,
-		?\DateTime $oldValue,
 		protected int $callFlag,
-		protected int $oldCallFlag,
+		protected array $details,
+		?Participant $actor,
 	) {
 		parent::__construct(
 			$room,
 			self::PROPERTY_ACTIVE_SINCE,
 			$newValue,
-			$oldValue,
+			null,
+			$actor,
 		);
 	}
 
 	public function getCallFlag(): int {
 		return $this->callFlag;
 	}
 
-	public function getOldCallFlag(): int {
-		return $this->oldCallFlag;
+	/**
+	 * @param AParticipantModifiedEvent::DETAIL_* $detail
+	 */
+	public function getDetail(string $detail): ?bool {
+		return $this->details[$detail] ?? null;
 	}
 }

lib/Events/BeforeActiveSinceModifiedEvent.php → lib/Events/BeforeCallStartedEvent.php

@@ -8,5 +8,5 @@
 
 namespace OCA\Talk\Events;
 
-class BeforeActiveSinceModifiedEvent extends AActiveSinceModifiedEvent {
+class BeforeCallStartedEvent extends ACallStartedEvent {
 }

lib/Events/CallStartedEvent.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Talk\Events;
+
+class CallStartedEvent extends ACallStartedEvent {
+}

lib/Federation/BackendNotifier.php

@@ -9,6 +9,7 @@
 namespace OCA\Talk\Federation;
 
 use OCA\FederatedFileSharing\AddressHandler;
+use OCA\Talk\Events\ACallStartedEvent;
 use OCA\Talk\Exceptions\RoomHasNoModeratorException;
 use OCA\Talk\Model\Attendee;
 use OCA\Talk\Model\RetryNotification;
@@ -243,27 +244,22 @@ public function sendRoomModifiedUpdate(
 	/**
 	 * Send information to remote participants that "active since" was updated
 	 * Sent from Host server to Remote participant server
+	 *
+	 * @psalm-param array<AParticipantModifiedEvent::DETAIL_*, bool> $details
 	 */
-	public function sendRoomModifiedActiveSinceUpdate(
+	public function sendCallStarted(
 		string $remoteServer,
 		int $localAttendeeId,
 		#[SensitiveParameter]
 		string $accessToken,
 		string $localToken,
 		string $changedProperty,
-		?\DateTime $newValue,
-		?\DateTime $oldValue,
+		\DateTime $activeSince,
 		int $callFlag,
+		array $details,
 	): ?bool {
 		$remote = $this->prepareRemoteUrl($remoteServer);
 
-		if ($newValue instanceof \DateTime) {
-			$newValue = (string) $newValue->getTimestamp();
-		}
-		if ($oldValue instanceof \DateTime) {
-			$oldValue = (string) $oldValue->getTimestamp();
-		}
-
 		$notification = $this->cloudFederationFactory->getCloudFederationNotification();
 		$notification->setMessage(
 			FederationManager::NOTIFICATION_ROOM_MODIFIED,
@@ -274,9 +270,10 @@ public function sendRoomModifiedActiveSinceUpdate(
 				'sharedSecret' => $accessToken,
 				'remoteToken' => $localToken,
 				'changedProperty' => $changedProperty,
-				'newValue' => $newValue,
-				'oldValue' => $oldValue,
+				'newValue' => $activeSince->getTimestamp(),
+				'oldValue' => null,
 				'callFlag' => $callFlag,
+				'details' => $details,
 			],
 		);
 

lib/Federation/CloudFederationProviderTalk.php

@@ -14,6 +14,7 @@
 use OCA\Talk\CachePrefix;
 use OCA\Talk\Config;
 use OCA\Talk\Events\AAttendeeRemovedEvent;
+use OCA\Talk\Events\AParticipantModifiedEvent;
 use OCA\Talk\Events\ARoomModifiedEvent;
 use OCA\Talk\Events\AttendeesAddedEvent;
 use OCA\Talk\Exceptions\CannotReachRemoteException;
@@ -288,7 +289,7 @@ private function shareUnshared(int $remoteAttendeeId, array $notification): arra
 
 	/**
 	 * @param int $remoteAttendeeId
-	 * @param array{remoteServerUrl: string, sharedSecret: string, remoteToken: string, changedProperty: string, newValue: string|int|bool|null, oldValue: string|int|bool|null, callFlag?: int, dateTime?: string, timerReached?: bool} $notification
+	 * @param array{remoteServerUrl: string, sharedSecret: string, remoteToken: string, changedProperty: string, newValue: string|int|bool|null, oldValue: string|int|bool|null, callFlag?: int, dateTime?: string, timerReached?: bool, details?: array<AParticipantModifiedEvent::DETAIL_*, bool>} $notification
 	 * @return array
 	 * @throws ActionNotSupportedException
 	 * @throws AuthenticationFailedException
@@ -311,15 +312,15 @@ private function roomModified(int $remoteAttendeeId, array $notification): array
 			if ($notification['newValue'] === null) {
 				$this->roomService->resetActiveSince($room);
 			} else {
-				$activeSince = \DateTime::createFromFormat('U', $notification['newValue']);
-				$this->roomService->setActiveSince($room, $activeSince, $notification['callFlag']);
+				$activeSince = $this->timeFactory->getDateTime('@' . $notification['newValue']);
+				$this->roomService->setActiveSince($room, null, $activeSince, $notification['callFlag'], !empty($notification['details'][AParticipantModifiedEvent::DETAIL_IN_CALL_SILENT]));
 			}
 		} elseif ($notification['changedProperty'] === ARoomModifiedEvent::PROPERTY_AVATAR) {
 			$this->roomService->setAvatar($room, $notification['newValue']);
 		} elseif ($notification['changedProperty'] === ARoomModifiedEvent::PROPERTY_DESCRIPTION) {
 			$this->roomService->setDescription($room, $notification['newValue']);
 		} elseif ($notification['changedProperty'] === ARoomModifiedEvent::PROPERTY_IN_CALL) {
-			$this->roomService->setActiveSince($room, $room->getActiveSince(), $notification['newValue']);
+			$this->roomService->setActiveSince($room, null, $room->getActiveSince(), $notification['newValue'], true);
 		} elseif ($notification['changedProperty'] === ARoomModifiedEvent::PROPERTY_LOBBY) {
 			$dateTime = !empty($notification['dateTime']) ? \DateTime::createFromFormat('U', $notification['dateTime']) : null;
 			$this->roomService->setLobby($room, $notification['newValue'], $dateTime, $notification['timerReached'] ?? false);

lib/Federation/Proxy/TalkV1/Controller/CallController.php

@@ -40,7 +40,7 @@ public function __construct(
 	 * @psalm-param int-mask-of<Participant::FLAG_*> $flags
 	 * @param bool $silent Join the call silently
 	 * @param bool $recordingConsent Agreement to be recorded
-	 * @return DataResponse<Http::STATUS_OK|Http::STATUS_BAD_REQUEST|Http::STATUS_NOT_FOUND, array<empty>, array{}>
+	 * @return DataResponse<Http::STATUS_OK|Http::STATUS_NOT_FOUND, array<empty>, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{error?: string}, array{}>
 	 * @throws CannotReachRemoteException
 	 *
 	 * 200: Federated user is now in the call

lib/Federation/Proxy/TalkV1/Notifier/RoomModifiedListener.php

@@ -10,9 +10,12 @@
 
 use OCA\Talk\Events\AActiveSinceModifiedEvent;
 use OCA\Talk\Events\AAttendeeRemovedEvent;
-use OCA\Talk\Events\ActiveSinceModifiedEvent;
 use OCA\Talk\Events\ALobbyModifiedEvent;
+use OCA\Talk\Events\AParticipantModifiedEvent;
 use OCA\Talk\Events\ARoomModifiedEvent;
+use OCA\Talk\Events\CallEndedEvent;
+use OCA\Talk\Events\CallEndedForEveryoneEvent;
+use OCA\Talk\Events\CallStartedEvent;
 use OCA\Talk\Events\LobbyModifiedEvent;
 use OCA\Talk\Events\RoomModifiedEvent;
 use OCA\Talk\Federation\BackendNotifier;
@@ -36,7 +39,7 @@ public function __construct(
 	}
 
 	public function handle(Event $event): void {
-		if (!$event instanceof ActiveSinceModifiedEvent
+		if (!$event instanceof CallStartedEvent
 				&& !$event instanceof LobbyModifiedEvent
 				&& !$event instanceof RoomModifiedEvent) {
 			return;
@@ -60,8 +63,8 @@ public function handle(Event $event): void {
 		foreach ($participants as $participant) {
 			$cloudId = $this->cloudIdManager->resolveCloudId($participant->getAttendee()->getActorId());
 
-			if ($event instanceof AActiveSinceModifiedEvent) {
-				$success = $this->notifyActiveSinceModified($cloudId, $participant, $event);
+			if ($event instanceof CallStartedEvent) {
+				$success = $this->notifyCallStarted($cloudId, $participant, $event);
 			} elseif ($event instanceof ALobbyModifiedEvent) {
 				$success = $this->notifyLobbyModified($cloudId, $participant, $event);
 			} else {
@@ -74,16 +77,21 @@ public function handle(Event $event): void {
 		}
 	}
 
-	private function notifyActiveSinceModified(ICloudId $cloudId, Participant $participant, AActiveSinceModifiedEvent $event) {
-		return $this->backendNotifier->sendRoomModifiedActiveSinceUpdate(
+	private function notifyCallStarted(ICloudId $cloudId, Participant $participant, CallStartedEvent $event) {
+		$details = [];
+		if ($event->getDetail(AParticipantModifiedEvent::DETAIL_IN_CALL_SILENT)) {
+			$details = [AParticipantModifiedEvent::DETAIL_IN_CALL_SILENT => true];
+		}
+
+		return $this->backendNotifier->sendCallStarted(
 			$cloudId->getRemote(),
 			$participant->getAttendee()->getId(),
 			$participant->getAttendee()->getAccessToken(),
 			$event->getRoom()->getToken(),
 			$event->getProperty(),
 			$event->getNewValue(),
-			$event->getOldValue(),
 			$event->getCallFlag(),
+			$details,
 		);
 	}