changes made after tupshins reconstruction
[org.ibex.core.git] / src / org / xwt / Stream.java
index 8300478..3d847e8 100644 (file)
@@ -1,5 +1,4 @@
-// FIXEME
-// Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
+// Copyright 2004 Adam Megacz, see the COPYING file for licensing [GPL]
 package org.xwt;
 
 import java.io.*;
@@ -7,136 +6,74 @@ import java.util.*;
 import java.util.zip.*;
 import org.xwt.js.*;
 import org.xwt.util.*;
+import org.xwt.translators.MSPack;
 import org.bouncycastle.util.encoders.Base64;
 
+/**
+ *   Essentiall an InputStream "factory".  You can repeatedly ask a
+ *   Stream for an InputStream, and each InputStream you get back will
+ *   be totally independent of the others (ie separate stream position
+ *   and state) although they draw from the same data source.
+ */
+public abstract class Stream extends JS.Cloneable {
 
-/** Base class for XWT resources */
-public abstract class Stream extends JS {
-
-    /** return a resource for a given url */
-    public static final Stream fromURL(String url) throws JSExn {
-        if (url.startsWith("http://")) return new Stream.HTTP(url);
-        else if (url.startsWith("https://")) return new Stream.HTTP(url);
-        else if (url.startsWith("data:")) return new Stream.ByteArray(Base64.decode(url.substring(5)), null);
-        else if (url.startsWith("utf8:")) return new Stream.ByteArray(url.substring(5).getBytes(), null);
-        throw new JSExn("invalid resource specifier " + url);
-    }
-
-    // Base Class //////////////////////////////////////////////////////////////////////
-
-    public String typeName() { return "resource"; }
-
-    /** so that we get the same subresource each time */
-    private Hash refCache = null;
-
-    public Template t = null;
-
-    public final InputStream getInputStream() throws IOException { return getInputStream(""); }
-    public abstract InputStream getInputStream(String path) throws IOException;
-
-    public Stream addExtension(String extension) { return new Ref(this, extension); }
-
-    public Object get(Object key) throws JSExn {
-        if ("".equals(key)) {
-            try {
-                Template t = Template.getTemplate(addExtension(".xwt"));
-                return t == null ? null : t.getStatic(null);  /** FIXME VERY BAD! */
-            } catch (Exception e) {
-                Log.info(this, e);
-                return null;
-            }
-        }
-        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;
-    }
-
-
-
-    // Caching //////////////////////////////////////////////////////////////////////
+    // Public Interface //////////////////////////////////////////////////////////////////////////////
 
+    public static InputStream getInputStream(Object js) throws IOException { return ((Stream)((JS)js).unclone()).getInputStream();}
     public static class NotCacheableException extends Exception { }
-    public static NotCacheableException notCacheable = new NotCacheableException();
 
-    /** if it makes sense to cache a resource, the resource must return a unique key */
-    public String getCacheKey() throws NotCacheableException { throw notCacheable; }
-
-    /** subclass from this if you want a CachedInputStream for each path */
-    public static class CachedStream extends Stream {
-        private Stream parent;
-        private boolean disk = false;
-        private String key;
-        public String getCacheKey() throws NotCacheableException { return key; }
-        public String toString() { return key; }
-        private Hash cachedInputStreams = new Hash();
-        public CachedStream(Stream p, String s, boolean d) throws NotCacheableException {
-            this.parent = p; this.disk = d; this.key = p.getCacheKey();
-        }
-        public InputStream getInputStream(String path) throws IOException {
-            CachedInputStream cis = (CachedInputStream)cachedInputStreams.get(path);
-            if (cis == null) {
-                if (disk) {
-                    java.io.File f = LocalStorage.Cache.getCacheFileForKey(key);
-                    if (f.exists()) return new FileInputStream(f);
-                    cis = new CachedInputStream(parent.getInputStream(path), f);
-                } else {
-                    cis = new CachedInputStream(parent.getInputStream(path));
-                }
-                cachedInputStreams.put(path, cis);
-            }
-            return cis.getInputStream();
-        }
-    }
+    // streams are "sealed" by default to prevent accidental object leakage
+    public void put(Object key, Object val) throws JSExn { }
+    public Object get(Object key) throws JSExn { return null; }
 
+    // Private Interface //////////////////////////////////////////////////////////////////////////////
 
-    // Useful Subclasses //////////////////////////////////////////////////////////////////////
+    protected abstract InputStream getInputStream() throws IOException;
+    protected String getCacheKey() throws NotCacheableException { throw new NotCacheableException(); }
 
     /** HTTP or HTTPS resource */
     public static class HTTP extends Stream {
         private String url;
+        public String toString() { return "Stream.HTTP:" + url; }
         HTTP(String url) { while (url.endsWith("/")) url = url.substring(0, url.length() - 1); this.url = url; }
-        public String toString() { return url; }
-        public String getCacheKey() throws NotCacheableException { return url; }
-        public InputStream getInputStream(String path) throws IOException { return new org.xwt.HTTP(url + path).GET(); }
+        public Object get(Object key) throws JSExn { return new HTTP(url + "/" + (String)key); }
+        public String getCacheKey(Vec path) throws NotCacheableException { return url; }
+        public InputStream getInputStream() throws IOException { return new org.xwt.HTTP(url).GET(); }
     }
 
     /** byte arrays */
     public static class ByteArray extends Stream {
         private byte[] bytes;
-        private String cacheKey = null;
+        private String cacheKey;
         ByteArray(byte[] bytes, String cacheKey) { this.bytes = bytes; this.cacheKey = cacheKey; }
-        public String toString() { return "byte[]"; }
-        public String getCacheKey() throws NotCacheableException { return cacheKey; }
-        public InputStream getInputStream(String path) throws IOException {
-            if (!"".equals(path)) throw new IOException("can't get subresources of a byte[] resource");
-            return new ByteArrayInputStream(bytes);
-        }
+        public String getCacheKey() throws NotCacheableException {
+            if (cacheKey == null) throw new NotCacheableException(); return cacheKey; }
+        public InputStream getInputStream() throws IOException { return new ByteArrayInputStream(bytes); }
     }
 
     /** a file */
     public static class File extends Stream {
         private String path;
-        File(String path) {
-            while (path.endsWith(java.io.File.separatorChar + "")) path = path.substring(0, path.length() - 1);
-            this.path = path;
-        }
+        File(String path) { this.path = path; }
         public String toString() { return "file:" + path; }
-        public String getCacheKey() throws NotCacheableException { throw notCacheable; }  // already on the disk!
-        public InputStream getInputStream(String rest) throws IOException {
-            return new FileInputStream((path + rest).replace('/', java.io.File.separatorChar)); }
+        public String getCacheKey() throws NotCacheableException { throw new NotCacheableException(); /* already on disk */ }
+        public InputStream getInputStream() throws IOException { return new FileInputStream(path); }
+        public Object get(Object key) throws JSExn { return new File(path + java.io.File.separatorChar + (String)key); }
     }
 
     /** "unwrap" a Zip archive */
     public static class Zip extends Stream {
         private Stream parent;
-        Zip(Stream parent) { this.parent = parent; }
-        public String toString() { return parent.toString() + "!zip"; }
+        private String path;
+        Zip(Stream parent) { this(parent, null); }
+        Zip(Stream parent, String path) {
+            while(path != null && path.startsWith("/")) path = path.substring(1);
+            this.parent = parent;
+            this.path = path;
+        }
         public String getCacheKey() throws NotCacheableException { return parent.getCacheKey() + "!zip:"; }
-        public InputStream getInputStream(String path) throws IOException {
-            if (path.startsWith("/")) path = path.substring(1);
+        public Object get(Object key) throws JSExn { return new Zip(parent, path==null?(String)key:path+'/'+(String)key); }
+        public InputStream getInputStream() throws IOException {
             InputStream pis = parent.getInputStream();
             ZipInputStream zis = new ZipInputStream(pis);
             ZipEntry ze = zis.getNextEntry();
@@ -149,70 +86,29 @@ public abstract class Stream extends JS {
     /** "unwrap" a Cab archive */
     public static class Cab extends Stream {
         private Stream parent;
-        Cab(Stream parent) { this.parent = parent; }
-        public String toString() { return parent.toString() + "!cab"; }
+        private String path;
+        Cab(Stream parent) { this(parent, null); }
+        Cab(Stream parent, String path) { this.parent = parent; this.path = path; }
         public String getCacheKey() throws NotCacheableException { return parent.getCacheKey() + "!cab:"; }
-        public InputStream getInputStream(String path) throws IOException {
-            if (path.startsWith("/")) path = path.substring(1);
-            return new org.xwt.translators.MSPack(parent.getInputStream()).getInputStream(path);
-        }
+        public Object get(Object key) throws JSExn { return new Cab(parent, path==null?(String)key:path+'/'+(String)key); }
+        public InputStream getInputStream() throws IOException { return new MSPack(parent.getInputStream()).getInputStream(path); }
     }
 
     /** the Builtin resource */
     public static class Builtin extends Stream {
         public Builtin() { };
-        public String getCacheKey() throws NotCacheableException { throw notCacheable; }    // not cacheable
-        public String toString() { 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 Stream {
-        Stream parent;
-        Object key;
-        public String toString() { return parent.toString() + "/" + key; }
-        Ref(Stream parent, Object key) { this.parent = parent; this.key = key; }
-        public String getCacheKey() throws NotCacheableException { return parent.getCacheKey() + "/" + key; }
-        public Stream addExtension(String extension) {
-            return ((String)key).endsWith(extension) ? this : new Ref(parent, key + extension); }
-        public InputStream getInputStream(String path) throws IOException { return parent.getInputStream("/" + key + path); }
-    }
-
-    /** provides redirection of a specified key */
-    public static class Graft extends Stream {
-        Stream graftee;
-        Object replaced_key, replaced_val;
-        Graft(Stream graftee, Object key, Object val) { this.graftee = graftee; this.replaced_key = key; this.replaced_val = val; }
-        public boolean equals(Object o) { return this == o || graftee.equals(o); }
-        public int hashCode() { return graftee.hashCode(); }
-        public InputStream getInputStream(String s) throws IOException { return graftee.getInputStream(s); }
-        public Object get(Object key) throws JSExn { return replaced_key.equals(key) ? replaced_val : graftee.get(key); }
-        public Object callMethod(Object name, Object a, Object b, Object c, Object[] rest, int nargs) throws JSExn {
-            if (replaced_key.equals(name)) {
-                if (replaced_val instanceof JS) return ((JS)replaced_val).call(a, b, c, rest, nargs);
-                else throw new JSExn("attempted to call non-function (class="+replaced_val.getClass()+")");
-            } else {
-                return graftee.callMethod(name, a, b, c, rest, nargs);
-            }
-        }
-        public Number coerceToNumber() { return graftee.coerceToNumber(); }
-        public String coerceToString() { return graftee.coerceToString(); }
-        public boolean coerceToBoolean() { return graftee.coerceToBoolean(); }
-        public String typeName() { return graftee.typeName(); }
+        public String getCacheKey() throws NotCacheableException { throw new NotCacheableException(); }
+        public InputStream getInputStream() throws IOException { return Platform.getBuiltinInputStream(); }
     }
 
     /** shadow resource which replaces the graft */
     public static class ProgressWatcher extends Stream {
         final Stream watchee;
-        JSFunction callback;
-        ProgressWatcher(Stream watchee, JSFunction callback) { this.watchee = watchee; this.callback = callback; }
-        public String toString() { return watchee.toString(); }
+        JS callback;
+        ProgressWatcher(Stream watchee, JS callback) { this.watchee = watchee; this.callback = callback; }
         public String getCacheKey() throws NotCacheableException { return watchee.getCacheKey(); }
-        public InputStream getInputStream(String s) throws IOException {
-            final InputStream is = watchee.getInputStream(s);
+        public InputStream getInputStream() throws IOException {
+            final InputStream is = watchee.getInputStream();
             return new FilterInputStream(is) {
                     int bytesDownloaded = 0;
                     public int read() throws IOException {
@@ -232,4 +128,27 @@ public abstract class Stream extends JS {
                 };
         }
     }
+
+    /** subclass from this if you want a CachedInputStream for each path */
+    public static class CachedStream extends Stream {
+        private Stream parent;
+        private boolean disk = false;
+        private String key;
+        public String getCacheKey() throws NotCacheableException { return key; }
+        CachedInputStream cis = null;
+        public CachedStream(Stream p, String s, boolean d) throws NotCacheableException {
+            this.parent = p; this.disk = d; this.key = p.getCacheKey();
+        }
+        public InputStream getInputStream() throws IOException {
+            if (cis != null) return cis.getInputStream();
+            if (!disk) {
+                cis = new CachedInputStream(parent.getInputStream());
+            } else {
+                java.io.File f = LocalStorage.Cache.getCacheFileForKey(key);
+                if (f.exists()) return new FileInputStream(f);
+                cis = new CachedInputStream(parent.getInputStream(), f);
+            }
+            return cis.getInputStream();
+        }
+    }
 }