ChatServerFrame.java

Go to the documentation of this file.

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Toolkit;
import java.text.SimpleDateFormat;
import java.util.Calendar;

import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.WindowConstants;

/**
 *  Simple multi-threaded chat server with GUI
 * 
 *  @author Mikica B Kocic
 */
public class ChatServerFrame extends JFrame implements ChatServer.Context
{
    /**
     *  Implements java.io.Serializable interface
     */
    private static final long serialVersionUID = 7408497530711923022L;

    /**
     *  TCP port that chat server listens for new connections 
     */
    private int port = 2000;
    
    /*  GUI components
     */
    private JTextArea logArea;

    /**
     *  Creates a new instance of the <code>ChatClientFrame</code>.
     *  
     *  @param args the command line arguments passed to main
     */
    public ChatServerFrame( String args[] )
    {
        super( "IP1-4.1.2: Yet Another Simple Chat Server" );
        
        setDefaultCloseOperation( WindowConstants.EXIT_ON_CLOSE );

        //////////////////////////////////////////////////////////////////////////////////
        
        /* Top level components
         */
        Font textFont = new Font( Font.MONOSPACED, Font.PLAIN, 14 );
        
        logArea = new JTextArea ();
        logArea.setFont( textFont );
        logArea.setBackground( new Color( 0, 0, 128 ) );
        logArea.setForeground( new Color( 220, 220, 192 ) );
        logArea.setLineWrap( true );
        logArea.setWrapStyleWord( true );
        logArea.setEditable( false );
        
        JScrollPane logPane = new JScrollPane ();
        logPane.setViewportView( logArea );

        add( logPane, BorderLayout.CENTER );
        
        /* Adjust window dimensions not to exceed screen dimensions ...
         */
        Dimension win = new Dimension( 1024, 600 );
        Dimension scsz = Toolkit.getDefaultToolkit().getScreenSize();
        win.width  = Math.min( win.width, scsz.width );
        win.height = Math.min( win.height, scsz.height - 40 );
        setSize( win );
        
        /* ... then center window on the screen.
         */
        setLocation( ( scsz.width - win.width )/2, ( scsz.height - 40 - win.height )/2 );
        
        /* Parse arguments: [ <port> ]
         */
        if ( args.length >= 1 ) {
            try {
                port = Integer.parseInt( args[ 0 ] );
            } catch ( NumberFormatException e ) {
                // TODO might report that we are using default port?
            }
        }
        
        /* Start receiving connections
         */
        ChatServer server = new ChatServer( port, this );
        server.start();
    }
    
    /**
     *  Gets current time stamp
     *  
     *  @return time in ISO format 
     */
    private static String now ()
    {
        Calendar cal = Calendar.getInstance ();
        SimpleDateFormat sdf = new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss" );
        return sdf.format( cal.getTime() );
    }

    /**
     *  Logs message in log area.
     *  
     *  @param str    actual message
     */
    @Override
    public void logMessage( String str )
    {
        synchronized( logArea )
        {
            logArea.append( now () + "  " + str + "\n" );
            logArea.setRows( logArea.getRows () + 1 );
            logArea.setCaretPosition( logArea.getText().length () );
        }
    }
    
    /**
     *  Updates status message by setting window title.
     *  
     *  @param str    new status message
     */
    @Override
    public void logStatus( String str )
    {
        setTitle( "IP1-4.1.2 Chat Server " + str );

        /* Change background color to dark red if the socket is dead.
         */
        if ( str.contains( ", dead") ) {
            logArea.setBackground( new Color( 92, 0, 0 ) );
        }
    }

    /**
     *  Main entry point
     *  
     *  @param args the command line arguments
     */
    public static void main( String args[] ) 
    {
        final String[] copyOfArgs = args;
        
        java.awt.EventQueue.invokeLater( 
                new Runnable() {
                    public void run() {
                        new ChatServerFrame( copyOfArgs ).setVisible( true );
                    }
                }
            );
    }
}

