<?php
/************************************************************************************
 * The contents of this file are subject to the vtiger CRM Public License Version 1.0
 * ("License"); You may not use this file except in compliance with the License
 * The Original Code is:  vtiger CRM Open Source
 * The Initial Developer of the Original Code is vtiger.
 * Portions created by vtiger are Copyright (C) vtiger.
 * All Rights Reserved.
 ************************************************************************************/

class SMSNotifier_Afilnet_Provider implements SMSNotifier_ISMSProvider_Model {

	private $userName;
	private $password;
	private $parameters = array();

	const SERVICE_URI = 'https://www.afilnet.com/api/http/';
	private static $REQUIRED_PARAMETERS = array('from');

	/**
	 * Function to get provider name
	 * @return <String> provider name
	 */
	public function getName() {
		return 'Afilnet';
	}

	/**
	 * Function to get required parameters other than (userName, password)
	 * @return <array> required parameters list
	 */
	public function getRequiredParams() {
		return self::$REQUIRED_PARAMETERS;
	}

	/**
	 * Function to get service URL to use for a given type
	 * @param <String> $type like SEND, PING, QUERY
	 */
	public function getServiceURL($type = false) {
		return self::SERVICE_URI;
	}

	/**
	 * Function to set authentication parameters
	 * @param <String> $userName
	 * @param <String> $password
	 */
	public function setAuthParameters($username, $password) {
		$this->userName = $username;
		$this->password = $password;
	}

	/**
	 * Function to set non-auth parameter.
	 * @param <String> $key
	 * @param <String> $value
	 */
	public function setParameter($key, $value) {
		$this->parameters[$key] = $value;
	}

	/**
	 * Function to get parameter value
	 * @param <String> $key
	 * @param <String> $defaultValue
	 * @return <String> value/$default value
	 */
	public function getParameter($key, $defvalue = false) {
		if (isset($this->parameters[$key])) {
			return $this->parameters[$key];
		}
		return $defvalue;
	}

	/**
	 * Function to prepare parameters
	 * @return <Array> parameters
	 */
	protected function prepareParameters() {
		$params = array('user' => $this->userName, 'password' => $this->password);
		foreach (self::$REQUIRED_PARAMETERS as $key) {
			$params[$key] = $this->getParameter($key);
		}
		return $params;
	}

	/**
	 * Function to handle SMS Send operation
	 * @param <String> $message
	 * @param <Mixed> $toNumbers One or Array of numbers
	 */
	public function send($message, $tonumbers) {
		if (!is_array($tonumbers)) {
			$tonumbers = array($tonumbers);
		}

		$results = array();
		foreach ($tonumbers as $i => $tonumber) 
		{
			$params = $this->prepareParameters();	
			$params['class'] = "sms";
			$params['method'] = "sendsms";
			$params['sms'] = $message;
			$params['to'] = preg_replace('/\D/', '', $tonumber);
			
			# We connect with the vTiger client
			$serviceURL = $this->getServiceURL();
			$httpClient = new Vtiger_Net_Client($serviceURL);		
			$response = $httpClient->doGet($params);
			
			$aresponse = json_decode($response);
			
			if($aresponse->status == "error")
			{
				$result['error'] = true;
				$result['to'] = $params['to'];
				$result['status'] = "FAIL";
			} else {
				$result['error'] = true;
				$result['id'] = $aresponse->result->messageid;
				$result['to'] = $params['to'];
				$result['status'] = self::MSG_STATUS_PROCESSING;
			}
			$results[] = $result;
		}

		return $results;
	}

	/**
	 * Function to get query for status using messgae id
	 * @param <Number> $messageId
	 */
	public function query($messageId) 
	{
		$params = $this->prepareParameters();	
		$params['class'] = "sms";
		$params['method'] = "getdeliverystatus";
		$params['messages'] = $messageId;
		
		# We connect with the vTiger client
		$serviceURL = $this->getServiceURL();
		$httpClient = new Vtiger_Net_Client($serviceURL);
		$response = $httpClient->doGet($params);
		
		$aresponse = json_decode($response);

		$result = array('error' => false, 'needlookup' => 1);
		
		if ($aresponse->result[0]->deliverystatus == 'DELIVERED') {
			$result['status'] = self::MSG_STATUS_DISPATCHED;
			$result['needlookup'] = 0;
			$result['statusmessage'] = 'Message delivered succesfully';
			
		} else if ($aresponse->result[0]->deliverystatus == 'SENT') {
			$result['status'] = self::MSG_STATUS_PROCESSING;
			$result['statusmessage'] = 'Message was sent';
			
		} else if ($aresponse->result[0]->deliverystatus == 'EXPIRED' || $aresponse->result[0]->deliverystatus == 'REJECTED' || $aresponse->result[0]->deliverystatus == 'NOT_SENT' || $aresponse->result[0]->deliverystatus == 'NOT_DELIVERED') {
			$result['status'] = self::MSG_STATUS_FAILED;
			$result['needlookup'] = 0;
			$result['statusmessage'] = 'Message delivery failed.';
			
		} else {
			$result['status'] = self::MSG_STATUS_PROCESSING;
			$result['statusmessage'] = 'Messages status pending.';
		}

		return $result;
	}

}
?>