2003/11/19 02:40:17
[org.ibex.core.git] / src / org / xwt / Res.java
index 5b1fc5f..ae2b50f 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 */
+
+/** Base class for XWT resources */
 public abstract class Res extends JS {
 
-    public String toString() { return "Resource, source=FIXME"; }
+    // Base Class //////////////////////////////////////////////////////////////////////
+
+    public String typeName() { return "resource"; }
+
+    /** so that we get the same subresource each time */
+    private Hash refCache = null;
 
-    public final InputStream getInputStream() { return getInputStream(""); }
+    /** FIXME: needed? good idea? */
+    public Template t = null;
 
-    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 final InputStream getInputStream() throws IOException { return getInputStream(""); }
+    public abstract InputStream getInputStream(String path) throws IOException;
 
-    public abstract InputStream getInputStream(String path) { return getInputStream(""); }
-    public abstract Res addExtension(String extension);
+    public Res addExtension(String extension) { return new Ref(this, extension); }
 
-    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.startsWith("http://")) return new HTTP(url);
-        if (url.startsWith("https://")) return new HTTP(url);
-        throw new JS.Exn("invalid resource specifier");
+    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;
     }
 
+
+
+    // Caching //////////////////////////////////////////////////////////////////////
+
+    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; }
+
+    // FIXME: general cleanup
+    /** subclass from this if you want a CachedInputStream for each path */
+    public static class CachedRes extends Res {
+        private Res 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 CachedRes(Res 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) {
+                java.io.File f = null;
+                if (disk) {
+                    f = new java.io.File(System.getProperty("user.home") +
+                                         java.io.File.separatorChar + ".xwt" +
+                                         java.io.File.separatorChar + "caches" +
+                                         java.io.File.separatorChar +
+                                         new String(Base64.encode(key.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();
+        }
+    }
+
+
+    // Useful Subclasses //////////////////////////////////////////////////////////////////////
+
     /** HTTP or HTTPS resource */
     public static class HTTP extends Res {
         private String url;
-        HTTP(String url) { this.url = url; }
-        public InputStream getInputStream(String path) { return new HTTP(url + path).GET(); }
+        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(); }
     }
 
-    /** 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;
+        private String cacheKey = null;
+        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 JSExn("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) {
+            while (path.endsWith(java.io.File.separatorChar + "")) path = path.substring(0, path.length() - 1);
+            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)); }
+    }
+
     /** "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 toString() { return parent.toString() + "!zip"; }
+        public String getCacheKey() throws NotCacheableException { return parent.getCacheKey() + "!zip:"; }
+        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;
-        }
-    }
-
-    /** 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) {
-            return parent.getInputStream("/" + key + path);
+            if (ze == null) throw new JSExn("requested file (" + path + ") not found in archive");
+            return new KnownLength.KnownLengthInputStream(zis, (int)ze.getSize());
         }
-        public Res graft(Object newResource) { return new Graft(parent, key, newResource); }
     }
 
-    /** 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; }
-        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);
+    /** "unwrap" a Cab archive */
+    public static class Cab extends Res {
+        private Res parent;
+        Cab(Res parent) { this.parent = parent; }
+        public String toString() { return parent.toString() + "!cab"; }
+        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);
         }
     }
 
-    /////////////// bytestream
-
-    public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
-        if (method.equals("getUTF")) {
-            if (checkOnly) return Boolean.TRUE;
-            if (args.length() != 0) return null;
-            try {
-                CharArrayWriter caw = new CharArrayWriter();
-                InputStream is = getInputStream();
-                BufferedReader r = new BufferedReader(new InputStreamReader(is));
-                char[] buf = new char[1024];
-                while(true) {
-                    int numread = r.read(buf, 0, 1024);
-                    if (numread == -1) break;
-                    caw.write(buf, 0, numread);
-                }
-                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");
-            }
-        } else if (name.equals("getDOM")) {
-            if (checkOnly) return Boolean.TRUE;
-            if (args.length() != 0) return null;
-            return new XMLHelper().doParse();
+    /** the Builtin resource */
+    public static class Builtin extends Res {
+        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();
         }
-        if (checkOnly) return Boolean.FALSE;
-        return null;
     }
 
-    private class XMLHelper extends XML {
-        Vector obStack = new Vector();
-        public XMLHelper() { super(BUFFER_SIZE); }
-        public void startElement(XML.Element c) throws XML.SchemaException {
-            JS o = new JS.Obj();
-            o.put("$name", c.localName);
-            for(int i=0; i<c.len; i++) o.put(c.keys[i], c.vals[i]);
-            o.put("$numchildren", new Integer(0));
-            obStack.addElement(o);
-        }
-        public void endElement(XML.Element c) throws XML.SchemaException {
-            if (obStack.size() == 1) return;
-            JS me = (JS)obStack.lastElement();
-            obStack.setSize(obStack.size() - 1);
-            JS parent = (JS)obStack.lastElement();
-            int numchildren = ((Integer)parent.get("$numchildren")).intValue();
-            parent.put("$numchildren", new Integer(numchildren + 1));
-            parent.put(new Integer(numchildren), me);
-        }
-        public void characters(char[] ch, int start, int length) throws XML.SchemaException {
-            String s = new String(ch, start, length);
-            JS parent = (JS)obStack.lastElement();
-            int numchildren = ((Integer)parent.get("$numchildren")).intValue();
-            Object lastChild = parent.get(new Integer(numchildren - 1));
-            if (lastChild instanceof String) {
-                parent.put(new Integer(numchildren - 1), lastChild + s);
-            } else {
-                parent.put("$numchildren", new Integer(numchildren + 1));
-                parent.put(new Integer(numchildren), s);
-            }
-        }
-        public void whitespace(char[] ch, int start, int length) {}
-        public JS doParse() throws JS.Exn {
-            try { 
-                InputStream is = getInputStream();
-                BufferedReader r = new BufferedReader(new InputStreamReader(is));
-                parse(r);
-            } 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");
-            }
-            return obStack.size() >= 1 ? (JS)obStack.elementAt(0) : null;
-        }
+    /** what you get when you reference a subresource */
+    public static class Ref extends Res {
+        Res parent;
+        Object key;
+        public String toString() { return parent.toString() + "/" + key; }
+        Ref(Res parent, Object key) { this.parent = parent; this.key = key; }
+        public String getCacheKey() throws NotCacheableException { return parent.getCacheKey() + "/" + key; }
+        public Res 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); }
     }
 
-    public void writeTo(OutputStream os) throws IOException {
-        InputStream is = getInputStream();
-        byte[] buf = new byte[1024];
-        while(true) {
-            int numread = is.read(buf, 0, 1024);
-            if (numread == -1) break;
-            if (Log.on) Log.log(this, "wrote " + numread + " bytes");
-            os.write(buf, 0, numread);
+    /** shadow resource which replaces the graft */
+    public static class ProgressWatcher extends Res {
+        final Res watchee;
+        JSFunction callback;
+        ProgressWatcher(Res watchee, JSFunction callback) { this.watchee = watchee; this.callback = callback; }
+        public String toString() { return watchee.toString(); }
+        public String getCacheKey() throws NotCacheableException { return watchee.getCacheKey(); }
+        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 void perform() {
+                            callback.call(N(bytesDownloaded),
+                                          N(is instanceof KnownLength ? ((KnownLength)is).getLength() : 0), null, null, 2);
+                        } });
+                        return ret;
+                    }
+                };
         }
-        os.flush();
-
-        // we have to close this because flush() doesn't work on Win32-GCJ
-        os.close();
     }
 }