Add an API to set and rollback the user status

Signed-off-by: Carl Schwan <carl@carlschwan.eu>

6 files changed, 106 insertions, 9 deletions

diff --git a/lib/composer/composer/autoload_classmap.php b/lib/composer/composer/autoload_classmap.php
index 343d2ddf027..cbdcbd0a224 100644
--- a/lib/composer/composer/autoload_classmap.php
+++ b/lib/composer/composer/autoload_classmap.php
@@ -1453,6 +1453,7 @@ return array(
     'OC\\Updater\\ChangesMapper' => $baseDir . '/lib/private/Updater/ChangesMapper.php',
     'OC\\Updater\\ChangesResult' => $baseDir . '/lib/private/Updater/ChangesResult.php',
     'OC\\Updater\\VersionCheck' => $baseDir . '/lib/private/Updater/VersionCheck.php',
+    'OC\\UserStatus\\ISettableProvider' => $baseDir . '/lib/private/UserStatus/ISettableProvider.php',
     'OC\\UserStatus\\Manager' => $baseDir . '/lib/private/UserStatus/Manager.php',
     'OC\\User\\Backend' => $baseDir . '/lib/private/User/Backend.php',
     'OC\\User\\Database' => $baseDir . '/lib/private/User/Database.php',
diff --git a/lib/composer/composer/autoload_static.php b/lib/composer/composer/autoload_static.php
index 96ed5a614bc..4a5705d2e63 100644
--- a/lib/composer/composer/autoload_static.php
+++ b/lib/composer/composer/autoload_static.php
@@ -1482,6 +1482,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OC\\Updater\\ChangesMapper' => __DIR__ . '/../../..' . '/lib/private/Updater/ChangesMapper.php',
         'OC\\Updater\\ChangesResult' => __DIR__ . '/../../..' . '/lib/private/Updater/ChangesResult.php',
         'OC\\Updater\\VersionCheck' => __DIR__ . '/../../..' . '/lib/private/Updater/VersionCheck.php',
+        'OC\\UserStatus\\ISettableProvider' => __DIR__ . '/../../..' . '/lib/private/UserStatus/ISettableProvider.php',
         'OC\\UserStatus\\Manager' => __DIR__ . '/../../..' . '/lib/private/UserStatus/Manager.php',
         'OC\\User\\Backend' => __DIR__ . '/../../..' . '/lib/private/User/Backend.php',
         'OC\\User\\Database' => __DIR__ . '/../../..' . '/lib/private/User/Database.php',
diff --git a/lib/private/UserStatus/ISettableProvider.php b/lib/private/UserStatus/ISettableProvider.php
new file mode 100644
index 00000000000..fc0d502845e
--- /dev/null
+++ b/lib/private/UserStatus/ISettableProvider.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2021 Carl Schwan <carl@carlschwan.eu>
+ *
+ * @author Carl Schwan <carl@carlschwan.eu>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OC\UserStatus;
+
+use OCP\UserStatus\IProvider;
+
+/**
+ * Interface ISettableProvider
+ * @package OC\UserStatus
+ */
+interface ISettableProvider extends IProvider {
+	/**
+	 * Set a new status for the selected user.
+	 *
+	 * @param string $userId The user for which we want to update the status.
+	 * @param string $messageId The new message id.
+	 * @param string $status The new status.
+	 * @param bool $createBackup If true, this will store the old status so that it is possible to revert it later (e.g. after a call).
+	 */
+	public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup): void;
+
+	/**
+	 * Revert an automatically set user status. For example after leaving a call,
+	 * change back to the previously set status. If the user has already updated
+	 * their status, this method does nothing.
+	 *
+	 * @param string $userId The user for which we want to update the status.
+	 * @param string $messageId The expected current messageId.
+	 * @param string $status The expected current status.
+	 */
+	public function revertUserStatus(string $userId, string $messageId, string $status): void;
+}
diff --git a/lib/private/UserStatus/Manager.php b/lib/private/UserStatus/Manager.php
index 9e48b284e92..bca80bc5b03 100644
--- a/lib/private/UserStatus/Manager.php
+++ b/lib/private/UserStatus/Manager.php
@@ -25,21 +25,21 @@ declare(strict_types=1);
  */
 namespace OC\UserStatus;
 
