Files
yuyin-php/extend/JPush/PushPayload.php

727 lines
24 KiB
PHP
Raw Permalink Normal View History

<?php
namespace JPush;
use InvalidArgumentException;
class PushPayload {
private static $EFFECTIVE_DEVICE_TYPES = array('ios', 'android', 'winphone');
private $client;
private $url;
private $cid;
private $platform;
private $audience;
private $tags;
private $tagAnds;
private $tagNots;
private $alias;
private $registrationIds;
private $segmentIds;
private $abtests;
private $notificationAlert;
private $iosNotification;
private $androidNotification;
private $winPhoneNotification;
private $smsMessage;
private $message;
private $options;
/**
* PushPayload constructor.
* @param $client JPush
*/
function __construct($client) {
$this->client = $client;
$url = $this->client->is_group() ? 'grouppush' : 'push';
$this->url = $this->client->makeURL('push') . $url;
}
public function getCid($count = 1, $type = 'push') {
$url = $this->client->makeURL('push') . 'push/cid?count=' . $count . '&type=' . $type;
return Http::get($this->client, $url);
}
public function setCid($cid) {
$this->cid = trim($cid);
return $this;
}
public function setPlatform($platform) {
# $required_keys = array('all', 'android', 'ios', 'winphone');
if (is_string($platform)) {
$ptf = strtolower($platform);
if ('all' === $ptf) {
$this->platform = 'all';
} elseif (in_array($ptf, self::$EFFECTIVE_DEVICE_TYPES)) {
$this->platform = array($ptf);
}
} elseif (is_array($platform)) {
$ptf = array_map('strtolower', $platform);
$this->platform = array_intersect($ptf, self::$EFFECTIVE_DEVICE_TYPES);
}
return $this;
}
public function setAudience($all) {
if (strtolower($all) === 'all') {
$this->addAllAudience();
return $this;
} else {
throw new InvalidArgumentException('Invalid audience value');
}
}
public function addAllAudience() {
$this->audience = "all";
return $this;
}
public function addTag($tag) {
return $this->updateAudience('tags', $tag, 'tag');
}
public function addTagAnd($tag) {
return $this->updateAudience('tagAnds', $tag, 'tag_and');
}
public function addTagNot($tag) {
return $this->updateAudience('tagNots', $tag, 'tag_not');
}
public function addAlias($alias) {
return $this->updateAudience('alias', $alias, 'alias');
}
public function addRegistrationId($registrationId) {
return $this->updateAudience('registrationIds', $registrationId, 'registration_id');
}
public function addSegmentId($segmentId) {
return $this->updateAudience('segmentIds', $segmentId, 'segment');
}
public function addAbtest($abtest) {
return $this->updateAudience('abtests', $abtest, 'abtest');
}
private function updateAudience($key, $value, $name) {
if (is_null($this->$key)) {
$this->$key = array();
}
if (is_array($value)) {
foreach($value as $v) {
if (!is_string($v)) {
throw new InvalidArgumentException("Invalid $name value");
}
if (!in_array($v, $this->$key)) {
array_push($this->$key, $v);
}
}
} else if (is_string($value)) {
if (!in_array($value, $this->$key)) {
array_push($this->$key, $value);
}
} else {
throw new InvalidArgumentException("Invalid $name value");
}
return $this;
}
public function setNotificationAlert($alert) {
if (!is_string($alert)) {
throw new InvalidArgumentException("Invalid alert value");
}
$this->notificationAlert = $alert;
return $this;
}
public function addWinPhoneNotification($alert=null, $title=null, $_open_page=null, $extras=null) {
$winPhone = array();
if (!is_null($alert)) {
if (!is_string($alert)) {
throw new InvalidArgumentException("Invalid winphone notification");
}
$winPhone['alert'] = $alert;
}
if (!is_null($title)) {
if (!is_string($title)) {
throw new InvalidArgumentException("Invalid winphone title notification");
}
if(strlen($title) > 0) {
$winPhone['title'] = $title;
}
}
if (!is_null($_open_page)) {
if (!is_string($_open_page)) {
throw new InvalidArgumentException("Invalid winphone _open_page notification");
}
if (strlen($_open_page) > 0) {
$winPhone['_open_page'] = $_open_page;
}
}
if (!is_null($extras)) {
if (!is_array($extras)) {
throw new InvalidArgumentException("Invalid winphone extras notification");
}
if (count($extras) > 0) {
$winPhone['extras'] = $extras;
}
}
if (count($winPhone) <= 0) {
throw new InvalidArgumentException("Invalid winphone notification");
}
$this->winPhoneNotification = $winPhone;
return $this;
}
public function setSms($delay_time, $temp_id, array $temp_para = []) {
$sms = array();
$sms['temp_id'] = $temp_id;
$sms['delay_time'] = ($delay_time === 0 || (is_int($delay_time) && $delay_time > 0 && $delay_time <= 86400)) ? $delay_time : 0;
if (!empty($temp_para)) {
$sms['temp_para'] = $temp_para;
}
$this->smsMessage = $sms;
return $this;
}
public function build() {
$payload = array();
// validate platform
if (is_null($this->platform)) {
throw new InvalidArgumentException("platform must be set");
}
$payload["platform"] = $this->platform;
if (!is_null($this->cid)) {
$payload['cid'] = $this->cid;
}
// validate audience
$audience = array();
if (!is_null($this->tags)) {
$audience["tag"] = $this->tags;
}
if (!is_null($this->tagAnds)) {
$audience["tag_and"] = $this->tagAnds;
}
if (!is_null($this->tagNots)) {
$audience["tag_not"] = $this->tagNots;
}
if (!is_null($this->alias)) {
$audience["alias"] = $this->alias;
}
if (!is_null($this->registrationIds)) {
$audience["registration_id"] = $this->registrationIds;
}
if (!is_null($this->segmentIds)) {
$audience["segment"] = $this->segmentIds;
}
if (!is_null($this->abtests)) {
$audience["abtest"] = $this->abtests;
}
if (is_null($this->audience) && count($audience) <= 0) {
throw new InvalidArgumentException("audience must be set");
} else if (!is_null($this->audience) && count($audience) > 0) {
throw new InvalidArgumentException("you can't add tags/alias/registration_id/tag_and when audience='all'");
} else if (is_null($this->audience)) {
$payload["audience"] = $audience;
} else {
$payload["audience"] = $this->audience;
}
// validate notification
$notification = array();
if (!is_null($this->notificationAlert)) {
$notification['alert'] = $this->notificationAlert;
}
if (!is_null($this->androidNotification)) {
$notification['android'] = $this->androidNotification;
if (is_null($this->androidNotification['alert'])) {
if (is_null($this->notificationAlert)) {
throw new InvalidArgumentException("Android alert can not be null");
} else {
$notification['android']['alert'] = $this->notificationAlert;
}
}
}
if (!is_null($this->iosNotification)) {
$notification['ios'] = $this->iosNotification;
if (is_null($this->iosNotification['alert'])) {
if (is_null($this->notificationAlert)) {
throw new InvalidArgumentException("iOS alert can not be null");
} else {
$notification['ios']['alert'] = $this->notificationAlert;
}
}
}
if (!is_null($this->winPhoneNotification)) {
$notification['winphone'] = $this->winPhoneNotification;
if (is_null($this->winPhoneNotification['alert'])) {
if (is_null($this->winPhoneNotification)) {
throw new InvalidArgumentException("WinPhone alert can not be null");
} else {
$notification['winphone']['alert'] = $this->notificationAlert;
}
}
}
if (count($notification) > 0) {
$payload['notification'] = $notification;
}
if (!is_null($this->message)) {
$payload['message'] = $this->message;
}
if (!array_key_exists('notification', $payload) && !array_key_exists('message', $payload)) {
throw new InvalidArgumentException('notification and message can not all be null');
}
if (!is_null($this->smsMessage)) {
$payload['sms_message'] = $this->smsMessage;
}
if (is_null($this->options)) {
$this->options();
}
$payload['options'] = $this->options;
return $payload;
}
public function toJSON() {
$payload = $this->build();
return json_encode($payload);
}
public function printJSON() {
echo $this->toJSON();
return $this;
}
public function send() {
return Http::post($this->client, $this->url, $this->build());
}
public function validate() {
$url = $this->client->makeURL('push') . '/push/validate';
return Http::post($this->client, $url, $this->build());
}
private function generateSendno() {
return rand(100000, getrandmax());
}
# new methods
public function iosNotification($alert = '', array $notification = array()) {
$ios = array();
$ios['alert'] = (is_string($alert) || is_array($alert)) ? $alert : '';
if (!empty($notification)) {
if (isset($notification['sound'])) {
if (is_string($notification['sound']) || is_array($notification['sound'])) {
$ios['sound'] = $notification['sound'];
} else {
unset($notification['sound']);
}
}
if (isset($notification['content-available'])) {
if (is_bool($notification['content-available'])) {
$ios['content-available'] = $notification['content-available'];
} else {
unset($notification['content-available']);
}
}
if (isset($notification['mutable-content'])) {
if (is_bool($notification['mutable-content'])) {
$ios['mutable-content'] = $notification['mutable-content'];
} else {
unset($notification['mutable-content']);
}
}
if (isset($notification['extras'])) {
if (is_array($notification['extras']) && !empty($notification['extras'])) {
$ios['extras'] = $notification['extras'];
} else {
unset($notification['extras']);
}
}
$ios = array_merge($notification, $ios);
}
if (!isset($ios['sound'])) {
$ios['sound'] = '';
}
if (!isset($ios['badge'])) {
$ios['badge'] = '+1';
}
$this->iosNotification = $ios;
return $this;
}
public function androidNotification($alert = '', array $notification = array()) {
$android = array();
$android['alert'] = is_string($alert) ? $alert : '';
if (!empty($notification)) {
if (isset($notification['builder_id'])) {
if (is_int($notification['builder_id'])) {
$android['builder_id'] = $notification['builder_id'];
} else {
unset($notification['builder_id']);
}
}
if (isset($notification['priority'])) {
if (is_int($notification['priority'])) {
$android['priority'] = $notification['priority'];
} else {
unset($notification['priority']);
}
}
if (isset($notification['style'])) {
if (is_int($notification['style'])) {
$android['style'] = $notification['style'];
} else {
unset($notification['style']);
}
}
if (isset($notification['alert_type'])) {
if (is_int($notification['alert_type'])) {
$android['alert_type'] = $notification['alert_type'];
} else {
unset($notification['alert_type']);
}
}
if (isset($notification['inbox'])) {
if (is_array($notification['inbox']) && !empty($notification['inbox'])) {
$android['inbox'] = $notification['inbox'];
} else {
unset($notification['inbox']);
}
}
if (isset($notification['intent'])) {
if (is_array($notification['intent']) && !empty($notification['intent'])) {
$android['intent'] = $notification['intent'];
} else {
unset($notification['intent']);
}
}
if (isset($notification['extras'])) {
if (is_array($notification['extras']) && !empty($notification['extras'])) {
$android['extras'] = $notification['extras'];
} else {
unset($notification['extras']);
}
}
$android = array_merge($notification, $android);
}
$this->androidNotification = $android;
return $this;
}
public function message($msg_content, array $msg = array()) {
# $required_keys = array('title', 'content_type', 'extras');
if (is_string($msg_content)) {
$message = array();
$message['msg_content'] = $msg_content;
if (!empty($msg)) {
if (isset($msg['title']) && is_string($msg['title'])) {
$message['title'] = $msg['title'];
}
if (isset($msg['content_type']) && is_string($msg['content_type'])) {
$message['content_type'] = $msg['content_type'];
}
if (isset($msg['extras']) && is_array($msg['extras']) && !empty($msg['extras'])) {
$message['extras'] = $msg['extras'];
}
}
$this->message = $message;
}
return $this;
}
public function options(array $opts = array()) {
# $required_keys = array('sendno', 'time_to_live', 'override_msg_id', 'apns_production', 'apns_collapse_id', 'big_push_duration');
$options = array();
if (isset($opts['sendno'])) {
$options['sendno'] = $opts['sendno'];
} else {
$options['sendno'] = $this->generateSendno();
}
if (isset($opts['time_to_live']) && $opts['time_to_live'] <= 864000 && $opts['time_to_live'] >= 0) {
$options['time_to_live'] = $opts['time_to_live'];
}
if (isset($opts['override_msg_id'])) {
$options['override_msg_id'] = $opts['override_msg_id'];
}
if (isset($opts['apns_production'])) {
$options['apns_production'] = (bool)$opts['apns_production'];
} else {
$options['apns_production'] = false;
}
if (isset($opts['apns_collapse_id'])) {
$options['apns_collapse_id'] = $opts['apns_collapse_id'];
}
if (isset($opts['big_push_duration']) && $opts['big_push_duration'] <= 1400 && $opts['big_push_duration'] >= 0) {
$options['big_push_duration'] = $opts['big_push_duration'];
}
$options = array_merge($opts, $options);
$this->options = $options;
return $this;
}
###############################################################################
############# 以下函数已过期,不推荐使用,仅作为兼容接口存在 #########################
###############################################################################
public function addIosNotification($alert=null, $sound=null, $badge=null, $content_available=null, $category=null, $extras=null) {
$ios = array();
if (!is_null($alert)) {
if (!is_string($alert) && !is_array($alert)) {
throw new InvalidArgumentException("Invalid ios alert value");
}
$ios['alert'] = $alert;
}
if (!is_null($sound)) {
if (!is_string($sound)) {
throw new InvalidArgumentException("Invalid ios sound value");
}
if ($sound !== Config::DISABLE_SOUND) {
$ios['sound'] = $sound;
}
} else {
// 默认sound为''
$ios['sound'] = '';
}
if (!is_null($badge)) {
if (is_string($badge) && !preg_match("/^[+-]{1}[0-9]{1,3}$/", $badge)) {
if (!is_int($badge)) {
throw new InvalidArgumentException("Invalid ios badge value");
}
}
if ($badge != Config::DISABLE_BADGE) {
$ios['badge'] = $badge;
}
} else {
// 默认badge为'+1'
$ios['badge'] = '+1';
}
if (!is_null($content_available)) {
if (!is_bool($content_available)) {
throw new InvalidArgumentException("Invalid ios content-available value");
}
$ios['content-available'] = $content_available;
}
if (!is_null($category)) {
if (!is_string($category)) {
throw new InvalidArgumentException("Invalid ios category value");
}
if (strlen($category)) {
$ios['category'] = $category;
}
}
if (!is_null($extras)) {
if (!is_array($extras)) {
throw new InvalidArgumentException("Invalid ios extras value");
}
if (count($extras) > 0) {
$ios['extras'] = $extras;
}
}
if (count($ios) <= 0) {
throw new InvalidArgumentException("Invalid iOS notification");
}
$this->iosNotification = $ios;
return $this;
}
public function addAndroidNotification($alert=null, $title=null, $builderId=null, $extras=null) {
$android = array();
if (!is_null($alert)) {
if (!is_string($alert)) {
throw new InvalidArgumentException("Invalid android alert value");
}
$android['alert'] = $alert;
}
if (!is_null($title)) {
if(!is_string($title)) {
throw new InvalidArgumentException("Invalid android title value");
}
if(strlen($title) > 0) {
$android['title'] = $title;
}
}
if (!is_null($builderId)) {
if (!is_int($builderId)) {
throw new InvalidArgumentException("Invalid android builder_id value");
}
$android['builder_id'] = $builderId;
}
if (!is_null($extras)) {
if (!is_array($extras)) {
throw new InvalidArgumentException("Invalid android extras value");
}
if (count($extras) > 0) {
$android['extras'] = $extras;
}
}
if (count($android) <= 0) {
throw new InvalidArgumentException("Invalid android notification");
}
$this->androidNotification = $android;
return $this;
}
public function setMessage($msg_content, $title=null, $content_type=null, $extras=null) {
$message = array();
if (is_null($msg_content) || !is_string($msg_content)) {
throw new InvalidArgumentException("Invalid message content");
} else {
$message['msg_content'] = $msg_content;
}
if (!is_null($title)) {
if (!is_string($title)) {
throw new InvalidArgumentException("Invalid message title");
}
$message['title'] = $title;
}
if (!is_null($content_type)) {
if (!is_string($content_type)) {
throw new InvalidArgumentException("Invalid message content type");
}
$message["content_type"] = $content_type;
}
if (!is_null($extras)) {
if (!is_array($extras)) {
throw new InvalidArgumentException("Invalid message extras");
}
if (count($extras) > 0) {
$message['extras'] = $extras;
}
}
$this->message = $message;
return $this;
}
public function setSmsMessage($smsMessage) {
$this->smsMessage = $smsMessage;
return $this;
}
public function setOptions($sendno=null, $time_to_live=null, $override_msg_id=null, $apns_production=null, $big_push_duration=null) {
$options = array();
if (!is_null($sendno)) {
if (!is_int($sendno)) {
throw new InvalidArgumentException('Invalid option sendno');
}
$options['sendno'] = $sendno;
} else {
$options['sendno'] = $this->generateSendno();
}
if (!is_null($time_to_live)) {
if (!is_int($time_to_live) || $time_to_live < 0 || $time_to_live > 864000) {
throw new InvalidArgumentException('Invalid option time to live, it must be a int and in [0, 864000]');
}
$options['time_to_live'] = $time_to_live;
}
if (!is_null($override_msg_id)) {
if (!is_long($override_msg_id)) {
throw new InvalidArgumentException('Invalid option override msg id');
}
$options['override_msg_id'] = $override_msg_id;
}
if (!is_null($apns_production)) {
if (!is_bool($apns_production)) {
throw new InvalidArgumentException('Invalid option apns production');
}
$options['apns_production'] = $apns_production;
} else {
$options['apns_production'] = false;
}
if (!is_null($big_push_duration)) {
if (!is_int($big_push_duration) || $big_push_duration < 0 || $big_push_duration > 1440) {
throw new InvalidArgumentException('Invalid option big push duration, it must be a int and in [0, 1440]');
}
$options['big_push_duration'] = $big_push_duration;
}
$this->options = $options;
return $this;
}
/*
针对RegID方式批量单推
https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#vip
*/
public function batchPushByRegid(array $singlePayloads) {
$body = array(
"pushlist"=>array()
);
$response = $this -> getCid(count($singlePayloads), 'push');
$cidlist = $response['body']['cidlist'];
foreach ($cidlist as $i => $cid) {
$body["pushlist"][$cid] = $singlePayloads[$i];
}
$url = $this->client->makeURL('push') . 'push/batch/regid/single';
return Http::post($this->client, $url, $body);
}
/*
针对Alias方式批量单推
https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#vip
*/
public function batchPushByAlias(array $singlePayloads) {
$body = array(
"pushlist"=>array()
);
$response = $this -> getCid(count($singlePayloads), 'push');
$cidlist = $response['body']['cidlist'];
foreach ($cidlist as $i => $cid) {
$body["pushlist"][$cid] = $singlePayloads[$i];
}
$url = $this->client->makeURL('push') . 'push/batch/alias/single';
return Http::post($this->client, $url, $body);
}
}