OCA\TwoFactorGateway\Provider\Channel\WhatsApp\Gateway

Complexity

Total Complexity

31

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Test Coverage

Coverage

10.87%

Importance

Changes	2
Bugs	1	Features	1

10 Methods

Rating	Name	Duplication	Size	Complexity
A	send()	0	29	3
A	cliConfigure()	0	18	3
A	getSessionStatus()	0	25	6
A	startSession()	0	7	1
A	getChatIdFromPhoneNumber()	0	20	4
A	getBaseUrl()	0	8	2
A	getSessionStart()	0	13	3
B	getSessionQr()	0	43	7
A	__construct()	0	10	1
A	createSettings()	0	9	1

<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */

namespace OCA\TwoFactorGateway\Provider\Channel\WhatsApp;

use GuzzleHttp\Exception\ClientException;

The type GuzzleHttp\Exception\ClientException was not found. Maybe you did not declare it correctly or list all dependencies?

use GuzzleHttp\Exception\RequestException;

The type GuzzleHttp\Exception\RequestException was not found. Maybe you did not declare it correctly or list all dependencies?

use GuzzleHttp\Exception\ServerException;

The type GuzzleHttp\Exception\ServerException was not found. Maybe you did not declare it correctly or list all dependencies?

use OCA\TwoFactorGateway\Exception\ConfigurationException;
use OCA\TwoFactorGateway\Exception\MessageTransmissionException;
use OCA\TwoFactorGateway\Provider\FieldDefinition;
use OCA\TwoFactorGateway\Provider\Gateway\AGateway;
use OCA\TwoFactorGateway\Provider\Settings;
use OCA\TwoFactorGateway\Vendor\BaconQrCode\Renderer\PlainTextRenderer;

The type OCA\TwoFactorGateway\Vendor\BaconQrCode\Renderer\PlainTextRenderer was not found. Maybe you did not declare it correctly or list all dependencies?

use OCA\TwoFactorGateway\Vendor\BaconQrCode\Writer;

The type OCA\TwoFactorGateway\Vendor\BaconQrCode\Writer was not found. Maybe you did not declare it correctly or list all dependencies?

use OCP\Http\Client\IClient;
use OCP\Http\Client\IClientService;
use OCP\IAppConfig;
use OCP\IConfig;
use OCP\IL10N;
use Psr\Log\LoggerInterface;
use Symfony\Component\Console\Cursor;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;

/**
 * @method string getBaseUrl()
 * @method static setBaseUrl(string $baseUrl)
 */
class Gateway extends AGateway {
	private string $instanceId;
	private IClient $client;
	private string $lazyBaseUrl = '';
	public function __construct(
		public IAppConfig $appConfig,
		private IConfig $config,
		private IClientService $clientService,
		private LoggerInterface $logger,
		private IL10N $l10n,
	) {
		parent::__construct($appConfig);
		$this->instanceId = $this->config->getSystemValue('instanceid');
		$this->client = $this->clientService->newClient();
	}

	#[\Override]
	public function createSettings(): Settings {
		return new Settings(
			name: 'WhatsApp',
			allowMarkdown: true,
			fields: [
				new FieldDefinition(
					field: 'base_url',
					prompt: 'Base URL to your WhatsApp API endpoint:',
				),
			],
		);
	}

	#[\Override]
	public function send(string $identifier, string $message, array $extra = []): void {
		$this->logger->debug("sending whatsapp message to $identifier, message: $message");

		$response = $this->getSessionStatus();
		if ($response !== 'CONNECTED') {
			throw new MessageTransmissionException('WhatsApp session is not connected. Current status: ' . $response);
		}

		$chatId = $this->getChatIdFromPhoneNumber($identifier);

		try {
			$response = $this->client->post($this->getBaseUrl() . '/client/sendMessage/' . $this->instanceId, [

The assignment to $response is dead and can be removed.

				'json' => [
					'chatId' => $chatId,
					'contentType' => 'string',
					'content' => $message,
					'options' => [],
				],
			]);
		} catch (\Exception $e) {
			$this->logger->error('Could not send WhatsApp message', [
				'identifier' => $identifier,
				'exception' => $e,
			]);
			throw new MessageTransmissionException();
		}

		$this->logger->debug("whatsapp message to chat $identifier sent");
	}

	#[\Override]
	public function cliConfigure(InputInterface $input, OutputInterface $output): int {
		$helper = new QuestionHelper();
		$baseUrlQuestion = new Question($this->getSettings()->fields[0]->prompt . ' ');
		$this->lazyBaseUrl = $helper->ask($input, $output, $baseUrlQuestion);
		$this->lazyBaseUrl = rtrim($this->lazyBaseUrl, '/');

		try {
			if ($this->getSessionQr($output) === 1) {
				return 1;
			}
		} catch (\Exception $e) {
			$output->writeln('<error>' . $e->getMessage() . '</error>');
		}

		$this->setBaseUrl($this->lazyBaseUrl);

It seems like $this->lazyBaseUrl can also be of type OCA\TwoFactorGateway\Provider\Channel\WhatsApp\Gateway; however, parameter $baseUrl of OCA\TwoFactorGateway\Provider\Channel\WhatsApp\Gateway::setBaseUrl() does only seem to accept string, maybe add an additional type check?

		return 0;
	}

