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.2 by tdb, Mon Feb 4 23:14:38 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(true);
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.sendMsg(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		public void run() {
199	<	// 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
199	>	while(true) {
200		try {
201	<	connect();
202	<	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);
201	>	init();
202	>	break;
203		}
204	<	while(doRead) {
205	<	try {
206	<	// read a command
211	<	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	<	}
204	>	catch (IOException e) {
205	>	_logger.write(this.toString(), Logger.ERROR, "Error initialising IRCBot: "+e);
206	>	reconnectSleep();
207		}
225	–	// make sure we're disconnected
226	–	try {
227	–	disconnect();
228	–	} catch (IOException e) {
229	–	_logger.write(this.toString(), Logger.ERROR, "Communication error: "+e);
230	–	}
231	–
232	–	// comms have failed, so wait a while and reconnect
233	–	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");
242	–	}
243	–	try {
244	–	Thread.sleep(delayTime * 1000);
245	–	} catch (InterruptedException e) {}
208		}
209	<	// maybe disconnect here ? - shutdown method not implemented yet
248	<	//disconnect();
209	>	//System.out.println("falling out!");
210		}
211
212	<	/**
213	<	* Sends a message to the channel.
253	<	*
254	<	* @param msg The message to send
255	<	*/
256	<	public void sendMsg(String msg) {
257	<	_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) {}
261	<	}
262	<
263	<	/**
264	<	* Sends a message to the channel.
265	<	*
266	<	* @param user The user to send to
267	<	* @param msg The message to send
268	<	*/
269	<	public void sendPrivMsg(String user, String msg) {
270	<	_socketOut.println("PRIVMSG "+user+" :"+msg);
271	<	// wait a second before returning...
272	<	// this ensures messages can't be sent too fast
273	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
274	<	}
275	<
276	<	/**
277	<	* Sends an action to the channel.
278	<	*
279	<	* @param msg the action message
280	<	*/
281	<	public void sendAction(String msg) {
282	<	char esc = 001;
283	<	sendMsg(esc+"ACTION "+msg+esc);
284	<	// wait a second before returning...
285	<	// this ensures messages can't be sent too fast
286	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
287	<	}
288	<
289	<	/**
290	<	* Sends a notice to the channel.
291	<	*
292	<	* @param msg The notice to send
293	<	*/
294	<	public void sendNotice(String msg) {
295	<	_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) {}
299	<	}
300	<
301	<	/**
302	<	* Connect to the IRC server, log in, and join the channel.
303	<	*
304	<	* @throws IOException if the connection fails
305	<	*/
306	<	public void connect() throws IOException {
212	>	public void init() throws IOException {
213	>	_logger.write(this.toString(), Logger.DEBUG, "Initialising IRCBot...");
214		ConfigurationProxy cp = ConfigurationProxy.getInstance();
215	<	// setup the socket, reader and writer
216	<	String server = cp.getProperty(_name, "Alerter.IRC.IRCServer");
217	<	int port = Integer.parseInt(cp.getProperty(_name, "Alerter.IRC.IRCPort"));
218	<	_socket = new Socket(server, port);
219	<	_socketIn = new BufferedReader(new InputStreamReader(_socket.getInputStream()));
220	<	_socketOut = new PrintWriter(_socket.getOutputStream(), true);
221	<	//_socketOut.println("PASS");
222	<	// send USER details
223	<	String user = cp.getProperty(_name, "Alerter.IRC.user");
224	<	String comment = cp.getProperty(_name, "Alerter.IRC.comment");
225	<	_socketOut.println("USER "+user+" 8 * :"+comment);
226	<	// attempt to get a nick
227	<	String nickList = cp.getProperty(_name, "Alerter.IRC.nickList");
215	>	String server;
216	>	int port;
217	>	try {
218	>	server = cp.getProperty(_name, "Alerter.IRC.IRCServer");
219	>	port = Integer.parseInt(cp.getProperty(_name, "Alerter.IRC.IRCPort"));
220	>	} catch (PropertyNotFoundException e) {
221	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
222	>	throw new IOException("Can't get irc server details due to configuration error");
223	>	} catch (NumberFormatException e) {
224	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
225	>	throw new IOException("Can't get irc server details due to malformed configuration");
226	>	}
227	>	String user, comment;
228	>	try {
229	>	user = cp.getProperty(_name, "Alerter.IRC.user");
230	>	comment = cp.getProperty(_name, "Alerter.IRC.comment");
231	>	} catch (PropertyNotFoundException e) {
232	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
233	>	throw new IOException("Can't get user details due to configuration error");
234	>	}
235	>	this.setLogin(user);
236	>	this.setVersion(comment);
237	>	this.setFinger(comment); // ?
238	>	String nickList;
239	>	try {
240	>	nickList = cp.getProperty(_name, "Alerter.IRC.nickList");
241	>	} catch (PropertyNotFoundException e) {
242	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
243	>	throw new IOException("Can't get nickname due to configuration error");
244	>	}
245		StringTokenizer st = new StringTokenizer(nickList, ";");
246		boolean ok = false;
323	–	// try until we exhaust our list
247		while(!ok && st.hasMoreTokens()) {
248		String nick = st.nextToken();
249	<	_socketOut.println("NICK "+nick);
250	<	// get a "yes" or "no" response back
251	<	String response = "";
252	<	do {
253	<	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
249	>	try {
250	>	_logger.write(this.toString(), Logger.DEBUG, "Trying nick: "+nick);
251	>	this.setName(nick);
252	>	this.connect(server, port);
253	>	// must be ok if we get here
254		_nickname = nick;
255	+	ok = true;
256		}
257	<	else {
258	<	// log we couldn't get the name
259	<	_logger.write(this.toString(), Logger.WARNING, "Nickname in use: "+nick);
257	>	catch(IOException e) {
258	>	_logger.write(this.toString(), Logger.ERROR, "IO error when connecting to server: "+e);
259	>	throw new IOException("IO error when connecting to server");
260		}
261	+	catch(IrcException e) {
262	+	_logger.write(this.toString(), Logger.ERROR, "IRC error when connecting to server: "+e);
263	+	throw new IOException("IRC error when connecting to server");
264	+	}
265	+	catch(NickAlreadyInUseException e) {
266	+	_logger.write(this.toString(), Logger.ERROR, "Nickname "+nick+" is already in use: "+e);
267	+	// just carry on around while loop
268	+	}
269		}
270		if(!ok) {
271		// oh dear, we couldn't get on.
272	<	throw new IOException("All nicknames in use");
272	>	_logger.write(this.toString(), Logger.ERROR, "All nicknames already in use");
273	>	throw new IOException("All nicknames already in use");
274		}
275	<	// join the channel
276	<	_channel = cp.getProperty(_name, "Alerter.IRC.channel");
277	<	_socketOut.println("JOIN "+_channel);
278	<	// allow alerts
275	>	try {
276	>	_channel = cp.getProperty(_name, "Alerter.IRC.channel");
277	>	this.joinChannel(_channel);
278	>	} catch (PropertyNotFoundException e) {
279	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
280	>	throw new IOException("Can't get channel name due to configuration error");
281	>	}
282	>
283	>	String startupNotice;
284	>	try {
285	>	startupNotice = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.startupNotice");
286	>	sendNotice(_channel, startupNotice);
287	>	} catch (PropertyNotFoundException e) {
288	>	_logger.write(this.toString(), Logger.DEBUG, "Startup notice not defined, so not sending: "+e);
289	>	}
290	>
291	>	// we should set this when all is ready!
292		_active = true;
293	+	//System.out.println("leaving init");
294		}
295
296	<	/**
297	<	* Disconnect "nicely" from the IRC server.
298	<	*
299	<	* @throws IOException if the disconnection fails
300	<	*/
363	<	public void disconnect() throws IOException {
364	<	// stop alerts
296	>	public void sendMsg(String msg) {
297	>	sendMessage(_channel, msg);
298	>	}
299	>
300	>	public void onDisconnect() {
301		_active = false;
302	<	// send proper QUIT
303	<	_socketOut.println("QUIT : iscreamBot component shutting down...");
304	<	// close the socket
305	<	_socketOut.close();
306	<	_socketIn.close();
307	<	_socket.close();
302	>	while(true) {
303	>	reconnectSleep();
304	>	try {
305	>	init();
306	>	break;
307	>	}
308	>	catch (IOException e) {
309	>	_logger.write(this.toString(), Logger.ERROR, "Error initialising IRCBot: "+e);
310	>	}
311	>	}
312	>	//System.out.println("falling out of disconnect!");
313		}
314
315	<	/**
316	<	* Overrides the {@link java.lang.Object#toString() Object.toString()}
317	<	* method to provide clean logging (every class should have this).
318	<	*
378	<	* This uses the uk.ac.ukc.iscream.util.NameFormat class
379	<	* to format the toString()
380	<	*
381	<	* @return the name of this class and its CVS revision
382	<	*/
383	<	public String toString() {
384	<	return FormatName.getName(
385	<	_name,
386	<	getClass().getName(),
387	<	REVISION);
315	>	public void onMessage(String channel, String sender, String login, String hostname, String message) {
316	>	if(isForMe(message)) {
317	>	handleInput(message, channel);
318	>	}
319		}
320
321	<	/**
322	<	* Deals with incoming lines from the server.
323	<	*
324	<	* @param line the line to deal with
325	<	*/
326	<	private void handleInput(String line) {
321	>	public void onPrivateMessage(String sender, String login, String hostname, String message) {
322	>	handleInput(message, sender);
323	>	}
324	>
325	>	public void onNickChange(String oldNick, String login, String hostname, String newNick) {
326	>	if(oldNick.equals(_nickname)) {
327	>	_nickname = newNick;
328	>	}
329	>	}
330	>
331	>	public void onKick(String channel, String kickerNick, String kickerLogin, String kickerHostname, String recipientNick, String reason) {
332	>	if(recipientNick.equals(_nickname) && channel.equals(_channel)) {
333	>	sendMessage(kickerNick, "That wasn't a nice thing to do...");
334	>	try {
335	>	_channel = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.channel");
336	>	} catch(PropertyNotFoundException e) {
337	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
338	>	}
339	>	// should this be in the try?
340	>	joinChannel(_channel);
341	>	}
342	>	}
343	>
344	>	private void handleInput(String message, String source) {
345	>	System.out.println("message: "+message);
346	>	System.out.println("from: "+source);
347		ConfigurationProxy cp = ConfigurationProxy.getInstance();
348	<	// if it's a PING...
349	<	if(line.startsWith("PING")) {
350	<	// ...send a PONG
351	<	_socketOut.println("PONG" + line.substring(4));
348	>	// setup some String's
349	>	String stopCommand, startCommand, timeSinceLastAlertCommand, lastAlertCommand, joinCommand;
350	>	String nickChangeCommand, versionCommand, helpCommand, statCommand, uptimeCommand;
351	>	// get the command set
352	>	try {
353	>	stopCommand = cp.getProperty(_name, "Alerter.IRC.stopCommand");
354	>	startCommand = cp.getProperty(_name, "Alerter.IRC.startCommand");
355	>	timeSinceLastAlertCommand = cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand");
356	>	lastAlertCommand = cp.getProperty(_name, "Alerter.IRC.lastAlertCommand");
357	>	joinCommand = cp.getProperty(_name, "Alerter.IRC.joinCommand");
358	>	nickChangeCommand = cp.getProperty(_name, "Alerter.IRC.nickChangeCommand");
359	>	versionCommand = cp.getProperty(_name, "Alerter.IRC.versionCommand");
360	>	helpCommand = cp.getProperty(_name, "Alerter.IRC.helpCommand");
361	>	statCommand = cp.getProperty(_name, "Alerter.IRC.statCommand");
362	>	uptimeCommand = cp.getProperty(_name, "Alerter.IRC.uptimeCommand");
363	>	} catch (PropertyNotFoundException e) {
364	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
365	>	// lets bail from handling this line...
366	>	// ...it's gonna be hard without a command set!
367	>	return;
368		}
369	<	// see if it's for us
370	<	else if(getMsg(line).startsWith(_nickname+",")
371	<	|| getMsg(line).startsWith(_nickname+":")
372	<	|| getMsg(line).startsWith(_nickname+" ")) {
373	<	// we have a message for us
374	<	String message = getMsg(line).substring(_nickname.length());
375	<	if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.stopCommand"))!=-1) {
376	<	_active = false;
377	<	sendMsg(getMsgSender(line)+", alerts have been stopped");
369	>
370	>	if(message.indexOf(stopCommand) != -1) {
371	>	_active = false;
372	>	sendMessage(source, "alerts have been stopped");
373	>	}
374	>	else if(message.indexOf(startCommand) != -1) {
375	>	_active = true;
376	>	sendMessage(source, "alerts have been activated");
377	>	}
378	>	// this needs to go here if it contains the same words as the lastAlertCommand
379	>	else if(message.indexOf(timeSinceLastAlertCommand) != -1) {
380	>	if(_lastAlertTime != -1) {
381	>	long uptime = (System.currentTimeMillis() - _lastAlertTime) / 1000;
382	>	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
383	>	sendMessage(source, "I last sent an alert "+uptimeText+ " ago");
384		}
385	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.startCommand"))!=-1) {
386	<	_active = true;
414	<	sendMsg(getMsgSender(line)+", alerts have been activated");
385	>	else {
386	>	sendMessage(source, "I've never sent an alert!");
387		}
388	<	// this needs to go here if it contains the same words as the lastAlertCommand
389	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand"))!=-1) {
390	<	if(_lastAlertTime != -1) {
391	<	long uptime = (System.currentTimeMillis() - _lastAlertTime) / 1000;
392	<	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	<	}
388	>	}
389	>	else if(message.indexOf(lastAlertCommand) != -1) {
390	>	if(_lastAlertTime != -1) {
391	>	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, Locale.UK).format(new Date(_lastAlertTime));
392	>	sendMessage(source, "last alert was at "+date+"; "+_lastAlert);
393		}
394	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.lastAlertCommand"))!=-1) {
395	<	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	<
394	>	else {
395	>	sendMessage(source, "I've never sent an alert!");
396		}
397	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.joinCommand"))!=-1) {
398	<	String joinCmd = cp.getProperty(_name, "Alerter.IRC.joinCommand");
399	<	String newChan = message.substring(message.indexOf(joinCmd) + joinCmd.length() + 1);
400	<	int endOfChan = newChan.indexOf(" ");
401	<	if(endOfChan == -1) {
402	<	endOfChan = newChan.length();
403	<	}
404	<	newChan = newChan.substring(0, endOfChan);
405	<	sendMsg(getMsgSender(line)+", okay, I'm off to "+newChan);
406	<	_socketOut.println("PART "+_channel);
407	<	_socketOut.println("JOIN "+newChan);
397	>
398	>	}
399	>	else if(message.indexOf(joinCommand) != -1) {
400	>	String joinCmd = joinCommand;
401	>	String newChan = message.substring(message.indexOf(joinCmd) + joinCmd.length() + 1);
402	>	int endOfChan = newChan.indexOf(" ");
403	>	if(endOfChan == -1) {
404	>	endOfChan = newChan.length();
405	>	}
406	>	newChan = newChan.substring(0, endOfChan);
407	>	if(newChan.equals(_channel)) {
408	>	sendMessage(source, "I'm already on "+newChan+"!");
409	>	} else {
410	>	partChannel(_channel);
411	>	joinChannel(newChan);
412		_channel = newChan;
413	+	//return null; // ???
414		}
415	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.nickChangeCommand"))!=-1) {
416	<	String nickChangeCmd = cp.getProperty(_name, "Alerter.IRC.nickChangeCommand");
417	<	String newNick = message.substring(message.indexOf(nickChangeCmd) + nickChangeCmd.length() + 1);
418	<	int endOfNick = newNick.indexOf(" ");
419	<	if(endOfNick == -1) {
420	<	endOfNick = newNick.length();
421	<	}
457	<	newNick = newNick.substring(0, endOfNick);
458	<	sendMsg(getMsgSender(line)+", okay, changing my nickname to "+newNick);
459	<	_socketOut.println("NICK "+newNick);
460	<	_nickname = newNick;
415	>	}
416	>	else if(message.indexOf(nickChangeCommand) != -1) {
417	>	String nickChangeCmd = nickChangeCommand;
418	>	String newNick = message.substring(message.indexOf(nickChangeCmd) + nickChangeCmd.length() + 1);
419	>	int endOfNick = newNick.indexOf(" ");
420	>	if(endOfNick == -1) {
421	>	endOfNick = newNick.length();
422		}
423	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.versionCommand"))!=-1) {
424	<	sendMsg(getMsgSender(line)+", I am version "+REVISION.substring(11, REVISION.length() -2)+" of the i-scream alerting bot");
425	<	}
426	<	else if(message.indexOf(cp.getProperty(_name, "Alerter.IRC.helpCommand"))!=-1) {
427	<	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	<	}
423	>	newNick = newNick.substring(0, endOfNick);
424	>	changeNick(newNick);
425	>	// should we check this worked?
426	>	//_nickname = newNick;
427	>	//return null; // ???
428		}
429	<	else if(line.indexOf(_nickname)!=-1 && line.indexOf(_channel)!=-1 && line.indexOf("KICK")!=-1) {
430	<	sendPrivMsg(getMsgSender(line), "That wasn't a nice thing to do...");
496	<	_channel = cp.getProperty(_name, "Alerter.IRC.channel");
497	<	_socketOut.println("JOIN "+_channel);
429	>	else if(message.indexOf(versionCommand) != -1) {
430	>	sendMessage(source, "I am version "+REVISION.substring(11, REVISION.length() -2)+" of the i-scream alerting bot");
431		}
432	+	else if(message.indexOf(helpCommand) != -1) {
433	+	//System.out.println("--starting help");
434	+	sendMessage(source, "Hello, I am the i-scream alerting bot version "+REVISION.substring(11, REVISION.length() -2));
435	+	sendMessage(source, "I understand the following commands;");
436	+	sendMessage(source, stopCommand);
437	+	sendMessage(source, startCommand);
438	+	sendMessage(source, lastAlertCommand);
439	+	sendMessage(source, joinCommand);
440	+	sendMessage(source, nickChangeCommand);
441	+	sendMessage(source, statCommand);
442	+	sendMessage(source, uptimeCommand);
443	+	sendMessage(source, timeSinceLastAlertCommand);
444	+	sendMessage(source, helpCommand);
445	+	//System.out.println("--ending help");
446	+	}
447	+	else if(message.indexOf(statCommand) != -1) {
448	+	sendMessage(source, "I have sent a total of "+_alertCount+" alerts, and ignored a total of "+_ignoredCount+"!");
449	+	}
450	+	else if(message.indexOf(uptimeCommand) != -1) {
451	+	long uptime = (System.currentTimeMillis() - _startTime) / 1000;
452	+	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
453	+	sendMessage(source, "I have been running for "+uptimeText);
454	+	}
455	+	else if(message.indexOf("ping") != -1) {
456	+	sendMessage(source, "pong");
457	+	}
458	+	else if(message.indexOf("do a jibble dance") != -1) {
459	+	// little joke :)
460	+	sendAction(source, "jives to the funky beat shouting \"ii--screeeaaammm\"");
461	+	}
462	+
463	+	else {
464	+	String rejectMessage = NOT_CONFIGURED;
465	+	try {
466	+	rejectMessage = cp.getProperty(_name, "Alerter.IRC.rejectMessage");
467	+	} catch(PropertyNotFoundException e) {
468	+	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
469	+	}
470	+	sendMessage(source, rejectMessage);
471	+	}
472		}
473
474	<	/**
475	<	* Strips the header from a message line
476	<	*
477	<	* @param line the line to strip
478	<	* @return the message from the line
479	<	*/
480	<	private String getMsg(String line) {
481	<	String result = "";
509	<	if(line.indexOf("PRIVMSG")!=-1) {
510	<	int firstColon = line.indexOf(":");
511	<	if(firstColon != -1) {
512	<	int secondColon = line.indexOf(":", firstColon+1);
513	<	if(secondColon != -1) {
514	<	result = line.substring(secondColon+1);
515	<	}
516	<	}
474	>	private boolean isForMe(String message) {
475	>	// change this!
476	>	String nick = _nickname.toLowerCase();
477	>	String msg = message.toLowerCase();
478	>	if(msg.startsWith(nick + ", ") ||
479	>	msg.startsWith(nick + ": ") ||
480	>	msg.startsWith(nick + " ")) {
481	>	return true;
482		}
483	<	return result;
483	>	else {
484	>	return false;
485	>	}
486		}
487
488	<	/**
489	<	* Finds out the sender of the message
490	<	*
491	<	* @param line the line to look for a sender in
492	<	* @return the sender
493	<	*/
494	<	private String getMsgSender(String line) {
495	<	String result = "";
496	<	int colon = line.indexOf(":");
497	<	int excl = line.indexOf("!");
531	<	if(colon!=-1 && excl!=-1) {
532	<	result = line.substring(colon+1, excl);
488	>	private void reconnectSleep() {
489	>	int delayTime = 0;
490	>	try {
491	>	delayTime = Integer.parseInt(ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.reconnectDelay"));
492	>	} catch (NumberFormatException e) {
493	>	delayTime = DEFAULT_RECONNECT_DELAY;
494	>	_logger.write(this.toString(), Logger.WARNING, "Erronous Alerter.IRC.reconnectDelay value in configuration using default of " + delayTime + " seconds");
495	>	} catch (PropertyNotFoundException e) {
496	>	delayTime = DEFAULT_RECONNECT_DELAY;
497	>	_logger.write(this.toString(), Logger.WARNING, "Alerter.IRC.reconnectDelay value unavailable using default of " + delayTime + " seconds");
498		}
499	<	return result;
499	>	_logger.write(this.toString(), Logger.ERROR, "Waiting "+delayTime+" seconds for reconnect...");
500	>	try {
501	>	Thread.sleep(delayTime * 1000);
502	>	} catch (InterruptedException e) {}
503		}
504
505		/**
506	<	* The socket connected to the server
506	>	* Overrides the {@link java.lang.Object#toString() Object.toString()}
507	>	* method to provide clean logging (every class should have this).
508	>	*
509	>	* This uses the uk.org.iscream.cms.server.util.NameFormat class
510	>	* to format the toString()
511	>	*
512	>	* @return the name of this class and its CVS revision
513		*/
514	<	private Socket _socket;
515	<
516	<	/**
517	<	* The writer
518	<	*/
519	<	private PrintWriter _socketOut;
546	<
547	<	/**
548	<	* The reader
549	<	*/
550	<	private BufferedReader _socketIn;
514	>	public String toString() {
515	>	return FormatName.getName(
516	>	_name,
517	>	getClass().getName(),
518	>	REVISION);
519	>	}
520
521		/**
522		* Just a reminder to what channel we're on...

Diff Legend

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