src/org/xwt/XMLRPC.java

   1 // Copyright 2002 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.xwt;
   3
   4 import java.io.*;
   5 import java.net.*;
   6 import java.util.*;
   7 import org.mozilla.javascript.*;
   8 import org.xwt.util.*;
   9 import org.bouncycastle.util.encoders.Base64;
  10
  11 /**
  12  *  An XML-RPC client implemented as a Rhino JavaScript Host
  13  *  Object. See the XWT spec for information on its behavior.
  14  *
  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.
  19  *
  20  *  This client conforms to <a href="http://www.xmlrpc.com/spec">The
  21  *  XML-RPC Spec</a>, subject to these limitations:
  22  *  <ol>
  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
  30  *         convert.
  31  *  </ol>
  32  */
  33 class XMLRPC extends XML implements Function {
  34
  35     /** the url to connect to */
  36     protected String url = null;
  37
  38     /** the method name to invoke on the remove server */
  39     protected String methodname = null;
  40
  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);
  43
  44     /** the HTTP connection to use */
  45     protected HTTP http = null;
  46
  47     /** The object stack. As we process xml elements, pieces of the
  48      *  return value are pushed onto and popped off of this stack.
  49      *
  50      *  The general protocol is that any time a &lt;value&gt; tag is
  51      *  encountered, an empty String ("") is pushed onto the stack. If
  52      *  the &lt;value/&gt; node has content (either an anonymous
  53      *  string or some other XML node), that content replaces the
  54      *  empty string.
  55      *
  56      *  If an &lt;array&gt; tag is encountered, a null is pushed onto the
  57      *  stack. When a &lt;/data&gt; 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.
  60      *
  61      *  If a &lt;struct&gt; tag is encountered, a JSObject is pushed
  62      *  onto the stack. If a &lt;name&gt; tag is encountered, its CDATA is
  63      *  pushed onto the stack. When a &lt;/member&gt; 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
  66      *  element on stack).
  67      */
  68     protected Vec objects = null;
  69
  70     /** used to detect multi-ref data */
  71     private Hash tracker;
  72
  73     /** True iff the return value is a fault (and should be thrown as an exception) */
  74     protected boolean fault = false;
  75
  76
  77     // Methods to Recieve and parse XML-RPC Response ////////////////////////////////////////////////////
  78
  79     public void startElement(String name, String[] keys, Object[] vals, int line, int col) {
  80         content.reset();
  81         if (name.equals("fault")) fault = true;
  82         else if (name.equals("struct")) objects.setElementAt(new JSObject(false), objects.size() - 1);
  83         else if (name.equals("array")) objects.setElementAt(null, objects.size() - 1);
  84         else if (name.equals("value")) objects.addElement("");
  85     }
  86
  87     public void endElement(String name, int line, int col) {
  88
  89         if (name.equals("int") || name.equals("i4"))
  90             objects.setElementAt(new Integer(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
  91
  92         else if (name.equals("boolean"))
  93             objects.setElementAt(content.getBuf()[0] == '1' ? Boolean.TRUE : Boolean.FALSE, objects.size() - 1);
  94
  95         else if (name.equals("string"))
  96             objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
  97
  98         else if (name.equals("double"))
  99             objects.setElementAt(new Double(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
 100
 101         else if (name.equals("base64"))
 102             objects.setElementAt(new ByteStream(Base64.decode(new String(content.getBuf(), 0, content.size()))), objects.size() - 1);
 103
 104         else if (name.equals("name"))
 105             objects.addElement(new String(content.getBuf(), 0, content.size()));
 106
 107         else if (name.equals("value") && "".equals(objects.lastElement()))
 108             objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
 109
 110         else if (name.equals("dateTime.iso8601")) {
 111             String s = new String(content.getBuf(), 0, content.size());
 112
 113             // strip whitespace
 114             int i=0;
 115             while(Character.isWhitespace(s.charAt(i))) i++;
 116             if (i > 0) s = s.substring(i);
 117
 118             try {
 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(),
 126                                                            (double)0
 127                                                            );
 128                 nd.jsFunction_setTime(NativeDate.internalUTC(date));
 129                 objects.setElementAt(nd, objects.size() - 1);
 130
 131             } catch (Exception e) {
 132                 if (Log.on) Log.log(this, "error parsing date : " + s);
 133                 if (Log.on) Log.log(this, e);
 134             }
 135
 136         } else if (name.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);
 142
 143         } else if (name.equals("data")) {
 144             int i;
 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);
 150
 151         }
 152
 153         content.reset();
 154     }
 155
 156     public void content(char[] ch, int start, int length, int line, int col) {
 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);
 161         }
 162     }
 163
 164
 165     // Methods to make outbound XML-RPC request ///////////////////////////////////////////////////
 166
 167     /** Appends the XML-RPC representation of <code>o</code> to <code>sb</code> */
 168     void appendObject(Object o, StringBuffer sb) throws JavaScriptException {
 169
 170         if (o == null) {
 171             throw new JavaScriptException("attempted to send a null value via XML-RPC");
 172
 173         } else if (o instanceof Number) {
 174             if ((double)((Number)o).intValue() == ((Number)o).doubleValue()) {
 175                 sb.append("                <value><i4>");
 176                 sb.append(((Number)o).intValue());
 177                 sb.append("</i4></value>\n");
 178             } else {
 179                 sb.append("                <value><double>");
 180                 sb.append(o);
 181                 sb.append("</double></value>\n");
 182             }
 183
 184         } else if (o instanceof Boolean) {
 185             sb.append("                <value><boolean>");
 186             sb.append(((Boolean)o).booleanValue() ? "1" : "0");
 187             sb.append("</boolean></value>\n");
 188
 189         } else if (o instanceof ByteStream) {
 190             try {
 191                 sb.append("                <value><base64>\n");
 192                 InputStream is = ((ByteStream)o).getInputStream();
 193                 byte[] buf = new byte[54];
 194                 while(true) {
 195                     int numread = is.read(buf, 0, 54);
 196                     if (numread == -1) break;
 197                     byte[] writebuf = buf;
 198                     if (numread < buf.length) {
 199                         writebuf = new byte[numread];
 200                         System.arraycopy(buf, 0, writebuf, 0, numread);
 201                     }
 202                     sb.append("              ");
 203                     sb.append(new String(Base64.encode(writebuf)));
 204                     sb.append("\n");
 205                 }
 206                 sb.append("\n              </base64></value>\n");
 207             } catch (IOException e) {
 208                 if (Log.on) Log.log(this, "caught IOException while attempting to send a ByteStream via XML-RPC");
 209                 if (Log.on) Log.log(this, e);
 210                 throw new JavaScriptException("caught IOException while attempting to send a ByteStream via XML-RPC");
 211             }
 212
 213         } else if (o instanceof String) {
 214             sb.append("                <value><string>");
 215             String s = (String)o;
 216             if (s.indexOf('<') == -1 && s.indexOf('&') == -1) {
 217                 sb.append(s);
 218             } else {
 219                 char[] cbuf = s.toCharArray();
 220                 int oldi = 0, i=0;
 221                 while(true) {
 222                     while(i < cbuf.length && cbuf[i] != '<' && cbuf[i] != '&') i++;
 223                     sb.append(cbuf, oldi, i - oldi);
 224                     if (i >= cbuf.length) break;
 225                     if (cbuf[i] == '<') sb.append("&lt;");
 226                     else if (cbuf[i] == '&') sb.append("&amp;");
 227                     i = oldi = i + 1;
 228                     if (i >= cbuf.length) break;
 229                 }
 230             }
 231             sb.append("</string></value>\n");
 232
 233         } else if (o instanceof NativeDate) {
 234             sb.append("                <value><dateTime.iso8601>");
 235             NativeDate nd = (NativeDate)o;
 236             Date d = new Date(nd.getRawTime());
 237             sb.append(d.getYear() + 1900);
 238             if (d.getMonth() + 1 < 10) sb.append('0');
 239             sb.append(d.getMonth() + 1);
 240             if (d.getDate() < 10) sb.append('0');
 241             sb.append(d.getDate());
 242             sb.append('T');
 243             if (d.getHours() < 10) sb.append('0');
 244             sb.append(d.getHours());
 245             sb.append(':');
 246             if (d.getMinutes() < 10) sb.append('0');
 247             sb.append(d.getMinutes());
 248             sb.append(':');
 249             if (d.getSeconds() < 10) sb.append('0');
 250             sb.append(d.getSeconds());
 251             sb.append("</dateTime.iso8601></value>\n");
 252
 253         } else if (o instanceof NativeArray) {
 254             if (tracker.get(o) != null) throw new JavaScriptException("attempted to send multi-ref data structure via XML-RPC");
 255             tracker.put(o, Boolean.TRUE);
 256             sb.append("                <value><array><data>\n");
 257             NativeArray na = (NativeArray)o;
 258             for(int i=0; i<na.jsGet_length(); i++)
 259                 appendObject(na.get(i, na), sb);
 260             sb.append("                </data></array></value>\n");
 261
 262         } else if (o instanceof Scriptable && !(o instanceof Undefined)) {
 263             if (tracker.get(o) != null) throw new JavaScriptException("attempted to send multi-ref data structure via XML-RPC");
 264             tracker.put(o, Boolean.TRUE);
 265             Scriptable s = (Scriptable)o;
 266             sb.append("                <value><struct>\n");
 267             Object[] ids = s.getIds();
 268             for(int i=0; i<ids.length; i++) {
 269                 sb.append("                <member><name>" + ids[i] + "</name>\n");
 270                 appendObject(s.get(ids[i].toString(), s), sb);
 271                 sb.append("                </member>\n");
 272             }
 273             sb.append("                </struct></value>\n");
 274
 275         } else {
 276             throw new JavaScriptException("attempt to send object of type " + o.getClass().getName() + " via XML-RPC");
 277
 278         }
 279     }
 280
 281     // this is synchronized in case multiple threads try to make a call on the same object... in the future, change this
 282     // behavior to use pipelining.
 283     public synchronized Object call(Object[] args) throws JavaScriptException, IOException {
 284         if (Log.verbose) Log.log(this, "call to " + url + " : " + methodname);
 285
 286         if (tracker == null) tracker = new Hash();
 287         else tracker.clear();
 288
 289         if (objects == null) objects = new Vec();
 290         else objects.setSize(0);
 291
 292         String content = send(args, http);
 293         if (Log.verbose) {
 294             String s;
 295             BufferedReader br2 = new BufferedReader(new StringReader(content));
 296             while ((s = br2.readLine()) != null) Log.log(this, "send: " + s);
 297         }
 298
 299         HTTP.HTTPInputStream is = http.POST("text/xml", content);
 300         try {
 301             BufferedReader br = !Log.verbose ?
 302                 new BufferedReader(new InputStreamReader(new Filter(is))) :
 303                 new BufferedReader(new FilterReader(new InputStreamReader(new Filter(is))) {
 304                         public int read() throws IOException {
 305                             int i = super.read();
 306                             if (Log.on) Log.log(this, "recv: " + ((char)i));
 307                             return i;
 308                         }
 309                         public int read(char[] c, int off, int len) throws IOException {
 310                             int ret = super.read(c, off, len);
 311                             if (ret == -1) return ret;
 312                             String s;
 313                             BufferedReader br2 = new BufferedReader(new StringReader(new String(c, off, ret)));
 314                             while ((s = br2.readLine()) != null) Log.log(this, "recv: " + s);
 315                             return ret;
 316                         }
 317                     });
 318             return recieve(br);
 319         } finally {
 320             is.close();
 321         }
 322     }
 323
 324     protected String send(Object[] args, HTTP http) throws JavaScriptException, IOException {
 325         StringBuffer content = new StringBuffer();
 326         content.append("<?xml version=\"1.0\"?>\n");
 327         content.append("    <methodCall>\n");
 328         content.append("        <methodName>");
 329         content.append(methodname);
 330         content.append("</methodName>\n");
 331         content.append("        <params>\n");
 332         for(int i=0; i<args.length; i++) {
 333             content.append("            <param>\n");
 334             appendObject(args[i], content);
 335             content.append("            </param>\n");
 336         }
 337         content.append("        </params>\n");
 338         content.append("    </methodCall>");
 339         return content.toString();
 340     }
 341
 342     protected Object recieve(BufferedReader br) throws JavaScriptException, IOException {
 343         // parse XML reply
 344         try {
 345             parse(br);
 346         } catch (XML.SAXException e) {
 347             if (Log.on) Log.log(this, "reply from server was not well-formed XML: " + e);
 348             throw new JavaScriptException("reply from server was not well-formed XML: " + e);
 349         }
 350
 351         if (fault) throw new JavaScriptException(objects.elementAt(0));
 352         if (objects.size() == 0) return null;
 353         return objects.elementAt(0);
 354     }
 355
 356     public final Object call(Context cx, Scriptable scope, Scriptable thisObj, java.lang.Object[] args) throws JavaScriptException {
 357
 358         if (!ThreadMessage.suspendThread()) return null;
 359
 360         try {
 361             return call(args);
 362         } catch (IOException se) {
 363             if (Log.on) Log.log(this, se);
 364             if (Log.on) Log.log(this, " at " + cx.interpreterSourceFile + ":" + cx.interpreterLine);
 365             throw new JavaScriptException("socket exception: " + se);
 366
 367         } catch (JavaScriptException jse) {
 368             Object val = jse.getValue();
 369             if (val instanceof String) {
 370                 if (Log.on) Log.log(this, val.toString());
 371                 if (Log.on) Log.log(this, " at " + cx.interpreterSourceFile + ":" + cx.interpreterLine);
 372             }
 373             throw jse;
 374         } finally {
 375             ThreadMessage.resumeThread();
 376         }
 377
 378     }
 379
 380     /** When you get a property from an XMLRPC, it just returns another XMLRPC with the property name tacked onto methodname. */
 381     public Object get(String name, Scriptable start) {
 382         return new XMLRPC(url, (methodname.equals("") ? "" : methodname + ".") + name, http);
 383     }
 384
 385     public XMLRPC(String url, String methodname) {
 386         this(url, methodname, new HTTP(url));
 387     }
 388
 389     public XMLRPC(String url, String methodname, HTTP http) {
 390         this.http = http;
 391         this.url = url;
 392         this.methodname = methodname;
 393     }
 394
 395
 396     // Helper Classes ///////////////////////////////////////////////////////////////////////////////////
 397
 398     /** CharArrayWriter that lets us touch its buffer */
 399     protected static class AccessibleCharArrayWriter extends CharArrayWriter {
 400         public char[] getBuf() { return buf; }
 401         public AccessibleCharArrayWriter(int i) { super(i); }
 402     }
 403
 404     /** private filter class to make sure that network transfers don't interfere with UI responsiveness */
 405     private static class Filter extends FilterInputStream {
 406         public Filter(InputStream is) { super(is); }
 407         public int read() throws IOException {
 408             Thread.yield();
 409             while(MessageQueue.nonThreadEventsInQueue > 0) try { Thread.sleep(100); } catch (Exception e) { };
 410             return super.read();
 411         }
 412         public int read(byte[] b) throws IOException {
 413             Thread.yield();
 414             while(MessageQueue.nonThreadEventsInQueue > 0) try { Thread.sleep(100); } catch (Exception e) { };
 415             return super.read(b);
 416         }
 417         public int read(byte[] b, int i, int j) throws IOException {
 418             Thread.yield();
 419             while(MessageQueue.nonThreadEventsInQueue > 0) try { Thread.sleep(100); } catch (Exception e) { };
 420             return super.read(b, i, j);
 421         }
 422     }
 423
 424
 425     // Methods Required by Rhino ////////////////////////////////////////////////////////
 426
 427     public String getClassName() { return "XMLRPC"; }
 428     public Scriptable construct(Context cx, Scriptable scope, java.lang.Object[] args) { return null; }
 429     public void delete(String name) { }
 430     public Scriptable getParentScope() { return null; }
 431     public void setParentScope(Scriptable p) { }
 432     public boolean hasInstance(Scriptable value) { return false; }
 433     public Scriptable getPrototype() { return null; }
 434     public void setPrototype(Scriptable p) { }
 435     public void delete(int i) { }
 436     public Object getDefaultValue(Class hint) { return "XML-RPC"; }
 437     public void put(int i, Scriptable start, Object value) { }
 438     public Object get(int i, Scriptable start) { return null; }
 439     public void put(String name, Scriptable start, Object value) { }
 440     public boolean has(String name, Scriptable start) { return true; }
 441     public boolean has(int i, Scriptable start) { return false; }
 442     public Object[] getIds() { return new Object[] { }; }
 443
 444 }