coolsms.php

<?php

/**
 *
 *   Copyright (C) 2008-2015 NURIGO
 *   http://www.coolsms.co.kr
 *
 **/

class coolsms
{
	private $api_key;
	private	$api_secret;
	private $host = "http://api.coolsms.co.kr/";
	private $resource;
	private $version = "1.5";
	private $sdk_version = "1.1";
	private $path;
	private $method;
	private $timestamp;
	private $salt;
	private $result;
	private $basecamp;
	private $user_agent;
	private $error;


	public function __construct($api_key, $api_secret, $basecamp=false)
	{
		if($basecamp)
		{
			$this->coolsms_user = $api_key;
			$this->basecamp = true;
		}
		else
		{
			$this->api_key = $api_key;
		}

		$this->api_secret = $api_secret;
		$this->user_agent = $_SERVER['HTTP_USER_AGENT'];
	}

	/**
	 * process curl
	 */
	public function curlProcess()
	{
		$ch = curl_init(); 
		// Set host. 1 = POST , 0 = GET
		if($this->method==1) 
		{
			$host = sprintf("%s%s/%s/%s", $this->host, $this->resource, $this->version, $this->path);
		}
		else if($this->method==0)
		{
			$host = sprintf("%s%s/%s/%s?%s", $this->host, $this->resource, $this->version, $this->path, $this->content);
		}

		curl_setopt($ch, CURLOPT_URL, $host);
		curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE); 
		curl_setopt($ch, CURLOPT_SSLVERSION,3); // SSL 버젼 (https 접속시에 필요)
		curl_setopt($ch, CURLOPT_HEADER, 0); // 헤더 출력 여부
		curl_setopt($ch, CURLOPT_POST, $this->method); // Post Get 접속 여부

