nextcloud-spreed/lib/Model/Bot.php

<?php

declare(strict_types=1);

/**
 * @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com>
 *
 * @author Joas Schilling <coding@schilljs.com>
 *
 * @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 OCA\Talk\Model;

class Bot {
	public const STATE_DISABLED = 0;
	public const STATE_ENABLED = 1;
	public const STATE_NO_SETUP = 2;

	public const FEATURE_NONE = 0;
	public const FEATURE_WEBHOOK = 1;
	public const FEATURE_RESPONSE = 2;

	public const FEATURE_LABEL_NONE = 'none';
	public const FEATURE_LABEL_WEBHOOK = 'webhook';
	public const FEATURE_LABEL_RESPONSE = 'response';

	public const FEATURE_MAP = [
		self::FEATURE_NONE => self::FEATURE_LABEL_NONE,
		self::FEATURE_WEBHOOK => self::FEATURE_LABEL_WEBHOOK,
		self::FEATURE_RESPONSE => self::FEATURE_LABEL_RESPONSE,
	];

	public function __construct(
		protected BotServer $botServer,
		protected BotConversation $botConversation,
	) {
	}

	public function getBotServer(): BotServer {
		return $this->botServer;
	}

	public function getBotConversation(): BotConversation {
		return $this->botConversation;
	}

	public function isEnabled(): bool {
		return $this->botServer->getState() !== self::STATE_DISABLED
			&& $this->botConversation->getState() !== self::STATE_DISABLED;
	}

	public static function featureFlagsToLabels(int $flags): string {
		if ($flags === self::FEATURE_NONE) {
			return self::FEATURE_LABEL_NONE;
		}

		$features = [];
		foreach (self::FEATURE_MAP as $flag => $label) {
			if ($flags & $flag) {
				$features[] = $label;
			}
		}
		return implode(', ', $features);
	}

	public static function featureLabelsToFlags(array $labels): int {
		$reverseMap = array_flip(self::FEATURE_MAP);
		$flags = 0;
		foreach ($labels as $label) {
			if ($label === self::FEATURE_LABEL_NONE) {
				return self::FEATURE_NONE;
			}
			if (isset($reverseMap[$label])) {
				$flags += $reverseMap[$label];
			}
		}

		return $flags;
	}
}