Initial implementation of SMS class and CoolSMS driver

common/framework/drivers/sms/base.php

@@ -0,0 +1,88 @@
+<?php
+
+namespace Rhymix\Framework\Drivers\SMS;
+
+/**
+ * The base class for other SMS drivers.
+ */
+abstract class Base implements \Rhymix\Framework\Drivers\SMSInterface
+{
+	/**
+	 * The configuration is stored here.
+	 */
+	protected $_config = null;
+	
+	/**
+	 * Direct invocation of the constructor is not permitted.
+	 */
+	protected function __construct(array $config)
+	{
+		$this->_config = $config;
+	}
+	
+	/**
+	 * Create a new instance of the current mail driver, using the given settings.
+	 * 
+	 * @param array $config
+	 * @return void
+	 */
+	public static function getInstance(array $config)
+	{
+		return new static($config);
+	}
+	
+	/**
+	 * Get the human-readable name of this mail driver.
+	 * 
+	 * @return string
+	 */
+	public static function getName()
+	{
+		return class_basename(get_called_class());
+	}
+	
+	/**
+	 * Get the list of configuration fields required by this mail driver.
+	 * 
+	 * @return array
+	 */
+	public static function getRequiredConfig()
+	{
+		return array();
+	}
+	
+	/**
+	 * Get the list of API types supported by this mail driver.
+	 * 
+	 * @return array
+	 */
+	public static function getAPITypes()
+	{
+		return array();
+	}
+	
+	/**
+	 * Check if the current mail driver is supported on this server.
+	 * 
+	 * This method returns true on success and false on failure.
+	 * 
+	 * @return bool
+	 */
+	public static function isSupported()
+	{
+		return true;
+	}
+	
+	/**
+	 * Send a message.
+	 * 
+	 * This method returns true on success and false on failure.
+	 * 
+	 * @param object $message
+	 * @return bool
+	 */
+	public function send(\Rhymix\Framework\SMS $message)
+	{
+		return false;
+	}
+}

common/framework/drivers/sms/coolsms.php

@@ -0,0 +1,121 @@
+<?php
+
+namespace Rhymix\Framework\Drivers\SMS;
+
+/**
+ * The CoolSMS SMS driver.
+ */
+class CoolSMS extends Base implements \Rhymix\Framework\Drivers\SMSInterface
+{
+	/**
+	 * Get the list of configuration fields required by this mail driver.
+	 * 
+	 * @return array
+	 */
+	public static function getRequiredConfig()
+	{
+		return array('api_key', 'api_secret');
+	}
+	
+	/**
+	 * Get the list of API types supported by this mail driver.
+	 * 
+	 * @return array
+	 */
+	public static function getAPITypes()
+	{
+		return array();
+	}
+	
+	/**
+	 * Send a message.
+	 * 
+	 * This method returns true on success and false on failure.
+	 * 
+	 * @param object $message
+	 * @return bool
+	 */
+	public function send(\Rhymix\Framework\SMS $message)
+	{
+		try
+		{
+			$recipients = $message->getRecipientsWithCountry();
+			foreach ($recipients as $recipient)
+			{
+				// Populate the options object.
+				$options = new \stdClass;
+				$options->from = $message->getFrom();
+				$options->to = $recipient->number;
+				$options->text = $message->getContent();
+				$options->charset = 'UTF-8';
+				
+				// Determine the message type based on the length.
+				$options->type = $this->_isShort($options->text) ? 'SMS' : 'LMS';
+				
+				// If the message has a subject, it must be an LMS.
+				if ($subject = $message->getSubject())
+				{
+					$options->subject = $subject;
+					$options->type = 'LMS';
+				}
+				
+				// If the message has an attachment, it must be an MMS.
+				if ($attachments = $message->getAttachments())
+				{
+					$image = reset($attachments);
+					$options->image = $image->local_filename;
+					$options->type = 'MMS';
+				}
+				
+				// If the recipient is not a Korean number, force SMS.
+				if ($recipient->country && $recipient->country != 82)
+				{
+					unset($options->subject);
+					unset($options->image);
+					$options->text = $this->_cutShort($options->text);
+					$options->type = 'SMS';
+				}
+				
+				// Send the message.
+				$sender = new \Nurigo\Api\Message($this->_config['api_key'], $this->_config['api_secret']);
+				$result = $sender->send($options);
+				return (isset($result->success_count) && $result->success_count > 0) ? true : false;
+			}
+		}
+		catch (\Nurigo\Exceptions\CoolsmsException $e)
+		{
+			$message->errors[] = class_basename($e) . ': ' . $e->getMessage();
+			return false;
+		}
+	}
+	
+	/**
+	 * Check if a message is short enough to fit in an SMS.
+	 * 
+	 * @param string $message
+	 * @param int $maxlength (optional)
+	 * @return bool
+	 */
+	protected function _isShort($message, $maxlength = 90)
+	{
+		$message = @iconv('UTF-8', 'CP949//IGNORE', $message);
+		return strlen($message) <= $maxlength;
+	}
+	
+	/**
+	 * Cut a message to fit in an SMS.
+	 * 
+	 * @param string $message
+	 * @param int $maxlength (optional)
+	 * @return string
+	 */
+	protected function _cutShort($message, $maxlength = 90)
+	{
+		$message = @iconv('UTF-8', 'CP949//IGNORE', $message);
+		while (strlen($message) > $maxlength)
+		{
+			$message = iconv_substr($message, 0, iconv_strlen($str, 'CP949') - 1, 'CP949');
+		}
+		return iconv('CP949', 'UTF-8', $message);
+	}
+}

common/framework/drivers/smsinterface.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Rhymix\Framework\Drivers;
+
+/**
+ * The SMS driver interface.
+ */
+interface SMSInterface
+{
+	/**
+	 * Create a new instance of the current SMS driver, using the given settings.
+	 * 
+	 * @param array $config
+	 * @return void
+	 */
+	public static function getInstance(array $config);
+	
+	/**
+	 * Get the human-readable name of this SMS driver.
+	 * 
+	 * @return string
+	 */
+	public static function getName();
+	
+	/**
+	 * Get the list of configuration fields required by this SMS driver.
+	 * 
+	 * @return array
+	 */
+	public static function getRequiredConfig();
+	
+	/**
+	 * Get the list of API types supported by this SMS driver.
+	 * 
+	 * @return array
+	 */
+	public static function getAPITypes();
+	
+	/**
+	 * Check if the current SMS driver is supported on this server.
+	 * 
+	 * This method returns true on success and false on failure.
+	 * 
+	 * @return bool
+	 */
+	public static function isSupported();
+	
+	/**
+	 * Send a message.
+	 * 
+	 * This method returns true on success and false on failure.
+	 * 
+	 * @param object $message
+	 * @return bool
+	 */
+	public function send(\Rhymix\Framework\SMS $message);
+}