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.30 by tdb, Thu Jan 17 17:58:12 2002 UTC vs.
Revision 1.30.2.3 by tdb, Tue Feb 5 18:00:15 2002 UTC

#	Line 10 | Line 10 | import java.io.*;
10		import java.net.*;
11		import java.util.*;
12		import java.text.DateFormat;
13	+	import org.jibble.pircbot.*;
14
15		/**
16		* This Alert sends an IRC message.
#	Line 34 | Line 35 | public class IRC__Alerter extends AlerterSkeleton {
35		*/
36		public final String DESC = "Sends alerts on an IRC channel";
37
37	–	/**
38	–	* The default reconnect delay in seconds
39	–	*/
40	–	public final int DEFAULT_RECONNECT_DELAY = 30;
41	–
38		//---STATIC METHODS---
39
40		//---CONSTRUCTORS---
41	<
41	>
42		public IRC__Alerter() {
43		super();
44	<	// connect to the IRC server
44	>	// construct and initialise the bot
45		_ircbot = new IRCBot();
46	+	_ircbot.setVerbose(false);
47	+	Thread ircThread = new Thread(_ircbot);
48		// set it's name and start it
49	<	_ircbot.setName("client.IRC__Alerter$IRCBot");
50	<	_ircbot.start();
49	>	ircThread.setName("client.IRC__Alerter$IRCBot");
50	>	ircThread.start();
51	>	// log our start time
52		_startTime = System.currentTimeMillis();
53		_logger.write(toString(), Logger.SYSINIT, "IRC Alerter started");
54		}
#	Line 78 | Line 77 | public class IRC__Alerter extends AlerterSkeleton {
77		if(_active) {
78		// send the message
79		_logger.write(toString(), Logger.DEBUG, "Sending " + _name + " at "+ alertType + " level");
80	<	_ircbot.sendMsg(message);
80	>	_ircbot.sendMessage(message);
81		// count sent alerts
82		_alertCount++;
83		} else {
#	Line 169 | Line 168 | public class IRC__Alerter extends AlerterSkeleton {
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 183 | Line 188 | public class IRC__Alerter extends AlerterSkeleton {
188
189		//---INNER CLASSES---
190
191	<	/**
187	<	* This class provides some basic IRCBot functionality. It connects
188	<	* to a specified server, and will remain there until told to
189	<	* leave. Whilst connected it can send a message or a notice to
190	<	* the server.
191	<	*/
192	<	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
203	<	boolean run = true;
204	<	while(run) {
205	<	// flag so we can stop the loop
206	<	boolean doRead = true;
207	<	// get the startup notice
208	<	String startupNotice;
206	>	while(true) {
207		try {
208	<	startupNotice = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.startupNotice");
209	<	} catch (PropertyNotFoundException e) {
212	<	startupNotice = DEFAULT_STARTUP_NOTICE;
213	<	_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);
219	<	} catch(IOException e) {
220	<	doRead=false;
221	<	_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		}
223	–	while(doRead) {
224	–	try {
225	–	// read a command
226	–	String cmd = _socketIn.readLine();
227	–	// if we have a null, we've lost contact
228	–	if(cmd == null) {
229	–	throw new IOException("End of stream reached");
230	–	}
231	–	// let another method deal with the input
232	–	handleInput(cmd);
233	–	} catch (IOException e) {
234	–	// comms failure, maybe our link is dead.
235	–	_logger.write(this.toString(), Logger.ERROR, "Communication error: "+e);
236	–	// stop, and loop round for a reconnect.
237	–	doRead = false;
238	–	}
239	–	}
240	–	// make sure we're disconnected
241	–	try {
242	–	disconnect();
243	–	} catch (IOException e) {
244	–	_logger.write(this.toString(), Logger.ERROR, "Communication error: "+e);
245	–	}
246	–
247	–	// comms have failed, so wait a while and reconnect
248	–	int delayTime = 0;
249	–	try {
250	–	delayTime = Integer.parseInt(ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.reconnectDelay"));
251	–	} catch (NumberFormatException e) {
252	–	delayTime = DEFAULT_RECONNECT_DELAY;
253	–	_logger.write(this.toString(), Logger.WARNING, "Erronous Alerter.IRC.reconnectDelay value in configuration using default of " + delayTime + " seconds");
254	–	} catch (PropertyNotFoundException e) {
255	–	delayTime = DEFAULT_RECONNECT_DELAY;
256	–	_logger.write(this.toString(), Logger.WARNING, "Alerter.IRC.reconnectDelay value unavailable using default of " + delayTime + " seconds");
257	–	}
258	–	try {
259	–	Thread.sleep(delayTime * 1000);
260	–	} catch (InterruptedException e) {}
216		}
262	–	// maybe disconnect here ? - shutdown method not implemented yet
263	–	//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
275	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
276	<	}
277	<
278	<	/**
279	<	* Sends a message to the channel.
280	<	*
281	<	* @param user The user to send to
282	<	* @param msg The message to send
283	<	*/
284	<	public void sendPrivMsg(String user, String msg) {
285	<	_socketOut.println("PRIVMSG "+user+" :"+msg);
286	<	// wait a second before returning...
287	<	// this ensures messages can't be sent too fast
288	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
289	<	}
290	<
291	<	/**
292	<	* Sends an action to the channel.
293	<	*
294	<	* @param msg the action message
295	<	*/
296	<	public void sendAction(String msg) {
297	<	char esc = 001;
298	<	sendMsg(esc+"ACTION "+msg+esc);
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 a notice to the channel.
306	<	*
307	<	* @param msg The notice to send
308	<	*/
309	<	public void sendNotice(String msg) {
310	<	_socketOut.println("NOTICE "+_channel+" :"+msg);
311	<	// wait a second before returning...
312	<	// this ensures messages can't be sent too fast
313	<	try {Thread.sleep(1000);} catch (InterruptedException e) {}
314	<	}
315	<
316	<	/**
317	<	* Connect to the IRC server, log in, and join the channel.
318	<	*
319	<	* @throws IOException if the connection fails
320	<	*/
321	<	public void connect() throws IOException {
227	>	public 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 333 | Line 243 | public class IRC__Alerter extends AlerterSkeleton {
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);
339	<	//_socketOut.println("PASS");
340	<	// send USER details
341	<	String user, comment;
246	>
247	>	// get hold of the user details and nickname list
248	>	String user, comment, finger, nickList;
249		try {
250		user = cp.getProperty(_name, "Alerter.IRC.user");
251		comment = cp.getProperty(_name, "Alerter.IRC.comment");
252	<	} catch (PropertyNotFoundException e) {
346	<	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
347	<	throw new IOException("Can't get user details due to configuration error");
348	<	}
349	<	_socketOut.println("USER "+user+" 8 * :"+comment);
350	<	// attempt to get a nick
351	<	String nickList;
352	<	try {
252	>	finger = cp.getProperty(_name, "Alerter.IRC.finger");
253		nickList = cp.getProperty(_name, "Alerter.IRC.nickList");
254		} catch (PropertyNotFoundException e) {
255		_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
256	<	throw new IOException("Can't get nickname due to configuration error");
256	>	throw new IOException("Can't get user/nickname details due to configuration error");
257		}
258	+
259	+	// put these details into the bot
260	+	this.setLogin(user);
261	+	this.setVersion(comment);
262	+	this.setFinger(finger);
263	+
264	+	// attempt to connect, trying each nickname
265	+	// in turn until sucessfully connected
266		StringTokenizer st = new StringTokenizer(nickList, ";");
267		boolean ok = false;
360	–	// try until we exhaust our list
268		while(!ok && st.hasMoreTokens()) {
269		String nick = st.nextToken();
270	<	_socketOut.println("NICK "+nick);
271	<	// get a "yes" or "no" response back
272	<	String response = "";
273	<	do {
274	<	response = _socketIn.readLine();
275	<	if(response==null) {
369	<	throw new IOException("Communication error whilst logging in");
370	<	}
371	<	} while(response.indexOf("001")==-1 && response.indexOf("433")==-1);
372	<	// see if it was a yes
373	<	if(response.indexOf("001")!=-1) {
374	<	// great, we're logged in !
375	<	ok = true;
376	<	// store the name we're using
270	>	try {
271	>	// try to connect with a nickname
272	>	_logger.write(this.toString(), Logger.DEBUG, "Trying nick: "+nick);
273	>	this.setName(nick);
274	>	this.connect(server, port);
275	>	// at this point we know the nickname was accepted
276		_nickname = nick;
277	+	ok = true;
278		}
279	<	else {
280	<	// log we couldn't get the name
281	<	_logger.write(this.toString(), Logger.WARNING, "Nickname in use: "+nick);
279	>	catch(IOException e) {
280	>	_logger.write(this.toString(), Logger.ERROR, "IO error when connecting to server: "+e);
281	>	throw new IOException("IO error when connecting to server");
282		}
283	+	catch(IrcException e) {
284	+	_logger.write(this.toString(), Logger.ERROR, "IRC error when connecting to server: "+e);
285	+	throw new IOException("IRC error when connecting to server");
286	+	}
287	+	catch(NickAlreadyInUseException e) {
288	+	_logger.write(this.toString(), Logger.ERROR, "Nickname "+nick+" is already in use: "+e);
289	+	// don't do anything, instead just loop round
290	+	// and try the next nickname in the list
291	+	}
292		}
293		if(!ok) {
294	<	// oh dear, we couldn't get on.
295	<	throw new IOException("All nicknames in use");
294	>	// must have tried all the nicknames, best bail out
295	>	_logger.write(this.toString(), Logger.ERROR, "All nicknames already in use");
296	>	throw new IOException("All nicknames already in use");
297		}
298	<	// join the channel
298	>
299	>	// get hold of the channel details, and attempt
300	>	// to join the specified channel
301		try {
302		_channel = cp.getProperty(_name, "Alerter.IRC.channel");
303	+	this.joinChannel(_channel);
304		} catch (PropertyNotFoundException e) {
305		_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
306		throw new IOException("Can't get channel name due to configuration error");
307		}
308	<	_socketOut.println("JOIN "+_channel);
309	<	// allow alerts
308	>
309	>	// get hold of the startup notice, and send
310	>	// it if it's defined
311	>	String startupNotice;
312	>	try {
313	>	startupNotice = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.startupNotice");
314	>	sendNotice(_channel, startupNotice);
315	>	} catch (PropertyNotFoundException e) {
316	>	_logger.write(this.toString(), Logger.DEBUG, "Startup notice not defined, so not sending: "+e);
317	>	}
318	>
319	>	// at this point initialisation is complete, so
320	>	// we can return and set this flag to allow alerts
321		_active = true;
322		}
323
324		/**
325	<	* Disconnect "nicely" from the IRC server.
325	>	* Send a message to the current channel.
326		*
327	<	* @throws IOException if the disconnection fails
327	>	* @param message The message to send
328		*/
329	<	public void disconnect() throws IOException {
330	<	// stop alerts
329	>	public void sendMessage(String message) {
330	>	sendMessage(_channel, message);
331	>	}
332	>
333	>	/**
334	>	* If we get disconnected this method will be
335	>	* called, so we must take action. We'll simply
336	>	* keep trying to reinitialise, and thus
337	>	* reconnect to the server.
338	>	*/
339	>	public void onDisconnect() {
340	>	// stop alerts being sent for now
341		_active = false;
342	<	// send proper QUIT
343	<	_socketOut.println("QUIT : iscreamBot component shutting down...");
344	<	// close the socket
345	<	_socketOut.close();
346	<	_socketIn.close();
347	<	_socket.close();
342	>	while(true) {
343	>	// wait for a while, defined in the config
344	>	reconnectSleep();
345	>	try {
346	>	init();
347	>	break;
348	>	}
349	>	catch (IOException e) {
350	>	_logger.write(this.toString(), Logger.ERROR, "Error initialising IRCBot: "+e);
351	>	}
352	>	}
353		}
354
355		/**
356	<	* Overrides the {@link java.lang.Object#toString() Object.toString()}
357	<	* method to provide clean logging (every class should have this).
356	>	* If we receive a message this method will
357	>	* be called. We'll check if the message is
358	>	* for us, and call handleInput if it is.
359		*
360	<	* This uses the uk.org.iscream.cms.server.util.NameFormat class
361	<	* to format the toString()
360	>	* @param channel The channel the message came from
361	>	* @param sender The sender of the message
362	>	* @param login The login of the sender
363	>	* @param hostname The hostname of the sender
364	>	* @param message The message sent
365	>	*/
366	>	public void onMessage(String channel, String sender, String login, String hostname, String message) {
367	>	if(isForMe(message)) {
368	>	handleInput(message, channel);
369	>	}
370	>	}
371	>
372	>	/**
373	>	* If we receive a private message this method
374	>	* will be called. No need to check if it's for
375	>	* us -- it has to be if it's a private message.
376		*
377	<	* @return the name of this class and its CVS revision
377	>	* @param sender The sender of the message
378	>	* @param login The login of the sender
379	>	* @param hostname The hostname of the sender
380	>	* @param message The message sent
381		*/
382	<	public String toString() {
383	<	return FormatName.getName(
427	<	_name,
428	<	getClass().getName(),
429	<	REVISION);
382	>	public void onPrivateMessage(String sender, String login, String hostname, String message) {
383	>	handleInput(message, sender);
384		}
385
386		/**
387	<	* Deals with incoming lines from the server.
387	>	* If we receive a nick change message, this
388	>	* method gets called. We don't care about
389	>	* other users changing their nick, so we only
390	>	* take notice if our nick changes. If it does
391	>	* we need to change our internal nickname
392	>	* state.
393		*
394	<	* @param line the line to deal with
394	>	* @param oldNick the old nickname
395	>	* @param login the login of the nick changer
396	>	* @param hostname the hostname of the nick changer
397	>	* @param newNick the new nickname
398		*/
399	<	private void handleInput(String line) {
400	<	ConfigurationProxy cp = ConfigurationProxy.getInstance();
401	<	// if it's a PING...
440	<	if(line.startsWith("PING")) {
441	<	// ...send a PONG
442	<	_socketOut.println("PONG" + line.substring(4));
399	>	public void onNickChange(String oldNick, String login, String hostname, String newNick) {
400	>	if(oldNick.equals(_nickname)) {
401	>	_nickname = newNick;
402		}
403	<	// see if it's for us
404	<	else if(getMsg(line).toLowerCase().startsWith(_nickname.toLowerCase()+",") ||
405	<	getMsg(line).toLowerCase().startsWith(_nickname.toLowerCase()+":") ||
406	<	getMsg(line).toLowerCase().startsWith(_nickname.toLowerCase()+" ")) {
407	<	// setup some String's
408	<	String stopCommand, startCommand, timeSinceLastAlertCommand, lastAlertCommand, joinCommand;
409	<	String nickChangeCommand, versionCommand, helpCommand, statCommand, uptimeCommand;
410	<	// get the command set
403	>	}
404	>
405	>	/**
406	>	* If we receive a kick message this method
407	>	* gets called. We only take notice if it's
408	>	* us getting kicked, and then we'll rejoin
409	>	* the channel after a short wait.
410	>	*
411	>	* @param channel the channel the kick happened on
412	>	* @param kickerNick the person who performed the kick
413	>	* @param kickerLogin the login of the person who performed the kick
414	>	* @param kickerHostname the hostname of the person who performed the kick
415	>	* @param recipientNick the nickname of the person being kicked
416	>	* @param reason the reason for the kick
417	>	*/
418	>	public void onKick(String channel, String kickerNick, String kickerLogin, String kickerHostname, String recipientNick, String reason) {
419	>	if(recipientNick.equals(_nickname) && channel.equals(_channel)) {
420	>	// remind the person it's not very nice :)
421	>	sendMessage(kickerNick, "That wasn't a nice thing to do...");
422	>	// get hold of the channel details, in case they've changed
423		try {
424	<	stopCommand = cp.getProperty(_name, "Alerter.IRC.stopCommand");
425	<	startCommand = cp.getProperty(_name, "Alerter.IRC.startCommand");
426	<	timeSinceLastAlertCommand = cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand");
456	<	lastAlertCommand = cp.getProperty(_name, "Alerter.IRC.lastAlertCommand");
457	<	joinCommand = cp.getProperty(_name, "Alerter.IRC.joinCommand");
458	<	nickChangeCommand = cp.getProperty(_name, "Alerter.IRC.nickChangeCommand");
459	<	versionCommand = cp.getProperty(_name, "Alerter.IRC.versionCommand");
460	<	helpCommand = cp.getProperty(_name, "Alerter.IRC.helpCommand");
461	<	statCommand = cp.getProperty(_name, "Alerter.IRC.statCommand");
462	<	uptimeCommand = cp.getProperty(_name, "Alerter.IRC.uptimeCommand");
463	<	} catch (PropertyNotFoundException e) {
464	<	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
465	<	// lets bail from handling this line...
466	<	// ...it's gonna be hard without a command set!
467	<	return;
424	>	_channel = ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.channel");
425	>	} catch(PropertyNotFoundException e) {
426	>	_logger.write(this.toString(), Logger.ERROR, "Can't get channel name due to configuration error: "+e);
427		}
428	<
429	<	// we have a message for us
430	<	String message = getMsg(line).substring(_nickname.length());
431	<	if(message.indexOf(stopCommand)!=-1) {
432	<	_active = false;
433	<	sendMsg(getMsgSender(line)+", alerts have been stopped");
428	>	// wait for a while, defined in the config
429	>	reconnectSleep();
430	>	// we'll try and rejoin the channel regardless
431	>	// otherwise we might end up doing nothing!
432	>	joinChannel(_channel);
433	>	}
434	>	}
435	>
436	>	/**
437	>	* This method handles input directed to us, and
438	>	* responds accordingly if required.
439	>	*
440	>	* nb. matching user input is quite bad right now,
441	>	*     and should be improved one day.
442	>	*
443	>	* @param message the message from someone
444	>	* @param source where the message came from, so we know where to send the response
445	>	*/
446	>	private void handleInput(String message, String source) {
447	>	// get hold of the configuration system
448	>	ConfigurationProxy cp = ConfigurationProxy.getInstance();
449	>	// setup some String's
450	>	String stopCommand, startCommand, timeSinceLastAlertCommand, lastAlertCommand, joinCommand;
451	>	String nickChangeCommand, versionCommand, helpCommand, statCommand, uptimeCommand;
452	>	// get the command set from the configuration
453	>	try {
454	>	stopCommand = cp.getProperty(_name, "Alerter.IRC.stopCommand");
455	>	startCommand = cp.getProperty(_name, "Alerter.IRC.startCommand");
456	>	timeSinceLastAlertCommand = cp.getProperty(_name, "Alerter.IRC.timeSinceLastAlertCommand");
457	>	lastAlertCommand = cp.getProperty(_name, "Alerter.IRC.lastAlertCommand");
458	>	joinCommand = cp.getProperty(_name, "Alerter.IRC.joinCommand");
459	>	nickChangeCommand = cp.getProperty(_name, "Alerter.IRC.nickChangeCommand");
460	>	versionCommand = cp.getProperty(_name, "Alerter.IRC.versionCommand");
461	>	helpCommand = cp.getProperty(_name, "Alerter.IRC.helpCommand");
462	>	statCommand = cp.getProperty(_name, "Alerter.IRC.statCommand");
463	>	uptimeCommand = cp.getProperty(_name, "Alerter.IRC.uptimeCommand");
464	>	} catch (PropertyNotFoundException e) {
465	>	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
466	>	// lets bail from handling this line...
467	>	// ...it's gonna be hard without a command set!
468	>	return;
469	>	}
470	>
471	>	// see if the message matches (loosely!) any
472	>	// of our known commands
473	>	if(message.indexOf(stopCommand) != -1) {
474	>	_active = false;
475	>	sendMessage(source, "alerts have been stopped");
476	>	}
477	>	else if(message.indexOf(startCommand) != -1) {
478	>	_active = true;
479	>	sendMessage(source, "alerts have been activated");
480	>	}
481	>	// this needs to go before lastAlertCommand if it contains
482	>	// the same words as the lastAlertCommand.
483	>	else if(message.indexOf(timeSinceLastAlertCommand) != -1) {
484	>	if(_lastAlertTime != -1) {
485	>	long uptime = (System.currentTimeMillis() - _lastAlertTime) / 1000;
486	>	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
487	>	sendMessage(source, "I last sent an alert "+uptimeText+ " ago");
488		}
489	<	else if(message.indexOf(startCommand)!=-1) {
490	<	_active = true;
478	<	sendMsg(getMsgSender(line)+", alerts have been activated");
489	>	else {
490	>	sendMessage(source, "I've never sent an alert!");
491		}
492	<	// this needs to go here if it contains the same words as the lastAlertCommand
493	<	else if(message.indexOf(timeSinceLastAlertCommand)!=-1) {
494	<	if(_lastAlertTime != -1) {
495	<	long uptime = (System.currentTimeMillis() - _lastAlertTime) / 1000;
496	<	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
485	<	sendMsg(getMsgSender(line)+", I last sent an alert "+uptimeText+ " ago");
486	<	}
487	<	else {
488	<	sendMsg(getMsgSender(line)+", I've never sent an alert!");
489	<	}
492	>	}
493	>	else if(message.indexOf(lastAlertCommand) != -1) {
494	>	if(_lastAlertTime != -1) {
495	>	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, Locale.UK).format(new Date(_lastAlertTime));
496	>	sendMessage(source, "last alert was at "+date+"; "+_lastAlert);
497		}
498	<	else if(message.indexOf(lastAlertCommand)!=-1) {
499	<	if(_lastAlertTime != -1) {
493	<	String date = DateFormat.getDateTimeInstance(DateFormat.SHORT, DateFormat.SHORT, Locale.UK).format(new Date(_lastAlertTime));
494	<	sendMsg(getMsgSender(line)+", last alert was at "+date+"; "+_lastAlert);
495	<	}
496	<	else {
497	<	sendMsg(getMsgSender(line)+", I've never sent an alert!");
498	<	}
499	<
498	>	else {
499	>	sendMessage(source, "I've never sent an alert!");
500		}
501	<	else if(message.indexOf(joinCommand)!=-1) {
502	<	String joinCmd = joinCommand;
503	<	String newChan = message.substring(message.indexOf(joinCmd) + joinCmd.length() + 1);
504	<	int endOfChan = newChan.indexOf(" ");
505	<	if(endOfChan == -1) {
506	<	endOfChan = newChan.length();
507	<	}
508	<	newChan = newChan.substring(0, endOfChan);
509	<	if(newChan.equals(_channel)) {
510	<	sendMsg(getMsgSender(line)+", I'm already on "+newChan+"!");
511	<	} else {
512	<	sendMsg(getMsgSender(line)+", okay, I'm off to "+newChan);
513	<	_socketOut.println("PART "+_channel);
514	<	_socketOut.println("JOIN "+newChan);
515	<	_channel = newChan;
516	<	}
501	>
502	>	}
503	>	else if(message.indexOf(joinCommand) != -1) {
504	>	String joinCmd = joinCommand;
505	>	String newChan = message.substring(message.indexOf(joinCmd) + joinCmd.length() + 1);
506	>	int endOfChan = newChan.indexOf(" ");
507	>	if(endOfChan == -1) {
508	>	endOfChan = newChan.length();
509		}
510	<	else if(message.indexOf(nickChangeCommand)!=-1) {
511	<	String nickChangeCmd = nickChangeCommand;
512	<	String newNick = message.substring(message.indexOf(nickChangeCmd) + nickChangeCmd.length() + 1);
513	<	int endOfNick = newNick.indexOf(" ");
514	<	if(endOfNick == -1) {
515	<	endOfNick = newNick.length();
516	<	}
525	<	newNick = newNick.substring(0, endOfNick);
526	<	sendMsg(getMsgSender(line)+", okay, changing my nickname to "+newNick);
527	<	_socketOut.println("NICK "+newNick);
528	<	_nickname = newNick;
510	>	newChan = newChan.substring(0, endOfChan);
511	>	if(newChan.equals(_channel)) {
512	>	sendMessage(source, "I'm already on "+newChan+"!");
513	>	} else {
514	>	partChannel(_channel);
515	>	joinChannel(newChan);
516	>	_channel = newChan;
517		}
518	<	else if(message.indexOf(versionCommand)!=-1) {
519	<	sendMsg(getMsgSender(line)+", I am version "+REVISION.substring(11, REVISION.length() -2)+" of the i-scream alerting bot");
518	>	}
519	>	else if(message.indexOf(nickChangeCommand) != -1) {
520	>	String nickChangeCmd = nickChangeCommand;
521	>	String newNick = message.substring(message.indexOf(nickChangeCmd) + nickChangeCmd.length() + 1);
522	>	int endOfNick = newNick.indexOf(" ");
523	>	if(endOfNick == -1) {
524	>	endOfNick = newNick.length();
525		}
526	<	else if(message.indexOf(helpCommand)!=-1) {
527	<	sendPrivMsg(getMsgSender(line), "Hello, I am the i-scream alerting bot version "+REVISION.substring(11, REVISION.length() -2));
535	<	sendPrivMsg(getMsgSender(line), "I understand the following commands;");
536	<	sendPrivMsg(getMsgSender(line), stopCommand);
537	<	sendPrivMsg(getMsgSender(line), startCommand);
538	<	sendPrivMsg(getMsgSender(line), lastAlertCommand);
539	<	sendPrivMsg(getMsgSender(line), joinCommand);
540	<	sendPrivMsg(getMsgSender(line), nickChangeCommand);
541	<	sendPrivMsg(getMsgSender(line), statCommand);
542	<	sendPrivMsg(getMsgSender(line), uptimeCommand);
543	<	sendPrivMsg(getMsgSender(line), timeSinceLastAlertCommand);
544	<	sendPrivMsg(getMsgSender(line), helpCommand);
545	<	}
546	<	else if(message.indexOf(statCommand)!=-1) {
547	<	sendMsg(getMsgSender(line)+", I have sent a total of "+_alertCount+" alerts, and ignored a total of "+_ignoredCount+"!");
548	<	}
549	<	else if(message.indexOf(uptimeCommand)!=-1) {
550	<	long uptime = (System.currentTimeMillis() - _startTime) / 1000;
551	<	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
552	<	sendMsg(getMsgSender(line)+", I have been running for "+uptimeText);
553	<	}
554	<	else if(message.indexOf("ping")!=-1) {
555	<	sendMsg("pong");
556	<	}
557	<	else if(message.indexOf("do a jibble dance")!=-1) {
558	<	// little joke :)
559	<	sendAction("jives to the funky beat shouting \"ii--screeeaaammm\"");
560	<	}
561	<	else {
562	<	String rejectMessage = NOT_CONFIGURED;
563	<	try {
564	<	rejectMessage = cp.getProperty(_name, "Alerter.IRC.rejectMessage");
565	<	} catch(PropertyNotFoundException e) {
566	<	_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
567	<	}
568	<	sendMsg(getMsgSender(line)+", "+rejectMessage);
569	<	}
526	>	newNick = newNick.substring(0, endOfNick);
527	>	changeNick(newNick);
528		}
529	<	else if(line.indexOf(_nickname)!=-1 && line.indexOf(_channel)!=-1 && line.indexOf("KICK")!=-1) {
530	<	sendPrivMsg(getMsgSender(line), "That wasn't a nice thing to do...");
529	>	else if(message.indexOf(versionCommand) != -1) {
530	>	sendMessage(source, "I am version "+REVISION.substring(11, REVISION.length() -2)+" of the i-scream alerting bot");
531	>	}
532	>	else if(message.indexOf(helpCommand) != -1) {
533	>	sendMessage(source, "Hello, I am the i-scream alerting bot version "+REVISION.substring(11, REVISION.length() -2));
534	>	sendMessage(source, "I understand the following commands;");
535	>	sendMessage(source, stopCommand);
536	>	sendMessage(source, startCommand);
537	>	sendMessage(source, lastAlertCommand);
538	>	sendMessage(source, joinCommand);
539	>	sendMessage(source, nickChangeCommand);
540	>	sendMessage(source, statCommand);
541	>	sendMessage(source, uptimeCommand);
542	>	sendMessage(source, timeSinceLastAlertCommand);
543	>	sendMessage(source, helpCommand);
544	>	}
545	>	else if(message.indexOf(statCommand) != -1) {
546	>	sendMessage(source, "I have sent a total of "+_alertCount+" alerts, and ignored a total of "+_ignoredCount+"!");
547	>	}
548	>	else if(message.indexOf(uptimeCommand) != -1) {
549	>	long uptime = (System.currentTimeMillis() - _startTime) / 1000;
550	>	String uptimeText = DateUtils.formatTime(uptime, "%DAYS% days, %HOURS% hours, %MINS% mins, and %SECS% secs");
551	>	sendMessage(source, "I have been running for "+uptimeText);
552	>	}
553	>	else if(message.indexOf("ping") != -1) {
554	>	sendMessage(source, "pong");
555	>	}
556	>	else if(message.indexOf("do a jibble dance") != -1) {
557	>	// little joke :)
558	>	sendAction(source, "jives to the funky beat shouting \"ii--screeeaaammm\"");
559	>	}
560	>	else {
561	>	String rejectMessage = NOT_CONFIGURED;
562		try {
563	<	_channel = cp.getProperty(_name, "Alerter.IRC.channel");
563	>	rejectMessage = cp.getProperty(_name, "Alerter.IRC.rejectMessage");
564		} catch(PropertyNotFoundException e) {
565		_logger.write(this.toString(), Logger.ERROR, "Configuration error: "+e);
566		}
567	<	_socketOut.println("JOIN "+_channel);
567	>	sendMessage(source, rejectMessage);
568		}
569		}
570
571		/**
572	<	* Strips the header from a message line
572	>	* Quick method to check if the message appears
573	>	* to be directed at us. We simply check to see
574	>	* if it starts with our nick in some fashion.
575		*
576	<	* @param line the line to strip
577	<	* @return the message from the line
576	>	* @param message the message to check
577	>	* @return if the message is for us
578		*/
579	<	private String getMsg(String line) {
580	<	String result = "";
581	<	if(line.indexOf("PRIVMSG")!=-1) {
582	<	int firstColon = line.indexOf(":");
583	<	if(firstColon != -1) {
584	<	int secondColon = line.indexOf(":", firstColon+1);
585	<	if(secondColon != -1) {
595	<	result = line.substring(secondColon+1);
596	<	}
597	<	}
579	>	private boolean isForMe(String message) {
580	>	String nick = _nickname.toLowerCase();
581	>	String msg = message.toLowerCase();
582	>	if(msg.startsWith(nick + ", ") ||
583	>	msg.startsWith(nick + ": ") ||
584	>	msg.startsWith(nick + " ")) {
585	>	return true;
586		}
587	<	return result;
587	>	else {
588	>	return false;
589	>	}
590		}
591
592		/**
593	<	* Finds out the sender of the message
594	<	*
595	<	* @param line the line to look for a sender in
606	<	* @return the sender
593	>	* Sleep for a configurable amount of time and
594	>	* then return. This is used when reconnecting
595	>	* to the server or a channel.
596		*/
597	<	private String getMsgSender(String line) {
598	<	String result = "";
599	<	int colon = line.indexOf(":");
600	<	int excl = line.indexOf("!");
601	<	if(colon!=-1 && excl!=-1) {
602	<	result = line.substring(colon+1, excl);
597	>	private void reconnectSleep() {
598	>	int delayTime = 0;
599	>	try {
600	>	delayTime = Integer.parseInt(ConfigurationProxy.getInstance().getProperty(_name, "Alerter.IRC.reconnectDelay"));
601	>	} catch (NumberFormatException e) {
602	>	delayTime = DEFAULT_RECONNECT_DELAY;
603	>	_logger.write(this.toString(), Logger.WARNING, "Erronous Alerter.IRC.reconnectDelay value in configuration using default of " + delayTime + " seconds");
604	>	} catch (PropertyNotFoundException e) {
605	>	delayTime = DEFAULT_RECONNECT_DELAY;
606	>	_logger.write(this.toString(), Logger.WARNING, "Alerter.IRC.reconnectDelay value unavailable using default of " + delayTime + " seconds");
607		}
608	<	return result;
608	>	_logger.write(this.toString(), Logger.ERROR, "Waiting "+delayTime+" seconds for reconnect...");
609	>	try {
610	>	Thread.sleep(delayTime * 1000);
611	>	} catch (InterruptedException e) {}
612		}
613
614		/**
615	<	* The socket connected to the server
615	>	* Overrides the {@link java.lang.Object#toString() Object.toString()}
616	>	* method to provide clean logging (every class should have this).
617	>	*
618	>	* This uses the uk.org.iscream.cms.server.util.NameFormat class
619	>	* to format the toString()
620	>	*
621	>	* @return the name of this class and its CVS revision
622		*/
623	<	private Socket _socket;
623	>	public String toString() {
624	>	return FormatName.getName(
625	>	_name,
626	>	getClass().getName(),
627	>	REVISION);
628	>	}
629
630		/**
624	–	* The writer
625	–	*/
626	–	private PrintWriter _socketOut;
627	–
628	–	/**
629	–	* The reader
630	–	*/
631	–	private BufferedReader _socketIn;
632	–
633	–	/**
631		* Just a reminder to what channel we're on...
632		* this can't be dynamic :)
633		*/
#	Line 640 | Line 637 | public class IRC__Alerter extends AlerterSkeleton {
637		* A reminder of our current nickname...
638		*/
639		private String _nickname;
643	–
644	–	/**
645	–	* This holds a reference to the
646	–	* system logger that is being used.
647	–	*/
648	–	protected Logger _logger = ReferenceManager.getInstance().getLogger();
640
641		}
642

Diff Legend

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