Google_IO::processEntityRequest() - Code Metrics - Inspection of "BREAKING CHANGE: Google Analytics settings simplif..." - GeoDirectory/geodirectory - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — master ( 4cd501...1b9ce5 )

by Stiofan

created 2016-11-24 16:22 UTC

Google_IO::processEntityRequest() B

↳ Parent: Project

Complexity

Conditions	6
Paths	8

Size

Total Lines	24
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	13
nc	8
nop	1
dl	0
loc	24
rs	8.5125
c	0
b	0
f	0

<?php
/**
 * Copyright 2010 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

require_once GA_API_Path. 'io/Google_HttpRequest.php';
require_once GA_API_Path. 'io/Google_HttpStreamIO.php';
require_once GA_API_Path. 'io/Google_CurlIO.php';
require_once GA_API_Path. 'io/Google_REST.php';

/**
 * Abstract IO class
 *
 * @author Chris Chabot <[email protected]>
 */
abstract class Google_IO {
  const CONNECTION_ESTABLISHED = "HTTP/1.0 200 Connection established\r\n\r\n";
  const FORM_URLENCODED = 'application/x-www-form-urlencoded';
  /**
   * An utility function that first calls $this->auth->sign($request) and then executes makeRequest()
   * on that signed request. Used for when a request should be authenticated
   * @param Google_HttpRequest $request
   * @return Google_HttpRequest $request
   */
  abstract function authenticatedRequest(Google_HttpRequest $request);


  /**
   * Executes a apIHttpRequest and returns the resulting populated httpRequest
   * @param Google_HttpRequest $request
   * @return Google_HttpRequest $request
   */
  abstract function makeRequest(Google_HttpRequest $request);


  /**
   * Set options that update the transport implementation's behavior.
   * @param $options
   */
  abstract function setOptions($options);


  /**
   * @visible for testing.
   * Cache the response to an HTTP request if it is cacheable.
   * @param Google_HttpRequest $request
   * @return bool Returns true if the insertion was successful.
   * Otherwise, return false.
   */
  protected function setCachedRequest(Google_HttpRequest $request) {

    // Determine if the request is cacheable.
    if (Google_CacheParser::isResponseCacheable($request)) {
      Google_Client::$cache->set($request->getCacheKey(), $request);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
      return true;
    }

    return false;
  }

  /**
   * @visible for testing.
   * @param Google_HttpRequest $request
   * @return Google_HttpRequest|bool Returns the cached object or
   * false if the operation was unsuccessful.
   */
  protected function getCachedRequest(Google_HttpRequest $request) {

    if (false == Google_CacheParser::isRequestCacheable($request)) {

      false;
    }

    return Google_Client::$cache->get($request->getCacheKey());

  }

  /**
   * @visible for testing
   * Process an http request that contains an enclosed entity.
   * @param Google_HttpRequest $request
   * @return Google_HttpRequest Processed request with the enclosed entity.
   */
  protected function processEntityRequest(Google_HttpRequest $request) {
    $postBody = $request->getPostBody();
    $contentType = $request->getRequestHeader("content-type");

    // Set the default content-type as application/x-www-form-urlencoded.
    if (false == $contentType) {
      $contentType = self::FORM_URLENCODED;
      $request->setRequestHeaders(array('content-type' => $contentType));
    }

    // Force the payload to match the content-type asserted in the header.
    if ($contentType == self::FORM_URLENCODED && is_array($postBody)) {
      $postBody = http_build_query($postBody, '', '&');
      $request->setPostBody($postBody);
    }

    // Make sure the content-length header is set.
    if (!$postBody || is_string($postBody)) {
      $postsLength = strlen($postBody);
      $request->setRequestHeaders(array('content-length' => $postsLength));
    }

    return $request;
  }

