client/alerters/IRC__Alerter.java

//---PACKAGE DECLARATION---
package uk.ac.ukc.iscream.client.alerters;

//---IMPORTS---
import uk.ac.ukc.iscream.client.*;
import uk.ac.ukc.iscream.core.*;
import uk.ac.ukc.iscream.util.*;
import uk.ac.ukc.iscream.componentmanager.*;

import java.io.*;
import java.net.*;

/**
 * This Alert sends an IRC message.
 *
 * @author  $Author: tdb1 $
 * @version $Id: IRC__Alerter.java,v 1.3 2001/03/02 00:37:03 tdb1 Exp $
 */
public class IRC__Alerter implements PluginAlerter {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.3 $";
    
    public final String DESC = "Sends alerts on an IRC channel";
    
//---STATIC METHODS---

//---CONSTRUCTORS---

    public IRC__Alerter() {
        // get the configuration for this alerter
        Configuration config = ReferenceManager.getInstance().getCM().getConfiguration(_name);
               
        // an integer value
        _level = Integer.parseInt(config.getProperty("Alerter.IRC.level"));
        // the hostname of the IRC server
        _IRCServer = config.getProperty("Alerter.IRC.IRCServer");
        // the port number of the IRC server
        _IRCPort = Integer.parseInt(config.getProperty("Alerter.IRC.IRCPort"));
        // the nickname to use
        _nick = config.getProperty("Alerter.IRC.nick");
        // the channel to join
        _channel = config.getProperty("Alerter.IRC.channel");
        // a message with the following: %level% and %message%
        _message = config.getProperty("Alerter.IRC.message");
        
        // connect to the IRC server
        _ircbot = null;
        try {
            _ircbot = new IRCBot();
            _ircbot.connect();
            _ircbot.sendNotice("iscreamBot activated");
        } catch(IOException e) {
            _logger.write(toString(), Logger.ERROR, "Error starting IRCBot: "+e);
        }
        
        _logger.write(toString(), Logger.SYSINT, "IRC Alerter started");
    }

//---PUBLIC METHODS---

    public void sendAlert(Alert alert) {
        // only send if it's equal (or above) our level
        if(alert.getLevel() >= _level) {
            // sort out the message
            String message = _message;
            message = StringUtils.replaceText(message, "%level%", String.valueOf(alert.getLevel()));
            message = StringUtils.replaceText(message, "%source%", alert.getSource());
            message = StringUtils.replaceText(message, "%value%", alert.getValue());
            message = StringUtils.replaceText(message, "%thresholdValue%", alert.getThresholdValue());
            message = StringUtils.replaceText(message, "%attributeName%", alert.getAttributeName());
            
            // send the message
            _logger.write(toString(), Logger.DEBUG, "Sending IRC Alert at level"+String.valueOf(alert.getLevel()));
            _ircbot.sendMsg(message);
        }
    }

    /**
     * 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.NameFormat 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);
    }

    /**
     * return the String representation of what the filter does
     */
    public String getDescription(){
        return DESC;
    }

//---PRIVATE METHODS---

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

//---ATTRIBUTES---

    // an integer value
    private int _level;
    
    // the hostname of the IRC server
    private String _IRCServer;
    
    // the port number of the IRC server
    private int _IRCPort;
    
    // the nickname to use
    private String _nick;
    
    // the channel to join
    private String _channel;
    
    // the ircbot
    private IRCBot _ircbot;
    
    // a message with the following: %level% and %message%
    private String _message;
    
    /**
     * 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 = ClientMain.NAME;

    /**
     * This holds a reference to the
     * system logger that is being used.
     */
    private Logger _logger = ReferenceManager.getInstance().getLogger();

//---STATIC ATTRIBUTES---

//---INNER CLASSES---

    /**
     * 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.
     */
    class IRCBot extends Thread {
        
        /**
         * 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
                    _logger.write(this.toString(), Logger.ERROR, "Comms error: "+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(_IRCServer, _IRCPort);
            _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();
        }
                        
        /**
         * The socket connected to the server
         */
        private Socket _socket;
        
        /**
         * The writer
         */
        private PrintWriter _socketOut;
        
