server/IRCBot/IRCBot.java

//---PACKAGE DECLARATION---

//---IMPORTS---
import java.io.*;
import java.net.*;

/**
 * This class provides some basic IRCBot functionality. It connects
 * to a specified server, and will remain there until told to
 * leave. Whilst connected it can send a message or a notice to
 * the server.
 *
 * @author  $Author$
 * @version $Id$
 */
class IRCBot extends Thread {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public static final String REVISION = "$Revision: 1.1 $";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

    /**
     * Constructs a new instance of the IRCBot class.
     *
     * @param host The hostname of the IRC server
     * @param port The port number of the IRC server
     * @param nick The nickname to use
     * @param channel The channel to join
     */
    public IRCBot (String host, int port, String nick, String channel) {
        _host = host;
        _port = port;
        _nick = nick;
        _channel = channel;
    }

//---PUBLIC METHODS---

    /**
     * Main thread loop, this part of the class listens for
     * messages from the server, and acts accordingly. At the
     * present moment it only responds to pings.
     */
    public void run() {
        // flag so we can stop the loop
        boolean run = true;
        while(run) {
            try {
                // read a command
                String cmd = _socketIn.readLine();
                // if it's a PING...
                if(cmd.startsWith("PING")) {
                    // ...send a PONG
                    _socketOut.println("PONG" + cmd.substring(4));
                }
            } catch (IOException e) {
                // comms failure, lets stop
                System.out.println(e);
                run = false;
            }
        }
    }
    
    /**
     * Sends a message to the channel.
     *
     * @param msg The message to send
     */
    public void sendMsg(String msg) {
        _socketOut.println("PRIVMSG "+_channel+" :"+msg);
    }
    
    /**
     * Sends a notice to the channel.
     *
     * @param msg The notice to send
     */
    public void sendNotice(String msg) {
        _socketOut.println("NOTICE "+_channel+" :"+msg);
    }
    
    /**
     * Connect to the IRC server, log in, and join the channel.
     *
     * @throws IOException if the connection fails
     */
    public void connect() throws IOException {
        // setup the socket, reader and writer
        _socket = new Socket(_host, _port);
        _socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
        _socketOut = new PrintWriter(_socket.getOutputStream(), true);
        // send the various log in messages
        _socketOut.println("PASS");
        _socketOut.println("NICK "+_nick);  
        _socketOut.println("USER iscream 8 * :i-scream Bot");
        // join the channel
        _socketOut.println("JOIN "+_channel);
        // start our listening thread
        this.start();
    }
    
    /**
     * Disconnect "nicely" from the IRC server.
     *
     * @throws IOException if the disconnection fails
     */
    public void disconnect() throws IOException {
        // send proper QUIET
        _socketOut.println("QUIT : iscreamBot component shutting down...");
        // close the socket
        _socketOut.close();
        _socketIn.close();
        _socket.close();
    }

    /**
     * Overrides the {@link java.lang.Object#toString() Object.toString()}
     * method to provide clean logging (every class should have this).
     *
     * This uses the uk.ac.ukc.iscream.util.FormatName class
     * to format the toString()
     *
     * @return the name of this class and its CVS revision
     */
    /*public String toString() {
        return FormatName.getName(
            _name,
            getClass().getName(),
            REVISION);
    }*/

//---PRIVATE METHODS---

//---ACCESSOR/MUTATOR METHODS---

//---ATTRIBUTES---

    /**
     * This is the friendly identifier of the
     * component this class is running in.
     * eg, a Filter may be called "filter1",
     * If this class does not have an owning
     * component,  a name from the configuration
     * can be placed here.  This name could also
     * be changed to null for utility classes.
     */
    private String _name = null;
    
    /**
     * The hostname of the IRC server
     */
    private String _host;
    
    /**
     * The port of the IRC server
     */
    private int _port;
    
    /**
     * The nickname we're using
     */
    private String _nick;
    
    /**
     * The channel we've joined
     */
    private String _channel;
    
    /**
     * The socket connected to the server
     */
    private Socket _socket;
    
    /**
     * The writer
     */
    private PrintWriter _socketOut;
    
