CurlLogger::logResponse() - Code Metrics - Inspection of "Sample Facebook Code Bug fix" - facebook/facebook-php-ads-sdk - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#410)

unknown

created 2018-01-31 14:47 UTC

CurlLogger::logResponse() A

↳ Parent: CurlLogger

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	3
crap	1

<?php
/**
 * Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
 *
 * You are hereby granted a non-exclusive, worldwide, royalty-free license to
 * use, copy, modify, and distribute this software in source code or binary
 * form for use in connection with the web services and APIs provided by
 * Facebook.
 *
 * As with any software that integrates with the Facebook platform, your use
 * of this software is subject to the Facebook Developer Principles and
 * Policies [http://developers.facebook.com/policy/]. This copyright notice
 * shall be included in all copies or substantial portions of the software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 *
 */

namespace FacebookAds\Logger;

use FacebookAds\Http\FileParameter;
use FacebookAds\Http\Parameters;
use FacebookAds\Http\RequestInterface;
use FacebookAds\Http\ResponseInterface;
use FacebookAds\Logger\CurlLogger\JsonAwareParameters;

class CurlLogger implements LoggerInterface {

  /**
   * @var string
   */
  const PARAM_DEFAULT_FLAG = 'd';

  /**
   * @var string
   */
  const PARAM_URLENCODE_FLAG = '-data-urlencode';

  /**
   * @var string
   */
  const PARAM_POST_FLAG = 'F';

  /**
   * @var string
   */
  const METHOD_DEFAULT_FLAG = '';

  /**
   * @var string
   */
  const METHOD_GET_FLAG = 'G';

  /**
   * @var string
   */
  const METHOD_PUT_FLAG = 'X PUT';

  /**
   * @var string
   */
  const METHOD_DELETE_FLAG = 'X DELETE';

  /**
   * @var resource
   */
  protected $handle;

  /**
   * @var bool
   */
  protected $jsonPrettyPrint = false;

  /**
   * @param resource $handle
   */
  public function __construct($handle = null) {
    
    if (!defined('STDOUT')) {
        define('STDOUT', fopen('php://stdout', 'w'));
    }
 
    $this->handle = is_resource($handle) ? $handle : STDOUT;
  }

  /**
   * @return bool
   */
  public function isJsonPrettyPrint() {
    return $this->jsonPrettyPrint;
  }

  /**
   * @param bool $json_pretty_print
   * @return $this
   */
  public function setJsonPrettyPrint($json_pretty_print) {
    $this->jsonPrettyPrint = $json_pretty_print;
    return $this;
  }

  /**
   * @param string $method
   * @return string
   */
  public static function getMethodFlag($method) {
    switch ($method) {
      case RequestInterface::METHOD_GET:
        return static::METHOD_GET_FLAG;
      case RequestInterface::METHOD_PUT:
        return static::METHOD_PUT_FLAG;
      case RequestInterface::METHOD_DELETE:
        return static::METHOD_DELETE_FLAG;
    }

    return static::METHOD_DEFAULT_FLAG;
  }

  /**
   * @param string $method
   * @param string $value
   * @return string
   */
  public static function getParamFlag($method, $value) {
    return $method === RequestInterface::METHOD_POST
      ? static::PARAM_POST_FLAG
      : (strstr($value, "\n")
        ? static::PARAM_URLENCODE_FLAG
        : static::PARAM_DEFAULT_FLAG);
  }

  /**
   * @param string $string
   * @param int $indent
   * @return string
   */
  protected function indent($string, $indent) {
    return str_replace("\n", " \n".str_repeat(' ', $indent), $string);
  }

