phpmqtt.php,PhpMQTT.php

namespace emitter;

/*

PhpMQTT

A simple php class to connect/publish/subscribe to an MQTT broker

*/

/*

Licence

Copyright (c) 2010 Blue Rhinos Consulting | Andrew Milsted

andrew@bluerhinos.co.uk | http://www.bluerhinos.co.uk

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

THE SOFTWARE.

*/

/* PhpMQTT */

use qhelpers\Benchmark;

class PhpMQTT

{

private $socket; /* holds the socket*/

private $msgid = 1; /* counter for message id */

public $keepalive = 10; /* default keepalive timmer */

public $timesinceping; /* host unix time, used to detect disconects */

public $topics = array(); /* used to store currently subscribed topics */

public $debug = false; /* should output debug messages */

public $address; /* broker address */

public $port; /* broker port */

public $clientid; /* client id sent to brocker */

public $will; /* stores the will of the client */

private $username; /* stores username */

private $password; /* stores password */

public $cafile;

private $_subscribe_cnt = 0;

public function __construct($address, $port, $clientid, $cafile = NULL)

{

$this->broker($address, $port, $clientid, $cafile);

}

/* sets the broker details */

private function broker($address, $port, $clientid, $cafile = NULL)

{

$this->address = $address;

$this->port = $port;

$this->clientid = $clientid;

$this->cafile = $cafile;

}

private function connect_auto($clean = true, $will = NULL, $username = NULL, $password = NULL)

{

while ($this->connect($clean, $will, $username, $password) == false) {

sleep(10);

}

return true;

}

/* connects to the broker

inputs: $clean: should the client send a clean session flag */

public function connect($clean = true, $will = NULL, $username = NULL, $password = NULL)

{

if($will)

{

$this->will = $will;

}

if($username)

{

$this->username = $username;

}

if($password)

{

$this->password = $password;

}

if($this->cafile)

{

$socketContext = stream_context_create(["ssl" => [

"verify_peer_name" => true,

"cafile" => $this->cafile

]]);

$this->socket = stream_socket_client("tls://" . $this->address . ":" . $this->port, $errno, $errstr, 60, STREAM_CLIENT_CONNECT, $socketContext);

}

else

{

$this->socket = stream_socket_client("tcp://" . $this->address . ":" . $this->port, $errno, $errstr, 60, STREAM_CLIENT_CONNECT);

}

if(!$this->socket)

{

if($this->debug)

{

error_log("stream_socket_create() $errno, $errstr \n");

}

throw new \Exception("stream_socket_create fail error no is $errno");

// return false;

}

stream_set_timeout($this->socket, 5);

stream_set_blocking($this->socket, 0);

$i = 0;

$buffer = "";

$buffer .= chr(0x00);

$i++;

$buffer .= chr(0x06);

$i++;

$buffer .= chr(0x4d);

$i++;

$buffer .= chr(0x51);

$i++;

$buffer .= chr(0x49);

$i++;

$buffer .= chr(0x73);

$i++;

$buffer .= chr(0x64);

$i++;

$buffer .= chr(0x70);

$i++;

$buffer .= chr(0x03);

$i++;

//No Will

$var = 0;

if($clean)

$var += 2;

//Add will info to header

if($this->will != NULL) {

$var += 4; // Set will flag

$var += ($this->will['qos'] << 3); //Set will qos

if($this->will['retain'])

$var += 32; //Set will retain

}

if($this->username != NULL)

$var += 128; //Add username to header

if($this->password != NULL)

$var += 64; //Add password to header

$buffer .= chr($var);

$i++;

//Keep alive

$buffer .= chr($this->keepalive >> 8);

$i++;

$buffer .= chr($this->keepalive & 0xff);

$i++;

$buffer .= $this->strwritestring($this->clientid, $i);

//Adding will to payload

if($this->will != NULL) {

$buffer .= $this->strwritestring($this->will['topic'], $i);

$buffer .= $this->strwritestring($this->will['content'], $i);

}

if($this->username)

$buffer .= $this->strwritestring($this->username, $i);

if($this->password)

$buffer .= $this->strwritestring($this->password, $i);

$head = " ";

$head{0} = chr(0x10);

$head{1} = chr($i);

fwrite($this->socket, $head, 2);

fwrite($this->socket, $buffer);

$string = $this->read(4);

if(ord($string{0}) >> 4 == 2 && $string{3} == chr(0))

{

if($this->debug)

{

echo "Connected to Broker\n";

}

}

else

{

error_log(sprintf("Connection failed! (Error: 0x%02x 0x%02x)\n",

ord($string{0}), ord($string{3})));

return false;

}

$this->timesinceping = time();

return true;

}

/* read: reads in so many bytes */

private function read($int = 8192, $nb = false)

{

//print_r(socket_get_status($this->socket));

if( $this->socket == false )

{

throw new LoseConnException('lost conn exception');

}

$string = "";

$togo = $int;

if($nb)

{

return fread($this->socket, $togo);

}

while (!feof($this->socket) && $togo > 0)

{

$fread = fread($this->socket, $togo);

$string .= $fread;

$togo = $int - strlen($string);

}

return $string;

}

/**

* note: this method will read stored message if configure

*

* subscribe: subscribes to topics

*/

public function subscribe($topics, $qos = 0)

{

$this->_subscribe_cnt++;

$i = 0;

$buffer = "";

$id = $this->msgid;

$buffer .= chr($id >> 8);

$i++;

$buffer .= chr($id % 256);

$i++;

if( $this->_subscribe_cnt > 1 )

{

echo 'subscribe cnt: ', $this->_subscribe_cnt, PHP_EOL;

}

foreach($topics as $channel => &$topic) {

assert(is_callable($topic['function']), 'function must be callable');

if( $this->_subscribe_cnt > 1 )

{

$key = $this->assembleKey($topic, true);

unset($this->topics[$key]);

}

$key = $this->assembleKey($topic, !($this->_subscribe_cnt > 1));

$buffer .= $this->strwritestring($key, $i);

$buffer .= chr($topic["qos"]);

$i++;

$this->topics[$key] = $topic;

$this->topics[$key]['cnt'] = 0;

}

$cmd = 0x80;

//$qos

$cmd += ($qos << 1);

$head = chr($cmd);

$head .= chr($i);

fwrite($this->socket, $head, 2);

fwrite($this->socket, $buffer, $i);

$this->readStoredMessage();

}

static public function PackStringWithLength($str)

{

$len = strlen($str);

return pack('n', $len) . $str;

}

public function unsubscribe($topics)

{

$unsubscribe_cmd = 0x0A << 4;

$payload = '';

# Payload

foreach ($topics as $key => $topic)

{

$payload .= self::PackStringWithLength($key);

$topic_key = $this->assembleKey($topic, !($this->_subscribe_cnt > 1));

unset( $this->topics[$topic_key] );

}

$payload_length = strlen($payload);

$remaining_length_bytes = $this->getRemainingBytes($payload_length);

$header = chr($unsubscribe_cmd) . $remaining_length_bytes;

$msg = $header. $payload;

$length = $this->getFullLength($remaining_length_bytes, $payload_length);

$write_length = fwrite($this->socket, $msg, $length);

return $length == $write_length;

}

private function getFullLength($remaining_length_bytes, $remaining_length)

{

$cmd_length = 1;

$rl_length = strlen($remaining_length_bytes);

return $cmd_length + $rl_length + $remaining_length;

}

private function getRemainingBytes($length)

{

$string = "";

do{

$digit = $length % 0x80;

$length = $length >> 7;

// if there are more digits to encode, set the top bit of this digit

if ( $length > 0 ) $digit = ($digit | 0x80);

$string .= chr($digit);

} while ( $length > 0 );

return $string;

}

private function assembleKey($topic_info, $retrieve_stored_message = false)

{

$key = $topic_info['key'] . '/' . $topic_info['channel'] . '/?';// . 'from=1576813100&until=1576813107&last=10';

if($retrieve_stored_message) {

foreach(['from', 'until', 'last'] as $field) {

if(!empty($topic_info[$field])) {

$key .= $field . '=' . $topic_info[$field] . '&';

}

}

}

return rtrim($key, '&');

}

private function getMessageTopicInfo($strMessage)

{

foreach($this->topics as $topic_key => $topic) {

$replaced_topic = '/' . str_replace("#", ".*", str_replace("+", "[^\/]*", str_replace("/", "\/", str_replace("$", '\$', $topic['channel'])))) . '/';

if(preg_match($replaced_topic, $strMessage)) {

return $topic_key;

}

}

return false;

}

/* ping: sends a keep alive ping */

private function ping()

{

//$head = " ";

$head = chr(0xc0);

$head .= chr(0x00);

fwrite($this->socket, $head, 2);

if($this->debug)

{

echo "ping sent\n";

}

}

/* disconnect: sends a proper disconect cmd */

private function disconnect()

{

$head = " ";

$head{0} = chr(0xe0);

$head{1} = chr(0x00);

fwrite($this->socket, $head, 2);

}

/* close: sends a proper disconect, then closes the socket */

public function close()

{

$this->disconnect();

stream_socket_shutdown($this->socket, STREAM_SHUT_WR);

}

/* publish: publishes $content on a $topic */

public function publish($topic, $content, $qos = 0, $retain = 0)

{

$i = 0;

$buffer = "";

$buffer .= $this->strwritestring($topic, $i);

//$buffer .= $this->strwritestring($content,$i);

if($qos)

{

$id = $this->msgid++;

$buffer .= chr($id >> 8);

$i++;

$buffer .= chr($id % 256);

$i++;

}

$buffer .= $content;

$i += strlen($content);

$head = " ";

$cmd = 0x30;

if($qos)

{

$cmd += $qos << 1;

}

if($retain)

{

$cmd += 1;

}

$head{0} = chr($cmd);

$head .= $this->setmsglength($i);

$ret = fwrite($this->socket, $head, strlen($head));

if( 0 != $ret )

{

$ret = fwrite($this->socket, $buffer, $i);

if( 0 == $ret )

{

throw new \Exception("lose connection or other exception");

}

return $ret;

}

else

{

throw new \Exception("lose connection or other exception");

}

return false;

}

/* message: processes a recieved topic */

private function message($msg)

{

$tlen = (ord($msg{0}) << 8) + ord($msg{1});

$topic = substr($msg, 2, $tlen);

$msg = substr($msg, ($tlen + 2));

$found = 0;

foreach($this->topics as $key => $top)

{

$replaced_topic = '/' . str_replace("#", ".*", str_replace("+", "[^\/]*", str_replace("/", "\/", str_replace("$", '\$', $topic)))) . '/';

if(preg_match($replaced_topic, $key))

{

if(is_callable($top['function']))

{

call_user_func($top['function'], $topic, $msg);

$found = 1;

}

}

}

if($this->debug && !$found)

{

echo "msg recieved but no match in subscriptions\n";

}

}

/* proc: the processing loop for an "allways on" client

set true when you are doing other stuff in the loop good for watching something else at the same time */

public function proc($loop = true)

{

//$byte = fgetc($this->socket);

if(feof($this->socket))

{

if($this->debug)

{

echo "eof receive going to reconnect for good measure\n";

}

fclose($this->socket);

$this->connect_auto(false);

if(count($this->topics))

{

$this->subscribe($this->topics);

}

}

$byte = $this->read(1, true);

if(!strlen($byte))

{

if($loop)

{

usleep(100);

}

}

else

{

$cmd = (int)(ord($byte) / 16);

if($this->debug)

{

echo "Recevid: $cmd\n";

}

$multiplier = 1;

$value = 0;

do {

$digit = ord($this->read(1));

$value += ($digit & 127) * $multiplier;

$multiplier *= 128;

} while (($digit & 128) != 0);

if($this->debug)

{

echo "Fetching: $value\n";

}

if($value)

{

$string = $this->read($value);

}

if($cmd)

{

switch ($cmd)

{

case 3:

$this->message($string);

break;

}

$this->timesinceping = time();

}

}

if($this->timesinceping < (time() - $this->keepalive))

{

if($this->debug)

{

echo "not found something so ping\n";

}

$this->ping();

}

if($this->timesinceping < (time() - ($this->keepalive * 2)))

{

if($this->debug)

{

echo "not seen a package in a while, disconnecting\n";

}

fclose($this->socket);

$this->connect_auto(false);

if(count($this->topics))

{

$this->subscribe($this->topics);

}

}

return 1;

}

/* getmsglength: */

private function getmsglength(&$msg, &$i)

{

$multiplier = 1;

$value = 0;

do {

$digit = ord($msg{$i});

$value += ($digit & 127) * $multiplier;

$multiplier *= 128;

$i++;

} while (($digit & 128) != 0);

return $value;

}

/* setmsglength: */

private function setmsglength($len)

{

$string = "";

do {

$digit = $len % 128;

$len = $len >> 7;

// if there are more digits to encode, set the top bit of this digit

if($len > 0)

$digit = ($digit | 0x80);

$string .= chr($digit);

} while ($len > 0);

return $string;

}

/* strwritestring: writes a string to a buffer */

private function strwritestring($str, &$i)

{

//$ret = " ";

$len = strlen($str);

$msb = $len >> 8;

$lsb = $len % 256;

$ret = chr($msb);

$ret .= chr($lsb);

$ret .= $str;

$i += ($len + 2);

return $ret;

}

private function printstr($string)

{

$strlen = strlen($string);

for($j = 0; $j < $strlen; $j++) {

$num = ord($string{$j});

if($num > 31)

$chr = $string{$j}; else $chr = " ";

printf("%4d: %08b : 0x%02x : %s \n", $j, $num, $num, $chr);

}

}

private function readStoredMessage(): void

{

while (!feof($this->socket))

{

$string = $this->read(2);

$bytes = ord(substr($string, 1, 1));

$strMessage = trim($this->read($bytes));

$strMessage = trim(substr($strMessage, 1));

$topic_key = $this->getMessageTopicInfo($strMessage);

if($topic_key)

{

$topic_info = $this->topics[$topic_key];

call_user_func($topic_info['function'], $topic_info['channel'], substr($strMessage, strlen($topic_info['channel']) + 3));

if(++$this->topics[$topic_key]['cnt'] >= $this->topics[$topic_key]['last'])

{

return;

}

}

else

{

return;

}

}

}

}

一键复制

编辑

Web IDE

原始数据

按行查看

历史