Add listable scope attribute for conversations

.drone.yml

@@ -378,12 +378,14 @@ steps:
     environment:
       APP_NAME: spreed
       CORE_BRANCH: master
+      GUESTS_BRANCH: master
       DATABASEHOST: sqlite
     commands:
       - bash tests/drone-run-integration-tests.sh || exit 0
       - wget https://raw.githubusercontent.com/nextcloud/travis_ci/master/before_install.sh
       - bash ./before_install.sh $APP_NAME $CORE_BRANCH $DATABASEHOST
       - cd ../server
+      - git clone --depth 1 -b "$GUESTS_BRANCH" https://github.com/nextcloud/guests apps/guests
       - ./occ app:enable $APP_NAME
       - cd apps/$APP_NAME
 

appinfo/routes.php

@@ -183,6 +183,14 @@
 				'apiVersion' => 'v(1|2|3)',
 			],
 		],
+		[
+			'name' => 'Room#getListedRooms',
+			'url' => '/api/{apiVersion}/listed-room',
+			'verb' => 'GET',
+			'requirements' => [
+				'apiVersion' => 'v3',
+			],
+		],
 		[
 			'name' => 'Room#createRoom',
 			'url' => '/api/{apiVersion}/room',
@@ -254,6 +262,15 @@
 				'token' => '^[a-z0-9]{4,30}$',
 			],
 		],
