Response::send() - Code Metrics - Inspection of "Improved calculation of the progress of the projec..." - YetiForceCompany/YetiForceCRM - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — developer ( dedd13...2a4a55 )

by Mariusz

created 2023-07-13 05:55 UTC

Response::send() F

↳ Parent: Project

Complexity

Conditions	20
Paths	336

Size

Total Lines	62
Code Lines	46

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	420

Importance

Changes

Metric	Value
eloc	46
dl	0
loc	62
ccs	0
cts	0
cp	0
rs	1.6333
c	0
b	0
f	0
cc	20
nc	336
nop	0
crap	420

How to fix Long Method Complexity

<?php
/**
 * Web service response file.
 *
 * @package API
 *
 * @copyright YetiForce S.A.
 * @license   YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
 * @author    Mariusz Krzaczkowski <[email protected]>
 */

namespace Api\Core;

/**
 * Web service response class.
 */
class Response
{
	/**
	 * Access control allow headers.
	 *
	 * @var string[]
	 */
	protected $acceptableHeaders = ['x-api-key', 'x-encrypted', 'x-token'];
	/**
	 * Access control allow methods.
	 *
	 * @var string[]
	 */
	protected $acceptableMethods = [];
	/**
	 * Request instance.
	 *
	 * @var \Api\Core\Request
	 */
	protected $request;
	protected static $instance = false;
	protected $body;
	/**
	 * File instance.
	 *
	 * @var \App\Fields\File
	 */
	protected $file;
	/**
	 * Headers.
	 *
	 * @var array
	 */
	protected $headers = [];
	/**
	 * @var int Response status code.
	 */
	protected $status = 200;
	/**
	 * @var string Response data type.
	 */
	protected $responseType;
	/**
	 * @var string Reason phrase.
	 */
	protected $reasonPhrase;
	/**
	 * @var string Reason content type
	 */
	protected $contentType;

	/**
	 * Get instance.
	 *
	 * @return self
	 */
	public static function getInstance(): self
	{
		if (!static::$instance) {
			static::$instance = new self();
		}
		return static::$instance;
	}

	/**
	 * Add header.
	 *
	 * @param string $key
	 * @param mixed  $value
	 *
	 * @return void
	 */
	public function addHeader(string $key, $value): void
	{
		$this->headers[$key] = $value;
	}

	/**
	 * Set status code.
	 *
	 * @param int $status
	 *
	 * @return void
	 */
	public function setStatus(int $status): void
	{
		if (is_numeric($status)) {
			$this->status = $status;
		}
	}

	/**
	 * Set reason phrase.
	 *
	 * @param string $reasonPhrase
	 *
	 * @return void
	 */
	public function setReasonPhrase(string $reasonPhrase): void
	{
		$this->reasonPhrase = $reasonPhrase;
	}

	/**
	 * Set body data.
	 *
	 * @param array $body
	 *
	 * @return void
	 */
	public function setBody(array $body): void
	{
		$this->body = $body;
		$this->responseType = 'data';
	}

	/**
	 * Set file instance.
	 *
	 * @param \App\Fields\File $file
	 *
	 * @return void
	 */
	public function setFile(\App\Fields\File $file): void
	{
		$this->file = $file;
		$this->responseType = 'file';
	}

	/**
	 * Set request.
	 *
	 * @param \Api\Core\Request $request
	 *
	 * @return void
	 */
	public function setRequest(Request $request): void
	{
		$this->request = $request;
	}

	/**
	 * Set acceptable methods.
	 *
	 * @param string[] $methods
	 *
	 * @return void
	 */
	public function setAcceptableMethods(array $methods)
	{
		$this->acceptableMethods = array_merge($this->acceptableMethods, $methods);
	}

	/**
	 * Set acceptable headers.
	 *
	 * @param string[] $headers
	 *
	 * @return void
	 */
	public function setAcceptableHeaders(array $headers)
	{
		$this->acceptableHeaders = array_merge($this->acceptableHeaders, $headers);
	}

	/**
	 * Set acceptable headers.
	 *
	 * @param string $type
	 *
	 * @return void
	 */
	public function setContentType(string $type): void
	{
		$this->contentType = $type;
	}

	/**
	 * Get reason phrase.
	 *
	 * @return string
	 */
	private function getReasonPhrase(): string
	{
		if (isset($this->reasonPhrase)) {
			return str_ireplace(["\r\n", "\r", "\n"], ' ', $this->reasonPhrase);
		}
		$statusCodes = [
			200 => 'OK',
			401 => 'Unauthorized',
			403 => 'Forbidden',
			404 => 'Not Found',
			405 => 'Method Not Allowed',
			500 => 'Internal Server Error',
		];
		return $statusCodes[$this->status] ?? $statusCodes[500];
	}

	public function send()
	{
		$encryptDataTransfer = \App\Config::api('ENCRYPT_DATA_TRANSFER') ? 1 : 0;
		if (200 !== $this->status || 'data' !== $this->responseType) {
			$encryptDataTransfer = 0;
		}
		if (empty($this->contentType)) {
			$requestContentType = strtolower(\App\Request::_getServer('HTTP_ACCEPT'));
			if (empty($requestContentType) || '*/*' === $requestContentType) {
				$this->contentType = $this->request->contentType;
			} else {
				$this->contentType = $requestContentType;
			}
		}
		$headersSent = headers_sent();
		if (!$headersSent) {
			header('Access-Control-Allow-Origin: *');
			header('Access-Control-Allow-Methods: ' . implode(', ', $this->acceptableMethods));
			header('Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization, ' . implode(', ', $this->acceptableHeaders));
			header(\App\Request::_getServer('SERVER_PROTOCOL') . ' ' . $this->status . ' ' . $this->getReasonPhrase());
			header('Encrypted: ' . $encryptDataTransfer);
			foreach ($this->headers as $key => $header) {
				header(\strtolower($key) . ': ' . $header);
			}
		}
		if ($encryptDataTransfer) {
			header('Content-disposition: attachment; filename="api.json"');
			if (!empty($this->body)) {
				echo $this->encryptData($this->body);
			}
		} else {
			switch ($this->responseType) {
				case 'data':
					if (!empty($this->body)) {
						if (!$headersSent) {
							header("Content-type: {$this->contentType}");
						}
						if (false !== strpos($this->contentType, 'application/xml')) {
							if (!$headersSent) {
								header('Content-disposition: attachment; filename="api.xml"');
							}
							echo $this->encodeXml($this->body);
						} else {
							if (!$headersSent) {
								header('Content-disposition: attachment; filename="api.json"');
							}
							echo $this->encodeJson($this->body);
						}
					}
					break;
				case 'file':
					if (isset($this->file) && file_exists($this->file->getPath())) {
						header('Content-type: ' . $this->file->getMimeType());
						header('Content-transfer-encoding: binary');
						header('Content-length: ' . $this->file->getSize());
						header('Content-disposition: attachment; filename="' . $this->file->getName() . '"');
						readfile($this->file->getPath());
					}
					break;
			}
		}
		$this->debugResponse();
	}

	public function encryptData($data)
	{
		openssl_public_encrypt($data, $encrypted, 'file://' . ROOT_DIRECTORY . \DIRECTORY_SEPARATOR . \App\Config::api('PUBLIC_KEY'), OPENSSL_PKCS1_OAEP_PADDING);
		return $encrypted;
	}

