<?php
namespace base;
use app\service\SmsLogService;
* 短信驱动
* @author Devil
* @blog http://gong.gg/
* @version 0.0.1
* @datetime 2016-12-01T21:51:08+0800
*/
class Sms
{
public $error;
private $access_key_id = '';
private $access_key_secret = '';
private $sign_ame = '';
private $interval_time;
private $expire_time;
private $key_code;
private $is_frq;
private $is_log;
* 构造方法
* @author Devil
* @blog http://gong.gg/
* @version 0.0.1
* @datetime 2017-03-07T14:03:02+0800
* @param [int] $params['interval_time'] [间隔时间（默认30）单位（秒）]
* @param [int] $params['expire_time'] [到期时间（默认30）单位（秒）]
* @param [string] $params['key_prefix'] [验证码种存储前缀key（默认 空）]
* @param [string] $params['is_frq'] [是否验证频率（默认 是）]
* @param [string] $params['is_log'] [是否记录日志（默认 是）]
*/
public function __construct($params = [])
{
$this->interval_time = isset($params['interval_time']) ? intval($params['interval_time']) : 30;
$this->expire_time = isset($params['expire_time']) ? intval($params['expire_time']) : 30;
$this->key_code = isset($params['key_prefix']) ? trim($params['key_prefix']).'_sms_code' : '_sms_code';
$this->is_frq = isset($params['is_frq']) ? intval($params['is_frq']) : 1;
$this->is_log = isset($params['is_log']) ? intval($params['is_log']) : 1;
$this->sign_ame = MyC('common_sms_sign');
$this->access_key_id = MyC('common_sms_apikey');
$this->access_key_secret = MyC('common_sms_apisecret');
}
* 验证码发送
* @author Devil
* @blog http://gong.gg/
* @version 1.0.0
* @date 2020-04-02
* @desc description
* @param [string] $mobile [手机号码，多个以 英文逗号 , 分割]
* @param [string|array] $code [变量code（单个直接传入 code 即可，多个传入数组）]
* @param [string] $template_value[模板 id]
* @param [boolean] $sign_name [自定义签名，默认使用基础配置的签名]
*/
public function SendCode($mobile, $code, $template_value, $sign_name = '')
{
if(is_string($code))
{
if(!$this->IntervalTimeCheck())
{
$this->error = MyLang('operate_frequent_tips');
return false;
}
$codes = ['code'=>$code];
} else {
$codes = $code;
}
$status = $this->SmsRequest($mobile, $template_value, $sign_name, $codes);
if($status)
{
if(is_string($code))
{
$this->KindofSession($code);
}
}
return $status;
}
* 短信发送
* @author Devil
* @blog http://gong.gg/
* @version 1.0.0
* @date 2020-04-02
* @desc description
* @param [string] $mobile [手机号码，多个以 英文逗号 , 分割]
* @param [string] $template_value [模板 id]
* @param [boolean] $sign_name [自定义签名，默认使用基础配置的签名]
* @param [string|array] $template_var [变量code（单个直接传入 code 即可，多个传入数组）]
*/
public function SendTemplate($mobile, $template_value, $sign_name = '', $template_var = [])
{
if($this->is_frq == 1)
{
if(!$this->IntervalTimeCheck())
{
$this->error = MyLang('operate_frequent_tips');
return false;
}
}
$status = $this->SmsRequest($mobile, $template_value, $sign_name, $template_var);
if($status)
{
if($this->is_frq == 1)
{
$this->KindofSession();
}
}
return $status;
}
* 请求发送
* @author Devil
* @blog http://gong.gg/
* @version 1.0.0
* @date 2022-03-26
* @desc description
* @param [string] $mobile [手机号码，多个以 英文逗号 , 分割]
* @param [string] $template_value [模板 id]
* @param [boolean] $sign_name [自定义签名，默认使用基础配置的签名]
* @param [string|array] $template_var [默认变量code（单个直接传入 code 即可，多个传入数组）]
*/
public function SmsRequest($mobile, $template_value, $sign_name = '', $template_var = [])
{
$sign_name = empty($sign_name) ? $this->sign_ame : $sign_name;
$hook_name = 'plugins_extend_sms_send_request_handle';
$ret = array_filter(MyEventTrigger($hook_name, [
'hook_name' => $hook_name,
'is_backend' => true,
'sign_name' => $sign_name,
'mobile' => $mobile,
'template_value' => $template_value,
'template_var' => $template_var,
]));
if(!empty($ret))
{
$ret = EventReturnHandle($ret);
if($ret['code'] != 0)
{
$this->error = $ret['msg'];
return false;
}
return true;
}
$request_url = 'http://dysmsapi.aliyuncs.com/';
$request_params = [
'SignName' => $sign_name,
'Format' => 'JSON',
'Version' => '2017-05-25',
'AccessKeyId' => $this->access_key_id,
'SignatureVersion' => '1.0',
'SignatureMethod' => 'HMAC-SHA1',
'SignatureNonce' => uniqid(),
'Timestamp' => gmdate('Y-m-d\TH:i:s\Z'),
'Action' => 'SendSms',
'TemplateCode' => $template_value,
'PhoneNumbers' => $mobile,
];
if(!empty($template_var))
{
if(!is_array($template_var))
{
$template_var = ['code'=>$template_var];
}
$request_params['TemplateParam'] = json_encode($template_var, JSON_UNESCAPED_UNICODE);
}
$request_params['Signature'] = $this->ComputeSignature($request_params, $this->access_key_secret);
if($this->is_log == 1)
{
$log = SmsLogService::SmsLogAdd('aliyun', $mobile, $sign_name, $template_value, $template_var, $request_url, $request_params);
if($log['code'] != 0)
{
$this->error = $log['msg'];
return false;
}
}
$request_url .= '?' . http_build_query($request_params);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $request_url);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
$result = curl_exec($ch);
curl_close($ch);
$result = json_decode($result, true);
if(isset($result['Code']) && $result['Code'] == 'OK')
{
if($this->is_log == 1)
{
SmsLogService::SmsLogResponse($log['data']['id'], 1, $result, time()-$log['data']['add_time']);
}
return true;
}
$this->error = $this->GetErrorMessage($result['Code']);
if($this->is_log == 1)
{
SmsLogService::SmsLogResponse($log['data']['id'], 2, $result, time()-$log['data']['add_time'], $this->error);
}
return false;
}
* 签名生成
* @author Devil
* @blog http://gong.gg/
* @version 1.0.0
* @date 2022-03-26
* @desc description
* @param [array] $parameters [参数]
* @param [string] $accessKeySecret [秘钥]
*/
private function ComputeSignature($parameters, $accessKeySecret)
{
ksort($parameters);
$canonicalizedQueryString = '';
foreach($parameters as $key=>$value)
{
$canonicalizedQueryString .= '&' . $this->PercentEncode($key) . '=' . $this->PercentEncode($value );
}
$stringToSign = 'GET&%2F&' . $this->Percentencode(substr($canonicalizedQueryString, 1));
$signature = base64_encode(hash_hmac('sha1', $stringToSign, $accessKeySecret . '&', true));
return $signature;
}
* 签名字符处理
* @author Devil
* @blog http://gong.gg/
* @version 1.0.0
* @date 2022-03-26
* @desc description
* @param [string] $string [需要处理的字符]
*/
private function PercentEncode($string)
{
if(!empty($string))
{
$string = urlencode($string);
$string = preg_replace('/\+/', '%20', $string);
$string = preg_replace('/\*/', '%2A', $string);
$string = preg_replace('/%7E/', '~', $string);
}
return $string;
}
* 获取详细错误信息
* @author Devil
* @blog http://gong.gg/
* @version 1.0.0
* @date 2022-03-26
* @desc description
* @param [string] $status [错误码]
*/
public function GetErrorMessage($status)
{
$message = [
'InvalidDayuStatus.Malformed' => '账户短信开通状态不正确',
'InvalidSignName.Malformed' => '短信签名不正确或签名状态不正确',
'InvalidTemplateCode.MalFormed' => '短信模板Code不正确或者模板状态不正确',
'InvalidRecNum.Malformed' => '目标手机号不正确，单次发送数量不能超过100',
'InvalidParamString.MalFormed' => '短信模板中变量不是json格式',
'InvalidParamStringTemplate.Malformed' => '短信模板中变量与模板内容不匹配',
'InvalidSendSms' => '触发业务流控',
'InvalidDayu.Malformed' => '变量不能是url，可以将变量固化在模板中',
'isv.RAM_PERMISSION_DENY' => 'RAM权限DENY',
'isv.OUT_OF_SERVICE' => '业务停机',
'isv.PRODUCT_UN_SUBSCRIPT' => '未开通云通信产品的阿里云客户',
'isv.PRODUCT_UNSUBSCRIBE' => '产品未开通',
'isv.ACCOUNT_NOT_EXISTS' => '账户不存在',
'isv.ACCOUNT_ABNORMAL' => '账户异常',
'isv.SMS_TEMPLATE_ILLEGAL' => '短信模板不合法',
'isv.SMS_SIGNATURE_ILLEGAL' => '短信签名不合法',
'isv.INVALID_PARAMETERS' => '参数异常',
'isv.SYSTEM_ERROR' => '系统错误',
'isv.MOBILE_NUMBER_ILLEGAL' => '非法手机号',
'isv.MOBILE_COUNT_OVER_LIMIT' => '手机号码数量超过限制',
'isv.TEMPLATE_MISSING_PARAMETERS' => '模板缺少变量',
'isv.BUSINESS_LIMIT_CONTROL' => '业务限流',
'isv.INVALID_JSON_PARAM' => 'JSON参数不合法，只接受字符串值',
'isv.BLACK_KEY_CONTROL_LIMIT' => '黑名单管控',
'isv.PARAM_LENGTH_LIMIT' => '参数超出长度限制',
'isv.PARAM_NOT_SUPPORT_URL' => '不支持URL',
'isv.AMOUNT_NOT_ENOUGH' => '账户余额不足',
];
if(isset($message[$status]))
{
return $message[$status];
}
return $status;
}
* 种验证码session
* @author Devil
* @blog http://gong.gg/
* @version 0.0.1
* @datetime 2017-03-07T14:59:13+0800
* @param [string] $value [存储值或验证码]
*/
private function KindofSession($value = '')
{
$data = [
'value' => $value,
'time' => time(),
];
MyCache($this->key_code, $data, $this->expire_time);
}
* 验证码是否过期
* @author Devil
* @blog http://gong.gg/
* @version 0.0.1
* @datetime 2017-03-05T19:02:26+0800
* @return [boolean] [有效true, 无效false]
*/
public function CheckExpire()
{
$data = MyCache($this->key_code);
if(!empty($data))
{
return (time() <= $data['time']+$this->expire_time);
}
return false;
}
* 验证码是否正确
* @author Devil
* @blog http://gong.gg/
* @version 0.0.1
* @datetime 2017-03-05T16:55:00+0800
* @param [string] $code [验证码（默认从post读取）]
* @return [booolean] [正确true, 错误false]
*/
public function CheckCorrect($code = '')
{
if(SecurityPreventViolence($this->key_code, 1, $this->expire_time))
{
$data = MyCache($this->key_code);
if(!empty($data))
{
if(empty($code) && !empty($_POST['code']))
{
$code = trim($_POST['code']);
}
return (isset($data['value']) && $data['value'] == $code);
}
}
return false;
}
* 验证码清除
* @author Devil
* @blog http://gong.gg/
* @version 0.0.1
* @datetime 2017-03-08T10:18:20+0800
* @return [other] [无返回值]
*/
public function Remove()
{
MyCache($this->key_code, null);
SecurityPreventViolence($this->key_code, 0);
}
* 是否已经超过控制的间隔时间
* @author Devil
* @blog http://gong.gg/
* @version 0.0.1
* @datetime 2017-03-10T11:26:52+0800
* @return [booolean] [已超过间隔时间true, 未超过间隔时间false]
*/
private function IntervalTimeCheck()
{
$data = MyCache($this->key_code);
if(!empty($data))
{
return (time() > $data['time']+$this->interval_time);
}
return true;
}
}
?>