-use OCP\ILogger;
 use OCP\IServerContainer;
 use OCP\UserStatus\IManager;
 use OCP\UserStatus\IProvider;
 use Psr\Container\ContainerExceptionInterface;
+use Psr\Log\LoggerInterface;
 
 class Manager implements IManager {
 
 	/** @var IServerContainer */
 	private $container;
 
-	/** @var ILogger */
+	/** @var LoggerInterface */
 	private $logger;
 
-	/** @var null */
+	/** @var class-string */
 	private $providerClass;
 
 	/** @var IProvider */
@@ -49,10 +49,10 @@ class Manager implements IManager {
 	 * Manager constructor.
 	 *
 	 * @param IServerContainer $container
-	 * @param ILogger $logger
+	 * @param LoggerInterface $logger
 	 */
 	public function __construct(IServerContainer $container,
-								ILogger $logger) {
+								LoggerInterface $logger) {
 		$this->container = $container;
 		$this->logger = $logger;
 	}
@@ -90,16 +90,35 @@ class Manager implements IManager {
 			return;
 		}
 
+		/**
+		 * @psalm-suppress InvalidCatch
+		 */
 		try {
 			$provider = $this->container->get($this->providerClass);
 		} catch (ContainerExceptionInterface $e) {
-			$this->logger->logException($e, [
-				'message' => 'Could not load user-status provider dynamically: ' . $e->getMessage(),
-				'level' => ILogger::ERROR,
+			$this->logger->error('Could not load user-status "' . $this->providerClass . '" provider dynamically: ' . $e->getMessage(), [
+				'exception' => $e,
 			]);
 			return;
 		}
 
 		$this->provider = $provider;
 	}
+
+	public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false): void {
+		$this->setupProvider();
+		if (!$this->provider || !($this->provider instanceof ISettableProvider)) {
+			return;
+		}
+
+		$this->provider->setUserStatus($userId, $messageId, $status, $createBackup);
+	}
+
+	public function revertUserStatus(string $userId, string $messageId, string $status): void {
+		$this->setupProvider();
+		if (!$this->provider || !($this->provider instanceof ISettableProvider)) {
+			return;
+		}
+		$this->provider->revertUserStatus($userId, $messageId, $status);
+	}
 }
diff --git a/lib/public/UserStatus/IManager.php b/lib/public/UserStatus/IManager.php
index 2f56ca17944..24cef821543 100644
--- a/lib/public/UserStatus/IManager.php
+++ b/lib/public/UserStatus/IManager.php
@@ -40,4 +40,25 @@ interface IManager {
 	 * @since 20.0.0
 	 */
 	public function getUserStatuses(array $userIds):array;
+
+
+	/**
+	 * Set a new status for the selected user.
+	 *
+	 * @param string $userId The user for which we want to update the status.
+	 * @param string $messageId The id of the predefined message.
+	 * @param bool $createBackup If true, this will store the old status so that it is possible to revert it later (e.g. after a call).
+	 * @since 23.0.0
+	 */
+	public function setUserStatus(string $userId, string $messageId, string $status, bool $createBackup = false): void;
+
+	/**
+	 * Revert an automatically set user status. For example after leaving a call,
+	 * change back to the previously set status.
+	 *
+	 * @param string $userId The user for which we want to update the status.
+	 * @param string $messageId The expected current messageId. If the user has already updated their status, this method does nothing.
+	 * @since 23.0.0
+	 */
+	public function revertUserStatus(string $userId, string $messageId, string $status): void;
 }
diff --git a/lib/public/UserStatus/IProvider.php b/lib/public/UserStatus/IProvider.php
index ba463e29f4d..976ebbefeab 100644
--- a/lib/public/UserStatus/IProvider.php
+++ b/lib/public/UserStatus/IProvider.php
@@ -26,7 +26,7 @@ declare(strict_types=1);
 namespace OCP\UserStatus;
 
 /**
- * Interface IManager
+ * Interface IProvider
  *
  * @since 20.0.0
  */