1 // Copyright 2002 Adam Megacz, see the COPYING file for licensing [GPL]
7 import org.mozilla.javascript.*;
9 import org.bouncycastle.util.encoders.Base64;
12 * An XML-RPC client implemented as a Rhino JavaScript Host
13 * Object. See the XWT spec for information on its behavior.
15 * NOTE: this client is EXTREMELY lenient in the responses it will
16 * accept; there are many, many invalid responses that it will
17 * successfully parse and return. Do NOT use this to determine the
18 * validity of your server.
20 * This client conforms to <a href="http://www.xmlrpc.com/spec">The
21 * XML-RPC Spec</a>, subject to these limitations:
23 * <li> XMLRPC cannot invoke methods that require a <base64/> argument
24 * <li> if a return value contains a <base64/>, it will be returned as a string
25 * <li> The decision to pass a number as <i4/> or <double/> is based
26 * entirely on whether or not the argument is fractional. Thus, it
27 * is impossible to pass a non-fractional number to an xmlrpc
28 * method that insists on being called with a <double/> element. We
29 * hope that most xml-rpc servers will be able to automatically
33 class XMLRPC extends XML implements Function {
35 /** the url to connect to */
36 protected String url = null;
38 /** the method name to invoke on the remove server */
39 protected String methodname = null;
41 /** this holds character content as we read it in -- since there is only one per instance, we don't support mixed content */
42 protected AccessibleCharArrayWriter content = new AccessibleCharArrayWriter(100);
44 /** the HTTP connection to use */
45 protected HTTP http = null;
47 /** The object stack. As we process xml elements, pieces of the
48 * return value are pushed onto and popped off of this stack.
50 * The general protocol is that any time a <value> tag is
51 * encountered, an empty String ("") is pushed onto the stack. If
52 * the <value/> node has content (either an anonymous
53 * string or some other XML node), that content replaces the
56 * If an <array> tag is encountered, a null is pushed onto the
57 * stack. When a </data> is encountered, we search back on the
58 * stack to the last null, replace it with a NativeArray, and
59 * insert into it all elements above it on the stack.
61 * If a <struct> tag is encountered, a JSObject is pushed
62 * onto the stack. If a <name> tag is encountered, its CDATA is
63 * pushed onto the stack. When a </member> is encountered, the
64 * name (second element on stack) and value (top of stack) are
65 * popped off the stack and inserted into the struct (third
68 protected Vec objects = null;
70 /** used to detect multi-ref data */
73 /** True iff the return value is a fault (and should be thrown as an exception) */
74 protected boolean fault = false;
77 // Methods to Recieve and parse XML-RPC Response ////////////////////////////////////////////////////
79 public void startElement(XML.Element c) {
81 if (c.localName.equals("fault")) fault = true;
82 else if (c.localName.equals("struct")) objects.setElementAt(new JSObject(false), objects.size() - 1);
83 else if (c.localName.equals("array")) objects.setElementAt(null, objects.size() - 1);
84 else if (c.localName.equals("value")) objects.addElement("");
87 public void endElement(XML.Element c) {
89 if (c.localName.equals("int") || c.localName.equals("i4"))
90 objects.setElementAt(new Integer(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
92 else if (c.localName.equals("boolean"))
93 objects.setElementAt(content.getBuf()[0] == '1' ? Boolean.TRUE : Boolean.FALSE, objects.size() - 1);
95 else if (c.localName.equals("string"))
96 objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
98 else if (c.localName.equals("double"))
99 objects.setElementAt(new Double(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
101 else if (c.localName.equals("base64"))
102 objects.setElementAt(new ByteStream(Base64.decode(new String(content.getBuf(), 0, content.size()))), objects.size() - 1);
104 else if (c.localName.equals("name"))
105 objects.addElement(new String(content.getBuf(), 0, content.size()));
107 else if (c.localName.equals("value") && "".equals(objects.lastElement()))
108 objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
110 else if (c.localName.equals("dateTime.iso8601")) {
111 String s = new String(content.getBuf(), 0, content.size());
115 while(Character.isWhitespace(s.charAt(i))) i++;
116 if (i > 0) s = s.substring(i);
119 NativeDate nd = (NativeDate)Context.enter().newObject(org.xwt.util.JSObject.defaultObjects, "Date");
120 double date = NativeDate.date_msecFromDate(Double.valueOf(s.substring(0, 4)).doubleValue(),
121 Double.valueOf(s.substring(4, 6)).doubleValue() - 1,
122 Double.valueOf(s.substring(6, 8)).doubleValue(),
123 Double.valueOf(s.substring(9, 11)).doubleValue(),
124 Double.valueOf(s.substring(12, 14)).doubleValue(),
125 Double.valueOf(s.substring(15, 17)).doubleValue(),
128 nd.jsFunction_setTime(NativeDate.internalUTC(date));
129 objects.setElementAt(nd, objects.size() - 1);
131 } catch (Exception e) {
132 if (Log.on) Log.log(this, "error parsing date : " + s);
133 if (Log.on) Log.log(this, e);
136 } else if (c.localName.equals("member")) {
137 Object memberValue = objects.elementAt(objects.size() - 1);
138 String memberName = (String)objects.elementAt(objects.size() - 2);
139 Scriptable struct = (Scriptable)objects.elementAt(objects.size() - 3);
140 struct.put(memberName, struct, memberValue);
141 objects.setSize(objects.size() - 2);
143 } else if (c.localName.equals("data")) {
145 for(i=objects.size() - 1; objects.elementAt(i) != null; i--);
146 Object[] arr = new Object[objects.size() - i - 1];
147 for(int j = i + 1; j<objects.size(); j++) arr[j - i - 1] = objects.elementAt(j);
148 objects.setElementAt(Context.enter().newArray(org.xwt.util.JSObject.defaultObjects, arr), i);
149 objects.setSize(i + 1);
156 public void characters(char[] ch, int start, int length) {
157 try { content.write(ch, start, length); }
158 catch (Exception e) {
159 if (Log.on) Log.log(this, "Exception in XMLRPC.content() -- this should never happen");
160 if (Log.on) Log.log(this, e);
164 public void whitespace(char[] ch, int start, int length) {}
166 // Methods to make outbound XML-RPC request ///////////////////////////////////////////////////
168 /** Appends the XML-RPC representation of <code>o</code> to <code>sb</code> */
169 void appendObject(Object o, StringBuffer sb) throws JavaScriptException {
172 throw new JavaScriptException("attempted to send a null value via XML-RPC");
174 } else if (o instanceof Number) {
175 if ((double)((Number)o).intValue() == ((Number)o).doubleValue()) {
176 sb.append(" <value><i4>");
177 sb.append(((Number)o).intValue());
178 sb.append("</i4></value>\n");
180 sb.append(" <value><double>");
182 sb.append("</double></value>\n");
185 } else if (o instanceof Boolean) {
186 sb.append(" <value><boolean>");
187 sb.append(((Boolean)o).booleanValue() ? "1" : "0");
188 sb.append("</boolean></value>\n");
190 } else if (o instanceof ByteStream) {
192 sb.append(" <value><base64>\n");
193 InputStream is = ((ByteStream)o).getInputStream();
194 byte[] buf = new byte[54];
196 int numread = is.read(buf, 0, 54);
197 if (numread == -1) break;
198 byte[] writebuf = buf;
199 if (numread < buf.length) {
200 writebuf = new byte[numread];
201 System.arraycopy(buf, 0, writebuf, 0, numread);
204 sb.append(new String(Base64.encode(writebuf)));
207 sb.append("\n </base64></value>\n");
208 } catch (IOException e) {
209 if (Log.on) Log.log(this, "caught IOException while attempting to send a ByteStream via XML-RPC");
210 if (Log.on) Log.log(this, e);
211 throw new JavaScriptException("caught IOException while attempting to send a ByteStream via XML-RPC");
214 } else if (o instanceof String) {
215 sb.append(" <value><string>");
216 String s = (String)o;
217 if (s.indexOf('<') == -1 && s.indexOf('&') == -1) {
220 char[] cbuf = s.toCharArray();
223 while(i < cbuf.length && cbuf[i] != '<' && cbuf[i] != '&') i++;
224 sb.append(cbuf, oldi, i - oldi);
225 if (i >= cbuf.length) break;
226 if (cbuf[i] == '<') sb.append("<");
227 else if (cbuf[i] == '&') sb.append("&");
229 if (i >= cbuf.length) break;
232 sb.append("</string></value>\n");
234 } else if (o instanceof NativeDate) {
235 sb.append(" <value><dateTime.iso8601>");
236 NativeDate nd = (NativeDate)o;
237 Date d = new Date(nd.getRawTime());
238 sb.append(d.getYear() + 1900);
239 if (d.getMonth() + 1 < 10) sb.append('0');
240 sb.append(d.getMonth() + 1);
241 if (d.getDate() < 10) sb.append('0');
242 sb.append(d.getDate());
244 if (d.getHours() < 10) sb.append('0');
245 sb.append(d.getHours());
247 if (d.getMinutes() < 10) sb.append('0');
248 sb.append(d.getMinutes());
250 if (d.getSeconds() < 10) sb.append('0');
251 sb.append(d.getSeconds());
252 sb.append("</dateTime.iso8601></value>\n");
254 } else if (o instanceof NativeArray) {
255 if (tracker.get(o) != null) throw new JavaScriptException("attempted to send multi-ref data structure via XML-RPC");
256 tracker.put(o, Boolean.TRUE);
257 sb.append(" <value><array><data>\n");
258 NativeArray na = (NativeArray)o;
259 for(int i=0; i<na.jsGet_length(); i++)
260 appendObject(na.get(i, na), sb);
261 sb.append(" </data></array></value>\n");
263 } else if (o instanceof Scriptable && !(o instanceof Undefined)) {
264 if (tracker.get(o) != null) throw new JavaScriptException("attempted to send multi-ref data structure via XML-RPC");
265 tracker.put(o, Boolean.TRUE);
266 Scriptable s = (Scriptable)o;
267 sb.append(" <value><struct>\n");
268 Object[] ids = s.getIds();
269 for(int i=0; i<ids.length; i++) {
270 sb.append(" <member><name>" + ids[i] + "</name>\n");
271 appendObject(s.get(ids[i].toString(), s), sb);
272 sb.append(" </member>\n");
274 sb.append(" </struct></value>\n");
277 throw new JavaScriptException("attempt to send object of type " + o.getClass().getName() + " via XML-RPC");
282 // this is synchronized in case multiple threads try to make a call on the same object... in the future, change this
283 // behavior to use pipelining.
284 public synchronized Object call(Object[] args) throws JavaScriptException, IOException {
285 if (Log.verbose) Log.log(this, "call to " + url + " : " + methodname);
287 if (tracker == null) tracker = new Hash();
288 else tracker.clear();
290 if (objects == null) objects = new Vec();
291 else objects.setSize(0);
293 String content = send(args, http);
296 BufferedReader br2 = new BufferedReader(new StringReader(content));
297 while ((s = br2.readLine()) != null) Log.log(this, "send: " + s);
300 HTTP.HTTPInputStream is = http.POST("text/xml", content);
302 BufferedReader br = !Log.verbose ?
303 new BufferedReader(new InputStreamReader(new Filter(is))) :
304 new BufferedReader(new FilterReader(new InputStreamReader(new Filter(is))) {
305 public int read() throws IOException {
306 int i = super.read();
307 if (Log.on) Log.log(this, "recv: " + ((char)i));
310 public int read(char[] c, int off, int len) throws IOException {
311 int ret = super.read(c, off, len);
312 if (ret == -1) return ret;
314 BufferedReader br2 = new BufferedReader(new StringReader(new String(c, off, ret)));
315 while ((s = br2.readLine()) != null) Log.log(this, "recv: " + s);
325 protected String send(Object[] args, HTTP http) throws JavaScriptException, IOException {
326 StringBuffer content = new StringBuffer();
327 content.append("\r\n");
328 content.append("<?xml version=\"1.0\"?>\n");
329 content.append(" <methodCall>\n");
330 content.append(" <methodName>");
331 content.append(methodname);
332 content.append("</methodName>\n");
333 content.append(" <params>\n");
334 for(int i=0; i<args.length; i++) {
335 content.append(" <param>\n");
336 appendObject(args[i], content);
337 content.append(" </param>\n");
339 content.append(" </params>\n");
340 content.append(" </methodCall>");
341 return content.toString();
344 protected Object recieve(BufferedReader br) throws JavaScriptException, IOException {
348 } catch (XML.XMLException e) {
349 if (Log.on) Log.log(this, "reply from server was not well-formed XML: " + e);
350 throw new JavaScriptException("reply from server was not well-formed XML: " + e);
353 if (fault) throw new JavaScriptException(objects.elementAt(0));
354 if (objects.size() == 0) return null;
355 return objects.elementAt(0);
358 public final Object call(Context cx, Scriptable scope, Scriptable thisObj, java.lang.Object[] args) throws JavaScriptException {
360 if (!ThreadMessage.suspendThread()) return null;
364 } catch (IOException se) {
365 if (Log.on) Log.log(this, se);
366 if (Log.on) Log.log(this, " at " + cx.interpreterSourceFile + ":" + cx.interpreterLine);
367 throw new JavaScriptException("socket exception: " + se);
369 } catch (JavaScriptException jse) {
370 Object val = jse.getValue();
371 if (val instanceof String) {
372 if (Log.on) Log.log(this, val.toString());
373 if (Log.on) Log.log(this, " at " + cx.interpreterSourceFile + ":" + cx.interpreterLine);
377 ThreadMessage.resumeThread();
382 /** When you get a property from an XMLRPC, it just returns another XMLRPC with the property name tacked onto methodname. */
383 public Object get(String name, Scriptable start) {
384 return new XMLRPC(url, (methodname.equals("") ? "" : methodname + ".") + name, http);
387 public XMLRPC(String url, String methodname) {
388 this(url, methodname, new HTTP(url));
391 public XMLRPC(String url, String methodname, HTTP http) {
396 this.methodname = methodname;
400 // Helper Classes ///////////////////////////////////////////////////////////////////////////////////
402 /** CharArrayWriter that lets us touch its buffer */
403 protected static class AccessibleCharArrayWriter extends CharArrayWriter {
404 public char[] getBuf() { return buf; }
405 public AccessibleCharArrayWriter(int i) { super(i); }
408 /** private filter class to make sure that network transfers don't interfere with UI responsiveness */
409 private static class Filter extends FilterInputStream {
410 public Filter(InputStream is) { super(is); }
411 public int read() throws IOException {
413 while(MessageQueue.nonThreadEventsInQueue > 0) try { Thread.sleep(100); } catch (Exception e) { };
416 public int read(byte[] b) throws IOException {
418 while(MessageQueue.nonThreadEventsInQueue > 0) try { Thread.sleep(100); } catch (Exception e) { };
419 return super.read(b);
421 public int read(byte[] b, int i, int j) throws IOException {
423 while(MessageQueue.nonThreadEventsInQueue > 0) try { Thread.sleep(100); } catch (Exception e) { };
424 return super.read(b, i, j);
429 // Methods Required by Rhino ////////////////////////////////////////////////////////
431 public String getClassName() { return "XMLRPC"; }
432 public Scriptable construct(Context cx, Scriptable scope, java.lang.Object[] args) { return null; }
433 public void delete(String name) { }
434 public Scriptable getParentScope() { return null; }
435 public void setParentScope(Scriptable p) { }
436 public boolean hasInstance(Scriptable value) { return false; }
437 public Scriptable getPrototype() { return null; }
438 public void setPrototype(Scriptable p) { }
439 public void delete(int i) { }
440 public Object getDefaultValue(Class hint) { return "XML-RPC"; }
441 public void put(int i, Scriptable start, Object value) { }
442 public Object get(int i, Scriptable start) { return null; }
443 public void put(String name, Scriptable start, Object value) { }
444 public boolean has(String name, Scriptable start) { return true; }
445 public boolean has(int i, Scriptable start) { return false; }
446 public Object[] getIds() { return new Object[] { }; }