src/org/xwt/Res.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.util.*;
   6 import java.util.zip.*;
   7 import org.xwt.js.*;
   8 import org.xwt.util.*;
   9 import org.bouncycastle.util.encoders.Base64;
  10
  11 /** base class for XWT resources */
  12 public abstract class Res extends JS {
  13
  14     public String getDescriptiveName() { return ""; }
  15     public String typeName() { return "resource"; }
  16
  17     /** cache of subresources so that the equality operator works on them */
  18     private Hash refCache = null;
  19
  20     public Template t = null;
  21
  22     public Res getParent() { return null; }
  23
  24     /** an InputStream that makes sure it is not in the MessageQueue when blocked on a read */
  25     private static class BackgroundInputStream extends FilterInputStream {
  26         BackgroundInputStream(InputStream i) { super(i); }
  27         private void suspend() throws IOException {
  28             if (!ThreadMessage.suspendThread())
  29                 throw new IOException("attempt to perform background-only operation in a foreground thread");
  30         }
  31         private void resume() {
  32             ThreadMessage.resumeThread();
  33         }
  34         public int read() throws IOException {
  35             suspend();
  36             try { return super.read(); }
  37             finally { resume(); }
  38         }
  39         public int read(byte[] b, int off, int len) throws IOException {
  40             suspend();
  41             try { return super.read(b, off, len); }
  42             finally { resume(); }
  43         }
  44     }
  45
  46     /** returns an InputStream containing the Resource's contents */
  47     public final InputStream getInputStream() throws IOException { return new BackgroundInputStream(getInputStream("")); }
  48     public abstract InputStream getInputStream(String path) throws IOException;
  49
  50     /** graft newResource in place of this resource on its parent */
  51     public Res graft(Object newResource) { throw new JS.Exn("cannot graft onto this resource"); }
  52
  53     /** if the path of this resource does not end with extension, return a new one wit it appended */
  54     public Res addExtension(String extension) { return new Ref(this, extension); }
  55
  56     public Object[] keys() { throw new JS.Exn("cannot enumerate a resource"); }
  57     public void put(Object key, Object val) { throw new JS.Exn("cannot put to a resource"); }
  58     public Object get(Object key) {
  59         if ("".equals(key)) {
  60             Template t = Template.getTemplate(addExtension(".xwt"));
  61             return t == null ? null : t.getStatic();
  62         }
  63         Object ret = refCache == null ? null : refCache.get(key);
  64         if (ret != null) return ret;
  65         ret = new Ref(this, key);
  66         if (refCache == null) refCache = new Hash();
  67         refCache.put(key, ret);
  68         return ret;
  69     }
  70
  71     public static Res stringToRes(String url) {
  72         if (url.indexOf('!') != -1) {
  73             Res ret = new Zip(stringToRes(url.substring(0, url.lastIndexOf('!'))));
  74             String subpath = url.substring(url.lastIndexOf('!') + 1);
  75             if (subpath.length() > 0) ret = (Res)ret.get(subpath);
  76             return ret;
  77         }
  78         if (url.startsWith("http://")) return new HTTP(url);
  79         if (url.startsWith("https://")) return new HTTP(url);
  80         if (url.startsWith("cab:")) return new CAB(stringToRes(url.substring(4)));
  81         if (url.startsWith("data:")) return new ByteArray(Base64.decode(url.substring(5)));
  82         if (url.startsWith("utf8:")) return new ByteArray(url.substring(5).getBytes());
  83         throw new JS.Exn("invalid resource specifier " + url);
  84     }
  85
  86     /** subclass from this if you want a CachedInputStream for each path */
  87     public static abstract class CachedRes extends Res {
  88         private Hash cachedInputStreams = new Hash();
  89         abstract InputStream _getInputStream(String path) throws IOException;
  90         public final InputStream getInputStream(String path) throws IOException {
  91             CachedInputStream cis = (CachedInputStream)cachedInputStreams.get(path);
  92             if (cis == null) {
  93                 cis = new CachedInputStream(_getInputStream(path));
  94                 cachedInputStreams.put(path, cis);
  95             }
  96             return cis.getInputStream();
  97         }
  98     }
  99
 100     /** HTTP or HTTPS resource */
 101     public static class HTTP extends CachedRes {
 102         private String url;
 103         HTTP(String url) { this.url = url; }
 104         public String getDescriptiveName() { return url; }
 105         public InputStream _getInputStream(String path) throws IOException {
 106             return new org.xwt.HTTP(url + path).GET(); }
 107     }
 108
 109     /** byte arrays */
 110     public static class ByteArray extends Res {
 111         private byte[] bytes;
 112         ByteArray(byte[] bytes) { this.bytes = bytes; }
 113         public String getDescriptiveName() { return "byte[]"; }
 114         public InputStream getInputStream(String path) throws IOException {
 115             if (!"".equals(path)) throw new JS.Exn("can't get subresources of a byte[] resource");
 116             return new ByteArrayInputStream(bytes);
 117         }
 118     }
 119
 120     /** a file */
 121     public static class File extends Res {
 122         private String path;
 123         File(String path) { this.path = path; }
 124         public String getDescriptiveName() { return "file://" + path; }
 125         public InputStream getInputStream(String rest) throws IOException {
 126             return new FileInputStream((path + rest).replace('/', java.io.File.separatorChar)); }
 127     }
 128
 129     /** "unwrap" a Zip archive */
 130     public static class Zip extends Res {
 131         private Res parent;
 132         Zip(Res parent) { this.parent = parent; }
 133         public String getDescriptiveName() { return parent.getDescriptiveName() + "!"; }
 134         public InputStream getInputStream(String path) throws IOException {
 135             if (path.startsWith("/")) path = path.substring(1);
 136             InputStream pis = parent.getInputStream();
 137             ZipInputStream zis = new ZipInputStream(pis);
 138             ZipEntry ze = zis.getNextEntry();
 139             while(ze != null && !ze.getName().equals(path)) ze = zis.getNextEntry();
 140             if (ze == null) throw new JS.Exn("requested file (" + path + ") not found in archive");
 141             return new KnownLength.KnownLengthInputStream(zis, (int)ze.getSize());
 142         }
 143     }
 144
 145     /** the Builtin resource */
 146     public static class Builtin extends Res {
 147         public Builtin() { };
 148         public String getDescriptiveName() { return "[builtin]"; }
 149         public InputStream getInputStream(String path) throws IOException {
 150             if (!path.equals("")) throw new IOException("the builtin resource has no subresources");
 151             return Platform.getBuiltinInputStream();
 152         }
 153     }
 154
 155     /** what you get when you reference a subresource */
 156     public static class Ref extends Res {
 157         Res parent;
 158         Object key;
 159         Ref(Res parent, Object key) { this.parent = parent; this.key = key; }
 160         public String getDescriptiveName() {
 161             String pdn = parent.getDescriptiveName();
 162             if (pdn.equals("")) return key.toString();
 163             if (!pdn.endsWith("!")) pdn += ".";
 164             return pdn + key.toString();
 165         }
 166         public Res addExtension(String extension) {
 167             return (key instanceof String && ((String)key).endsWith(extension)) ? this : new Ref(parent, key + extension);
 168         }
 169         public InputStream getInputStream(String path) throws IOException {
 170             return parent.getInputStream("/" + key + path);
 171         }
 172         public Res getParent() { return parent; }
 173         public Res graft(Object newResource) { return new Graft(parent, key, newResource); }
 174     }
 175
 176     // FEATURE: eliminate code duplication with JS.Graft
 177     /** shadow resource which replaces the graft */
 178     public static class Graft extends Res {
 179         Res graftee;
 180         Object replaced_key;
 181         Object replaced_val;
 182         Graft(Res graftee, Object key, Object val) { this.graftee = graftee; replaced_key = key; replaced_val = val; }
 183         public boolean equals(Object o) { return (this == o || graftee.equals(o)); }
 184         public int hashCode() { return graftee.hashCode(); }
 185         public InputStream getInputStream(String s) throws IOException { return graftee.getInputStream(s); }
 186         public Object get(Object key) { return replaced_key.equals(key) ? replaced_val : graftee.get(key); }
 187         public String getDescriptiveName() { return graftee.getDescriptiveName(); }
 188         public Res getParent() { return graftee.getParent(); }
 189         public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
 190             if (!replaced_key.equals(method)) return graftee.callMethod(method, args, checkOnly);
 191             if (replaced_val instanceof Callable) return checkOnly ? Boolean.TRUE : ((Callable)replaced_val).call(args);
 192             if (checkOnly) return Boolean.FALSE;
 193             throw new JS.Exn("attempt to call non-function");
 194         }
 195         public Number coerceToNumber() { return graftee.coerceToNumber(); }
 196         public String coerceToString() { return graftee.coerceToString(); }
 197         public boolean coerceToBoolean() { return graftee.coerceToBoolean(); }
 198         public String typeName() { return graftee.typeName(); }
 199     }
 200
 201     /** shadow resource which replaces the graft */
 202     public static class ProgressWatcher extends Res {
 203         final Res watchee;
 204         JS.Callable callback;
 205         ProgressWatcher(Res watchee, JS.Callable callback) { this.watchee = watchee; this.callback = callback; }
 206         public String getDescriptiveName() { return watchee.getDescriptiveName(); }
 207         public InputStream getInputStream(String s) throws IOException {
 208             final InputStream is = watchee.getInputStream(s);
 209             return new FilterInputStream(is) {
 210                     int bytesDownloaded = 0;
 211                     public int read() throws IOException {
 212                         int ret = super.read();
 213                         if (ret != -1) bytesDownloaded++;
 214                         return ret;
 215                     }
 216                     public int read(byte[] b, int off, int len) throws IOException {
 217                         int ret = super.read(b, off, len);
 218                         if (ret != 1) bytesDownloaded += ret;
 219                         ThreadMessage.newthread(new JS.Callable() { public Object call(JS.Array a) {
 220                             JS.Array args = new JS.Array();
 221                             args.addElement(new Integer(bytesDownloaded));
 222                             args.addElement(new Integer(is instanceof KnownLength ? ((KnownLength)is).getLength() : 0));
 223                             callback.call(args);
 224                             return null;
 225                         } });
 226                         return ret;
 227                     }
 228                 };
 229         }
 230     }
 231
 232     /** unpacks a Microsoft CAB file (possibly embedded in another file; we scan for 'MSCF' */
 233     public static class CAB extends Res {
 234         private Res parent;
 235         CAB(Res parent) { this.parent = parent; }
 236         private int swap_endian(int i) {
 237             return ((i & 0xff) << 24) | ((i & 0xff00) << 8) | ((i & 0xff0000) >>> 8) | (i >>> 24);
 238         }
 239         public InputStream getInputStream(String path) throws IOException {
 240             try {
 241                return org.xwt.util.CAB.getFileInputStream(parent.getInputStream(), 2, path);
 242             } catch (EOFException eof) {
 243                throw new JS.Exn("MSCF header tag not found in file");
 244             } catch (IOException ioe) {
 245                throw new JS.Exn("IOException while reading file");
 246             }
 247         }
 248     }
 249
 250     public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
 251         if (method.equals("getUTF")) {
 252             if (checkOnly) return Boolean.TRUE;
 253             if (args.length() != 0) return null;
 254             try {
 255                 CharArrayWriter caw = new CharArrayWriter();
 256                 InputStream is = getInputStream();
 257                 BufferedReader r = new BufferedReader(new InputStreamReader(is));
 258                 char[] buf = new char[1024];
 259                 while(true) {
 260                     int numread = r.read(buf, 0, 1024);
 261                     if (numread == -1) break;
 262                     caw.write(buf, 0, numread);
 263                 }
 264                 return caw.toString();
 265             } catch (IOException e) {
 266                 if (Log.on) Log.log(Res.class, "IO Exception while reading from file");
 267                 if (Log.on) Log.log(Res.class, e);
 268                 throw new JS.Exn("error while reading from Resource");
 269             }
 270         } else if (method.equals("getDOM")) {
 271             if (checkOnly) return Boolean.TRUE;
 272             if (args.length() != 0) return null;
 273             return new XMLHelper().doParse();
 274         }
 275         if (checkOnly) return Boolean.FALSE;
 276         return null;
 277     }
 278
 279     private class XMLHelper extends XML {
 280         Vector obStack = new Vector();
 281         public XMLHelper() { super(BUFFER_SIZE); }
 282         public void startElement(XML.Element c) throws XML.SchemaException {
 283             JS o = new JS.Obj();
 284             o.put("$name", c.localName);
 285             for(int i=0; i<c.len; i++) o.put(c.keys[i], c.vals[i]);
 286             o.put("$numchildren", new Integer(0));
 287             obStack.addElement(o);
 288         }
 289         public void endElement(XML.Element c) throws XML.SchemaException {
 290             if (obStack.size() == 1) return;
 291             JS me = (JS)obStack.lastElement();
 292             obStack.setSize(obStack.size() - 1);
 293             JS parent = (JS)obStack.lastElement();
 294             int numchildren = ((Integer)parent.get("$numchildren")).intValue();
 295             parent.put("$numchildren", new Integer(numchildren + 1));
 296             parent.put(new Integer(numchildren), me);
 297         }
 298         public void characters(char[] ch, int start, int length) throws XML.SchemaException {
 299             String s = new String(ch, start, length);
 300             JS parent = (JS)obStack.lastElement();
 301             int numchildren = ((Integer)parent.get("$numchildren")).intValue();
 302             Object lastChild = parent.get(new Integer(numchildren - 1));
 303             if (lastChild instanceof String) {
 304                 parent.put(new Integer(numchildren - 1), lastChild + s);
 305             } else {
 306                 parent.put("$numchildren", new Integer(numchildren + 1));
 307                 parent.put(new Integer(numchildren), s);
 308             }
 309         }
 310         public void whitespace(char[] ch, int start, int length) {}
 311         public JS doParse() throws JS.Exn {
 312             try {
 313                 InputStream is = getInputStream();
 314                 BufferedReader r = new BufferedReader(new InputStreamReader(is));
 315                 parse(r);
 316             } catch (XML.XMLException e) {
 317                 throw new JS.Exn("error parsing XML: " + e.toString());
 318             } catch (IOException e) {
 319                 if (Log.on) Log.log(this, "IO Exception while reading from file");
 320                 if (Log.on) Log.log(this, e);
 321                 throw new JS.Exn("error reading from Resource");
 322             }
 323             return obStack.size() >= 1 ? (JS)obStack.elementAt(0) : null;
 324         }
 325     }
 326
 327     public void writeTo(OutputStream os) throws IOException {
 328         InputStream is = getInputStream();
 329         byte[] buf = new byte[1024];
 330         while(true) {
 331             int numread = is.read(buf, 0, 1024);
 332             if (numread == -1) break;
 333             if (Log.on) Log.log(this, "wrote " + numread + " bytes");
 334             os.write(buf, 0, numread);
 335         }
 336         os.flush();
 337
 338         // we have to close this because flush() doesn't work on Win32-GCJ
 339         os.close();
 340     }
 341 }