  /**
   * @param Parameters $params
   * @param string $method
   * @param bool $is_file
   * @return string
   */
  protected function processParams(Parameters $params, $method, $is_file) {
    $chunks = array();
    if ($this->isJsonPrettyPrint()) {
      $params = new JsonAwareParameters($params);
    }
    foreach ($params->export() as $name => $value) {
      if ($is_file && $params->offsetGet($name) instanceof FileParameter) {
        $value = "@" . $this->normalizeFileParam($params->offsetGet($name));
      } else {
        $value = addcslashes(
          strpos($value, "\n") !== false
            ? $this->indent($value, 2)
            : $value,
          '\'');
      }
      $chunks[$name] = sprintf(
        '-%s \'%s=%s\'',
        $this->getParamFlag($method, $value),
        $name,
        $value);
    }

    return $chunks;
  }

  /**
   * @param FileParameter $file_param
   * @return string
   */
  protected function normalizeFileParam(FileParameter $file_param) {
    return sprintf('%s%s%s%s%s',
      $file_param->getPath(),
      $file_param->getMimeType() != null ? ";type=" : "",

      $file_param->getMimeType(),
      $file_param->getName() != null ? ";name=" : "",

      $file_param->getName());
  }

  /**
   * @param RequestInterface $request
   * @return string
   */
  protected function processUrl(RequestInterface $request) {
    return $request->getProtocol().$request->getDomain()
      .'/v'.$request->getGraphVersion().$request->getPath();
  }

  /**
   * @param string $buffer
   */
  protected function flush($buffer) {
    fwrite($this->handle, $buffer.PHP_EOL.PHP_EOL);
  }

  /**
   * @param mixed $level
   * @param string $message
   * @param array $context
   */
  public function log($level, $message, array $context = array()) {
    // We only care about requests
  }

  /**
   * @param array $array
   * @param mixed $key
   * @return mixed
   */
  protected function removeArrayKey(array &$array, $key) {
    if (array_key_exists($key, $array)) {
      $value = $array[$key];
      unset($array[$key]);
      return $value;
    } else {
      return null;
    }
  }

  /**
   * @param array $params
   * @return array
   */
  protected function sortParams(array $params) {
    $access_token = $this->removeArrayKey($params, 'access_token');
    $appsecret_proof = $this->removeArrayKey($params, 'appsecret_proof');
    $access_token !== null && $params['access_token'] = $access_token;
    $appsecret_proof !== null && $params['appsecret_proof'] = $appsecret_proof;

    return $params;
  }

  /**
   * @param string $level
   * @param RequestInterface $request
   * @param array $context
   */
  public function logRequest(
    $level, RequestInterface $request, array $context = array()) {

    $new_line = ' \\'.PHP_EOL.'  ';
    $method = $request->getMethod();
    $method_flag = static::getMethodFlag($method);
    $params = $this->sortParams(array_merge(
      $this->processParams($request->getQueryParams(), $method, false),
      $this->processParams($request->getBodyParams(), $method, false),
      $this->processParams($request->getFileParams(), $method, true)));

    $buffer = 'curl'.($method_flag ? ' -'.$method_flag : '');
    foreach ($params as $param) {
      $buffer .= $new_line.$param;
    }
    $buffer .= $new_line.$this->processUrl($request);

    $this->flush($buffer);
  }

  /**
   * @param string $level
   * @param ResponseInterface $response
   * @param array $context
   */
  public function logResponse(
    $level, ResponseInterface $response, array $context = array()) {
    // We only care about requests
  }
}


