Merge pull request #4121 from nextcloud/enh/4099/log-matterbridge-actions

Log matterbridge start/stop actions in related room

lib/Chat/Parser/SystemMessage.php

@@ -289,6 +289,21 @@ class SystemMessage {
 					$parsedMessage = $this->l->t('You shared a file which is no longer available');
 				}
 			}
+		} elseif ($message === 'matterbridge_config_added') {
+			$parsedMessage = $this->l->t('{actor} set up Matterbridge to synchronize this conversation with other chats.');
+			if ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You set up Matterbridge to synchronize this conversation with other chats.');
+			}
+		} elseif ($message === 'matterbridge_config_edited') {
+			$parsedMessage = $this->l->t('{actor} updated the Matterbridge configuration.');
+			if ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You updated the Matterbridge configuration.');
+			}
+		} elseif ($message === 'matterbridge_config_removed') {
+			$parsedMessage = $this->l->t('{actor} removed the Matterbridge configuration.');
+			if ($currentUserIsActor) {
+				$parsedMessage = $this->l->t('You removed the Matterbridge configuration.');
+			}
 		} else {
 			throw new \OutOfBoundsException('Unknown subject');
 		}

lib/Controller/MatterbridgeController.php

@@ -93,7 +93,7 @@ class MatterbridgeController extends AEnvironmentAwareController {
 	 */
 	public function editBridgeOfRoom(bool $enabled, array $parts = []): DataResponse {
 		try {
-			$state = $this->bridgeManager->editBridgeOfRoom($this->room, $enabled, $parts);
+			$state = $this->bridgeManager->editBridgeOfRoom($this->room, $this->userId, $enabled, $parts);
 		} catch (ImpossibleToKillException $e) {
 			return new DataResponse(['error' => $e->getMessage()], Http::STATUS_NOT_ACCEPTABLE);
 		}

lib/MatterbridgeManager.php

@@ -38,10 +38,12 @@ use OCP\Security\ISecureRandom;
 use OCP\IAvatarManager;
 use Doctrine\DBAL\Exception\UniqueConstraintViolationException;
 use Psr\Log\LoggerInterface;
+use OCP\AppFramework\Utility\ITimeFactory;
 
 use OCA\Talk\Exceptions\ImpossibleToKillException;
 use OCA\Talk\Exceptions\WrongPermissionsException;
 use OCA\Talk\Exceptions\ParticipantNotFoundException;
+use OCA\Talk\Chat\ChatManager;
 
 class MatterbridgeManager {
 	/** @var IDBConnection */
@@ -58,6 +60,10 @@ class MatterbridgeManager {
 	private $tokenProvider;
 	/** @var ISecureRandom */
 	private $random;
+	/** @var ChatManager */
+	private $chatManager;
+	/** @var ITimeFactory */
+	private $timeFactory;
 
 	public function __construct(IDBConnection $db,
 								IConfig $config,
@@ -65,11 +71,13 @@ class MatterbridgeManager {
 								IURLGenerator $urlGenerator,
 								IUserManager $userManager,
 								Manager $manager,
+								ChatManager $chatManager,
 								IAuthTokenProvider $tokenProvider,
 								ISecureRandom $random,
 								IAvatarManager $avatarManager,
 								LoggerInterface $logger,
-								IL10N $l) {
+								IL10N $l,
+								ITimeFactory $timeFactory) {
 		$this->avatarManager = $avatarManager;
 		$this->db = $db;
 		$this->config = $config;
@@ -77,10 +85,12 @@ class MatterbridgeManager {
 		$this->appData = $appData;
 		$this->userManager = $userManager;
 		$this->manager = $manager;
+		$this->chatManager = $chatManager;
 		$this->tokenProvider = $tokenProvider;
 		$this->random = $random;
 		$this->logger = $logger;
 		$this->l = $l;
+		$this->timeFactory = $timeFactory;
 	}
 
 	/**
@@ -131,7 +141,7 @@ class MatterbridgeManager {
 	 * @param array $parts parts of the bridge (what it connects to)
 	 * @return array bridge state
 	 */
-	public function editBridgeOfRoom(Room $room, bool $enabled, array $parts = []): array {
+	public function editBridgeOfRoom(Room $room, string $userId, bool $enabled, array $parts = []): array {
 		$currentBridge = $this->getBridgeOfRoom($room);
 		// kill matterbridge if we edit a running bridge config file so that it will be launched again
 		// matterbridge dynamic config reload does not fully work
@@ -144,6 +154,8 @@ class MatterbridgeManager {
 			'parts' => $parts,
 		];
 
+		$this->notify($room, $userId, $currentBridge, $newBridge);
+
 		// edit/update the config file
 		$this->editBridgeConfig($room, $newBridge);
 
@@ -548,6 +560,90 @@ class MatterbridgeManager {
 		return $pid;
 	}
 
+	/**
+	 * Send system message to the room if necessary
+	 *
+	 * @param Room $room the room
+	 * @param string $userId the editing user
+	 * @param array $currentBridge previous bridge values
+	 * @param array $newBridge future bridge values
+	 */
+	private function notify(Room $room, string $userId, array $currentBridge, array $newBridge): void {
+		$currentParts = $currentBridge['parts'];
+		$newParts = $newBridge['parts'];
+		if (count($currentParts) === 0 && count($newParts) > 0) {
+			$this->sendSystemMessage($room, $userId, 'matterbridge_config_added');
+		} elseif (count($currentParts) > 0 && count($newParts) === 0) {
+			$this->sendSystemMessage($room, $userId, 'matterbridge_config_removed');
+		} elseif (count($currentParts) !== count($newParts) || !$this->compareBridges($currentBridge, $newBridge)) {
+			$this->sendSystemMessage($room, $userId, 'matterbridge_config_edited');
+		}
+	}
+
+	/**
+	 * Check if 2 bridge configurations are identical
+	 *
+	 * @param array $bridge1
+	 * @param array $bridge2
+	 * @return bool True if they are strictly equivalent
+	 */
+	private function compareBridges(array $bridge1, array $bridge2): bool {
+		// try to find an equivalent for each bridge part of one side in the other
+		foreach ($bridge1['parts'] as $part1) {
+			$found = false;
+			foreach ($bridge2['parts'] as $part2) {
+				if ($this->compareBridgeParts($part1, $part2)) {
+					$found = true;
+					break;
+				}
+			}
+			if (!$found) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+	/**
+	 * Check if 2 bridge parts are identical
+	 *
+	 * @param array $part1
+	 * @param array $part2
+	 * @return bool True if they are strictly equivalent
+	 */
+	private function compareBridgeParts(array $part1, array $part2): bool {
+		$keys1 = array_keys($part1);
+		$keys2 = array_keys($part2);
+		if (count($keys1) !== count($keys2)) {
+			return false;
+		}
+
+		foreach ($part1 as $key => $val) {
+			if (!isset($part2[$key]) || $val !== $part2[$key]) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+	/**
+	 * actually send the system message
+	 * @param Room $room the room
+	 * @param string $userId the involved user
+	 * @param string $message the message ID
+	 */
+	private function sendSystemMessage(Room $room, string $userId, string $message): void {
+		$this->chatManager->addSystemMessage(
+			$room,
+			'users',
+			$userId,
+			json_encode(['message' => $message, 'parameters' => []]),
+			$this->timeFactory->getDateTime(),
+			false
+		);
+	}
+
 	/**
 	 * Actually launch a matterbridge process for a room
 	 *

src/components/RightSidebar/Matterbridge/MatterbridgeSettings.vue

@@ -505,7 +505,6 @@ export default {
 		},
 		onDelete(i) {
 			this.parts.splice(i, 1)
-			this.onSave()
 		},
 		onEnabled(checked) {
 			this.enabled = checked