nextcloud-guests/tests/integration/features/bootstrap/GuestsContext.php

<?php
/**
 * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2017 ownCloud GmbH
 * SPDX-License-Identifier: AGPL-3.0-only AND (AGPL-3.0-or-later OR AGPL-3.0-only)
 */

use Behat\Behat\Context\Context;
use Behat\Behat\Context\SnippetAcceptingContext;
use GuzzleHttp\Client;

require __DIR__ . '/../../vendor/autoload.php';


/**
 * Guests context.
 */
class GuestsContext implements Context, SnippetAcceptingContext {
	use Webdav;

	/** @var array */
	private $createdGuests = [];

	public function prepareUserNameAsFrontend($guestDisplayName, $guestEmail) {
		$emailDomain = preg_split('/\./', preg_split('/@/', $guestEmail, null, null)[1], null, null);
		$userName = $guestDisplayName . '_' . $emailDomain[0] . '_' . $emailDomain[1];
		return $userName;
	}

	/**
	 * @Given user :user creates guest user :guestDisplayName with email :guestEmail
	 * @param string $user
	 * @param string $guestDisplayName
	 * @param string $guestEmail
	 */
	public function userCreatedAGuestUser($user, $guestDisplayName, $guestEmail) {
		$fullUrl = substr($this->baseUrl, 0, -4) . '/index.php/apps/guests/users';
		//Replicating frontend behaviour
		$userName = $this->prepareUserNameAsFrontend($guestDisplayName, $guestEmail);
		$fullUrl = $fullUrl . '?displayName=' . $guestDisplayName . '&email=' . $guestEmail . '&username=' . $userName;
		$client = new Client();
		$options = [];
		if ($user === 'admin') {
			$options['auth'] = $this->adminUser;
		} else {
			$options['auth'] = [$user, $this->regularUser];
		}
		$request = $client->createRequest("PUT", $fullUrl, $options);
		$request->addHeader('Content-Type', 'application/x-www-form-urlencoded');

		try {
			$this->response = $client->send($request);
		} catch (\GuzzleHttp\Exception\BadResponseException $e) {
			// 4xx and 5xx responses cause an exception
			$this->response = $e->getResponse();
		}
		$this->createdGuests[$guestDisplayName] = $guestEmail;
	}

	/**
	 * @Then check that user :user is a guest
	 * @param string $guestDisplayName
	 */
	public function checkGuestUser($guestDisplayName) {
		$userName = $this->prepareUserNameAsFrontend($guestDisplayName, $this->createdGuests[$guestDisplayName]);
		$this->checkThatUserBelongsToGroup($userName, 'guest_app');
	}

	/**
	 * @Then guest user :user is deleted
	 * @param string $guestDisplayName
	 */
	public function deleteGuestUser($guestDisplayName) {
		$userName = $this->prepareUserNameAsFrontend($guestDisplayName, $this->createdGuests[$guestDisplayName]);
		$this->deleteUser($userName);
	}

	/*Processes the body of an email sent and gets the reset password url
	  It depends on the content of the email*/
	public function extractResetPasswordUrl($emailBody) {
		$knownString = 'Activate your guest account at ownCloud by setting a password: ';
		$nextString = 'Then view it';
		$posKnownString = strpos($emailBody, $knownString);
		$posNextString = strpos($emailBody, $nextString, $posKnownString + strlen($knownString));
		$urlResetPasswd = substr($emailBody,
			$posKnownString + strlen($knownString),
			$posNextString - ($posKnownString + strlen($knownString)));
		$urlResetPasswd = preg_replace('/[\s]+/mu', ' ', $urlResetPasswd);
		$urlResetPasswd = str_replace('=', '', $urlResetPasswd);
		$urlResetPasswd = str_replace(' ', '', $urlResetPasswd);
		return $urlResetPasswd;
	}

	/*Function to prepare the set password url from the reset password form one*/
	public function getSetPasswordUrl($urlResetPasswd) {
		$resetUrlParts = explode('/', $urlResetPasswd);
		array_splice($resetUrlParts, 5, 2, 'set');
		$urlSetPasswd = implode('/', $resetUrlParts);
		return $urlSetPasswd;
	}

	/**
	 * @Given guest user :user sets its password
	 * @param string $guestDisplayName
	 */
	public function guestUserSetsItsPassword($guestDisplayName) {
		$userName = $this->prepareUserNameAsFrontend($guestDisplayName, $this->createdGuests[$guestDisplayName]);
		$emails = $this->getEmails();
		$lastEmailBody = $emails->items[0]->Content->Body;
		$resetPwUrl = $this->extractResetPasswordUrl($lastEmailBody);
		$urlSetPasswd = $this->getSetPasswordUrl($resetPwUrl);

		$client = new Client();
		$options['body'] = [
			'password' => $this->regularUser,
			'proceed' => 'false'
		];
		try {
			$this->response = $client->send($client->createRequest('POST', $urlSetPasswd, $options));
		} catch (\GuzzleHttp\Exception\ClientException $ex) {
			$this->response = $ex->getResponse();
		}
	}

	/**
	 * @BeforeScenario
	 * @AfterScenario
	 */
	public function cleanupGuests() {
		foreach ($this->createdGuests as $displayName => $email) {
			$this->deleteGuestUser($displayName);
		}
	}
}