4 using System.Collections;
5 using System.Net.Sockets;
7 namespace TechBot.IRCLibrary
10 /// Delegate that delivers an IRC message.
12 public delegate void MessageReceivedHandler(IrcMessage message);
15 /// Delegate that notifies if the user database for a channel has changed.
17 public delegate void ChannelUserDatabaseChangedHandler(IrcChannel channel);
19 public delegate void OnConnectHandler ();
20 public delegate void OnDisconnectHandler();
21 public delegate void OnConnectionLostHandler();
26 public class IrcClient
29 /// Monitor when an IRC command is received.
31 private class IrcCommandEventRegistration
34 /// IRC command to monitor.
36 private string command;
46 /// Handler to call when command is received.
48 private MessageReceivedHandler handler;
49 public MessageReceivedHandler Handler
60 /// <param name="command">IRC command to monitor.</param>
61 /// <param name="handler">Handler to call when command is received.</param>
62 public IrcCommandEventRegistration(string command,
63 MessageReceivedHandler handler)
65 this.command = command;
66 this.handler = handler;
73 /// A buffer to store lines of text.
75 private class LineBuffer
78 /// Full lines of text in buffer.
80 private ArrayList strings;
83 /// Part of the last line of text in buffer.
85 private string left = "";
88 /// Standard constructor.
92 strings = new ArrayList();
96 /// Return true if there is a complete line in the buffer or false if there is not.
98 public bool DataAvailable
102 return (strings.Count > 0);
107 /// Return next complete line in buffer or null if none exists.
109 /// <returns>Next complete line in buffer or null if none exists.</returns>
114 string line = strings[0] as string;
125 /// Write a string to buffer splitting it into lines.
127 /// <param name="data"></param>
128 public void Write(string data)
132 string[] sa = data.Split(new char[] { '\n' });
142 for (int i = 0; i < sa.Length; i++)
144 if (i < sa.Length - 1)
146 /* This is a complete line. Remove any \r characters at the end of the line. */
147 string line = sa[i].TrimEnd(new char[] { '\r', '\n'});
148 /* Silently ignore empty lines */
149 if (!line.Equals(String.Empty))
156 /* This may be a partial line. */
165 /// State for asynchronous reads.
167 private class StateObject
170 /// Network stream where data is read from.
172 public NetworkStream Stream;
175 /// Buffer where data is put.
177 public byte[] Buffer;
182 /// <param name="stream">Network stream where data is read from.</param>
183 /// <param name="buffer">Buffer where data is put.</param>
184 public StateObject(NetworkStream stream, byte[] buffer)
186 this.Stream = stream;
187 this.Buffer = buffer;
192 #region Private fields
193 private bool firstPingReceived = false;
194 private bool awaitingGhostDeath = false;
195 private System.Text.Encoding encoding = System.Text.Encoding.UTF8;
196 private TcpClient tcpClient;
197 private NetworkStream networkStream;
198 private bool connected = false;
199 private LineBuffer messageStream;
200 private ArrayList ircCommandEventRegistrations = new ArrayList();
201 private ArrayList channels = new ArrayList();
202 private string reqNickname;
203 private string curNickname;
204 private string password;
207 #region Public events
209 public event MessageReceivedHandler MessageReceived;
211 public event ChannelUserDatabaseChangedHandler ChannelUserDatabaseChanged;
213 public event OnConnectHandler OnConnect;
214 public event OnConnectionLostHandler OnConnectionLost;
215 public event OnDisconnectHandler OnDisconnect;
219 #region Public properties
224 public System.Text.Encoding Encoding
237 /// List of joined channels.
239 public ArrayList Channels
248 /// Nickname for the bot.
250 public string Nickname
259 #region Private methods
262 /// Signal MessageReceived event.
264 /// <param name="message">Message that was received.</param>
265 private void OnMessageReceived(IrcMessage message)
267 foreach (IrcCommandEventRegistration icre in ircCommandEventRegistrations)
269 if (message.Command.ToLower().Equals(icre.Command.ToLower()))
271 icre.Handler(message);
274 if (MessageReceived != null)
276 MessageReceived(message);
281 /// Signal ChannelUserDatabaseChanged event.
283 /// <param name="channel">Message that was received.</param>
284 private void OnChannelUserDatabaseChanged(IrcChannel channel)
286 if (ChannelUserDatabaseChanged != null)
288 ChannelUserDatabaseChanged(channel);
293 /// Start an asynchronous read.
295 private void Receive()
297 if ((networkStream != null) && (networkStream.CanRead))
299 byte[] buffer = new byte[1024];
300 networkStream.BeginRead(buffer, 0, buffer.Length,
301 new AsyncCallback(ReadComplete),
302 new StateObject(networkStream, buffer));
306 throw new Exception("Socket is closed.");
311 /// Asynchronous read has completed.
313 /// <param name="ar">IAsyncResult object.</param>
314 private void ReadComplete(IAsyncResult ar)
318 StateObject stateObject = (StateObject)ar.AsyncState;
319 if (stateObject.Stream.CanRead)
321 int bytesReceived = stateObject.Stream.EndRead(ar);
322 if (bytesReceived > 0)
324 messageStream.Write(Encoding.GetString(stateObject.Buffer, 0, bytesReceived));
325 while (messageStream.DataAvailable)
327 OnMessageReceived(new IrcMessage(messageStream.Read()));
334 catch (SocketException)
336 if (OnConnectionLost != null)
341 if (OnConnectionLost != null)
346 if (OnConnectionLost != null)
354 /// <param name="name">Channel name.</param>
355 /// <returns>Channel or null if none was found.</returns>
356 private IrcChannel LocateChannel(string name)
358 foreach (IrcChannel channel in Channels)
360 if (name.ToLower().Equals(channel.Name.ToLower()))
369 /// Send a PONG message when a PING message is received.
371 /// <param name="message">Received IRC message.</param>
372 private void PingMessageReceived(IrcMessage message)
374 SendMessage(new IrcMessage(IRC.PONG, message.Parameters));
375 firstPingReceived = true;
379 /// Send a PONG message when a PING message is received.
381 /// <param name="message">Received IRC message.</param>
382 private void NoticeMessageReceived(IrcMessage message)
384 if (awaitingGhostDeath)
386 string str = string.Format("
\ 2{0}
\ 2 has been ghosted", reqNickname);
387 if (message.Parameters.Contains(str))
389 ChangeNick(reqNickname);
390 SubmitPassword(password);
391 awaitingGhostDeath = false;
397 /// Process RPL_NAMREPLY message.
399 /// <param name="message">Received IRC message.</param>
400 private void RPL_NAMREPLYMessageReceived(IrcMessage message)
404 // :Oslo2.NO.EU.undernet.org 353 E101 = #E101 :E101 KongFu_uK @Exception
405 /* "( "=" / "*" / "@" ) <channel>
406 :[ "@" / "+" ] <nick> *( " " [ "@" / "+" ] <nick> )
407 - "@" is used for secret channels, "*" for private
408 channels, and "=" for others (public channels). */
409 if (message.Parameters == null)
411 System.Diagnostics.Debug.WriteLine(String.Format("Message has no parameters."));
414 string[] parameters = message.Parameters.Split(new char[] { ' '});
415 if (parameters.Length < 5)
417 System.Diagnostics.Debug.WriteLine(String.Format("{0} is two few parameters.", parameters.Length));
421 switch (parameters[1])
424 type = IrcChannelType.Public;
427 type = IrcChannelType.Private;
430 type = IrcChannelType.Secret;
433 type = IrcChannelType.Public;
436 IrcChannel channel = LocateChannel(parameters[2].Substring(1));
439 System.Diagnostics.Debug.WriteLine(String.Format("Channel not found '{0}'.",
440 parameters[2].Substring(1)));
443 string nickname = parameters[3];
444 if (nickname[0] != ':')
446 System.Diagnostics.Debug.WriteLine(String.Format("String should start with : and not {0}.", nickname[0]));
450 IrcUser user = channel.LocateUser(nickname.Substring(1));
453 user = new IrcUser(this,
454 nickname.Substring(1));
455 channel.Users.Add(user);
457 for (int i = 4; i < parameters.Length; i++)
459 nickname = parameters[i];
460 user = channel.LocateUser(nickname);
463 user = new IrcUser(this,
465 channel.Users.Add(user);
471 System.Diagnostics.Debug.WriteLine(String.Format("Ex. {0}", ex));
476 /// Process RPL_ENDOFNAMES message.
478 /// <param name="message">Received IRC message.</param>
479 private void RPL_ENDOFNAMESMessageReceived(IrcMessage message)
483 /* <channel> :End of NAMES list */
484 if (message.Parameters == null)
486 System.Diagnostics.Debug.WriteLine(String.Format("Message has no parameters."));
490 string[] parameters = message.Parameters.Split(new char[] { ' ' });
491 IrcChannel channel = LocateChannel(parameters[1].Substring(1));
494 System.Diagnostics.Debug.WriteLine(String.Format("Channel not found '{0}'.",
495 parameters[0].Substring(1)));
499 OnChannelUserDatabaseChanged(channel);
503 System.Diagnostics.Debug.WriteLine(String.Format("Ex. {0}", ex));
508 /// Process ERR_NICKNAMEINUSE message.
510 /// <param name="message">Received IRC message.</param>
511 private void ERR_NICKNAMEINUSEMessageReceived(IrcMessage message)
515 if (message.Parameters == null)
517 System.Diagnostics.Debug.WriteLine(String.Format("Message has no parameters."));
521 /* Connect with a different name */
522 string[] parameters = message.Parameters.Split(new char[] { ' ' });
523 string nickname = parameters[1];
524 ChangeNick(nickname + "__");
528 System.Diagnostics.Debug.WriteLine(String.Format("Ex. {0}", ex));
535 /// Connect to the specified IRC server on the specified port.
537 /// <param name="server">Address of IRC server.</param>
538 /// <param name="port">Port of IRC server.</param>
539 public void Connect(string server, int port)
543 throw new AlreadyConnectedException();
547 messageStream = new LineBuffer();
548 tcpClient = new TcpClient();
549 tcpClient.Connect(server, port);
550 tcpClient.NoDelay = true;
551 tcpClient.LingerState = new LingerOption(false, 0);
552 networkStream = tcpClient.GetStream();
553 connected = networkStream.CanRead && networkStream.CanWrite;
556 throw new Exception("Cannot read and write from socket.");
558 /* Install PING message handler */
559 MonitorCommand(IRC.PING, new MessageReceivedHandler(PingMessageReceived));
560 /* Install NOTICE message handler */
561 MonitorCommand(IRC.NOTICE, new MessageReceivedHandler(NoticeMessageReceived));
562 /* Install RPL_NAMREPLY message handler */
563 MonitorCommand(IRC.RPL_NAMREPLY, new MessageReceivedHandler(RPL_NAMREPLYMessageReceived));
564 /* Install RPL_ENDOFNAMES message handler */
565 MonitorCommand(IRC.RPL_ENDOFNAMES, new MessageReceivedHandler(RPL_ENDOFNAMESMessageReceived));
566 /* Install ERR_NICKNAMEINUSE message handler */
567 MonitorCommand(IRC.ERR_NICKNAMEINUSE, new MessageReceivedHandler(ERR_NICKNAMEINUSEMessageReceived));
568 /* Start receiving data */
574 /// Disconnect from IRC server.
576 public void Diconnect()
580 throw new NotConnectedException();
588 if (OnDisconnect != null)
594 /// Send an IRC message.
596 /// <param name="message">The message to be sent.</param>
597 public void SendMessage(IrcMessage message)
603 throw new NotConnectedException();
606 /* Serialize sending messages */
607 lock (typeof(IrcClient))
609 NetworkStream networkStream = tcpClient.GetStream();
610 byte[] bytes = Encoding.GetBytes(message.Line);
611 networkStream.Write(bytes, 0, bytes.Length);
612 networkStream.Flush();
615 catch (SocketException)
617 if (OnConnectionLost != null)
622 if (OnConnectionLost != null)
627 if (OnConnectionLost != null)
633 /// Monitor when a message with an IRC command is received.
635 /// <param name="command">IRC command to monitor.</param>
636 /// <param name="handler">Handler to call when command is received.</param>
637 public void MonitorCommand(string command, MessageReceivedHandler handler)
641 throw new ArgumentNullException("command", "Command cannot be null.");
645 throw new ArgumentNullException("handler", "Handler cannot be null.");
647 ircCommandEventRegistrations.Add(new IrcCommandEventRegistration(command, handler));
651 /// Talk to the channel.
653 /// <param name="nickname">Nickname of user to talk to.</param>
654 /// <param name="text">Text to send to the channel.</param>
655 public void TalkTo(string nickname, string text)
662 /// <param name="nickname">New nickname.</param>
663 public void ChangeNick(string nickname)
665 if (nickname == null)
666 throw new ArgumentNullException("nickname", "Nickname cannot be null.");
668 Console.WriteLine("Changing nick to {0}\n", nickname);
669 curNickname = nickname;
671 /* NICK <nickname> [ <hopcount> ] */
672 SendMessage(new IrcMessage(IRC.NICK, nickname));
678 /// <param name="nickname">Nickname.</param>
679 public void GhostNick(string nickname,
682 if (nickname == null)
683 throw new ArgumentNullException("nickname", "Nickname cannot be null.");
685 if (password == null)
686 throw new ArgumentNullException("password", "Password cannot be null.");
688 awaitingGhostDeath = true;
690 /* GHOST <nickname> <password> */
691 SendMessage(new IrcMessage(IRC.GHOST, nickname + " " + password));
695 /// Submit password to identify user.
697 /// <param name="password">Password of registered nick.</param>
698 private void SubmitPassword(string password)
700 if (password == null)
701 throw new ArgumentNullException("password", "Password cannot be null.");
703 this.password = password;
705 /* PASS <password> */
706 SendMessage(new IrcMessage(IRC.PASS, password));
712 /// <param name="nickname">New nickname.</param>
713 /// <param name="password">Password. Can be null.</param>
714 /// <param name="realname">Real name. Can be null.</param>
715 public void Register(string nickname,
719 if (nickname == null)
720 throw new ArgumentNullException("nickname", "Nickname cannot be null.");
721 reqNickname = nickname;
722 firstPingReceived = false;
723 if (password != null)
725 SubmitPassword(password);
727 ChangeNick(nickname);
728 /* OLD: USER <username> <hostname> <servername> <realname> */
729 /* NEW: USER <user> <mode> <unused> <realname> */
730 SendMessage(new IrcMessage(IRC.USER, String.Format("{0} 0 * :{1}",
731 nickname, realname != null ? realname : "Anonymous")));
733 /* Wait for PING for up til 10 seconds */
735 while (!firstPingReceived && timer < 200)
737 System.Threading.Thread.Sleep(50);
743 /// Join an IRC channel.
745 /// <param name="name">Name of channel (without leading #).</param>
746 /// <returns>New channel.</returns>
747 public IrcChannel JoinChannel(string name)
749 IrcChannel channel = new IrcChannel(this, name);
750 channels.Add(channel);
751 /* JOIN ( <channel> *( "," <channel> ) [ <key> *( "," <key> ) ] ) / "0" */
752 SendMessage(new IrcMessage(IRC.JOIN, String.Format("#{0}", name)));
757 /// Part an IRC channel.
759 /// <param name="channel">IRC channel. If null, the user parts from all channels.</param>
760 /// <param name="message">Part message. Can be null.</param>
761 public void PartChannel(IrcChannel channel, string message)
763 /* PART <channel> *( "," <channel> ) [ <Part Message> ] */
766 SendMessage(new IrcMessage(IRC.PART, String.Format("#{0}{1}",
767 channel.Name, message != null ? String.Format(" :{0}", message) : "")));
768 channels.Remove(channel);
772 string channelList = null;
773 foreach (IrcChannel myChannel in Channels)
775 if (channelList == null)
783 channelList += myChannel.Name;
785 if (channelList != null)
787 SendMessage(new IrcMessage(IRC.PART, String.Format("#{0}{1}",
788 channelList, message != null ? String.Format(" :{0}", message) : "")));