diff --git a/CHANGELOG.md b/CHANGELOG.md index 89707d2..db8aef0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,9 @@ +# Change Log + +All notable changes to this project will be documented in this file. -# 2.1 +The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). -- Minimum php version 7.4 -- Fix php 8.0 compatibilites for NativeArray -- Adapt code style for php 7.4, adding types +## [Unreleased] -# 2.0 - -- All classes are declared under Sentiweb\Rserve namespace allowing PSR-4 autoloading -- Parsers are now individualized into classes -- A Parser instance can be directly used as second argument of evalString() to replace default parser (see example) - -# Before TDB \ No newline at end of file +Initial release. Forked from https://github.com/cturbelin/rserve-php. This is v2.1 of that package, adapted to PHP 7.3. diff --git a/composer.json b/composer.json index ecbfc58..abc31d5 100644 --- a/composer.json +++ b/composer.json @@ -1,39 +1,39 @@ { - "name": "cturbelin/rserve-php", - "type": "library", - "description": "Rserve client library for PHP", - "keywords": ["R","Rserve","Stats"], - "homepage": "https://github.com/cturbelin/rserve-php", - "licence": "LGPL-2.1", - "authors": [ - { - "name": "Clément Turbelin", - "email": "clement.turbelin@gmail.com" - } - ], - "require": { - "php": ">=7.4" - }, - "require-dev": { - "phpunit/phpunit": "^9", - "symplify/easy-coding-standard": "^12.0" - }, - "autoload": { - "files": ["src/lib/helpers.php"], - "psr-4": { - "Sentiweb\\Rserve\\": "src/", - "Sentiweb\\Rserve\\Tests\\":"tests/" - } - }, - "autoload-dev": { - "psr-4" : { - "Sentiweb\\Rserve\\Tests\\":"tests/" - } - }, - "scripts": { - "test": [ - "parallel-lint . --exclude vendor --exclude doc", - "phpunit --verbose" - ] - } + "name": "piogaw/rserve-php", + "type": "library", + "description": "Rserve client library for PHP", + "keywords": ["R", "Rserve", "Stats"], + "homepage": "https://github.com/cturbelin/rserve-php", + "licence": "LGPL-2.1", + "authors": [ + { + "name": "Clément Turbelin", + "email": "clement.turbelin@gmail.com" + } + ], + "require": { + "php": ">=7.3" + }, + "require-dev": { + "phpunit/phpunit": "^9", + "symplify/easy-coding-standard": "^12.0" + }, + "autoload": { + "files": ["src/lib/helpers.php"], + "psr-4": { + "Sentiweb\\Rserve\\": "src/", + "Sentiweb\\Rserve\\Tests\\": "tests/" + } + }, + "autoload-dev": { + "psr-4": { + "Sentiweb\\Rserve\\Tests\\": "tests/" + } + }, + "scripts": { + "test": [ + "parallel-lint . --exclude vendor --exclude doc", + "phpunit --verbose" + ] + } } diff --git a/src/Connection.php b/src/Connection.php index a0171f0..64ade42 100644 --- a/src/Connection.php +++ b/src/Connection.php @@ -4,558 +4,667 @@ /** * Rserve client for PHP - * Supports Rserve protocol 0103 only (used by Rserve 0.5 and higher) + * Supports Rserve protocol 0103 only (used by Rserve 0.5 and higher). + * * @author Clément TURBELIN * Developped using code from Simple Rserve client for PHP by Simon Urbanek Licensed under GPL v2 or at your option v3 */ -require_once __DIR__ . '/lib/helpers.php'; +require_once __DIR__ . "/lib/helpers.php"; -use Sentiweb\Rserve\Parser; use Sentiweb\Rserve\Parser\NativeArray; /** - * Handle Connection and communicating with Rserve instance (QAP1 protocol) - * @author Clément Turbelin + * Handle Connection and communicating with Rserve instance (QAP1 protocol). * + * @author Clément Turbelin */ -class Connection { - - const DT_INT = 1; - const DT_CHAR = 2; - const DT_DOUBLE = 3; - const DT_STRING = 4; - const DT_BYTESTREAM = 5; - const DT_SEXP = 10; - const DT_ARRAY = 11; - - const DEFAULT_HOST = '127.0.0.1'; - const DEFAULT_PORT = 6311; - - /** this is a flag saying that the contents is large (>0xfffff0) and hence uses 56-bit length field */ - const DT_LARGE = 64; - - const CMD_login = 0x001; - const CMD_voidEval = 0x002; - const CMD_eval = 0x003; - const CMD_shutdown = 0x004; - const CMD_openFile = 0x010; - const CMD_createFile = 0x011; - const CMD_closeFile = 0x012; - const CMD_readFile = 0x013; - const CMD_writeFile = 0x014; - const CMD_removeFile = 0x015; - const CMD_setSEXP = 0x020; - const CMD_assignSEXP = 0x021; - - const CMD_setBufferSize = 0x081; - const CMD_setEncoding = 0x082; - - const CMD_detachSession = 0x030; - const CMD_detachedVoidEval = 0x031; - const CMD_attachSession = 0x032; - - // control commands since 0.6-0 - const CMD_ctrlEval = 0x42; - const CMD_ctrlSource = 0x45; - const CMD_ctrlShutdown = 0x44; - - const CMD_Response = 0x10000; - - // errors as returned by Rserve - const ERR_auth_failed = 0x41; - const ERR_conn_broken = 0x42; - const ERR_inv_cmd = 0x43; - const ERR_inv_par = 0x44; - const ERR_Rerror = 0x45; - const ERR_IOerror = 0x46; - const ERR_not_open = 0x47; - const ERR_access_denied = 0x48; - const ERR_unsupported_cmd=0x49; - const ERR_unknown_cmd = 0x4a; - const ERR_data_overflow = 0x4b; - const ERR_object_too_big = 0x4c; - const ERR_out_of_mem = 0x4d; - const ERR_ctrl_closed = 0x4e; - const ERR_session_busy = 0x50; - const ERR_detach_failed = 0x51; - - public static $machine_is_bigendian = null; - - private static $init = false; - - private $host; - private int $port; - private $socket; - private $auth_request; - private $auth_method; - - private bool $debug; - - private bool $async; - - private ?string $username; - - private ?string $password; - - /** - * Encoding to use - * @var string - */ - private ?string $encoding; - - // Internal parser, used as default parser - // To handle internal operations - private $parser; - - /** - * initialization of the library - */ - public static function init() { - if( self::$init ) { - return; - } - $m = pack('s', 1); - self::$machine_is_bigendian = ($m[0] == 0); - self::$init = true; - } - - /** - * @param mixed host or a Session instance or an array of parameters - * @param int $port if 0 then host is interpreted as unix socket, - * @param array params - * - * If host is an array then further arguments are ignored - * (all options should be passed using this array) - * - * If - * - */ - public function __construct($host=self::DEFAULT_HOST, int $port = self::DEFAULT_PORT, $params=[]) { - if( !self::$init ) { - self::init(); - } - $session = null; - - if( is_array($host) ) { - $params = $host; - $this->host = $params['host'] ?? self::DEFAULT_HOST; - $this->port = (int)($params['port'] ?? self::DEFAULT_PORT); - - } elseif(is_object($host) AND $host instanceof Session) { - $session = $host->key; - $this->port = (int)$host->port; - $host = $host->host; - if( !$host ) { - $host = self::DEFAULT_HOST; - } - $this->host = $host; - } else { - $this->host = $host; - $this->port = $port; - } - $this->debug = (bool)($params['debug'] ?? false); - $this->async = (bool)($params['async'] ?? false); - $this->username = $params['username'] ?? null; - $this->password = $params['password'] ?? null; - $this->encoding = $params['encoding'] ?? null; - - // Internal parser used for basic command - $this->parser = new NativeArray(); - - $this->openSocket($session); - } - - /** - * Open a new socket to Rserv - * @return resource socket - */ - private function openSocket($session_key = null) { - - if( $this->port == 0 ) { - $socket = socket_create(AF_UNIX, SOCK_STREAM, 0); - } else { - $socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); - } - if( !$socket ) { - throw new Exception('Unable to create socket ['.socket_strerror(socket_last_error()).']'); - } - //socket_set_option($socket, SOL_TCP, SO_DEBUG,2); - - $ok = socket_connect($socket, $this->host, $this->port); - if( !$ok ) { - throw new Exception('Unable to connect ['.socket_strerror(socket_last_error()).']'); - } - $this->socket = $socket; - if( !is_null($session_key) ) { - // Try to resume session - $n = socket_send($socket, $session_key, 32, 0); - if($n < 32) { - throw new Exception('Unable to send session key'); - } - $r = $this->getResponse(); - if($r['is_error']) { - $msg = $this->getErrorMessage($r['error']); - throw new Exception('invalid session key : '.$msg); - } - return; - } - - // No session, check handshake - $buf = ''; - $n = socket_recv($socket, $buf, 32, 0); - if( $n < 32 || strncmp($buf, 'Rsrv', 4) != 0 ) { - throw new Exception('Invalid response from server.'); - } - $rv = substr($buf, 4, 4); - if( strcmp($rv, '0103') != 0 ) { - throw new Exception('Unsupported protocol version.'); - } - $key=null; - $this->auth_request = false; - for($i = 12; $i < 32; $i += 4) { - $attr = substr($buf, $i, 4); - if($attr == 'ARpt') { - $this->auth_request = true; - $this->auth_method = 'plain'; - - } elseif($attr == 'ARuc') { - $this->auth_request = true; - $this->auth_method = 'crypt'; - } - if($attr[0] === 'K') { - $key = substr($attr, 1, 3); - } - } - if($this->auth_request === true) { - if($this->auth_method=="plain") $this->login(); else $this->login($key); - } - - if($this->encoding) { - $this->setEncoding($this->encoding); - } - } - - /** - * Allow access to socket - */ - public function getSocket() { - return $this->socket; - } - - /** - * Set Asynchronous mode - * @param bool $async - */ - public function setAsync($async) { - $this->async = (bool)$async; - } - - /** - * - * Parse a response from Rserve - * @param $buf - * @param Parser $parser - * @return mixed parsed results - */ - private function parseResponse($buf, $parser=null) { - $type = _rserve_int8($buf, 0); - if($type != self::DT_SEXP) { // Check Data type of the packet - throw new Exception('Unexpected packet Data type (expect DT_SEXP)', $buf); - } - $i = 4; // + 4 bytes (Data part HEADER) - $r = null; - if( is_null($parser) ) { - $r = $this->parser->parse($buf, $i); - } else { - $r = $parser->parse($buf, $i); - } - return $r; - } - - - /** - * Login to rserve - * Similar to RSlogin http://rforge.net/doc/packages/RSclient/Rclient.html - * Inspired from https://github.com/SurajGupta/RserveCLI2/blob/master/RServeCLI2/Qap1.cs - * https://github.com/SurajGupta/RserveCLI2/blob/master/RServeCLI2/RConnection.cs - * @param string $salt - */ - public function login($salt=null) { - switch ( $this->auth_method ) - { - case "plain": - break; - case "crypt": - if( !$salt ) { - throw new Exception("Should pass the salt for login"); - } - $this->password=crypt($this->password, $salt); - break; - default: - throw new Exception( "Could not interpret login method '{$this->auth_method}'" ); - } - $data = _rserve_make_data(self::DT_STRING, "{$this->username}\n{$this->password}"); - $r = $this->sendCommand(self::CMD_login, $data ); - if( !$r['is_error'] ) { - return true; - } - throw new Exception( "Could not login" ); - } - - /** - * Evaluate a string as an R code and return result - * @param string $string - * @param int $parser - */ - public function evalString($string, $parser = null) { - - $data = _rserve_make_data(self::DT_STRING, $string); - - $r = $this->sendCommand(self::CMD_eval, $data ); - if($this->async) { - return true; - } - if( !$r['is_error'] ) { - return $this->parseResponse($r['contents'], $parser); - } - throw new Exception('unable to evaluate', $r); - } - - /** - * Detach the current session from the current connection. - * Save envirnoment could be attached to another R connection later - * @return array with session_key used to - * @throws Exception - */ - public function detachSession() { - $r = $this->sendCommand(self::CMD_detachSession, null); - if( !$r['is_error'] ) { - $x = $r['contents']; - if( strlen($x) != (32 + 3 * 4) ) { - throw new Exception('Invalid response to detach'); - } - - $port = _rserve_int32($x, 4); - $key = substr($x, 12); - $session = new Session($key, $this->host, $port); - - return $session; - } - throw new Exception('Unable to detach sesssion', $r); - } - - /** - * Assign a value to a symbol in R - * @param string $symbol name of the variable to set (should be compliant with R syntax !) - * @param REXP $value value to set - */ - public function assign($symbol, REXP $value) { - $symbol = (string)$symbol; - $data = _rserve_make_data(self::DT_STRING, $symbol); - $serializer = new Serializer(); - $bin = $serializer->serialize($value); - $data .= _rserve_make_data(self::DT_SEXP, $bin); - $r = $this->sendCommand(self::CMD_assignSEXP, $data); - return $r; - } - - public function setEncoding($encoding) { - $this->sendCommand(self::CMD_setEncoding, _rserve_make_data(self::DT_STRING, $encoding)); - } - - /** - * Get the response from a command - * @param resource $socket - * @return array contents - */ - protected function getResponse() { - $header = null; - $n = socket_recv($this->socket, $header, 16, 0); - if ($n != 16) { - // header should be sent in one block of 16 bytes - return false; - } - $len = _rserve_int32($header, 4); - $ltg = $len; // length to get - $buf = ''; - while ($ltg > 0) { - $n = socket_recv($this->socket, $b2, $ltg, 0); - if ($n > 0) { - $buf .= $b2; - unset($b2); - $ltg -= $n; - } else { - break; - } - } - $res = _rserve_int32($header); - return([ - 'code'=>$res, - 'is_error'=>($res & 15) != 1, - 'error'=>($res >> 24) & 127, - 'header'=>$header, - 'contents'=>$buf - ]); - } - - /** - * Create a new connection to Rserve for async calls - * @return Rserve_Connection - */ - public function newConnection() { - $newConnection = clone($this); - $newConnection->openSocket(); - return $newConnection; - } - - - /** - * Get results from an eval command in async mode - * @param Parser $parser, if null use internal parser - * @return mixed contents of response - */ - public function getResults($parser = null) { - $r = $this->getResponse(); - if( !$r['is_error'] ) { - return $this->parseResponse($r['contents'], $parser); - } - throw new Exception('unable to evaluate', $r); - } - - /** - * Close the current connection - */ - public function close() { - return socket_close($this->socket); - } - - /** - * send a command to Rserve - * @param int $command command code - * @param string $data data packets - * @return int if $async, true - */ - protected function sendCommand($command, $data) { - - $pkt = _rserve_make_packet($command, $data); - - if($this->debug) { - $this->debugPacket($pkt); - } - - socket_send($this->socket, $pkt, strlen($pkt), 0); - - if($this->async) { - return true; - } - // get response - return $this->getResponse(); - } - - /** - * Debug a Rserve packet - * @param array|string $packet - */ - public function debugPacket($packet) { - /* - [0] (int) command - [4] (int) length of the message (bits 0-31) - [8] (int) offset of the data part - [12] (int) length of the message (bits 32-63) - */ - if(is_array($packet)) { - $buf = $packet['contents']; - $header = $packet['header']; - } else { - $header = substr($packet, 0, 16); - $buf = substr($packet, 16); - } - $command = _rserve_int32($header, 0); - $lengthLow = _rserve_int32($header, 4); - $offset = _rserve_int32($header, 8); - $lenghtHigh = _rserve_int32($header, 12); - if($command & self::CMD_Response) { - $is_error = $command & 15 != 1; - $cmd = 'CMD Response'.(($is_error) ? 'OK' : 'Error'); - $err = ($command >> 24) & 0x7F; - } else { - $cmd = dechex($command) & 0xFFF; - } - echo '[header:<'.$cmd.' Length:'.dechex($lenghtHigh).'-'.dechex($lengthLow).' offset'.$offset.">\n"; - $len = strlen($buf); - $i = 0; - while($len > 0) { - $type = _rserve_int8($buf, $i); - $m_len = _rserve_int24($buf, $i+1); - $i += 4; - $i += $m_len; - $len -= $m_len + 4; - echo 'data:<'.$this->getDataTypeTitle($type).' length:'.$m_len.">\n"; - } - echo "]\n"; - } - - /** - * Data Type value to label - * @param int $x - */ - public function getDataTypeTitle($x) { - switch($x) { - case self::DT_INT : - $m = 'int'; - break; - case self::DT_CHAR : - $m = 'char'; - break; - case self::DT_DOUBLE : - $m = 'double'; - break; - case self::DT_STRING : - $m = 'string'; - break; - case self::DT_BYTESTREAM : - $m = 'stream'; - break; - - case self::DT_SEXP : - $m = 'sexp'; - break; - - case self::DT_ARRAY : - $m = 'array'; - break; - default: - $m = 'unknown'; - } - return $m; - } - - /** - * Translate an error code to an error message - * @param int $code - */ - public function getErrorMessage($code) { - switch($code) { - case self::ERR_auth_failed : $m = 'auth failed'; break; - case self::ERR_conn_broken : $m = 'connexion broken'; break; - case self::ERR_inv_cmd : $m = 'invalid command'; break; - case self::ERR_inv_par : $m = 'invalid parameter'; break; - case self::ERR_Rerror : $m = 'R error'; break; - case self::ERR_IOerror : $m = 'IO error'; break; - case self::ERR_not_open : $m = 'not open'; break; - case self::ERR_access_denied : $m = 'access denied'; break; - case self::ERR_unsupported_cmd: $m = 'unsupported command'; break; - case self::ERR_unknown_cmd : $m = 'unknown command'; break; - case self::ERR_data_overflow : $m = 'data overflow'; break; - case self::ERR_object_too_big : $m = 'object too big'; break; - case self::ERR_out_of_mem : $m = 'out of memory' ; break; - case self::ERR_ctrl_closed : $m = 'control closed'; break; - case self::ERR_session_busy : $m = 'session busy'; break; - case self::ERR_detach_failed : $m = 'detach failed'; break; - default: - $m = 'unknown error'; - } - return $m; - } - +class Connection +{ + public const DT_INT = 1; + public const DT_CHAR = 2; + public const DT_DOUBLE = 3; + public const DT_STRING = 4; + public const DT_BYTESTREAM = 5; + public const DT_SEXP = 10; + public const DT_ARRAY = 11; + + public const DEFAULT_HOST = "127.0.0.1"; + public const DEFAULT_PORT = 6311; + + /** this is a flag saying that the contents is large (>0xfffff0) and hence uses 56-bit length field */ + public const DT_LARGE = 64; + + public const CMD_login = 0x001; + public const CMD_voidEval = 0x002; + public const CMD_eval = 0x003; + public const CMD_shutdown = 0x004; + public const CMD_openFile = 0x010; + public const CMD_createFile = 0x011; + public const CMD_closeFile = 0x012; + public const CMD_readFile = 0x013; + public const CMD_writeFile = 0x014; + public const CMD_removeFile = 0x015; + public const CMD_setSEXP = 0x020; + public const CMD_assignSEXP = 0x021; + + public const CMD_setBufferSize = 0x081; + public const CMD_setEncoding = 0x082; + + public const CMD_detachSession = 0x030; + public const CMD_detachedVoidEval = 0x031; + public const CMD_attachSession = 0x032; + + // control commands since 0.6-0 + public const CMD_ctrlEval = 0x42; + public const CMD_ctrlSource = 0x45; + public const CMD_ctrlShutdown = 0x44; + + public const CMD_Response = 0x10000; + + // errors as returned by Rserve + public const ERR_auth_failed = 0x41; + public const ERR_conn_broken = 0x42; + public const ERR_inv_cmd = 0x43; + public const ERR_inv_par = 0x44; + public const ERR_Rerror = 0x45; + public const ERR_IOerror = 0x46; + public const ERR_not_open = 0x47; + public const ERR_access_denied = 0x48; + public const ERR_unsupported_cmd = 0x49; + public const ERR_unknown_cmd = 0x4a; + public const ERR_data_overflow = 0x4b; + public const ERR_object_too_big = 0x4c; + public const ERR_out_of_mem = 0x4d; + public const ERR_ctrl_closed = 0x4e; + public const ERR_session_busy = 0x50; + public const ERR_detach_failed = 0x51; + + public static $machine_is_bigendian; + + private static $init = false; + + private $host; + /** @var int */ + private $port; + private $socket; + private $auth_request; + private $auth_method; + + /** @var bool */ + private $debug; + + /** @var bool */ + private $async; + + /** @var string|null */ + private $username; + + /** @var string|null */ + private $password; + + /** + * Encoding to use. + * + * @var string|null + */ + private $encoding; + + // Internal parser, used as default parser + // To handle internal operations + private $parser; + + /** + * initialization of the library. + */ + public static function init() + { + if (self::$init) { + return; + } + $m = pack("s", 1); + self::$machine_is_bigendian = $m[0] == 0; + self::$init = true; + } + + /** + * @param mixed host or a Session instance or an array of parameters + * @param int $port if 0 then host is interpreted as unix socket, + * @param array params + * + * If host is an array then further arguments are ignored + * (all options should be passed using this array) + * + * If + */ + public function __construct( + $host = self::DEFAULT_HOST, + int $port = self::DEFAULT_PORT, + $params = [] + ) { + if (!self::$init) { + self::init(); + } + $session = null; + + if (is_array($host)) { + $params = $host; + $this->host = $params["host"] ?? self::DEFAULT_HOST; + $this->port = (int) ($params["port"] ?? self::DEFAULT_PORT); + } elseif (is_object($host) and $host instanceof Session) { + $session = $host->key; + $this->port = (int) $host->port; + $host = $host->host; + if (!$host) { + $host = self::DEFAULT_HOST; + } + $this->host = $host; + } else { + $this->host = $host; + $this->port = $port; + } + $this->debug = (bool) ($params["debug"] ?? false); + $this->async = (bool) ($params["async"] ?? false); + $this->username = $params["username"] ?? null; + $this->password = $params["password"] ?? null; + $this->encoding = $params["encoding"] ?? null; + + // Internal parser used for basic command + $this->parser = new NativeArray(); + + $this->openSocket($session); + } + + /** + * Open a new socket to Rserv. + * + * @return resource socket + */ + private function openSocket($session_key = null) + { + if ($this->port == 0) { + $socket = socket_create(AF_UNIX, SOCK_STREAM, 0); + } else { + $socket = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); + } + if (!$socket) { + throw new Exception( + "Unable to create socket [" . + socket_strerror(socket_last_error()) . + "]" + ); + } + // socket_set_option($socket, SOL_TCP, SO_DEBUG,2); + + $ok = socket_connect($socket, $this->host, $this->port); + if (!$ok) { + throw new Exception( + "Unable to connect [" . + socket_strerror(socket_last_error()) . + "]" + ); + } + $this->socket = $socket; + if (!is_null($session_key)) { + // Try to resume session + $n = socket_send($socket, $session_key, 32, 0); + if ($n < 32) { + throw new Exception("Unable to send session key"); + } + $r = $this->getResponse(); + if ($r["is_error"]) { + $msg = $this->getErrorMessage($r["error"]); + throw new Exception("invalid session key : " . $msg); + } + + return; + } + + // No session, check handshake + $buf = ""; + $n = socket_recv($socket, $buf, 32, 0); + if ($n < 32 || strncmp($buf, "Rsrv", 4) != 0) { + throw new Exception("Invalid response from server."); + } + $rv = substr($buf, 4, 4); + if (strcmp($rv, "0103") != 0) { + throw new Exception("Unsupported protocol version."); + } + $key = null; + $this->auth_request = false; + for ($i = 12; $i < 32; $i += 4) { + $attr = substr($buf, $i, 4); + if ($attr == "ARpt") { + $this->auth_request = true; + $this->auth_method = "plain"; + } elseif ($attr == "ARuc") { + $this->auth_request = true; + $this->auth_method = "crypt"; + } + if ($attr[0] === "K") { + $key = substr($attr, 1, 3); + } + } + if ($this->auth_request === true) { + if ($this->auth_method == "plain") { + $this->login(); + } else { + $this->login($key); + } + } + + if ($this->encoding) { + $this->setEncoding($this->encoding); + } + } + + /** + * Allow access to socket. + */ + public function getSocket() + { + return $this->socket; + } + + /** + * Set Asynchronous mode. + * + * @param bool $async + */ + public function setAsync($async) + { + $this->async = (bool) $async; + } + + /** + * Parse a response from Rserve. + * + * @param Parser $parser + * + * @return mixed parsed results + */ + private function parseResponse($buf, $parser = null) + { + $type = _rserve_int8($buf, 0); + if ($type != self::DT_SEXP) { + // Check Data type of the packet + throw new Exception( + "Unexpected packet Data type (expect DT_SEXP)", + $buf + ); + } + $i = 4; // + 4 bytes (Data part HEADER) + $r = null; + if (is_null($parser)) { + $r = $this->parser->parse($buf, $i); + } else { + $r = $parser->parse($buf, $i); + } + + return $r; + } + + /** + * Login to rserve + * Similar to RSlogin http://rforge.net/doc/packages/RSclient/Rclient.html + * Inspired from https://github.com/SurajGupta/RserveCLI2/blob/master/RServeCLI2/Qap1.cs + * https://github.com/SurajGupta/RserveCLI2/blob/master/RServeCLI2/RConnection.cs. + * + * @param string $salt + */ + public function login($salt = null) + { + switch ($this->auth_method) { + case "plain": + break; + case "crypt": + if (!$salt) { + throw new Exception("Should pass the salt for login"); + } + $this->password = crypt($this->password, $salt); + break; + default: + throw new Exception( + "Could not interpret login method '{$this->auth_method}'" + ); + } + $data = _rserve_make_data( + self::DT_STRING, + "{$this->username}\n{$this->password}" + ); + $r = $this->sendCommand(self::CMD_login, $data); + if (!$r["is_error"]) { + return true; + } + throw new Exception("Could not login"); + } + + /** + * Evaluate a string as an R code and return result. + * + * @param string $string + * @param int $parser + */ + public function evalString($string, $parser = null) + { + $data = _rserve_make_data(self::DT_STRING, $string); + + $r = $this->sendCommand(self::CMD_eval, $data); + if ($this->async) { + return true; + } + if (!$r["is_error"]) { + return $this->parseResponse($r["contents"], $parser); + } + throw new Exception("unable to evaluate", $r); + } + + /** + * Detach the current session from the current connection. + * Save envirnoment could be attached to another R connection later. + * + * @return array with session_key used to + * + * @throws Exception + */ + public function detachSession() + { + $r = $this->sendCommand(self::CMD_detachSession, null); + if (!$r["is_error"]) { + $x = $r["contents"]; + if (strlen($x) != 32 + 3 * 4) { + throw new Exception("Invalid response to detach"); + } + + $port = _rserve_int32($x, 4); + $key = substr($x, 12); + $session = new Session($key, $this->host, $port); + + return $session; + } + throw new Exception("Unable to detach sesssion", $r); + } + + /** + * Assign a value to a symbol in R. + * + * @param string $symbol name of the variable to set (should be compliant with R syntax !) + * @param REXP $value value to set + */ + public function assign($symbol, REXP $value) + { + $symbol = (string) $symbol; + $data = _rserve_make_data(self::DT_STRING, $symbol); + $serializer = new Serializer(); + $bin = $serializer->serialize($value); + $data .= _rserve_make_data(self::DT_SEXP, $bin); + $r = $this->sendCommand(self::CMD_assignSEXP, $data); + + return $r; + } + + public function setEncoding($encoding) + { + $this->sendCommand( + self::CMD_setEncoding, + _rserve_make_data(self::DT_STRING, $encoding) + ); + } + + /** + * Get the response from a command. + * + * @return array contents + */ + protected function getResponse() + { + $header = null; + $n = socket_recv($this->socket, $header, 16, 0); + if ($n != 16) { + // header should be sent in one block of 16 bytes + return false; + } + $len = _rserve_int32($header, 4); + $ltg = $len; // length to get + $buf = ""; + while ($ltg > 0) { + $n = socket_recv($this->socket, $b2, $ltg, 0); + if ($n > 0) { + $buf .= $b2; + unset($b2); + $ltg -= $n; + } else { + break; + } + } + $res = _rserve_int32($header); + + return [ + "code" => $res, + "is_error" => ($res & 15) != 1, + "error" => ($res >> 24) & 127, + "header" => $header, + "contents" => $buf, + ]; + } + + /** + * Create a new connection to Rserve for async calls. + * + * @return Rserve_Connection + */ + public function newConnection() + { + $newConnection = clone $this; + $newConnection->openSocket(); + + return $newConnection; + } + + /** + * Get results from an eval command in async mode. + * + * @param Parser $parser, if null use internal parser + * + * @return mixed contents of response + */ + public function getResults($parser = null) + { + $r = $this->getResponse(); + if (!$r["is_error"]) { + return $this->parseResponse($r["contents"], $parser); + } + throw new Exception("unable to evaluate", $r); + } + + /** + * Close the current connection. + */ + public function close() + { + return socket_close($this->socket); + } + + /** + * send a command to Rserve. + * + * @param int $command command code + * @param string $data data packets + * + * @return int if $async, true + */ + protected function sendCommand($command, $data) + { + $pkt = _rserve_make_packet($command, $data); + + if ($this->debug) { + $this->debugPacket($pkt); + } + + socket_send($this->socket, $pkt, strlen($pkt), 0); + + if ($this->async) { + return true; + } + + // get response + return $this->getResponse(); + } + + /** + * Debug a Rserve packet. + * + * @param array|string $packet + */ + public function debugPacket($packet) + { + /* + [0] (int) command + [4] (int) length of the message (bits 0-31) + [8] (int) offset of the data part + [12] (int) length of the message (bits 32-63) + */ + if (is_array($packet)) { + $buf = $packet["contents"]; + $header = $packet["header"]; + } else { + $header = substr($packet, 0, 16); + $buf = substr($packet, 16); + } + $command = _rserve_int32($header, 0); + $lengthLow = _rserve_int32($header, 4); + $offset = _rserve_int32($header, 8); + $lenghtHigh = _rserve_int32($header, 12); + if ($command & self::CMD_Response) { + $is_error = $command & (15 != 1); + $cmd = "CMD Response" . ($is_error ? "OK" : "Error"); + $err = ($command >> 24) & 0x7f; + } else { + $cmd = dechex($command) & 0xfff; + } + echo "[header:<" . + $cmd . + " Length:" . + dechex($lenghtHigh) . + "-" . + dechex($lengthLow) . + " offset" . + $offset . + ">\n"; + $len = strlen($buf); + $i = 0; + while ($len > 0) { + $type = _rserve_int8($buf, $i); + $m_len = _rserve_int24($buf, $i + 1); + $i += 4; + $i += $m_len; + $len -= $m_len + 4; + echo "data:<" . + $this->getDataTypeTitle($type) . + " length:" . + $m_len . + ">\n"; + } + echo "]\n"; + } + + /** + * Data Type value to label. + * + * @param int $x + */ + public function getDataTypeTitle($x) + { + switch ($x) { + case self::DT_INT: + $m = "int"; + break; + case self::DT_CHAR: + $m = "char"; + break; + case self::DT_DOUBLE: + $m = "double"; + break; + case self::DT_STRING: + $m = "string"; + break; + case self::DT_BYTESTREAM: + $m = "stream"; + break; + + case self::DT_SEXP: + $m = "sexp"; + break; + + case self::DT_ARRAY: + $m = "array"; + break; + default: + $m = "unknown"; + } + + return $m; + } + + /** + * Translate an error code to an error message. + * + * @param int $code + */ + public function getErrorMessage($code) + { + switch ($code) { + case self::ERR_auth_failed: + $m = "auth failed"; + break; + case self::ERR_conn_broken: + $m = "connexion broken"; + break; + case self::ERR_inv_cmd: + $m = "invalid command"; + break; + case self::ERR_inv_par: + $m = "invalid parameter"; + break; + case self::ERR_Rerror: + $m = "R error"; + break; + case self::ERR_IOerror: + $m = "IO error"; + break; + case self::ERR_not_open: + $m = "not open"; + break; + case self::ERR_access_denied: + $m = "access denied"; + break; + case self::ERR_unsupported_cmd: + $m = "unsupported command"; + break; + case self::ERR_unknown_cmd: + $m = "unknown command"; + break; + case self::ERR_data_overflow: + $m = "data overflow"; + break; + case self::ERR_object_too_big: + $m = "object too big"; + break; + case self::ERR_out_of_mem: + $m = "out of memory"; + break; + case self::ERR_ctrl_closed: + $m = "control closed"; + break; + case self::ERR_session_busy: + $m = "session busy"; + break; + case self::ERR_detach_failed: + $m = "detach failed"; + break; + default: + $m = "unknown error"; + } + + return $m; + } } diff --git a/src/REXP/Vector.php b/src/REXP/Vector.php index b337a69..9427b24 100644 --- a/src/REXP/Vector.php +++ b/src/REXP/Vector.php @@ -1,12 +1,12 @@ values = []; - } - - /** - * return int - */ - public function length():int { - return( count($this->values) ); - } - - public function isVector():bool { - return true; - } - - public function setValues($values) { - $this->values = $values; - } - - public function getValues() { - return $this->values; - } - - /** - * Return dimensions length of the vector - * uses 'dim' attribute if exists or the length of the vector (one dimension vector) - */ - public function dim() { - /** - * @var Vector - */ - $dim = $this->getAttribute('dim'); - if( $dim ) { - return $dim->getValues(); - } - return [$this->length()]; - } - - /** - * Matrix is a multidimensionnal vector - */ - public function isMatrix() { - $dim = $this->dim(); - return count($dim) > 1; - } - - /** - * Get value - * @param unknown_type $index - */ - public function at($index) { - return $this->values[$index] ?? null; - } - - public function getType() { - return Parser::XT_VECTOR; - } - - public function toHTML() { - $s = '
'; - $dim = $this->dim(); - $n = $this->length(); - $s .= ''.Parser::xtName($this->getType()).''; - $s .= '['; - $s .= join(',', $dim); - $s .= ']'; - $s .= '
'; - if($n) { - $m = ($n > 20) ? 20 : $n; - for($i = 0; $i < $m; ++$i) { - $v = $this->values[$i]; - if(is_object($v) AND ($v instanceof REXP)) { - $v = $v->toHTML(); - } else { - $v = $this->valueToHTML($v); - } - $s .= '
'.$v.'
'; - } - } - $s .= '
'; - $s .= $this->attrToHTML(); - $s .= '
'; - return $s; - } - - /** - * HTML representation for a single value of the vector - * @param mixed $v - */ - protected function valueToHTML($v) { - return (string)$v; - } + * R Vector + */ +class Vector extends REXP +{ + /** @var array */ + protected $values; + + public function __construct() + { + $this->values = []; + } + + /** + * return int + */ + public function length(): int + { + return count($this->values); + } + + public function isVector(): bool + { + return true; + } + + public function setValues($values) + { + $this->values = $values; + } + + public function getValues() + { + return $this->values; + } + + /** + * Return dimensions length of the vector + * uses 'dim' attribute if exists or the length of the vector (one dimension vector) + */ + public function dim() + { + /** + * @var Vector + */ + $dim = $this->getAttribute("dim"); + if ($dim) { + return $dim->getValues(); + } + return [$this->length()]; + } + + /** + * Matrix is a multidimensionnal vector + */ + public function isMatrix() + { + $dim = $this->dim(); + return count($dim) > 1; + } + + /** + * Get value + * @param unknown_type $index + */ + public function at($index) + { + return $this->values[$index] ?? null; + } + + public function getType() + { + return Parser::XT_VECTOR; + } + + public function toHTML() + { + $s = '
'; + $dim = $this->dim(); + $n = $this->length(); + $s .= + '' . + Parser::xtName($this->getType()) . + ""; + $s .= "["; + $s .= join(",", $dim); + $s .= "]"; + $s .= '
'; + if ($n) { + $m = $n > 20 ? 20 : $n; + for ($i = 0; $i < $m; ++$i) { + $v = $this->values[$i]; + if (is_object($v) and $v instanceof REXP) { + $v = $v->toHTML(); + } else { + $v = $this->valueToHTML($v); + } + $s .= '
' . $v . "
"; + } + } + $s .= "
"; + $s .= $this->attrToHTML(); + $s .= "
"; + return $s; + } + + /** + * HTML representation for a single value of the vector + * @param mixed $v + */ + protected function valueToHTML($v) + { + return (string) $v; + } } diff --git a/src/lib/helpers.php b/src/lib/helpers.php index a0fb4af..ab787ad 100644 --- a/src/lib/helpers.php +++ b/src/lib/helpers.php @@ -1,139 +1,183 @@ ->= 8; - $r .= chr($i & 255); - $i >>=8; - $r .= chr($i & 255); - $i >>=8; - $r .= chr($i & 255); - return $r; -} - -/* - * Create a 24 bit integer - * @return string binary representation of the int using 24 bits - */ -function _rserve_mkint24($i) { - $r = chr($i & 255); - $i >>= 8; - $r .= chr($i & 255); - $i >>=8; - $r .= chr($i & 255); - return $r; -} - -/** - * Create a binary representation of float to 64bits - * TODO: works only for intel endianess, should be adapted for no big endian proc - * @param double $v - */ -function _rserve_mkfloat64($v) { - return pack('d', $v); -} - -/** - * 64bit integer to Float - * @param $buf - * @param $o - */ -function _rserve_flt64($buf, $o = 0) { - $ss = substr($buf, $o, 8); - if (Connection::$machine_is_bigendian) { - for ($k = 0; $k < 7; $k++) { - $ss[7 - $k] = $buf[$o + $k]; - } - } - $r = unpack('d', substr($buf, $o, 8)); - return $r[1]; -} - -/** - * Create a packet for QAP1 message - * @param int $cmd command identifier - * @param string $string contents of the message - */ -function _rserve_make_packet($cmd, $data) { - // [0] (int) command - // [4] (int) length of the message (bits 0-31) - // [8] (int) offset of the data part - // [12] (int) length of the message (bits 32-63) - return _rserve_mkint32($cmd) . _rserve_mkint32(strlen($data)) . _rserve_mkint32(0) . _rserve_mkint32(0).$data; -} - -/** - * Make a data packet - * @param unknown_type $type - * @param unknown_type $string NULL terminated string - */ -function _rserve_make_data($type, $string) { - if($type == Connection::DT_STRING) { - $string .= chr(0); - } - $len = strlen($string); // Length of the binary string - $pad = ($len % 4); // Number of padding needed - if($pad > 0) { - $pad = 4 - $pad; - } - $len += $pad; - $s = chr($type & 255); // [0] Type - $s .= _rserve_mkint24($len); // [1] Length (24bits) - $s .= $string; // Data - if($pad) { - $s .= str_repeat(chr(0), $pad); - } - return $s; -} +>= 8; + $r .= chr($i & 255); + $i >>= 8; + $r .= chr($i & 255); + $i >>= 8; + $r .= chr($i & 255); + + return $r; + } +} + +/* + * Create a 24 bit integer + * @return string binary representation of the int using 24 bits + */ +if (!function_exists("_rserve_mkint24")) { + function _rserve_mkint24($i) + { + $r = chr($i & 255); + $i >>= 8; + $r .= chr($i & 255); + $i >>= 8; + $r .= chr($i & 255); + + return $r; + } +} + +/* + * Create a binary representation of float to 64bits + * TODO: works only for intel endianess, should be adapted for no big endian proc + * @param double $v + */ +if (!function_exists("_rserve_mkfloat64")) { + function _rserve_mkfloat64($v) + { + return pack("d", $v); + } +} + +/* + * 64bit integer to Float + * @param $buf + * @param $o + */ +if (!function_exists("_rserve_flt64")) { + function _rserve_flt64($buf, $o = 0) + { + $ss = substr($buf, $o, 8); + if (Connection::$machine_is_bigendian) { + for ($k = 0; $k < 7; $k++) { + $ss[7 - $k] = $buf[$o + $k]; + } + } + $r = unpack("d", substr($buf, $o, 8)); + + return $r[1]; + } +} + +/* + * Create a packet for QAP1 message + * @param int $cmd command identifier + * @param string $string contents of the message + */ +if (!function_exists("_rserve_make_packet")) { + function _rserve_make_packet($cmd, $data) + { + // [0] (int) command + // [4] (int) length of the message (bits 0-31) + // [8] (int) offset of the data part + // [12] (int) length of the message (bits 32-63) + return _rserve_mkint32($cmd) . + _rserve_mkint32(strlen($data)) . + _rserve_mkint32(0) . + _rserve_mkint32(0) . + $data; + } +} + +/* + * Make a data packet + * @param unknown_type $type + * @param unknown_type $string NULL terminated string + */ +if (!function_exists("_rserve_make_data")) { + function _rserve_make_data($type, $string) + { + if ($type == Connection::DT_STRING) { + $string .= chr(0); + } + $len = strlen($string); // Length of the binary string + $pad = $len % 4; // Number of padding needed + if ($pad > 0) { + $pad = 4 - $pad; + } + $len += $pad; + $s = chr($type & 255); // [0] Type + $s .= _rserve_mkint24($len); // [1] Length (24bits) + $s .= $string; // Data + if ($pad) { + $s .= str_repeat(chr(0), $pad); + } + + return $s; + } +} diff --git a/tests/BaseTest.php b/tests/BaseTest.php index d0c8bd8..71e36e4 100644 --- a/tests/BaseTest.php +++ b/tests/BaseTest.php @@ -9,18 +9,21 @@ use Sentiweb\Rserve\Connection; -class BaseTest extends TestCase { - - protected ConnectionManager $connectionManager; +class BaseTest extends TestCase +{ + /** @var ConnectionManager */ + protected $connectionManager; - /** - * - */ - protected function setUp():void { + /** + * + */ + protected function setUp(): void + { $this->connectionManager = new ConnectionManager(); - } + } - protected function getConnection($withAuth=false): ?Connection { + protected function getConnection($withAuth = false): ?Connection + { return $this->connectionManager->create($withAuth); } @@ -29,12 +32,13 @@ protected function getConnection($withAuth=false): ?Connection { * * @return string */ - protected function getRandomString():string { + protected function getRandomString(): string + { // random id - $random = ''; - for ($i = 0; $i < 10; ++$i) { - $random .= dechex(mt_rand()); - } - return uniqid($random, true); + $random = ""; + for ($i = 0; $i < 10; ++$i) { + $random .= dechex(mt_rand()); + } + return uniqid($random, true); } -} \ No newline at end of file +} diff --git a/tests/ConnectionManager.php b/tests/ConnectionManager.php index e6a5990..4b76598 100644 --- a/tests/ConnectionManager.php +++ b/tests/ConnectionManager.php @@ -1,61 +1,65 @@ host = $this->getvar('RSERVE_HOST'); + $this->host = $this->getvar("RSERVE_HOST"); - $port = $this->getvar('RSERVE_PORT'); - if($port) { - if($port == '0' || $port == 'unix' || $port == 'socket') { + $port = $this->getvar("RSERVE_PORT"); + if ($port) { + if ($port == "0" || $port == "unix" || $port == "socket") { $this->port = 0; } - if($port == '') { + if ($port == "") { $this->port = Connection::DEFAULT_PORT; } else { - $this->port = (int)$port; + $this->port = (int) $port; } } - $this->username = $this->getvar('RSERVE_USER'); - $this->password = $this->getvar('RSERVE_PASS'); + $this->username = $this->getvar("RSERVE_USER"); + $this->password = $this->getvar("RSERVE_PASS"); } - protected function getvar(string $name):?string { - if(defined($name)) { + protected function getvar(string $name): ?string + { + if (defined($name)) { return constant($name); } $value = getenv($name); return $value !== false ? $value : null; } - public function create(bool $requireAuth=false): ?Connection { - if(!$this->host) { + public function create(bool $requireAuth = false): ?Connection + { + if (!$this->host) { return null; } - if(!$this->username && $requireAuth) { + if (!$this->username && $requireAuth) { return null; } $params = []; - if($this->username) { - $params['username'] = $this->username; - $params['password'] = $this->password; + if ($this->username) { + $params["username"] = $this->username; + $params["password"] = $this->password; } return new Connection($this->host, $this->port, $params); } - }