src/org/xwt/XMLRPC.java

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