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.1 2001/03/01 23:45:45 tdb1 Exp $
 */
public class IRC__Alerter implements PluginAlerter {

//---FINAL ATTRIBUTES---

    /**
     * The current CVS revision of this class
     */
    public final String REVISION = "$Revision: 1.1 $";
    
    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);
        }
    }

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