Handles more errors, expands Response class

README.md

@@ -31,6 +31,12 @@ $message
 try {
     $response = $sender->send($message);
 
+    if ($response->getMustRetry() {
+        $waitSeconds = $response->getWaitSeconds();
+        //Try again after that many seconds, and use exponential backoff subsequently, as needed.
+        //TODO
+    }
+
     if ($response->getNewRegistrationIdsCount() > 0) {
         $newRegistrationIds = $response->getNewRegistrationIds();
         foreach ($newRegistrationIds as $oldRegistrationId => $newRegistrationId){
@@ -40,7 +46,21 @@ try {
     }
 
     if ($response->getFailureCount() > 0) {
-        $invalidRegistrationIds = $GCMresponse->getInvalidRegistrationIds();
+
+        if ($response->getExistsInvalidDataKey()) {
+            //You used a reserved data key
+            $error_msg = 'Invalid data key in payload. ' . json_encode($message->getNotification());
+            throw new Exception($error_msg, Exception::INVALID_DATA_KEY);
+        }
+
+        if ($response->getExistsMismatchSenderId()) {
+            //A client sent the wrong senderId when it registered for pushes
+            $error_msg = 'Mismatch senderId. Problem clients are '
+                . json_encode($response->getMismatchSenderIdIds());
+            throw new Exception($error_msg, Exception::MISMATCH_SENDER_ID);
+        } 
+
+        $invalidRegistrationIds = $response->getInvalidRegistrationIds();
         foreach($invalidRegistrationIds as $invalidRegistrationId) {
             //Remove $invalidRegistrationId from DB
             //TODO
@@ -58,6 +78,9 @@ try {
         case GCM\Exception::MALFORMED_REQUEST:
         case GCM\Exception::UNKNOWN_ERROR:
         case GCM\Exception::MALFORMED_RESPONSE:
+        case GCM\Exception::INVALID_DATA_KEY: //you used a forbidden key in the notification
+        case GCM\Exception::CURL_ERROR: //problem posting to gcm server
+        case GCM\Exception::MISMATCH_SENDER_ID; //a client sent the wrong senderId when it registered for pushes
             //Deal with it
             break;
     }
@@ -80,6 +103,12 @@ try {
         "collapse_key"
     );
 
+    if ($response->getMustRetry() {
+        $waitSeconds = $response->getWaitSeconds();
+        //Try again after that many seconds, and use exponential backoff subsequently, as needed.
+        //TODO
+    }
+
     if ($response->getNewRegistrationIdsCount() > 0) {
         $newRegistrationIds = $response->getNewRegistrationIds();
         foreach ($newRegistrationIds as $oldRegistrationId => $newRegistrationId){
@@ -89,7 +118,21 @@ try {
     }
 
     if ($response->getFailureCount() > 0) {
-        $invalidRegistrationIds = $GCMresponse->getInvalidRegistrationIds();
+
+        if ($response->getExistsInvalidDataKey()) {
+            //You used a reserved data key
+            $error_msg = 'Invalid data key in payload. ' . json_encode($message->getNotification());
+            throw new Exception($error_msg, Exception::INVALID_DATA_KEY);
+        }
+
+        if ($response->getExistsMismatchSenderId()) {
+            //A client sent the wrong senderId when it registered for pushes
+            $error_msg = 'Mismatch senderId. Problem clients are '
+                . json_encode($response->getMismatchSenderIdIds());
+            throw new Exception($error_msg, Exception::MISMATCH_SENDER_ID);
+        } 
+
+        $invalidRegistrationIds = $response->getInvalidRegistrationIds();
         foreach($invalidRegistrationIds as $invalidRegistrationId) {
             //Remove $invalidRegistrationId from DB
             //TODO
@@ -107,6 +150,9 @@ try {
         case GCM\Exception::MALFORMED_REQUEST:
         case GCM\Exception::UNKNOWN_ERROR:
         case GCM\Exception::MALFORMED_RESPONSE:
+        case GCM\Exception::INVALID_DATA_KEY: //you used a forbidden key in the notification
+        case GCM\Exception::CURL_ERROR: //problem posting to gcm server
+        case GCM\Exception::MISMATCH_SENDER_ID; //a client sent the wrong senderId when it registered for pushes
             //Deal with it
             break;
     }

library/CodeMonkeysRu/GCM/Exception.php

@@ -9,5 +9,7 @@ class Exception extends \Exception
     const MALFORMED_REQUEST = 3;
     const UNKNOWN_ERROR = 4;
     const MALFORMED_RESPONSE = 5;
-
-}
+    const INVALID_DATA_KEY = 6;
+    const CURL_ERROR = 7;
+    const MISMATCH_SENDER_ID = 8;
+}

library/CodeMonkeysRu/GCM/Message.php

@@ -222,4 +222,4 @@ public function setContentAvailable($contentAvailable)
         $this->contentAvailable = $contentAvailable;
         return $this;
     }
-}
+}

library/CodeMonkeysRu/GCM/Response.php

@@ -1,9 +1,6 @@
 <?php
 namespace CodeMonkeysRu\GCM;
 
-/**
- * @author Vladimir Savenkov <[email protected]>
- */
 class Response
 {
 
@@ -34,6 +31,42 @@ class Response
      * @var integer
      */
     private $canonicalIds = null;
+
+    /**
+     * Response headers.
+     *
+     * @var string[]
+     */
+    private $responseHeaders = [];
+
+    /**
+     * Did Google demand that we try again.
+     *
+     * @var boolean
+     */
+    private $mustRetry = false;
+
+    /**
+     * Number of seconds to wait.
+     *
+     * @var integer
+     */
+    private $waitSeconds = null;
+
+    /**
+     * Did you use a reserved data key?
+     *
+     * @var boolean
+     */
+    private $existsInvalidDataKey = false;
+
+    /**
+     * Did one of your clients register with the wrong senderId?
+     * If one of them did, then presumably they all did.
+     * 
+     * @var boolean
+     */
+    private $existsMismatchSenderId = false;
 
     /**
      * Array of objects representing the status of the messages processed.
@@ -53,8 +86,20 @@ class Response
      */
     private $results = array();
 
-    public function __construct(Message $message, $responseBody)
+    public function __construct(Message $message, $responseBody, $responseHeaders)
     {
+        $this->responseHeaders = $responseHeaders;
+
+        $this->mustRetry = false;  
+
+	foreach($responseHeaders as $header) {
+            if (strpos($header, 'Retry-After') !== false) {
+                $this->mustRetry = true;
+              	$this->waitSeconds = (int) explode(" ", $header)[1];
+		break;
+	    }
+	}	
+
         $data = \json_decode($responseBody, true);
         if ($data === null) {
             throw new Exception("Malformed reponse body. ".$responseBody, Exception::MALFORMED_RESPONSE);
@@ -63,26 +108,72 @@ public function __construct(Message $message, $responseBody)
         $this->failure = $data['failure'];
         $this->success = $data['success'];
         $this->canonicalIds = $data['canonical_ids'];
+        $this->existsInvalidDataKey = false;
+        $this->existsMismatchSenderId = false;
         $this->results = array();
+
         foreach ($message->getRegistrationIds() as $key => $registrationId) {
-            $this->results[$registrationId] = $data['results'][$key];
+            $result = $data['results'][$key];
+            if (isset($result['error'])) {
+	        switch ($result['error']) {
+		    case "InvalidDataKey":
+		        $this->existsInvalidDataKey = true;
+			break;
+		    case "MismatchSenderId":
+		        $this->existsMismatchSenderId = true;
+			break;
+		    default:
+		        break;
+	        }
+	    }
+	    $this->results[$registrationId] = $result; 
         }
+        $result = null;
     }
-
+
+    public function getResponseHeaders() {
+        return $this->responseHeaders;
+    }
+
     public function getMulticastId()
     {
         return $this->multicastId;
     }
+
+    public function getMustRetry()
+    {
+        return $this->mustRetry;
+    }
+
+    public function getWaitSeconds()
+    {
+        return $this->waitSeconds;
+    }
 
     public function getSuccessCount()
     {
         return $this->success;
     }
-
+
+    /**
+     * Both implementation errors and server errors are included here.
+     *
+     * @return integer
+     */
     public function getFailureCount()
     {
         return $this->failure;
     }
+
+    public function getExistsInvalidDataKey()
+    {
+        return $this->existsInvalidDataKey;
+    }
+
+    public function getExistsMismatchSenderId()
+    {
+        return $this->existsMismatchSenderId;
+    }
 
     public function getNewRegistrationIdsCount()
     {
@@ -144,6 +235,7 @@ function($result) {
         return array_keys($filteredResults);
     }
 
+
     /**
      * Returns an array of registration ids for which you must resend a message (?),
      * cause devices aren't available now.
@@ -162,11 +254,38 @@ function($result) {
                 return (
                     isset($result['error'])
                     &&
+                    (
                     ($result['error'] == "Unavailable")
+                    ||
+                    ($result['error'] == "InternalServerError")
+                    ||
+                    ($result['error'] == "DeviceMessageRateExceeded")
+                    )
                     );
             });
 
         return array_keys($filteredResults);
     }
+
+    /**
+     * Returns an array of registration ids who registered
+     * for pushes using the wrong senderId.
+     *
+     * @return array
+     */
+    public function getMismatchSenderIdIds() {
+        if ($this->getFailureCount() == 0) {
+            return array();
+        }
+        $filteredResults = array_filter($this->results,
+            function($result) {
+                return (
+                    isset($result['error'])
+                    &&
+                    ($result['error'] == "MismatchSenderId")
+                    );
+            });
 
-}
+        return array_keys($filteredResults);
+    }
+}

library/CodeMonkeysRu/GCM/Sender.php

@@ -90,10 +90,10 @@ public function send(Message $message)
         $ch = curl_init();
 
         curl_setopt($ch, CURLOPT_URL, $this->gcmUrl);
-
         curl_setopt($ch, CURLOPT_POST, true);
         curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($ch, CURLOPT_HEADER, 1); // return HTTP headers with response
 
         if ($this->caInfoPath !== false) {
             curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
@@ -104,7 +104,18 @@ public function send(Message $message)
 
         curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
 
-        $resultBody = curl_exec($ch);
+        $resp = curl_exec($ch);
+
+        if ($resp === FALSE) {
+            throw new Exception('cURL error: '. curl_error($ch), Exception::CURL_ERROR);
+        }
+
+        list($responseHeaders, $resultBody) = explode("\r\n\r\n", $resp, 2);
+        // $headers now has a string of the HTTP headers
+        // $resultBody is the body of the HTTP response
+
+        $responseHeaders = explode("\n", $responseHeaders);
+
         $resultHttpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
 
         curl_close($ch);
@@ -128,7 +139,7 @@ public function send(Message $message)
                 break;
         }
 
-        return new Response($message, $resultBody);
+        return new Response($message, $resultBody, $responseHeaders);
     }
 
     /**
@@ -152,7 +163,7 @@ private function formMessageData(Message $message)
             'time_to_live' => 'getTtl',
             'restricted_package_name' => 'getRestrictedPackageName',
             'dry_run' => 'getDryRun',
-            'content_available' => 'getContentAvailable',
+            'content_available' => 'getContentAvailable'
         );
 
         foreach ($dataFields as $fieldName => $getter) {
@@ -183,5 +194,4 @@ private function validatePayloadSize(array $rawData, $fieldName, $maxSize)
             );
         }
     }
-
 }