	/**
	 * Debug response function.
	 *
	 * @return void
	 */
	public function debugResponse()
	{
		if (\App\Config::debug('apiLogAllRequests')) {
			$log = '============ Request ' . \App\RequestUtil::requestId() . ' (Response) ======  ' . date('Y-m-d H:i:s') . "  ======\n";
			$log .= 'REQUEST_METHOD: ' . \App\Request::getRequestMethod() . PHP_EOL;
			$log .= 'REQUEST_URI: ' . $_SERVER['REQUEST_URI'] . PHP_EOL;
			$log .= 'QUERY_STRING: ' . $_SERVER['QUERY_STRING'] . PHP_EOL;
			$log .= 'PATH_INFO: ' . ($_SERVER['PATH_INFO'] ?? '') . PHP_EOL;
			$log .= 'IP: ' . $_SERVER['REMOTE_ADDR'] . PHP_EOL;
			if ($this->body) {
				$log .= "----------- Response data -----------\n";
				$log .= print_r($this->body, true) . PHP_EOL;
			}
			$path = ROOT_DIRECTORY . '/cache/logs/webserviceDebug.log';
			if (isset(\Api\Controller::$container)) {
				$path = ROOT_DIRECTORY . '/cache/logs/webservice' . \Api\Controller::$container . 'Debug.log';
			}
			file_put_contents($path, $log, FILE_APPEND);
		}
	}

	/**
	 * Encode json data output.
	 *
	 * @param array $responseData
	 *
	 * @return string
	 */
	public function encodeJson($responseData): string
	{
		return json_encode($responseData, JSON_FORCE_OBJECT | JSON_UNESCAPED_UNICODE);
	}

	public function encodeXml($responseData)
	{
		$xml = new \SimpleXMLElement('<?xml version="1.0"?><data></data>');
		$this->toXml($responseData, $xml);
		return $xml->asXML();
	}

	public function toXml($data, \SimpleXMLElement &$xmlData)

	{
		foreach ($data as $key => $value) {
			if (is_numeric($key)) {
				$key = 'item' . $key;
			}
			if (\is_array($value)) {
				$subnode = $xmlData->addChild($key);
				$this->toXml($value, $subnode);
			} else {
				$xmlData->addChild("$key", htmlspecialchars("$value"));
			}
		}
	}
}