    /**
     * The reader
     */
    private BufferedReader _socketIn;

//---STATIC ATTRIBUTES---

}
Revision:	1.1
Committed:	Wed Feb 21 02:24:23 2001 UTC (23 years, 10 months ago) by tdb
Branch:	MAIN
CVS Tags:	PROJECT_COMPLETION, HEAD
Log Message:	An IRCBot class. Provides only basic functionality, such as connecting with a given name, to a given server, on a given channel. It will respond to pings and can thus stay as long as required. It will send a message or notice upon request.
#	User	Rev	Content
1	tdb	1.1	//---PACKAGE DECLARATION---
2
3			//---IMPORTS---
4			import java.io.*;
5			import java.net.*;
6
7			/**
8			* This class provides some basic IRCBot functionality. It connects
9			* to a specified server, and will remain there until told to
10			* leave. Whilst connected it can send a message or a notice to
11			* the server.
12			*
13			* @author $Author$
14			* @version $Id$
15			*/
16			class IRCBot extends Thread {
17
18			//---FINAL ATTRIBUTES---
19
20			/**
21			* The current CVS revision of this class
22			*/
23			public static final String REVISION = "$Revision: 1.1 $";
24
25			//---STATIC METHODS---
26
27			//---CONSTRUCTORS---
28
29			/**
30			* Constructs a new instance of the IRCBot class.
31			*
32			* @param host The hostname of the IRC server
33			* @param port The port number of the IRC server
34			* @param nick The nickname to use
35			* @param channel The channel to join
36			*/
37			public IRCBot (String host, int port, String nick, String channel) {
38			_host = host;
39			_port = port;
40			_nick = nick;
41			_channel = channel;
42			}
43
44			//---PUBLIC METHODS---
45
46			/**
47			* Main thread loop, this part of the class listens for
48			* messages from the server, and acts accordingly. At the
49			* present moment it only responds to pings.
50			*/
51			public void run() {
52			// flag so we can stop the loop
53			boolean run = true;
54			while(run) {
55			try {
56			// read a command
57			String cmd = _socketIn.readLine();
58			// if it's a PING...
59			if(cmd.startsWith("PING")) {
60			// ...send a PONG
61			_socketOut.println("PONG" + cmd.substring(4));
62			}
63			} catch (IOException e) {
64			// comms failure, lets stop
65			System.out.println(e);
66			run = false;
67			}
68			}
69			}
70
71			/**
72			* Sends a message to the channel.
73			*
74			* @param msg The message to send
75			*/
76			public void sendMsg(String msg) {
77			_socketOut.println("PRIVMSG "+_channel+" :"+msg);
78			}
79
80			/**
81			* Sends a notice to the channel.
82			*
83			* @param msg The notice to send
84			*/
85			public void sendNotice(String msg) {
86			_socketOut.println("NOTICE "+_channel+" :"+msg);
87			}
88
89			/**
90			* Connect to the IRC server, log in, and join the channel.
91			*
92			* @throws IOException if the connection fails
93			*/
94			public void connect() throws IOException {
95			// setup the socket, reader and writer
96			_socket = new Socket(_host, _port);
97			_socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
98			_socketOut = new PrintWriter(_socket.getOutputStream(), true);
99			// send the various log in messages
100			_socketOut.println("PASS");
101			_socketOut.println("NICK "+_nick);
102			_socketOut.println("USER iscream 8 * :i-scream Bot");
103			// join the channel
104			_socketOut.println("JOIN "+_channel);
105			// start our listening thread
106			this.start();
107			}
108
109			/**
110			* Disconnect "nicely" from the IRC server.
111			*
112			* @throws IOException if the disconnection fails
113			*/
114			public void disconnect() throws IOException {
115			// send proper QUIET
116			_socketOut.println("QUIT : iscreamBot component shutting down...");
117			// close the socket
118			_socketOut.close();
119			_socketIn.close();
120			_socket.close();
121			}
122
123			/**
124			* Overrides the {@link java.lang.Object#toString() Object.toString()}
125			* method to provide clean logging (every class should have this).
126			*
127			* This uses the uk.ac.ukc.iscream.util.FormatName class
128			* to format the toString()
129			*
130			* @return the name of this class and its CVS revision
131			*/
132			/*public String toString() {
133			return FormatName.getName(
134			_name,
135			getClass().getName(),
136			REVISION);
137			}*/
138
139			//---PRIVATE METHODS---
140
141			//---ACCESSOR/MUTATOR METHODS---
142
143			//---ATTRIBUTES---
144
145			/**
146			* This is the friendly identifier of the
147			* component this class is running in.
148			* eg, a Filter may be called "filter1",
149			* If this class does not have an owning
150			* component, a name from the configuration
151			* can be placed here. This name could also
152			* be changed to null for utility classes.
153			*/
154			private String _name = null;
155
156			/**
157			* The hostname of the IRC server
158			*/
159			private String _host;
160
161			/**
162			* The port of the IRC server
163			*/
164			private int _port;
165
166			/**
167			* The nickname we're using
168			*/
169			private String _nick;
170
171			/**
172			* The channel we've joined
173			*/
174			private String _channel;
175
176			/**
177			* The socket connected to the server
178			*/
179			private Socket _socket;
180
181			/**
182			* The writer
183			*/
184			private PrintWriter _socketOut;
185
186			/**
187			* The reader
188			*/
189			private BufferedReader _socketIn;
190
191			//---STATIC ATTRIBUTES---
192
193			}