Refs #11076. First implementation of websocket (without wss/ssl)

extension/Classes/Core/Constants.php

@@ -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';

extension/Classes/Core/Report/Link.php

@@ -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.

extension/Classes/Core/Report/Report.php

@@ -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;