src/org/xwt/Platform.java

   1 // Copyright 2003 Adam Megacz, see the COPYING file for licensing [GPL]
   2 package org.xwt;
   3
   4 import java.lang.reflect.*;
   5 import java.net.*;
   6 import java.io.*;
   7 import java.util.*;
   8 import org.xwt.util.*;
   9
  10 /**
  11  *  Abstracts away the small irregularities in JVM implementations.
  12  *
  13  *  The default Platform class supports a vanilla JDK 1.1
  14  *  JVM. Subclasses are provided for other VMs. Methods whose names
  15  *  start with an underscore are meant to be overridden by
  16  *  subclasses. If you create a subclass of Platform, you should put
  17  *  it in the org.xwt.plat package, and add code to this file's static
  18  *  block to detect the new platform.
  19  */
  20 public class Platform {
  21
  22     // Static Data /////////////////////////////////////////////////////////////////////////////////////
  23
  24     /**
  25      *  set to true during the delivery of a KeyPressed:C-v/A-v or Press3; it is safe to use a
  26      *  'global' here, since message delivery is single-threaded and non-preemptable
  27      */
  28     static boolean clipboardReadEnabled = false;
  29
  30     /** The appropriate Platform object for this JVM */
  31     static Platform platform = null;
  32
  33     /** true if proxy autodetection has already been run */
  34     static boolean alreadyDetectedProxy = false;
  35
  36     /** the result of proxy autodetection */
  37     static HTTP.Proxy cachedProxyInfo = null;
  38
  39     /** the current build */
  40     public static String build = "unknown";
  41
  42     // VM Detection Logic /////////////////////////////////////////////////////////////////////
  43
  44     /** do-nothing method that forces &lt;clinit&gt; to run */
  45     public static void forceLoad() { }
  46
  47     // If you create a new subclass of Platform, you should add logic
  48     // here to detect it. Do not reference your class directly -- use
  49     // reflection.
  50
  51     static {
  52         System.err.println("Detecting JVM...");
  53         try {
  54             String vendor = System.getProperty("java.vendor", "");
  55             String version = System.getProperty("java.version", "");
  56             String os_name = System.getProperty("os.name", "");
  57             String os_version = System.getProperty("os.version", "");
  58             String platform_class = null;
  59
  60             if (os_name.startsWith("Darwin")) platform_class = "Darwin";
  61             else if (vendor.startsWith("Free Software Foundation")) {
  62                 if (os_name.startsWith("Window")) platform_class = "Win32";
  63                 else platform_class = "X11";
  64             } else if (version.startsWith("1.1") && vendor.startsWith("Netscape")) platform_class = "Netscape";
  65             else if (version.startsWith("1.1") && vendor.startsWith("Microsoft")) platform_class = "Microsoft";
  66             else if (!version.startsWith("1.0") && !version.startsWith("1.1")) platform_class = "Java2";
  67
  68             /*
  69         // Disable 2d hardware acceleration on Jaguar
  70         if (os_name.equals("Mac OS X") && os_version.equals("10.2"))
  71             */
  72         System.setProperty("com.apple.hwaccel", "false");
  73
  74             if (platform_class != null) {
  75                 platform = (Platform)Class.forName("org.xwt.plat." + platform_class).newInstance();
  76                 platform.init();
  77             }
  78
  79             try {
  80                 build = (String)Class.forName("org.xwt.Build").getField("build").get(null);
  81             } catch (ClassNotFoundException cnfe) {
  82             } catch (Exception e) {
  83                 if (Log.on) Log.log(Platform.class, "exception while detecting build:");
  84                 if (Log.on) Log.log(Platform.class, e);
  85             }
  86             if (Log.on) Log.log(Platform.class, "XWT build: " + build);
  87
  88             if (Log.on) Log.log(Platform.class, "XWT VM detection:   vendor = " + vendor);
  89             if (Log.on) Log.log(Platform.class, "                   version = " + version);
  90             if (Log.on) Log.log(Platform.class, "                        os = " + os_name + " [version " + os_version + "]");
  91
  92             if (platform_class == null) {
  93                 if (Log.on) Log.log(Platform.class, "Unable to detect JVM");
  94                 new Platform().criticalAbort("Unable to detect JVM");
  95             }
  96
  97             if (Log.on) Log.log(Platform.class, "                  platform = " + platform.getDescriptiveName());
  98             if (Log.on) Log.log(Platform.class, "                     class = " + platform.getClass().getName());
  99             platform.postInit();
 100
 101         } catch (Exception e) {
 102             if (Log.on) Log.log(Platform.class, "Exception while trying to detect JVM");
 103             if (Log.on) Log.log(Platform.class, e);
 104             new Platform().criticalAbort("Unable to detect JVM");
 105         }
 106
 107     }
 108
 109
 110     // Methods to be Overridden ////////////////////////////////////////////////////////////////////
 111
 112     /** a string describing the VM */
 113     protected String getDescriptiveName() { return "Generic Java 1.1 VM"; }
 114
 115     /** this initializes the platform; code in here can invoke methods on Platform since Platform.platform has already been set */
 116     protected void init() { }
 117     protected void postInit() { }
 118
 119     /** creates and returns a doublebuffer 'belonging' to <tt>owner</tt>; we need to associate PixelBuffers to surfaces
 120      *  due to AWT 1.1 requirements (definately for Navigator, possibly also for MSJVM).
 121      */
 122     public static PixelBuffer createPixelBuffer(int w, int h, Surface s) { return platform._createPixelBuffer(w, h, s); }
 123     protected PixelBuffer _createPixelBuffer(int w, int h, Surface owner) { return null; }
 124
 125     /** creates and returns a picture */
 126     public static Picture createPicture(int[] data, int w, int h) { return platform._createPicture(data, w, h); }
 127     protected Picture _createPicture(int[] b, int w, int h) { return null; }
 128
 129     /** creates a socket object */
 130     public static Socket getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
 131         return platform._getSocket(host, port, ssl, negotiate);
 132     }
 133     protected Socket _getSocket(String host, int port, boolean ssl, boolean negotiate) throws IOException {
 134         Socket ret = ssl ? new TinySSL(host, port, negotiate) : new Socket(java.net.InetAddress.getByName(host), port);
 135         ret.setTcpNoDelay(true);
 136         return ret;
 137     }
 138
 139     /** should return true if it is safe to supress full-surface dirties immediately after a window resize */
 140     public static boolean supressDirtyOnResize() { return platform._supressDirtyOnResize(); }
 141     protected boolean _supressDirtyOnResize() { return false; }
 142
 143     /** the human-readable name of the key mapped to XWT's 'alt' key */
 144     public static String altKeyName() { return platform._altKeyName(); }
 145     protected String _altKeyName() { return "alt"; }
 146
 147     /** returns the contents of the clipboard */
 148     public static Object getClipBoard() { return clipboardReadEnabled ? platform._getClipBoard() : null; }
 149     protected String _getClipBoard() { return null; }
 150
 151     /** sets the contents of the clipboard */
 152     public static void setClipBoard(String s) { platform._setClipBoard(s); }
 153     protected void _setClipBoard(String s) { }
 154
 155     /** returns the width of the screen, in pixels */
 156     public static int getScreenWidth() { return platform._getScreenWidth(); }
 157     protected int _getScreenWidth() { return 640; }
 158
 159     /** returns the height of the screen, in pixels */
 160     public static int getScreenHeight() { return platform._getScreenHeight(); }
 161     protected int _getScreenHeight() { return 480; }
 162
 163     /** returns the maximum number of threads that the XWT engine can create without adversely affecting the host OS */
 164     public static int maxThreads() { return platform._maxThreads(); }
 165     protected int _maxThreads() { return 25; }
 166
 167     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
 168     protected void _criticalAbort(String message) { System.exit(-1); }
 169
 170     /** if true, org.xwt.Surface will generate a Click automatically after a press and a release */
 171     public static boolean needsAutoClick() { return platform._needsAutoClick(); }
 172     protected boolean _needsAutoClick() { return false; }
 173
 174     /** if true, org.xwt.Surface will generate a DoubleClick automatically after recieving two clicks in a short period of time */
 175     public static boolean needsAutoDoubleClick() { return platform._needsAutoDoubleClick(); }
 176     protected boolean _needsAutoDoubleClick() { return false; }
 177
 178     /** returns true iff the platform has a case-sensitive filesystem */
 179     public static boolean isCaseSensitive() { return platform._isCaseSensitive(); }
 180     protected boolean _isCaseSensitive() { return true; }
 181
 182     /** returns an InputStream to the builtin xwar */
 183     public static InputStream getBuiltinInputStream() { return platform._getBuiltinInputStream(); }
 184     protected InputStream _getBuiltinInputStream() {
 185         return this.getClass().getClassLoader().getResourceAsStream("org/xwt/builtin.jar");
 186     }
 187
 188     /** returns the value of the environment variable key, or null if no such key exists */
 189     public static String getEnv(String key) { return platform._getEnv(key); }
 190     protected String _getEnv(String key) {
 191         try {
 192             String os = System.getProperty("os.name").toLowerCase();
 193             Process p;
 194             if (os.indexOf("windows 9") != -1 || os.indexOf("windows me") != -1) {
 195                 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
 196                 if (platform.getClass().getName().endsWith("Java12")) return null;
 197                 p = Runtime.getRuntime().exec("command.com /c set");
 198             } else if (os.indexOf("windows") > -1) {
 199                 // hack -- jdk1.2/1.3 on Win32 pop open an ugly DOS box; 1.4 does not
 200                 if (platform.getClass().getName().endsWith("Java12")) return null;
 201                 p = Runtime.getRuntime().exec("cmd.exe /c set");
 202             } else {
 203                 p = Runtime.getRuntime().exec("env");
 204             }
 205             BufferedReader br = new BufferedReader(new InputStreamReader(p.getInputStream()));
 206             String s;
 207             while ((s = br.readLine()) != null)
 208                 if (s.startsWith(key + "="))
 209                     return s.substring(key.length() + 1);
 210         } catch (Exception e) {
 211             if (Log.on) Log.log(this, "Exception while reading from environment:");
 212             if (Log.on) Log.log(this, e);
 213         }
 214         return null;
 215     }
 216
 217     /** convert a JPEG into an Image */
 218     public static synchronized Picture decodeJPEG(InputStream is, String name) { return platform._decodeJPEG(is, name); }
 219     protected Picture _decodeJPEG(InputStream is, String name) { return null; }
 220
 221     /** displays a platform-specific "open file" dialog and returns the chosen filename, or null if the user hit cancel */
 222     protected String _fileDialog(String suggestedFileName, boolean write) { return null; }
 223     public static String fileDialog(String suggestedFileName, boolean write) {
 224         if (!ThreadMessage.suspendThread()) return null;
 225         try {
 226             return platform._fileDialog(suggestedFileName, write);
 227         } finally {
 228             ThreadMessage.resumeThread();
 229         }
 230     }
 231
 232     /** default implementation is Eric Albert's BrowserLauncher.java */
 233     protected void _newBrowserWindow(String url) {
 234         try {
 235             edu.stanford.ejalbert.BrowserLauncher.openURL(url);
 236         } catch (Exception e) {
 237             Log.log(this, e);
 238         }
 239     }
 240
 241     /** opens a new browser window */
 242     public static void newBrowserWindow(String url) {
 243         if (!(url.startsWith("https://") || url.startsWith("http://") || url.startsWith("ftp://") || url.startsWith("mailto:"))) {
 244             if (Log.on) Log.log(Platform.class, "xwt.newBrowserWindow() only supports http and https urls");
 245             return;
 246         }
 247
 248         // check the URL for well-formedness, as a defense against buffer overflow attacks
 249         try {
 250             String u = url;
 251             if (u.startsWith("https")) u = "http" + u.substring(5);
 252             new URL(u);
 253         } catch (MalformedURLException e) {
 254             if (Log.on) Log.log(Platform.class, "URL " + url + " is not well-formed");
 255             if (Log.on) Log.log(Platform.class, e);
 256         }
 257
 258         if (Log.on) Log.log(Platform.class, "newBrowserWindow, url = " + url);
 259         platform._newBrowserWindow(url);
 260     }
 261
 262     /** used to notify the user of very serious failures; usually used when logging is not working or unavailable */
 263     public static void criticalAbort(String message) {
 264         if (Log.on) Log.log(Platform.class, "Critical Abort:");
 265         if (Log.on) Log.log(Platform.class, message);
 266         platform._criticalAbort(message);
 267     }
 268
 269     /** this method invokes the platform _createSurface() method and then enforces a few post-call invariants */
 270     protected Surface _createSurface(Box b, boolean framed) { return null; }
 271     public static Surface createSurface(Box b, boolean framed, boolean refreshable) {
 272         Surface ret = platform._createSurface(b, framed);
 273         ret.setInvisible(false);
 274
 275         Object titlebar = b.get("titlebar", true);
 276         if (titlebar != null) ret.setTitleBarText(titlebar.toString());
 277
 278         Object icon = b.get("icon", true);
 279         if (icon != null && icon instanceof Res) {
 280             Picture pic = Picture.fromRes((Res)icon);
 281             if (pic != null) ret.setIcon(pic);
 282             else if (Log.on) Log.log(Platform.class, "unable to load icon " + icon);
 283         }
 284
 285         ret.setLimits(b.minwidth, b.minheight, b.maxwidth, b.maxheight);
 286
 287         if (refreshable) {
 288             Surface.allSurfaces.addElement(ret);
 289             ret.dirty(0, 0, b.width, b.height);
 290             ret.Refresh();
 291         }
 292         return ret;
 293     }
 294
 295     /** detects proxy settings */
 296     protected synchronized HTTP.Proxy _detectProxy() { return null; }
 297     public static synchronized HTTP.Proxy detectProxy() {
 298
 299         if (cachedProxyInfo != null) return cachedProxyInfo;
 300         if (alreadyDetectedProxy) return null;
 301         alreadyDetectedProxy = true;
 302
 303         if (Log.on) Log.log(Platform.class, "attempting environment-variable DNS proxy detection");
 304         cachedProxyInfo = HTTP.Proxy.detectProxyViaManual();
 305         if (cachedProxyInfo != null) return cachedProxyInfo;
 306
 307         if (Log.on) Log.log(Platform.class, "attempting " + platform.getClass().getName() + " proxy detection");
 308         cachedProxyInfo = platform._detectProxy();
 309         if (cachedProxyInfo != null) return cachedProxyInfo;
 310
 311         return cachedProxyInfo;
 312     }
 313
 314 }
 315
 316