Merge pull request #107 from ianbarber/master

Requests clean up

Author: silvolu

src/Google/Cache/Null.php

@@ -0,0 +1,56 @@
+<?php
+/*
+ * Copyright 2014 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 "Google/Cache/Abstract.php";
+require_once "Google/Cache/Exception.php";
+
+/**
+ * A blank storage class, for cases where caching is not
+ * required.
+ */
+class Google_Cache_Null extends Google_Cache_Abstract
+{
+  public function __construct(Google_Client $client)
+  {
+
+  }
+
+   /**
+   * @inheritDoc
+   */
+  public function get($key, $expiration = false)
+  {
+    return false;
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public function set($key, $value)
+  {
+    // Nop.
+  }
+
+  /**
+   * @inheritDoc
+   * @param String $key
+   */
+  public function delete($key)
+  {
+    // Nop.
+  }
+}

src/Google/Config.php

@@ -20,6 +20,10 @@
  */
 class Google_Config
 {
+  const GZIP_DISABLED = true;
+  const GZIP_ENABLED = false;
+  const GZIP_UPLOADS_ENABLED = true;
+  const GZIP_UPLOADS_DISABLED = false;
   const USE_AUTO_IO_SELECTION = "auto";
   private $configuration;
 
@@ -47,12 +51,21 @@ public function __construct($ini_file_location = null)
 
       // Definition of class specific values, like file paths and so on.
       'classes' => array(
-        // If you want to pass in OAuth 2.0 settings, they will need to be
-        // structured like this.
+        'Google_IO_Abstract' => array(
+          'request_timeout_seconds' => 100,
+        ),
         'Google_Http_Request' => array(
-          // Disable the use of gzip on calls if set to true.
-          'disable_gzip' => false
+          // Disable the use of gzip on calls if set to true. Defaults to false.
+          'disable_gzip' => self::GZIP_ENABLED,
+
+          // We default gzip to disabled on uploads even if gzip is otherwise
+          // enabled, due to some issues seen with small packet sizes for uploads.
+          // Please test with this option before enabling gzip for uploads in
+          // a production environment.
+          'enable_gzip_for_uploads' => self::GZIP_UPLOADS_DISABLED,
         ),
+        // If you want to pass in OAuth 2.0 settings, they will need to be
+        // structured like this.
         'Google_Auth_OAuth2' => array(
           // Keys for OAuth 2.0 access, see the API console at
           // https://developers.google.com/console
@@ -109,7 +122,7 @@ public function setClassConfig($class, $config, $value = null)
       $this->configuration['classes'][$class] = $config;
     }
   }
-  
+
   public function getClassConfig($class, $key = null)
   {
     if (!isset($this->configuration['classes'][$class])) {
@@ -139,7 +152,7 @@ public function getAuthClass()
   {
     return $this->configuration['auth_class'];
   }
-  
+
   /**
    * Set the auth class.
    *
@@ -155,7 +168,7 @@ public function setAuthClass($class)
     }
     $this->configuration['auth_class'] = $class;
   }
-  
+
   /**
    * Set the IO class.
    *
@@ -268,7 +281,7 @@ public function setApprovalPrompt($approval)
   {
     $this->setAuthConfig('approval_prompt', $approval);
   }
-  
+
   /**
    * Set the developer key for the auth class. Note that this is separate value
    * from the client ID - if it looks like a URL, its a client ID!
@@ -286,7 +299,7 @@ public function getBasePath()
   {
     return $this->configuration['base_path'];
   }
-  
+
   /**
    * Set the auth configuration for the current auth class.
    * @param $key - the key to set

src/Google/Http/MediaFileUpload.php

@@ -51,13 +51,13 @@ class Google_Http_MediaFileUpload
 
   /** @var int $progress */
   private $progress;
-  
+
   /** @var Google_Client */
   private $client;
-  
+
   /** @var Google_Http_Request */
   private $request;
-  
+
   /** @var string */
   private $boundary;
 
@@ -89,7 +89,7 @@ public function __construct(
     $this->chunkSize = $chunkSize;
     $this->progress = 0;
     $this->boundary = $boundary;
-    
+
     // Process Media Request
     $this->process();
   }
@@ -102,16 +102,16 @@ public function setFileSize($size)
   {
     $this->size = $size;
   }
-  
-  /** 
+
+  /**
    * Return the progress on the upload
    * @return int progress in bytes uploaded.
    */
   public function getProgress()
   {
     return $this->progress;
   }
-  
+
   /**
    * Send the next part of the file to upload.
    * @param [$chunk] the next set of bytes to send. If false will used $data passed
@@ -141,7 +141,13 @@ public function nextChunk($chunk = false)
         $headers,
         $chunk
     );
-    $httpRequest->disableGzip(); // Disable gzip for uploads.
+
+    if ($client->getClassConfig("Google_Http_Request", "enable_gzip_for_uploads")) {
+      $httpRequest->enableGzip();
+    } else {
+      $httpRequest->disableGzip();
+    }
+
     $response = $this->client->getIo()->makeRequest($httpRequest);
     $response->setExpectedClass($this->request->getExpectedClass());
     $code = $response->getResponseHttpCode();
@@ -150,13 +156,13 @@ public function nextChunk($chunk = false)
       // Track the amount uploaded.
       $range = explode('-', $response->getResponseHeader('range'));
       $this->progress = $range[1] + 1;
-      
+
       // Allow for changing upload URLs.
       $location = $response->getResponseHeader('location');
       if ($location) {
         $this->resumeUri = $location;
       }
-      
+
       // No problems, but upload not complete.
       return false;
     } else {
@@ -177,7 +183,7 @@ private function process()
 
     $meta = $this->request->getPostBody();
     $meta = is_string($meta) ? json_decode($meta, true) : $meta;
-    
+
     $uploadType = $this->getUploadType($meta);
     $this->request->setQueryParam('uploadType', $uploadType);
     $this->transformToUploadUrl();
@@ -214,7 +220,7 @@ private function process()
       $this->request->setRequestHeaders($contentTypeHeader);
     }
   }
-  
+
   private function transformToUploadUrl()
   {
     $base = $this->request->getBaseComponent();

src/Google/IO/Abstract.php

@@ -37,6 +37,10 @@ abstract class Google_IO_Abstract
   public function __construct(Google_Client $client)
   {
     $this->client = $client;
+    $timeout = $client->getClassConfig('Google_IO_Abstract', 'request_timeout_seconds');
+    if ($timeout > 0) {
+      $this->setTimeout($timeout);
+    }
   }
 
   /**
@@ -51,6 +55,18 @@ abstract public function executeRequest(Google_Http_Request $request);
    * @param $options
    */
   abstract public function setOptions($options);
+  
+  /**
+   * Set the maximum request time in seconds.
+   * @param $timeout in seconds
+   */
+  abstract public function setTimeout($timeout);
+  
+  /**
+   * Get the maximum request time in seconds.
+   * @return timeout in seconds
+   */
+  abstract public function getTimeout();
 
   /**
    * @visible for testing.

src/Google/IO/Curl.php

@@ -37,11 +37,11 @@ class Google_IO_Curl extends Google_IO_Abstract
   public function executeRequest(Google_Http_Request $request)
   {
     $curl = curl_init();
-    
+
     if ($request->getPostBody()) {
       curl_setopt($curl, CURLOPT_POSTFIELDS, $request->getPostBody());
     }
-    
+
     $requestHeaders = $request->getRequestHeaders();
     if ($requestHeaders && is_array($requestHeaders)) {
       $curlHeaders = array();
@@ -60,11 +60,11 @@ public function executeRequest(Google_Http_Request $request)
     curl_setopt($curl, CURLOPT_HEADER, true);
 
     curl_setopt($curl, CURLOPT_URL, $request->getUrl());
-    
+
     if ($request->canGzip()) {
       curl_setopt($curl, CURLOPT_ENCODING, 'gzip,deflate');
     }
-    
+
     foreach ($this->options as $key => $var) {
       curl_setopt($curl, $key, $var);
     }
@@ -74,6 +74,9 @@ public function executeRequest(Google_Http_Request $request)
     }
 
     $response = curl_exec($curl);
+    if ($response === false) {
+      throw new Google_IO_Exception(curl_error($curl));
+    }
     $headerSize = curl_getinfo($curl, CURLINFO_HEADER_SIZE);
 
     $responseBody = substr($response, $headerSize);
@@ -90,6 +93,29 @@ public function executeRequest(Google_Http_Request $request)
    */
   public function setOptions($options)
   {
-    $this->options = $options;
+    $this->options = array_merge($this->options, $options);
+  }
+
+  /**
+   * Set the maximum request time in seconds.
+   * @param $timeout in seconds
+   */
+  public function setTimeout($timeout)
+  {
+    // Since this timeout is really for putting a bound on the time
+    // we'll set them both to the same. If you need to specify a longer
+    // CURLOPT_TIMEOUT, or a tigher CONNECTTIMEOUT, the best thing to
+    // do is use the setOptions method for the values individually.
+    $this->options[CURLOPT_CONNECTTIMEOUT] = $timeout;
+    $this->options[CURLOPT_TIMEOUT] = $timeout;
+  }
+
+  /**
+   * Get the maximum request time in seconds.
+   * @return timeout in seconds
+   */
+  public function getTimeout()
+  {
+    return $this->options[CURLOPT_TIMEOUT];
   }
 }

src/Google/IO/Stream.php

@@ -25,7 +25,9 @@
 
 class Google_IO_Stream extends Google_IO_Abstract
 {
+  const TIMEOUT = "timeout";
   const ZLIB = "compress.zlib://";
+  private $options = array();
 
   private static $DEFAULT_HTTP_CONTEXT = array(
     "follow_location" => 0,
@@ -102,6 +104,10 @@ public function executeRequest(Google_Http_Request $request)
     $response_data = false;
     $respHttpCode = self::UNKNOWN_CODE;
     if ($fh) {
+      if (isset($this->options[self::TIMEOUT])) {
+        stream_set_timeout($fh, $this->options[self::TIMEOUT]);
+      }
+
       $response_data = stream_get_contents($fh);
       fclose($fh);
 
@@ -119,7 +125,7 @@ public function executeRequest(Google_Http_Request $request)
     }
 
     $responseHeaders = $this->getHttpResponseHeaders($http_response_header);
-    
+
     return array($response_data, $responseHeaders, $respHttpCode);
   }
 
@@ -129,9 +135,27 @@ public function executeRequest(Google_Http_Request $request)
    */
   public function setOptions($options)
   {
-    // NO-OP
+    $this->options = array_merge($this->options, $options);
+  }
+
+  /**
+   * Set the maximum request time in seconds.
+   * @param $timeout in seconds
+   */
+  public function setTimeout($timeout)
+  {
+    $this->options[self::TIMEOUT] = $timeout;
   }
-  
+
+  /**
+   * Get the maximum request time in seconds.
+   * @return timeout in seconds
+   */
+  public function getTimeout()
+  {
+    return $this->options[self::TIMEOUT];
+  }
+
   protected function getHttpResponseCode($response_headers)
   {
     $header_count = count($response_headers);