io.soluble.pjb.bridge.Request Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of php-java-bridge Show documentation
Show all versions of php-java-bridge Show documentation
PHPJavaBridge server (soluble fork)
package io.soluble.pjb.bridge;
/*
* Copyright (C) 2003-2007 Jost Boekemeier
*
* 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 COPYRIGHT HOLDER(S) OR AUTHOR(S) 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.
*/
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.LinkedList;
/**
* This class is used to handle requests from the front-end.
*
* @author jostb
*/
public final class Request implements IDocHandler {
protected static final IntegerComparator PHP_ARRAY_KEY_COMPARATOR = new IntegerComparator();
protected static final PhpNull PHPNULL = new PhpNull();
protected static final Object[] ZERO_ARGS = new Object[0];
protected static final byte[] ZERO = {0};
protected static final Object ZERO_OBJECT = new Object();
private final Parser parser;
private JavaBridge defaultBridge, bridge;
private SimpleContext contextCache;
private Arg arg;
/**
* The current response handle or null.
* There is only one response handle for each request object.
* response.reset() or response.flush() must be called at the end of each packet.
*/
Response response = null;
protected Object getGlobalRef(int i) {
Object ref = bridge.globalRef.get(i);
if (ref == PHPNULL) return null;
return ref;
}
SimpleContext getContext() {
if (contextCache != null) return contextCache;
if (bridge.options.passContext()) {
return contextCache = new Context();
}
return contextCache = new SimpleContext();
}
/**
* Creates an empty request object.
*
* @param bridge The bridge instance.
* @see Request#init(InputStream, OutputStream)
*/
public Request(JavaBridge bridge) {
this.bridge = bridge;
this.parser = new Parser(bridge, this);
}
/**
* This method must be called with the current header option byte.
* It initializes the request object.
*
* @param ch the current php options.
*/
public void init(byte ch) {
parser.initOptions(ch);
}
/**
* This method must be called with the current input and output streams.
* It reads the protocol header and initializes the request object.
*
* @param in The input stream.
* @param out The output stream.
* @return true, if the protocol header was valid, false otherwise.
* @throws IOException
*/
public boolean init(InputStream in, OutputStream out) throws IOException {
switch (parser.initOptions(in, out)) {
case Parser.PING:
bridge.logDebug("PING - PONG - Closing Request");
out.write(ZERO, 0, 1);
return false;
case Parser.IO_ERROR:
bridge.logDebug("IO_ERROR - Closing Request");
return false;
case Parser.EOF:
bridge.logDebug("EOF - Closing Request");
return false;
}
return true;
}
private long getClassicPhpLong(ParserString st[]) {
return st[0].getClassicLongValue();
}
private Object createClassicExact(ParserString st[]) {
return st[0].getClassicIntValue();
}
private long getPhpLong(ParserString st[]) {
long val = st[0].getLongValue();
if (st[1].string[st[1].off] != 'O')
val *= -1;
return val;
}
private Object createExact(ParserString st[]) {
{
int val = st[0].getIntValue();
if (st[1].string[st[1].off] != 'O')
val *= -1;
return (val);
}
}
/**
* {@inheritDoc}
*/
@Override
public boolean begin(ParserTag[] tag) {
boolean reply = true;
ParserString[] st = tag[2].strings;
byte ch;
switch (ch = tag[0].strings[0].string[0]) {
case 'G':
case 'Y': {
arg.type = ch;
arg.predicate = st[0].string[st[0].off];
int i = st[1].getIntValue();
arg.callObject = i == 0 ? bridge : getGlobalRef(i);
arg.method = st[2].getCachedStringValue();
arg.id.parseID(st[3]);
break;
}
case 'I': {
arg.type = ch;
int i = st[0].getIntValue();
arg.callObject = i == 0 ? bridge : getGlobalRef(i);
arg.method = st[1].getCachedStringValue();
arg.predicate = st[2].string[st[2].off];
arg.id.parseID(st[3]);
break;
}
case 'H':
case 'K': {
arg.type = ch;
arg.predicate = st[0].string[st[0].off];
arg.callObject = st[1].getCachedStringValue();
arg.id.parseID(st[2]);
break;
}
case 'C': {
arg.type = ch;
arg.callObject = st[0].getCachedStringValue();
arg.predicate = st[1].string[st[1].off];
arg.id.parseID(st[2]);
break;
}
case 'F': {
arg.type = ch;
arg.predicate = st[0].string[st[0].off];
break;
}
case 'R': {
arg.type = ch;
arg.id.parseID(st[0]);
break;
}
case 'X': {
arg = new CompositeArg(arg);
arg.composite = st[0].string[st[0].off];
break;
}
case 'P': {
if (arg.composite == 'H') {// hash
if (st[0].string[st[0].off] == 'S')
arg.key = st[1].getCachedStringValue();
else {
arg.key = new Integer(st[1].getIntValue());
}
} else // array
arg.key = null;
break;
}
case 'U': {
int i = st[0].getIntValue();
if (Util.logLevel > 4) {
Object obj = bridge.globalRef.get(i);
if (!(obj instanceof java.lang.reflect.Proxy))
Util.logDebug("unref: " + obj);
}
bridge.globalRef.remove(i);
reply = false; // U is the only top-level request which doesn't need a reply
break;
}
case 'S':
if (tag[2].n > 0) { // handle
* The exception is thrown when the client exits while running a callback,
* it aborts everything and jumps back to the top-level request-handling loop, see handleRequests() above.
*
* Do not catch this exception! If you must catch Exception(), check for AbortException. If
* you invoke using the reflection interface, check for the wrapped exception, unwrap it, if necessary
* and re-throw the exception
*
* @see Request#handleRequest()
*/
public static class AbortException extends RuntimeException {
private static final long serialVersionUID = 7778150395848350732L;
}
/**
* When within a sub request, handle an IOException as EOF
*
* @return EOF if an IOException or EOF occurred, otherwise the parser status is returned
*/
private short parseSubRequestUntilEof() {
try {
return parser.parse(bridge.in);
} catch (IOException e) {
bridge.printStackTrace(e);
return Parser.EOF;
}
}
/**
* Handle protocol sub-requests, see R and A in the protocol spec.
*
* @return An array of one object. The object is the result of the Apply call.
* @throws IOException
* @throws Throwable thrown by the PHP code.
*/
protected Object[] handleSubRequests() throws AbortException, Throwable {
Response currentResponse = response;
Arg current = arg;
response = response.copyResponse(); // must keep the current response state, for example coerceWriter for castToString()
arg = new SimpleArg();
while (Parser.OK == parseSubRequestUntilEof()) {
arg.id.setID(response);
switch (arg.type) {
case 'I':
switch (arg.predicate) {
case 'P':
bridge.GetSetProp(arg.callObject, arg.method, arg.getArgs(), response);
break;
case 'I':
bridge.Invoke(arg.callObject, arg.method, arg.getArgs(), response);
break;
default:
throw new IOException("Protocol error");
}
response.flush();
break;
case 'G':
switch (arg.predicate) {
case '2':
response.setAsyncWriter();
case '1':
bridge.GetSetProp(arg.callObject, arg.method, arg.getArgs(), response);
break;
case '3':
response.setAsyncVoidWriter();
bridge.GetSetProp(arg.callObject, arg.method, arg.getArgs(), response);
break;
default:
throw new IOException("Protocol error");
}
response.flush();
break;
case 'Y':
switch (arg.predicate) {
case '2':
response.setAsyncWriter();
case '1':
bridge.Invoke(arg.callObject, arg.method, arg.getArgs(), response);
break;
case '3':
response.setAsyncVoidWriter();
bridge.Invoke(arg.callObject, arg.method, arg.getArgs(), response);
break;
default:
throw new IOException("Protocol error");
}
response.flush();
break;
case 'C':
switch (arg.predicate) {
case 'C':
bridge.CreateObject((String) arg.callObject, false, arg.getArgs(), response);
break;
case 'I':
bridge.CreateObject((String) arg.callObject, true, arg.getArgs(), response);
break;
default:
throw new IOException("Protocol error");
}
response.flush();
break;
case 'H':
switch (arg.predicate) {
case '2':
response.setAsyncWriter();
case '1':
bridge.CreateObject((String) arg.callObject, false, arg.getArgs(), response);
break;
case '3':
response.setAsyncVoidWriter();
bridge.CreateObject((String) arg.callObject, false, arg.getArgs(), response);
break;
default:
throw new IOException("Protocol error");
}
response.flush();
break;
case 'K':
switch (arg.predicate) {
case '2':
response.setAsyncWriter();
case '1':
bridge.CreateObject((String) arg.callObject, true, arg.getArgs(), response);
break;
case '3':
response.setAsyncVoidWriter();
bridge.CreateObject((String) arg.callObject, true, arg.getArgs(), response);
break;
default:
throw new IOException("Protocol error");
}
response.flush();
break;
case 'F': // may happen due to a fatal error in a sub request
response.setFinish(false);
response.flush();
response = currentResponse;
arg = current;
throw new AbortException();
// no factory.invalidate necessary; ContextRunner will terminate and call factory.destroy()
case 'R':
Arg ret = arg;
arg = current;
// remove retval from the output buffer and return it to the parent.
response.reset();
response = currentResponse;
if (ret.callObject != null)
throw (Throwable) ret.callObject;
return ret.getArgs();
}
arg.reset();
}
// should not happen
response.setFinish(false);
response.flush();
arg = current;
response = currentResponse;
throw new AbortException();
}
/**
* Reset the internal state so that a new input and output stream
* can be used for the next packed. Note that request options
* (from init()) remain valid.
*
* @see #init(InputStream, OutputStream)
*/
public void reset() {
parser.reset();
}
/**
* Set a temporary bridge into this request. The bridge and its
* associated session-/contextFactory will be automatically destroyed when the request is done.
*
* @param bridge The fresh bridge and its ContextFactory
* @see io.soluble.pjb.bridge.http.IContextFactory#recycle(String)
*/
public void setBridge(JavaBridge bridge) {
defaultBridge = this.bridge;
bridge.in = this.bridge.in;
bridge.out = this.bridge.out;
this.bridge = bridge;
this.bridge.request = this;
response.setBridge(bridge);
parser.setBridge(bridge);
}
private void resetBridge() {
if (defaultBridge != null) {
bridge = defaultBridge;
response.setBridge(bridge);
parser.setBridge(bridge);
defaultBridge = null;
}
}
/**
* re-initialize for new requests
*/
public void recycle() {
reset();
if (arg != null) arg.reset();
if (response != null) response.recycle();
resetBridge();
}
/**
* {@inheritDoc}
*/
public void parseHeader(InputStream in) throws IOException {
bridge.getFactory().parseHeader(this, in);
}
// Only used when the async. protocol is enabled.
protected static final class PhpNull {
@Override
public String toString() {
return ""; //evaluates to false
}
}
private class SimpleContext {
public void parseID(ParserString string) {
}
public void setID(Response response) {
}
}
private class Context extends SimpleContext {
protected long id;
@Override
public void parseID(ParserString string) {
this.id = string.getLongValue();
}
@Override
public void setID(Response response) {
response.setID(id);
}
}
private abstract class Arg {
protected byte type;
protected Object callObject;
protected String method;
protected SimpleContext id = getContext();
protected byte predicate;
protected Object key;
protected byte composite;
public abstract void add(Object val);
public abstract Object[] getArgs();
public abstract void reset();
}
private final class SimpleArg extends Arg {
private LinkedList list;
public void add(Object val) {
if (list == null) list = new LinkedList();
list.add(val);
}
public Object[] getArgs() {
return (list == null) ? Request.ZERO_ARGS : list.toArray();
}
public void reset() {
list = null;
composite = 0;
type = 0;
callObject = null;
method = null;
key = null;
}
}
private final class CompositeArg extends Arg {
private PhpArray ht = null;
private int count = 0;
private Arg parent;
public CompositeArg(Arg parent) {
this.parent = parent;
}
public void add(Object val) {
if (ht == null) ht = new PhpArray();
if (key != null) {
ht.put(key, val);
} else {
ht.put(new Integer(count++), val);
}
}
protected Arg pop() {
if (ht == null) ht = new PhpArray();
parent.add(ht);
return parent;
}
/* (non-Javadoc)
* @see io.soluble.pjb.Request.Arg#getArgs()
*/
public Object[] getArgs() {
bridge.logError("Protocol error: getArgs");
return ZERO_ARGS;
}
/* (non-Javadoc)
* @see io.soluble.pjb.Request.Arg#reset()
*/
public void reset() {
bridge.logError("Protocol error: reset");
}
}
}