1			<?php
2			/**
3			* Web service response file.
4			*
5			* @package API
6			*
7			* @copyright YetiForce S.A.
8			* @license YetiForce Public License 5.0 (licenses/LicenseEN.txt or yetiforce.com)
9			* @author Mariusz Krzaczkowski <[email protected]>
10			*/
11
12			namespace Api\Core;
13
14			/**
15			* Web service response class.
16			*/
17			class Response
18			{
19			/**
20			* Access control allow headers.
21			*
22			* @var string[]
23			*/
24			protected $acceptableHeaders = ['x-api-key', 'x-encrypted', 'x-token'];
25			/**
26			* Access control allow methods.
27			*
28			* @var string[]
29			*/
30			protected $acceptableMethods = [];
31			/**
32			* Request instance.
33			*
34			* @var \Api\Core\Request
35			*/
36			protected $request;
37			protected static $instance = false;
38			protected $body;
39			/**
40			* File instance.
41			*
42			* @var \App\Fields\File
43			*/
44			protected $file;
45			/**
46			* Headers.
47			*
48			* @var array
49			*/
50			protected $headers = [];
51			/**
52			* @var int Response status code.
53			*/
54			protected $status = 200;
55			/**
56			* @var string Response data type.
57			*/
58			protected $responseType;
59			/**
60			* @var string Reason phrase.
61			*/
62			protected $reasonPhrase;
63			/**
64			* @var string Reason content type
65			*/
66			protected $contentType;
67
68			/**
69			* Get instance.
70			*
71			* @return self
72			*/
73			public static function getInstance(): self
74			{
75			if (!static::$instance) {
76			static::$instance = new self();
77			}
78			return static::$instance;
79			}
80
81			/**
82			* Add header.
83			*
84			* @param string $key
85			* @param mixed $value
86			*
87			* @return void
88			*/
89			public function addHeader(string $key, $value): void
90			{
91			$this->headers[$key] = $value;
92			}
93
94			/**
95			* Set status code.
96			*
97			* @param int $status
98			*
99			* @return void
100			*/
101			public function setStatus(int $status): void
102			{
103			if (is_numeric($status)) {
104			$this->status = $status;
105			}
106			}
107
108			/**
109			* Set reason phrase.
110			*
111			* @param string $reasonPhrase
112			*
113			* @return void
114			*/
115			public function setReasonPhrase(string $reasonPhrase): void
116			{
117			$this->reasonPhrase = $reasonPhrase;
118			}
119
120			/**
121			* Set body data.
122			*
123			* @param array $body
124			*
125			* @return void
126			*/
127			public function setBody(array $body): void
128			{
129			$this->body = $body;
130			$this->responseType = 'data';
131			}
132
133			/**
134			* Set file instance.
135			*
136			* @param \App\Fields\File $file
137			*
138			* @return void
139			*/
140			public function setFile(\App\Fields\File $file): void
141			{
142			$this->file = $file;
143			$this->responseType = 'file';
144			}
145
146			/**
147			* Set request.
148			*
149			* @param \Api\Core\Request $request
150			*
151			* @return void
152			*/
153			public function setRequest(Request $request): void
154			{
155			$this->request = $request;
156			}
157
158			/**
159			* Set acceptable methods.
160			*
161			* @param string[] $methods
162			*
163			* @return void
164			*/
165			public function setAcceptableMethods(array $methods)
166			{
167			$this->acceptableMethods = array_merge($this->acceptableMethods, $methods);
168			}
169
170			/**
171			* Set acceptable headers.
172			*
173			* @param string[] $headers
174			*
175			* @return void
176			*/
177			public function setAcceptableHeaders(array $headers)
178			{
179			$this->acceptableHeaders = array_merge($this->acceptableHeaders, $headers);
180			}
181
182			/**
183			* Set acceptable headers.
184			*
185			* @param string $type
186			*
187			* @return void
188			*/
189			public function setContentType(string $type): void
190			{
191			$this->contentType = $type;
192			}
193
194			/**
195			* Get reason phrase.
196			*
197			* @return string
198			*/
199			private function getReasonPhrase(): string
200			{
201			if (isset($this->reasonPhrase)) {
202			return str_ireplace(["\r\n", "\r", "\n"], ' ', $this->reasonPhrase);
203			}
204			$statusCodes = [
205			200 => 'OK',
206			401 => 'Unauthorized',
207			403 => 'Forbidden',
208			404 => 'Not Found',
209			405 => 'Method Not Allowed',
210			500 => 'Internal Server Error',
211			];
212			return $statusCodes[$this->status] ?? $statusCodes[500];
213			}
214
215			public function send()
216			{
217			$encryptDataTransfer = \App\Config::api('ENCRYPT_DATA_TRANSFER') ? 1 : 0;
218			if (200 !== $this->status \|\| 'data' !== $this->responseType) {
219			$encryptDataTransfer = 0;
220			}
221			if (empty($this->contentType)) {
222			$requestContentType = strtolower(\App\Request::_getServer('HTTP_ACCEPT'));
223			if (empty($requestContentType) \|\| '/' === $requestContentType) {
224			$this->contentType = $this->request->contentType;
225			} else {
226			$this->contentType = $requestContentType;
227			}
228			}
229			$headersSent = headers_sent();
230			if (!$headersSent) {
231			header('Access-Control-Allow-Origin: *');
232			header('Access-Control-Allow-Methods: ' . implode(', ', $this->acceptableMethods));
233			header('Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization, ' . implode(', ', $this->acceptableHeaders));
234			header(\App\Request::_getServer('SERVER_PROTOCOL') . ' ' . $this->status . ' ' . $this->getReasonPhrase());
235			header('Encrypted: ' . $encryptDataTransfer);
236			foreach ($this->headers as $key => $header) {
237			header(\strtolower($key) . ': ' . $header);
238			}
239			}
240			if ($encryptDataTransfer) {
241			header('Content-disposition: attachment; filename="api.json"');
242			if (!empty($this->body)) {
243			echo $this->encryptData($this->body);
244			}
245			} else {
246			switch ($this->responseType) {
247			case 'data':
248			if (!empty($this->body)) {
249			if (!$headersSent) {
250			header("Content-type: {$this->contentType}");
251			}
252			if (false !== strpos($this->contentType, 'application/xml')) {
253			if (!$headersSent) {
254			header('Content-disposition: attachment; filename="api.xml"');
255			}
256			echo $this->encodeXml($this->body);
257			} else {
258			if (!$headersSent) {
259			header('Content-disposition: attachment; filename="api.json"');
260			}
261			echo $this->encodeJson($this->body);
262			}
263			}
264			break;
265			case 'file':
266			if (isset($this->file) && file_exists($this->file->getPath())) {
267			header('Content-type: ' . $this->file->getMimeType());
268			header('Content-transfer-encoding: binary');
269			header('Content-length: ' . $this->file->getSize());
270			header('Content-disposition: attachment; filename="' . $this->file->getName() . '"');
271			readfile($this->file->getPath());
272			}
273			break;
274			}
275			}
276			$this->debugResponse();
277			}
278
279			public function encryptData($data)
280			{
281			openssl_public_encrypt($data, $encrypted, 'file://' . ROOT_DIRECTORY . \DIRECTORY_SEPARATOR . \App\Config::api('PUBLIC_KEY'), OPENSSL_PKCS1_OAEP_PADDING);
282			return $encrypted;
283			}
284
285			/**
286			* Debug response function.
287			*
288			* @return void
289			*/
290			public function debugResponse()
291			{
292			if (\App\Config::debug('apiLogAllRequests')) {
293			$log = '============ Request ' . \App\RequestUtil::requestId() . ' (Response) ====== ' . date('Y-m-d H:i:s') . " ======\n";
294			$log .= 'REQUEST_METHOD: ' . \App\Request::getRequestMethod() . PHP_EOL;
295			$log .= 'REQUEST_URI: ' . $_SERVER['REQUEST_URI'] . PHP_EOL;
296			$log .= 'QUERY_STRING: ' . $_SERVER['QUERY_STRING'] . PHP_EOL;
297			$log .= 'PATH_INFO: ' . ($_SERVER['PATH_INFO'] ?? '') . PHP_EOL;
298			$log .= 'IP: ' . $_SERVER['REMOTE_ADDR'] . PHP_EOL;
299			if ($this->body) {
300			$log .= "----------- Response data -----------\n";
301			$log .= print_r($this->body, true) . PHP_EOL;
302			}
303			$path = ROOT_DIRECTORY . '/cache/logs/webserviceDebug.log';
304			if (isset(\Api\Controller::$container)) {
305			$path = ROOT_DIRECTORY . '/cache/logs/webservice' . \Api\Controller::$container . 'Debug.log';
306			}
307			file_put_contents($path, $log, FILE_APPEND);
308			}
309			}
310
311			/**
312			* Encode json data output.
313			*
314			* @param array $responseData
315			*
316			* @return string
317			*/
318			public function encodeJson($responseData): string
319			{
320			return json_encode($responseData, JSON_FORCE_OBJECT \| JSON_UNESCAPED_UNICODE);
321			}
322
323			public function encodeXml($responseData)
324			{
325			$xml = new \SimpleXMLElement('<?xml version="1.0"?><data></data>');
326			$this->toXml($responseData, $xml);
327			return $xml->asXML();
328			}
329
330			public function toXml($data, \SimpleXMLElement &$xmlData)
			0 ignored issues – show Bug introduced 2023-07-13 06:09 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_VARIABLE, expecting T_STRING or T_NAME_QUALIFIED or T_NAME_FULLY_QUALIFIED or T_NAME_RELATIVE on line 330 at column 49 Loading history...
331			{
332			foreach ($data as $key => $value) {
333			if (is_numeric($key)) {
334			$key = 'item' . $key;
335			}
336			if (\is_array($value)) {
337			$subnode = $xmlData->addChild($key);
338			$this->toXml($value, $subnode);
339			} else {
340			$xmlData->addChild("$key", htmlspecialchars("$value"));
341			}
342			}
343			}
344			}
345

YetiForceCompany / YetiForceCRM

Push — developer ( dedd13...2a4a55 )

Response::send() F

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like