ViewVC Help

View File | Revision Log | Show Annotations | Revision Graph | Root Listing

root/i-scream/projects/cms/source/server/uk/org/iscream/cms/server/client/alerters/IRC__Alerter.java

Comparing projects/cms/source/server/uk/org/iscream/cms/server/client/alerters/IRC__Alerter.java (file contents):
Revision 1.14 by ajm, Mon Mar 5 12:09:28 2001 UTC vs.
Revision 1.30.2.4 by tdb, Tue Feb 5 21:40:03 2002 UTC

#	Line 1 | Line 1
1		//---PACKAGE DECLARATION---
2	<	package uk.ac.ukc.iscream.client.alerters;
2	>	package uk.org.iscream.cms.server.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	<
5	>	import uk.org.iscream.cms.server.client.*;
6	>	import uk.org.iscream.cms.server.core.*;
7	>	import uk.org.iscream.cms.server.util.*;
8	>	import uk.org.iscream.cms.server.componentmanager.*;
9		import java.io.*;
10		import java.net.*;
11		import java.util.*;
12	<	import java.text.*;
12	>	import java.text.DateFormat;
13	>	import org.jibble.pircbot.*;
14
15		/**
16		* This Alert sends an IRC message.
#	Line 21 | Line 21 | import java.text.*;
21		* @author  $Author$
22		* @version $Id$
23		*/
24	<	public class IRC__Alerter implements PluginAlerter {
24	>	public class IRC__Alerter extends AlerterSkeleton {
25
26		//---FINAL ATTRIBUTES---
27
#	Line 35 | Line 35 | public class IRC__Alerter implements PluginAlerter {
35		*/
36		public final String DESC = "Sends alerts on an IRC channel";
37
38	–	/**
39	–	* The default reconnect delay in seconds
40	–	*/
41	–	public final int DEFAULT_RECONNECT_DELAY = 30;
42	–
38		//---STATIC METHODS---
39
40		//---CONSTRUCTORS---
41	<
41	>
42		public IRC__Alerter() {
43	<
44	<	// connect to the IRC server
43	>	super();
44	>	// construct and initialise the bot
45		_ircbot = new IRCBot();
46	<	_ircbot.start();
46	>	_ircbot.setVerbose(false);
47	>	Thread ircThread = new Thread(_ircbot);
48	>	// set it's name and start it
49	>	ircThread.setName("client.IRC__Alerter$IRCBot");
50	>	ircThread.start();
51	>	// log our start time
52		_startTime = System.currentTimeMillis();
53	–
53		_logger.write(toString(), Logger.SYSINIT, "IRC Alerter started");
54		}
55
56		//---PUBLIC METHODS---
57
58	+	/**
59	+	* Implements the abstract method from the skeleton class.
60	+	* This method will attempt to send an alert
61	+	* message over the IRC channel.
62	+	*
63	+	* @param alert the alert to send
64	+	*/
65		public void sendAlert(Alert alert) {
66	+	// sort out the message
67	+	String alertType = Alert.alertLevels[alert.getLevel()];
68	+	String message;
69	+	try {
70	+	message = _cp.getProperty(_name, "Alerter.IRC.message");
71	+	} catch (PropertyNotFoundException e) {
72	+	message = NOT_CONFIGURED;
73	+	_logger.write(toString(), Logger.WARNING, "Alerter.IRC.message value unavailable using default of " + message);
74	+	}
75	+	message = processAlertMessage(message, alert);
76		// only send alerts if we're active
77	<	if(_active) {
78	<	ConfigurationProxy cp = ConfigurationProxy.getInstance();
79	<	String levelName = cp.getProperty(_name, "Alerter.IRC.level");
80	<	int level = StringUtils.getStringPos(levelName, Alert.alertLevels);
81	<	// only send if it's equal (or above) our level
82	<	if((alert.getLevel() == 0) || (alert.getLevel() >= level)) {
83	<	String alertType = Alert.alertLevels[alert.getLevel()];
84	<	String thresholdType = Alert.thresholdLevels[alert.getThreshold()];
85	<	// sort out the message
70	<	String message = cp.getProperty(_name, "Alerter.IRC.message");
71	<	message = StringUtils.replaceText(message, "%level%", alertType);
72	<	message = StringUtils.replaceText(message, "%threshold%", thresholdType);
73	<	message = StringUtils.replaceText(message, "%source%", alert.getSource());
74	<	message = StringUtils.replaceText(message, "%value%", alert.getValue());
75	<	message = StringUtils.replaceText(message, "%thresholdValue%", alert.getThresholdValue());
76	<	message = StringUtils.replaceText(message, "%attributeName%", alert.getAttributeName());
77	<	message = StringUtils.replaceText(message, "%timeTillNextAlert%",  getTimeString(Long.parseLong(alert.getTimeTillNextAlert())));
78	<
79	<	// send the message
80	<	_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ alertType + " level");
81	<	_ircbot.sendMsg(message);
82	<	_lastAlert = message;
83	<	_lastAlertTime = System.currentTimeMillis();
84	<	_alertCount ++;
85	<	}
77	>	if(_active) {
78	>	// send the message
79	>	_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ alertType + " level");
80	>	_ircbot.sendMessage(message);
81	>	// count sent alerts
82	>	_alertCount++;
83	>	} else {
84	>	// don't send, but keep a count that we ignored it
85	>	_ignoredCount++;
86		}
87	+	// we'll always store the "last alert", regardless
88	+	// of whether we actually display it or not
89	+	_lastAlert = message;
90	+	_lastAlertTime = System.currentTimeMillis();
91		}
92
93		/**
94		* Overrides the {@link java.lang.Object#toString() Object.toString()}
95		* method to provide clean logging (every class should have this).
96		*
97	<	* This uses the uk.ac.ukc.iscream.util.NameFormat class
97	>	* This uses the uk.org.iscream.cms.server.util.NameFormat class
98		* to format the toString()
99		*
100		* @return the name of this class and its CVS revision
#	Line 102 | Line 106 | public class IRC__Alerter implements PluginAlerter {
106		REVISION);
107		}
108
109	<	/**
110	<	* return the String representation of what the filter does
109	>	/**
110	>	* Return the String representation of what the alerter does
111	>	*
112	>	* @return the description
113		*/
114		public String getDescription(){
115		return DESC;
#	Line 111 | Line 117 | public class IRC__Alerter implements PluginAlerter {
117
118		//---PRIVATE METHODS---
119
114	–	private String getTimeString(long time) {
115	–	String timeString = null;
116	–	if (time >= 60) {
117	–	timeString = (time / 60) + " minute(s)";
118	–	} else if (time >= 3600) {
119	–	timeString = ((time/60) / 60) + " hour(s)";
120	–	} else {
121	–	timeString = time + " second(s)";
122	–	}
123	–	return timeString;
124	–	}
125	–
120		//---ACCESSOR/MUTATOR METHODS---
121
122	+	/**
123	+	* Returns the "friendly" name of this class. This
124	+	* is simply an accessor for _name, required due to
125	+	* inheritance issues with extending AlerterSkeleton.
126	+	*
127	+	* @return the friendly name
128	+	*/
129	+	protected String getFName() {
130	+	return _name;
131	+	}
132	+
133		//---ATTRIBUTES---
134
135		/**
#	Line 150 | Line 155 | public class IRC__Alerter implements PluginAlerter {
155		/**
156		* Number of alerts sent
157		*/
158	<	private long _alertCount = 0;
158	>	private int _alertCount = 0;
159
160		/**
161	+	* Number of alerts ignored when in "stopped" mode
162	+	*/
163	+	private int _ignoredCount = 0;
164	+
165	+	/**
166		* Time of IRCBot startup
167		*/
168		private long _startTime;
169
170		/**
171	+	* This holds a reference to the
172	+	* system logger that is being used.
173	+	*/
174	+	protected Logger _logger = ReferenceManager.getInstance().getLogger();
175	+
176	+	/**
177		* This is the friendly identifier of the
178		* component this class is running in.
179		* eg, a Filter may be called "filter1",
#	Line 166 | Line 182 | public class IRC__Alerter implements PluginAlerter {
182		* can be placed here.  This name could also
183		* be changed to null for utility classes.
184		*/
185	<	private String _name = "IRC Alert";
185	>	private String _name = "IRC";
186
171	–	/**
172	–	* This holds a reference to the
173	–	* system logger that is being used.
174	–	*/
175	–	private Logger _logger = ReferenceManager.getInstance().getLogger();
176	–
187		//---STATIC ATTRIBUTES---
188
189		//---INNER CLASSES---
190
191	<	/**
182	<	* This class provides some basic IRCBot functionality. It connects
183	<	* to a specified server, and will remain there until told to
184	<	* leave. Whilst connected it can send a message or a notice to
185	<	* the server.
186	<	*/
187	<	class IRCBot extends Thread {
191	>	class IRCBot extends PircBot implements Runnable {
192
193		/**
194	<	* Main thread loop, this part of the class listens for
191	<	* messages from the server, and acts accordingly. At the
192	<	* present moment it only responds to pings.
194	>	* The default reconnect delay in seconds
195		*/
196	+	public final int DEFAULT_RECONNECT_DELAY = 30;
197	+
198	+	/**
199	+	* Attempt to kick-start the IRCBot into action. Will
200	+	* keep calling init() until it doesn't throw an
201	+	* an IOException (which will only be thrown if there
202	+	* is an error initialising). After a successful call
203	+	* to init() the method finishes.
204	+	*/
205		public void run() {
206	<	// so we can stop if required
196	<	boolean run = true;
197	<	while(run) {
198	<	// flag so we can stop the loop
199	<	boolean doRead = true;
200	<	// connect to the IRC server
206	>	while(true) {
207		try {
208	<	connect();
209	<	sendNotice(ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.startupNotice"));
204	<	} catch(IOException e) {
205	<	doRead=false;
206	<	_logger.write(this.toString(), Logger.ERROR, "Error connecting: "+e);
208	>	init();
209	>	break;
210		}
211	<	while(doRead) {
212	<	try {
213	<	// read a command
214	<	String cmd = _socketIn.readLine();
212	<	// if we have a null, we've lost contact
213	<	if(cmd == null) {
214	<	throw new IOException("End of stream reached");
215	<	}
216	<	// let another method deal with the input
217	<	handleInput(cmd);
218	<	} catch (IOException e) {
219	<	// comms failure, maybe our link is dead.
220	<	_logger.write(this.toString(), Logger.ERROR, "Communication error: "+e);
221	<	// stop, and loop round for a reconnect.
222	<	doRead = false;
223	<	}
211	>	catch (IOException e) {
212	>	_logger.write(this.toString(), Logger.ERROR, "Error initialising IRCBot: "+e);
213	>	// wait for a while, defined in the config
214	>	reconnectSleep();
215		}
216	<	// make sure we're disconnected
216	>	}
217	>	}
218	>
219	>	/**
220	>	* Connects the bot to an irc server and joins a channel,
221	>	* using details supplied from the i-scream configuration
222	>	* system. If this method completes without an exception
223	>	* one can presume the bot is ready for use.
224	>	*
225	>	* @throws IOException if there is any problem initialising
226	>	*/
227	>	private void init() throws IOException {
228	>	_logger.write(this.toString(), Logger.DEBUG, "Initialising IRCBot...");
229	>
230	>	// get a hook on the configuration system
231	>	ConfigurationProxy cp = ConfigurationProxy.getInstance();
232	>
233	>	// get hold of the server details
234	>	String server;
235	>	int port;
236	>	try {
237	>	server = cp.getProperty(_name, "Alerter.IRC.IRCServer");
238	>	port = Integer.parseInt(cp.getProperty(_name, "Alerter.IRC.IRCPort"));
239	>	} catch (PropertyNotFoundException e) {
240	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
241	>	throw new IOException("Can't get irc server details due to configuration error");
242	>	} catch (NumberFormatException e) {
243	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
244	>	throw new IOException("Can't get irc server details due to malformed configuration");
245	>	}
246	>
247	>	// get hold of the user details and nickname list
248	>	String user, nickList;
249	>	try {
250	>	user = cp.getProperty(_name, "Alerter.IRC.user");
251	>	nickList = cp.getProperty(_name, "Alerter.IRC.nickList");
252	>	} catch (PropertyNotFoundException e) {
253	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
254	>	throw new IOException("Can't get user/nickname details due to configuration error");
255	>	}
256	>
257	>	// get hold of comment and finger information
258	>	//  -- we're not too fussed if these aren't set
259	>	String comment = "Alerter.IRC.comment is undefined";
260	>	String finger = "Alerter.IRC.finger is undefined";
261	>	try {
262	>	comment = cp.getProperty(_name, "Alerter.IRC.comment");
263	>	finger = cp.getProperty(_name, "Alerter.IRC.finger");
264	>	} catch (PropertyNotFoundException e) {
265	>	_logger.write(this.toString(), Logger.WARNING, "Configuration warning, using default: "+e);
266	>	}
267	>
268	>	// put these details into the bot
269	>	this.setLogin(user);
270	>	this.setVersion(comment);
271	>	this.setFinger(finger);
272	>
273	>	// attempt to connect, trying each nickname
274	>	// in turn until sucessfully connected
275	>	StringTokenizer st = new StringTokenizer(nickList, ";");
276	>	boolean ok = false;
277	>	while(!ok && st.hasMoreTokens()) {
278	>	String nick = st.nextToken();
279		try {
280	<	disconnect();
281	<	} catch (IOException e) {
282	<	_logger.write(this.toString(), Logger.ERROR, "Communication error: "+e);
280	>	// try to connect with a nickname
281	>	_logger.write(this.toString(), Logger.DEBUG, "Trying nick: "+nick);
282	>	this.setName(nick);
283	>	this.connect(server, port);
284	>	// at this point we know the nickname was accepted
285	>	_nickname = nick;
286	>	ok = true;
287		}
288	<
289	<	// comms have failed, so wait a while and reconnect
290	<	int delayTime = 0;
234	<	try {
235	<	delayTime = Integer.parseInt(ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.reconnectDelay"));
236	<	} catch (NumberFormatException e) {
237	<	delayTime = DEFAULT_RECONNECT_DELAY;
238	<	_logger.write(this.toString(), Logger.WARNING, "Erronous Alerter.IRC.reconnectDelay value in configuration using default of " + delayTime + " seconds");
239	<	} catch (org.omg.CORBA.MARSHAL e2) {
240	<	delayTime = DEFAULT_RECONNECT_DELAY;
241	<	_logger.write(this.toString(), Logger.WARNING, "Alerter.IRC.reconnectDelay value unavailable using default of " + delayTime + " seconds");
288	>	catch(IOException e) {
289	>	_logger.write(this.toString(), Logger.ERROR, "IO error when connecting to server: "+e);
290	>	throw new IOException("IO error when connecting to server");
291		}
292	<	try {
293	<	Thread.sleep(delayTime * 1000);
294	<	} catch (InterruptedException e) {}
292	>	catch(IrcException e) {
293	>	_logger.write(this.toString(), Logger.ERROR, "IRC error when connecting to server: "+e);
294	>	throw new IOException("IRC error when connecting to server");
295	>	}
296	>	catch(NickAlreadyInUseException e) {
297	>	_logger.write(this.toString(), Logger.ERROR, "Nickname "+nick+" is already in use: "+e);
298	>	// don't do anything, instead just loop round
299	>	// and try the next nickname in the list
300	>	}
301		}
302	<	// maybe disconnect here ? - shutdown method not implemented yet
303	<	//disconnect();
302	>	if(!ok) {
303	>	// must have tried all the nicknames, best bail out
304	>	_logger.write(this.toString(), Logger.ERROR, "All nicknames already in use");
305	>	throw new IOException("All nicknames already in use");
306	>	}
307	>
308	>	// get hold of the channel details, and attempt
309	>	// to join the specified channel
310	>	try {
311	>	_channel = cp.getProperty(_name, "Alerter.IRC.channel");
312	>	this.joinChannel(_channel);
313	>	} catch (PropertyNotFoundException e) {
314	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
315	>	throw new IOException("Can't get channel name due to configuration error");
316	>	}
317	>
318	>	// get hold of the startup notice, and send
319	>	// it if it's defined
320	>	String startupNotice;
321	>	try {
322	>	startupNotice = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.startupNotice");
323	>	sendNotice(_channel, startupNotice);
324	>	} catch (PropertyNotFoundException e) {
325	>	_logger.write(this.toString(), Logger.DEBUG, "Startup notice not defined, so not sending: "+e);
326	>	}
327	>
328	>	// at this point initialisation is complete, so
329	>	// we can return and set this flag to allow alerts
330	>	_active = true;
331		}
332
333		/**
334	<	* Sends a message to the channel.
334	>	* Send a message to the current channel.
335		*
336	<	* @param msg The message to send
336	>	* @param message The message to send
337		*/
338	<	public void sendMsg(String msg) {
339	<	_socketOut.println("PRIVMSG "+_channel+" :"+msg);
258	<	// wait a second before returning...
259	<	// this ensures messages can't be sent too fast
260	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
338	>	private void sendMessage(String message) {
339	>	sendMessage(_channel, message);
340		}
341
342		/**
343	<	* Sends a message to the channel.
344	<	*
345	<	* @param user The user to send to
346	<	* @param msg The message to send
343	>	* If we get disconnected this method will be
344	>	* called, so we must take action. We'll simply
345	>	* keep trying to reinitialise, and thus
346	>	* reconnect to the server.
347		*/
348	<	public void sendPrivMsg(String user, String msg) {
349	<	_socketOut.println("PRIVMSG "+user+" :"+msg);
350	<	// wait a second before returning...
351	<	// this ensures messages can't be sent too fast
352	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
348	>	public void onDisconnect() {
349	>	// stop alerts being sent for now
350	>	_active = false;
351	>	while(true) {
352	>	// wait for a while, defined in the config
353	>	reconnectSleep();
354	>	try {
355	>	init();
356	>	break;
357	>	}
358	>	catch (IOException e) {
359	>	_logger.write(this.toString(), Logger.ERROR, "Error initialising IRCBot: "+e);
360	>	}
361	>	}
362		}
363
364		/**
365	<	* Sends an action to the channel.
365	>	* If we receive a message this method will
366	>	* be called. We'll check if the message is
367	>	* for us, and call handleInput if it is.
368		*
369	<	* @param msg the action message
369	>	* @param channel The channel the message came from
370	>	* @param sender The sender of the message
371	>	* @param login The login of the sender
372	>	* @param hostname The hostname of the sender
373	>	* @param message The message sent
374		*/
375	<	public void sendAction(String msg) {
376	<	char esc = 001;
377	<	sendMsg(esc+"ACTION "+msg+esc);
378	<	// wait a second before returning...
379	<	// this ensures messages can't be sent too fast
380	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
375	>	public void onMessage(String channel, String sender, String login, String hostname, String message) {
376	>	String trimmedMessage = isForMe(message);
377	>	// if trimmedMessage is null, it's not for us
378	>	if(trimmedMessage != null) {
379	>	handleInput(trimmedMessage, channel);
380	>	}
381		}
382
383		/**
384	<	* Sends a notice to the channel.
384	>	* If we receive a private message this method
385	>	* will be called. No need to check if it's for
386	>	* us -- it has to be if it's a private message.
387		*
388	<	* @param msg The notice to send
388	>	* @param sender The sender of the message
389	>	* @param login The login of the sender
390	>	* @param hostname The hostname of the sender
391	>	* @param message The message sent
392		*/
393	<	public void sendNotice(String msg) {
394	<	_socketOut.println("NOTICE "+_channel+" :"+msg);
296	<	// wait a second before returning...
297	<	// this ensures messages can't be sent too fast
298	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
393	>	public void onPrivateMessage(String sender, String login, String hostname, String message) {
394	>	handleInput(message, sender);
395		}
396
397		/**
398	<	* Connect to the IRC server, log in, and join the channel.
398	>	* If we receive a nick change message, this
399	>	* method gets called. We don't care about
400	>	* other users changing their nick, so we only
401	>	* take notice if our nick changes. If it does
402	>	* we need to change our internal nickname
403	>	* state.
404		*
405	<	* @throws IOException if the connection fails
405	>	* @param oldNick the old nickname
406	>	* @param login the login of the nick changer
407	>	* @param hostname the hostname of the nick changer
408	>	* @param newNick the new nickname
409		*/
410	<	public void connect() throws IOException {
411	<	ConfigurationProxy cp = ConfigurationProxy.getInstance();
412	<	// setup the socket, reader and writer
309	<	String server = cp.getProperty(_name, "Alerter.IRC.IRCServer");
310	<	int port = Integer.parseInt(cp.getProperty(_name, "Alerter.IRC.IRCPort"));
311	<	_socket = new Socket(server, port);
312	<	_socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
313	<	_socketOut = new PrintWriter(_socket.getOutputStream(), true);
314	<	//_socketOut.println("PASS");
315	<	// send USER details
316	<	String user = cp.getProperty(_name, "Alerter.IRC.user");
317	<	String comment = cp.getProperty(_name, "Alerter.IRC.comment");
318	<	_socketOut.println("USER "+user+" 8 * :"+comment);
319	<	// attempt to get a nick
320	<	String nickList = cp.getProperty(_name, "Alerter.IRC.nickList");
321	<	StringTokenizer st = new StringTokenizer(nickList, ";");
322	<	boolean ok = false;
323	<	// try until we exhaust our list
324	<	while(!ok && st.hasMoreTokens()) {
325	<	String nick = st.nextToken();
326	<	_socketOut.println("NICK "+nick);
327	<	// get a "yes" or "no" response back
328	<	String response = "";
329	<	do {
330	<	response = _socketIn.readLine();
331	<	if(response==null) {
332	<	throw new IOException("Communication error whilst logging in");
333	<	}
334	<	} while(response.indexOf("001")==-1 && response.indexOf("433")==-1);
335	<	// see if it was a yes
336	<	if(response.indexOf("001")!=-1) {
337	<	// great, we're logged in !
338	<	ok = true;
339	<	// store the name we're using
340	<	_nickname = nick;
341	<	}
342	<	else {
343	<	// log we couldn't get the name
344	<	_logger.write(this.toString(), Logger.WARNING, "Nickname in use: "+nick);
345	<	}
410	>	public void onNickChange(String oldNick, String login, String hostname, String newNick) {
411	>	if(oldNick.equals(_nickname)) {
412	>	_nickname = newNick;
413		}
347	–	if(!ok) {
348	–	// oh dear, we couldn't get on.
349	–	throw new IOException("All nicknames in use");
350	–	}
351	–	// join the channel
352	–	_channel = cp.getProperty(_name, "Alerter.IRC.channel");
353	–	_socketOut.println("JOIN "+_channel);
354	–	// allow alerts
355	–	_active = true;
414		}
415
416		/**
417	<	* Disconnect "nicely" from the IRC server.
417	>	* If we receive a kick message this method
418	>	* gets called. We only take notice if it's
419	>	* us getting kicked, and then we'll rejoin
420	>	* the channel after a short wait.
421		*
422	<	* @throws IOException if the disconnection fails
422	>	* @param channel the channel the kick happened on
423	>	* @param kickerNick the person who performed the kick
424	>	* @param kickerLogin the login of the person who performed the kick
425	>	* @param kickerHostname the hostname of the person who performed the kick
426	>	* @param recipientNick the nickname of the person being kicked
427	>	* @param reason the reason for the kick
428		*/
429	<	public void disconnect() throws IOException {
430	<	// stop alerts
431	<	_active = false;
432	<	// send proper QUIT
433	<	_socketOut.println("QUIT : iscreamBot component shutting down...");
434	<	// close the socket
435	<	_socketOut.close();
436	<	_socketIn.close();
437	<	_socket.close();
429	>	public void onKick(String channel, String kickerNick, String kickerLogin, String kickerHostname, String recipientNick, String reason) {
430	>	if(recipientNick.equals(_nickname) && channel.equals(_channel)) {
431	>	// remind the person it's not very nice :)
432	>	sendMessage(kickerNick, "That wasn't a nice thing to do...");
433	>	// get hold of the channel details, in case they've changed
434	>	try {
435	>	_channel = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.channel");
436	>	} catch(PropertyNotFoundException e) {
437	>	_logger.write(this.toString(), Logger.ERROR, "Can't get channel name due to configuration error: "+e);
438	>	}
439	>	// wait for a while, defined in the config
440	>	reconnectSleep();
441	>	// we'll try and rejoin the channel regardless
442	>	// otherwise we might end up doing nothing!
443	>	joinChannel(_channel);
444	>	}
445		}
446
447		/**
448	<	* Overrides the {@link java.lang.Object#toString() Object.toString()}
449	<	* method to provide clean logging (every class should have this).
448	>	* This method handles input directed to us, and
449	>	* responds accordingly if required.
450		*
451	<	* This uses the uk.ac.ukc.iscream.util.NameFormat class
452	<	* to format the toString()
451	>	* nb. matching user input is quite bad right now,
452	>	*     and should be improved one day.
453		*
454	<	* @return the name of this class and its CVS revision
454	>	* @param message the message from someone
455	>	* @param source where the message came from, so we know where to send the response
456		*/
457	<	public String toString() {
458	<	return FormatName.getName(
385	<	_name,
386	<	getClass().getName(),
387	<	REVISION);
388	<	}
389	<
390	<	/**
391	<	* Deals with incoming lines from the server.
392	<	*
393	<	* @param line the line to deal with
394	<	*/
395	<	private void handleInput(String line) {
457	>	private void handleInput(String message, String source) {
458	>	// get hold of the configuration system
459		ConfigurationProxy cp = ConfigurationProxy.getInstance();
460	<	// if it's a PING...
461	<	if(line.startsWith("PING")) {
462	<	// ...send a PONG
463	<	_socketOut.println("PONG" + line.substring(4));
460	>	// setup some String's
461	>	String stopCommand, startCommand, timeSinceLastAlertCommand, lastAlertCommand, joinCommand;
462	>	String nickChangeCommand, versionCommand, helpCommand, statCommand, uptimeCommand;
463	>	// get the command set from the configuration
464	>	try {
465	>	stopCommand = cp.getProperty(_name, "Alerter.IRC.stopCommand");
466	>	startCommand = cp.getProperty(_name, "Alerter.IRC.startCommand");
467	>	timeSinceLastAlertCommand = cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand");
468	>	lastAlertCommand = cp.getProperty(_name, "Alerter.IRC.lastAlertCommand");
469	>	joinCommand = cp.getProperty(_name, "Alerter.IRC.joinCommand");
470	>	nickChangeCommand = cp.getProperty(_name, "Alerter.IRC.nickChangeCommand");
471	>	versionCommand = cp.getProperty(_name, "Alerter.IRC.versionCommand");
472	>	helpCommand = cp.getProperty(_name, "Alerter.IRC.helpCommand");
473	>	statCommand = cp.getProperty(_name, "Alerter.IRC.statCommand");
474	>	uptimeCommand = cp.getProperty(_name, "Alerter.IRC.uptimeCommand");
475	>	} catch (PropertyNotFoundException e) {
476	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
477	>	// lets bail from handling this line...
478	>	// ...it's gonna be hard without a command set!
479	>	return;
480		}
481	<	// see if it's for us
482	<	else if(getMsg(line).startsWith(_nickname+",")
483	<	|| getMsg(line).startsWith(_nickname+":")
484	<	|| getMsg(line).startsWith(_nickname+" ")) {
485	<	// we have a message for us
486	<	String message = getMsg(line).substring(_nickname.length());
487	<	if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.stopCommand"))!=-1) {
488	<	_active = false;
489	<	sendMsg(getMsgSender(line)+", alerts have been stopped");
481	>
482	>	// see if the message matches (loosely!) any
483	>	// of our known commands
484	>	if(message.equalsIgnoreCase(stopCommand)) {
485	>	_active = false;
486	>	sendMessage(source, "alerts have been stopped");
487	>	}
488	>	else if(message.equalsIgnoreCase(startCommand)) {
489	>	_active = true;
490	>	sendMessage(source, "alerts have been activated");
491	>	}
492	>	// this needs to go before lastAlertCommand if it contains
493	>	// the same words as the lastAlertCommand.
494	>	else if(message.equalsIgnoreCase(timeSinceLastAlertCommand)) {
495	>	if(_lastAlertTime != -1) {
496	>	long uptime = (System.currentTimeMillis() - _lastAlertTime) / 1000;
497	>	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
498	>	sendMessage(source, "I last sent an alert "+uptimeText+ " ago");
499		}
500	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.startCommand"))!=-1) {
501	<	_active = true;
414	<	sendMsg(getMsgSender(line)+", alerts have been activated");
500	>	else {
501	>	sendMessage(source, "I've never sent an alert!");
502		}
503	<	// this needs to go here if it contains the same words as the lastAlertCommand
504	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand"))!=-1) {
505	<	if(_lastAlertTime != -1) {
506	<	long uptime = (System.currentTimeMillis() - _lastAlertTime) / 1000;
507	<	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
421	<	sendMsg(getMsgSender(line)+", I last sent an alert "+uptimeText+ " ago");
422	<	}
423	<	else {
424	<	sendMsg(getMsgSender(line)+", I've never sent an alert!");
425	<	}
503	>	}
504	>	else if(message.equalsIgnoreCase(lastAlertCommand)) {
505	>	if(_lastAlertTime != -1) {
506	>	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, Locale.UK).format(new Date(_lastAlertTime));
507	>	sendMessage(source, "last alert was at "+date+"; "+_lastAlert);
508		}
509	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.lastAlertCommand"))!=-1) {
510	<	if(_lastAlertTime != -1) {
429	<	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, Locale.UK).format(new Date(_lastAlertTime));
430	<	sendMsg(getMsgSender(line)+", last alert was at "+date+"; "+_lastAlert);
431	<	}
432	<	else {
433	<	sendMsg(getMsgSender(line)+", I've never sent an alert!");
434	<	}
435	<
509	>	else {
510	>	sendMessage(source, "I've never sent an alert!");
511		}
512	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.joinCommand"))!=-1) {
513	<	String joinCmd = cp.getProperty(_name, "Alerter.IRC.joinCommand");
514	<	String newChan = message.substring(message.indexOf(joinCmd) + joinCmd.length() + 1);
515	<	int endOfChan = newChan.indexOf(" ");
516	<	if(endOfChan == -1) {
517	<	endOfChan = newChan.length();
518	<	}
519	<	newChan = newChan.substring(0, endOfChan);
520	<	sendMsg(getMsgSender(line)+", okay, I'm off to "+newChan);
521	<	_socketOut.println("PART "+_channel);
522	<	_socketOut.println("JOIN "+newChan);
512	>
513	>	}
514	>	else if(message.equalsIgnoreCase(joinCommand)) {
515	>	String joinCmd = joinCommand;
516	>	String newChan = message.substring(message.indexOf(joinCmd) + joinCmd.length() + 1);
517	>	int endOfChan = newChan.indexOf(" ");
518	>	if(endOfChan == -1) {
519	>	endOfChan = newChan.length();
520	>	}
521	>	newChan = newChan.substring(0, endOfChan);
522	>	if(newChan.equals(_channel)) {
523	>	sendMessage(source, "I'm already on "+newChan+"!");
524	>	} else {
525	>	partChannel(_channel);
526	>	joinChannel(newChan);
527		_channel = newChan;
528		}
529	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.nickChangeCommand"))!=-1) {
530	<	String nickChangeCmd = cp.getProperty(_name, "Alerter.IRC.nickChangeCommand");
531	<	String newNick = message.substring(message.indexOf(nickChangeCmd) + nickChangeCmd.length() + 1);
532	<	int endOfNick = newNick.indexOf(" ");
533	<	if(endOfNick == -1) {
534	<	endOfNick = newNick.length();
535	<	}
457	<	newNick = newNick.substring(0, endOfNick);
458	<	sendMsg(getMsgSender(line)+", okay, changing my nickname to "+newNick);
459	<	_socketOut.println("NICK "+newNick);
460	<	_nickname = newNick;
529	>	}
530	>	else if(message.equalsIgnoreCase(nickChangeCommand)) {
531	>	String nickChangeCmd = nickChangeCommand;
532	>	String newNick = message.substring(message.indexOf(nickChangeCmd) + nickChangeCmd.length() + 1);
533	>	int endOfNick = newNick.indexOf(" ");
534	>	if(endOfNick == -1) {
535	>	endOfNick = newNick.length();
536		}
537	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.versionCommand"))!=-1) {
538	<	sendMsg(getMsgSender(line)+", I am version "+REVISION.substring(11, REVISION.length() -2)+" of the i-scream alerting bot");
464	<	}
465	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.helpCommand"))!=-1) {
466	<	sendPrivMsg(getMsgSender(line), "Hello, I am the i-scream alerting bot version "+REVISION.substring(11, REVISION.length() -2));
467	<	sendPrivMsg(getMsgSender(line), "I understand the following commands;");
468	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.stopCommand"));
469	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.startCommand"));
470	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.lastAlertCommand"));
471	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.joinCommand"));
472	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.nickChangeCommand"));
473	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.statCommand"));
474	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.uptimeCommand"));
475	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand"));
476	<	sendPrivMsg(getMsgSender(line), cp.getProperty(_name, "Alerter.IRC.helpCommand"));
477	<	}
478	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.statCommand"))!=-1) {
479	<	sendMsg(getMsgSender(line)+", I have sent a total of "+_alertCount+" alerts!");
480	<	}
481	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.uptimeCommand"))!=-1) {
482	<	long uptime = (System.currentTimeMillis() - _startTime) / 1000;
483	<	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
484	<	sendMsg(getMsgSender(line)+", I have been running for "+uptimeText);
485	<	}
486	<	else if(message.indexOf("do a jibble dance")!=-1) {
487	<	// little joke :)
488	<	sendAction("jives to the funky beat shouting \"ii--screeeaaammm\"");
489	<	}
490	<	else {
491	<	sendMsg(getMsgSender(line)+", "+cp.getProperty(_name, "Alerter.IRC.rejectMessage"));
492	<	}
537	>	newNick = newNick.substring(0, endOfNick);
538	>	changeNick(newNick);
539		}
540	<	else if(line.indexOf(_nickname)!=-1 && line.indexOf(_channel)!=-1 && line.indexOf("KICK")!=-1) {
541	<	sendPrivMsg(getMsgSender(line), "That wasn't a nice thing to do...");
496	<	_channel = cp.getProperty(_name, "Alerter.IRC.channel");
497	<	_socketOut.println("JOIN "+_channel);
540	>	else if(message.equalsIgnoreCase(versionCommand)) {
541	>	sendMessage(source, "I am version "+REVISION.substring(11, REVISION.length()-2)+" of the i-scream alerting bot");
542		}
543	+	else if(message.equalsIgnoreCase(helpCommand)) {
544	+	sendMessage(source, "Hello, I am the i-scream alerting bot version "+REVISION.substring(11, REVISION.length() -2));
545	+	sendMessage(source, "I understand the following commands;");
546	+	sendMessage(source, stopCommand);
547	+	sendMessage(source, startCommand);
548	+	sendMessage(source, lastAlertCommand);
549	+	sendMessage(source, joinCommand);
550	+	sendMessage(source, nickChangeCommand);
551	+	sendMessage(source, statCommand);
552	+	sendMessage(source, uptimeCommand);
553	+	sendMessage(source, timeSinceLastAlertCommand);
554	+	sendMessage(source, helpCommand);
555	+	}
556	+	else if(message.equalsIgnoreCase(statCommand)) {
557	+	sendMessage(source, "I have sent a total of "+_alertCount+" alerts, and ignored a total of "+_ignoredCount+"!");
558	+	}
559	+	else if(message.equalsIgnoreCase(uptimeCommand)) {
560	+	long uptime = (System.currentTimeMillis() - _startTime) / 1000;
561	+	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
562	+	sendMessage(source, "I have been running for "+uptimeText);
563	+	}
564	+	else if(message.equalsIgnoreCase("ping")) {
565	+	sendMessage(source, "pong");
566	+	}
567	+	else if(message.equalsIgnoreCase("do a jibble dance")) {
568	+	// little joke :)
569	+	sendAction(source, "jives to the funky beat shouting \"ii--screeeaaammm\"");
570	+	}
571	+	else {
572	+	String rejectMessage = NOT_CONFIGURED;
573	+	try {
574	+	rejectMessage = cp.getProperty(_name, "Alerter.IRC.rejectMessage");
575	+	} catch(PropertyNotFoundException e) {
576	+	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
577	+	}
578	+	sendMessage(source, rejectMessage);
579	+	}
580		}
581
582		/**
583	<	* Strips the header from a message line
583	>	* Quick method to check if the message appears
584	>	* to be directed at us. We simply check to see
585	>	* if it starts with our nick in some fashion.
586	>	* This will return null if the message is not
587	>	* for us - thus allowing this method to perform
588	>	* two tasks at once.
589		*
590	<	* @param line the line to strip
591	<	* @return the message from the line
590	>	* @param message the message to check
591	>	* @return the message (with our nick removed), or null if it's not for us.
592		*/
593	<	private String getMsg(String line) {
594	<	String result = "";
595	<	if(line.indexOf("PRIVMSG")!=-1) {
596	<	int firstColon = line.indexOf(":");
597	<	if(firstColon != -1) {
598	<	int secondColon = line.indexOf(":", firstColon+1);
599	<	if(secondColon != -1) {
600	<	result = line.substring(secondColon+1);
601	<	}
602	<	}
593	>	private String isForMe(String message) {
594	>	// change to lower case to remove
595	>	// case ambiguities
596	>	String nick = _nickname.toLowerCase();
597	>	String msg = message.toLowerCase();
598	>	if(msg.startsWith(nick + ", ") ||
599	>	msg.startsWith(nick + ": ") ||
600	>	msg.startsWith(nick + " ")) {
601	>	// NOTE that the 1 here is hardcoded to be the length
602	>	// of the above 'extra' character (eg , or :)
603	>	return message.substring(nick.length()+1).trim();
604		}
605	<	return result;
605	>	else {
606	>	return null;
607	>	}
608		}
609
610		/**
611	<	* Finds out the sender of the message
612	<	*
613	<	* @param line the line to look for a sender in
525	<	* @return the sender
611	>	* Sleep for a configurable amount of time and
612	>	* then return. This is used when reconnecting
613	>	* to the server or a channel.
614		*/
615	<	private String getMsgSender(String line) {
616	<	String result = "";
617	<	int colon = line.indexOf(":");
618	<	int excl = line.indexOf("!");
619	<	if(colon!=-1 && excl!=-1) {
620	<	result = line.substring(colon+1, excl);
615	>	private void reconnectSleep() {
616	>	int delayTime = 0;
617	>	try {
618	>	delayTime = Integer.parseInt(ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.reconnectDelay"));
619	>	} catch (NumberFormatException e) {
620	>	delayTime = DEFAULT_RECONNECT_DELAY;
621	>	_logger.write(this.toString(), Logger.WARNING, "Erronous Alerter.IRC.reconnectDelay value in configuration using default of " + delayTime + " seconds");
622	>	} catch (PropertyNotFoundException e) {
623	>	delayTime = DEFAULT_RECONNECT_DELAY;
624	>	_logger.write(this.toString(), Logger.WARNING, "Alerter.IRC.reconnectDelay value unavailable using default of " + delayTime + " seconds");
625		}
626	<	return result;
626	>	_logger.write(this.toString(), Logger.ERROR, "Waiting "+delayTime+" seconds for reconnect...");
627	>	try {
628	>	Thread.sleep(delayTime * 1000);
629	>	} catch (InterruptedException e) {}
630		}
631
632		/**
633	<	* The socket connected to the server
633	>	* Overrides the {@link java.lang.Object#toString() Object.toString()}
634	>	* method to provide clean logging (every class should have this).
635	>	*
636	>	* This uses the uk.org.iscream.cms.server.util.NameFormat class
637	>	* to format the toString()
638	>	*
639	>	* @return the name of this class and its CVS revision
640		*/
641	<	private Socket _socket;
642	<
643	<	/**
644	<	* The writer
645	<	*/
646	<	private PrintWriter _socketOut;
546	<
547	<	/**
548	<	* The reader
549	<	*/
550	<	private BufferedReader _socketIn;
641	>	public String toString() {
642	>	return FormatName.getName(
643	>	_name,
644	>	getClass().getName(),
645	>	REVISION);
646	>	}
647
648		/**
649		* Just a reminder to what channel we're on...

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines