1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
6 import java.util.zip.*;
9 import org.bouncycastle.util.encoders.Base64;
11 /** base class for XWT resources */
12 public abstract class Res extends JS {
14 public String getDescriptiveName() { return ""; }
15 public String typeName() { return "resource"; }
17 /** cache of subresources so that the equality operator works on them */
18 private Hash refCache = null;
20 public Template t = null;
22 public Res getParent() { return null; }
24 /** an InputStream that makes sure it is not in the MessageQueue when blocked on a read */
25 private static class BackgroundInputStream extends FilterInputStream {
26 BackgroundInputStream(InputStream i) { super(i); }
27 private void suspend() throws IOException {
28 if (!ThreadMessage.suspendThread())
29 throw new IOException("attempt to perform background-only operation in a foreground thread");
31 private void resume() {
32 ThreadMessage.resumeThread();
34 public int read() throws IOException {
36 try { return super.read(); }
39 public int read(byte[] b, int off, int len) throws IOException {
41 try { return super.read(b, off, len); }
46 /** returns an InputStream containing the Resource's contents */
47 public final InputStream getInputStream() throws IOException { return new BackgroundInputStream(getInputStream("")); }
48 public abstract InputStream getInputStream(String path) throws IOException;
50 /** graft newResource in place of this resource on its parent */
51 public Res graft(Object newResource) { throw new JS.Exn("cannot graft onto this resource"); }
53 /** if the path of this resource does not end with extension, return a new one wit it appended */
54 public Res addExtension(String extension) { return new Ref(this, extension); }
56 public Object[] keys() { throw new JS.Exn("cannot enumerate a resource"); }
57 public void put(Object key, Object val) { throw new JS.Exn("cannot put to a resource"); }
58 public Object get(Object key) {
60 Template t = Template.getTemplate(addExtension(".xwt"));
61 return t == null ? null : t.getStatic();
63 Object ret = refCache == null ? null : refCache.get(key);
64 if (ret != null) return ret;
65 ret = new Ref(this, key);
66 if (refCache == null) refCache = new Hash();
67 refCache.put(key, ret);
71 public static Res stringToRes(String url) { return stringToRes(url, false); }
72 public static Res stringToRes(String url, boolean permitLocalFilesystem) {
73 if (url.indexOf('!') != -1)
74 return (Res)(new Zip(stringToRes(url.substring(0, url.lastIndexOf('!')))).
75 get(url.substring(url.lastIndexOf('!') + 1)));
76 if (url.startsWith("http://")) return new HTTP(url);
77 if (url.startsWith("https://")) return new HTTP(url);
78 if (url.startsWith("file:") && permitLocalFilesystem) return new File(url.substring(5));
79 if (url.startsWith("cab:")) return new CAB(stringToRes(url.substring(4)));
80 if (url.startsWith("data:")) return new ByteArray(Base64.decode(url.substring(5)));
81 if (url.startsWith("utf8:")) return new ByteArray(url.substring(5).getBytes());
82 throw new JS.Exn("invalid resource specifier " + url);
85 /** subclass from this if you want a CachedInputStream for each path */
86 public static abstract class CachedRes extends Res {
87 private Hash cachedInputStreams = new Hash();
88 abstract InputStream _getInputStream(String path) throws IOException;
89 public final InputStream getInputStream(String path) throws IOException {
90 CachedInputStream cis = (CachedInputStream)cachedInputStreams.get(path);
92 cis = new CachedInputStream(_getInputStream(path));
93 cachedInputStreams.put(path, cis);
95 return cis.getInputStream();
99 /** HTTP or HTTPS resource */
100 public static class HTTP extends CachedRes {
102 HTTP(String url) { this.url = url; }
103 public InputStream _getInputStream(String path) throws IOException {
104 return new org.xwt.HTTP(url + path).GET(); }
108 public static class ByteArray extends Res {
109 private byte[] bytes;
110 ByteArray(byte[] bytes) { this.bytes = bytes; }
111 public InputStream getInputStream(String path) throws IOException {
112 if (!"".equals(path)) throw new JS.Exn("can't get subresources of a byte[] resource");
113 return new ByteArrayInputStream(bytes);
118 public static class File extends Res {
120 File(String path) { this.path = path; }
121 public InputStream getInputStream(String rest) throws IOException {
122 return new FileInputStream((path + rest).replace('/', java.io.File.separatorChar)); }
125 /** "unwrap" a Zip archive */
126 public static class Zip extends Res {
128 Zip(Res parent) { this.parent = parent; }
129 public InputStream getInputStream(String path) throws IOException {
130 if (path.startsWith("/")) path = path.substring(1);
131 ZipInputStream zis = new ZipInputStream(parent.getInputStream());
132 ZipEntry ze = zis.getNextEntry();
133 while(ze != null && !ze.getName().equals(path)) ze = zis.getNextEntry();
134 if (ze == null) throw new JS.Exn("requested file (" + path + ") not found in archive");
139 /** what you get when you reference a subresource */
140 public static class Ref extends Res {
143 Ref(Res parent, Object key) { this.parent = parent; this.key = key; }
144 public String getDescriptiveName() {
145 String pdn = parent.getDescriptiveName();
146 return pdn.equals("") ? key.toString() : (pdn + "." + key.toString());
148 public Res addExtension(String extension) {
149 return (key instanceof String && ((String)key).endsWith(extension)) ? this : new Ref(parent, key + extension);
151 public InputStream getInputStream(String path) throws IOException {
152 return parent.getInputStream("/" + key + path);
154 public Res getParent() { return parent; }
155 public Res graft(Object newResource) { return new Graft(parent, key, newResource); }
158 // FEATURE: eliminate code duplication with JS.Graft
159 /** shadow resource which replaces the graft */
160 public static class Graft extends Res {
164 Graft(Res graftee, Object key, Object val) { this.graftee = graftee; replaced_key = key; replaced_val = val; }
165 public boolean equals(Object o) { return (this == o || graftee.equals(o)); }
166 public int hashCode() { return graftee.hashCode(); }
167 public InputStream getInputStream(String s) throws IOException { return graftee.getInputStream(s); }
168 public Object get(Object key) { return replaced_key.equals(key) ? replaced_val : graftee.get(key); }
169 public String getDescriptiveName() { return graftee.getDescriptiveName(); }
170 public Res getParent() { return graftee.getParent(); }
171 public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
172 if (!replaced_key.equals(method)) return graftee.callMethod(method, args, checkOnly);
173 if (replaced_val instanceof Callable) return checkOnly ? Boolean.TRUE : ((Callable)replaced_val).call(args);
174 if (checkOnly) return Boolean.FALSE;
175 throw new JS.Exn("attempt to call non-function");
177 public Number coerceToNumber() { return graftee.coerceToNumber(); }
178 public String coerceToString() { return graftee.coerceToString(); }
179 public boolean coerceToBoolean() { return graftee.coerceToBoolean(); }
180 public String typeName() { return graftee.typeName(); }
183 /** shadow resource which replaces the graft */
184 public static class ProgressWatcher extends Res {
186 JS.Callable callback;
187 ProgressWatcher(Res watchee, JS.Callable callback) { this.watchee = watchee; this.callback = callback; }
188 public InputStream getInputStream(String s) throws IOException {
189 return new FilterInputStream(watchee.getInputStream(s)) {
190 int bytesDownloaded = 0;
191 public int read() throws IOException {
192 int ret = super.read();
193 if (ret != -1) bytesDownloaded++;
196 public int read(byte[] b, int off, int len) throws IOException {
197 int ret = super.read(b, off, len);
198 if (ret != 1) bytesDownloaded += ret;
199 ThreadMessage.newthread(new JS.Callable() { public Object call(JS.Array a) {
200 JS.Array args = new JS.Array();
201 args.addElement(new Integer(bytesDownloaded));
211 /** unpacks a Microsoft CAB file (possibly embedded in another file; we scan for 'MSCF' */
212 public static class CAB extends Res {
214 CAB(Res parent) { this.parent = parent; }
215 private int swap_endian(int i) {
216 return ((i & 0xff) << 24) | ((i & 0xff00) << 8) | ((i & 0xff0000) >>> 8) | (i >>> 24);
218 public InputStream getInputStream(String path) throws IOException {
220 return org.xwt.util.CAB.getFileInputStream(parent.getInputStream(), 2, path);
221 } catch (EOFException eof) {
222 throw new JS.Exn("MSCF header tag not found in file");
223 } catch (IOException ioe) {
224 throw new JS.Exn("IOException while reading file");
229 public Object callMethod(Object method, Array args, boolean checkOnly) throws JS.Exn {
230 if (method.equals("getUTF")) {
231 if (checkOnly) return Boolean.TRUE;
232 if (args.length() != 0) return null;
234 CharArrayWriter caw = new CharArrayWriter();
235 InputStream is = getInputStream();
236 BufferedReader r = new BufferedReader(new InputStreamReader(is));
237 char[] buf = new char[1024];
239 int numread = r.read(buf, 0, 1024);
240 if (numread == -1) break;
241 caw.write(buf, 0, numread);
243 return caw.toString();
244 } catch (IOException e) {
245 if (Log.on) Log.log(Res.class, "IO Exception while reading from file");
246 if (Log.on) Log.log(Res.class, e);
247 throw new JS.Exn("error while reading from Resource");
249 } else if (method.equals("getDOM")) {
250 if (checkOnly) return Boolean.TRUE;
251 if (args.length() != 0) return null;
252 return new XMLHelper().doParse();
254 if (checkOnly) return Boolean.FALSE;
258 private class XMLHelper extends XML {
259 Vector obStack = new Vector();
260 public XMLHelper() { super(BUFFER_SIZE); }
261 public void startElement(XML.Element c) throws XML.SchemaException {
263 o.put("$name", c.localName);
264 for(int i=0; i<c.len; i++) o.put(c.keys[i], c.vals[i]);
265 o.put("$numchildren", new Integer(0));
266 obStack.addElement(o);
268 public void endElement(XML.Element c) throws XML.SchemaException {
269 if (obStack.size() == 1) return;
270 JS me = (JS)obStack.lastElement();
271 obStack.setSize(obStack.size() - 1);
272 JS parent = (JS)obStack.lastElement();
273 int numchildren = ((Integer)parent.get("$numchildren")).intValue();
274 parent.put("$numchildren", new Integer(numchildren + 1));
275 parent.put(new Integer(numchildren), me);
277 public void characters(char[] ch, int start, int length) throws XML.SchemaException {
278 String s = new String(ch, start, length);
279 JS parent = (JS)obStack.lastElement();
280 int numchildren = ((Integer)parent.get("$numchildren")).intValue();
281 Object lastChild = parent.get(new Integer(numchildren - 1));
282 if (lastChild instanceof String) {
283 parent.put(new Integer(numchildren - 1), lastChild + s);
285 parent.put("$numchildren", new Integer(numchildren + 1));
286 parent.put(new Integer(numchildren), s);
289 public void whitespace(char[] ch, int start, int length) {}
290 public JS doParse() throws JS.Exn {
292 InputStream is = getInputStream();
293 BufferedReader r = new BufferedReader(new InputStreamReader(is));
295 } catch (XML.XMLException e) {
296 throw new JS.Exn("error parsing XML: " + e.toString());
297 } catch (IOException e) {
298 if (Log.on) Log.log(this, "IO Exception while reading from file");
299 if (Log.on) Log.log(this, e);
300 throw new JS.Exn("error reading from Resource");
302 return obStack.size() >= 1 ? (JS)obStack.elementAt(0) : null;
306 public void writeTo(OutputStream os) throws IOException {
307 InputStream is = getInputStream();
308 byte[] buf = new byte[1024];
310 int numread = is.read(buf, 0, 1024);
311 if (numread == -1) break;
312 if (Log.on) Log.log(this, "wrote " + numread + " bytes");
313 os.write(buf, 0, numread);
317 // we have to close this because flush() doesn't work on Win32-GCJ