changes made after tupshins reconstruction
[org.ibex.core.git] / src / org / xwt / XMLRPC.java
index c4f5fc6..f78936a 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright 2002 Adam Megacz, see the COPYING file for licensing [GPL]
+// Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
 package org.xwt;
 
 import java.io.*;
@@ -30,21 +30,21 @@ import org.bouncycastle.util.encoders.Base64;
  *         convert.
  *  </ol>
  */
-class XMLRPC extends JS.Callable {
+class XMLRPC extends JS {
 
-    public Object[] keys() { throw new Error("not implemented"); }
+    public XMLRPC(String url, String method) { this(url, method, new HTTP(url)); }
+    public XMLRPC(String url, String method, HTTP http) { this.http = http; this.url = url; this.method = method; }
+    public Object get(Object name) { return new XMLRPC(url, (method.equals("") ? "" : method + ".") + name.toString(), http); }
 
-    /** the url to connect to */
-    protected String url = null;
-
-    /** the method name to invoke on the remove server */
-    protected String methodname = null;
 
     /** this holds character content as we read it in -- since there is only one per instance, we don't support mixed content */
     protected AccessibleCharArrayWriter content = new AccessibleCharArrayWriter(100);
+    protected String url = null;         ///< the url to connect to
+    protected String method = null;      ///< the method name to invoke on the remove server
+    protected HTTP http = null;          ///< the HTTP connection to use
+    private Hash tracker;                ///< used to detect multi-ref data
+    protected boolean fault = false;     ///< True iff the return value is a fault (and should be thrown as an exception)
 
-    /** the HTTP connection to use */
-    protected HTTP http = null;
 
     /** The object stack. As we process xml elements, pieces of the
      *  return value are pushed onto and popped off of this stack.
@@ -57,10 +57,10 @@ class XMLRPC extends JS.Callable {
      *
      *  If an &lt;array&gt; tag is encountered, a null is pushed onto the
      *  stack. When a &lt;/data&gt; is encountered, we search back on the
-     *  stack to the last null, replace it with a NativeJS.Array, and
+     *  stack to the last null, replace it with a NativeJSArray, and
      *  insert into it all elements above it on the stack.
      *
-     *  If a &lt;struct&gt; tag is encountered, a JSObject is pushed
+     *  If a &lt;struct&gt; tag is encountered, a JSect is pushed
      *  onto the stack. If a &lt;name&gt; tag is encountered, its CDATA is
      *  pushed onto the stack. When a &lt;/member&gt; is encountered, the
      *  name (second element on stack) and value (top of stack) are
@@ -69,116 +69,122 @@ class XMLRPC extends JS.Callable {
      */
     protected Vec objects = null;
 
-    /** used to detect multi-ref data */
-    private Hash tracker;
-
-    /** True iff the return value is a fault (and should be thrown as an exception) */
-    protected boolean fault = false;
-
 
-    // Methods to Recieve and parse XML-RPC Response ////////////////////////////////////////////////////
+    // Recieve ////////////////////////////////////////////////////////////////
 
     private class Helper extends XML {
         public Helper() { super(BUFFER_SIZE); }
 
         public void startElement(XML.Element c) {
             content.reset();
-            if (c.localName.equals("fault")) fault = true;
-            else if (c.localName.equals("struct")) objects.setElementAt(new JS.Obj(), objects.size() - 1);
-            else if (c.localName.equals("array")) objects.setElementAt(null, objects.size() - 1);
-            else if (c.localName.equals("value")) objects.addElement("");
+            //#switch(c.getLocalName())
+            case "fault": fault = true;
+            case "struct": objects.setElementAt(new JS(), objects.size() - 1);
+            case "array": objects.setElementAt(null, objects.size() - 1);
+            case "value": objects.addElement("");
+            //#end
         }
         
         public void endElement(XML.Element c) {
-            
-            if (c.localName.equals("int") || c.localName.equals("i4"))
-                objects.setElementAt(new Integer(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
-            
-            else if (c.localName.equals("boolean"))
-                objects.setElementAt(content.getBuf()[0] == '1' ? Boolean.TRUE : Boolean.FALSE, objects.size() - 1);
-            
-            else if (c.localName.equals("string"))
+            //#switch(c.getLocalName())
+            case "int": objects.setElementAt(new Integer(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
+            case "i4": objects.setElementAt(new Integer(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
+            case "boolean": objects.setElementAt(content.getBuf()[0] == '1' ? Boolean.TRUE : Boolean.FALSE, objects.size() - 1);
+            case "string": objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
+            case "double": objects.setElementAt(new Double(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
+            case "base64":
+                objects.setElementAt(new Stream.ByteArray(Base64.decode(new String(content.getBuf(), 0, content.size())),
+                                                          null), objects.size() - 1);
+            case "name": objects.addElement(new String(content.getBuf(), 0, content.size()));
+            case "value": if ("".equals(objects.lastElement()))
                 objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
-            
-            else if (c.localName.equals("double"))
-                objects.setElementAt(new Double(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
-            
-            else if (c.localName.equals("base64"))
-                objects.setElementAt(new ByteStream(Base64.decode(new String(content.getBuf(), 0, content.size()))), objects.size() - 1);
-            
-            else if (c.localName.equals("name"))
-                objects.addElement(new String(content.getBuf(), 0, content.size()));
-            
-            else if (c.localName.equals("value") && "".equals(objects.lastElement()))
-                objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
-            
-            else if (c.localName.equals("dateTime.iso8601")) {
-                throw new Error("not implemented");
-                /*
-                  String s = new String(content.getBuf(), 0, content.size());
-                  
-                  // strip whitespace
-                  int i=0;
-                  while(Character.isWhitespace(s.charAt(i))) i++;
-                  if (i > 0) s = s.substring(i);
-                  
-                  try {
-                  NativeDate nd = (NativeDate)JS.Thread.enter().newObject(org.xwt.util.JS.Obj.defaultObjects, "Date");
-                  double date = NativeDate.date_msecFromDate(Double.valueOf(s.substring(0, 4)).doubleValue(),
-                  Double.valueOf(s.substring(4, 6)).doubleValue() - 1,
-                  Double.valueOf(s.substring(6, 8)).doubleValue(),
-                  Double.valueOf(s.substring(9, 11)).doubleValue(),
-                  Double.valueOf(s.substring(12, 14)).doubleValue(),
-                  Double.valueOf(s.substring(15, 17)).doubleValue(),
-                  (double)0
-                  );
-                  nd.jsFunction_setTime(NativeDate.internalUTC(date));
-                  objects.setElementAt(nd, objects.size() - 1);
-                  
-                  } catch (Exception e) {
-                  if (Log.on) Log.log(this, "error parsing date : " + s);
-                  if (Log.on) Log.log(this, e);
-                  }
-                */
+            case "dateTime.iso8601":
+                String s = new String(content.getBuf(), 0, content.size());
+                
+                // strip whitespace
+                int i=0;
+                while(Character.isWhitespace(s.charAt(i))) i++;
+                if (i > 0) s = s.substring(i);
                 
-            } else if (c.localName.equals("member")) {
+                try {
+                    JSDate nd = new JSDate();
+                    double date = JSDate.date_msecFromDate(Double.valueOf(s.substring(0, 4)).doubleValue(),
+                                                           Double.valueOf(s.substring(4, 6)).doubleValue() - 1,
+                                                           Double.valueOf(s.substring(6, 8)).doubleValue(),
+                                                           Double.valueOf(s.substring(9, 11)).doubleValue(),
+                                                           Double.valueOf(s.substring(12, 14)).doubleValue(),
+                                                           Double.valueOf(s.substring(15, 17)).doubleValue(),
+                                                           (double)0
+                                                           );
+                    nd.setTime(JSDate.internalUTC(date));
+                    objects.setElementAt(nd, objects.size() - 1);
+                    
+                } catch (Exception e) {
+                    throw new RuntimeException("xwt.net.rpc.xml.recieve.malformedDateTag" +
+                                    "the server sent a <dateTime.iso8601> tag which was malformed: " + s);
+                }
+            case "member":
                 Object memberValue = objects.elementAt(objects.size() - 1);
                 String memberName = (String)objects.elementAt(objects.size() - 2);
                 JS struct = (JS)objects.elementAt(objects.size() - 3);
-                struct.put(memberName, memberValue);
+                try {
+                    struct.put(memberName, memberValue);
+                } catch (JSExn e) {
+                    throw new Error("this should never happen");
+                }
                 objects.setSize(objects.size() - 2);
-                
-            } else if (c.localName.equals("data")) {
+            case "data":
                 int i;
                 for(i=objects.size() - 1; objects.elementAt(i) != null; i--);
-                JS.Array arr = new JS.Array();
-                for(int j = i + 1; j<objects.size(); j++) arr.put(new Integer(j - i - 1), objects.elementAt(j));
+                JSArray arr = new JSArray();
+                try {
+                    for(int j = i + 1; j<objects.size(); j++) arr.put(new Integer(j - i - 1), objects.elementAt(j));
+                } catch (JSExn e) {
+                    throw new Error("this should never happen");
+                }
                 objects.setElementAt(arr, i);
                 objects.setSize(i + 1);
-                
-            }
-            
+            //#end            
             content.reset();
         }
         
         public void characters(char[] ch, int start, int length) {
             try { content.write(ch, start, length); }
             catch (Exception e) { 
-                if (Log.on) Log.log(this, "Exception in XMLRPC.content() -- this should never happen");
-                if (Log.on) Log.log(this, e);
+                if (Log.on) Log.info(this, "Exception in XMLRPC.content() -- this should never happen");
+                if (Log.on) Log.info(this, e);
             }
         }
         
         public void whitespace(char[] ch, int start, int length) {}
     }
 
-    // Methods to make outbound XML-RPC request ///////////////////////////////////////////////////
+    // Send ///////////////////////////////////////////////////////////////////////////
+
+    protected String buildRequest(JSArray args) throws JSExn, IOException {
+        StringBuffer content = new StringBuffer();
+        content.append("\r\n");
+        content.append("<?xml version=\"1.0\"?>\n");
+        content.append("    <methodCall>\n");
+        content.append("        <method>");
+        content.append(method);
+        content.append("</method>\n");
+        content.append("        <params>\n");
+        for(int i=0; i<args.length(); i++) {
+            content.append("            <param>\n");
+            appendObject(args.elementAt(i), content);
+            content.append("            </param>\n");
+        }
+        content.append("        </params>\n");
+        content.append("    </methodCall>");
+        return content.toString();
+    }
 
     /** Appends the XML-RPC representation of <code>o</code> to <code>sb</code> */
-    void appendObject(Object o, StringBuffer sb) throws JS.Exn {
+    void appendObject(Object o, StringBuffer sb) throws JSExn {
 
         if (o == null) {
-            throw new JS.Exn("attempted to send a null value via XML-RPC");
+            throw new JSExn("attempted to send a null value via XML-RPC");
 
         } else if (o instanceof Number) {
             if ((double)((Number)o).intValue() == ((Number)o).doubleValue()) {
@@ -196,10 +202,10 @@ class XMLRPC extends JS.Callable {
             sb.append(((Boolean)o).booleanValue() ? "1" : "0");
             sb.append("</boolean></value>\n");
 
-        } else if (o instanceof ByteStream) {
+        } else if (o instanceof Stream) {
             try {
                 sb.append("                <value><base64>\n");
-                InputStream is = ((ByteStream)o).getInputStream();
+                InputStream is = ((Stream)o).getInputStream();
                 byte[] buf = new byte[54];
                 while(true) {
                     int numread = is.read(buf, 0, 54);
@@ -215,9 +221,9 @@ class XMLRPC extends JS.Callable {
                 }
                 sb.append("\n              </base64></value>\n");
             } catch (IOException e) {
-                if (Log.on) Log.log(this, "caught IOException while attempting to send a ByteStream via XML-RPC");
-                if (Log.on) Log.log(this, e);
-                throw new JS.Exn("caught IOException while attempting to send a ByteStream via XML-RPC");
+                if (Log.on) Log.info(this, "caught IOException while attempting to send a ByteStream via XML-RPC");
+                if (Log.on) Log.info(this, e);
+                throw new JSExn("caught IOException while attempting to send a ByteStream via XML-RPC");
             }
 
         } else if (o instanceof String) {
@@ -240,12 +246,9 @@ class XMLRPC extends JS.Callable {
             }
             sb.append("</string></value>\n");
 
-            /*
-        } else if (o instanceof org.xwt.js.Date) {
+        } else if (o instanceof JSDate) {
             sb.append("                <value><dateTime.iso8601>");
-              FIXME
-            org.xwt.js.Date d = (org.xwt.js.Date)o;
-            Date d = new Date(nd.getRawTime());
+            java.util.Date d = new java.util.Date(((JSDate)o).getRawTime());
             sb.append(d.getYear() + 1900);
             if (d.getMonth() + 1 < 10) sb.append('0');
             sb.append(d.getMonth() + 1);
@@ -261,172 +264,80 @@ class XMLRPC extends JS.Callable {
             if (d.getSeconds() < 10) sb.append('0');
             sb.append(d.getSeconds());
             sb.append("</dateTime.iso8601></value>\n");
-            */
 
-        } else if (o instanceof JS.Array) {
-            if (tracker.get(o) != null) throw new JS.Exn("attempted to send multi-ref data structure via XML-RPC");
+        } else if (o instanceof JSArray) {
+            if (tracker.get(o) != null) throw new JSExn("attempted to send multi-ref data structure via XML-RPC");
             tracker.put(o, Boolean.TRUE);
             sb.append("                <value><array><data>\n");
-            JS.Array a = (JS.Array)o;
+            JSArray a = (JSArray)o;
             for(int i=0; i<a.length(); i++) appendObject(a.elementAt(i), sb);
             sb.append("                </data></array></value>\n");
 
         } else if (o instanceof JS) {
-            if (tracker.get(o) != null) throw new JS.Exn("attempted to send multi-ref data structure via XML-RPC");
+            if (tracker.get(o) != null) throw new JSExn("attempted to send multi-ref data structure via XML-RPC");
             tracker.put(o, Boolean.TRUE);
             JS j = (JS)o;
             sb.append("                <value><struct>\n");
-            Object[] ids = j.keys();
-            for(int i=0; i<ids.length; i++) {
-                sb.append("                <member><name>" + ids[i] + "</name>\n");
-                appendObject(j.get(ids[i].toString()), sb);
+            Enumeration e = j.keys();
+            while(e.hasMoreElements()) {
+                Object key = e.nextElement();
+                sb.append("                <member><name>" + key + "</name>\n");
+                appendObject(j.get(key), sb);
                 sb.append("                </member>\n");
             }
             sb.append("                </struct></value>\n");
 
         } else {
-            throw new JS.Exn("attempt to send object of type " + o.getClass().getName() + " via XML-RPC");
+            throw new JSExn("attempt to send object of type " + o.getClass().getName() + " via XML-RPC");
 
         }
     }
 
-    // this is synchronized in case multiple threads try to make a call on the same object... in the future, change this
-    // behavior to use pipelining.
-    public synchronized Object call2(JS.Array args) throws JS.Exn, IOException {
-        if (Log.verbose) Log.log(this, "call to " + url + " : " + methodname);
-
-        if (tracker == null) tracker = new Hash();
-        else tracker.clear();
 
-        if (objects == null) objects = new Vec();
-        else objects.setSize(0);
+    // Call Sequence //////////////////////////////////////////////////////////////////////////
 
-        String content = send(args, http);
-        if (Log.verbose) {
-            String s;
-            BufferedReader br2 = new BufferedReader(new StringReader(content));
-            while ((s = br2.readLine()) != null) Log.log(this, "send: " + s);
-        }
-
-        HTTP.HTTPInputStream is = http.POST("text/xml", content);
-        try {
-            BufferedReader br = !Log.verbose ?
-                new BufferedReader(new InputStreamReader(new Filter(is))) :
-                new BufferedReader(new FilterReader(new InputStreamReader(new Filter(is))) {
-                        public int read() throws IOException {
-                            int i = super.read();
-                            if (Log.on) Log.log(this, "recv: " + ((char)i));
-                            return i;
-                        }
-                        public int read(char[] c, int off, int len) throws IOException {
-                            int ret = super.read(c, off, len);
-                            if (ret == -1) return ret;
-                            String s;
-                            BufferedReader br2 = new BufferedReader(new StringReader(new String(c, off, ret)));
-                            while ((s = br2.readLine()) != null) Log.log(this, "recv: " + s);
-                            return ret;
-                        }
-                    });
-            return recieve(br);
-        } finally {
-            is.close();
-        }
+    public final Object call(Object a0, Object a1, Object a2, Object[] rest, int nargs) throws JSExn {
+        JSArray args = new JSArray();
+        for(int i=0; i<nargs; i++) args.addElement(i==0?a0:i==1?a1:i==2?a2:rest[i-3]);
+        return call(args);
     }
 
-    protected String send(JS.Array args, HTTP http) throws JS.Exn, IOException {
-        StringBuffer content = new StringBuffer();
-        content.append("\r\n");
-        content.append("<?xml version=\"1.0\"?>\n");
-        content.append("    <methodCall>\n");
-        content.append("        <methodName>");
-        content.append(methodname);
-        content.append("</methodName>\n");
-        content.append("        <params>\n");
-        for(int i=0; i<args.length(); i++) {
-            content.append("            <param>\n");
-            appendObject(args.elementAt(i), content);
-            content.append("            </param>\n");
-        }
-        content.append("        </params>\n");
-        content.append("    </methodCall>");
-        return content.toString();
-    }
-        
-    protected Object recieve(BufferedReader br) throws JS.Exn, IOException {
-        // parse XML reply
+    public final Object call(final JSArray args) throws JSExn {
         try {
-            new Helper().parse(br);
-        } catch (XML.XMLException e) {
-            if (Log.on) Log.log(this, "reply from server was not well-formed XML: " + e);
-            throw new JS.Exn("reply from server was not well-formed XML: " + e);
+            final JS.UnpauseCallback callback = JS.pause();
+            new java.lang.Thread() { public void run() { call(callback, args); }  }.start();
+            return null; // doesn't matter since we paused
+        } catch (NotPauseableException npe) {
+            throw new JSExn("cannot invoke an XML-RPC call in the foreground thread");
         }
-        
-        if (fault) throw new JS.Exn(objects.elementAt(0));
-        if (objects.size() == 0) return null;
-        return objects.elementAt(0);
     }
 
-    public final Object call(JS.Array args) throws JS.Exn {
-
-        if (!ThreadMessage.suspendThread()) return null;
-
+    final void call(final JS.UnpauseCallback callback, final JSArray args) {
         try {
-            return call2(args);
-        } catch (IOException se) {
-            if (Log.on) Log.log(this, se);
-            throw new JS.Exn("socket exception: " + se);
-
-        } catch (JS.Exn jse) {
-            if (Log.on) Log.log(this, jse.toString());
-            throw jse;
-        } finally {
-            ThreadMessage.resumeThread();
-        }
-
-    }
-
-    /** When you get a property from an XMLRPC, it just returns another XMLRPC with the property name tacked onto methodname. */
-    public Object get(Object name) {
-        return new XMLRPC(url, (methodname.equals("") ? "" : methodname + ".") + name.toString(), http);
-    }
-
-    public XMLRPC(String url, String methodname) {
-        this(url, methodname, new HTTP(url));
-    }
-
-    public XMLRPC(String url, String methodname, HTTP http) {
-        this.http = http;
-        this.url = url;
-        this.methodname = methodname;
-    }
-
-
-    // Helper Classes ///////////////////////////////////////////////////////////////////////////////////
-
-    /** CharArrayWriter that lets us touch its buffer */
-    protected static class AccessibleCharArrayWriter extends CharArrayWriter {
-        public char[] getBuf() { return buf; }
-        public AccessibleCharArrayWriter(int i) { super(i); }
-    }
-
-    /** private filter class to make sure that network transfers don't interfere with UI responsiveness */
-    private static class Filter extends FilterInputStream {
-        public Filter(InputStream is) { super(is); }
-        public int read() throws IOException {
-            java.lang.Thread.yield();
-            while(MessageQueue.nonThreadEventsInQueue > 0) try { java.lang.Thread.sleep(100); } catch (Exception e) { };
-            return super.read();
-        }
-        public int read(byte[] b) throws IOException {
-            java.lang.Thread.yield();
-            while(MessageQueue.nonThreadEventsInQueue > 0) try { java.lang.Thread.sleep(100); } catch (Exception e) { };
-            return super.read(b);
-        }
-        public int read(byte[] b, int i, int j) throws IOException {
-            java.lang.Thread.yield();
-            while(MessageQueue.nonThreadEventsInQueue > 0) try { java.lang.Thread.sleep(100); } catch (Exception e) { };
-            return super.read(b, i, j);
+            if (Log.verbose) Log.info(this, "call to " + url + " : " + method);
+            if (tracker == null) tracker = new Hash();
+            if (objects == null) objects = new Vec();
+            String request = buildRequest(args);
+            if (Log.verbose) Log.info(this, "send:\n" + request);
+            InputStream is = http.POST("text/xml", request);
+            BufferedReader br = new BufferedReader(new InputStreamReader(is));
+            try {
+                new Helper().parse(br);
+                final Object result = fault ? new JSExn(objects.elementAt(0)) : objects.size() == 0 ? null : objects.elementAt(0);
+                Scheduler.add(new Scheduler.Task() { public void perform() throws Exception { callback.unpause(result); }});
+            } finally {
+                tracker.clear();
+                objects.setSize(0);
+            }
+        } catch (final JSExn e) {
+            final Exception e2 = e;
+            Scheduler.add(new Scheduler.Task() { public void perform() throws Exception { callback.unpause(e2); }});
+        } catch (final IOException e) {
+            final Exception e2 = e;
+            Scheduler.add(new Scheduler.Task() { public void perform() throws Exception { callback.unpause(new JSExn(e2)); }});
+        } catch (final XML.Exn e) {
+            final Exception e2 = e;
+            Scheduler.add(new Scheduler.Task() { public void perform() throws Exception { callback.unpause(new JSExn(e2)); }});
         }
     }
-
 }