+		[
+			'name' => 'Room#setListable',
+			'url' => '/api/{apiVersion}/room/{token}/listable',
+			'verb' => 'PUT',
+			'requirements' => [
+				'apiVersion' => 'v3',
+				'token' => '^[a-z0-9]{4,30}$',
+			],
+		],
 		[
 			'name' => 'Room#setPassword',
 			'url' => '/api/{apiVersion}/room/{token}/password',

docs/capabilities.md

@@ -59,3 +59,4 @@ title: Capabilities
 * `config => previews => max-gif-size` - Maximum size in bytes below which a GIF can be embedded directly in the page at render time. Bigger files will be rendered statically using the preview endpoint instead. Can be set with `occ config:app:set spreed max-gif-size --value=X` where X is the new value in bytes. Defaults to 3 MB.
 * `chat-read-status` - On conversation API v3 and the chat API the last common read message is exposed which can be used to update the "read status" flag of own chat messages. The info should be shown only when the user also shares their read status. The user's value can be found in `config => chat => read-privacy`.
 * `config => chat => read-privacy` - See `chat-read-status`
+* `listable-rooms` - Conversations can searched for even when not joined. A "listable" attribute set on rooms defines the scope of who can find it.

docs/chat.md

@@ -149,7 +149,7 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
         `status` | string | Optional: Only available with `includeStatus=true` and for users with a set status
         `statusIcon` | string | Optional: Only available with `includeStatus=true` and for users with a set status
         `statusMessage` | string | Optional: Only available with `includeStatus=true` and for users with a set status
-        
+
 ## System messages
 
 * `conversation_created` - {actor} created the conversation
@@ -160,6 +160,9 @@ Base endpoint is: `/ocs/v2.php/apps/spreed/api/v1`
 * `call_ended` - Call with {user1}, {user2}, {user3}, {user4} and {user5} (Duration 30:23)
 * `read_only_off` - {actor} unlocked the conversation
 * `read_only` - {actor} locked the conversation
+* `listable_none` - {actor} made the conversation visible for nobody
+* `listable_users` - {actor} made the conversation visible for regular users
+* `listable_all` - {actor} made the conversation visible for everone which includes users and guests
 * `lobby_timer_reached` - The conversation is now open to everyone
 * `lobby_none` - {actor} opened the conversation to everyone
 * `lobby_non_moderators` - {actor} restricted the conversation to moderators

docs/constants.md

@@ -12,6 +12,11 @@ title: Constants
 * `0` read-write
 * `1` read-only
 
+## Listable scope
+* `0` participants only
+* `1` regular users only, excluding guest app users
+* `2` everyone
+
 ## Participant types
 * `1` owner
 * `2` moderator

docs/conversation.md

@@ -4,6 +4,63 @@
 * Base endpoint for API v2 is: `/ocs/v2.php/apps/spreed/api/v2`
 * Base endpoint for API v3 is: `/ocs/v2.php/apps/spreed/api/v3`
 
+## Get listed conversations
+
+* Method: `GET`
+* Endpoint: `/listed-room`
+
+* Response:
+    - Status code:
+        + `200 OK`
+        + `401 Unauthorized` when the user is not logged in
+
+    - Header:
+
+        field | type | Description
+        ------|------|------------
+        `searchTerm` | string | search term
+
+    - Data: See array definition in `Get user´s conversations`
+        Array of conversations, each conversation has at least:
+
+        field | type | API | Description
+        ------|------|-----|------------
+        `token` | string | * | Token identifier of the conversation which is used for further interaction
+        `type` | int | * | See list of conversation types in the [constants list](constants.md#Conversation-types)
+        `name` | string | * | Name of the conversation (can also be empty)
+        `displayName` | string | * | `name` if non empty, otherwise it falls back to a list of participants
+        `participantType` | int | * | Permissions level of the current user
+        `attendeeId` | int | v3 | Unique attendee id
+        `attendeePin` | string | v3 | Unique dial-in authentication code for this user, when the conversation has SIP enabled (see `sipEnabled` attribute)
+        `actorType` | string | v3 | Currently known `users|guests|emails|groups`
+        `actorId` | string | v3 | The unique identifier for the given actor type
+        `participantInCall` | bool | 🏴 v1 | Flag if the current user is in the call (deprecated, use `participantFlags` instead)
+        `participantFlags` | int | * | Flags of the current user (only available with `in-call-flags` capability)
+        `readOnly` | int | * | Read-only state for the current user (only available with `read-only-rooms` capability)
+        `listable` | int | * | Listable scope for the room (only available with `listable-rooms` capability)
+        `count` | int | 🏴 v1 | **Deprecated:** ~~Number of active users~~ - always returns `0`
+        `numGuests` | int | 🏴 v1 | Number of active guests
+        `lastPing` | int | * | Timestamp of the last ping of the current user (should be used for sorting)
+        `sessionId` | string | * | `'0'` if not connected, otherwise a 512 character long string
+        `hasPassword` | bool | * | Flag if the conversation has a password
+        `hasCall` | bool | * | Flag if the conversation has an active call
+        `canStartCall` | bool | * | Flag if the user can start a new call in this conversation (joining is always possible) (only available with `start-call-flag` capability)
+        `canDeleteConversation` | bool | 🆕 v2 | Flag if the user can delete the conversation for everyone (not possible without moderator permissions or in one-to-one conversations)
+        `canLeaveConversation` | bool | 🆕 v2 | Flag if the user can leave the conversation (not possible for the last user with moderator permissions)
+        `lastActivity` | int | * | Timestamp of the last activity in the conversation, in seconds and UTC time zone
+        `isFavorite` | bool | * | Flag if the conversation is favorited by the user
+        `notificationLevel` | int | * | The notification level for the user (one of `Participant::NOTIFY_*` (1-3))
+        `lobbyState` | int | * | Webinary lobby restriction (0-1), if the participant is a moderator they can always join the conversation (only available with `webinary-lobby` capability)
+        `lobbyTimer` | int | * | Timestamp when the lobby will be automatically disabled (only available with `webinary-lobby` capability)
+        `sipEnabled` | int | v3 | SIP enable status (0-1)
+        `canEnableSIP` | int | v3 | Whether the given user can enable SIP for this conversation. Note that when the token is not-numeric only, SIP can not be enabled even if the user is permitted and a moderator of the conversation
+        `unreadMessages` | int | * | Number of unread chat messages in the conversation (only available with `chat-v2` capability)
+        `unreadMention` | bool | * | Flag if the user was mentioned since their last visit
+        `lastReadMessage` | int | * | ID of the last read message in a room (only available with `chat-read-marker` capability)
+        `lastMessage` | message | * | Last message in a conversation if available, otherwise empty
+        `objectType` | string | * | The type of object that the conversation is associated with; "share:password" if the conversation is used to request a password for a share, otherwise empty
+        `objectId` | string | * | Share token if "objectType" is "share:password", otherwise empty
+
 ## Get user´s conversations
 
 * Method: `GET`
@@ -38,6 +95,7 @@
         `participantInCall` | bool | 🏴 v1 | Flag if the current user is in the call (deprecated, use `participantFlags` instead)
         `participantFlags` | int | * | Flags of the current user (only available with `in-call-flags` capability)
         `readOnly` | int | * | Read-only state for the current user (only available with `read-only-rooms` capability)
+        `listable` | int | * | Listable scope for the room (only available with `listable-rooms` capability)
         `count` | int | 🏴 v1 | **Deprecated:** ~~Number of active users~~ - always returns `0`
         `numGuests` | int | 🏴 v1 | Number of active guests
         `lastPing` | int | * | Timestamp of the last ping of the current user (should be used for sorting)
@@ -266,3 +324,20 @@
         + `400 Bad Request` When the the given level is invalid
         + `401 Unauthorized` When the participant is a guest
         + `404 Not Found` When the conversation could not be found for the participant
+
+## Set listable scope for a conversation
+
+* Method: `PUT`
+* Endpoint: `/room/{token}/listable`
+* Data:
+
+    field | type | Description
+    ------|------|------------
+    `scope` | int | New flags for the conversation
+
+* Response:
+    - Status code:
+        + `200 OK`
+        + `400 Bad Request` When the conversation type does not support making it listable (only group and public conversation)
+        + `403 Forbidden` When the current user is not a moderator/owner or the conversation is not a public conversation
+        + `404 Not Found` When the conversation could not be found for the participant

docs/events.md

@@ -12,7 +12,6 @@ Explanations:
 * Event name: `OCA\Talk\Controller\RoomController::EVENT_BEFORE_ROOMS_GET`
 * Since: 8.0.0
 
-
 ### Create conversation
 
 * Event class: `OCA\Talk\Events\RoomEvent`
@@ -54,6 +53,13 @@ Explanations:
 * After event name: `OCA\Talk\Room::EVENT_AFTER_READONLY_SET`
 * Since: 8.0.0
 
+### Set listable
+
+* Event class: `OCA\Talk\Events\ModifyRoomEvent`
+* Before event name: `OCA\Talk\Room::EVENT_BEFORE_LISTABLE_SET`
+* After event name: `OCA\Talk\Room::EVENT_AFTER_LISTABLE_SET`
+* Since: 11.0.0
+
 ### Set lobby
 
 * Event class: `OCA\Talk\Events\ModifyLobbyEvent`

lib/Capabilities.php

@@ -74,6 +74,7 @@ public function getCapabilities(): array {
 				'invite-groups-and-mails',
 				'locked-one-to-one-rooms',
 				'read-only-rooms',
+				'listable-rooms',
 				'chat-read-marker',
 				'webinary-lobby',
 				'start-call-flag',

lib/Chat/Parser/SystemMessage.php

@@ -165,6 +165,27 @@ public function parseMessage(Message $chatMessage): void {
 			} elseif ($cliIsActor) {
 				$parsedMessage = $this->l->t('An administrator locked the conversation');
 			}
+		} elseif ($message === 'listable_none') {
+			$parsedMessage = $this->l->t('{actor} made the conversation invisible');
+			if ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You made the conversation invisible');
+			} elseif ($cliIsActor) {
+				$parsedMessage = $this->l->t('An administrator made the conversation invisible');
+			}
+		} elseif ($message === 'listable_users') {
+			$parsedMessage = $this->l->t('{actor} made the conversation visible for registered users only');
+			if ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You made the conversation visible for registered users only');
+			} elseif ($cliIsActor) {
+				$parsedMessage = $this->l->t('An administrator made the visible for registered users only');
+			}
+		} elseif ($message === 'listable_all') {
+			$parsedMessage = $this->l->t('{actor} made the conversation visible for everyone');
+			if ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You made the conversation visible for everyone');
+			} elseif ($cliIsActor) {
+				$parsedMessage = $this->l->t('An administrator made the conversation visible for everyone');
+			}
 		} elseif ($message === 'lobby_timer_reached') {
 			$parsedMessage = $this->l->t('The conversation is now open to everyone');
 		} elseif ($message === 'lobby_none') {

lib/Chat/SystemMessage/Listener.php

@@ -176,6 +176,20 @@ public static function register(IEventDispatcher $dispatcher): void {
 				$listener->sendSystemMessage($room, 'read_only_off');
 			}
 		});
