/application/libraries/Gcm.php

<?php
/**
 *
 * @package GCM (Google Cloud Messaging)
 * @copyright (c) 2012 AntonGorodezkiy
 * info: https://github.com/antongorodezkiy/codeigniter-gcm/
 * Description: PHP Codeigniter Google Cloud Messaging Library
 * License: BSD
 *
 * Copyright (c) 2012, AntonGorodezkiy
 * All rights reserved.
 * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

class Gcm {

	protected $apiKey = '';
	protected $apiSendAddress = '';
	protected $payload = array();
	protected $additionalData = array();
	protected $recepients = array();
	protected $message = '';

	public $status = array();
	public $messagesStatuses = array();
	public $responseData = null;
	public $responseInfo = null;


	protected $errorStatuses = array(
		'Unavailable' => 'Maybe missed API key',
		'MismatchSenderId' => 'Make sure you\'re using one of those when trying to send messages to the device. If you switch to a different sender, the existing registration IDs won\'t work.',
		'MissingRegistration' => 'Check that the request contains a registration ID',
		'InvalidRegistration' => 'Check the formatting of the registration ID that you pass to the server. Make sure it matches the registration ID the phone receives in the google',
		'NotRegistered' => 'Not registered',
		'MessageTooBig' => 'The total size of the payload data that is included in a message can\'t exceed 4096 bytes',
		'InvalidPackageName' => 'Make sure the message was addressed to a registration token whose package name matches the value passed in the request.',
		'InvalidDataKey' => 'Check that the payload data does not contain a key (such as from, or gcm, or any value prefixed by google) that is used internally by GCM.',
		'InvalidTtl' => 'Check that the value used in time_to_live is an integer representing a duration in seconds between 0 and 2,419,200 (4 weeks).',
		'InternalServerError' => 'The server encountered an error while trying to process the request.',
		'TopicsMessageRateExceeded' => 'The rate of messages to subscribers to a particular topic is too high. Reduce the number of messages sent for this topic, and do not immediately retry sending.',
		'DeviceMessageRateExceeded' =>  'The rate of messages to a particular device is too high. Reduce the number of messages sent to this device and do not immediately retry sending to this device.'
	);

	/**
	 * Constructor
	 */
	public function __construct() {

		$ci =& get_instance();
		$ci->load->config('gcm',true);

		$this->apiKey = $ci->config->item('gcm_api_key','gcm');
		$this->apiSendAddress = $ci->config->item('gcm_api_send_address','gcm');

		if (!$this->apiKey) {
			show_error('GCM: Needed API Key');
		}

		if (!$this->apiSendAddress) {
			show_error('GCM: Needed API Send Address');
		}
	}


	/**
	* Sets additional data which will be send with main apn message
	*
	* @param <array> $data
	* @return <array>
	*/
	public function setTtl($ttl = '')
	{
		if (!$ttl)
			unset($this->payload['time_to_live']);
		else
			$this->payload['time_to_live'] = $ttl;
	}


	/**
	 * Setting GCM message
	 *
	 * @param <string> $message
	 */
	public function setMessage($message = '') {

		$this->message = $message;
		$this->payload['data']['message'] = $message;

	}


	/**
	 * Setting data to message
	 *
	 * @param <string> $data
	 */
	public function setData($data = array()) {

		$this->payload['data'] = $data;

		if ($this->message)
			$this->payload['data']['message'] = $this->message;

	}


	/**
	 * Setting group of messages
	 *
	 * @param <string> $group
	 */
	public function setGroup($group = '') {

		if (!$group)
			unset($this->payload['collapse_key']);
		else
			$this->payload['collapse_key'] = $group;
	}


	/**
	 * Adding one recepient
	 *
	 * @param <string> $group
	 */
	public function addRecepient($registrationId) {

		$this->payload['registration_ids'][] = $registrationId;
	}


	/**
	 * Setting all recepients
	 *
	 * @param <string> $group
	 */
	public function setRecepients($registrationIds) {

		$this->payload['registration_ids'] = $registrationIds;
	}


	/**
	 * Clearing group of messages
	 */
	public function clearRecepients() {

		$this->payload['registration_ids'] = array();
	}


	/**
	 * Senging messages to Google Cloud Messaging
	 *
	 * @param <string> $group
	 */
	public function send()
	{
		$this->payload['registration_ids'] = array_unique($this->payload['registration_ids']);
		sort($this->payload['registration_ids']);

		if (isset($this->payload['time_to_live']) && !isset($this->payload['collapse_key']))
			$this->payload['collapse_key'] = 'GCM Notifications';

		$data = json_encode($this->payload);
		return $this->request($data);
	}







	protected function request($data)
	{

		$headers[] = 'Content-Type:application/json';
		$headers[] = 'Authorization:key='.$this->apiKey;

		$curl = curl_init();

		curl_setopt($curl, CURLOPT_URL, $this->apiSendAddress);
		curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
		curl_setopt($curl, CURLOPT_FOLLOWLOCATION, false);
		curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
		curl_setopt($curl, CURLOPT_HEADER, true);
		curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

		curl_setopt($curl, CURLOPT_POST, true);
		curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

		$this->responseData = curl_exec($curl);

		$this->responseInfo = curl_getinfo($curl);

		curl_close($curl);



		return $this->parseResponse();
	}


	protected function parseResponse()
	{
		if ($this->responseInfo['http_code'] == 200)
		{
			$response = explode("\n",$this->responseData);
			$responseBody = json_decode($response[count($response)-1]);

			if ($responseBody->success && !$responseBody->failure)
			{
				$message = 'All messages were sent successfully';
				$error = 0;
			}
			elseif ($responseBody->success && $responseBody->failure)
			{
				$message = $responseBody->success.' of '.($responseBody->success+$responseBody->failure).' messages were sent successfully';
				$error = 1;
			}
			elseif (!$responseBody->success && $responseBody->failure)
			{
				$message = 'No messages cannot be sent. '.$responseBody->results[0]->error;
				$error = 1;
			}

			$this->status = array(
				'error' => $error,
				'message' => $message
			);

			$this->messagesStatuses = array();
			foreach($responseBody->results as $key => $result)
			{
				if (isset($result->error) && $result->error)
				{
					$this->messagesStatuses[$key] = array(
						'error' => 1,
						'regid' => $this->payload['registration_ids'][$key],
						'message' => $this->errorStatuses[$result->error],
						'message_id' => ''
					);
				}
				else
				{
					$this->messagesStatuses[$key] = array(
						'error' => 0,
						'regid' => $this->payload['registration_ids'][$key],
						'message' => 'Message was sent successfully',
						'message_id' => $result->message_id
					);
				}
			}

			return !$error;
		}
		elseif ($this->responseInfo['http_code'] == 400)
		{
			$this->status = array(
				'error' => 1,
				'message' => 'Request could not be parsed as JSON'
			);
			return false;
		}
		elseif ($this->responseInfo['http_code'] == 401)
		{
			$this->status = array(
				'error' => 1,
				'message' => 'There was an error authenticating the sender account'
			);
			return false;
		}
		elseif ($this->responseInfo['http_code'] == 500)
		{
			$this->status = array(
				'error' => 1,
				'message' => 'There was an internal error in the GCM server while trying to process the request'
			);
			return false;
		}
		elseif ($this->responseInfo['http_code'] == 503)
		{
			$this->status = array(
				'error' => 1,
				'message' => 'Server is temporarily unavailable'
			);
			return false;
		}
		else
		{
			$this->status = array(
				'error' => 1,
				'message' => 'Status undefined'
			);
			return false;
		}
	}

}