        /**
         * The reader
         */
        private BufferedReader _socketIn;
        
    }

}
Revision:	1.4
Committed:	Fri Mar 2 01:29:22 2001 UTC (23 years, 3 months ago) by tdb
Branch:	MAIN
Changes since 1.3:	+5 -2 lines
Log Message:	Added some debugging information.
#	User	Rev	Content
1	tdb	1.1	//---PACKAGE DECLARATION---
2			package uk.ac.ukc.iscream.client.alerters;
3
4			//---IMPORTS---
5			import uk.ac.ukc.iscream.client.*;
6			import uk.ac.ukc.iscream.core.*;
7			import uk.ac.ukc.iscream.util.*;
8			import uk.ac.ukc.iscream.componentmanager.*;
9
10			import java.io.*;
11			import java.net.*;
12
13			/**
14			* This Alert sends an IRC message.
15			*
16	tdb	1.2	* @author $Author: tdb1 $
17	tdb	1.4	* @version $Id: IRC__Alerter.java,v 1.3 2001/03/02 00:37:03 tdb1 Exp $
18	tdb	1.1	*/
19			public class IRC__Alerter implements PluginAlerter {
20
21			//---FINAL ATTRIBUTES---
22
23			/**
24			* The current CVS revision of this class
25			*/
26	tdb	1.4	public final String REVISION = "$Revision: 1.3 $";
27	tdb	1.1
28			public final String DESC = "Sends alerts on an IRC channel";
29
30			//---STATIC METHODS---
31
32			//---CONSTRUCTORS---
33
34			public IRC__Alerter() {
35			// get the configuration for this alerter
36			Configuration config = ReferenceManager.getInstance().getCM().getConfiguration(_name);
37
38			// an integer value
39			_level = Integer.parseInt(config.getProperty("Alerter.IRC.level"));
40			// the hostname of the IRC server
41			_IRCServer = config.getProperty("Alerter.IRC.IRCServer");
42			// the port number of the IRC server
43			_IRCPort = Integer.parseInt(config.getProperty("Alerter.IRC.IRCPort"));
44			// the nickname to use
45			_nick = config.getProperty("Alerter.IRC.nick");
46			// the channel to join
47			_channel = config.getProperty("Alerter.IRC.channel");
48			// a message with the following: %level% and %message%
49			_message = config.getProperty("Alerter.IRC.message");
50
51			// connect to the IRC server
52			_ircbot = null;
53			try {
54			_ircbot = new IRCBot();
55			_ircbot.connect();
56			_ircbot.sendNotice("iscreamBot activated");
57			} catch(IOException e) {
58			_logger.write(toString(), Logger.ERROR, "Error starting IRCBot: "+e);
59			}
60	tdb	1.4
61			_logger.write(toString(), Logger.SYSINT, "IRC Alerter started");
62	tdb	1.1	}
63
64			//---PUBLIC METHODS---
65
66			public void sendAlert(Alert alert) {
67			// only send if it's equal (or above) our level
68			if(alert.getLevel() >= _level) {
69			// sort out the message
70			String message = _message;
71			message = StringUtils.replaceText(message, "%level%", String.valueOf(alert.getLevel()));
72	tdb	1.3	message = StringUtils.replaceText(message, "%source%", alert.getSource());
73	tdb	1.2	message = StringUtils.replaceText(message, "%value%", alert.getValue());
74			message = StringUtils.replaceText(message, "%thresholdValue%", alert.getThresholdValue());
75			message = StringUtils.replaceText(message, "%attributeName%", alert.getAttributeName());
76	tdb	1.1
77			// send the message
78	tdb	1.4	_logger.write(toString(), Logger.DEBUG, "Sending IRC Alert at level"+String.valueOf(alert.getLevel()));
79	tdb	1.1	_ircbot.sendMsg(message);
80			}
81			}
82
83			/**
84			* Overrides the {@link java.lang.Object#toString() Object.toString()}
85			* method to provide clean logging (every class should have this).
86			*
87			* This uses the uk.ac.ukc.iscream.util.NameFormat class
88			* to format the toString()
89			*
90			* @return the name of this class and its CVS revision
91			*/
92			public String toString() {
93			return FormatName.getName(
94			_name,
95			getClass().getName(),
96			REVISION);
97			}
98
99			/**
100			* return the String representation of what the filter does
101			*/
102			public String getDescription(){
103			return DESC;
104			}
105
106			//---PRIVATE METHODS---
107
108			//---ACCESSOR/MUTATOR METHODS---
109
110			//---ATTRIBUTES---
111
112			// an integer value
113			private int _level;
114
115			// the hostname of the IRC server
116			private String _IRCServer;
117
118			// the port number of the IRC server
119			private int _IRCPort;
120
121			// the nickname to use
122			private String _nick;
123
124			// the channel to join
125			private String _channel;
126
127			// the ircbot
128			private IRCBot _ircbot;
129
130			// a message with the following: %level% and %message%
131			private String _message;
132
133			/**
134			* This is the friendly identifier of the
135			* component this class is running in.
136			* eg, a Filter may be called "filter1",
137			* If this class does not have an owning
138			* component, a name from the configuration
139			* can be placed here. This name could also
140			* be changed to null for utility classes.
141			*/
142			private String _name = ClientMain.NAME;
143
144			/**
145			* This holds a reference to the
146			* system logger that is being used.
147			*/
148			private Logger _logger = ReferenceManager.getInstance().getLogger();
149
150			//---STATIC ATTRIBUTES---
151
152			//---INNER CLASSES---
153
154			/**
155			* This class provides some basic IRCBot functionality. It connects
156			* to a specified server, and will remain there until told to
157			* leave. Whilst connected it can send a message or a notice to
158			* the server.
159			*/
160			class IRCBot extends Thread {
161
162			/**
163			* Main thread loop, this part of the class listens for
164			* messages from the server, and acts accordingly. At the
165			* present moment it only responds to pings.
166			*/
167			public void run() {
168			// flag so we can stop the loop
169			boolean run = true;
170			while(run) {
171			try {
172			// read a command
173			String cmd = _socketIn.readLine();
174			// if it's a PING...
175			if(cmd.startsWith("PING")) {
176			// ...send a PONG
177			_socketOut.println("PONG" + cmd.substring(4));
178			}
179			} catch (IOException e) {
180			// comms failure, lets stop
181			_logger.write(this.toString(), Logger.ERROR, "Comms error: "+e);
182			//run = false;
183			}
184			}
185			}
186
187			/**
188			* Sends a message to the channel.
189			*
190			* @param msg The message to send
191			*/
192			public void sendMsg(String msg) {
193			_socketOut.println("PRIVMSG "+_channel+" :"+msg);
194			}
195
196			/**
197			* Sends a notice to the channel.
198			*
199			* @param msg The notice to send
200			*/
201			public void sendNotice(String msg) {
202			_socketOut.println("NOTICE "+_channel+" :"+msg);
203			}
204
205			/**
206			* Connect to the IRC server, log in, and join the channel.
207			*
208			* @throws IOException if the connection fails
209			*/
210			public void connect() throws IOException {
211			// setup the socket, reader and writer
212			_socket = new Socket(_IRCServer, _IRCPort);
213			_socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
214			_socketOut = new PrintWriter(_socket.getOutputStream(), true);
215			// send the various log in messages
216			_socketOut.println("PASS");
217			_socketOut.println("NICK "+_nick);
218			_socketOut.println("USER iscream 8 * :i-scream Bot");
219			// join the channel
220			_socketOut.println("JOIN "+_channel);
221			// start our listening thread
222			this.start();
223			}
224
225			/**
226			* Disconnect "nicely" from the IRC server.
227			*
228			* @throws IOException if the disconnection fails
229			*/
230			public void disconnect() throws IOException {
231			// send proper QUIET
232			_socketOut.println("QUIT : iscreamBot component shutting down...");
233			// close the socket
234			_socketOut.close();
235			_socketIn.close();
236			_socket.close();
237			}
238
239			/**
240			* The socket connected to the server
241			*/
242			private Socket _socket;
243
244			/**
245			* The writer
246			*/
247			private PrintWriter _socketOut;
248
249			/**
250			* The reader
251			*/
252			private BufferedReader _socketIn;
253
254			}
255
256			}