/*! 
 *  \mainpage Yet Another Chat Server
 *
 *  \section s_intro Introduction
 *  
 *  The package implements solution to \ref p_task as a part of 
 *  the <a href="http://dsv.su.se/utbildning/distans/ip1" target="_blank"><b>SU/IP1 
 *  course</b></a>.
 *  
 *  \image html chatServer.png
 *  
 *  \section s_desc Description
 *  
 *  Chat server's principal class is ChatServer that listens on socket for new 
 *  connections. It instantiates a new threaded client back-end for each new connection 
 *  (as instance of the ChatServerClient class) and keeps all such client connections
 *  in the ChatServer.clients list. Client back-end thread purges itself 
 *  from the list after remote end is disconnected.
 *  
 *  ChatServerClient will receive messages in ChatServerClient.run() from the remote 
 *  client and call-back servers's ChatServer.broadcast() method that will distribute 
 *  message to all connected clients.
 *  
 *  Server may also opriginate its own messages, which will be prefixed 
 *  with the "[System] :: ".
 *  
 *  After receiving "wwhhoo" message, server will broadcast a list of all connected
 *  clients in the form: <code>WWHHOO: &lt;client-hostname&gt;:&lt;port&gt;</code>.
 *  
 *  One can start application with the following command:
 *  
 *   - <code>java -jar <a href="../chatServer.jar">chatServer.jar</a>
 *     [ &lt;port&gt; ]</code>
 *   
 *  where the default port is <code>2000</code>
 *  
 *  \section s_eliza Joseph Weizenbaum's Eliza
 *  
 *  If the server detects that the user is alone in the chat-room, it will offer to user
 *  to talk to an instance of 
 *  <a href="http://en.wikipedia.org/wiki/ELIZA" target="_blank"> Joseph Weizenbaum's 
 *  Eliza</a>, a simulation of a Rogerian 
 *  psychoterapist implemented by 
 *  <a href="http://chayden.net/eliza/Eliza.html" target="_blank">Charles Chayeden</a>.
 *  
 *  The server will start Eliza in respond to user message <code>talk eliza</code>
 *  (ignoring spaces and character cases).
 *  
 *  \section s_jar Executable
 *  
 *  The jar file of the package can be found <a href="../chatServer.jar"><b>here</b></a>.
 *   
 *  \section s_src Sources
 *  
 *  Source files:
 *   - \ref ChatServer.java
 *   - \ref ChatServerClient.java
 *   - \ref ChatServerFrame.java
 *
 */
/*! \page p_task IP1-4.1.2 Uppgift
 *
 *  Gör ett fristående program med ett grafiskt användargränssnitt som implementerar en
 *  chat-server som kan sända och ta emot text-meddelanden. Chat-servern ska använda
 *  stream-sockets.
 *
 *  Chat-servern ska kunna ta emot begäran om uppkoppling från nya chat-klienter och 
 *  placera alla chat-klienter i en egen tråd för att kunna ta emot ytterligare 
 *  chat-klienter. Varje chat-klient-tråd ligger och väntar på att en chat-klient 
 *  ska skicka ett text-meddelande. När så sker så ska chat-servern "broadcasta" 
 *  detta meddelande till samtliga chat-klienter. Chat-servern måste således hålla 
 *  reda på alla anslutna chat-klienter i någon datasamling.
 *
 *  Alla text-meddelanden som sänds från chat-klienterna ska visas en en lämplig 
 *  swing-komponent, exempelvis en text-area. För samtliga text-meddelanden så ska 
 *  följande skrivas ut i denna swing-komponent: 
 *  
 *   - Chat-klientens IP-adress
 *   - Text-meddelandet från chat-klienten
 *   
 *  Chat-servern ska gå att starta på två sätt:
 *  
 *   -# <code>java Server</code> (då ska port default bli 2000)
 *   -# <code>java Server &lt;port&gt;</code>
 *   
 *   Efter detta ska chat-servern göra sig redo för att ta emot förfrågningar om 
 *   anslutning från chat-klienter. Om detta lyckas så ska det i chat-serverns 
 *   titelrad stå den host och port som chat-servern kör på samt antalet chat-klienter 
 *   som är uppkopplade.
 *   
 *   Observera! Chat-servern ska upptäcka när en klient inte längre är ansluten och 
 *   då ta bort den ur datasamlingen och döda tråden (eventuellt kan tråden döda sig 
 *   själv). 
 */