<?php

/**
 * This file is part of the CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CodeIgniter\Test;

use CodeIgniter\Events\Events;
use CodeIgniter\HTTP\IncomingRequest;
use CodeIgniter\HTTP\Request;
use CodeIgniter\HTTP\URI;
use CodeIgniter\HTTP\UserAgent;
use CodeIgniter\Router\Exceptions\RedirectException;
use CodeIgniter\Router\RouteCollection;
use Config\App;
use Config\Services;
use Exception;
use ReflectionException;

/**
 * Trait FeatureTestTrait
 *
 * Provides additional utilities for doing full HTTP testing
 * against your application in trait format.
 */
trait FeatureTestTrait
{
	/**
	 * Sets a RouteCollection that will override
	 * the application's route collection.
	 *
	 * Example routes:
	 * [
	 *    ['get', 'home', 'Home::index']
	 * ]
	 *
	 * @param array $routes
	 *
	 * @return $this
	 */
	protected function withRoutes(array $routes = null)
	{
		$collection = Services::routes();

		if ($routes)
		{
			$collection->resetRoutes();
			foreach ($routes as $route)
			{
				$collection->{$route[0]}($route[1], $route[2]);
			}
		}

		$this->routes = $collection;

		return $this;
	}

	/**
	 * Sets any values that should exist during this session.
	 *
	 * @param array|null $values Array of values, or null to use the current $_SESSION
	 *
	 * @return $this
	 */
	public function withSession(array $values = null)
	{
		$this->session = is_null($values) ? $_SESSION : $values;

		return $this;
	}

	/**
	 * Set request's headers
	 *
	 * Example of use
	 * withHeaders([
	 *  'Authorization' => 'Token'
	 * ])
	 *
	 * @param array $headers Array of headers
	 *
	 * @return $this
	 */
	public function withHeaders(array $headers = [])
	{
		$this->headers = $headers;

		return $this;
	}

	/**
	 * Set the format the request's body should have.
	 *
	 * @param  string $format The desired format. Currently supported formats: xml, json
	 * @return $this
	 */
	public function withBodyFormat(string $format)
	{
		$this->bodyFormat = $format;

		return $this;
	}

	/**
	 * Set the raw body for the request
	 *
	 * @param  mixed $body
	 * @return $this
	 */
	public function withBody($body)
	{
		$this->requestBody = $body;

		return $this;
	}

	/**
	 * Don't run any events while running this test.
	 *
	 * @return $this
	 */
	public function skipEvents()
	{
		Events::simulate(true);

		return $this;
	}

	/**
	 * Calls a single URI, executes it, and returns a TestResponse
	 * instance that can be used to run many assertions against.
	 *
	 * @param string     $method
	 * @param string     $path
	 * @param array|null $params
	 *
	 * @return TestResponse
	 * @throws RedirectException
	 * @throws Exception
	 */
	public function call(string $method, string $path, array $params = null)
	{
		$buffer = \ob_get_level();

		// Clean up any open output buffers
		// not relevant to unit testing
		// @codeCoverageIgnoreStart
		if (\ob_get_level() > 0 && (! isset($this->clean) || $this->clean === true))
		{
			\ob_end_clean();
		}
		// @codeCoverageIgnoreEnd

		// Simulate having a blank session
		$_SESSION                  = [];
		$_SERVER['REQUEST_METHOD'] = $method;

		$request = $this->setupRequest($method, $path);
		$request = $this->setupHeaders($request);
		$request = $this->populateGlobals($method, $request, $params);
		$request = $this->setRequestBody($request);

		// Initialize the RouteCollection
		if (! $routes = $this->routes)
		{
			require APPPATH . 'Config/Routes.php';

			/**
			 * @var RouteCollection $routes
			 */
			$routes->getRoutes('*');
		}

		$routes->setHTTPVerb($method);

		// Make sure any other classes that might call the request
		// instance get the right one.
		Services::injectMock('request', $request);

		// Make sure filters are reset between tests
		Services::injectMock('filters', Services::filters(null, false));

		$response = $this->app
				->setRequest($request)
				->run($routes, true);

		$output = \ob_get_contents();
		if (empty($response->getBody()) && ! empty($output))
		{
			$response->setBody($output);
		}

		// Reset directory if it has been set
		Services::router()->setDirectory(null);

		// Ensure the output buffer is identical so no tests are risky
		// @codeCoverageIgnoreStart
		while (\ob_get_level() > $buffer)
		{
			\ob_end_clean();
		}
		while (\ob_get_level() < $buffer)
		{
			\ob_start();
		}
		// @codeCoverageIgnoreEnd

		return new TestResponse($response);
	}

	/**
	 * Performs a GET request.
	 *
	 * @param string     $path
	 * @param array|null $params
	 *
	 * @return TestResponse
	 * @throws RedirectException
	 * @throws Exception
	 */
	public function get(string $path, array $params = null)
	{
		return $this->call('get', $path, $params);
	}

