2003/10/31 09:50:08
[org.ibex.core.git] / src / org / xwt / Res.java
index 5b1fc5f..196bb2c 100644 (file)
 package org.xwt;
 
 import java.io.*;
+import java.util.*;
+import java.util.zip.*;
 import org.xwt.js.*;
+import org.xwt.util.*;
+import org.bouncycastle.util.encoders.Base64;
 
-// FIXME: ByteStream fileName property
 /** base class for XWT resources */
 public abstract class Res extends JS {
 
-    public String toString() { return "Resource, source=FIXME"; }
+    public String getDescriptiveName() { return ""; }
+    public String typeName() { return "resource"; }
 
-    public final InputStream getInputStream() { return getInputStream(""); }
+    /** cache of subresources so that the equality operator works on them */
+    private Hash refCache = null;
 
+    public Template t = null;
+
+    public Res getParent() { return null; }
+
+    /** an InputStream that makes sure it is not in the MessageQueue when blocked on a read */
+    // FIXME
+    private static class BackgroundInputStream extends FilterInputStream {
+        BackgroundInputStream(InputStream i) { super(i); }
+    /*
+        private void suspend() throws IOException {
+            if (!ThreadMessage.suspendThread())
+                throw new IOException("attempt to perform background-only operation in a foreground thread");
+        }
+        private void resume() {
+            ThreadMessage.resumeThread();
+        }
+        public int read() throws IOException {
+            suspend();
+            try { return super.read(); }
+            finally { resume(); }
+        }
+        public int read(byte[] b, int off, int len) throws IOException {
+            suspend();
+            try { return super.read(b, off, len); }
+            finally { resume(); }
+        }
+    */
+    }
+
+    /** returns an InputStream containing the Resource's contents */
+    public final InputStream getInputStream() throws IOException { return new BackgroundInputStream(getInputStream("")); }
+    public abstract InputStream getInputStream(String path) throws IOException;
+
+    /** graft newResource in place of this resource on its parent */
     public Res graft(Object newResource) { throw new JS.Exn("cannot graft onto this resource"); }
-    public Object get(Object key) { return new Ref(this, key); } 
-    public void put(Object key, Object val) { throw new JS.Exn("cannot put to a resource"); } 
-    public Object[] keys() { throw new JS.Exn("cannot enumerate a resource"); } 
 
-    public abstract InputStream getInputStream(String path) { return getInputStream(""); }
-    public abstract Res addExtension(String extension);
+    /** if the path of this resource does not end with extension, return a new one wit it appended */
+    public Res addExtension(String extension) { return new Ref(this, extension); }
+
+    public Object[] keys() { throw new JS.Exn("cannot enumerate a resource"); } 
+    public void put(Object key, Object val) { throw new JS.Exn("cannot put to a resource"); } 
+    public Object get(Object key) {
+        if ("".equals(key)) {
+            Template t = Template.getTemplate(addExtension(".xwt"));
+            return t == null ? null : t.getStatic();
+        }
+        Object ret = refCache == null ? null : refCache.get(key);
+        if (ret != null) return ret;
+        ret = new Ref(this, key);
+        if (refCache == null) refCache = new Hash();
+        refCache.put(key, ret);
+        return ret;
+    }
 
     public static Res stringToRes(String url) {
-        if (url.indexOf('!') == -1)
-            return new Zip(stringToRes(url.substring(0, url.lastIndexOf('!'))),
-                           url.substring(url.lastIndexOf('!') + 1));
+        if (url.indexOf('!') != -1) {
+            Res ret = new Zip(stringToRes(url.substring(0, url.lastIndexOf('!'))));
+            String subpath = url.substring(url.lastIndexOf('!') + 1);
+            if (subpath.length() > 0) ret = (Res)ret.get(subpath);
+            return ret;
+        }
         if (url.startsWith("http://")) return new HTTP(url);
         if (url.startsWith("https://")) return new HTTP(url);
-        throw new JS.Exn("invalid resource specifier");
+        if (url.startsWith("cab:")) return new CAB(stringToRes(url.substring(4)));
+        if (url.startsWith("data:")) return new ByteArray(Base64.decode(url.substring(5)));
+        if (url.startsWith("utf8:")) return new ByteArray(url.substring(5).getBytes());
+        throw new JS.Exn("invalid resource specifier " + url);
+    }
+
+    /** subclass from this if you want a CachedInputStream for each path */
+    public static abstract class CachedRes extends Res {
+        private Hash cachedInputStreams = new Hash();
+        abstract InputStream _getInputStream(String path) throws IOException;
+        public final InputStream getInputStream(String path) throws IOException {
+            CachedInputStream cis = (CachedInputStream)cachedInputStreams.get(path);
+            if (cis == null) {
+                cis = new CachedInputStream(_getInputStream(path));
+                cachedInputStreams.put(path, cis);
+            }
+            return cis.getInputStream();
+        }
     }
 
     /** HTTP or HTTPS resource */
-    public static class HTTP extends Res {
+    public static class HTTP extends CachedRes {
         private String url;
         HTTP(String url) { this.url = url; }
-        public InputStream getInputStream(String path) { return new HTTP(url + path).GET(); }
+        public String getDescriptiveName() { return url; }
+        public InputStream _getInputStream(String path) throws IOException {
+            return new org.xwt.HTTP(url + path).GET(); }
     }
 
-    /** wrap a Res around a preexisting InputStream */
-    public static class IS extends Res {
-        InputStream parent;
-        IS(InputStream parent) { this.parent = parent; }
-        public InputStream getInputStream() { return parent; }
-        public InputStream getInputStream(String path) {
-            if (!"".equals(path)) throw new JS.Exn("can't access subresources of IS");
-            return parent;
+    /** byte arrays */
+    public static class ByteArray extends Res {
+        private byte[] bytes;
+        ByteArray(byte[] bytes) { this.bytes = bytes; }
+        public String getDescriptiveName() { return "byte[]"; }
+        public InputStream getInputStream(String path) throws IOException {
+            if (!"".equals(path)) throw new JS.Exn("can't get subresources of a byte[] resource");
+            return new ByteArrayInputStream(bytes);
         }
     }
 
+    /** a file */
+    public static class File extends Res {
+        private String path;
+        File(String path) { this.path = path; }
+        public String getDescriptiveName() { return "file://" + path; }
+        public InputStream getInputStream(String rest) throws IOException {
+            return new FileInputStream((path + rest).replace('/', java.io.File.separatorChar)); }
+    }
+
     /** "unwrap" a Zip archive */
     public static class Zip extends Res {
         private Res parent;
         Zip(Res parent) { this.parent = parent; }
-        public InputStream getInputStream(String path) {
-            ZipInputStream zis = new ZipInputStream(parent.getInputStream());
+        public String getDescriptiveName() { return parent.getDescriptiveName() + "!"; }
+        public InputStream getInputStream(String path) throws IOException {
+            if (path.startsWith("/")) path = path.substring(1);
+            InputStream pis = parent.getInputStream();
+            ZipInputStream zis = new ZipInputStream(pis);
             ZipEntry ze = zis.getNextEntry();
             while(ze != null && !ze.getName().equals(path)) ze = zis.getNextEntry();
-            if (ze == null) throw new JS.Exn("zip file not found in archive");
-            return zis;
+            if (ze == null) throw new JS.Exn("requested file (" + path + ") not found in archive");
+            return new KnownLength.KnownLengthInputStream(zis, (int)ze.getSize());
         }
     }
 
+    /** the Builtin resource */
+    public static class Builtin extends Res {
+       public Builtin() { };
+       public String getDescriptiveName() { return "[builtin]"; }
+       public InputStream getInputStream(String path) throws IOException {
+           if (!path.equals("")) throw new IOException("the builtin resource has no subresources");
+           return Platform.getBuiltinInputStream();
+       }
+    }
+
     /** what you get when you reference a subresource */
     public static class Ref extends Res {
         Res parent;
         Object key;
         Ref(Res parent, Object key) { this.parent = parent; this.key = key; }
-        public InputStream getInputStream(path) {
+        public String getDescriptiveName() {
+            String pdn = parent.getDescriptiveName();
+           if (pdn.equals("")) return key.toString();
+           if (!pdn.endsWith("!")) pdn += ".";
+           return pdn + key.toString();
+        }
+        public Res addExtension(String extension) {
+            return (key instanceof String && ((String)key).endsWith(extension)) ? this : new Ref(parent, key + extension);
+        }
+        public InputStream getInputStream(String path) throws IOException {
             return parent.getInputStream("/" + key + path);
         }
+        public Res getParent() { return parent; }
         public Res graft(Object newResource) { return new Graft(parent, key, newResource); }
     }
 
+    // FEATURE: eliminate code duplication with JS.Graft
     /** shadow resource which replaces the graft */
     public static class Graft extends Res {
         Res graftee;
         Object replaced_key;
         Object replaced_val;
-        Graft(Res graftee, Object key, Object val) {
-            this.graftee = graftee; replaced_key = key; replaced_val = val; }
+        Graft(Res graftee, Object key, Object val) { this.graftee = graftee; replaced_key = key; replaced_val = val; }
         public boolean equals(Object o) { return (this == o || graftee.equals(o)); }
-        public Object get(Object key) {
-            return replaced_key.equals(key) ? replaced_val : graftee.get(key);
+        public int hashCode() { return graftee.hashCode(); }
+        public InputStream getInputStream(String s) throws IOException { return graftee.getInputStream(s); }
+        public Object get(Object key) { return replaced_key.equals(key) ? replaced_val : graftee.get(key); }
+        public String getDescriptiveName() { return graftee.getDescriptiveName(); }
+        public Res getParent() { return graftee.getParent(); }
+        public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
+            if (!replaced_key.equals(method)) return graftee.callMethod(method, args, checkOnly);
+            if (replaced_val instanceof Callable) return checkOnly ? Boolean.TRUE : ((Callable)replaced_val).call(args);
+            if (checkOnly) return Boolean.FALSE;
+            throw new JS.Exn("attempt to call non-function");
+        }
+        public Number coerceToNumber() { return graftee.coerceToNumber(); }
+        public String coerceToString() { return graftee.coerceToString(); }
+        public boolean coerceToBoolean() { return graftee.coerceToBoolean(); }
+        public String typeName() { return graftee.typeName(); }
+    }
+
+    /** shadow resource which replaces the graft */
+    public static class ProgressWatcher extends Res {
+        final Res watchee;
+        JS.CompiledFunction callback;
+        ProgressWatcher(Res watchee, JS.CompiledFunction callback) { this.watchee = watchee; this.callback = callback; }
+        public String getDescriptiveName() { return watchee.getDescriptiveName(); }
+        public InputStream getInputStream(String s) throws IOException {
+            final InputStream is = watchee.getInputStream(s);
+            return new FilterInputStream(is) {
+                    int bytesDownloaded = 0;
+                    public int read() throws IOException {
+                        int ret = super.read();
+                        if (ret != -1) bytesDownloaded++;
+                        return ret;
+                    }
+                    public int read(byte[] b, int off, int len) throws IOException {
+                        int ret = super.read(b, off, len);
+                        if (ret != 1) bytesDownloaded += ret;
+                        Scheduler.add(new Scheduler.Task() { public Object call(Object arg) {
+                            JS.Array args = new JS.Array();
+                            args.addElement(new Integer(bytesDownloaded));
+                            args.addElement(new Integer(is instanceof KnownLength ? ((KnownLength)is).getLength() : 0));
+                            // FIXME
+                            // new JS.Thread(callback, callbackScope).resume();
+                            return null;
+                        } });
+                        return ret;
+                    }
+                };
         }
     }
 
-    /////////////// bytestream
+    /** unpacks a Microsoft CAB file (possibly embedded in another file; we scan for 'MSCF' */
+    public static class CAB extends Res {
+        private Res parent;
+        CAB(Res parent) { this.parent = parent; }
+        private int swap_endian(int i) {
+            return ((i & 0xff) << 24) | ((i & 0xff00) << 8) | ((i & 0xff0000) >>> 8) | (i >>> 24);
+        }
+        public InputStream getInputStream(String path) throws IOException {
+            try {
+               return org.xwt.util.CAB.getFileInputStream(parent.getInputStream(), 2, path);
+            } catch (EOFException eof) {
+               throw new JS.Exn("MSCF header tag not found in file");
+            } catch (IOException ioe) {
+               throw new JS.Exn("IOException while reading file");
+            }
+        }
+    }
 
     public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
         if (method.equals("getUTF")) {
@@ -102,11 +267,11 @@ public abstract class Res extends JS {
                 }
                 return caw.toString();
             } catch (IOException e) {
-                if (Log.on) Log.log(ByteStream.class, "IO Exception while reading from file");
-                if (Log.on) Log.log(ByteStream.class, e);
-                throw new JS.Exn("error while reading from ByteStream");
+                if (Log.on) Log.log(Res.class, "IO Exception while reading from file");
+                if (Log.on) Log.log(Res.class, e);
+                throw new JS.Exn("error while reading from Resource");
             }
-        } else if (name.equals("getDOM")) {
+        } else if (method.equals("getDOM")) {
             if (checkOnly) return Boolean.TRUE;
             if (args.length() != 0) return null;
             return new XMLHelper().doParse();
@@ -155,9 +320,9 @@ public abstract class Res extends JS {
             } catch (XML.XMLException e) {
                 throw new JS.Exn("error parsing XML: " + e.toString());
             } catch (IOException e) {
-                if (Log.on) Log.log(ByteStream.class, "IO Exception while reading from file");
-                if (Log.on) Log.log(ByteStream.class, e);
-                throw new JS.Exn("error reading from ByteStream");
+                if (Log.on) Log.log(this, "IO Exception while reading from file");
+                if (Log.on) Log.log(this, e);
+                throw new JS.Exn("error reading from Resource");
             }
             return obStack.size() >= 1 ? (JS)obStack.elementAt(0) : null;
         }