//
// Copyright (C) 2001,2002 HorizonLive.com, Inc. All Rights Reserved.
// Copyright (C) 2002 Constantin Kaplinsky. All Rights Reserved.
// Copyright (C) 1999 AT&T Laboratories Cambridge. All Rights Reserved.
//
// This is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// This software is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this software; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
// USA.
//
//
// VncViewer.java - the VNC viewer applet. This class mainly just sets up the
// user interface, leaving it to the VncCanvas to do the actual rendering of
// a VNC desktop.
//
import java.awt.*;
import java.awt.event.*;
import java.io.*;
import java.net.*;
public class VncViewer extends java.applet.Applet
implements java.lang.Runnable, WindowListener {
boolean inAnApplet = true;
boolean inSeparateFrame = false;
//
// main() is called when run as a java program from the command line.
// It simply runs the applet inside a newly-created frame.
//
public static void main(String[] argv) {
VncViewer v = new VncViewer();
v.mainArgs = argv;
v.inAnApplet = false;
v.inSeparateFrame = true;
v.init();
v.start();
}
String[] mainArgs;
RfbProto rfb;
Thread rfbThread;
Frame vncFrame;
Container vncContainer;
ScrollPane desktopScrollPane;
GridBagLayout gridbag;
ButtonPanel buttonPanel;
AuthPanel authenticator;
VncCanvas vc;
OptionsFrame options;
ClipboardFrame clipboard;
RecordingFrame rec;
// Control session recording.
Object recordingSync;
String sessionFileName;
boolean recordingActive;
boolean recordingStatusChanged;
String cursorUpdatesDef;
String eightBitColorsDef;
// Variables read from parameter values.
String socketFactory;
String host;
int port;
String passwordParam;
String encPasswordParam;
boolean showControls;
boolean offerRelogin;
boolean showOfflineDesktop;
int deferScreenUpdates;
int deferCursorUpdates;
int deferUpdateRequests;
//
// init()
//
public void init() {
readParameters();
if (inSeparateFrame) {
vncFrame = new Frame("jfVNC");
if (!inAnApplet) {
vncFrame.add("Center", this);
}
vncContainer = vncFrame;
} else {
vncContainer = this;
}
recordingSync = new Object();
options = new OptionsFrame(this);
clipboard = new ClipboardFrame(this);
authenticator = new AuthPanel();
if (RecordingFrame.checkSecurity())
rec = new RecordingFrame(this);
sessionFileName = null;
recordingActive = false;
recordingStatusChanged = false;
cursorUpdatesDef = null;
eightBitColorsDef = null;
if (inSeparateFrame)
vncFrame.addWindowListener(this);
rfbThread = new Thread(this);
rfbThread.start();
}
public void update(Graphics g) {
}
//
// run() - executed by the rfbThread to deal with the RFB socket.
//
public void run() {
gridbag = new GridBagLayout();
vncContainer.setLayout(gridbag);
GridBagConstraints gbc = new GridBagConstraints();
gbc.gridwidth = GridBagConstraints.REMAINDER;
gbc.anchor = GridBagConstraints.NORTHWEST;
if (showControls) {
buttonPanel = new ButtonPanel(this);
gridbag.setConstraints(buttonPanel, gbc);
vncContainer.add(buttonPanel);
}
try {
connectAndAuthenticate();
doProtocolInitialisation();
vc = new VncCanvas(this);
gbc.weightx = 1.0;
gbc.weighty = 1.0;
if (inSeparateFrame) {
// Create a panel which itself is resizeable and can hold
// non-resizeable VncCanvas component at the top left corner.
Panel canvasPanel = new Panel();
canvasPanel.setLayout(new FlowLayout(FlowLayout.LEFT, 0, 0));
canvasPanel.add(vc);
// Create a ScrollPane which will hold a panel with VncCanvas
// inside.
desktopScrollPane = new ScrollPane(ScrollPane.SCROLLBARS_AS_NEEDED);
gbc.fill = GridBagConstraints.BOTH;
gridbag.setConstraints(desktopScrollPane, gbc);
desktopScrollPane.add(canvasPanel);
// Finally, add our ScrollPane to the Frame window.
vncFrame.add(desktopScrollPane);
vncFrame.setTitle(rfb.desktopName);
vncFrame.pack();
vc.resizeDesktopFrame();
} else {
// Just add the VncCanvas component to the Applet.
gridbag.setConstraints(vc, gbc);
add(vc);
validate();
}
if (showControls)
buttonPanel.enableButtons();
vc.processNormalProtocol();
} catch (NoRouteToHostException e) {
fatalError("Network error: no route to server: " + host, e);
} catch (UnknownHostException e) {
fatalError("Network error: server name unknown: " + host, e);
} catch (ConnectException e) {
fatalError("Network error: could not connect to server: " +
host + ":" + port, e);
} catch (EOFException e) {
if (showOfflineDesktop) {
e.printStackTrace();
System.out.println("Network error: remote side closed connection");
if (vc != null) {
vc.enableInput(false);
}
if (inSeparateFrame) {
vncFrame.setTitle(rfb.desktopName + " [disconnected]");
}
if (rfb != null && !rfb.closed())
rfb.close();
if (showControls && buttonPanel != null) {
buttonPanel.disableButtonsOnDisconnect();
if (inSeparateFrame) {
vncFrame.pack();
} else {
validate();
}
}
} else {
fatalError("Network error: remote side closed connection", e);
}
} catch (IOException e) {
String str = e.getMessage();
if (str != null && str.length() != 0) {
fatalError("Network Error: " + str, e);
} else {
fatalError(e.toString(), e);
}
} catch (Exception e) {
String str = e.getMessage();
if (str != null && str.length() != 0) {
fatalError("Error: " + str, e);
} else {
fatalError(e.toString(), e);
}
}
}
//
// Connect to the RFB server and authenticate the user.
//
void connectAndAuthenticate() throws Exception {
// If "ENCPASSWORD" parameter is set, decrypt the password into
// the passwordParam string.
if (encPasswordParam != null) {
// ENCPASSWORD is hexascii-encoded. Decode.
byte[] pw = {0, 0, 0, 0, 0, 0, 0, 0};
int len = encPasswordParam.length() / 2;
if (len > 8)
len = 8;
for (int i = 0; i < len; i++) {
String hex = encPasswordParam.substring(i*2, i*2+2);
Integer x = new Integer(Integer.parseInt(hex, 16));
pw[i] = x.byteValue();
}
// Decrypt the password.
byte[] key = {23, 82, 107, 6, 35, 78, 88, 7};
DesCipher des = new DesCipher(key);
des.decrypt(pw, 0, pw, 0);
passwordParam = new String(pw);
}
// If a password parameter ("PASSWORD" or "ENCPASSWORD") is set,
// don't ask user a password, get one from passwordParam instead.
// Authentication failures would be fatal.
if (passwordParam != null) {
if (inSeparateFrame) {
vncFrame.pack();
vncFrame.show();
} else {
validate();
}
if (!tryAuthenticate(passwordParam)) {
throw new Exception("VNC authentication failed");
}
return;
}
// There is no "PASSWORD" or "ENCPASSWORD" parameters -- ask user
// for a password, try to authenticate, retry on authentication
// failures.
GridBagConstraints gbc = new GridBagConstraints();
gbc.gridwidth = GridBagConstraints.REMAINDER;
gbc.anchor = GridBagConstraints.NORTHWEST;
gbc.weightx = 1.0;
gbc.weighty = 1.0;
gbc.ipadx = 100;
gbc.ipady = 50;
gridbag.setConstraints(authenticator, gbc);
vncContainer.add(authenticator);
if (inSeparateFrame) {
vncFrame.pack();
vncFrame.show();
} else {
validate();
// FIXME: here moveFocusToPasswordField() does not always work
// under Netscape 4.7x/Java 1.1.5/Linux. It seems like this call
// is being executed before the password field of the
// authenticator is fully drawn and activated, therefore
// requestFocus() does not work. Currently, I don't know how to
// solve this problem.
// -- const
authenticator.moveFocusToPasswordField();
}
while (true) {
// Wait for user entering a password.
synchronized(authenticator) {
try {
authenticator.wait();
} catch (InterruptedException e) {
}
}
// Try to authenticate with a given password.
if (tryAuthenticate(authenticator.password.getText()))
break;
// Retry on authentication failure.
authenticator.retry();
}
vncContainer.remove(authenticator);
}
//
// Try to authenticate with a given password.
//
boolean tryAuthenticate(String pw) throws Exception {
rfb = new RfbProto(host, port, this);
rfb.readVersionMsg();
System.out.println("RFB server supports protocol version " +
rfb.serverMajor + "." + rfb.serverMinor);
rfb.writeVersionMsg();
int authScheme = rfb.readAuthScheme();
switch (authScheme) {
case RfbProto.NoAuth:
System.out.println("No authentication needed");
return true;
case RfbProto.VncAuth:
byte[] challenge = new byte[16];
rfb.is.readFully(challenge);
if (pw.length() > 8)
pw = pw.substring(0, 8); // Truncate to 8 chars
// vncEncryptBytes in the UNIX libvncauth truncates password
// after the first zero byte. We do to.
int firstZero = pw.indexOf(0);
if (firstZero != -1)
pw = pw.substring(0, firstZero);
byte[] key = {0, 0, 0, 0, 0, 0, 0, 0};
System.arraycopy(pw.getBytes(), 0, key, 0, pw.length());
DesCipher des = new DesCipher(key);
des.encrypt(challenge, 0, challenge, 0);
des.encrypt(challenge, 8, challenge, 8);
rfb.os.write(challenge);
int authResult = rfb.is.readInt();
switch (authResult) {
case RfbProto.VncAuthOK:
System.out.println("VNC authentication succeeded");
return true;
case RfbProto.VncAuthFailed:
System.out.println("VNC authentication failed");
break;
case RfbProto.VncAuthTooMany:
throw new Exception("VNC authentication failed - too many tries");
default:
throw new Exception("Unknown VNC authentication result " + authResult);
}
break;
default:
throw new Exception("Unknown VNC authentication scheme " + authScheme);
}
return false;
}
//
// Do the rest of the protocol initialisation.
//
void doProtocolInitialisation() throws IOException {
rfb.writeClientInit();
rfb.readServerInit();
System.out.println("Desktop name is " + rfb.desktopName);
System.out.println("Desktop size is " + rfb.framebufferWidth + " x " +
rfb.framebufferHeight);
setEncodings();
}
//
// Send current encoding list to the RFB server.
//
void setEncodings() {
try {
if (rfb != null && rfb.inNormalProtocol) {
rfb.writeSetEncodings(options.encodings, options.nEncodings);
if (vc != null) {
vc.softCursorFree();
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
//
// setCutText() - send the given cut text to the RFB server.
//
void setCutText(String text) {
try {
if (rfb != null && rfb.inNormalProtocol) {
rfb.writeClientCutText(text);
}
} catch (Exception e) {
e.printStackTrace();
}
}
//
// Order change in session recording status. To stop recording, pass
// null in place of the fname argument.
//
void setRecordingStatus(String fname) {
synchronized(recordingSync) {
sessionFileName = fname;
recordingStatusChanged = true;
}
}
//
// Start or stop session recording. Returns true if this method call
// causes recording of a new session.
//
boolean checkRecordingStatus() throws IOException {
synchronized(recordingSync) {
if (recordingStatusChanged) {
recordingStatusChanged = false;
if (sessionFileName != null) {
startRecording();
return true;
} else {
stopRecording();
}
}
}
return false;
}
//
// Start session recording.
//
protected void startRecording() throws IOException {
synchronized(recordingSync) {
if (!recordingActive) {
// Save settings to restore them after recording the session.
cursorUpdatesDef =
options.choices[options.cursorUpdatesIndex].getSelectedItem();
eightBitColorsDef =
options.choices[options.eightBitColorsIndex].getSelectedItem();
// Set options to values suitable for recording.
options.choices[options.cursorUpdatesIndex].select("Disable");
options.choices[options.cursorUpdatesIndex].setEnabled(false);
options.setEncodings();
options.choices[options.eightBitColorsIndex].select("No");
options.choices[options.eightBitColorsIndex].setEnabled(false);
options.setColorFormat();
} else {
rfb.closeSession();
}
System.out.println("Recording the session in " + sessionFileName);
rfb.startSession(sessionFileName);
recordingActive = true;
}
}
//
// Stop session recording.
//
protected void stopRecording() throws IOException {
synchronized(recordingSync) {
if (recordingActive) {
// Restore options.
options.choices[options.cursorUpdatesIndex].select(cursorUpdatesDef);
options.choices[options.cursorUpdatesIndex].setEnabled(true);
options.setEncodings();
options.choices[options.eightBitColorsIndex].select(eightBitColorsDef);
options.choices[options.eightBitColorsIndex].setEnabled(true);
options.setColorFormat();
rfb.closeSession();
System.out.println("Session recording stopped.");
}
sessionFileName = null;
recordingActive = false;
}
}
//
// readParameters() - read parameters from the html source or from the
// command line. On the command line, the arguments are just a sequence of
// param_name/param_value pairs where the names and values correspond to
// those expected in the html applet tag source.
//
public void readParameters() {
host = readParameter("HOST", !inAnApplet);
if (host == null) {
host = getCodeBase().getHost();
if (host.equals("")) {
fatalError("HOST parameter not specified");
}
}
String str = readParameter("PORT", true);
port = Integer.parseInt(str);
if (inAnApplet) {
str = readParameter("Open New Window", false);
if (str != null && str.equalsIgnoreCase("Yes"))
inSeparateFrame = true;
}
encPasswordParam = readParameter("ENCPASSWORD", false);
if (encPasswordParam == null)
passwordParam = readParameter("PASSWORD", false);
// "Show Controls" set to "No" disables button panel.
showControls = true;
str = readParameter("Show Controls", false);
if (str != null && str.equalsIgnoreCase("No"))
showControls = false;
// "Offer Relogin" set to "No" disables "Login again" and "Close
// window" buttons under error messages in applet mode.
offerRelogin = true;
str = readParameter("Offer Relogin", false);
if (str != null && str.equalsIgnoreCase("No"))
offerRelogin = false;
// Do we continue showing desktop on remote disconnect?
showOfflineDesktop = false;
str = readParameter("Show Offline Desktop", false);
if (str != null && str.equalsIgnoreCase("Yes"))
showOfflineDesktop = true;
// Fine tuning options.
deferScreenUpdates = readIntParameter("Defer screen updates", 20);
deferCursorUpdates = readIntParameter("Defer cursor updates", 10);
deferUpdateRequests = readIntParameter("Defer update requests", 50);
// SocketFactory.
socketFactory = readParameter("SocketFactory", false);
}
public String readParameter(String name, boolean required) {
if (inAnApplet) {
String s = getParameter(name);
if ((s == null) && required) {
fatalError(name + " parameter not specified");
}
return s;
}
for (int i = 0; i < mainArgs.length; i += 2) {
if (mainArgs[i].equalsIgnoreCase(name)) {
try {
return mainArgs[i+1];
} catch (Exception e) {
if (required) {
fatalError(name + " parameter not specified");
}
return null;
}
}
}
if (required) {
fatalError(name + " parameter not specified");
}
return null;
}
int readIntParameter(String name, int defaultValue) {
String str = readParameter(name, false);
int result = defaultValue;
if (str != null) {
try {
result = Integer.parseInt(str);
} catch (NumberFormatException e) { }
}
return result;
}
//
// moveFocusToDesktop() - move keyboard focus either to the
// VncCanvas or to the AuthPanel.
//
void moveFocusToDesktop() {
if (vncContainer != null) {
if (vc != null && vncContainer.isAncestorOf(vc)) {
vc.requestFocus();
} else if (vncContainer.isAncestorOf(authenticator)) {
authenticator.moveFocusToPasswordField();
}
}
}
//
// disconnect() - close connection to server.
//
synchronized public void disconnect() {
System.out.println("Disconnect");
if (rfb != null && !rfb.closed())
rfb.close();
options.dispose();
clipboard.dispose();
if (rec != null)
rec.dispose();
if (inAnApplet) {
showMessage("Disconnected");
} else {
System.exit(0);
}
}
//
// fatalError() - print out a fatal error message.
//
synchronized public void fatalError(String str) {
System.out.println(str);
if (inAnApplet) {
// vncContainer null, applet not inited,
// can not present the error to the user.
Thread.currentThread().stop();
} else {
System.exit(1);
}
}
synchronized public void fatalError(String str, Exception e) {
if (rfb != null) {
// Not necessary to show error message if the error was caused
// by I/O problems after the rfb.close() method call.
if (rfb.closed()) {
System.out.println("RFB thread finished");
return;
}
rfb.close();
}
e.printStackTrace();
System.out.println(str);
if (inAnApplet) {
showMessage(str);
} else {
System.exit(1);
}
}
//
// Show message text and optionally "Relogin" and "Close" buttons.
//
void showMessage(String msg) {
vncContainer.removeAll();
Label errLabel = new Label(msg, Label.CENTER);
errLabel.setFont(new Font("Helvetica", Font.PLAIN, 12));
if (offerRelogin) {
Panel gridPanel = new Panel(new GridLayout(0, 1));
Panel outerPanel = new Panel(new FlowLayout(FlowLayout.LEFT));
outerPanel.add(gridPanel);
vncContainer.setLayout(new FlowLayout(FlowLayout.LEFT, 30, 16));
vncContainer.add(outerPanel);
Panel textPanel = new Panel(new FlowLayout(FlowLayout.CENTER));
textPanel.add(errLabel);
gridPanel.add(textPanel);
gridPanel.add(new ReloginPanel(this));
} else {
vncContainer.setLayout(new FlowLayout(FlowLayout.LEFT, 30, 30));
vncContainer.add(errLabel);
}
if (inSeparateFrame) {
vncFrame.pack();
} else {
validate();
}
}
//
// This method is called before the applet is destroyed.
//
public void destroy() {
System.out.println("Destroying applet");
vncContainer.removeAll();
options.dispose();
clipboard.dispose();
if (rec != null)
rec.dispose();
if (rfb != null && !rfb.closed())
rfb.close();
if (inSeparateFrame)
vncFrame.dispose();
}
//
// Close application properly on window close event.
//
public void windowClosing(WindowEvent evt) {
System.out.println("Closing window");
if (rfb != null)
disconnect();
vncFrame.dispose();
if (!inAnApplet) {
System.exit(0);
}
}
//
// Move the keyboard focus to the password field on window activation.
//
public void windowActivated(WindowEvent evt) {
if (vncFrame.isAncestorOf(authenticator))
authenticator.moveFocusToPasswordField();
}
//
// Ignore window events we're not interested in.
//
public void windowDeactivated (WindowEvent evt) {}
public void windowOpened(WindowEvent evt) {}
public void windowClosed(WindowEvent evt) {}
public void windowIconified(WindowEvent evt) {}
public void windowDeiconified(WindowEvent evt) {}
}