  /**
   * Check if an already cached request must be revalidated, and if so update
   * the request with the correct ETag headers.
   * @param Google_HttpRequest $cached A previously cached response.
   * @param Google_HttpRequest $request The outbound request.
   * return bool If the cached object needs to be revalidated, false if it is
   * still current and can be re-used.
   */
  protected function checkMustRevaliadateCachedRequest($cached, $request) {
    if (Google_CacheParser::mustRevalidate($cached)) {
      $addHeaders = array();
      if ($cached->getResponseHeader('etag')) {
        // [13.3.4] If an entity tag has been provided by the origin server,
        // we must use that entity tag in any cache-conditional request.
        $addHeaders['If-None-Match'] = $cached->getResponseHeader('etag');
      } elseif ($cached->getResponseHeader('date')) {
        $addHeaders['If-Modified-Since'] = $cached->getResponseHeader('date');
      }

      $request->setRequestHeaders($addHeaders);
      return true;
    } else {
      return false;
    }
  }

  /**
   * Update a cached request, using the headers from the last response.
   * @param Google_HttpRequest $cached A previously cached response.
   * @param mixed Associative array of response headers from the last request.
   */
  protected function updateCachedRequest($cached, $responseHeaders) {
    if (isset($responseHeaders['connection'])) {
      $hopByHop = array_merge(
        self::$HOP_BY_HOP,
        explode(',', $responseHeaders['connection'])
      );

      $endToEnd = array();
      foreach($hopByHop as $key) {
        if (isset($responseHeaders[$key])) {
          $endToEnd[$key] = $responseHeaders[$key];
        }
      }
      $cached->setResponseHeaders($endToEnd);
    }
  }
}


