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 java.util.zip.*;
   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 == '_' || c == '.' ||
  43                   (c >= '0' && c <= '9'))) return false;
  44         }
  45         return true;
  46     }
  47
  48     /** Load a directory as if it were an archive */
  49     public static synchronized void loadDirectory(File dir) throws IOException { loadDirectory(dir, ""); }
  50     private static synchronized void loadDirectory(File dir, String prefix) throws IOException {
  51         new Static(prefix.replace(File.separatorChar, '.'));
  52         String[] subfiles = dir.list();
  53         for(int i=0; i<subfiles.length; i++) {
  54             if (subfiles[i].equals("CVS") || !validResourceName(subfiles[i])) continue;
  55             String name = prefix + subfiles[i];
  56             File file = new File(dir.getPath() + File.separatorChar + subfiles[i]);
  57             if (file.isDirectory()) {
  58                 loadDirectory(file, name + File.separatorChar);
  59             } else {
  60                 if (name.endsWith(".xwt")) {
  61                     String name2 = name.substring(0, name.length() - 4);
  62                     Static.createStatic(name2.replace(File.separatorChar, '.'), false);
  63                     usedPackages.put(JSObject.nodeNameToPackageName(name2.replace('/', '.')), new Object());
  64                 }
  65                 bytes.put(name.replace(File.separatorChar, '.'), file);
  66             }
  67         }
  68     }
  69
  70     /** Load an archive from an inputstream. */
  71     public static synchronized void loadArchive(InputStream is) throws IOException { loadArchive(is, 0, null); }
  72     public static synchronized void loadArchive(InputStream is, final int length, final Function callback) throws IOException {
  73
  74         // random placeholder
  75         Object thisArchive = new Object();
  76
  77         ZipInputStream zis = new ZipInputStream(new FilterInputStream(is) {
  78                 int bytesDownloaded = 0;
  79                 boolean clear = true;
  80                 public int read() throws IOException {
  81                     bytesDownloaded++;
  82                     return super.read();
  83                 }
  84                 public int read(byte[] b, int off, int len) throws IOException {
  85                     int ret = super.read(b, off, len);
  86                     if (clear && callback != null) {
  87                         clear = false;
  88                         ThreadMessage.newthread(new JSObject.JSFunction() {
  89                                 public Object call(Context cx, Scriptable thisObj, Scriptable ctorObj, Object[] args) throws JavaScriptException {
  90                                     try {
  91                                         callback.call(cx, null, null, new Object[] { new Double(bytesDownloaded), new Double(length) });
  92                                     } finally {
  93                                         clear = true;
  94                                     }
  95                                     return null;
  96                                 }
  97                             });
  98                     }
  99                     bytesDownloaded += ret;
 100                     return ret;
 101                 }
 102             });
 103
 104         Template.TemplateHelper t = new Template.TemplateHelper();
 105
 106         for(ZipEntry ze = zis.getNextEntry(); ze != null; ze = zis.getNextEntry()) {
 107             String name = ze.getName();
 108             if (!validResourceName(name.substring(name.lastIndexOf('/') + 1))) {
 109                 if (Log.on) Log.log(Resources.class, "WARNING: ignoring xwar entry with invalid name: " + name);
 110                 continue;
 111             }
 112
 113             if (name.endsWith(".xwt")) {
 114                 // placeholder so resolveResource() works properly
 115                 bytes.put(name.replace('/', '.'), new byte[] { });
 116                 name = name.substring(0, name.length() - 4);
 117
 118                 String packageName = JSObject.nodeNameToPackageName(name.replace('/', '.'));
 119                 Object user = usedPackages.get(packageName);
 120                 if (user != null && user != thisArchive) {
 121                     if (Log.on) Log.log(Resources.class, "templates have already been loaded into " + packageName + "; refusing to load " + name);
 122                 } else {
 123                     usedPackages.put(packageName, thisArchive);
 124                     Static.createStatic(name.replace('/', '.'), false);
 125                     Template.buildTemplate(zis, name.replace('/', '.'), t);
 126                 }
 127
 128             } else {
 129                 bytes.put(name.replace('/', '.'), isToByteArray(zis));
 130             }
 131         }
 132         if (Log.verbose) Log.log(Resources.class, "done loading archive");
 133     }
 134
 135     /** holds the current theme mappings */
 136     static Vector mapFrom = new Vector();
 137
 138     /** holds the current theme mappings */
 139     static Vector mapTo = new Vector();
 140
 141     /**
 142      *  Resolves the partial resource name <tt>name</tt> to a fully
 143      *  resolved resource name, using <tt>importlist</tt> as a search
 144      *  list, or null if no resource was found.
 145      *
 146      *  Both the arguments and return values from this function SHOULD
 147      *  include extensions (".xwt", ".xwf", etc) and SHOULD use dots
 148      *  (".") instead of slashes ("/").
 149      */
 150     public static String resolve(String name, String[] importlist) {
 151         final int imax = importlist == null ? 0 : importlist.length;
 152         for(int i=-1; i < imax; i++) {
 153             String resolved = i == -1 ? name : (importlist[i] + '.' + name);
 154             for(int j=mapFrom.size() - 1; j>=0; j--) {
 155                 String from = mapFrom.elementAt(j).toString();
 156                 if (resolved.startsWith(from) && (resolved.endsWith(".xwt") || resolved.endsWith(".xwf"))) {
 157                     String tryme = mapTo.elementAt(j) + resolved.substring(from.length());
 158                     if (bytes.get(tryme) != null) return tryme;
 159                 }
 160             }
 161             if (bytes.get(resolved) != null) return resolved;
 162         }
 163         return null;
 164     }
 165
 166     /** Returns the named resource as a byte[].
 167      *  @param name A fully resolved resource name, using slashes
 168      *              instead of periods. If it is null, this function
 169      *              will return null.
 170      */
 171     public static byte[] getResource(String name) {
 172         if (name == null) return null;
 173         synchronized(bytes) {
 174             Object o = bytes.get(name);
 175             if (o == null) return null;
 176             if (o instanceof byte[]) return ((byte[])o);
 177             if (o instanceof File) {
 178                 try {
 179                     FileInputStream fi = new FileInputStream((File)o);
 180                     byte[] b = isToByteArray(fi);
 181                     bytes.put(name, b);
 182                     return b;
 183                 } catch (Exception e) {
 184                     if (Log.on) Log.log(Resources.class, "Exception while reading from file " + o);
 185                     if (Log.on) Log.log(Resources.class, e);
 186                     return null;
 187                 }
 188             }
 189             return null;
 190         }
 191     }
 192
 193     /** scratch space for isToByteArray() */
 194     private static byte[] workspace = new byte[16 * 1024];
 195
 196     /** Trivial method to completely read an InputStream */
 197     public static synchronized byte[] isToByteArray(InputStream is) throws IOException {
 198         int pos = 0;
 199         while (true) {
 200             int numread = is.read(workspace, pos, workspace.length - pos);
 201             if (numread == -1) break;
 202             else if (pos + numread < workspace.length) pos += numread;
 203             else {
 204                 pos += numread;
 205                 byte[] temp = new byte[workspace.length * 2];
 206                 System.arraycopy(workspace, 0, temp, 0, workspace.length);
 207                 workspace = temp;
 208             }
 209         }
 210         byte[] ret = new byte[pos];
 211         System.arraycopy(workspace, 0, ret, 0, pos);
 212         return ret;
 213     }
 214 }
 215
 216
 217