	private function getChatIdFromPhoneNumber(string $phoneNumber): string {
		try {
			$response = $this->client->post($this->getBaseUrl() . '/client/getNumberId/' . $this->instanceId, [
				'json' => [
					'number' => preg_replace('/\D/', '', $phoneNumber),
				],
			]);
			$json = $response->getBody();
			$data = json_decode($json, true);

It seems like $json can also be of type null and resource; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

			if (empty($data['result'])) {
				throw new MessageTransmissionException('The phone number is not registered on WhatsApp.');
			}
			return $data['result']['_serialized'];
		} catch (ServerException $e) {
			$content = $e->getResponse()?->getBody()?->getContents();
			if ($content === null) {
				throw new MessageTransmissionException('Unknown error');
			}
			$errorMessage = json_decode($content, true)['error'] ?? 'Unknown error';
			throw new MessageTransmissionException($errorMessage);
		}
	}

	/**
	 * @throws ConfigurationException
	 */
	public function getBaseUrl(): string {
		if ($this->lazyBaseUrl !== '') {
			return $this->lazyBaseUrl;
		}

		/** @var string */
		$this->lazyBaseUrl = $this->__call(__FUNCTION__, []);

The property lazyBaseUrl does not exist on string.

		return $this->lazyBaseUrl;

The expression return $this->lazyBaseUrl returns the type OCA\TwoFactorGateway\Provider\Channel\WhatsApp\Gateway which is incompatible with the type-hinted return string.

	}

	private function getSessionQr(OutputInterface $output): int {
		$renderer = new PlainTextRenderer(margin: 3);
		$writer = new Writer($renderer);
		$cursor = new Cursor($output);

		if ($this->startSession() === 2) {
			$output->writeln('<info>Session already connected, no need to scan QR code.</info>');
			return 0;
		}

		$last = null;
		while (true) {
			$response = $this->client->get($this->getBaseUrl() . '/session/qr/' . $this->instanceId);
			$json = $response->getBody();
			$data = json_decode($json, true);

It seems like $json can also be of type null and resource; however, parameter $json of json_decode() does only seem to accept string, maybe add an additional type check?

			if ($data['success'] === false) {
				if ($data['message'] === 'qr code not ready or already scanned') {
					$output->writeln('<error>Session not connected yet, waiting...</error>');
					sleep(2);
					continue;
				}
				$output->writeln('<error>' . $data['message'] . '</error>');
				return 1;
			}
			$qrCodeContent = $data['qr'];

			if ($qrCodeContent !== $last) {
				$last = $qrCodeContent;
				$cursor->clearScreen();
				$cursor->moveToPosition(1, 1);

				$output->write($writer->writeString($qrCodeContent));
				$output->writeln('');
				$output->writeln('<info>Please confirm on your phone.</info>');
				$output->writeln('Press Ctrl+C to exit');
			}

			sleep(1);
			if ($this->startSession() === 2) {
				return 0;
			}
		}
		return 0;
	}

	private function getSessionStatus(): string {
		$endpoint = $this->getBaseUrl() . '/session/status/' . $this->instanceId;

		try {
			$response = $this->client->get($endpoint);
			$body = (string)$response->getBody();
			$responseData = json_decode($body, true);

			if (!is_array($responseData)) {
				return 'not_connected';
			}

			if (($responseData['success'] ?? null) === false) {
				$msg = $responseData['message'] ?? '';
				return in_array($msg, ['session_not_found', 'session_not_connected'], true)
					? $msg
					: 'not_connected';
			}

			return (string)($responseData['state'] ?? 'not_connected');
		} catch (ClientException $e) {
			return 'not_connected';
		} catch (RequestException $e) {
			$this->logger->info('Could not connect to ' . $endpoint, ['exception' => $e]);
			throw new \Exception('Could not connect to the WhatsApp API. Please check the URL.', 1);
		}
	}

	/**
	 * @return integer 0 = not connected, 1 = started, 2 = connected
	 */
	private function startSession(): int {
		$status = $this->getSessionStatus();
		return match ($status) {
			'CONNECTED' => 2,
			'session_not_connected' => 0,
			'session_not_found' => $this->getSessionStart(),
			default => 0,
		};
	}

	private function getSessionStart(): int {
		$endpoint = $this->getBaseUrl() . '/session/start/' . $this->instanceId;
		try {
			$this->client->get($endpoint);
		} catch (ClientException $e) {
			return 1;
		} catch (RequestException $e) {
			$this->logger->info('Could not connect to ' . $endpoint, [
				'exception' => $e,
			]);
			throw new \Exception('Could not connect to the WhatsApp API. Please check the URL.', 1);
		}
		return 0;
	}
}