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 System.Text.Encoding encoding = System.Text.Encoding.UTF8;
195 private TcpClient tcpClient;
196 private NetworkStream networkStream;
197 private bool connected = false;
198 private LineBuffer messageStream;
199 private ArrayList ircCommandEventRegistrations = new ArrayList();
200 private ArrayList channels = new ArrayList();
203 #region Public events
205 public event MessageReceivedHandler MessageReceived;
207 public event ChannelUserDatabaseChangedHandler ChannelUserDatabaseChanged;
209 public event OnConnectHandler OnConnect;
210 public event OnConnectionLostHandler OnConnectionLost;
211 public event OnDisconnectHandler OnDisconnect;
215 #region Public properties
220 public System.Text.Encoding Encoding
233 /// List of joined channels.
235 public ArrayList Channels
245 #region Private methods
248 /// Signal MessageReceived event.
250 /// <param name="message">Message that was received.</param>
251 private void OnMessageReceived(IrcMessage message)
253 foreach (IrcCommandEventRegistration icre in ircCommandEventRegistrations)
255 if (message.Command.ToLower().Equals(icre.Command.ToLower()))
257 icre.Handler(message);
260 if (MessageReceived != null)
262 MessageReceived(message);
267 /// Signal ChannelUserDatabaseChanged event.
269 /// <param name="channel">Message that was received.</param>
270 private void OnChannelUserDatabaseChanged(IrcChannel channel)
272 if (ChannelUserDatabaseChanged != null)
274 ChannelUserDatabaseChanged(channel);
279 /// Start an asynchronous read.
281 private void Receive()
283 if ((networkStream != null) && (networkStream.CanRead))
285 byte[] buffer = new byte[1024];
286 networkStream.BeginRead(buffer, 0, buffer.Length,
287 new AsyncCallback(ReadComplete),
288 new StateObject(networkStream, buffer));
292 throw new Exception("Socket is closed.");
297 /// Asynchronous read has completed.
299 /// <param name="ar">IAsyncResult object.</param>
300 private void ReadComplete(IAsyncResult ar)
304 StateObject stateObject = (StateObject)ar.AsyncState;
305 if (stateObject.Stream.CanRead)
307 int bytesReceived = stateObject.Stream.EndRead(ar);
308 if (bytesReceived > 0)
310 messageStream.Write(Encoding.GetString(stateObject.Buffer, 0, bytesReceived));
311 while (messageStream.DataAvailable)
313 OnMessageReceived(new IrcMessage(messageStream.Read()));
320 catch (SocketException)
322 if (OnConnectionLost != null)
327 if (OnConnectionLost != null)
332 if (OnConnectionLost != null)
340 /// <param name="name">Channel name.</param>
341 /// <returns>Channel or null if none was found.</returns>
342 private IrcChannel LocateChannel(string name)
344 foreach (IrcChannel channel in Channels)
346 if (name.ToLower().Equals(channel.Name.ToLower()))
355 /// Send a PONG message when a PING message is received.
357 /// <param name="message">Received IRC message.</param>
358 private void PingMessageReceived(IrcMessage message)
360 SendMessage(new IrcMessage(IRC.PONG, message.Parameters));
361 firstPingReceived = true;
365 /// Process RPL_NAMREPLY message.
367 /// <param name="message">Received IRC message.</param>
368 private void RPL_NAMREPLYMessageReceived(IrcMessage message)
372 // :Oslo2.NO.EU.undernet.org 353 E101 = #E101 :E101 KongFu_uK @Exception
373 /* "( "=" / "*" / "@" ) <channel>
374 :[ "@" / "+" ] <nick> *( " " [ "@" / "+" ] <nick> )
375 - "@" is used for secret channels, "*" for private
376 channels, and "=" for others (public channels). */
377 if (message.Parameters == null)
379 System.Diagnostics.Debug.WriteLine(String.Format("Message has no parameters."));
382 string[] parameters = message.Parameters.Split(new char[] { ' '});
383 if (parameters.Length < 5)
385 System.Diagnostics.Debug.WriteLine(String.Format("{0} is two few parameters.", parameters.Length));
389 switch (parameters[1])
392 type = IrcChannelType.Public;
395 type = IrcChannelType.Private;
398 type = IrcChannelType.Secret;
401 type = IrcChannelType.Public;
404 IrcChannel channel = LocateChannel(parameters[2].Substring(1));
407 System.Diagnostics.Debug.WriteLine(String.Format("Channel not found '{0}'.",
408 parameters[2].Substring(1)));
411 string nickname = parameters[3];
412 if (nickname[0] != ':')
414 System.Diagnostics.Debug.WriteLine(String.Format("String should start with : and not {0}.", nickname[0]));
418 IrcUser user = channel.LocateUser(nickname.Substring(1));
421 user = new IrcUser(this,
422 nickname.Substring(1));
423 channel.Users.Add(user);
425 for (int i = 4; i < parameters.Length; i++)
427 nickname = parameters[i];
428 user = channel.LocateUser(nickname);
431 user = new IrcUser(this,
433 channel.Users.Add(user);
439 System.Diagnostics.Debug.WriteLine(String.Format("Ex. {0}", ex));
444 /// Process RPL_ENDOFNAMES message.
446 /// <param name="message">Received IRC message.</param>
447 private void RPL_ENDOFNAMESMessageReceived(IrcMessage message)
451 /* <channel> :End of NAMES list */
452 if (message.Parameters == null)
454 System.Diagnostics.Debug.WriteLine(String.Format("Message has no parameters."));
458 string[] parameters = message.Parameters.Split(new char[] { ' ' });
459 IrcChannel channel = LocateChannel(parameters[1].Substring(1));
462 System.Diagnostics.Debug.WriteLine(String.Format("Channel not found '{0}'.",
463 parameters[0].Substring(1)));
467 OnChannelUserDatabaseChanged(channel);
471 System.Diagnostics.Debug.WriteLine(String.Format("Ex. {0}", ex));
478 /// Connect to the specified IRC server on the specified port.
480 /// <param name="server">Address of IRC server.</param>
481 /// <param name="port">Port of IRC server.</param>
482 public void Connect(string server, int port)
486 throw new AlreadyConnectedException();
490 messageStream = new LineBuffer();
491 tcpClient = new TcpClient();
492 tcpClient.Connect(server, port);
493 tcpClient.NoDelay = true;
494 tcpClient.LingerState = new LingerOption(false, 0);
495 networkStream = tcpClient.GetStream();
496 connected = networkStream.CanRead && networkStream.CanWrite;
499 throw new Exception("Cannot read and write from socket.");
501 /* Install PING message handler */
502 MonitorCommand(IRC.PING, new MessageReceivedHandler(PingMessageReceived));
503 /* Install RPL_NAMREPLY message handler */
504 MonitorCommand(IRC.RPL_NAMREPLY, new MessageReceivedHandler(RPL_NAMREPLYMessageReceived));
505 /* Install RPL_ENDOFNAMES message handler */
506 MonitorCommand(IRC.RPL_ENDOFNAMES, new MessageReceivedHandler(RPL_ENDOFNAMESMessageReceived));
507 /* Start receiving data */
513 /// Disconnect from IRC server.
515 public void Diconnect()
519 throw new NotConnectedException();
529 if (OnDisconnect != null)
535 /// Send an IRC message.
537 /// <param name="message">The message to be sent.</param>
538 public void SendMessage(IrcMessage message)
544 throw new NotConnectedException();
547 /* Serialize sending messages */
548 lock (typeof(IrcClient))
550 NetworkStream networkStream = tcpClient.GetStream();
551 byte[] bytes = Encoding.GetBytes(message.Line);
552 networkStream.Write(bytes, 0, bytes.Length);
553 networkStream.Flush();
556 catch (SocketException)
558 if (OnConnectionLost != null)
563 if (OnConnectionLost != null)
568 if (OnConnectionLost != null)
574 /// Monitor when a message with an IRC command is received.
576 /// <param name="command">IRC command to monitor.</param>
577 /// <param name="handler">Handler to call when command is received.</param>
578 public void MonitorCommand(string command, MessageReceivedHandler handler)
582 throw new ArgumentNullException("command", "Command cannot be null.");
586 throw new ArgumentNullException("handler", "Handler cannot be null.");
588 ircCommandEventRegistrations.Add(new IrcCommandEventRegistration(command, handler));
592 /// Talk to the channel.
594 /// <param name="nickname">Nickname of user to talk to.</param>
595 /// <param name="text">Text to send to the channel.</param>
596 public void TalkTo(string nickname, string text)
603 /// <param name="nickname">New nickname.</param>
604 public void ChangeNick(string nickname)
606 if (nickname == null)
607 throw new ArgumentNullException("nickname", "Nickname cannot be null.");
609 /* NICK <nickname> [ <hopcount> ] */
610 SendMessage(new IrcMessage(IRC.NICK, nickname));
614 /// Submit password to identify user.
616 /// <param name="password">Password of registered nick.</param>
617 private void SubmitPassword(string password)
619 if (password == null)
620 throw new ArgumentNullException("password", "Password cannot be null.");
622 /* PASS <password> */
623 SendMessage(new IrcMessage(IRC.PASS, password));
629 /// <param name="nickname">New nickname.</param>
630 /// <param name="password">Password. Can be null.</param>
631 /// <param name="realname">Real name. Can be null.</param>
632 public void Register(string nickname,
636 if (nickname == null)
637 throw new ArgumentNullException("nickname", "Nickname cannot be null.");
638 firstPingReceived = false;
639 if (password != null)
640 SubmitPassword(password);
641 ChangeNick(nickname);
642 /* Before we send our nickname, just ghost it */
643 SendMessage(new IrcMessage(IRC.GHOST, nickname));
644 /* OLD: USER <username> <hostname> <servername> <realname> */
645 /* NEW: USER <user> <mode> <unused> <realname> */
646 SendMessage(new IrcMessage(IRC.USER, String.Format("{0} 0 * :{1}",
647 nickname, realname != null ? realname : "Anonymous")));
649 /* Wait for PING for up til 10 seconds */
651 while (!firstPingReceived && timer < 200)
653 System.Threading.Thread.Sleep(50);
659 /// Join an IRC channel.
661 /// <param name="name">Name of channel (without leading #).</param>
662 /// <returns>New channel.</returns>
663 public IrcChannel JoinChannel(string name)
665 IrcChannel channel = new IrcChannel(this, name);
666 channels.Add(channel);
667 /* JOIN ( <channel> *( "," <channel> ) [ <key> *( "," <key> ) ] ) / "0" */
668 SendMessage(new IrcMessage(IRC.JOIN, String.Format("#{0}", name)));
673 /// Part an IRC channel.
675 /// <param name="channel">IRC channel. If null, the user parts from all channels.</param>
676 /// <param name="message">Part message. Can be null.</param>
677 public void PartChannel(IrcChannel channel, string message)
679 /* PART <channel> *( "," <channel> ) [ <Part Message> ] */
682 SendMessage(new IrcMessage(IRC.PART, String.Format("#{0}{1}",
683 channel.Name, message != null ? String.Format(" :{0}", message) : "")));
684 channels.Remove(channel);
688 string channelList = null;
689 foreach (IrcChannel myChannel in Channels)
691 if (channelList == null)
699 channelList += myChannel.Name;
701 if (channelList != null)
703 SendMessage(new IrcMessage(IRC.PART, String.Format("#{0}{1}",
704 channelList, message != null ? String.Format(" :{0}", message) : "")));