1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
9 import org.bouncycastle.util.encoders.Base64;
12 * An XML-RPC client implemented as a JavaScript Host Object. See the
13 * 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 JS {
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 NativeJSArray, and
59 * insert into it all elements above it on the stack.
61 * If a <struct> tag is encountered, a JSect 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 private class Helper extends XML {
80 public Helper() { super(BUFFER_SIZE); }
82 public void startElement(XML.Element c) {
84 if (c.localName.equals("fault")) fault = true;
85 else if (c.localName.equals("struct")) objects.setElementAt(new JS(), objects.size() - 1);
86 else if (c.localName.equals("array")) objects.setElementAt(null, objects.size() - 1);
87 else if (c.localName.equals("value")) objects.addElement("");
90 public void endElement(XML.Element c) {
92 if (c.localName.equals("int") || c.localName.equals("i4"))
93 objects.setElementAt(new Integer(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
95 else if (c.localName.equals("boolean"))
96 objects.setElementAt(content.getBuf()[0] == '1' ? Boolean.TRUE : Boolean.FALSE, objects.size() - 1);
98 else if (c.localName.equals("string"))
99 objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
101 else if (c.localName.equals("double"))
102 objects.setElementAt(new Double(new String(content.getBuf(), 0, content.size())), objects.size() - 1);
104 else if (c.localName.equals("base64"))
105 objects.setElementAt(new Res.ByteArray(Base64.decode(new String(content.getBuf(), 0, content.size())), null), objects.size() - 1);
107 else if (c.localName.equals("name"))
108 objects.addElement(new String(content.getBuf(), 0, content.size()));
110 else if (c.localName.equals("value") && "".equals(objects.lastElement()))
111 objects.setElementAt(new String(content.getBuf(), 0, content.size()), objects.size() - 1);
113 else if (c.localName.equals("dateTime.iso8601")) {
114 String s = new String(content.getBuf(), 0, content.size());
118 while(Character.isWhitespace(s.charAt(i))) i++;
119 if (i > 0) s = s.substring(i);
122 JSDate nd = new JSDate();
123 double date = JSDate.date_msecFromDate(Double.valueOf(s.substring(0, 4)).doubleValue(),
124 Double.valueOf(s.substring(4, 6)).doubleValue() - 1,
125 Double.valueOf(s.substring(6, 8)).doubleValue(),
126 Double.valueOf(s.substring(9, 11)).doubleValue(),
127 Double.valueOf(s.substring(12, 14)).doubleValue(),
128 Double.valueOf(s.substring(15, 17)).doubleValue(),
131 nd.setTime(JSDate.internalUTC(date));
132 objects.setElementAt(nd, objects.size() - 1);
134 } catch (Exception e) {
135 if (Log.on) Log.log(this, "error parsing date : " + s);
136 if (Log.on) Log.log(this, e);
139 } else if (c.localName.equals("member")) {
140 Object memberValue = objects.elementAt(objects.size() - 1);
141 String memberName = (String)objects.elementAt(objects.size() - 2);
142 JS struct = (JS)objects.elementAt(objects.size() - 3);
143 struct.put(memberName, memberValue);
144 objects.setSize(objects.size() - 2);
146 } else if (c.localName.equals("data")) {
148 for(i=objects.size() - 1; objects.elementAt(i) != null; i--);
149 JSArray arr = new JSArray();
150 for(int j = i + 1; j<objects.size(); j++) arr.put(new Integer(j - i - 1), objects.elementAt(j));
151 objects.setElementAt(arr, i);
152 objects.setSize(i + 1);
159 public void characters(char[] ch, int start, int length) {
160 try { content.write(ch, start, length); }
161 catch (Exception e) {
162 if (Log.on) Log.log(this, "Exception in XMLRPC.content() -- this should never happen");
163 if (Log.on) Log.log(this, e);
167 public void whitespace(char[] ch, int start, int length) {}
170 // Methods to make outbound XML-RPC request ///////////////////////////////////////////////////
172 /** Appends the XML-RPC representation of <code>o</code> to <code>sb</code> */
173 void appendObject(Object o, StringBuffer sb) throws JSExn {
176 throw new JSExn("attempted to send a null value via XML-RPC");
178 } else if (o instanceof Number) {
179 if ((double)((Number)o).intValue() == ((Number)o).doubleValue()) {
180 sb.append(" <value><i4>");
181 sb.append(((Number)o).intValue());
182 sb.append("</i4></value>\n");
184 sb.append(" <value><double>");
186 sb.append("</double></value>\n");
189 } else if (o instanceof Boolean) {
190 sb.append(" <value><boolean>");
191 sb.append(((Boolean)o).booleanValue() ? "1" : "0");
192 sb.append("</boolean></value>\n");
194 } else if (o instanceof Res) {
196 sb.append(" <value><base64>\n");
197 InputStream is = ((Res)o).getInputStream();
198 byte[] buf = new byte[54];
200 int numread = is.read(buf, 0, 54);
201 if (numread == -1) break;
202 byte[] writebuf = buf;
203 if (numread < buf.length) {
204 writebuf = new byte[numread];
205 System.arraycopy(buf, 0, writebuf, 0, numread);
208 sb.append(new String(Base64.encode(writebuf)));
211 sb.append("\n </base64></value>\n");
212 } catch (IOException e) {
213 if (Log.on) Log.log(this, "caught IOException while attempting to send a ByteStream via XML-RPC");
214 if (Log.on) Log.log(this, e);
215 throw new JSExn("caught IOException while attempting to send a ByteStream via XML-RPC");
218 } else if (o instanceof String) {
219 sb.append(" <value><string>");
220 String s = (String)o;
221 if (s.indexOf('<') == -1 && s.indexOf('&') == -1) {
224 char[] cbuf = s.toCharArray();
227 while(i < cbuf.length && cbuf[i] != '<' && cbuf[i] != '&') i++;
228 sb.append(cbuf, oldi, i - oldi);
229 if (i >= cbuf.length) break;
230 if (cbuf[i] == '<') sb.append("<");
231 else if (cbuf[i] == '&') sb.append("&");
233 if (i >= cbuf.length) break;
236 sb.append("</string></value>\n");
238 } else if (o instanceof JSDate) {
239 sb.append(" <value><dateTime.iso8601>");
240 java.util.Date d = new java.util.Date(((JSDate)o).getRawTime());
241 sb.append(d.getYear() + 1900);
242 if (d.getMonth() + 1 < 10) sb.append('0');
243 sb.append(d.getMonth() + 1);
244 if (d.getDate() < 10) sb.append('0');
245 sb.append(d.getDate());
247 if (d.getHours() < 10) sb.append('0');
248 sb.append(d.getHours());
250 if (d.getMinutes() < 10) sb.append('0');
251 sb.append(d.getMinutes());
253 if (d.getSeconds() < 10) sb.append('0');
254 sb.append(d.getSeconds());
255 sb.append("</dateTime.iso8601></value>\n");
257 } else if (o instanceof JSArray) {
258 if (tracker.get(o) != null) throw new JSExn("attempted to send multi-ref data structure via XML-RPC");
259 tracker.put(o, Boolean.TRUE);
260 sb.append(" <value><array><data>\n");
261 JSArray a = (JSArray)o;
262 for(int i=0; i<a.length(); i++) appendObject(a.elementAt(i), sb);
263 sb.append(" </data></array></value>\n");
265 } else if (o instanceof JS) {
266 if (tracker.get(o) != null) throw new JSExn("attempted to send multi-ref data structure via XML-RPC");
267 tracker.put(o, Boolean.TRUE);
269 sb.append(" <value><struct>\n");
270 Enumeration e = j.keys();
271 while(e.hasMoreElements()) {
272 Object key = e.nextElement();
273 sb.append(" <member><name>" + key + "</name>\n");
274 appendObject(j.get(key), sb);
275 sb.append(" </member>\n");
277 sb.append(" </struct></value>\n");
280 throw new JSExn("attempt to send object of type " + o.getClass().getName() + " via XML-RPC");
285 public Object call_(JSArray args) throws JSExn, IOException {
286 if (Log.verbose) Log.log(this, "call to " + url + " : " + methodname);
288 if (tracker == null) tracker = new Hash();
289 else tracker.clear();
291 if (objects == null) objects = new Vec();
292 else objects.setSize(0);
294 final String content = send(args, http);
297 BufferedReader br2 = new BufferedReader(new StringReader(content));
298 while ((s = br2.readLine()) != null) Log.log(this, "send: " + s);
301 InputStream is = http.POST("text/xml", content);
303 BufferedReader br = !Log.verbose ?
304 new BufferedReader(new InputStreamReader(is)) :
305 new BufferedReader(new FilterReader(new InputStreamReader(is)) {
306 public int read() throws IOException {
307 int i = super.read();
308 if (Log.on) Log.log(this, "recv: " + ((char)i));
311 public int read(char[] c, int off, int len) throws IOException {
312 int ret = super.read(c, off, len);
313 if (ret == -1) return ret;
315 BufferedReader br2 = new BufferedReader(new StringReader(new String(c, off, ret)));
316 while ((s = br2.readLine()) != null) Log.log(this, "recv: " + s);
326 protected String send(JSArray args, HTTP http) throws JSExn, IOException {
327 StringBuffer content = new StringBuffer();
328 content.append("\r\n");
329 content.append("<?xml version=\"1.0\"?>\n");
330 content.append(" <methodCall>\n");
331 content.append(" <methodName>");
332 content.append(methodname);
333 content.append("</methodName>\n");
334 content.append(" <params>\n");
335 for(int i=0; i<args.length(); i++) {
336 content.append(" <param>\n");
337 appendObject(args.elementAt(i), content);
338 content.append(" </param>\n");
340 content.append(" </params>\n");
341 content.append(" </methodCall>");
342 return content.toString();
345 protected Object recieve(BufferedReader br) throws JSExn, IOException {
348 new Helper().parse(br);
349 } catch (XML.XMLException e) {
350 if (Log.on) Log.log(this, "reply from server was not well-formed XML: " + e);
351 throw new JSExn("reply from server was not well-formed XML: " + e);
354 if (fault) throw new JSExn(objects.elementAt(0));
355 if (objects.size() == 0) return null;
356 return objects.elementAt(0);
359 public final Object call(Object a0, Object a1, Object a2, Object[] rest, int nargs) throws JSExn {
360 JSArray args = new JSArray();
361 for(int i=0; i<nargs; i++) args.addElement(i==0?a0:i==1?a1:i==2?a2:rest[i-3]);
364 public final Object call(final JSArray args) throws JSExn {
366 final JS.UnpauseCallback callback = JS.pause();
367 new java.lang.Thread() {
370 final Object ret = call_(args);
371 Scheduler.add(new Scheduler.Task() {
372 public void perform() {
374 callback.unpause(null);
375 } catch (JS.PausedException pe) {
380 } catch (IOException se) {
381 if (Log.on) Log.log(this, se);
382 throw new JSExn("socket exception: " + se);
386 } catch (NotPauseableException npe) {
387 throw new JSExn("cannot invoke an XML-RPC call in the foreground thread");
391 /** When you get a property from an XMLRPC, it just returns another XMLRPC with the property name tacked onto methodname. */
392 public Object get(Object name) {
393 return new XMLRPC(url, (methodname.equals("") ? "" : methodname + ".") + name.toString(), http);
396 public XMLRPC(String url, String methodname) {
397 this(url, methodname, new HTTP(url));
400 public XMLRPC(String url, String methodname, HTTP http) {
403 this.methodname = methodname;
407 // Helper Classes ///////////////////////////////////////////////////////////////////////////////////
409 /** CharArrayWriter that lets us touch its buffer */
410 protected static class AccessibleCharArrayWriter extends CharArrayWriter {
411 public char[] getBuf() { return buf; }
412 public AccessibleCharArrayWriter(int i) { super(i); }