		// Set POST DATA
		if($this->method)
		{
			curl_setopt($ch, CURLOPT_HTTPHEADER, array("Content-Type:multipart/form-data"));
			curl_setopt($ch, CURLOPT_POSTFIELDS, $this->content); 
		}
		curl_setopt($ch, CURLOPT_TIMEOUT, 10); // TimeOut 값
		curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); // 결과값을 받을것인지
		
		$this->result = json_decode(curl_exec($ch));
		// Check coolsms error code
		if($this->result->code) $this->error = 'Code : ' . $this->result->code . ' Message : ' . $this->result->message;

		// Check connect errors
		if(curl_errno($ch)) $this->error = curl_error($ch);

		curl_close ($ch);
	}

	/**
	 * set http body content
	 */
	private function setContent($options)
	{
		if($this->method)
		{
			$this->content = array();
			foreach($options as $key => $val)
			{
				if($key != "image")
					$this->content[$key] = sprintf("\0%s", $val);
				else
					$this->content[$key] = "@".realpath("./$val");
			}
		}
		else
		{
			foreach($options as $key => $val)
				$this->content .= $key."=".urlencode($val)."&";
		}
	}

	/**
	 * make a signature with hash_hamac then return the signature
	 */
	private function getSignature()
	{
		return hash_hmac('md5', (string)$this->timestamp.$this->salt, $this->api_secret);
	}

	/**
	 * set authenticate information
	 */
	private function addInfos($options)
	{
		$this->salt = uniqid();
		$this->timestamp = (string)time();
		if(!$options->User_Agent) $options->User_Agent = sprintf("PHP REST API %s", $this>version);
		if(!$options->os_platform) $options->os_platform = $this->getOS();
		if(!$options->dev_lang) $options->dev_lang = sprintf("PHP %s", phpversion());
		if(!$options->sdk_version) $options->sdk_version = sprintf("PHP SDK %s", $this->sdk_version);

		$options->salt = $this->salt;
		$options->timestamp = $this->timestamp;
		if($this->basecamp)
		{
			$options->coolsms_user = $this->coolsms_user;
		}
		else
		{
			$options->api_key = $this->api_key;
		}
		$options->signature = $this->getSignature();
		$this->setContent($options);
		$this->curlProcess();
	}

	/**
	 * $resource
	 * 'sms', 'senderid'
	 * $method 
	 * GET = 0, POST, 1
	 * $path
	 * 'send' 'sent' 'cancel' 'balance' 
	 */
	private function setMethod($resource, $path, $method, $version="1.5")
	{
		$this->resource = $resource;
		$this->path = $path;
		$this->method = $method;
		$this->version = $version;
	}

	/**
	 * return result
	 */
	public function getResult()
	{
		return $this->result;
	}

	/**
	 *  @POST send method
	 *	@param $options (options must contain api_key, salt, signature, to, from, text)
	 *	@type, image, refname, country, datetime, mid, gid, subject, charset (optional)
	 *	@returns an object(recipient_number, group_id, message_id, result_code, result_message)
	 */
	public function send($options) 
	{
		$this->setMethod('sms', 'send', 1);
		$this->addInfos($options);	
		return $this;
	}
	
	/**
	 * 	@GET sent method
	 * 	@param $options (options can be optional)
	 * 	@count,  page, s_rcpt, s_start, s_end, mid, gid (optional)
	 * 	@returns an object(total count, list_count, page, data['type', 'accepted_time', 'recipient_number', 'group_id', 'message_id', 'status', 'result_code', 'result_message', 'sent_time', 'text'])
	 */
	public function sent($options=null) 
	{
		if(!$options)
			$options = new stdClass();
		$this->setMethod('sms', 'sent', 0);
		$this->addInfos($options);	
		return $this;
	}

	/**
	 * 	@POST cancel method
	 * 	@options must contain api_key, salt, signature
	 * 	@mid, gid (either one must be entered.)
	 */
	public function cancel($options) 
	{
		$this->setMethod('sms', 'cancel', 1);
		$this->addInfos($options);	
		return $this;
	}

	/**
	 * 	@GET balance method
	 * 	@options must contain api_key, salt, signature
	 * 	@return an object(cash, point)
	 */
	public function balance() 
	{
		$this->setMethod('sms', 'balance', 0);
		$this->addInfos($options = new stdClass());	
		return $this;
	}

	/**
	 * 	@GET status method
	 * 	@options must contain api_key, salt, signature
	 * 	@return an object(registdate, sms_average, sms_sk_average, sms_kt_average, sms_lg_average, mms_average, mms_sk_average, mms_kt_average, mms_lg_average)
	 * 	this method is made for Coolsms inc. internal use
	 */
	public function status($options) 
	{
		$this->setMethod('sms', 'status', 0);
		$this->addInfos($options);	
		return $this;
	}

	/**
	 * @POST register method
	 * @options must contains api_key, salt, signature, phone, site_user(optional)
	 * @return json object(handle_key, ars_number)
	 */
	public function register($options)
	{
		$this->setMethod('senderid', 'register', 1, "1.1");
		$this->addInfos($options);
		return $this;
	}

	/**
	 * @POST verify method
	 * @options must contains api_key, salt, signature, handle_key
	 * return nothing
	 */
	public function verify($options)
	{
		$this->setMethod('senderid', 'verify', 1, "1.1");
		$this->addInfos($options);
		return $this;
	}

	/**
	 * POST delete method
	 * $options must contains api_key, salt, signature, handle_key
	 * return nothing
	 */
	public function delete($options)
	{
		$this->setMethod('senderid', 'delete', 1, "1.1");
		$this->addInfos($options);
		return $this;
	}

	/**
	 * GET list method
	 * $options must conatins api_key, salt, signature, site_user(optional)
	 * return json object(idno, phone_number, flag_default, updatetime, regdate)
	 */
	public function get_senderid_list($options)
	{
		$this->setMethod('senderid', 'list', 0, "1.1");
		$this->addInfos($options);
		return $this;
	}

	/**
	 * POST set_default
	 * $options must contains api_key, salt, signature, handle_key, site_user(optional)
	 * return nothing
	 */
	public function set_default($options)
	{
		$this->setMethod('senderid', 'set_default', 1, "1.1");
		$this->addInfos($options);
		return $this;
	}

	/**
	 * GET get_default
	 * $options must conatins api_key, salt, signature, site_user(optional)
	 * return json object(handle_key, phone_number)
	 */
	public function get_default($options)
	{
		$this->setMethod('senderid', 'get_default', 0, "1.1");
		$this->addInfos($options);
		return $this;
	}
	
	/**
	 * return user's current OS
	 */
	function getOS() { 
		$user_agent = $this->user_agent;
		$os_platform    =   "Unknown OS Platform";
		$os_array       =   array(
								'/windows nt 10/i'     =>  'Windows 10',
								'/windows nt 6.3/i'     =>  'Windows 8.1',
								'/windows nt 6.2/i'     =>  'Windows 8',
								'/windows nt 6.1/i'     =>  'Windows 7',
								'/windows nt 6.0/i'     =>  'Windows Vista',
								'/windows nt 5.2/i'     =>  'Windows Server 2003/XP x64',
								'/windows nt 5.1/i'     =>  'Windows XP',
								'/windows xp/i'         =>  'Windows XP',
								'/windows nt 5.0/i'     =>  'Windows 2000',
								'/windows me/i'         =>  'Windows ME',
								'/win98/i'              =>  'Windows 98',
								'/win95/i'              =>  'Windows 95',
								'/win16/i'              =>  'Windows 3.11',
								'/macintosh|mac os x/i' =>  'Mac OS X',
								'/mac_powerpc/i'        =>  'Mac OS 9',
								'/linux/i'              =>  'Linux',
								'/ubuntu/i'             =>  'Ubuntu',
								'/iphone/i'             =>  'iPhone',
								'/ipod/i'               =>  'iPod',
								'/ipad/i'               =>  'iPad',
								'/android/i'            =>  'Android',
								'/blackberry/i'         =>  'BlackBerry',
								'/webos/i'              =>  'Mobile'
							);

		foreach ($os_array as $regex => $value) { 
			if (preg_match($regex, $user_agent)) {
				$os_platform    =   $value;
			}
		}   
		return $os_platform;
	}

	/**
	 * return user's current browser
	 */
	function getBrowser() {
		$user_agent = $this->user_agent;
		$browser        =   "Unknown Browser";
		$browser_array  =   array(
								'/msie/i'       =>  'Internet Explorer',
								'/firefox/i'    =>  'Firefox',
								'/safari/i'     =>  'Safari',
								'/chrome/i'     =>  'Chrome',
								'/opera/i'      =>  'Opera',
								'/netscape/i'   =>  'Netscape',
								'/maxthon/i'    =>  'Maxthon',
								'/konqueror/i'  =>  'Konqueror',
								'/mobile/i'     =>  'Handheld Browser'
							);
		foreach ($browser_array as $regex => $value) { 
			if (preg_match($regex, $user_agent)) {
				$browser    =   $value;
			}
		}
		return $browser;
	}
}