src/org/xwt/Resources.java

   1 // Copyright 2002 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.xwt;
   3
   4 import java.io.*;
   5 import java.net.*;
   6 import java.util.*;
   7 import jazz.*;
   8 import java.lang.*;
   9 import java.applet.*;
  10 import org.mozilla.javascript.*;
  11 import org.xwt.util.*;
  12
  13 /**
  14  *  A singleton class that acts as a repository for files obtained
  15  *  from xwar archives or the local filesystem.
  16  *
  17  *  All names are converted to resource names (dots instead of
  18  *  slashes) when they are loaded into this repository; however,
  19  *  filename extensions are left on, so queries (resolveResource(),
  20  *  getResource()) should include the extension when querying for
  21  *  resources.
  22  */
  23 public class Resources {
  24
  25     /** Holds resources added at runtime. Initialized to hold 2000 to work around a NetscapeJVM bug. */
  26     private static Hash bytes = new Hash(2000, 3);
  27
  28     /** keeps track of which archive loaded templates into which package */
  29     private static Hash usedPackages = new Hash();
  30
  31     /** Returns true iff <tt>name</tt> is a valid resource name */
  32     private static boolean validResourceName(String name) {
  33         if (name == null || name.equals("")) return true;
  34         if (name.endsWith("/box.xwt") || name.endsWith("/svg.xwt")) return false;
  35         if (name.equals("box.xwt") || name.equals("svg.xwt")) return false;
  36         if (!((name.charAt(0) >= 'A' && name.charAt(0) <= 'Z') ||
  37               (name.charAt(0) >= 'a' && name.charAt(0) <= 'z'))) return false;
  38         for(int i=1; i<name.length(); i++) {
  39             char c = name.charAt(i);
  40             if (!((c >= 'A' && c <= 'Z') ||
  41                   (c >= 'a' && c <= 'z') ||
  42                   c == '_' ||
  43                   (c >= '0' && c <= '9') ||
  44                   (c == '.' && i == name.length() - 4))) return false;
  45         }
  46         return true;
  47     }
  48
  49     /** Load a directory as if it were an archive */
  50     public static synchronized void loadDirectory(File dir) throws IOException { loadDirectory(dir, ""); }
  51     private static synchronized void loadDirectory(File dir, String prefix) throws IOException {
  52         new Static(prefix.replace(File.separatorChar, '.'));
  53         String[] subfiles = dir.list();
  54         for(int i=0; i<subfiles.length; i++) {
  55             if (subfiles[i].equals("CVS") || !validResourceName(subfiles[i])) continue;
  56             String name = prefix + subfiles[i];
  57             File file = new File(dir.getPath() + File.separatorChar + subfiles[i]);
  58             if (file.isDirectory()) loadDirectory(file, name + File.separatorChar);
  59             else bytes.put(name.replace(File.separatorChar, '.'), file);
  60         }
  61     }
  62
  63     /** Load an archive from an inputstream. */
  64     public static synchronized void loadArchive(InputStream is) throws IOException { loadArchive(is, 0, null); }
  65     public static synchronized void loadArchive(InputStream is, final int length, final Function callback) throws IOException {
  66
  67         // random placeholder
  68         Object thisArchive = new Object();
  69
  70         ZipInputStream zis = new ZipInputStream(new FilterInputStream(is) {
  71                 int bytesDownloaded = 0;
  72                 boolean clear = true;
  73                 public int read() throws IOException {
  74                     bytesDownloaded++;
  75                     return super.read();
  76                 }
  77                 public int read(byte[] b, int off, int len) throws IOException {
  78                     int ret = super.read(b, off, len);
  79                     if (ret != -1) bytesDownloaded += ret;
  80                     if (clear && callback != null) {
  81                         clear = false;
  82                         ThreadMessage.newthread(new JSObject.JSFunction() {
  83                                 public Object call(Context cx, Scriptable thisObj, Scriptable ctorObj, Object[] args) throws JavaScriptException {
  84                                     try {
  85                                         callback.call(cx, null, null, new Object[] { new Double(bytesDownloaded), new Double(length) });
  86                                     } finally {
  87                                         clear = true;
  88                                     }
  89                                     return null;
  90                                 }
  91                             });
  92                     }
  93                     return ret;
  94                 }
  95             });
  96
  97         for(ZipEntry ze = zis.getNextEntry(); ze != null; ze = zis.getNextEntry()) {
  98             String name = ze.getName();
  99             if (!validResourceName(name.substring(name.lastIndexOf('/') + 1))) {
 100                 if (Log.on) Log.log(Resources.class, "WARNING: ignoring xwar entry with invalid name: " + name);
 101                 continue;
 102             }
 103
 104             if (name.endsWith(".xwt")) {
 105                 // placeholder so resolveResource() works properly
 106                 bytes.put(name.replace('/', '.'), new byte[] { });
 107                 name = name.substring(0, name.length() - 4);
 108
 109                 String packageName = JSObject.nodeNameToPackageName(name.replace('/', '.'));
 110                 Object user = usedPackages.get(packageName);
 111                 if (user != null && user != thisArchive) {
 112                     if (Log.on) Log.log(Resources.class, "templates have already been loaded into " + packageName + "; refusing to load " + name);
 113                 } else {
 114                     usedPackages.put(packageName, thisArchive);
 115                     for(int i=0; i<name.length() && i != -1; i = name.indexOf('/', i + 1))
 116                         Static.createStatic(name.substring(0, i).replace('/', '.'));
 117                     Template.buildTemplate(zis, name.replace('/', '.'));
 118                 }
 119
 120             } else {
 121                 bytes.put(name.replace('/', '.'), isToByteArray(zis));
 122             }
 123         }
 124         if (Log.verbose) Log.log(Resources.class, "done loading archive");
 125     }
 126
 127     /** holds the current theme mappings */
 128     static Vector mapFrom = new Vector();
 129
 130     /** holds the current theme mappings */
 131     static Vector mapTo = new Vector();
 132
 133     /**
 134      *  Resolves the partial resource name <tt>name</tt> to a fully
 135      *  resolved resource name, using <tt>importlist</tt> as a search
 136      *  list, or null if no resource was found.
 137      *
 138      *  Both the arguments and return values from this function SHOULD
 139      *  include extensions (".xwt", ".xwf", etc) and SHOULD use dots
 140      *  (".") instead of slashes ("/").
 141      */
 142     public static String resolve(String name, String[] importlist) {
 143         final int imax = importlist == null ? 0 : importlist.length;
 144         for(int i=-1; i < imax; i++) {
 145             String resolved = i == -1 ? name : (importlist[i] + '.' + name);
 146             for(int j=mapFrom.size() - 1; j>=0; j--) {
 147                 String from = mapFrom.elementAt(j).toString();
 148                 if (resolved.startsWith(from) && (resolved.endsWith(".xwt") || resolved.endsWith(".xwf"))) {
 149                     String tryme = mapTo.elementAt(j) + resolved.substring(from.length());
 150                     if (bytes.get(tryme) != null) return tryme;
 151                 }
 152             }
 153             if (bytes.get(resolved) != null) return resolved;
 154         }
 155         return null;
 156     }
 157
 158     /** Returns the named resource as a byte[].
 159      *  @param name A fully resolved resource name, using slashes
 160      *              instead of periods. If it is null, this function
 161      *              will return null.
 162      */
 163     public static byte[] getResource(String name) {
 164         if (name == null) return null;
 165         synchronized(bytes) {
 166             Object o = bytes.get(name);
 167             if (o == null) return null;
 168             if (o instanceof byte[]) return ((byte[])o);
 169             if (o instanceof File) {
 170                 try {
 171                     FileInputStream fi = new FileInputStream((File)o);
 172                     byte[] b = isToByteArray(fi);
 173                     bytes.put(name, b);
 174                     return b;
 175                 } catch (Exception e) {
 176                     if (Log.on) Log.log(Resources.class, "Exception while reading from file " + o);
 177                     if (Log.on) Log.log(Resources.class, e);
 178                     return null;
 179                 }
 180             }
 181             return null;
 182         }
 183     }
 184
 185     /** scratch space for isToByteArray() */
 186     private static byte[] workspace = new byte[16 * 1024];
 187
 188     /** Trivial method to completely read an InputStream */
 189     public static synchronized byte[] isToByteArray(InputStream is) throws IOException {
 190         int pos = 0;
 191         while (true) {
 192             int numread = is.read(workspace, pos, workspace.length - pos);
 193             if (numread == -1) break;
 194             else if (pos + numread < workspace.length) pos += numread;
 195             else {
 196                 pos += numread;
 197                 byte[] temp = new byte[workspace.length * 2];
 198                 System.arraycopy(workspace, 0, temp, 0, workspace.length);
 199                 workspace = temp;
 200             }
 201         }
 202         byte[] ret = new byte[pos];
 203         System.arraycopy(workspace, 0, ret, 0, pos);
 204         return ret;
 205     }
 206 }
 207
 208
 209