Commit 8f9bd35d authored by Carsten  Rose's avatar Carsten Rose
Browse files

Merge branch 'F11076_AS_websocket' into 'develop'

F11076 as websocket

See merge request !278
parents f5013b3b f07a0c9d
Pipeline #3754 passed with stages
in 4 minutes and 24 seconds
......@@ -494,9 +494,15 @@ Columns of the upper / outer level result can be accessed via variables in two w
The STORE_RECORD will always be merged with previous content. The Level Keys are unique.
.. important::
Multiple columns, with the same column name, can't be accessed individually. Only the last column is available.
Retrieving the *final* value of :ref:`special-column-names` is possible via '{{&<column>:R}}. Example::
.. important::
Retrieving the *final* value of :ref:`special-column-names` is possible via '{{&<column>:R}} (there is an '&' direct behind '{{')
Example::
10.sql = SELECT 'p:home&form=Person|s|b:success|t:Edit' AS _link
10.20.sql = SELECT '{{link:R}}', '{{&link:R}}'
......@@ -599,12 +605,12 @@ One exception are columns, whose name starts with '_'. E.g.::
content will be hidden.
* The fourth column (alias name 'link') uses a QFQ special column name. Here, only in this example, it has no
further meaning.
* All columns in a row with the same special column name (e.g. ``... AS _page``) will have the same column name: 'page'.
To access individual columns a uniq column title can be added::
* All columns in a row, with the same special column name (e.g. ``... AS _page``) will have the same column name: 'page'.
To access individual columns a uniq column title is necessary and can be added ``|_column1``::
10.sql = SELECT '..1..' AS '_page|column1', '..2..' AS '_page|column2'
Those columns can be accessed via ``{{10.column1}}`` , ``{{10.column2}}`` or ``{{column1:R}}`` , ``{{column2:R}}``
Those columns can be accessed via ``{{10.column1}}`` , ``{{10.column2}}`` or (recommended) ``{{column1:R}}`` , ``{{column2:R}}``
* To skip wrapping via ``fbeg``, ``fsep``, ``fend`` for dedicated columns, add the keyword ``|_noWrap`` to the column alias.
Example::
......@@ -612,6 +618,7 @@ One exception are columns, whose name starts with '_'. E.g.::
Summary:
* Special column names always start with '_'.
* Columns starting with a '_' but not defined as as QFQ special column name are hidden(!) - in other words: they are
not **printed** as output.
......@@ -714,7 +721,9 @@ Column: _link
|x | |Copy to |y:[some content] |y:this will be copied |Click on it copies the value of 'y:' to the clipboard. Optional a file ('F:...') might be specified as source. |
| | |clipboard | | |See :ref:`copyToClipboard`. |
+---+---+--------------+-----------------------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| | |Dropdown menu |z |z||p:home|t:Home |Creates a dropdown menu. SEe :ref:`dropdownMenu`. |
| | |Dropdown menu |z |z||p:home|t:Home |Creates a dropdown menu. See :ref:`dropdownMenu`. |
+---+---+--------------+-----------------------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| | |websocket |w:ws://<host>:<port>/<path> | w:ws://localhost:123/demo |Send message given in 't:...' to websocket. See :ref:`websocket`. |
+---+---+--------------+-----------------------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
| | |Text |t:<text> |t:Firstname Lastname | |
+---+---+--------------+-----------------------------------+---------------------------+----------------------------------------------------------------------------------------------------------------------------------------+
......@@ -2183,6 +2192,45 @@ Line 6: A PDF download.
Line 7: A disabled menu entry.
.. _websocket:
WebSocket
---------
Sending messages via WebSocket and receiving the answer is done via: ::
SELECT 'w:ws://<host>:<port>/<path>|t:<message>' AS _websocket
Instead of '... AS _websocket' it's also possible to use '... AS _link'.
The answer is written to output and stored in the given column (in this case 'websocket' or 'link').
.. tip::
To suppress the direct output, add '_hide' to the column name::
SELECT 'w:ws://<host>:<port>/<path>|t:<message>' AS '_websocket|_hide'
.. tip::
To define a uniq column name (to access it later via STORE_RECORD)::
SELECT 'w:ws://<host>:<port>/<path>|t:<message>' AS '_websocket|myName'
.. tip::
Get the answer from STORE_RECORD by using '{{&...'. Check `access-column-values`_.
Example::
SELECT 'w:ws://<host>:<port>/<path>|t:<message>' AS '_websocket|myName'
Results:
'{{myName:R}}' >> 'w:ws://<host>:<port>/<path>|t:<message>'
'{{&myName:R}}' >> '<received socket answer>'
.. _drag_and_drop:
Drag and drop
......
......@@ -1603,6 +1603,7 @@ const COLUMN_IMG = "img";
const COLUMN_MAILTO = "mailto";
const COLUMN_SENDMAIL = "sendmail";
const COLUMN_VERTICAL = "vertical";
const COLUMN_WEBSOCKET = "websocket";
const COLUMN_NO_WRAP = "noWrap";
const COLUMN_HIDE = "hide";
......@@ -1758,6 +1759,7 @@ const TOKEN_UID = 'uid';
const TOKEN_DOWNLOAD = 'd';
const TOKEN_COPY_TO_CLIPBOARD = 'y';
const TOKEN_DROPDOWN = 'z';
const TOKEN_WEBSOCKET = 'w';
const TOKEN_TEXT = 't';
const TOKEN_ALT_TEXT = 'a';
......
......@@ -23,14 +23,14 @@
namespace IMATHUZH\Qfq\Core\Report;
use IMATHUZH\Qfq\Core\Helper\KeyValueStringParser;
use IMATHUZH\Qfq\Core\Helper\OnArray;
use IMATHUZH\Qfq\Core\Helper\Sanitize;
use IMATHUZH\Qfq\Core\Helper\Support;
use IMATHUZH\Qfq\Core\Helper\Token;
use IMATHUZH\Qfq\Core\Helper\Sanitize;
use IMATHUZH\Qfq\Core\Store\Sip;
use IMATHUZH\Qfq\Core\Store\Store;
use IMATHUZH\Qfq\Core\Report\WebSocket;
/*
* a:AltText
......@@ -77,7 +77,7 @@ use IMATHUZH\Qfq\Core\Store\Store;
* U:URL Param
* v:
* V:
* w:
* w:websocket
* W:Dimension
* x:Delete
* X:
......@@ -519,13 +519,56 @@ class Link {
return $this->renderLink(KeyValueStringParser::unparse($paramArr, PARAM_TOKEN_DELIMITER, PARAM_DELIMITER));
}
/**
* @param $str
* @return string
* @throws \UserFormException
* @throws \UserReportException
*/
public function processWebSocket($str) {
$websocket = new WebSocket();
$answer = '';
// str="w:wss://antmedia.math.uzh.ch:6334/test|t:<payload>|timeout:..."
$param = KeyValueStringParser::parse($str, PARAM_TOKEN_DELIMITER, PARAM_DELIMITER);
if (empty($param[TOKEN_WEBSOCKET]) || empty($param[TOKEN_TEXT])) {
throw new \UserReportException("Missing Websocket target or text to send", ERROR_MISSING_VALUE);
}
$urlParts = parse_url($param[TOKEN_WEBSOCKET]);
if (empty($urlParts['host']) || empty($urlParts['port']) || empty($urlParts['path'])) {
throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'Target URL incomplete',
ERROR_MESSAGE_TO_DEVELOPER =>
'host:' . $urlParts['host'] . ', ' .
'port:' . $urlParts['port'] . ', ' .
'path:' . $urlParts['path']])
, ERROR_MISSING_VALUE);
}
// Open Socket
if (false === $websocket->connect($urlParts['host'], $urlParts['port'], $urlParts['path'])) {
throw new \UserFormException(json_encode([ERROR_MESSAGE_TO_USER => 'Failed connect websocket',
ERROR_MESSAGE_TO_DEVELOPER =>
'host:' . $urlParts['host'] . ', ' .
'port:' . $urlParts['port'] . ', ' .
'path:' . $urlParts['path']])
, ERROR_MISSING_VALUE);
}
$answer = $websocket->sendData($param[TOKEN_TEXT]);
return $answer;
}
/**
* Build the whole link.
*
* @param string $str Qualifier with params. 'report'-syntax. F.e.: u:www.example.com|P:home.gif|t:Home"
*
* @return string The complete HTML encoded Link like
* <a href='http://example.com' class='external'><img src='iconf.gif' title='help text'>Description</a>
* <a href='http://example.com' class='external'><img src='icon.gif' title='help text'>Description</a>
* @throws \CodeException
* @throws \UserFormException
* @throws \UserReportException
......@@ -539,7 +582,18 @@ class Link {
return '';
}
// Check for dropdown menu
switch ($str[0] ?? '') {
case TOKEN_DROPDOWN:
// Check for dropdown menu
return $this->processDropdown($str);
break;
case TOKEN_WEBSOCKET:
return $this->processWebSocket($str);
break;
default:
break;
}
if (($str[0] ?? '') == TOKEN_DROPDOWN) {
return $this->processDropdown($str);
}
......@@ -673,7 +727,6 @@ class Link {
$flagArray = array();
// str="u:http://www.example.com|c:i|t:Hello World|q:Do you really want to delete the record 25:warn:yes:no"
// $param = explode(PARAM_DELIMITER, $str);
$param = KeyValueStringParser::explodeEscape(PARAM_DELIMITER, $str);
$param = $this->paramPriority($param);
......@@ -807,7 +860,6 @@ class Link {
NAME_DELETE => '',
NAME_MONITOR => '0',
NAME_COPY_TO_CLIPBOARD => '',
NAME_LINK_CLASS => '', // class name
NAME_LINK_CLASS_DEFAULT => '', // Depending of 'as page' or 'as url'. Only used if class is not explicit set.
......
......@@ -675,7 +675,7 @@ class Report {
/**
* Called with an array of column names.
* Each column name can be split in multiple string by '|': [s1[|s2[|s3]]]
* Each s1|s2|s3 can be: {title}, _{special colum name}, _hide, _noWrap, _={title}, _+{tag}, _<{tag1}><{tag2}>
* Each s1|s2|s3 can be: {title}, _{special column name}, _hide, _noWrap, _={title}, _+{tag}, _<{tag1}><{tag2}>
*
* Return an Array: newKeys[idx][C_FULL|C_TITLE|C_NO_WRAP|C_HIDE]
*
......@@ -906,7 +906,7 @@ class Report {
* @param string $columnValue
* @param string $full_level
* @param string $rowIndex
* @param $flagOutput
* @param bool $flagOutput
*
* @return string rendered column
* @throws \CodeException
......@@ -938,6 +938,7 @@ class Report {
switch ($columnName) {
case COLUMN_LINK:
case COLUMN_WEBSOCKET:
$content .= $this->link->renderLink($columnValue);
break;
......
<?php
namespace IMATHUZH\Qfq\Core\Report;
/**
* Simple WebSocket client.
*
* Class WebSocket
* @package qfq
*
* @author Simon Samtleben <foo@bloatless.org>
* @version 2.0
*/
class WebSocket {
/**
* @var string $host
*/
private $host;
/**
* @var int $port
*/
private $port;
/**
* @var string $path
*/
private $path;
/**
* @var string $origin
*/
private $origin;
/**
* @var resource $socket
*/
private $socket = null;
/**
* @var bool $connected
*/
private $connected = false;
/**
* @var string $target
*/
private $target = '';
public function __destruct() {
$this->disconnect();
}
/**
* Sends data to remote server.
*
* @param string $data
* @param string $type
* @param bool $masked
* @return bool
*/
public function sendData(string $data, string $type = 'text', bool $masked = true) {
if ($this->connected === false) {
trigger_error("Not connected", E_USER_WARNING);
return false;
}
if (!is_string($data)) {
trigger_error("Not a string data was given.", E_USER_WARNING);
return false;
}
if (strlen($data) === 0) {
return false;
}
$res = @fwrite($this->socket, $this->hybi10Encode($data, $type, $masked));
if ($res === 0 || $res === false) {
return false;
}
$buffer = ' ';
$answer = '';
while ($buffer !== '') {
$buffer = fread($this->socket, 512);// drop?
$answer .= $buffer;
}
// Decode WebSocket answer
if ($answer !== '') {
$data = $this->hybi10Decode($answer);
$answer = $data['payload'];
}
return $answer;
}
/**
* @param string $data
* @param string $type
* @param bool $masked
* @return mixed|string
*/
public function sendAndWait(string $data, string $type = 'text', bool $masked = true) {
if ($this->sendData($data, $type, $masked)) {
// to be implemented - for now it waits a bit and sends a predefined message
usleep(250);
$msg = json_decode($data, true);
$msg['type'] = 'response';
$msg['token'] = 'some_random_unusable_token';
return json_decode($msg);
} else {
// error!
return '';
}
/* $this->connected = false;
// send ping:
$data = 'ping?';
@fwrite($this->socket, $this->hybi10Encode($data, 'ping', true));
$response = @fread($this->socket, 300);
if (empty($response)) {
return false;
}
$response = $this->hybi10Decode($response);
if (!is_array($response)) {
return false;
}
if (!isset($response['type']) || $response['type'] !== 'pong') {
return false;
}
$this->connected = true;
return true;*/
}
/**
* Connects to a websocket server.
*
* @param string $host
* @param int $port
* @param string $path
* @param string $origin
* @return bool
*/
public function connect(string $host, int $port, string $path, string $origin = '') {
$this->host = $host;
$this->port = $port;
$this->path = $path;
$this->origin = $origin;
$key = base64_encode($this->generateRandomString(16, false, true));
$header = "GET " . $path . " HTTP/1.1\r\n";
$header .= "Host: " . $host . ":" . $port . "\r\n";
$header .= "Upgrade: websocket\r\n";
$header .= "Connection: Upgrade\r\n";
$header .= "Sec-WebSocket-Key: " . $key . "\r\n";
if (!empty($origin)) {
$header .= "Sec-WebSocket-Origin: " . $origin . "\r\n";
}
$header .= "Sec-WebSocket-Version: 13\r\n\r\n";
$this->socket = fsockopen($host, $port, $errno, $errstr, 2);
if ($this->socket === false) {
return false;
}
socket_set_timeout($this->socket, 0, 10000);
@fwrite($this->socket, $header);
$response = @fread($this->socket, 1500);
preg_match('#Sec-WebSocket-Accept:\s(.*)$#mU', $response, $matches);
if ($matches) {
$keyAccept = trim($matches[1]);
$expectedResponse = base64_encode(pack('H*', sha1($key . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11')));
$this->connected = ($keyAccept === $expectedResponse) ? true : false;
}
return $this->connected;
}
/**
* Checks if connection to webserver is active.
*
* @return bool
*/
public function checkConnection() {
$this->connected = false;
// send ping:
$data = 'ping?';
@fwrite($this->socket, $this->hybi10Encode($data, 'ping', true));
$response = @fread($this->socket, 300);
if (empty($response)) {
return false;
}
$response = $this->hybi10Decode($response);
if (!is_array($response)) {
return false;
}
if (!isset($response['type']) || $response['type'] !== 'pong') {
return false;
}
$this->connected = true;
return true;
}
/**
* Disconnects from websocket server.
*
* @return void
*/
public function disconnect() {
$this->connected = false;
is_resource($this->socket) && fclose($this->socket);
}
/**
* Reconnects to previously connected websocket server.
*
* @return void
*/
public function reconnect() {
sleep(10);
$this->connected = false;
fclose($this->socket);
$this->connect($this->host, $this->port, $this->path, $this->origin);
}
/**
* Generates a random string.
*
* @param int $length
* @param bool $addSpaces
* @param bool $addNumbers
* @return string
*/
private function generateRandomString(int $length = 10, bool $addSpaces = true, bool $addNumbers = true) {
$characters = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ!"§$%&/()=[]{}';
$useChars = [];
// select some random chars:
for ($i = 0; $i < $length; $i++) {
$useChars[] = $characters[mt_rand(0, strlen($characters) - 1)];
}
// add spaces and numbers:
if ($addSpaces === true) {
array_push($useChars, ' ', ' ', ' ', ' ', ' ', ' ');
}
if ($addNumbers === true) {
array_push($useChars, rand(0, 9), rand(0, 9), rand(0, 9));
}
shuffle($useChars);
$randomString = trim(implode('', $useChars));
$randomString = substr($randomString, 0, $length);
return $randomString;
}
/**
* Encodes data according to the WebSocket protocol standard.
*
* @param string $payload
* @param string $type
* @param bool $masked
* @return string
*/
private function hybi10Encode(string $payload, string $type = 'text', bool $masked = true) {
$frameHead = [];
$payloadLength = strlen($payload);
switch ($type) {
case 'text':
// first byte indicates FIN, Text-Frame (10000001):
$frameHead[0] = 129;
break;
case 'close':
// first byte indicates FIN, Close Frame(10001000):
$frameHead[0] = 136;
break;
case 'ping':
// first byte indicates FIN, Ping frame (10001001):
$frameHead[0] = 137;
break;
case 'pong':
// first byte indicates FIN, Pong frame (10001010):
$frameHead[0] = 138;
break;
}
// set mask and payload length (using 1, 3 or 9 bytes)
if ($payloadLength > 65535) {
$payloadLengthBin = str_split(sprintf('%064b', $payloadLength), 8);
$frameHead[1] = ($masked === true) ? 255 : 127;
for ($i = 0; $i < 8; $i++) {
$frameHead[$i + 2] = bindec($payloadLengthBin[$i]);
}
// most significant bit MUST be 0 (close connection if frame too big)
if ($frameHead[2] > 127) {
$this->disconnect();
throw new \RuntimeException('Invalid payload. Could not encode frame.');
}
} elseif ($payloadLength > 125) {
$payloadLengthBin = str_split(sprintf('%016b', $payloadLength), 8);
$frameHead[1] = ($masked === true) ? 254 : 126;
$frameHead[2] = bindec($payloadLengthBin[0]);
$frameHead[3] = bindec($payloadLengthBin[1]);
} else {
$frameHead[1] = ($masked === true) ? $payloadLength + 128 : $payloadLength;
}
// convert frame-head to string:
foreach (array_keys($frameHead) as $i) {
$frameHead[$i] = chr($frameHead[$i]);
}
if ($masked === true) {
// generate a random mask:
$mask = [];
for ($i = 0; $i < 4; $i++) {
$mask[$i] = chr(rand(0, 255));
}
$frameHead = array_merge($frameHead, $mask);
}
$frame = implode('', $frameHead);
// append payload to frame:
for ($i = 0; $i < $payloadLength; $i++) {
$frame .= ($masked === true) ? $payload[$i] ^ $mask[$i % 4] : $payload[$i];
}
return $frame;
}
/**
* Decodes a received frame/string according to the WebSocket protocol standards.
*
* @param string $data
* @return array
*/
private function hybi10Decode(string $data) {
$unmaskedPayload = '';
$decodedData = [];
// estimate frame type:
$firstByteBinary = sprintf('%08b', ord($data[0]));
$secondByteBinary = sprintf('%08b', ord($data[1]));
$opcode = bindec(substr($firstByteBinary, 4, 4));
$isMasked = ($secondByteBinary[0] == '1') ? true : false;
$payloadLength = ord($data[1]) & 127;