Files
Testing/arrowchat2/includes/classes/class_arrowpush.php

513 lines
13 KiB
PHP
Raw Permalink Normal View History

2026-11-17 16:15:01 -05:00
<?php
require_once('class_arrowpush_encrypt.php');
/**
* ArrowPush 3.0 Real-time Push Cloud API
* @package ArrowPush
*/
class ArrowPush
{
private $ORIGIN = 'www.arrowpushengine.com';
private $PUBLISH_KEY = 'demo';
private $SUBSCRIBE_KEY = 'demo';
private $SECRET_KEY = false;
private $CIPHER_KEY = '';
private $SSL = false;
private $SESSION_UUID = '';
/**
* ArrowPush
*
* Init the ArrowPush Client API
*
* @param string $publish_key required key to send messages.
* @param string $subscribe_key required key to receive messages.
* @param string $secret_key optional key to sign messages.
* @param string $origin optional setting for cloud origin.
* @param boolean $ssl required for 2048 bit encrypted messages.
*/
function ArrowPush(
$publish_key = 'demo',
$subscribe_key = 'demo',
$secret_key = false,
$cipher_key = false,
$ssl = false,
$origin = false
)
{
$this->SESSION_UUID = $this->uuid();
$this->PUBLISH_KEY = $publish_key;
$this->SUBSCRIBE_KEY = $subscribe_key;
$this->SECRET_KEY = $secret_key;
if (!isBlank($cipher_key)) {
$this->CIPHER_KEY = $cipher_key;
}
$this->SSL = $ssl;
if ($origin)
$this->ORIGIN = $origin;
if ($ssl)
$this->ORIGIN = 'https://' . $this->ORIGIN;
else
$this->ORIGIN = 'http://' . $this->ORIGIN;
}
/**
* Publish
*
* Send a message to a channel.
*
* @param array $args with channel and message.
* @return array success information.
*/
function publish($args)
{
## Fail if bad input.
if (!(isset($args['channel']) && isset($args['message']))) {
echo('Missing Channel or Message');
return false;
}
## Capture User Input
$channel = $args['channel'];
$message_org = $args['message'];
$message = $this->sendMessage($message_org);
## Sign Message
$signature = "0";
if ($this->SECRET_KEY) {
## Generate String to Sign
$string_to_sign = implode('/', array(
$this->PUBLISH_KEY,
$this->SUBSCRIBE_KEY,
$this->SECRET_KEY,
$channel,
$message
));
$signature = md5($string_to_sign);
}
## Send Message
$publishResponse = $this->_request(array(
'publish',
$this->PUBLISH_KEY,
$this->SUBSCRIBE_KEY,
$signature,
$channel,
'0',
$message
));
if ($publishResponse == null)
return array(0, "Error during publish.");
else
return $publishResponse;
}
public function sendMessage($message_org)
{
if ($this->CIPHER_KEY != false) {
$message = json_encode(encrypt(json_encode($message_org), $this->CIPHER_KEY));
} else {
$message = json_encode($message_org);
}
return $message;
}
function here_now($args)
{
if (!($args['channel'])) {
echo('Missing Channel');
return false;
}
## Capture User Input
$channel = $args['channel'];
return $this->_request(array(
'v2',
'presence',
'sub_key',
$this->SUBSCRIBE_KEY,
'channel',
$channel
));
}
/**
* Subscribe
*
* This is BLOCKING.
* Listen for a message on a channel.
*
* @param array $args with channel and message.
* @return mixed false on fail, array on success.
*/
function subscribe($args, $presence = false)
{
## Capture User Input
$channel = $args['channel'];
$callback = $args['callback'];
$timetoken = isset($args['timetoken']) ? $args['timetoken'] : '0';
## Fail if missing channel
if (!$channel) {
echo("Missing Channel.\n");
return false;
}
## Fail if missing callback
if (!$callback) {
echo("Missing Callback.\n");
return false;
}
if ($presence == true) {
$mode = "presence";
} else
$mode = "default";
while (1) {
try {
## Wait for Message
$response = $this->_request(array(
'subscribe',
$this->SUBSCRIBE_KEY,
$channel,
'0',
$timetoken
));
if ($response == "_PUBNUB_TIMEOUT") {
continue;
} elseif ($response == "_PUBNUB_MESSAGE_TOO_LARGE") {
$timetoken = $this->throwAndResetTimetoken($callback, "Message Too Large");
continue;
} elseif ($response == null || $timetoken == null) {
$timetoken = $this->throwAndResetTimetoken($callback, "Bad server response.");
continue;
}
$messages = $response[0];
$timetoken = $response[1];
if (!count($messages)) {
continue;
}
$receivedMessages = $this->decodeAndDecrypt($messages, $mode);
$returnArray = array($receivedMessages, $timetoken);
$cbReturn = $callback($returnArray);
if ($cbReturn == false) {
return;
}
} catch (Exception $error) {
$this->handleError($error, $args);
$timetoken = $this->throwAndResetTimetoken($callback, "Unknown error.");
continue;
}
}
}
public function throwAndResetTimetoken($callback, $errorMessage)
{
$callback(array(0, $errorMessage));
$timetoken = "0";
return $timetoken;
}
public function decodeAndDecrypt($messages, $mode = "default")
{
$receivedMessages = array();
if ($mode == "presence") {
return $messages;
} elseif ($mode == "default") {
$messageArray = $messages;
$receivedMessages = $this->decodeDecryptLoop($messageArray);
} elseif ($mode == "detailedHistory") {
$messageArray = $messages[0];
$receivedMessages = $this->decodeDecryptLoop($messageArray);
}
return $receivedMessages;
}
public function decodeDecryptLoop($messageArray)
{
$receivedMessages = array();
foreach ($messageArray as $message) {
if ($this->CIPHER_KEY) {
$decryptedMessage = decrypt($message, $this->CIPHER_KEY);
$message = json_decode($decryptedMessage, true);
}
array_push($receivedMessages, $message);
}
return $receivedMessages;
}
public function handleError($error, $args)
{
$errorMsg = 'Error on line ' . $error->getLine() . ' in ' . $error->getFile() . $error->getMessage();
trigger_error($errorMsg, E_COMPILE_WARNING);
sleep(1);
}
/**
* Presence
*
* This is BLOCKING.
* Listen for a message on a channel.
*
* @param array $args with channel and message.
* @return mixed false on fail, array on success.
*/
function presence($args)
{
## Capture User Input
$args['channel'] = ($args['channel'] . "-pnpres");
$this->subscribe($args, true);
}
/**
* Detailed History
*
* Load history from a channel.
*
* @param array $args with 'channel' and 'limit'.
* @return mixed false on fail, array on success.
*/
function detailedHistory($args)
{
## Capture User Input
## Fail if bad input.
if (!$args['channel']) {
echo('Missing Channel');
return false;
}
$channel = $args['channel'];
$urlParams = "";
if ($args['count'] || $args['start'] || $args['end'] || $args['reverse']) {
$urlParamSep = "?";
if (isset($args['count'])) {
$urlParams .= $urlParamSep . "count=" . $args['count'];
$urlParamSep = "&";
}
if (isset($args['start'])) {
$urlParams .= $urlParamSep . "start=" . $args['start'];
$urlParamSep = "&";
}
if (isset($args['end'])) {
$urlParams .= $urlParamSep . "end=" . $args['end'];
$urlParamSep = "&";
}
if (isset($args['reverse'])) {
$urlParams .= $urlParamSep . "reverse=" . $args['reverse'];
}
}
$response = $this->_request(array(
'v2',
'history',
"sub-key",
$this->SUBSCRIBE_KEY,
"channel",
$channel
), $urlParams);
;
$receivedMessages = $this->decodeAndDecrypt($response, "detailedHistory");
return $receivedMessages;
}
/**
* History
*
* Load history from a channel.
*
* @param array $args with 'channel' and 'limit'.
* @return mixed false on fail, array on success.
*/
function history($args)
{
## Capture User Input
$limit = +$args['limit'] ? +$args['limit'] : 10;
$channel = $args['channel'];
## Fail if bad input.
if (!$channel) {
echo('Missing Channel');
return false;
}
## Get History
$response = $this->_request(array(
'history',
$this->SUBSCRIBE_KEY,
$channel,
'0',
$limit
));
;
$receivedMessages = $this->decodeAndDecrypt($response);
return $receivedMessages;
}
/**
* Time
*
* Timestamp from ArrowPush Cloud.
*
* @return int timestamp.
*/
function time()
{
## Get History
$response = $this->_request(array(
'time',
'0'
));
return $response[0];
}
/**
* UUID
*
* UUID generator
*
* @return UUID
*/
function uuid()
{
if (function_exists('com_create_guid') === true) {
return trim(com_create_guid(), '{}');
}
return sprintf('%04X%04X-%04X-%04X-%04X-%04X%04X%04X', mt_rand(0, 65535), mt_rand(0, 65535), mt_rand(0, 65535), mt_rand(16384, 20479), mt_rand(32768, 49151), mt_rand(0, 65535), mt_rand(0, 65535), mt_rand(0, 65535));
}
/**
* Request URL
*
* @param array $request of url directories.
* @return array from JSON response.
*/
private function _request($request, $urlParams = false)
{
$request = array_map('ArrowPush::_encode', $request);
array_unshift($request, $this->ORIGIN);
if (($request[1] === 'presence') || ($request[1] === 'subscribe')) {
array_push($request, '?uuid=' . $this->SESSION_UUID);
}
$urlString = implode('/', $request);
if ($urlParams) {
$urlString .= $urlParams;
}
$ch = curl_init();
$pubnubHeaders = array("V: 3.3", "Accept: */*");
curl_setopt($ch, CURLOPT_HTTPHEADER, $pubnubHeaders);
curl_setopt($ch, CURLOPT_USERAGENT, "PHP");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 300);
curl_setopt($ch, CURLOPT_URL, $urlString);
if ($this->SSL) {
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 2);
curl_setopt($ch, CURLOPT_CAINFO, getcwd() . "/pubnub.com.pem");
}
$output = curl_exec($ch);
$curlError = curl_errno($ch);
$curlResponseCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
$JSONdecodedResponse = json_decode($output, true);
if ($JSONdecodedResponse != null)
return $JSONdecodedResponse;
elseif ($curlError == 28)
return "_PUBNUB_TIMEOUT";
elseif ($curlResponseCode == 400 || $curlResponseCode == 404)
return "_PUBNUB_MESSAGE_TOO_LARGE";
}
/**
* Encode
*
* @param string $part of url directories.
* @return string encoded string.
*/
private static function _encode($part)
{
$pieces = array_map('ArrowPush::_encode_char', str_split($part));
return implode('', $pieces);
}
/**
* Encode Char
*
* @param string $char val.
* @return string encoded char.
*/
private static function _encode_char($char)
{
if (strpos(' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?', $char) === false)
return $char;
else
return rawurlencode($char);
}
}
?>