Disable gzip on file upload

This seems to be the best bet to get back sensible upload times
- gzip isn't any user here anyway, and compress.zlib seems to
play badly with others.

Author: Ian Barber

src/Google/Client.php

@@ -37,7 +37,6 @@ class Google_Client
 {
   const LIBVER = "1.0.2-beta";
   const USER_AGENT_SUFFIX = "google-api-php-client/";
-  const GZIP_UA = " (gzip)";
   /**
    * @var Google_Auth_Abstract $auth
    */
@@ -476,17 +475,14 @@ public function setDefer($defer)
   public function execute($request)
   {
     if ($request instanceof Google_Http_Request) {
-      $userAgentGzipSuffix = "";
-      if (!$this->getClassConfig("Google_Http_Request", "disable_gzip")) {
-        $request->setRequestHeaders(array("Accept-Encoding" => "gzip"));
-        $userAgentGzipSuffix = self::GZIP_UA;
-      }
       $request->setUserAgent(
           $this->getApplicationName()
           . " " . self::USER_AGENT_SUFFIX
           . $this->getLibraryVersion()
-          . $userAgentGzipSuffix
       );
+      if (!$this->getClassConfig("Google_Http_Request", "disable_gzip")) {
+        $request->enableGzip();
+      }
       $request->maybeMoveParametersToBody();
       return Google_Http_REST::execute($this, $request);
     } else if ($request instanceof Google_Http_Batch) {

src/Google/Http/MediaFileUpload.php

@@ -141,6 +141,7 @@ public function nextChunk($chunk = false)
         $headers,
         $chunk
     );
+    $httpRequest->disableGzip(); // Disable gzip for uploads.
     $response = $this->client->getIo()->makeRequest($httpRequest);
     $response->setExpectedClass($this->request->getExpectedClass());
     $code = $response->getResponseHttpCode();

src/Google/Http/Request.php

@@ -27,6 +27,8 @@
  */
 class Google_Http_Request
 {
+  const GZIP_UA = " (gzip)";
+
   private $batchHeaders = array(
     'Content-Type' => 'application/http',
     'Content-Transfer-Encoding' => 'binary',
@@ -40,6 +42,7 @@ class Google_Http_Request
   protected $path;
   protected $postBody;
   protected $userAgent;
+  protected $canGzip = null;
 
   protected $responseHttpCode;
   protected $responseHeaders;
@@ -79,6 +82,40 @@ public function setBaseComponent($baseComponent)
   {
     $this->baseComponent = $baseComponent;
   }
+  
+  /**
+   * Enable support for gzipped responses with this request.
+   */
+  public function enableGzip()
+  {
+    $this->setRequestHeaders(array("Accept-Encoding" => "gzip"));
+    $this->canGzip = true;
+    $this->setUserAgent($this->userAgent);
+  }
+  
+  /**
+   * Disable support for gzip responses with this request.
+   */
+  public function disableGzip()
+  {
+    if (
+        isset($this->requestHeaders['accept-encoding']) &&
+        $this->requestHeaders['accept-encoding'] == "gzip"
+    ) {
+      unset($this->requestHeaders['accept-encoding']);
+    }
+    $this->canGzip = false;
+    $this->userAgent = str_replace(self::GZIP_UA, "", $this->userAgent);
+  }
+  
+  /**
+   * Can this request accept a gzip response?
+   * @return bool
+   */
+  public function canGzip()
+  {
+    return $this->canGzip;
+  }
 
   /**
    * Misc function that returns an array of the query parameters of the current
@@ -297,6 +334,9 @@ public function setPostBody($postBody)
   public function setUserAgent($userAgent)
   {
     $this->userAgent = $userAgent;
+    if ($this->canGzip) {
+      $this->userAgent = $userAgent . self::GZIP_UA;
+    }
   }
 
   /**

src/Google/IO/Stream.php

@@ -104,7 +104,7 @@ public function makeRequest(Google_Http_Request $request)
 
     $url = $request->getUrl();
 
-    if (!$this->client->getClassConfig("Google_Http_Request", "disable_gzip")) {
+    if ($request->canGzip()) {
       $url = self::ZLIB . $url;
     }
 

tests/general/RequestTest.php

@@ -57,4 +57,18 @@ public function testRequestParameters()
     $request->setBaseComponent($base . '/upload');
     $this->assertEquals($url4, $request->getUrl());
   }
+  
+  public function testGzipSupport() 
+  {
+    $url = 'http://localhost:8080/foo/bar?foo=a&foo=b&wowee=oh+my';
+    $request = new Google_Http_Request($url);  
+    $request->enableGzip();
+    $this->assertStringEndsWith(Google_Http_Request::GZIP_UA, $request->getUserAgent());
+    $this->assertArrayHasKey('accept-encoding', $request->getRequestHeaders());
+    $this->assertTrue($request->canGzip());
+    $request->disableGzip();
+    $this->assertStringEndsNotWith(Google_Http_Request::GZIP_UA, $request->getUserAgent());
+    $this->assertArrayNotHasKey('accept-encoding', $request->getRequestHeaders());
+    $this->assertFalse($request->canGzip());
+  }
 }