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.16 by tdb, Mon Mar 5 23:12:43 2001 UTC vs.
Revision 1.30.2.6 by tdb, Wed Feb 6 22:59:06 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	–
43	–	public final String DEFAULT_LEVEL = Alert.alertLevels[0];
44	–
45	–	public final String NOT_CONFIGURED = "<NOT CONFIGURED>";
46	–
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();
57	–
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	<
80	<	String levelName;
81	<	try {
82	<	levelName = cp.getProperty(_name, "Alerter.IRC.level");
83	<	} catch (PropertyNotFoundException e) {
84	<	levelName = DEFAULT_LEVEL;
85	<	_logger.write(toString(), Logger.WARNING, "Alerter.IRC.level value unavailable using default of " + levelName);
74	<	}
75	<	int level = StringUtils.getStringPos(levelName, Alert.alertLevels);
76	<	// only send if it's equal (or above) our level
77	<	if(((alert.getLevel() == 0) && (alert.getLastLevel() >= level)) || (alert.getLevel() >= level)) {
78	<	String alertType = Alert.alertLevels[alert.getLevel()];
79	<	String thresholdType = Alert.thresholdLevels[alert.getThreshold()];
80	<	// sort out the message
81	<	String message;
82	<	try {
83	<	message = cp.getProperty(_name, "Alerter.IRC.message");
84	<	} catch (PropertyNotFoundException e) {
85	<	message = NOT_CONFIGURED;
86	<	_logger.write(toString(), Logger.WARNING, "Alerter.IRC.message value unavailable using default of " + message);
87	<	}
88	<
89	<	message = StringUtils.replaceText(message, "%level%", alertType);
90	<	message = StringUtils.replaceText(message, "%threshold%", thresholdType);
91	<	message = StringUtils.replaceText(message, "%source%", alert.getSource());
92	<	message = StringUtils.replaceText(message, "%value%", alert.getValue());
93	<	message = StringUtils.replaceText(message, "%thresholdValue%", alert.getThresholdValue());
94	<	message = StringUtils.replaceText(message, "%attributeName%", alert.getAttributeName());
95	<	message = StringUtils.replaceText(message, "%timeTillNextAlert%",  getTimeString(Long.parseLong(alert.getTimeTillNextAlert())));
96	<
97	<	// send the message
98	<	_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ alertType + " level");
99	<	_ircbot.sendMsg(message);
100	<	_lastAlert = message;
101	<	_lastAlertTime = System.currentTimeMillis();
102	<	_alertCount ++;
103	<	}
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 120 | 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 129 | Line 117 | public class IRC__Alerter implements PluginAlerter {
117
118		//---PRIVATE METHODS---
119
132	–	private String getTimeString(long time) {
133	–	String timeString = null;
134	–	if (time >= 60) {
135	–	timeString = (time / 60) + " minute(s)";
136	–	} else if (time >= 3600) {
137	–	timeString = ((time/60) / 60) + " hour(s)";
138	–	} else {
139	–	timeString = time + " second(s)";
140	–	}
141	–	return timeString;
142	–	}
143	–
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 168 | 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 184 | 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
189	–	/**
190	–	* This holds a reference to the
191	–	* system logger that is being used.
192	–	*/
193	–	private Logger _logger = ReferenceManager.getInstance().getLogger();
194	–
187		//---STATIC ATTRIBUTES---
188
189		//---INNER CLASSES---
190
191	<	/**
200	<	* This class provides some basic IRCBot functionality. It connects
201	<	* to a specified server, and will remain there until told to
202	<	* leave. Whilst connected it can send a message or a notice to
203	<	* the server.
204	<	*/
205	<	class IRCBot extends Thread {
191	>	class IRCBot extends PircBot implements Runnable {
192
193	<	public static final String DEFAULT_STARTUP_NOTICE = "i-scream ircbot starting...";
193	>	/**
194	>	* The default reconnect delay in seconds
195	>	*/
196	>	public final int DEFAULT_RECONNECT_DELAY = 30;
197
198		/**
199	<	* Main thread loop, this part of the class listens for
200	<	* messages from the server, and acts accordingly. At the
201	<	* present moment it only responds to pings.
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
216	<	boolean run = true;
217	<	while(run) {
218	<	// flag so we can stop the loop
219	<	boolean doRead = true;
220	<	// get the startup notice
221	<	String startupNotice;
206	>	while(true) {
207		try {
208	<	startupNotice = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.startupNotice");
209	<	} catch (PropertyNotFoundException e) {
225	<	startupNotice = DEFAULT_STARTUP_NOTICE;
226	<	_logger.write(this.toString(), Logger.WARNING, "Configuration error: "+e);
208	>	init();
209	>	break;
210		}
211	<	// connect to the IRC server
212	<	try {
213	<	connect();
214	<	sendNotice(startupNotice);
232	<	} catch(IOException e) {
233	<	doRead=false;
234	<	_logger.write(this.toString(), Logger.ERROR, "Error connecting: "+e);
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		}
236	–	while(doRead) {
237	–	try {
238	–	// read a command
239	–	String cmd = _socketIn.readLine();
240	–	// if we have a null, we've lost contact
241	–	if(cmd == null) {
242	–	throw new IOException("End of stream reached");
243	–	}
244	–	// let another method deal with the input
245	–	handleInput(cmd);
246	–	} catch (IOException e) {
247	–	// comms failure, maybe our link is dead.
248	–	_logger.write(this.toString(), Logger.ERROR, "Communication error: "+e);
249	–	// stop, and loop round for a reconnect.
250	–	doRead = false;
251	–	}
252	–	}
253	–	// make sure we're disconnected
254	–	try {
255	–	disconnect();
256	–	} catch (IOException e) {
257	–	_logger.write(this.toString(), Logger.ERROR, "Communication error: "+e);
258	–	}
259	–
260	–	// comms have failed, so wait a while and reconnect
261	–	int delayTime = 0;
262	–	try {
263	–	delayTime = Integer.parseInt(ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.reconnectDelay"));
264	–	} catch (NumberFormatException e) {
265	–	delayTime = DEFAULT_RECONNECT_DELAY;
266	–	_logger.write(this.toString(), Logger.WARNING, "Erronous Alerter.IRC.reconnectDelay value in configuration using default of " + delayTime + " seconds");
267	–	} catch (PropertyNotFoundException e) {
268	–	delayTime = DEFAULT_RECONNECT_DELAY;
269	–	_logger.write(this.toString(), Logger.WARNING, "Alerter.IRC.reconnectDelay value unavailable using default of " + delayTime + " seconds");
270	–	}
271	–	try {
272	–	Thread.sleep(delayTime * 1000);
273	–	} catch (InterruptedException e) {}
216		}
275	–	// maybe disconnect here ? - shutdown method not implemented yet
276	–	//disconnect();
217		}
218
219		/**
220	<	* Sends a message to the channel.
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	<	* @param msg The message to send
225	>	* @throws IOException if there is any problem initialising
226		*/
227	<	public void sendMsg(String msg) {
228	<	_socketOut.println("PRIVMSG "+_channel+" :"+msg);
229	<	// wait a second before returning...
230	<	// this ensures messages can't be sent too fast
288	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
289	<	}
290	<
291	<	/**
292	<	* Sends a message to the channel.
293	<	*
294	<	* @param user The user to send to
295	<	* @param msg The message to send
296	<	*/
297	<	public void sendPrivMsg(String user, String msg) {
298	<	_socketOut.println("PRIVMSG "+user+" :"+msg);
299	<	// wait a second before returning...
300	<	// this ensures messages can't be sent too fast
301	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
302	<	}
303	<
304	<	/**
305	<	* Sends an action to the channel.
306	<	*
307	<	* @param msg the action message
308	<	*/
309	<	public void sendAction(String msg) {
310	<	char esc = 001;
311	<	sendMsg(esc+"ACTION "+msg+esc);
312	<	// wait a second before returning...
313	<	// this ensures messages can't be sent too fast
314	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
315	<	}
316	<
317	<	/**
318	<	* Sends a notice to the channel.
319	<	*
320	<	* @param msg The notice to send
321	<	*/
322	<	public void sendNotice(String msg) {
323	<	_socketOut.println("NOTICE "+_channel+" :"+msg);
324	<	// wait a second before returning...
325	<	// this ensures messages can't be sent too fast
326	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
327	<	}
328	<
329	<	/**
330	<	* Connect to the IRC server, log in, and join the channel.
331	<	*
332	<	* @throws IOException if the connection fails
333	<	*/
334	<	public void connect() throws IOException {
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	<	// setup the socket, reader and writer
232	>
233	>	// get hold of the server details
234		String server;
235		int port;
236		try {
#	Line 346 | Line 243 | public class IRC__Alerter implements PluginAlerter {
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	<	_socket = new Socket(server, port);
247	<	_socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
248	<	_socketOut = new PrintWriter(_socket.getOutputStream(), true);
352	<	//_socketOut.println("PASS");
353	<	// send USER details
354	<	String user, comment;
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	<	comment = cp.getProperty(_name, "Alerter.IRC.comment");
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 details due to configuration error");
254	>	throw new IOException("Can't get user/nickname details due to configuration error");
255		}
256	<	_socketOut.println("USER "+user+" 8 * :"+comment);
257	<	// attempt to get a nick
258	<	String nickList;
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	<	nickList = cp.getProperty(_name, "Alerter.IRC.nickList");
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.ERROR, "Configuration error: "+e);
369	<	throw new IOException("Can't get nickname due to configuration error");
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("[" + getRevision() + "] " + 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;
373	–	// try until we exhaust our list
277		while(!ok && st.hasMoreTokens()) {
278		String nick = st.nextToken();
279	<	_socketOut.println("NICK "+nick);
280	<	// get a "yes" or "no" response back
281	<	String response = "";
282	<	do {
283	<	response = _socketIn.readLine();
284	<	if(response==null) {
382	<	throw new IOException("Communication error whilst logging in");
383	<	}
384	<	} while(response.indexOf("001")==-1 && response.indexOf("433")==-1);
385	<	// see if it was a yes
386	<	if(response.indexOf("001")!=-1) {
387	<	// great, we're logged in !
388	<	ok = true;
389	<	// store the name we're using
279	>	try {
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	<	else {
289	<	// log we couldn't get the name
290	<	_logger.write(this.toString(), Logger.WARNING, "Nickname in use: "+nick);
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	+	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		if(!ok) {
303	<	// oh dear, we couldn't get on.
304	<	throw new IOException("All nicknames in use");
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	<	// join the channel
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	<	_socketOut.println("JOIN "+_channel);
318	<	// allow alerts
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	<	* Disconnect "nicely" from the IRC server.
334	>	* Send a message to the current channel.
335		*
336	<	* @throws IOException if the disconnection fails
336	>	* @param message The message to send
337		*/
338	<	public void disconnect() throws IOException {
339	<	// stop alerts
338	>	private void sendMessage(String message) {
339	>	sendMessage(_channel, message);
340	>	}
341	>
342	>	/**
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 onDisconnect() {
349	>	// stop alerts being sent for now
350		_active = false;
351	<	// send proper QUIT
352	<	_socketOut.println("QUIT : iscreamBot component shutting down...");
353	<	// close the socket
354	<	_socketOut.close();
355	<	_socketIn.close();
356	<	_socket.close();
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	<	* Overrides the {@link java.lang.Object#toString() Object.toString()}
366	<	* method to provide clean logging (every class should have this).
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	<	* This uses the uk.ac.ukc.iscream.util.NameFormat class
370	<	* to format the toString()
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 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	>	* 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	<	* @return the name of this class and its CVS revision
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 String toString() {
394	<	return FormatName.getName(
440	<	_name,
441	<	getClass().getName(),
442	<	REVISION);
393	>	public void onPrivateMessage(String sender, String login, String hostname, String message) {
394	>	handleInput(message, sender);
395		}
396
397		/**
398	<	* Deals with incoming lines from the server.
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	<	* @param line the line to deal with
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	<	private void handleInput(String line) {
411	<	ConfigurationProxy cp = ConfigurationProxy.getInstance();
412	<	// if it's a PING...
413	<	if(line.startsWith("PING")) {
414	<	// ...send a PONG
455	<	_socketOut.println("PONG" + line.substring(4));
410	>	public void onNickChange(String oldNick, String login, String hostname, String newNick) {
411	>	if(oldNick.equals(_nickname)) {
412	>	_nickname = newNick;
413	>	// tell the underlying pircbot that our nick has changed too :)
414	>	setName(newNick);
415		}
416	<	// see if it's for us
417	<	else if(getMsg(line).startsWith(_nickname+",") || getMsg(line).startsWith(_nickname+":") || getMsg(line).startsWith(_nickname+" ")) {
418	<	// setup some String's
419	<	String stopCommand, startCommand, timeSinceLastAlertCommand, lastAlertCommand, joinCommand;
420	<	String nickChangeCommand, versionCommand, helpCommand, statCommand, uptimeCommand;
421	<	// get the command set
416	>	}
417	>
418	>	/**
419	>	* If we receive a kick message this method
420	>	* gets called. We only take notice if it's
421	>	* us getting kicked, and then we'll rejoin
422	>	* the channel after a short wait.
423	>	*
424	>	* @param channel the channel the kick happened on
425	>	* @param kickerNick the person who performed the kick
426	>	* @param kickerLogin the login of the person who performed the kick
427	>	* @param kickerHostname the hostname of the person who performed the kick
428	>	* @param recipientNick the nickname of the person being kicked
429	>	* @param reason the reason for the kick
430	>	*/
431	>	public void onKick(String channel, String kickerNick, String kickerLogin, String kickerHostname, String recipientNick, String reason) {
432	>	if(recipientNick.equals(_nickname) && channel.equals(_channel)) {
433	>	// remind the person it's not very nice :)
434	>	sendMessage(kickerNick, "That wasn't a nice thing to do...");
435	>	// get hold of the channel details, in case they've changed
436		try {
437	<	stopCommand = cp.getProperty(_name, "Alerter.IRC.stopCommand");
438	<	startCommand = cp.getProperty(_name, "Alerter.IRC.startCommand");
439	<	timeSinceLastAlertCommand = cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand");
467	<	lastAlertCommand = cp.getProperty(_name, "Alerter.IRC.lastAlertCommand");
468	<	joinCommand = cp.getProperty(_name, "Alerter.IRC.joinCommand");
469	<	nickChangeCommand = cp.getProperty(_name, "Alerter.IRC.nickChangeCommand");
470	<	versionCommand = cp.getProperty(_name, "Alerter.IRC.versionCommand");
471	<	helpCommand = cp.getProperty(_name, "Alerter.IRC.helpCommand");
472	<	statCommand = cp.getProperty(_name, "Alerter.IRC.statCommand");
473	<	uptimeCommand = cp.getProperty(_name, "Alerter.IRC.uptimeCommand");
474	<	} catch (PropertyNotFoundException e) {
475	<	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
476	<	// lets bail from handling this line...
477	<	// ...it's gonna be hard without a command set!
478	<	return;
437	>	_channel = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.channel");
438	>	} catch(PropertyNotFoundException e) {
439	>	_logger.write(this.toString(), Logger.ERROR, "Can't get channel name due to configuration error: "+e);
440		}
441	<
442	<	// we have a message for us
443	<	String message = getMsg(line).substring(_nickname.length());
444	<	if(message.indexOf(stopCommand)!=-1) {
445	<	_active = false;
446	<	sendMsg(getMsgSender(line)+", alerts have been stopped");
441	>	// wait for a while, defined in the config
442	>	reconnectSleep();
443	>	// we'll try and rejoin the channel regardless
444	>	// otherwise we might end up doing nothing!
445	>	joinChannel(_channel);
446	>	}
447	>	}
448	>
449	>	/**
450	>	* This method handles input directed to us, and
451	>	* responds accordingly if required.
452	>	*
453	>	* @param message the message from someone
454	>	* @param source where the message came from, so we know where to send the response
455	>	*/
456	>	private void handleInput(String message, String source) {
457	>	// get hold of the configuration system
458	>	ConfigurationProxy cp = ConfigurationProxy.getInstance();
459	>	// setup some String's
460	>	String stopCommand, startCommand, timeSinceLastAlertCommand, lastAlertCommand, joinCommand;
461	>	String nickChangeCommand, versionCommand, helpCommand, statCommand, uptimeCommand;
462	>	// get the command set from the configuration
463	>	try {
464	>	stopCommand = cp.getProperty(_name, "Alerter.IRC.stopCommand");
465	>	startCommand = cp.getProperty(_name, "Alerter.IRC.startCommand");
466	>	timeSinceLastAlertCommand = cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand");
467	>	lastAlertCommand = cp.getProperty(_name, "Alerter.IRC.lastAlertCommand");
468	>	joinCommand = cp.getProperty(_name, "Alerter.IRC.joinCommand");
469	>	nickChangeCommand = cp.getProperty(_name, "Alerter.IRC.nickChangeCommand");
470	>	versionCommand = cp.getProperty(_name, "Alerter.IRC.versionCommand");
471	>	helpCommand = cp.getProperty(_name, "Alerter.IRC.helpCommand");
472	>	statCommand = cp.getProperty(_name, "Alerter.IRC.statCommand");
473	>	uptimeCommand = cp.getProperty(_name, "Alerter.IRC.uptimeCommand");
474	>	} catch (PropertyNotFoundException e) {
475	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
476	>	// lets bail from handling this line...
477	>	// ...it's gonna be hard without a command set!
478	>	return;
479	>	}
480	>
481	>	if(message.equalsIgnoreCase(stopCommand)) {
482	>	_active = false;
483	>	sendMessage(source, "alerts have been stopped");
484	>	}
485	>	else if(message.equalsIgnoreCase(startCommand)) {
486	>	_active = true;
487	>	sendMessage(source, "alerts have been activated");
488	>	}
489	>	// this needs to go before lastAlertCommand if it contains
490	>	// the same words as the lastAlertCommand.
491	>	else if(message.equalsIgnoreCase(timeSinceLastAlertCommand)) {
492	>	if(_lastAlertTime != -1) {
493	>	long uptime = (System.currentTimeMillis() - _lastAlertTime) / 1000;
494	>	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
495	>	sendMessage(source, "I last sent an alert "+uptimeText+ " ago");
496		}
497	<	else if(message.indexOf(startCommand)!=-1) {
498	<	_active = true;
489	<	sendMsg(getMsgSender(line)+", alerts have been activated");
497	>	else {
498	>	sendMessage(source, "I've never sent an alert!");
499		}
500	<	// this needs to go here if it contains the same words as the lastAlertCommand
501	<	else if(message.indexOf(timeSinceLastAlertCommand)!=-1) {
502	<	if(_lastAlertTime != -1) {
503	<	long uptime = (System.currentTimeMillis() - _lastAlertTime) / 1000;
504	<	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
496	<	sendMsg(getMsgSender(line)+", I last sent an alert "+uptimeText+ " ago");
497	<	}
498	<	else {
499	<	sendMsg(getMsgSender(line)+", I've never sent an alert!");
500	<	}
500	>	}
501	>	else if(message.equalsIgnoreCase(lastAlertCommand)) {
502	>	if(_lastAlertTime != -1) {
503	>	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, Locale.UK).format(new Date(_lastAlertTime));
504	>	sendMessage(source, "last alert was at "+date+"; "+_lastAlert);
505		}
506	<	else if(message.indexOf(lastAlertCommand)!=-1) {
507	<	if(_lastAlertTime != -1) {
504	<	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, Locale.UK).format(new Date(_lastAlertTime));
505	<	sendMsg(getMsgSender(line)+", last alert was at "+date+"; "+_lastAlert);
506	<	}
507	<	else {
508	<	sendMsg(getMsgSender(line)+", I've never sent an alert!");
509	<	}
510	<
506	>	else {
507	>	sendMessage(source, "I've never sent an alert!");
508		}
509	<	else if(message.indexOf(joinCommand)!=-1) {
510	<	String joinCmd = joinCommand;
511	<	String newChan = message.substring(message.indexOf(joinCmd) + joinCmd.length() + 1);
512	<	int endOfChan = newChan.indexOf(" ");
513	<	if(endOfChan == -1) {
514	<	endOfChan = newChan.length();
515	<	}
516	<	newChan = newChan.substring(0, endOfChan);
517	<	sendMsg(getMsgSender(line)+", okay, I'm off to "+newChan);
518	<	_socketOut.println("PART "+_channel);
519	<	_socketOut.println("JOIN "+newChan);
509	>
510	>	}
511	>	else if(message.toLowerCase().startsWith(joinCommand.toLowerCase())) {
512	>	String joinCmd = joinCommand;
513	>	String newChan = message.substring(message.indexOf(joinCmd) + joinCmd.length() + 1);
514	>	int endOfChan = newChan.indexOf(" ");
515	>	if(endOfChan == -1) {
516	>	endOfChan = newChan.length();
517	>	}
518	>	newChan = newChan.substring(0, endOfChan);
519	>	if(newChan.equals(_channel)) {
520	>	sendMessage(source, "I'm already on "+newChan+"!");
521	>	} else {
522	>	partChannel(_channel);
523	>	joinChannel(newChan);
524		_channel = newChan;
525		}
526	<	else if(message.indexOf(nickChangeCommand)!=-1) {
527	<	String nickChangeCmd = nickChangeCommand;
528	<	String newNick = message.substring(message.indexOf(nickChangeCmd) + nickChangeCmd.length() + 1);
529	<	int endOfNick = newNick.indexOf(" ");
530	<	if(endOfNick == -1) {
531	<	endOfNick = newNick.length();
532	<	}
532	<	newNick = newNick.substring(0, endOfNick);
533	<	sendMsg(getMsgSender(line)+", okay, changing my nickname to "+newNick);
534	<	_socketOut.println("NICK "+newNick);
535	<	_nickname = newNick;
526	>	}
527	>	else if(message.toLowerCase().startsWith(nickChangeCommand.toLowerCase())) {
528	>	String nickChangeCmd = nickChangeCommand;
529	>	String newNick = message.substring(message.indexOf(nickChangeCmd) + nickChangeCmd.length() + 1);
530	>	int endOfNick = newNick.indexOf(" ");
531	>	if(endOfNick == -1) {
532	>	endOfNick = newNick.length();
533		}
534	<	else if(message.indexOf(versionCommand)!=-1) {
535	<	sendMsg(getMsgSender(line)+", I am version "+REVISION.substring(11, REVISION.length() -2)+" of the i-scream alerting bot");
539	<	}
540	<	else if(message.indexOf(helpCommand)!=-1) {
541	<	sendPrivMsg(getMsgSender(line), "Hello, I am the i-scream alerting bot version "+REVISION.substring(11, REVISION.length() -2));
542	<	sendPrivMsg(getMsgSender(line), "I understand the following commands;");
543	<	sendPrivMsg(getMsgSender(line), stopCommand);
544	<	sendPrivMsg(getMsgSender(line), startCommand);
545	<	sendPrivMsg(getMsgSender(line), lastAlertCommand);
546	<	sendPrivMsg(getMsgSender(line), joinCommand);
547	<	sendPrivMsg(getMsgSender(line), nickChangeCommand);
548	<	sendPrivMsg(getMsgSender(line), statCommand);
549	<	sendPrivMsg(getMsgSender(line), uptimeCommand);
550	<	sendPrivMsg(getMsgSender(line), timeSinceLastAlertCommand);
551	<	sendPrivMsg(getMsgSender(line), helpCommand);
552	<	}
553	<	else if(message.indexOf(statCommand)!=-1) {
554	<	sendMsg(getMsgSender(line)+", I have sent a total of "+_alertCount+" alerts!");
555	<	}
556	<	else if(message.indexOf(uptimeCommand)!=-1) {
557	<	long uptime = (System.currentTimeMillis() - _startTime) / 1000;
558	<	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
559	<	sendMsg(getMsgSender(line)+", I have been running for "+uptimeText);
560	<	}
561	<	else if(message.indexOf("do a jibble dance")!=-1) {
562	<	// little joke :)
563	<	sendAction("jives to the funky beat shouting \"ii--screeeaaammm\"");
564	<	}
565	<	else {
566	<	String rejectMessage = NOT_CONFIGURED;
567	<	try {
568	<	rejectMessage = cp.getProperty(_name, "Alerter.IRC.rejectMessage");
569	<	} catch(PropertyNotFoundException e) {
570	<	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
571	<	}
572	<	sendMsg(getMsgSender(line)+", "+rejectMessage);
573	<	}
534	>	newNick = newNick.substring(0, endOfNick);
535	>	changeNick(newNick);
536		}
537	<	else if(line.indexOf(_nickname)!=-1 && line.indexOf(_channel)!=-1 && line.indexOf("KICK")!=-1) {
538	<	sendPrivMsg(getMsgSender(line), "That wasn't a nice thing to do...");
537	>	else if(message.equalsIgnoreCase(versionCommand)) {
538	>	sendMessage(source, "I am version " + getRevision() + " of the i-scream alerting bot");
539	>	}
540	>	else if(message.equalsIgnoreCase(helpCommand)) {
541	>	sendMessage(source, "Hello, I am the i-scream alerting bot version "+REVISION.substring(11, REVISION.length() -2));
542	>	sendMessage(source, "I understand the following commands;");
543	>	sendMessage(source, stopCommand);
544	>	sendMessage(source, startCommand);
545	>	sendMessage(source, lastAlertCommand);
546	>	sendMessage(source, joinCommand);
547	>	sendMessage(source, nickChangeCommand);
548	>	sendMessage(source, statCommand);
549	>	sendMessage(source, uptimeCommand);
550	>	sendMessage(source, timeSinceLastAlertCommand);
551	>	sendMessage(source, helpCommand);
552	>	}
553	>	else if(message.equalsIgnoreCase(statCommand)) {
554	>	sendMessage(source, "I have sent a total of "+_alertCount+" alerts, and ignored a total of "+_ignoredCount+"!");
555	>	}
556	>	else if(message.equalsIgnoreCase(uptimeCommand)) {
557	>	long uptime = (System.currentTimeMillis() - _startTime) / 1000;
558	>	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
559	>	sendMessage(source, "I have been running for "+uptimeText);
560	>	}
561	>	else if(message.equalsIgnoreCase("ping")) {
562	>	sendMessage(source, "pong");
563	>	}
564	>	else if(message.equalsIgnoreCase("do a jibble dance")) {
565	>	// little joke :)
566	>	sendAction(source, "jives to the funky beat shouting \"ii--screeeaaammm\"");
567	>	}
568	>	else {
569	>	String rejectMessage = NOT_CONFIGURED;
570		try {
571	<	_channel = cp.getProperty(_name, "Alerter.IRC.channel");
571	>	rejectMessage = cp.getProperty(_name, "Alerter.IRC.rejectMessage");
572		} catch(PropertyNotFoundException e) {
573		_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
574		}
575	<	_socketOut.println("JOIN "+_channel);
575	>	sendMessage(source, rejectMessage);
576		}
577		}
578
579		/**
580	<	* Strips the header from a message line
580	>	* Quick method to check if the message appears
581	>	* to be directed at us. We simply check to see
582	>	* if it starts with our nick in some fashion.
583	>	* This will return null if the message is not
584	>	* for us - thus allowing this method to perform
585	>	* two tasks at once.
586		*
587	<	* @param line the line to strip
588	<	* @return the message from the line
587	>	* @param message the message to check
588	>	* @return the message (with our nick removed), or null if it's not for us.
589		*/
590	<	private String getMsg(String line) {
591	<	String result = "";
592	<	if(line.indexOf("PRIVMSG")!=-1) {
593	<	int firstColon = line.indexOf(":");
594	<	if(firstColon != -1) {
595	<	int secondColon = line.indexOf(":", firstColon+1);
596	<	if(secondColon != -1) {
597	<	result = line.substring(secondColon+1);
598	<	}
599	<	}
590	>	private String isForMe(String message) {
591	>	// change to lower case to remove
592	>	// case ambiguities
593	>	String nick = _nickname.toLowerCase();
594	>	String msg = message.toLowerCase();
595	>	if(msg.startsWith(nick + ", ") ||
596	>	msg.startsWith(nick + ": ") ||
597	>	msg.startsWith(nick + " ")) {
598	>	// NOTE that the 1 here is hardcoded to be the length
599	>	// of the above 'extra' character (eg , or :)
600	>	return message.substring(nick.length()+1).trim();
601		}
602	<	return result;
602	>	else {
603	>	return null;
604	>	}
605		}
606
607		/**
608	<	* Finds out the sender of the message
609	<	*
610	<	* @param line the line to look for a sender in
610	<	* @return the sender
608	>	* Sleep for a configurable amount of time and
609	>	* then return. This is used when reconnecting
610	>	* to the server or a channel.
611		*/
612	<	private String getMsgSender(String line) {
613	<	String result = "";
614	<	int colon = line.indexOf(":");
615	<	int excl = line.indexOf("!");
616	<	if(colon!=-1 && excl!=-1) {
617	<	result = line.substring(colon+1, excl);
612	>	private void reconnectSleep() {
613	>	int delayTime = 0;
614	>	try {
615	>	delayTime = Integer.parseInt(ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.reconnectDelay"));
616	>	} catch (NumberFormatException e) {
617	>	delayTime = DEFAULT_RECONNECT_DELAY;
618	>	_logger.write(this.toString(), Logger.WARNING, "Erronous Alerter.IRC.reconnectDelay value in configuration using default of " + delayTime + " seconds");
619	>	} catch (PropertyNotFoundException e) {
620	>	delayTime = DEFAULT_RECONNECT_DELAY;
621	>	_logger.write(this.toString(), Logger.WARNING, "Alerter.IRC.reconnectDelay value unavailable using default of " + delayTime + " seconds");
622		}
623	<	return result;
623	>	_logger.write(this.toString(), Logger.ERROR, "Waiting "+delayTime+" seconds for reconnect...");
624	>	try {
625	>	Thread.sleep(delayTime * 1000);
626	>	} catch (InterruptedException e) {}
627		}
628
629		/**
630	<	* The socket connected to the server
630	>	* Returns the revision of the bot.
631	>	*
632	>	* @return the revision of this bot
633		*/
634	<	private Socket _socket;
634	>	private String getRevision() {
635	>	return REVISION.substring(11, REVISION.length()-2);
636	>	}
637
638		/**
639	<	* The writer
639	>	* Overrides the {@link java.lang.Object#toString() Object.toString()}
640	>	* method to provide clean logging (every class should have this).
641	>	*
642	>	* This uses the uk.org.iscream.cms.server.util.NameFormat class
643	>	* to format the toString()
644	>	*
645	>	* @return the name of this class and its CVS revision
646		*/
647	<	private PrintWriter _socketOut;
648	<
649	<	/**
650	<	* The reader
651	<	*/
652	<	private BufferedReader _socketIn;
647	>	public String toString() {
648	>	return FormatName.getName(
649	>	_name,
650	>	getClass().getName(),
651	>	REVISION);
652	>	}
653
654		/**
655		* Just a reminder to what channel we're on...

Diff Legend

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