/**
* Send SMS
*
* @global array $core_config, $user_config
* @param string $username
* @param mixed $sms_to
* @param string $message
* @param string $sms_type
* @param integer $unicode
* @param string $smsc
* @param boolean $nofooter
* @param string $sms_footer
* @param string $sms_sender
* @param string $sms_schedule
* @return array array($status, $sms_to, $smslog_id, $queue, $counts, $error_strings)
*/
function sendsms($username, $sms_to, $message, $sms_type = 'text', $unicode = 0, $smsc = '', $nofooter = false, $sms_footer = '', $sms_sender = '', $sms_schedule = '')
{
global $core_config, $user_config;
// htmlspecialchars_decode to message and footer
$message = htmlspecialchars_decode($message);
$sms_footer = htmlspecialchars_decode($sms_footer);
// get user data
$user = $user_config;
if ($username && $user['username'] != $username) {
$user = user_getdatabyusername($username);
}
if (!is_array($sms_to)) {
$sms_to = explode(',', $sms_to);
}
$uid = $user['uid'];
// discard if banned
if (user_banned_get($uid)) {
_log("user banned, exit immediately uid:" . $uid . ' username:'******'username'], 2, "sendsms");
return array(FALSE, '', '', '', '', sprintf(_('Account %s is currently banned to use services'), $username));
}
// SMS sender ID
$sms_sender = core_sanitize_sender($sms_sender);
$sms_sender = $sms_sender && sender_id_isvalid($username, $sms_sender) ? $sms_sender : sendsms_get_sender($username);
// SMS footer
$sms_footer = core_sanitize_footer($sms_footer);
$sms_footer = $sms_footer ? $sms_footer : $user['footer'];
if ($nofooter) {
$sms_footer = '';
}
// a hack to remove \r from \r\n
// the issue begins with ENTER being \r\n and detected as 2 chars
// and since the javascript message counter can't detect it as 2 chars
// thus the message length counts is inaccurate
$message = str_replace("\r\n", "\n", $message);
// just to make sure its length, we need to stripslashes message before enter other procedures
$sms_sender = stripslashes($sms_sender);
$message = stripslashes($message);
$sms_footer = stripslashes($sms_footer);
// fixme anton - fix #71 but not sure whats the correct solution for this
// $max_length = ( $unicode ? $user['opt']['max_sms_length_unicode'] : $user['opt']['max_sms_length'] );
$max_length = $user['opt']['max_sms_length'];
if (strlen($message) > $max_length) {
$message = substr($message, 0, $max_length);
}
$sms_msg = $message;
_log("start uid:" . $uid . " sender_id:[" . $sms_sender . "] smsc:[" . $smsc . "]", 2, "sendsms");
// add a space infront of footer if exists
$c_sms_footer = trim($sms_footer) ? ' ' . trim($sms_footer) : '';
_log("maxlen:" . $max_length . " footerlen:" . strlen($c_sms_footer) . " footer:[" . $c_sms_footer . "] msglen:" . strlen($sms_msg) . " message:[" . $sms_msg . "]", 3, "sendsms");
// create a queue
$queue_code = sendsms_queue_create($sms_sender, $sms_footer, $sms_msg, $uid, 0, $sms_type, $unicode, $sms_schedule, $smsc);
if (!$queue_code) {
// when unable to create a queue then immediately returns FALSE, no point to continue
_log("fail to finalize queue creation, exit immediately", 2, "sendsms");
return array(FALSE, '', '', '', '', _('Send message failed due to unable to create queue'));
}
if (is_array($sms_to)) {
$array_sms_to = $sms_to;
} else {
$array_sms_to = explode(',', $sms_to);
}
// get manipulated and valid destination numbers
$all_sms_to = array();
for ($i = 0; $i < count($array_sms_to); $i++) {
if ($c_sms_to = sendsms_getvalidnumber(trim($array_sms_to[$i]))) {
$c_sms_to = sendsms_manipulate_prefix(trim($c_sms_to), $user);
$all_sms_to[] = $c_sms_to;
}
}
// remove double entries
$all_sms_to = array_unique($all_sms_to, SORT_STRING);
// calculate total sms and charges
$total_count = 0;
$total_charges = 0;
foreach ($all_sms_to as $c_sms_to) {
list($count, $rate, $charge) = rate_getcharges($uid, strlen($message . $c_sms_footer), $unicode, $c_sms_to);
$total_count += $count;
$total_charges += $charge;
}
_log('dst:' . count($all_sms_to) . ' sms_count:' . $total_count . ' total_charges:' . $total_charges, 2, 'sendsms');
// sender's
$credit = rate_getusercredit($user['username']);
$balance = $credit - $total_charges;
// parent's when sender is a subuser
$parent_uid = user_getparentbyuid($user['uid']);
if ($parent_uid) {
$username_parent = user_uid2username($parent_uid);
$credit_parent = rate_getusercredit($username_parent);
$balance_parent = $credit_parent - $total_charges;
}
if ($parent_uid) {
if (!($balance_parent >= 0)) {
_log('failed parent do not have enough credit. credit:' . $credit_parent . ' dst:' . count($all_sms_to) . ' sms_count:' . $total_count . ' total_charges:' . $total_charges, 2, 'sendsms');
return array(FALSE, '', '', '', '', _('Internal error please contact service provider'));
}
} else {
if (!($balance >= 0)) {
_log('failed user do not have enough credit. credit:' . $credit_parent . ' dst:' . count($all_sms_to) . ' sms_count:' . $total_count . ' total_charges:' . $total_charges, 2, 'sendsms');
return array(FALSE, '', '', '', '', _('Send message failed due to insufficient funds'));
}
}
// default returns
for ($i = 0; $i < count($all_sms_to); $i++) {
$ok[$i] = FALSE;
$to[$i] = $all_sms_to[$i];
$smslog_id[$i] = 0;
$queue[$i] = $queue_code;
$counts[$i] = $count;
}
$queue_count = 0;
$sms_count = 0;
$failed_queue_count = 0;
$failed_sms_count = 0;
for ($i = 0; $i < count($all_sms_to); $i++) {
$c_sms_to = $all_sms_to[$i];
$continue = TRUE;
if (blacklist_mobile_isexists(0, $c_sms_to)) {
$continue = FALSE;
_log("fail to send. mobile is in the blacklist mobile:" . $c_sms_to, 2, "sendsms");
}
if ($continue && ($smslog_id[$i] = sendsms_queue_push($queue_code, $c_sms_to))) {
$ok[$i] = TRUE;
$queue_count++;
$sms_count += $count;
$error_strings[$i] = sprintf(_('Message %s has been delivered to queue'), $smslog_id[$i]);
} else {
$ok[$i] = FALSE;
$failed_queue_count++;
$failed_sms_count++;
$error_strings[$i] = sprintf(_('Send message to %s in queue %s has failed'), $c_sms_to, $queue_code);
}
$to[$i] = $c_sms_to;
$queue[$i] = $queue_code;
$counts[$i] = $count;
}
if (sendsms_queue_update($queue_code, array('flag' => '0', 'queue_count' => $queue_count, 'sms_count' => $sms_count))) {
_log("end queue_code:" . $queue_code . " queue_count:" . $queue_count . " sms_count:" . $sms_count . " failed_queue:" . $failed_queue_count . " failed_sms:" . $failed_sms_count, 2, "sendsms");
} else {
_log("fail to prepare queue, exit immediately queue_code:" . $queue_code, 2, "sendsms");
return array(FALSE, '', '', $queue_code, '', sprintf(_('Send message failed due to unable to prepare queue %s'), $queue_code));
}
if (!$core_config['issendsmsd']) {
unset($ok);
unset($to);
unset($queue);
unset($counts);
_log("sendsmsd off immediately process queue_code:" . $queue_code, 2, "sendsms");
list($ok, $to, $smslog_id, $queue, $counts) = sendsmsd($queue_code);
}
return array($ok, $to, $smslog_id, $queue, $counts, $error_strings);
}
/**
* Send SMS to phonebook group
*
* @global array $core_config
* @param string $username
* @param integer $gpid
* @param string $message
* @param string $sms_type
* @param integer $unicode
* @param string $smsc
* @param boolean $nofooter
* @param string $sms_footer
* @param string $sms_sender
* @param string $sms_schedule
* @return array array($status, $sms_to, $smslog_id, $queue)
*/
function sendsms_bc($username, $gpid, $message, $sms_type = 'text', $unicode = 0, $smsc = '', $nofooter = false, $sms_footer = '', $sms_sender = '', $sms_schedule = '')
{
global $core_config, $user_config;
$user = $user_config;
if ($username && $user['username'] != $username) {
$user = user_getdatabyusername($username);
}
$uid = $user['uid'];
// discard if banned
if (user_banned_get($uid)) {
logger_print("user banned, exit immediately uid:" . $uid, 2, "sendsms_bc");
return array(FALSE, '', '', '', '');
}
// SMS sender ID
$sms_sender = core_sanitize_sender($sms_sender);
$sms_sender = $sms_sender && sender_id_isvalid($username, $sms_sender) ? $sms_sender : sendsms_get_sender($username);
// SMS footer
$sms_footer = core_sanitize_footer($sms_footer);
$sms_footer = $sms_footer ? $sms_footer : $user['footer'];
if ($nofooter) {
$sms_footer = '';
}
// a hack to remove \r from \r\n
// the issue begins with ENTER being \r\n and detected as 2 chars
// and since the javascript message counter can't detect it as 2 chars
// thus the message length counts is inaccurate
$message = str_replace("\r\n", "\n", $message);
// just to make sure its length, we need to stripslashes message before enter other procedures
$sms_sender = stripslashes($sms_sender);
$message = stripslashes($message);
$sms_footer = stripslashes($sms_footer);
// fixme anton - fix #71 but not sure whats the correct solution for this
// $max_length = ( $unicode ? $user['opt']['max_sms_length_unicode'] : $user['opt']['max_sms_length'] );
$max_length = $user['opt']['max_sms_length'];
if (strlen($message) > $max_length) {
$message = substr($message, 0, $max_length);
}
$sms_msg = $message;
logger_print("start uid:" . $uid . " sender:" . $sms_sender, 2, "sendsms_bc");
// add a space infront of footer if exists
$c_sms_footer = trim($sms_footer) ? ' ' . trim($sms_footer) : '';
logger_print("maxlen:" . $max_length . " footerlen:" . strlen($c_sms_footer) . " footer:[" . $c_sms_footer . "] msglen:" . strlen($sms_msg) . " message:[" . $sms_msg . "]", 3, "sendsms_bc");
// destination group should be an array, if single then make it array of 1 member
if (is_array($gpid)) {
$array_gpid = $gpid;
} else {
$array_gpid = explode(',', $gpid);
}
$j = 0;
for ($i = 0; $i < count($array_gpid); $i++) {
if ($c_gpid = trim($array_gpid[$i])) {
logger_print("start gpid:" . $c_gpid . " uid:" . $uid . " sender:" . $sms_sender, 2, "sendsms_bc");
// create a queue
$queue_code = sendsms_queue_create($sms_sender, $sms_footer, $sms_msg, $uid, $c_gpid, $sms_type, $unicode, $sms_schedule, $smsc);
if (!$queue_code) {
// when unable to create a queue then immediately returns FALSE, no point to continue
logger_print("fail to finalize queue creation, exit immediately", 2, "sendsms_bc");
return array(FALSE, '', '', '', '');
}
$queue_count = 0;
$sms_count = 0;
$failed_queue_count = 0;
$failed_sms_count = 0;
$rows = phonebook_getdatabyid($c_gpid);
if (is_array($rows)) {
foreach ($rows as $key => $db_row) {
$p_num = trim($db_row['p_num']);
if ($sms_to = sendsms_getvalidnumber($p_num)) {
$sms_to = sendsms_manipulate_prefix($sms_to, $user);
if ($smslog_id[$j] = sendsms_queue_push($queue_code, $sms_to)) {
$ok[$j] = true;
$queue_count++;
$sms_count += $count;
} else {
$ok[$j] = FALSE;
$failed_queue_count++;
$failed_sms_count++;
}
$to[$j] = $sms_to;
$queue[$j] = $queue_code;
$counts[$j] = $count;
$j++;
}
}
}
if (sendsms_queue_update($queue_code, array('flag' => '0', 'sms_count' => $sms_count))) {
logger_print("end queue_code:" . $queue_code . " queue_count:" . $queue_count . " sms_count:" . $sms_count . " failed_queue:" . $failed_queue_count . " failed_sms:" . $failed_sms_count, 2, "sendsms_bc");
} else {
logger_print("fail to prepare queue, exit immediately queue_code:" . $queue_code, 2, "sendsms_bc");
return array(FALSE, '', '', $queue_code, '');
}
}
}
if (!$core_config['issendsmsd']) {
unset($ok);
unset($to);
unset($queue);
unset($counts);
logger_print("sendsmsd off immediately process queue_code:" . $queue_code, 2, "sendsms_bc");
list($ok, $to, $smslog_id, $queue, $counts) = sendsmsd($queue_code);
}
return array($ok, $to, $smslog_id, $queue, $counts);
}
function sendsms($sms_sender, $sms_footer, $sms_to, $sms_msg, $uid, $gpid = 0, $sms_type = 'text', $unicode = 0)
{
global $core_config, $gateway_module;
$user = user_getdatabyuid($uid);
$username = $user['username'];
$sms_to = sendsms_getvalidnumber($sms_to);
$sms_to = sendsms_manipulate_prefix($sms_to, $user);
// make sure sms_datetime is in supported format and in GMT+0
// timezone used for outgoing message is not module timezone, but default timezone
// module gateway may have set already to +0000 (such kannel and clickatell)
$sms_datetime = core_adjust_datetime($core_config['datetime']['now'], $core_config['main']['cfg_datetime_timezone']);
// sent sms will be handled by plugin/tools/* first
$ret_intercept = interceptsendsms($sms_sender, $sms_footer, $sms_to, $sms_msg, $uid, $gpid, $sms_type, $unicode);
if ($ret_intercept['modified']) {
$sms_sender = $ret_intercept['param']['sms_sender'] ? $ret_intercept['param']['sms_sender'] : $sms_sender;
$sms_footer = $ret_intercept['param']['sms_footer'] ? $ret_intercept['param']['sms_footer'] : $sms_footer;
$sms_to = $ret_intercept['param']['sms_to'] ? $ret_intercept['param']['sms_to'] : $sms_to;
$sms_msg = $ret_intercept['param']['sms_msg'] ? $ret_intercept['param']['sms_msg'] : $sms_msg;
$uid = $ret_intercept['param']['uid'] ? $ret_intercept['param']['uid'] : $uid;
$gpid = $ret_intercept['param']['gpid'] ? $ret_intercept['param']['gpid'] : $gpid;
$sms_type = $ret_intercept['param']['sms_type'] ? $ret_intercept['param']['sms_type'] : $sms_type;
$unicode = $ret_intercept['param']['unicode'] ? $ret_intercept['param']['unicode'] : $unicode;
}
// if hooked function returns cancel=true then stop the sending, return false
if ($ret_intercept['cancel']) {
logger_print("cancelled:{$uid},{$gpid},{$gateway_module},{$sms_sender},{$sms_to},{$sms_type},{$unicode}", 3, "sendsms");
$ret['status'] = false;
return $ret;
}
// fixme anton - mobile number can be anything, screened by gateway
// $sms_sender = sendsms_getvalidnumber($sms_sender);
$ok = false;
logger_print("start", 3, "sendsms");
if (rate_cansend($username, $sms_to)) {
// fixme anton - its a total mess ! need another DBA - we dont need this anymore
//$sms_footer = addslashes(trim($sms_footer));
//$sms_msg = addslashes($sms_msg);
// we save all info first and then process with gateway module
// the thing about this is that message saved may not be the same since gateway may not be able to process
// message with that length or certain characters in the message are not supported by the gateway
$db_query = "\n\t\t\tINSERT INTO " . _DB_PREF_ . "_tblSMSOutgoing \n\t\t\t(uid,p_gpid,p_gateway,p_src,p_dst,p_footer,p_msg,p_datetime,p_sms_type,unicode) \n\t\t\tVALUES ('{$uid}','{$gpid}','{$gateway_module}','{$sms_sender}','{$sms_to}','{$sms_footer}','{$sms_msg}','{$sms_datetime}','{$sms_type}','{$unicode}')\n\t\t";
logger_print("saving:{$uid},{$gpid},{$gateway_module},{$sms_sender},{$sms_to},{$sms_type},{$unicode}", 3, "sendsms");
// continue to gateway only when save to db is true
if ($smslog_id = @dba_insert_id($db_query)) {
logger_print("smslog_id:" . $smslog_id . " saved", 3, "sendsms");
// fixme anton - another mess with slashes! also trim $sms_footer and prefix it with a space
$sms_footer = ' ' . stripslashes(trim($sms_footer));
$sms_msg = stripslashes($sms_msg);
if (x_hook($gateway_module, 'sendsms', array($sms_sender, $sms_footer, $sms_to, $sms_msg, $uid, $gpid, $smslog_id, $sms_type, $unicode))) {
// fixme anton - deduct user's credit as soon as gateway returns true
rate_deduct($smslog_id);
$ok = true;
}
}
}
logger_print("end", 3, "sendsms");
$ret['status'] = $ok;
$ret['smslog_id'] = $smslog_id;
return $ret;
}
