io.soluble.pjb.bridge.http.Context 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)
/*-*- mode: Java; tab-width:8 -*-*/
package io.soluble.pjb.bridge.http;
/*
* 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.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.Writer;
import java.lang.reflect.Method;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;
import io.soluble.pjb.bridge.IManaged;
import io.soluble.pjb.bridge.Invocable;
import io.soluble.pjb.bridge.NotImplementedException;
import io.soluble.pjb.bridge.Util;
/**
* Emulates a JSR223 script context when the JSR223 classes are not available.
* The method call(kont) returns false, so that it can be used to check if a script was called from java:
*
* function toString() {return "hello java, I am a php script, but in your eyes I am an ordinary java object...";}
* java_context()->call(java_closure()) || die("This script must be called from java!");
*
*
* @author jostb
* @see io.soluble.pjb.script.IPhpScriptContext
* @see javax.script.ScriptContext
* @see io.soluble.pjb.script.PhpScriptContext
*/
public class Context implements IManaged, Invocable, IContext {
/**
* Map of the scope of level GLOBAL_SCOPE
*/
private Map globalScope;
/**
* Map of the scope of level ENGINE_SCOPE
*/
private Map engineScope;
protected Context() {
}
/**
* {@inheritDoc}
*/
public Object getAttribute(String name) throws IllegalArgumentException {
if (name == null) {
throw new IllegalArgumentException("name cannot be null");
}
if (getEngineScope().get(name) != null) {
return getEngineScope().get(name);
} else if (getGlobalScope().get(name) != null) {
return getGlobalScope().get(name);
} else {
return null;
}
}
/**
* {@inheritDoc}
*/
public Object getAttribute(String name, int scope)
throws IllegalArgumentException {
if (name == null) {
throw new IllegalArgumentException("name cannot be null");
}
switch (scope) {
case ENGINE_SCOPE:
return getEngineScope().get(name);
case GLOBAL_SCOPE:
return getGlobalScope().get(name);
default:
throw new IllegalArgumentException("invalid scope");
}
}
/**
* {@inheritDoc}
*/
public int getAttributesScope(String name) {
if (getEngineScope().containsKey(name)) {
return ENGINE_SCOPE;
} else if (getGlobalScope().containsKey(name)) {
return GLOBAL_SCOPE;
}
return -1;
}
/**
* {@inheritDoc}
*/
public Writer getWriter() throws IOException {
// autoflush is true so that I can see the output immediately
return new PrintWriter(System.out, true);
}
/**
* {@inheritDoc}
*/
public Object removeAttribute(String name, int scope)
throws IllegalArgumentException {
if (name == null) {
throw new IllegalArgumentException("name is null");
}
switch (scope) {
case ENGINE_SCOPE:
return getEngineScope().remove(name);
case GLOBAL_SCOPE:
return getGlobalScope().remove(name);
default:
throw new IllegalArgumentException("invalid scope");
}
}
/**
* {@inheritDoc}
*/
public void setAttribute(String name, Object value, int scope)
throws IllegalArgumentException {
if (name == null) {
throw new IllegalArgumentException("name is null");
}
switch (scope) {
case ENGINE_SCOPE:
getEngineScope().put(name, value);
break;
case GLOBAL_SCOPE:
getGlobalScope().put(name, value);
break;
default:
throw new IllegalArgumentException("invalid scope");
}
}
/**
* Throws IllegalStateException
*
* @return none
*/
public Object getHttpServletRequest() {
throw new IllegalStateException("PHP not running in a servlet environment");
}
/**
* Throws IllegalStateException
*
* @return none
*/
public Object getServletContext() {
throw new IllegalStateException("PHP not running in a servlet environment");
}
/**
* Throws IllegalStateException
*
* @return none
*/
public Object getHttpServletResponse() {
throw new IllegalStateException("PHP not running in a servlet environment");
}
/**
* Throws IllegalStateException
*
* @return none
*/
public Object getServlet() {
throw new IllegalStateException("PHP not running in a servlet environment");
}
/**
* Throws IllegalStateException
*
* @return none
*/
public Object getServletConfig() {
throw new IllegalStateException("PHP not running in a servlet environment");
}
/**
* @param kont dummy
* @return false
*/
public boolean call(Object kont) {
return false;
}
protected void setGlobalScope(Map globalScope) {
this.globalScope = globalScope;
}
protected Map getGlobalScope() {
if (globalScope == null) globalScope = new HashMap();
return globalScope;
}
protected void setEngineScope(Map engineScope) {
this.engineScope = engineScope;
}
protected Map getEngineScope() {
if (engineScope == null) engineScope = new HashMap();
return engineScope;
}
private static boolean registeredHook = false;
private static LinkedList closeables = new LinkedList();
private static Object lockObject = new Object();
/**
* Only for internal use.
* Used when scripts are running outside of a servlet environment:
* Either the Standalone or the JSR223 Standalone (see PhpScriptContext).
* Within a servlet environment use the ContextLoaderListener instead:
* Either io.soluble.pjb.servlet.Context or the JSR223 Context (see PhpSimpleHttpScriptContext).
*
* @param closeable The procedure close(), will be called before the VM terminates
*/
public static void handleManaged(Object closeable) {
// make sure to properly release them upon System.exit().
synchronized (closeables) {
if (!registeredHook) {
registeredHook = true;
try {
Runtime.getRuntime().addShutdownHook(new Util.Thread() {
public void run() {
if (closeables == null) return;
synchronized (closeables) {
for (Iterator ii = closeables.iterator(); ii.hasNext(); ii.remove()) {
Object c = ii.next();
try {
Method close = c.getClass().getMethod("close", Util.ZERO_PARAM);
close.invoke(c, Util.ZERO_ARG);
} catch (Exception e) {
Util.printStackTrace(e);
}
}
}
}
});
} catch (SecurityException e) {/*ignore*/}
}
closeables.add(closeable);
}
}
/**
* Only for internal use
*
* @param callable The callable
* @return The result of the Callable::call().
* @throws Exception
*/
public static Object getManageable(Object callable) throws Exception {
synchronized (lockObject) {
Method call = callable.getClass().getMethod("call", Util.ZERO_PARAM);
return call.invoke(callable, Util.ZERO_ARG);
}
}
/**
* {@inheritDoc}
*
* @throws Exception
*/
public Object init(Object callable) throws Exception {
return getManageable(callable);
}
/**
* {@inheritDoc}
*/
public void onShutdown(Object closeable) {
io.soluble.pjb.bridge.http.Context.handleManaged(closeable);
}
/**
* Only for internal use
*
* @param path the path
* @return the real path
*/
public static String getRealPathInternal(String path) {
try {
return new File(path).getCanonicalPath();
} catch (IOException e) {
return new File(path).getAbsolutePath();
}
}
/**
* {@inheritDoc}
*/
public String getRealPath(String path) {
return getRealPathInternal(path);
}
/**
* {@inheritDoc}
*/
public Object get(String key) {
return getEngineScope().get(key);
}
/**
* {@inheritDoc}
*/
public void put(String key, Object val) {
getEngineScope().put(key, val);
}
/**
* {@inheritDoc}
*/
public void remove(String key) {
getEngineScope().remove(key);
}
/**
* {@inheritDoc}
*/
public void putAll(Map map) {
getEngineScope().putAll(map);
}
/**
* {@inheritDoc}
*/
public Map getAll() {
return Collections.unmodifiableMap(getEngineScope());
}
/**
* {@inheritDoc}
*/
public String getSocketName() {
throw new NotImplementedException("Use the JSR 223 API or a servlet environment instead");
}
/**
* @deprecated
*/
public String getRedirectString() {
throw new NotImplementedException();
}
/**
* @deprecated
*/
public String getRedirectString(String webPath) {
throw new NotImplementedException();
}
/**
* {@inheritDoc}
*/
public String getRedirectURL(String webPath) {
return "http://127.0.0.1:" + getSocketName() + webPath;
}
}