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
  16     /** cache of subresources so that the equality operator works on them */
  17     private Hash refCache = null;
  18
  19     public Template t = null;
  20
  21     public Res getParent() { return null; }
  22
  23     /** returns an InputStream containing the Resource's contents */
  24     public InputStream getInputStream() throws IOException { return getInputStream(""); }
  25     public abstract InputStream getInputStream(String path) throws IOException;
  26
  27     /** graft newResource in place of this resource on its parent */
  28     public Res graft(Object newResource) { throw new JS.Exn("cannot graft onto this resource"); }
  29
  30     /** if the path of this resource does not end with extension, return a new one wit it appended */
  31     public Res addExtension(String extension) { return new Ref(this, extension); }
  32
  33     public Object[] keys() { throw new JS.Exn("cannot enumerate a resource"); }
  34     public void put(Object key, Object val) { throw new JS.Exn("cannot put to a resource"); }
  35     public Object get(Object key) {
  36         if ("".equals(key)) {
  37             Template t = Template.getTemplate(addExtension(".xwt"));
  38             return t == null ? null : t.getStatic();
  39         }
  40         Object ret = refCache == null ? null : refCache.get(key);
  41         if (ret != null) return ret;
  42         ret = new Ref(this, key);
  43         if (refCache == null) refCache = new Hash();
  44         refCache.put(key, ret);
  45         return ret;
  46     }
  47
  48     public static Res stringToRes(String url) { return stringToRes(url, false); }
  49     public static Res stringToRes(String url, boolean permitLocalFilesystem) {
  50         if (url.indexOf('!') != -1)
  51             return (Res)(new Zip(stringToRes(url.substring(0, url.lastIndexOf('!')))).get(url.substring(url.lastIndexOf('!') + 1)));
  52         if (url.startsWith("http://")) return new HTTP(url);
  53         if (url.startsWith("https://")) return new HTTP(url);
  54         if (url.startsWith("file:") && permitLocalFilesystem) return new File(url.substring(5));
  55         if (url.startsWith("cab:")) return new CAB(stringToRes(url.substring(4)));
  56         if (url.startsWith("data:")) return new ByteArray(Base64.decode(url.substring(5)));
  57         if (url.startsWith("utf8:")) return new ByteArray(url.substring(5).getBytes());
  58         throw new JS.Exn("invalid resource specifier " + url);
  59     }
  60
  61     /** HTTP or HTTPS resource */
  62     public static class HTTP extends Res {
  63         private String url;
  64         HTTP(String url) { this.url = url; }
  65         public InputStream getInputStream(String path) throws IOException { return new org.xwt.HTTP(url + path).GET(); }
  66     }
  67
  68     /** byte arrays */
  69     public static class ByteArray extends Res {
  70         private byte[] bytes;
  71         ByteArray(byte[] bytes) { this.bytes = bytes; }
  72         public InputStream getInputStream(String path) throws IOException {
  73             if (!"".equals(path)) throw new JS.Exn("can't get subresources of a byte[] resource");
  74             return new ByteArrayInputStream(bytes);
  75         }
  76     }
  77
  78     /** a file */
  79     public static class File extends Res {
  80         private String path;
  81         File(String path) { this.path = path; }
  82         public InputStream getInputStream(String rest) throws IOException {
  83             return new FileInputStream((path + rest).replace('/', java.io.File.separatorChar)); }
  84     }
  85
  86     /** wrap a Res around a preexisting InputStream */
  87     public static class IS extends Res {
  88         InputStream parent;
  89         IS(InputStream parent) { this.parent = parent; }
  90         public InputStream getInputStream(String path) {
  91             if (!"".equals(path)) throw new JS.Exn("can't access subresources of IS");
  92             return parent;
  93         }
  94     }
  95
  96     /** "unwrap" a Zip archive */
  97     public static class Zip extends Res {
  98         private Res parent;
  99         Zip(Res parent) { this.parent = parent; }
 100         public InputStream getInputStream(String path) throws IOException {
 101             if (path.startsWith("/")) path = path.substring(1);
 102             ZipInputStream zis = new ZipInputStream(parent.getInputStream());
 103             ZipEntry ze = zis.getNextEntry();
 104             while(ze != null && !ze.getName().equals(path)) ze = zis.getNextEntry();
 105             if (ze == null) throw new JS.Exn("requested file not found in archive");
 106             return zis;
 107         }
 108     }
 109
 110     /** what you get when you reference a subresource */
 111     public static class Ref extends Res {
 112         Res parent;
 113         Object key;
 114         Ref(Res parent, Object key) { this.parent = parent; this.key = key; }
 115         public String getDescriptiveName() {
 116             String pdn = parent.getDescriptiveName();
 117             return pdn.equals("") ? key.toString() : (pdn + "." + key.toString());
 118         }
 119         public Res addExtension(String extension) {
 120             return (key instanceof String && ((String)key).endsWith(extension)) ? this : new Ref(parent, key + extension);
 121         }
 122         public InputStream getInputStream(String path) throws IOException {
 123             return parent.getInputStream("/" + key + path);
 124         }
 125         public Res getParent() { return parent; }
 126         public Res graft(Object newResource) { return new Graft(parent, key, newResource); }
 127     }
 128
 129     /** shadow resource which replaces the graft */
 130     public static class Graft extends Res {
 131         Res graftee;
 132         Object replaced_key;
 133         Object replaced_val;
 134         Graft(Res graftee, Object key, Object val) { this.graftee = graftee; replaced_key = key; replaced_val = val; }
 135         public boolean equals(Object o) { return (this == o || graftee.equals(o)); }
 136         public int hashCode() { return graftee.hashCode(); }
 137         public InputStream getInputStream(String s) throws IOException { return graftee.getInputStream(s); }
 138         public Object get(Object key) { return replaced_key.equals(key) ? replaced_val : graftee.get(key); }
 139         public String getDescriptiveName() { return graftee.getDescriptiveName(); }
 140         public Res getParent() { return graftee.getParent(); }
 141     }
 142
 143     /** shadow resource which replaces the graft */
 144     public static class ProgressWatcher extends Res {
 145         Res watchee;
 146         JS.Callable callback;
 147         Graft(Res watchee, JS.Callable callback) { this.watchee = watchee; this.callback = callback; }
 148         public InputStream getInputStream(String s) throws IOException {
 149             return new FilterInputStream(graftee.getInputStream(s)) {
 150                     int bytesDownloaded = 0;
 151                     public int read() throws IOException {
 152                         int ret = super.read();
 153                         if (ret != -1) bytesDownloaded++;
 154                         return ret;
 155                     }
 156                     public int read(byte[] b, int off, int len) throws IOException {
 157                         int ret = super.read(b, off, len);
 158                         ThreadMessage.newthread(new JS.Callable() { public Object call(JS.Args a) {
 159                             JS.Array args = new JS.Array();
 160                             args.addElement(new Integer(bytesDownloaded));
 161                             callback.call(args);
 162                         } });
 163                     }
 164                 };
 165         }
 166     });
 167
 168     /** unpacks a Microsoft CAB file (possibly embedded in another file; we scan for 'MSCF' */
 169     public static class CAB extends Res {
 170         private Res parent;
 171         CAB(Res parent) { this.parent = parent; }
 172         private int swap_endian(int i) {
 173             return ((i & 0xff) << 24) | ((i & 0xff00) << 8) | ((i & 0xff0000) >>> 8) | (i >>> 24);
 174         }
 175         public InputStream getInputStream(String path) throws IOException {
 176             InputStream is = parent.getInputStream();
 177             byte[] scan = new byte[4];
 178             int ofs = 0;
 179             for(int i=0; i<2; i++)  {
 180                 // wierdly, .exe files have three MSCF's
 181                 while(scan[0] != 'M' || scan[1] != 'S' || scan[2] != 'C' || scan[3] != 'F') {
 182                     System.arraycopy(scan, 1, scan, 0, 3);
 183                     int read = is.read();
 184                     if (read == -1) throw new JS.Exn("MSCF header tag not found in file");
 185                     scan[3] = (byte)read;
 186                     ofs++;
 187                 }
 188                 scan[0] = 0;
 189             }
 190             Log.log(this, "found MSCF header at offset " + ofs);
 191             return org.xwt.util.CAB.getFileInputStream(is, path, true);
 192         }
 193     }
 194
 195     public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
 196         if (method.equals("getUTF")) {
 197             if (checkOnly) return Boolean.TRUE;
 198             if (args.length() != 0) return null;
 199             try {
 200                 CharArrayWriter caw = new CharArrayWriter();
 201                 InputStream is = getInputStream();
 202                 BufferedReader r = new BufferedReader(new InputStreamReader(is));
 203                 char[] buf = new char[1024];
 204                 while(true) {
 205                     int numread = r.read(buf, 0, 1024);
 206                     if (numread == -1) break;
 207                     caw.write(buf, 0, numread);
 208                 }
 209                 return caw.toString();
 210             } catch (IOException e) {
 211                 if (Log.on) Log.log(Res.class, "IO Exception while reading from file");
 212                 if (Log.on) Log.log(Res.class, e);
 213                 throw new JS.Exn("error while reading from Resource");
 214             }
 215         } else if (method.equals("getDOM")) {
 216             if (checkOnly) return Boolean.TRUE;
 217             if (args.length() != 0) return null;
 218             return new XMLHelper().doParse();
 219         }
 220         if (checkOnly) return Boolean.FALSE;
 221         return null;
 222     }
 223
 224     private class XMLHelper extends XML {
 225         Vector obStack = new Vector();
 226         public XMLHelper() { super(BUFFER_SIZE); }
 227         public void startElement(XML.Element c) throws XML.SchemaException {
 228             JS o = new JS.Obj();
 229             o.put("$name", c.localName);
 230             for(int i=0; i<c.len; i++) o.put(c.keys[i], c.vals[i]);
 231             o.put("$numchildren", new Integer(0));
 232             obStack.addElement(o);
 233         }
 234         public void endElement(XML.Element c) throws XML.SchemaException {
 235             if (obStack.size() == 1) return;
 236             JS me = (JS)obStack.lastElement();
 237             obStack.setSize(obStack.size() - 1);
 238             JS parent = (JS)obStack.lastElement();
 239             int numchildren = ((Integer)parent.get("$numchildren")).intValue();
 240             parent.put("$numchildren", new Integer(numchildren + 1));
 241             parent.put(new Integer(numchildren), me);
 242         }
 243         public void characters(char[] ch, int start, int length) throws XML.SchemaException {
 244             String s = new String(ch, start, length);
 245             JS parent = (JS)obStack.lastElement();
 246             int numchildren = ((Integer)parent.get("$numchildren")).intValue();
 247             Object lastChild = parent.get(new Integer(numchildren - 1));
 248             if (lastChild instanceof String) {
 249                 parent.put(new Integer(numchildren - 1), lastChild + s);
 250             } else {
 251                 parent.put("$numchildren", new Integer(numchildren + 1));
 252                 parent.put(new Integer(numchildren), s);
 253             }
 254         }
 255         public void whitespace(char[] ch, int start, int length) {}
 256         public JS doParse() throws JS.Exn {
 257             try {
 258                 InputStream is = getInputStream();
 259                 BufferedReader r = new BufferedReader(new InputStreamReader(is));
 260                 parse(r);
 261             } catch (XML.XMLException e) {
 262                 throw new JS.Exn("error parsing XML: " + e.toString());
 263             } catch (IOException e) {
 264                 if (Log.on) Log.log(this, "IO Exception while reading from file");
 265                 if (Log.on) Log.log(this, e);
 266                 throw new JS.Exn("error reading from Resource");
 267             }
 268             return obStack.size() >= 1 ? (JS)obStack.elementAt(0) : null;
 269         }
 270     }
 271
 272     public void writeTo(OutputStream os) throws IOException {
 273         InputStream is = getInputStream();
 274         byte[] buf = new byte[1024];
 275         while(true) {
 276             int numread = is.read(buf, 0, 1024);
 277             if (numread == -1) break;
 278             if (Log.on) Log.log(this, "wrote " + numread + " bytes");
 279             os.write(buf, 0, numread);
 280         }
 281         os.flush();
 282
 283         // we have to close this because flush() doesn't work on Win32-GCJ
 284         os.close();
 285     }
 286 }