	/**
	 * Performs a POST request.
	 *
	 * @param string     $path
	 * @param array|null $params
	 *
	 * @return TestResponse
	 * @throws RedirectException
	 * @throws Exception
	 */
	public function post(string $path, array $params = null)
	{
		return $this->call('post', $path, $params);
	}

	/**
	 * Performs a PUT request
	 *
	 * @param string     $path
	 * @param array|null $params
	 *
	 * @return TestResponse
	 * @throws RedirectException
	 * @throws Exception
	 */
	public function put(string $path, array $params = null)
	{
		return $this->call('put', $path, $params);
	}

	/**
	 * Performss a PATCH request
	 *
	 * @param string     $path
	 * @param array|null $params
	 *
	 * @return TestResponse
	 * @throws RedirectException
	 * @throws Exception
	 */
	public function patch(string $path, array $params = null)
	{
		return $this->call('patch', $path, $params);
	}

	/**
	 * Performs a DELETE request.
	 *
	 * @param string     $path
	 * @param array|null $params
	 *
	 * @return TestResponse
	 * @throws RedirectException
	 * @throws Exception
	 */
	public function delete(string $path, array $params = null)
	{
		return $this->call('delete', $path, $params);
	}

	/**
	 * Performs an OPTIONS request.
	 *
	 * @param string     $path
	 * @param array|null $params
	 *
	 * @return TestResponse
	 * @throws RedirectException
	 * @throws Exception
	 */
	public function options(string $path, array $params = null)
	{
		return $this->call('options', $path, $params);
	}

	/**
	 * Setup a Request object to use so that CodeIgniter
	 * won't try to auto-populate some of the items.
	 *
	 * @param string      $method
	 * @param string|null $path
	 *
	 * @return IncomingRequest
	 */
	protected function setupRequest(string $method, string $path = null): IncomingRequest
	{
		$path    = URI::removeDotSegments($path);
		$config  = config(App::class);
		$request = new IncomingRequest($config, new URI(), null, new UserAgent());

		// $path may have a query in it
		$parts                   = explode('?', $path);
		$_SERVER['QUERY_STRING'] = $parts[1] ?? '';

		$request->setPath($parts[0]);
		$request->setMethod($method);
		$request->setProtocolVersion('1.1');

		if ($config->forceGlobalSecureRequests)
		{
			$_SERVER['HTTPS'] = 'test';
		}

		return $request;
	}

	/**
	 * Setup the custom request's headers
	 *
	 * @param IncomingRequest $request
	 *
	 * @return IncomingRequest
	 */
	protected function setupHeaders(IncomingRequest $request)
	{
		if (! empty($this->headers))
		{
			foreach ($this->headers as $name => $value)
			{
				$request->setHeader($name, $value);
			}
		}

		return $request;
	}

	/**
	 * Populates the data of our Request with "global" data
	 * relevant to the request, like $_POST data.
	 *
	 * Always populate the GET vars based on the URI.
	 *
	 * @param string     $method
	 * @param Request    $request
	 * @param array|null $params
	 *
	 * @return Request
	 * @throws ReflectionException
	 */
	protected function populateGlobals(string $method, Request $request, array $params = null)
	{
		// $params should set the query vars if present,
		// otherwise set it from the URL.
		$get = ! empty($params) && $method === 'get'
			? $params
			: $this->getPrivateProperty($request->uri, 'query'); // @phpstan-ignore-line

		$request->setGlobal('get', $get);
		if ($method !== 'get')
		{
			$request->setGlobal($method, $params);
		}

		$request->setGlobal('request', $params);

		$_SESSION = $this->session ?? [];

		return $request;
	}

	/**
	 * Set the request's body formatted according to the value in $this->bodyFormat.
	 * This allows the body to be formatted in a way that the controller is going to
	 * expect as in the case of testing a JSON or XML API.
	 *
	 * @param  Request    $request
	 * @param  null|array $params  The parameters to be formatted and put in the body. If this is empty, it will get the
	 *                               what has been loaded into the request global of the request class.
	 * @return Request
	 */
	protected function setRequestBody(Request $request, array $params = null): Request
	{
		if (isset($this->requestBody) && $this->requestBody !== '')
		{
			$request->setBody($this->requestBody);
			return $request;
		}

		if (isset($this->bodyFormat) && $this->bodyFormat !== '')
		{
			if (empty($params))
			{
				$params = $request->fetchGlobal('request');
			}
			$formatMime = '';
			if ($this->bodyFormat === 'json')
			{
				$formatMime = 'application/json';
			}
			elseif ($this->bodyFormat === 'xml')
			{
				$formatMime = 'application/xml';
			}
			if (! empty($formatMime) && ! empty($params))
			{
				$formatted = Services::format()->getFormatter($formatMime)->format($params);
				$request->setBody($formatted);
				$request->setHeader('Content-Type', $formatMime);
			}
		}

		return $request;
	}
}
