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     /** what you get when you reference a subresource */
 146     public static class Ref extends Res {
 147         Res parent;
 148         Object key;
 149         Ref(Res parent, Object key) { this.parent = parent; this.key = key; }
 150         public String getDescriptiveName() {
 151             String pdn = parent.getDescriptiveName();
 152             return pdn.equals("") ? key.toString() : (pdn + "." + key.toString());
 153         }
 154         public Res addExtension(String extension) {
 155             return (key instanceof String && ((String)key).endsWith(extension)) ? this : new Ref(parent, key + extension);
 156         }
 157         public InputStream getInputStream(String path) throws IOException {
 158             return parent.getInputStream("/" + key + path);
 159         }
 160         public Res getParent() { return parent; }
 161         public Res graft(Object newResource) { return new Graft(parent, key, newResource); }
 162     }
 163
 164     // FEATURE: eliminate code duplication with JS.Graft
 165     /** shadow resource which replaces the graft */
 166     public static class Graft extends Res {
 167         Res graftee;
 168         Object replaced_key;
 169         Object replaced_val;
 170         Graft(Res graftee, Object key, Object val) { this.graftee = graftee; replaced_key = key; replaced_val = val; }
 171         public boolean equals(Object o) { return (this == o || graftee.equals(o)); }
 172         public int hashCode() { return graftee.hashCode(); }
 173         public InputStream getInputStream(String s) throws IOException { return graftee.getInputStream(s); }
 174         public Object get(Object key) { return replaced_key.equals(key) ? replaced_val : graftee.get(key); }
 175         public String getDescriptiveName() { return graftee.getDescriptiveName(); }
 176         public Res getParent() { return graftee.getParent(); }
 177         public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
 178             if (!replaced_key.equals(method)) return graftee.callMethod(method, args, checkOnly);
 179             if (replaced_val instanceof Callable) return checkOnly ? Boolean.TRUE : ((Callable)replaced_val).call(args);
 180             if (checkOnly) return Boolean.FALSE;
 181             throw new JS.Exn("attempt to call non-function");
 182         }
 183         public Number coerceToNumber() { return graftee.coerceToNumber(); }
 184         public String coerceToString() { return graftee.coerceToString(); }
 185         public boolean coerceToBoolean() { return graftee.coerceToBoolean(); }
 186         public String typeName() { return graftee.typeName(); }
 187     }
 188
 189     /** shadow resource which replaces the graft */
 190     public static class ProgressWatcher extends Res {
 191         final Res watchee;
 192         JS.Callable callback;
 193         ProgressWatcher(Res watchee, JS.Callable callback) { this.watchee = watchee; this.callback = callback; }
 194         public String getDescriptiveName() { return watchee.getDescriptiveName(); }
 195         public InputStream getInputStream(String s) throws IOException {
 196             final InputStream is = watchee.getInputStream(s);
 197             return new FilterInputStream(is) {
 198                     int bytesDownloaded = 0;
 199                     public int read() throws IOException {
 200                         int ret = super.read();
 201                         if (ret != -1) bytesDownloaded++;
 202                         return ret;
 203                     }
 204                     public int read(byte[] b, int off, int len) throws IOException {
 205                         int ret = super.read(b, off, len);
 206                         if (ret != 1) bytesDownloaded += ret;
 207                         ThreadMessage.newthread(new JS.Callable() { public Object call(JS.Array a) {
 208                             JS.Array args = new JS.Array();
 209                             args.addElement(new Integer(bytesDownloaded));
 210                             args.addElement(new Integer(is instanceof KnownLength ? ((KnownLength)is).getLength() : 0));
 211                             callback.call(args);
 212                             return null;
 213                         } });
 214                         return ret;
 215                     }
 216                 };
 217         }
 218     }
 219
 220     /** unpacks a Microsoft CAB file (possibly embedded in another file; we scan for 'MSCF' */
 221     public static class CAB extends Res {
 222         private Res parent;
 223         CAB(Res parent) { this.parent = parent; }
 224         private int swap_endian(int i) {
 225             return ((i & 0xff) << 24) | ((i & 0xff00) << 8) | ((i & 0xff0000) >>> 8) | (i >>> 24);
 226         }
 227         public InputStream getInputStream(String path) throws IOException {
 228             try {
 229                return org.xwt.util.CAB.getFileInputStream(parent.getInputStream(), 2, path);
 230             } catch (EOFException eof) {
 231                throw new JS.Exn("MSCF header tag not found in file");
 232             } catch (IOException ioe) {
 233                throw new JS.Exn("IOException while reading file");
 234             }
 235         }
 236     }
 237
 238     public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
 239         if (method.equals("getUTF")) {
 240             if (checkOnly) return Boolean.TRUE;
 241             if (args.length() != 0) return null;
 242             try {
 243                 CharArrayWriter caw = new CharArrayWriter();
 244                 InputStream is = getInputStream();
 245                 BufferedReader r = new BufferedReader(new InputStreamReader(is));
 246                 char[] buf = new char[1024];
 247                 while(true) {
 248                     int numread = r.read(buf, 0, 1024);
 249                     if (numread == -1) break;
 250                     caw.write(buf, 0, numread);
 251                 }
 252                 return caw.toString();
 253             } catch (IOException e) {
 254                 if (Log.on) Log.log(Res.class, "IO Exception while reading from file");
 255                 if (Log.on) Log.log(Res.class, e);
 256                 throw new JS.Exn("error while reading from Resource");
 257             }
 258         } else if (method.equals("getDOM")) {
 259             if (checkOnly) return Boolean.TRUE;
 260             if (args.length() != 0) return null;
 261             return new XMLHelper().doParse();
 262         }
 263         if (checkOnly) return Boolean.FALSE;
 264         return null;
 265     }
 266
 267     private class XMLHelper extends XML {
 268         Vector obStack = new Vector();
 269         public XMLHelper() { super(BUFFER_SIZE); }
 270         public void startElement(XML.Element c) throws XML.SchemaException {
 271             JS o = new JS.Obj();
 272             o.put("$name", c.localName);
 273             for(int i=0; i<c.len; i++) o.put(c.keys[i], c.vals[i]);
 274             o.put("$numchildren", new Integer(0));
 275             obStack.addElement(o);
 276         }
 277         public void endElement(XML.Element c) throws XML.SchemaException {
 278             if (obStack.size() == 1) return;
 279             JS me = (JS)obStack.lastElement();
 280             obStack.setSize(obStack.size() - 1);
 281             JS parent = (JS)obStack.lastElement();
 282             int numchildren = ((Integer)parent.get("$numchildren")).intValue();
 283             parent.put("$numchildren", new Integer(numchildren + 1));
 284             parent.put(new Integer(numchildren), me);
 285         }
 286         public void characters(char[] ch, int start, int length) throws XML.SchemaException {
 287             String s = new String(ch, start, length);
 288             JS parent = (JS)obStack.lastElement();
 289             int numchildren = ((Integer)parent.get("$numchildren")).intValue();
 290             Object lastChild = parent.get(new Integer(numchildren - 1));
 291             if (lastChild instanceof String) {
 292                 parent.put(new Integer(numchildren - 1), lastChild + s);
 293             } else {
 294                 parent.put("$numchildren", new Integer(numchildren + 1));
 295                 parent.put(new Integer(numchildren), s);
 296             }
 297         }
 298         public void whitespace(char[] ch, int start, int length) {}
 299         public JS doParse() throws JS.Exn {
 300             try {
 301                 InputStream is = getInputStream();
 302                 BufferedReader r = new BufferedReader(new InputStreamReader(is));
 303                 parse(r);
 304             } catch (XML.XMLException e) {
 305                 throw new JS.Exn("error parsing XML: " + e.toString());
 306             } catch (IOException e) {
 307                 if (Log.on) Log.log(this, "IO Exception while reading from file");
 308                 if (Log.on) Log.log(this, e);
 309                 throw new JS.Exn("error reading from Resource");
 310             }
 311             return obStack.size() >= 1 ? (JS)obStack.elementAt(0) : null;
 312         }
 313     }
 314
 315     public void writeTo(OutputStream os) throws IOException {
 316         InputStream is = getInputStream();
 317         byte[] buf = new byte[1024];
 318         while(true) {
 319             int numread = is.read(buf, 0, 1024);
 320             if (numread == -1) break;
 321             if (Log.on) Log.log(this, "wrote " + numread + " bytes");
 322             os.write(buf, 0, numread);
 323         }
 324         os.flush();
 325
 326         // we have to close this because flush() doesn't work on Win32-GCJ
 327         os.close();
 328     }
 329 }