2003/11/03 07:36:40
[org.ibex.core.git] / src / org / xwt / Res.java
index 896220b..3bf88ee 100644 (file)
@@ -11,7 +11,7 @@ import org.bouncycastle.util.encoders.Base64;
 /** base class for XWT resources */
 public abstract class Res extends JS {
 
-    public String getDescriptiveName() { return ""; }
+    public abstract String getDescriptiveName();
     public String typeName() { return "resource"; }
 
     /** cache of subresources so that the equality operator works on them */
@@ -21,8 +21,33 @@ public abstract class Res extends JS {
 
     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 InputStream getInputStream() throws IOException { return getInputStream(""); }
+    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 */
@@ -32,7 +57,7 @@ public abstract class Res extends JS {
     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 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"));
@@ -46,28 +71,52 @@ public abstract class Res extends JS {
         return ret;
     }
 
-    public static Res stringToRes(String url) { return stringToRes(url, false); }
-    public static Res stringToRes(String url, boolean permitLocalFilesystem) {
-        if (url.indexOf('!') != -1)
-            return (Res)(new Zip(stringToRes(url.substring(0, url.lastIndexOf('!')))).
-                         get(url.substring(url.lastIndexOf('!') + 1)));
+    public static Res stringToRes(String url) {
+        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);
-        if (url.startsWith("file:") && permitLocalFilesystem) return new File(url.substring(5));
-        if (url.startsWith("cab:")) return new CAB(stringToRes(url.substring(4)));
+        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 {
+    public static class CachedRes extends Res {
+        private Res parent;
+        private boolean disk = false;
+
+        // FIXME: security concern here
+        private String subdir = null;
+
+        public String getDescriptiveName() { return parent.getDescriptiveName(); }
         private Hash cachedInputStreams = new Hash();
-        abstract InputStream _getInputStream(String path) throws IOException;
-        public final InputStream getInputStream(String path) throws IOException {
+        public CachedRes(Res parent, String subdir, boolean disk) {
+            this.parent = parent; this.disk = disk; this.subdir = subdir;
+        }
+        public InputStream getInputStream(String path) throws IOException {
             CachedInputStream cis = (CachedInputStream)cachedInputStreams.get(path);
             if (cis == null) {
-                cis = new CachedInputStream(_getInputStream(path));
+                java.io.File f = null;
+                if (disk) {
+                    // FIXME ugly
+                    // FIXME need separate hash for disk/nondisk
+                    f = new java.io.File(System.getProperty("user.home") +
+                                         java.io.File.separatorChar + ".xwt" +
+                                         java.io.File.separatorChar + "caches" +
+                                         java.io.File.separatorChar + subdir +
+                                         java.io.File.separatorChar +
+                                         new String(Base64.encode(parent.getDescriptiveName().getBytes())));
+                    Log.log(this, "caching resource in " + f);
+                    new java.io.File(f.getParent()).mkdirs();
+                    if (f.exists()) return new FileInputStream(f);
+                }
+                cis = new CachedInputStream(parent.getInputStream(path), f);
                 cachedInputStreams.put(path, cis);
             }
             return cis.getInputStream();
@@ -75,10 +124,11 @@ public abstract class Res extends JS {
     }
 
     /** HTTP or HTTPS resource */
-    public static class HTTP extends CachedRes {
+    public static class HTTP extends Res {
         private String url;
         HTTP(String url) { this.url = url; }
-        public InputStream _getInputStream(String path) throws IOException {
+        public String getDescriptiveName() { return url; }
+        public InputStream getInputStream(String path) throws IOException {
             return new org.xwt.HTTP(url + path).GET(); }
     }
 
@@ -86,6 +136,7 @@ public abstract class Res extends JS {
     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);
@@ -96,34 +147,49 @@ public abstract class Res extends JS {
     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)); }
     }
 
-    /** wrap a Res around a preexisting InputStream */
-    public static class IS extends Res {
-        InputStream parent;
-        IS(InputStream parent) { this.parent = parent; }
-        public InputStream getInputStream(String path) {
-            if (!"".equals(path)) throw new JS.Exn("can't access subresources of IS");
-            return parent;
-        }
-    }
-
     /** "unwrap" a Zip archive */
     public static class Zip extends Res {
         private Res parent;
         Zip(Res parent) { this.parent = parent; }
+        public String getDescriptiveName() { return parent.getDescriptiveName() + "!"; }
         public InputStream getInputStream(String path) throws IOException {
             if (path.startsWith("/")) path = path.substring(1);
-            ZipInputStream zis = new ZipInputStream(parent.getInputStream());
+            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("requested 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());
         }
     }
 
+    /** "unwrap" a Cab archive */
+    public static class Cab extends Res {
+        private Res parent;
+        Cab(Res parent) { this.parent = parent; }
+        public String getDescriptiveName() { return "cab[" + parent.getDescriptiveName() + "]"; }
+        public InputStream getInputStream(String path) throws IOException {
+            // FIXME: knownlength
+            if (path.startsWith("/")) path = path.substring(1);
+            return new org.xwt.translators.MSPack(parent.getInputStream()).getInputStream(path);
+        }
+    }
+
+    /** 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;
@@ -131,7 +197,9 @@ public abstract class Res extends JS {
         Ref(Res parent, Object key) { this.parent = parent; this.key = key; }
         public String getDescriptiveName() {
             String pdn = parent.getDescriptiveName();
-            return pdn.equals("") ? key.toString() : (pdn + "." + key.toString());
+           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);
@@ -170,11 +238,13 @@ public abstract class Res extends JS {
 
     /** shadow resource which replaces the graft */
     public static class ProgressWatcher extends Res {
-        Res watchee;
-        JS.Callable callback;
-        ProgressWatcher(Res watchee, JS.Callable callback) { this.watchee = watchee; this.callback = callback; }
+        final Res watchee;
+        Function callback;
+        ProgressWatcher(Res watchee, Function callback) { this.watchee = watchee; this.callback = callback; }
+        public String getDescriptiveName() { return watchee.getDescriptiveName(); }
         public InputStream getInputStream(String s) throws IOException {
-            return new FilterInputStream(watchee.getInputStream(s)) {
+            final InputStream is = watchee.getInputStream(s);
+            return new FilterInputStream(is) {
                     int bytesDownloaded = 0;
                     public int read() throws IOException {
                         int ret = super.read();
@@ -184,11 +254,12 @@ public abstract class Res extends JS {
                     public int read(byte[] b, int off, int len) throws IOException {
                         int ret = super.read(b, off, len);
                         if (ret != 1) bytesDownloaded += ret;
-                        ThreadMessage.newthread(new JS.Callable() { public Object call(JS.Array a) {
+                        Scheduler.add(new Scheduler.Task() { public void perform() {
                             JS.Array args = new JS.Array();
                             args.addElement(new Integer(bytesDownloaded));
-                            callback.call(args);
-                            return null;
+                            args.addElement(new Integer(is instanceof KnownLength ? ((KnownLength)is).getLength() : 0));
+                            // FIXME
+                            //new JS.Context(callback, null, args).resume();
                         } });
                         return ret;
                     }
@@ -196,24 +267,6 @@ public abstract class Res extends JS {
         }
     }
 
-    /** 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")) {
             if (checkOnly) return Boolean.TRUE;