1		<?php
2		/**
3		* Copyright (c) 2014-present, Facebook, Inc. All rights reserved.
4		*
5		* You are hereby granted a non-exclusive, worldwide, royalty-free license to
6		* use, copy, modify, and distribute this software in source code or binary
7		* form for use in connection with the web services and APIs provided by
8		* Facebook.
9		*
10		* As with any software that integrates with the Facebook platform, your use
11		* of this software is subject to the Facebook Developer Principles and
12		* Policies [http://developers.facebook.com/policy/]. This copyright notice
13		* shall be included in all copies or substantial portions of the software.
14		*
15		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18		* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20		* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21		* DEALINGS IN THE SOFTWARE.
22		*
23		*/
24
25		namespace FacebookAds\Logger;
26
27		use FacebookAds\Http\FileParameter;
28		use FacebookAds\Http\Parameters;
29		use FacebookAds\Http\RequestInterface;
30		use FacebookAds\Http\ResponseInterface;
31		use FacebookAds\Logger\CurlLogger\JsonAwareParameters;
32
33		class CurlLogger implements LoggerInterface {
34
35		/**
36		* @var string
37		*/
38		const PARAM_DEFAULT_FLAG = 'd';
39
40		/**
41		* @var string
42		*/
43		const PARAM_URLENCODE_FLAG = '-data-urlencode';
44
45		/**
46		* @var string
47		*/
48		const PARAM_POST_FLAG = 'F';
49
50		/**
51		* @var string
52		*/
53		const METHOD_DEFAULT_FLAG = '';
54
55		/**
56		* @var string
57		*/
58		const METHOD_GET_FLAG = 'G';
59
60		/**
61		* @var string
62		*/
63		const METHOD_PUT_FLAG = 'X PUT';
64
65		/**
66		* @var string
67		*/
68		const METHOD_DELETE_FLAG = 'X DELETE';
69
70		/**
71		* @var resource
72		*/
73		protected $handle;
74
75		/**
76		* @var bool
77		*/
78		protected $jsonPrettyPrint = false;
79
80		/**
81		* @param resource $handle
82		*/
83	7	public function __construct($handle = null) {
84
85	7	if (!defined('STDOUT')) {
86		define('STDOUT', fopen('php://stdout', 'w'));
87		}
88
89	7	$this->handle = is_resource($handle) ? $handle : STDOUT;
90	7	}
91
92		/**
93		* @return bool
94		*/
95	5	public function isJsonPrettyPrint() {
96	5	return $this->jsonPrettyPrint;
97		}
98
99		/**
100		* @param bool $json_pretty_print
101		* @return $this
102		*/
103	1	public function setJsonPrettyPrint($json_pretty_print) {
104	1	$this->jsonPrettyPrint = $json_pretty_print;
105	1	return $this;
106		}
107
108		/**
109		* @param string $method
110		* @return string
111		*/
112	5	public static function getMethodFlag($method) {
113		switch ($method) {
114	5	case RequestInterface::METHOD_GET:
115	1	return static::METHOD_GET_FLAG;
116	4	case RequestInterface::METHOD_PUT:
117	1	return static::METHOD_PUT_FLAG;
118	3	case RequestInterface::METHOD_DELETE:
119	1	return static::METHOD_DELETE_FLAG;
120		}
121
122	2	return static::METHOD_DEFAULT_FLAG;
123		}
124
125		/**
126		* @param string $method
127		* @param string $value
128		* @return string
129		*/
130	5	public static function getParamFlag($method, $value) {
131		return $method === RequestInterface::METHOD_POST
132	5	? static::PARAM_POST_FLAG
133	5	: (strstr($value, "\n")
134	4	? static::PARAM_URLENCODE_FLAG
135	5	: static::PARAM_DEFAULT_FLAG);
136		}
137
138		/**
139		* @param string $string
140		* @param int $indent
141		* @return string
142		*/
143	1	protected function indent($string, $indent) {
144	1	return str_replace("\n", " \n".str_repeat(' ', $indent), $string);
145		}
146
147		/**
148		* @param Parameters $params
149		* @param string $method
150		* @param bool $is_file
151		* @return string
152		*/
153	5	protected function processParams(Parameters $params, $method, $is_file) {
154	5	$chunks = array();
155	5	if ($this->isJsonPrettyPrint()) {
156	1	$params = new JsonAwareParameters($params);
157	1	}
158	5	foreach ($params->export() as $name => $value) {
159	5	if ($is_file && $params->offsetGet($name) instanceof FileParameter) {
160		$value = "@" . $this->normalizeFileParam($params->offsetGet($name));
161		} else {
162	5	$value = addcslashes(
163	5	strpos($value, "\n") !== false
164	5	? $this->indent($value, 2)
165	5	: $value,
166	5	'\'');
167		}
168	5	$chunks[$name] = sprintf(
169	5	'-%s \'%s=%s\'',
170	5	$this->getParamFlag($method, $value),
171	5	$name,
172	5	$value);
173	5	}
174
175	5	return $chunks;
176		}
177
178		/**
179		* @param FileParameter $file_param
180		* @return string
181		*/
182		protected function normalizeFileParam(FileParameter $file_param) {
183		return sprintf('%s%s%s%s%s',
184		$file_param->getPath(),
185		$file_param->getMimeType() != null ? ";type=" : "",
		0 ignored issues – show Bug introduced 2017-11-08 10:38 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$file_param->getMimeType()` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
186		$file_param->getMimeType(),
187		$file_param->getName() != null ? ";name=" : "",
		0 ignored issues – show Bug introduced 2017-11-08 10:38 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `$file_param->getName()` of type `string\|null` against `null`; this is ambiguous if the string can be empty. Consider using a strict comparison `!==` instead. Loading history...
188		$file_param->getName());
189		}
190
191		/**
192		* @param RequestInterface $request
193		* @return string
194		*/
195	5	protected function processUrl(RequestInterface $request) {
196	5	return $request->getProtocol().$request->getDomain()
197	5	.'/v'.$request->getGraphVersion().$request->getPath();
198		}
199
200		/**
201		* @param string $buffer
202		*/
203	5	protected function flush($buffer) {
204	5	fwrite($this->handle, $buffer.PHP_EOL.PHP_EOL);
205	5	}
206
207		/**
208		* @param mixed $level
209		* @param string $message
210		* @param array $context
211		*/
212	1	public function log($level, $message, array $context = array()) {
213		// We only care about requests
214	1	}
215
216		/**
217		* @param array $array
218		* @param mixed $key
219		* @return mixed
220		*/
221	5	protected function removeArrayKey(array &$array, $key) {
222	5	if (array_key_exists($key, $array)) {
223	4	$value = $array[$key];
224	4	unset($array[$key]);
225	4	return $value;
226		} else {
227	1	return null;
228		}
229		}
230
231		/**
232		* @param array $params
233		* @return array
234		*/
235	5	protected function sortParams(array $params) {
236	5	$access_token = $this->removeArrayKey($params, 'access_token');
237	5	$appsecret_proof = $this->removeArrayKey($params, 'appsecret_proof');
238	5	$access_token !== null && $params['access_token'] = $access_token;
239	5	$appsecret_proof !== null && $params['appsecret_proof'] = $appsecret_proof;
240
241	5	return $params;
242		}
243
244		/**
245		* @param string $level
246		* @param RequestInterface $request
247		* @param array $context
248		*/
249	5	public function logRequest(
250		$level, RequestInterface $request, array $context = array()) {
251
252	5	$new_line = ' \\'.PHP_EOL.' ';
253	5	$method = $request->getMethod();
254	5	$method_flag = static::getMethodFlag($method);
255	5	$params = $this->sortParams(array_merge(
256	5	$this->processParams($request->getQueryParams(), $method, false),
257	5	$this->processParams($request->getBodyParams(), $method, false),
258	5	$this->processParams($request->getFileParams(), $method, true)));
259
260	5	$buffer = 'curl'.($method_flag ? ' -'.$method_flag : '');
261	5	foreach ($params as $param) {
262	5	$buffer .= $new_line.$param;
263	5	}
264	5	$buffer .= $new_line.$this->processUrl($request);
265
266	5	$this->flush($buffer);
267	5	}
268
269		/**
270		* @param string $level
271		* @param ResponseInterface $response
272		* @param array $context
273		*/
274	1	public function logResponse(
275		$level, ResponseInterface $response, array $context = array()) {
276		// We only care about requests
277	1	}
278		}
279

facebook / facebook-php-ads-sdk

Pull Request — master (#410)

CurlLogger::logResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like