1		<?php
2		/**
3		* Copyright 2010 Google Inc.
4		*
5		* Licensed under the Apache License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17
18		require_once GA_API_Path. 'io/Google_HttpRequest.php';
19		require_once GA_API_Path. 'io/Google_HttpStreamIO.php';
20		require_once GA_API_Path. 'io/Google_CurlIO.php';
21		require_once GA_API_Path. 'io/Google_REST.php';
22
23		/**
24		* Abstract IO class
25		*
26		* @author Chris Chabot <[email protected]>
27		*/
28		abstract class Google_IO {
29		const CONNECTION_ESTABLISHED = "HTTP/1.0 200 Connection established\r\n\r\n";
30		const FORM_URLENCODED = 'application/x-www-form-urlencoded';
31		/**
32		* An utility function that first calls $this->auth->sign($request) and then executes makeRequest()
33		* on that signed request. Used for when a request should be authenticated
34		* @param Google_HttpRequest $request
35		* @return Google_HttpRequest $request
36		*/
37		abstract function authenticatedRequest(Google_HttpRequest $request);
		0 ignored issues – show Best Practice introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
38
39		/**
40		* Executes a apIHttpRequest and returns the resulting populated httpRequest
41		* @param Google_HttpRequest $request
42		* @return Google_HttpRequest $request
43		*/
44		abstract function makeRequest(Google_HttpRequest $request);
		0 ignored issues – show Best Practice introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
45
46		/**
47		* Set options that update the transport implementation's behavior.
48		* @param $options
49		*/
50		abstract function setOptions($options);
		0 ignored issues – show Best Practice introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
51
52		/**
53		* @visible for testing.
54		* Cache the response to an HTTP request if it is cacheable.
55		* @param Google_HttpRequest $request
56		* @return bool Returns true if the insertion was successful.
57		* Otherwise, return false.
58		*/
59	View Code Duplication	protected function setCachedRequest(Google_HttpRequest $request) {
		0 ignored issues – show Duplication introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
60		// Determine if the request is cacheable.
61		if (Google_CacheParser::isResponseCacheable($request)) {
62		Google_Client::$cache->set($request->getCacheKey(), $request);
		0 ignored issues – show Bug introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report The property `cache` cannot be accessed from this context as it is declared `private` in class `Google_Client`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history... Documentation introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report `$request` is of type `object<Google_HttpRequest>`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
63		return true;
64		}
65
66		return false;
67		}
68
69		/**
70		* @visible for testing.
71		* @param Google_HttpRequest $request
72		* @return Google_HttpRequest\|bool Returns the cached object or
73		* false if the operation was unsuccessful.
74		*/
75	View Code Duplication	protected function getCachedRequest(Google_HttpRequest $request) {
		0 ignored issues – show Duplication introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
76		if (false == Google_CacheParser::isRequestCacheable($request)) {
		0 ignored issues – show Coding Style Best Practice introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing two booleans. Considering using the strict comparison `===` instead. When comparing two booleans, it is generally considered safer to use the strict comparison operator. Loading history...
77		false;
78		}
79
80		return Google_Client::$cache->get($request->getCacheKey());
		0 ignored issues – show Bug introduced 2016-11-24 16:29 UTC by Report Bug Copy Issue Report The property `cache` cannot be accessed from this context as it is declared `private` in class `Google_Client`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
81		}
82
83		/**
84		* @visible for testing
85		* Process an http request that contains an enclosed entity.
86		* @param Google_HttpRequest $request
87		* @return Google_HttpRequest Processed request with the enclosed entity.
88		*/
89		protected function processEntityRequest(Google_HttpRequest $request) {
90		$postBody = $request->getPostBody();
91		$contentType = $request->getRequestHeader("content-type");
92
93		// Set the default content-type as application/x-www-form-urlencoded.
94		if (false == $contentType) {
95		$contentType = self::FORM_URLENCODED;
96		$request->setRequestHeaders(array('content-type' => $contentType));
97		}
98
99		// Force the payload to match the content-type asserted in the header.
100		if ($contentType == self::FORM_URLENCODED && is_array($postBody)) {
101		$postBody = http_build_query($postBody, '', '&');
102		$request->setPostBody($postBody);
103		}
104
105		// Make sure the content-length header is set.
106		if (!$postBody \|\| is_string($postBody)) {
107		$postsLength = strlen($postBody);
108		$request->setRequestHeaders(array('content-length' => $postsLength));
109		}
110
111		return $request;
112		}
113
114		/**
115		* Check if an already cached request must be revalidated, and if so update
116		* the request with the correct ETag headers.
117		* @param Google_HttpRequest $cached A previously cached response.
118		* @param Google_HttpRequest $request The outbound request.
119		* return bool If the cached object needs to be revalidated, false if it is
120		* still current and can be re-used.
121		*/
122		protected function checkMustRevaliadateCachedRequest($cached, $request) {
123		if (Google_CacheParser::mustRevalidate($cached)) {
124		$addHeaders = array();
125		if ($cached->getResponseHeader('etag')) {
126		// [13.3.4] If an entity tag has been provided by the origin server,
127		// we must use that entity tag in any cache-conditional request.
128		$addHeaders['If-None-Match'] = $cached->getResponseHeader('etag');
129		} elseif ($cached->getResponseHeader('date')) {
130		$addHeaders['If-Modified-Since'] = $cached->getResponseHeader('date');
131		}
132
133		$request->setRequestHeaders($addHeaders);
134		return true;
135		} else {
136		return false;
137		}
138		}
139
140		/**
141		* Update a cached request, using the headers from the last response.
142		* @param Google_HttpRequest $cached A previously cached response.
143		* @param mixed Associative array of response headers from the last request.
144		*/
145		protected function updateCachedRequest($cached, $responseHeaders) {
146		if (isset($responseHeaders['connection'])) {
147		$hopByHop = array_merge(
148		self::$HOP_BY_HOP,
149		explode(',', $responseHeaders['connection'])
150		);
151
152		$endToEnd = array();
153		foreach($hopByHop as $key) {
154		if (isset($responseHeaders[$key])) {
155		$endToEnd[$key] = $responseHeaders[$key];
156		}
157		}
158		$cached->setResponseHeaders($endToEnd);
159		}
160		}
161		}
162

GeoDirectory / geodirectory

Push — master ( 4cd501...1b9ce5 )

Google_IO::processEntityRequest() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like