feat(bots): 🐣 Start with implementing bots

[nickvergessen]

☑️ Resolves

• Ref Webhook Support / bot integration #1879
• Requires feat(HTTPClient): Provide wrapped access to Guzzle's asyncRequest() server#38613

Config (webhook.json)

{
	"secret": "At least 32 long random shared secret"
}

Receiver (webhook.php)

<?php

$configData = file_get_contents('./webhook.json');

if ($configData === false) {
	file_put_contents('./webhook.log', "[ERROR] Could not read config]\n", FILE_APPEND);
	return;
}

$config = json_decode($configData, true);

if ($config === null) {
	file_put_contents('./webhook.log', "[ERROR] Could not json_decode config\n", FILE_APPEND);
	return;
}

$signature = $_SERVER['HTTP_X_NEXTCLOUD_TALK_SIGNATURE'] ?? '';
$random = $_SERVER['HTTP_X_NEXTCLOUD_TALK_RANDOM'] ?? '';
$server = $_SERVER['HTTP_X_NEXTCLOUD_TALK_BACKEND'] ?? '';

$body = file_get_contents('php://input');
$generatedDigest = hash_hmac('sha256', $random . $body, $config['secret']);

if (!hash_equals($generatedDigest, strtolower($signature))) {
	file_put_contents('./webhook.log', "[ERROR] Message signature could not be verified\n", FILE_APPEND);
	return;
}

file_put_contents('./webhook.log', $body . "\n", FILE_APPEND);
$data = json_decode($body, true);

if ($data['type'] === 'Create') {
	file_put_contents('./webhook.log', '[OK]    ' . $data['object']['name'] . "\n", FILE_APPEND);
}

if ($config['server']) {
	$message = 'Re: ' . json_decode($data['object']['name'], true)['message'];
	$body = [
		'message' => $message,
		'referenceId' => sha1($random),
		'replyTo' => (int) $data['object']['id'],
	];

	$jsonBody = json_encode($body, JSON_THROW_ON_ERROR);

	$random = bin2hex(random_bytes(32));
	$hash = hash_hmac('sha256', $random . $message, $config['secret']);
	file_put_contents('./webhook.log', '[INFO]  Reply: Random ' . $random . "\n", FILE_APPEND);
	file_put_contents('./webhook.log', '[INFO]  Reply: Hash ' . $hash . "\n", FILE_APPEND);

	try {
		$ch = curl_init(rtrim($server, '/') . '/ocs/v2.php/apps/spreed/api/v1/bot/' . $data['target']['id'] . '/message');
		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
		curl_setopt($ch, CURLOPT_POST, 1);
		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
		curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
		curl_setopt($ch, CURLOPT_POSTFIELDS, $jsonBody);
		curl_setopt($ch, CURLOPT_USERAGENT, 'nextcloud-talk-bot/1.0');
		curl_setopt($ch, CURLOPT_HTTPHEADER, [
			'OCS-APIRequest: true',
			'Content-Type: application/json',
			'X-Nextcloud-Talk-Bot-Random: ' . $random,
			'X-Nextcloud-Talk-Bot-Signature: ' . $hash,
		]);
		$content  = curl_exec($ch);

		$error = curl_error($ch);
		if ($error) {
			file_put_contents('./webhook.log', '[ERROR] CURL error: ' . $error . "\n", FILE_APPEND);
		} elseif ($content) {
			file_put_contents('./webhook.log', '[INFO]  CURL response: ' . $content . "\n", FILE_APPEND);
		}

		curl_close($ch);
	} catch (\Exception $exception) {
		file_put_contents('./webhook.log', '[ERROR] ' . get_class($exception) . ': ' . $exception->getMessage() . "\n", FILE_APPEND);
	}
}

Webhook message received

{
  "type": "Create",
  "actor": {
    "type": "Person",
    "id": "users/admin",
    "name": "Laura Adams"
  },
  "object": {
    "type": "Note",
    "id": "2370",
    "name": "{\"message\":\"Hello {mention-call1} \\ud83d\\udc4b\",\"parameters\":{\"mention-call1\":{\"type\":\"call\",\"id\":\"u48mn5p4\",\"name\":\"Webhooked room\",\"call-type\":\"group\",\"icon-url\":\"https:\\/\\/192.168.2.63\\/ocs\\/v2.php\\/apps\\/spreed\\/api\\/v1\\/room\\/u48mn5p4\\/avatar?v=996f0d79\"}}}"
  },
  "target": {
    "type": "Collection",
    "id": "u48mn5p4",
    "name": "Webhooked room"
  }
}

[nickvergessen]

Next steps

• Add commands to handle bots
  • List
  • Install
    • Setup
    • Remove
  • Uninstall
• States
  • Enable
  • Disable
  • Prevent installing to new conversations
• API for moderators to see all bots (that are setupable) and enable/disable for current conversation

[nickvergessen]

Now with integration tests for setup/remove as moderator as well as handling all cases via OCC.

Rendering on iOS and Android also looks good:

iOS	Android

So I guess API is ready to review.

[nickvergessen]

Tests now fail due to missing #10078

[mkrecek234]

@nickvergessen Thanks a lot for implementing webhooks. Unfortunately I struggle to accomplish the following which was also requested in issue #1879 - Slack and most other chat solutions allow the user to easily create a token for a chat room, and based on that token create a webhook secure URL which then can be used to let any other application send a message into that chat room (no authentication then required). How can I accomplish this now programmatically? I want users to add any room to my own (non-Nextcloud) app, and let my app communicate via Nextcloud Talk to users. Thank you for a hint.

[nickvergessen]

Responded in the issue