<?php /*-*- mode: php; tab-width:4 -*-*/
/* java_Protocol.php -- PHP/Java Bridge protocol implementation
Copyright (C) 2003-2007 Jost Boekemeier
This file is part of the PHP/Java Bridge.
The PHP/Java Bridge ("the library") is free software; you can
redistribute it and/or modify it under the terms of the GNU General
Public License as published by the Free Software Foundation; either
version 2, or (at your option) any later version.
The library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with the PHP/Java Bridge; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA.
Linking this file statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version. */
require_once ("${JAVA_BASE}/Options.inc");
require_once ("${JAVA_BASE}/Client.inc");
/**
* @access private
*/
class java_SocketChannel {
public $peer, $protocol;
private $channelName, $host;
function java_SocketChannel($peer, $protocol, $host, $channelName) {
$this->peer = $peer;
$this->protocol = $protocol;
$this->host = $host;
$this->channelName = $channelName;
}
function fwrite($data) {
return fwrite($this->peer, $data);
}
function fread($size) {
return fread($this->peer, $size);
}
function keepAlive() {
// keep alive, required by protocol
$this->fwrite("<F p=\"A\" />");
$this->fread(10); // <F p="A"/>
}
}
/**
* @access private
*/
class java_EmptyPipeChannel {
function open($handler) {
if (false) $handler = $handler;
throw new java_RuntimeException("protocol error: socket channel names must not start with a slash");
}
function getName() {
return null;
}
function keepAlive() {}
}
/**
* @access private
*/
class java_PipeChannel extends java_EmptyPipeChannel {
public $peer, $peerr, $peerr_desc, $name;
public $fifo, $fifor;
public $iname, $oname;
function java_PipeChannel($name) {
$this->name = $name;
$this->iname = $this->name . ".i";
$mask = umask(0);
$this->fifor = posix_mkfifo($this->iname, 0666);
$this->oname = $this->name . ".o";
$this->fifo = posix_mkfifo($this->oname, 0666);
umask($mask);
}
function open($handler) {
if (false) $handler = $handler;
$this->peerr = fopen($this->iname, "r");
$this->peerr_desc = array($this->peerr);
stream_set_blocking($this->peerr, false);
stream_set_timeout($this->peerr, -1);
$this->peer = fopen($this->oname, "w");
unlink($this->iname);
unlink($this->oname);
unlink($this->name);
stream_set_timeout($this->peer, -1);
return $this;
}
function fwrite($data) {
return fwrite($this->peer, $data);
}
function fread($size) {
static $empty = NULL;
stream_select($this->peerr_desc, $empty, $empty, 1677216);
return fread($this->peerr, $size);
}
function getName() {
return $this->name;
}
}
/**
* @access private
*/
class java_SocketHandler {
public $protocol, $channel;
function java_SocketHandler($protocol, $channel) {
$this->protocol = $protocol;
$this->channel = $channel;
}
function write($data) {
return $this->channel->fwrite($data);
}
function read($size) {
return $this->channel->fread($size);
}
function redirect() {}
function keepAlive() {
$this->channel->keepAlive();
}
}
/**
* @access private
*/
class java_HttpHandler extends java_SocketHandler {
public $headers;
public $redirect;
public $context, $ssl, $port; // used by reopen
public $host; // used when creating a socket channel lazily. the port# is passed via X_JAVABRIDGE_CHANNEL
public $socket; // we write to the socket directly and keep the pipe channel for later use
function createPipeChannel($host, $pipe_dir) {
if(!is_null($pipe_dir) && ($host == "127.0.0.1" || (substr($host,0,9) == "localhost")))
return new java_PipeChannel(tempnam($pipe_dir, ".php_java_bridge"));
return new java_EmptyPipeChannel();
}
function close() {
fclose($this->socket);
}
function open() {
$errno = null; $errstr = null;
/* Do not pfsockopen here, the J2EE server may not be able to handle
hundreds of persistent connections to the servlet very well */
$socket = fsockopen("{$this->ssl}{$this->host}", $this->port, $errno, $errstr, 30);
if (!$socket) throw new java_RuntimeException("Could not connect to the J2EE server {$this->ssl}{$this->host}:{$this->port}. Please start it, for example with the command: \"java -jar JavaBridge.jar SERVLET:8080 3 JavaBridge.log\" or, if the back end has been compiled to native code, with \"modules/java SERVLET:8080 3 JavaBridge.log\". Error message: $errstr ($errno)\n");
stream_set_timeout($socket, -1);
return $socket;
}
function java_HttpHandler($protocol, $ssl, $host, $port) {
$this->protocol = $protocol;
$this->ssl = $ssl;
$this->host = $host;
$this->port = $port;
$this->channel = $this->createPipeChannel($host, $protocol->client->RUNTIME['PIPE_DIR']);
$this->socket = $this->open();
}
function getCookies() {
$str="";
$first=true;
foreach($_COOKIE as $k => $v) {
$str .= ($first ? "Cookie: $k=$v":"; $k=$v");
$first=false;
}
if(!$first) $str .= "\r\n";
return $str;
}
function getContextFromCgiEnvironment() {
$ctx = array_key_exists('X_JAVABRIDGE_CONTEXT', $_SERVER)
?$_SERVER['X_JAVABRIDGE_CONTEXT']
:null;
return $ctx;
}
function getChannelName() {
$name = $this->channel->getName();
return !is_null($name) ? sprintf("X_JAVABRIDGE_CHANNEL: %s\r\n", $name) : null;
}
function getContext() {
$ctx = $this->getContextFromCgiEnvironment();
$context = "";
if($ctx) {
$context = sprintf("X_JAVABRIDGE_CONTEXT: %s\r\n", $ctx);
}
return $context;
}
function getWebAppInternal() {
// from createHttpHandler
$context = $this->protocol->webContext;
if(isset($context)) return $context;
/* Coerce a http://xyz.com/kontext/foo.php request to the back
end: http://xyz.com:{java_hosts[0]}/kontext/foo.php. For
example if we receive a request:
http://localhost/sessionSharing.php and java.servlet is On and
java.hosts is "127.0.0.1:8080" the code would connect to the
back end:
http://127.0.0.1:8080/sessionSharing.phpjavabridge. This
creates a cookie with PATH value "/". If java_servlet is User
the request http://localhost/myContext/sessionSharing.php the
code would connect to
http://127.0.0.1/myContext/sessionSharing.phpjavabridge and a
cookie with a PATH value "/myContext" would be created.
*/
return (JAVA_SERVLET == "User" &&
array_key_exists('PHP_SELF', $_SERVER) &&
array_key_exists('HTTP_HOST', $_SERVER))
? $_SERVER['PHP_SELF']."javabridge"
: null;
}
function getWebApp() {
$context = $this->getWebAppInternal();
if(is_null($context)) $context = JAVA_SERVLET;
if(is_null($context) || $context[0]!="/")
$context = "/JavaBridge/JavaBridge.phpjavabridge";
return $context;
}
function write($data) {
$compatibility = $this->protocol->client->RUNTIME["PARSER"]=="NATIVE"
? chr(0103-JAVA_PREFER_VALUES)
: chr(0100+JAVA_PREFER_VALUES);
if(is_int(JAVA_LOG_LEVEL)) {
$compatibility |= 128 | (7 & JAVA_LOG_LEVEL)<<2;
}
$this->headers = null;
$socket = $this->socket;
$len = 2 + strlen($data);
$webapp = $this->getWebApp();
$cookies = $this->getCookies();
$channel = $this->getChannelName();
$context = $this->getContext();
$redirect = $this->redirect;
$res = "PUT ";
$res .= $webapp;
$res .= " HTTP/1.0\r\n";
$res .= "Host: localhost\r\n";
$res .= "Content-Length: "; $res .= $len; $res .= "\r\n";
$res .= $context;
$res .= $cookies;
$res .= $redirect;
if(!is_null($channel)) $res .= $channel;
$res .= "\r\n";
$res .= "\177";
$res .= $compatibility;
$res .= $data;
$count = fwrite($socket, $res); fflush($socket);
return $count;
}
function doSetCookie($key, $val, $path) {
$path=trim($path);
$webapp = $this->getWebAppInternal(); if(!$webapp) $path="/";
setcookie($key, $val, 0, $path);
}
function parseHeaders() {
$this->headers = array();
while (($str = trim(fgets($this->socket, JAVA_RECV_SIZE)))) {
if($str[0]=='X') {
if(!strncasecmp("X_JAVABRIDGE_REDIRECT", $str, 21)) {
$this->headers["redirect"]=trim(substr($str, 22));
} else if(!strncasecmp("X_JAVABRIDGE_CONTEXT", $str, 20)) {
$this->headers["context"]=trim(substr($str, 21));
}
} else if($str[0]=='S') { // Set-Cookie:
if(!strncasecmp("SET-COOKIE", $str, 10)) {
$str=substr($str, 12);
$ar = explode(";", $str);
$cookie = explode("=",$ar[0]);
$path = "";
if(isset($ar[1])) $p=explode("=", $ar[1]);
if(isset($p)) $path=$p[1];
$this->doSetCookie($cookie[0], $cookie[1], $path);
}
} else if($str[0]=='C') { // Content-Length
if(!strncasecmp("CONTENT-LENGTH", $str, 14)) {
$this->headers["content_length"]=trim(substr($str, 15));
}
}
}
}
function read($size) {
if (false) $size = $size;
if(is_null($this->headers)) $this->parseHeaders();
$data = fread($this->socket, $this->headers['content_length']);
return $data;
}
function getChannel($channelName) {
$errstr = null; $errno = null;
if($channelName[0]=='/') return $this->channel->open($this);
$peer = pfsockopen($this->host, $channelName, $errno, $errstr, 30);
if (!$peer) throw new java_RuntimeException("Could not connect to the context server {$this->host}:{$channelName}. Error message: $errstr ($errno)\n");
stream_set_timeout($peer, -1);
return new java_SocketChannel($peer, $this->protocol, $this->host, $channelName);
}
function redirect() {
if(!isset($this->headers["redirect"])) { // no redirect received: must continue to send PUT requests
throw new java_RuntimeException("no Pipe- or SocketContextServer available.");
}
if(!isset($this->protocol->socketHandler)) {
$hostVec = java_Protocol::getHost();
$this->host = $hostVec[0];
$channelName = $this->headers["redirect"];
$context = $this->headers["context"];
$len = strlen($context);
$len0 = chr(0xFF);
$len1 = chr($len&0xFF); $len>>=8;
$len2 = chr($len&0xFF);
$this->protocol->socketHandler=new java_SocketHandler($this->protocol, $this->getChannel($channelName));
$this->protocol->write("\177${len0}${len1}${len2}${context}");
$this->context = sprintf("X_JAVABRIDGE_CONTEXT: %s\r\n", $context);
}
$this->close();
$this->protocol->handler = $this->protocol->socketHandler;
}
}
/**
* @access private
*/
class java_Protocol {
public $client;
public $webContext;
public $serverName;
function getOverrideHosts() {
if(array_key_exists('X_JAVABRIDGE_OVERRIDE_HOSTS', $_ENV)) {
$override = $_ENV['X_JAVABRIDGE_OVERRIDE_HOSTS'];
if(!is_null($override) && $override!='/') return $override;
}
// fcgi: override for redirect
return
array_key_exists('X_JAVABRIDGE_OVERRIDE_HOSTS_REDIRECT', $_SERVER)
?$_SERVER['X_JAVABRIDGE_OVERRIDE_HOSTS_REDIRECT']
:null;
}
static function getHost() {
static $host;
if(!isset($host)) {
$hosts = explode(";", JAVA_HOSTS);
$host = explode(":", $hosts[0]); // TODO: check host list
}
return $host;
}
function createHttpHandler() {
$hostVec = java_Protocol::getHost();
$host = $hostVec[0];
$port = $hostVec[1];
$overrideHosts = $this->getOverrideHosts();
$ssl = "";
if($overrideHosts) {
// handle "s:127.0.0.1:8080//JavaBridge/test.phpjavabridge"
// or "s:127.0.0.1:8080"
// or "/"
// or ""
$s=$overrideHosts;
if((strlen($s)>2) && ($s[1]==':')) {
if($s[0]=='s')
$ssl="ssl://";
$s = substr($s, 2);
}
$webCtx = strpos($s, "//");
if($webCtx)
$host = substr($s, 0, $webCtx);
else
$host = $s;
$idx = strpos($host, ':');
if($idx) {
if($webCtx)
$port = substr($host, $idx+1, $webCtx);
else
$port = substr($host, $idx+1);
$host = substr($host, 0, $idx);
} else {
$port = "8080";
}
if($webCtx) $webCtx = substr($s, $webCtx+1);
$this->webContext = $webCtx;
}
$this->serverName = "$host:$port";
return new java_HttpHandler($this, $ssl, $host, $port);
}
/**
* connect to a local channel (no servlet engine or app server)
*/
function createSimpleHandler($channelName) {
if(!is_string($channelName)) {
$errno = null; $errstr = null;
$peer = pfsockopen($host="127.0.0.1", $channelName, $errno, $errstr, 30);
} else {
$type = $channelName[0];
if($type=='@' || $type=='/') { // unix domain socket
if($type=='@') $channelName[0]="\0"; // abstract name space
$peer = pfsockopen($host="unix://${channelName}", null, $errno, $errstr, 30);
$channelName = null;
}
else { // tcp socket
list($host, $channelName) = explode(":", $channelName);
$peer = pfsockopen($host, $channelName, $errno, $errstr, 30);
}
}
if (!$peer) throw new java_RuntimeException("Could not connect to the context server $channelName. Error message: $errstr ($errno)\n");
stream_set_timeout($peer, -1);
$handler = new java_SocketHandler($this, new java_SocketChannel($peer, $this, $host, $channelName));
$compatibility = $this->client->RUNTIME["PARSER"]=="NATIVE"
? chr(0103-JAVA_PREFER_VALUES)
: chr(0100+JAVA_PREFER_VALUES);
if(is_int(JAVA_LOG_LEVEL)) {
$compatibility |= 128 | (7 & JAVA_LOG_LEVEL)<<2;
}
$this->write("\177$compatibility");
$this->serverName = "127.0.0.1:$channelName";
return $handler;
}
function createHandler() {
if(!array_key_exists('X_JAVABRIDGE_OVERRIDE_HOSTS_REDIRECT', $_SERVER)
&& function_exists("java_get_default_channel") &&
($defaultChannel=java_get_default_channel())) {
// if bind.c has started a local back end from Apache/IIS
return $this->createSimpleHandler($defaultChannel);
} else {
return $this->createHttpHandler();
}
}
function java_Protocol ($client) {
$this->client = $client;
$this->handler = $this->createHandler();
}
function redirect() {
$this->handler->redirect();
}
function read($size) {
return $this->handler->read($size);
}
function sendData() {
$this->handler->write($this->client->sendBuffer);
$this->client->sendBuffer=null;
}
function flush() {
if(JAVA_DEBUG) {
echo "sending::: "; echo $this->client->sendBuffer; echo "\n";
}
$this->sendData();
}
function keepAlive() {
$this->handler->keepAlive();
}
function handle() {
$this->client->handleRequests();
}
function write($data) {
$this->client->sendBuffer.=$data;
}
function finish() {
$this->flush();
$this->handle();
$this->redirect();
}
function referenceBegin($name) {
$this->client->sendBuffer.=$this->client->preparedToSendBuffer;
if(JAVA_DEBUG) {
echo "flushed preparedToSendBuffer: ".$this->client->preparedToSendBuffer."\n";
}
$this->client->preparedToSendBuffer=null;
$signature=sprintf("<H p=\"1\" v=\"%s\">", $name);
$this->write($signature);
$signature[6]="2";
$this->client->currentArgumentsFormat = $signature;
}
function referenceEnd() {
$this->client->currentArgumentsFormat.=$format="</H>";
$this->write($format);
$this->finish();
$this->client->currentCacheKey=null;
}
function createObjectBegin($name) {
$this->client->sendBuffer.=$this->client->preparedToSendBuffer;
if(JAVA_DEBUG) {
echo "flushed preparedToSendBuffer: ".$this->client->preparedToSendBuffer."\n";
}
$this->client->preparedToSendBuffer=null;
$signature=sprintf("<K p=\"1\" v=\"%s\">", $name);
$this->write($signature);
$signature[6]="2";
$this->client->currentArgumentsFormat = $signature;
}
function createObjectEnd() {
$this->client->currentArgumentsFormat.=$format="</K>";
$this->write($format);
$this->finish();
$this->client->currentCacheKey=null;
}
function propertyAccessBegin($object, $method) {
$this->client->sendBuffer.=$this->client->preparedToSendBuffer;
if(JAVA_DEBUG) {
echo "flushed preparedToSendBuffer: ".$this->client->preparedToSendBuffer."\n";
}
$this->client->preparedToSendBuffer=null;
$this->write(sprintf("<G p=\"1\" v=\"%x\" m=\"%s\">", $object, $method));
$this->client->currentArgumentsFormat="<G p=\"2\" v=\"%x\" m=\"${method}\">";
}
function propertyAccessEnd() {
$this->client->currentArgumentsFormat.=$format="</G>";
$this->write($format);
$this->finish();
$this->client->currentCacheKey=null;
}
function invokeBegin($object, $method) {
$this->client->sendBuffer.=$this->client->preparedToSendBuffer;
if(JAVA_DEBUG) {
echo "flushed preparedToSendBuffer: ".$this->client->preparedToSendBuffer."\n";
}
$this->client->preparedToSendBuffer=null;
$this->write(sprintf("<Y p=\"1\" v=\"%x\" m=\"%s\">", $object, $method));
$this->client->currentArgumentsFormat="<Y p=\"2\" v=\"%x\" m=\"${method}\">";
}
function invokeEnd() {
$this->client->currentArgumentsFormat.=$format="</Y>";
$this->write($format);
$this->finish();
$this->client->currentCacheKey=null;
}
function resultBegin() {
$this->client->sendBuffer.=$this->client->preparedToSendBuffer;
if(JAVA_DEBUG) {
echo "flushed preparedToSendBuffer: ".$this->client->preparedToSendBuffer."\n";
}
$this->client->preparedToSendBuffer=null;
$this->write("<R>");
}
function resultEnd() {
$this->client->currentCacheKey=null;
$this->write("</R>");
$this->flush();
}
function writeString($name) {
$this->client->currentArgumentsFormat.=$format="<S v=\"%s\"/>";
$this->write(sprintf($format, htmlspecialchars($name, ENT_COMPAT)));
}
function writeBoolean($boolean) {
$this->client->currentArgumentsFormat.=$format="<T v=\"%s\"/>";
$this->write(sprintf($format, $boolean));
}
function writeLong($l) {
$this->client->currentArgumentsFormat.="<J v=\"%d\"/>";
if($l<0) {
$this->write(sprintf("<L v=\"%x\" p=\"A\"/>",-$l));
} else {
$this->write(sprintf("<L v=\"%x\" p=\"O\"/>",$l));
}
}
function writeULong($l) {
$this->client->currentArgumentsFormat.=$format="<L v=\"%x\" p=\"O\"/>";
$this->write(sprintf($format,$l));
}
function writeDouble($d) {
$this->client->currentArgumentsFormat.=$format="<D v=\"%.14e\"/>";
$this->write(sprintf($format, $d));
}
function writeObject($object) {
$this->client->currentArgumentsFormat.=$format="<O v=\"%x\"/>";
$this->write(sprintf($format, $object));
}
/* the following routines are not cached */
function writeException($object, $str) {
$this->write(sprintf("<E v=\"%x\" m=\"%s\"/>",$object, htmlspecialchars($str, ENT_COMPAT)));
}
function writeCompositeBegin_a() {
$this->write("<X t=\"A\">");
}
function writeCompositeBegin_h() {
$this->write("<X t=\"H\">");
}
function writeCompositeEnd() {
$this->write("</X>");
}
function writePairBegin_s($key) {
$this->write(sprintf("<P t=\"S\" v=\"%s\">", htmlspecialchars($key, ENT_COMPAT)));
}
function writePairBegin_n($key) {
$this->write(sprintf("<P t=\"N\" v=\"%x\">",$key));
}
function writePairBegin() {
$this->write("<P>");
}
function writePairEnd() {
$this->write("</P>");
}
function writeUnref($object) {
$this->client->sendBuffer.=$this->client->preparedToSendBuffer;
//echo "clear prepared to send buffer\n";
$this->client->preparedToSendBuffer=null;
$this->write(sprintf("<U v=\"%x\"/>", $object));
}
function getServerName() {
return $this->serverName;
}
}
?>