+		$dispatcher->addListener(Room::EVENT_AFTER_LISTABLE_SET, static function (ModifyRoomEvent $event) {
+			$room = $event->getRoom();
+
+			/** @var self $listener */
+			$listener = \OC::$server->query(self::class);
+
+			if ($event->getNewValue() === Room::LISTABLE_NONE) {
+				$listener->sendSystemMessage($room, 'listable_none');
+			} elseif ($event->getNewValue() === Room::LISTABLE_USERS) {
+				$listener->sendSystemMessage($room, 'listable_users');
+			} elseif ($event->getNewValue() === Room::LISTABLE_ALL) {
+				$listener->sendSystemMessage($room, 'listable_all');
+			}
+		});
 		$dispatcher->addListener(Room::EVENT_AFTER_LOBBY_STATE_SET, static function (ModifyLobbyEvent $event) {
 			if ($event->getNewValue() === $event->getOldValue()) {
 				return;
@@ -196,26 +210,36 @@ public static function register(IEventDispatcher $dispatcher): void {
 		});
 
 		$dispatcher->addListener(Room::EVENT_AFTER_USERS_ADD, static function (AddParticipantsEvent $event) {
-			$participants = $event->getParticipants();
-			$user = \OC::$server->getUserSession()->getUser();
-			$userId = $user instanceof IUser ? $user->getUID() : null;
-
 			$room = $event->getRoom();
-
 			if ($room->getType() === Room::ONE_TO_ONE_CALL) {
 				return;
 			}
 
 			/** @var self $listener */
 			$listener = \OC::$server->query(self::class);
+
+			$participants = $event->getParticipants();
+
 			foreach ($participants as $participant) {
 				if ($participant['actorType'] !== 'users') {
 					continue;
 				}
 
-				$userJoinedFileRoom = $room->getObjectType() === 'file' &&
-						(!isset($participant['participantType']) || $participant['participantType'] !== Participant::USER_SELF_JOINED);
-				if ($userJoinedFileRoom || $userId !== $participant['actorId']) {
+				$participantType = null;
+				if (isset($participant['participantType'])) {
+					$participantType = $participant['participantType'];
+				}
+
+				$userJoinedFileRoom = $room->getObjectType() === 'file' && $participantType !== Participant::USER_SELF_JOINED;
+
+				// add a message "X joined the conversation", whenever user $userId:
+				if (
+					// - has joined a file room but not through a public link
+					$userJoinedFileRoom
+					// - has been added by another user (and not when creating a conversation)
+					|| $listener->getUserId() !== $participant['actorId']
+					// - has joined a listable room on their own
+					|| $participantType === Participant::USER) {
 					$listener->sendSystemMessage($room, 'user_added', ['user' => $participant['actorId']]);
 				}
 			}
@@ -314,4 +338,9 @@ protected function sendSystemMessage(Room $room, string $message, array $paramet
 			$referenceId
 		);
 	}
+
+	protected function getUserId() {
+		$user = $this->userSession->getUser();
+		return $user instanceof IUser ? $user->getUID() : null;
+	}
 }

lib/Command/Room/Create.php

@@ -70,6 +70,11 @@ protected function configure(): void {
 				null,
 				InputOption::VALUE_NONE,
 				'Creates the room with read-only access only if set'
+			)->addOption(
+				'listable',
+				null,
+				InputOption::VALUE_REQUIRED,
+				'Creates the room with the given listable scope'
 			)->addOption(
 				'password',
 				null,
@@ -95,10 +100,26 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 		$groups = $input->getOption('group');
 		$public = $input->getOption('public');
 		$readonly = $input->getOption('readonly');
+		$listable = $input->getOption('listable');
 		$password = $input->getOption('password');
 		$owner = $input->getOption('owner');
 		$moderators = $input->getOption('moderator');
 
+		if (!in_array($readOnly, [null, (string)Room::READ_WRITE, (string)Room::READ_ONLY], true)) {
+			$output->writeln('<error>Invalid value for option "--readonly" given.</error>');
+			return 1;
+		}
+
+		if (!in_array($listable, [
+			null,
+			(string)Room::LISTABLE_NONE,
+			(string)Room::LISTABLE_USERS,
+			(string)Room::LISTABLE_ALL,
+		], true)) {
+			$output->writeln('<error>Invalid value for option "--listable" given.</error>');
+			return 1;
+		}
+
 		$roomType = $public ? Room::PUBLIC_CALL : Room::GROUP_CALL;
 		try {
 			$room = $this->roomService->createConversation($roomType, $name);
@@ -116,6 +137,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 			}
 
 			$this->setRoomReadOnly($room, $readonly);
+			$this->setRoomListable($room, (int)$listable);
 
 			if ($password !== null) {
 				$this->setRoomPassword($room, $password);
@@ -150,6 +172,14 @@ public function completeOptionValues($optionName, CompletionContext $context) {
 			case 'owner':
 			case 'moderator':
 				return $this->completeParticipantValues($context);
+			case 'readonly':
+				return [(string)Room::READ_ONLY, (string)Room::READ_WRITE];
+			case 'listable':
+				return [
+					(string)Room::LISTABLE_ALL,
+					(string)Room::LISTABLE_USERS,
+					(string)Room::LISTABLE_NONE,
+				];
 		}
 
 		return parent::completeOptionValues($optionName, $context);

lib/Command/Room/TRoomCommand.php

@@ -151,6 +151,22 @@ protected function setRoomReadOnly(Room $room, bool $readOnly): void {
 		}
 	}
 
+	/**
+	 * @param Room $room
+	 * @param int $listable
+	 *
+	 * @throws InvalidArgumentException
+	 */
+	protected function setRoomListable(Room $room, int $listable): void {
+		if ($room->getListable() === $listable) {
+			return;
+		}
+
+		if (!$room->setListable($listable)) {
+			throw new InvalidArgumentException('Unable to change room state.');
+		}
+	}
+
 	/**
 	 * @param Room   $room
 	 * @param string $password