aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/OpenSim/Region/OptionalModules/Avatar/Chat/IRCConnector.cs
blob: 5123ef56a8c9264e074b5d470d7f206baac4368d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSim Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Timers;
using System.Collections.Generic;
using System.IO;
using System.Net.Sockets;
using System.Reflection;
using System.Text.RegularExpressions;
using System.Threading;
using OpenMetaverse;
using log4net;
using Nini.Config;
using OpenSim.Framework;
using OpenSim.Region.Framework.Interfaces;
using OpenSim.Region.Framework.Scenes;

namespace OpenSim.Region.OptionalModules.Avatar.Chat
{
    public class IRCConnector
    {

        #region Global (static) state

        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

        // Local constants
 
        private static readonly Vector3 CenterOfRegion = new Vector3(128, 128, 20);
        private static readonly char[]  CS_SPACE = { ' ' };

        private const  int  WD_INTERVAL = 1000;     // base watchdog interval
        private static int  PING_PERIOD = 15;       // WD intervals per PING
        private static int  ICCD_PERIOD = 10;       // WD intervals between Connects
        private static int  L_TIMEOUT   = 25;       // Login time out interval

        private static int _idk_        = 0;        // core connector identifier
        private static int _pdk_        = 0;        // ping interval counter
        private static int _icc_        = 0;        // IRC connect counter

        // List of configured connectors

        private static List<IRCConnector> m_connectors = new List<IRCConnector>();

        // Watchdog state

        private static System.Timers.Timer m_watchdog = null;

        static IRCConnector()
        {
            m_log.DebugFormat("[IRC-Connector]: Static initialization started");
            m_watchdog = new System.Timers.Timer(WD_INTERVAL);
            m_watchdog.Elapsed += new ElapsedEventHandler(WatchdogHandler);
            m_watchdog.AutoReset = true;
            m_watchdog.Start();
            m_log.DebugFormat("[IRC-Connector]: Static initialization complete");
        }

        #endregion

        #region Instance state

        // Connector identity

        internal int idn = _idk_++;

        // How many regions depend upon this connection
        // This count is updated by the ChannelState object and reflects the sum
        // of the region clients associated with the set of associated channel 
        // state instances. That's why it cannot be managed here.

        internal int depends = 0;

        // Working threads

        private Thread m_listener = null;

        private Object msyncConnect = new Object();

        internal bool   m_randomizeNick = true; // add random suffix
        internal string m_baseNick = null;      // base name for randomizing
        internal string m_nick = null;          // effective nickname

        public string Nick                        // Public property
        {
            get { return m_nick; }
            set { m_nick = value; }
        }
        
        private bool m_enabled = false;            // connector enablement
        public bool Enabled
        {
            get { return m_enabled; }
        }

        private bool m_connected = false;        // connection status
        private bool m_pending   = false;        // login disposition
        private int  m_timeout   = L_TIMEOUT;    // login timeout counter
        public bool Connected
        {
            get { return m_connected; }
        }

        private string m_ircChannel;            // associated channel id
        public string IrcChannel
        {
            get { return m_ircChannel; }
            set { m_ircChannel = value; }
        }
        
        private uint m_port = 6667;                // session port
        public uint Port 
        {
            get { return m_port; }
            set { m_port = value; }
        }

        private string m_server = null;            // IRC server name
        public string Server
        {
            get { return m_server; }
            set { m_server = value; }
        }
        private string m_password = null;
        public string Password
        {
            get { return m_password; }
            set { m_password = value; }
        }

        private string m_user = "USER OpenSimBot 8 * :I'm an OpenSim to IRC bot";
        public string User
        {
            get { return m_user; }
        }

        // Network interface

        private TcpClient     m_tcp;
        private NetworkStream m_stream = null;
        private StreamReader  m_reader;
        private StreamWriter  m_writer;

        // Channel characteristic info (if available)

        internal string usermod = String.Empty;
        internal string chanmod = String.Empty;
        internal string version = String.Empty;
        internal bool motd = false;

        #endregion

        #region connector instance management

        internal IRCConnector(ChannelState cs)
        {

            // Prepare network interface

            m_tcp    = null;
            m_writer = null;
            m_reader = null;

            // Setup IRC session parameters

            m_server        = cs.Server;
            m_password      = cs.Password;
            m_baseNick      = cs.BaseNickname;
            m_randomizeNick = cs.RandomizeNickname;
            m_ircChannel    = cs.IrcChannel;
            m_port          = cs.Port;
            m_user          = cs.User;

            if (m_watchdog == null)
            {
                // Non-differentiating

                ICCD_PERIOD     = cs.ConnectDelay;
                PING_PERIOD     = cs.PingDelay;

                // Smaller values are not reasonable

                if (ICCD_PERIOD < 5)
                    ICCD_PERIOD = 5;

                if (PING_PERIOD < 5)
                    PING_PERIOD = 5;

                _icc_ = ICCD_PERIOD;    // get started right away!

            }

            // The last line of defense

            if (m_server == null || m_baseNick == null || m_ircChannel == null || m_user == null)
                throw new Exception("Invalid connector configuration");

            // Generate an initial nickname if randomizing is enabled

            if (m_randomizeNick)
            {
                m_nick = m_baseNick + Util.RandomClass.Next(1, 99);
            }

            // Add the newly created connector to the known connectors list

            m_connectors.Add(this);

            m_log.InfoFormat("[IRC-Connector-{0}]: Initialization complete", idn);

        }

        ~IRCConnector()
        {
            m_watchdog.Stop();
            Close();
        }

        // Mark the connector as connectable. Harmless if already enabled.

        public void Open()
        {
            if (!m_enabled)
            {

                m_connectors.Add(this);
                m_enabled = true;

                if (!Connected)
                {
                    Connect();
                }

            }
        }

        // Only close the connector if the dependency count is zero.

        public void Close()
        {

            m_log.InfoFormat("[IRC-Connector-{0}] Closing", idn);

            lock (msyncConnect)
            {

                if ((depends == 0) && Enabled)
                {

                    m_enabled = false;

                    if (Connected)
                    {
                        m_log.DebugFormat("[IRC-Connector-{0}] Closing interface", idn);

                        // Cleanup the IRC session

                        try
                        {
                            m_writer.WriteLine(String.Format("QUIT :{0} to {1} wormhole to {2} closing",
                                m_nick, m_ircChannel, m_server));
                            m_writer.Flush();
                        }
                        catch (Exception) {}
       

                        m_connected = false;

                        try { m_writer.Close(); } catch (Exception) {}
                        try { m_reader.Close(); } catch (Exception) {}
                        try { m_stream.Close(); } catch (Exception) {}
                        try { m_tcp.Close();    } catch (Exception) {}

                    }
       
                    m_connectors.Remove(this);

                }
            }

            m_log.InfoFormat("[IRC-Connector-{0}] Closed", idn);

        }

        #endregion

        #region session management

        // Connect to the IRC server. A connector should always be connected, once enabled

        public void Connect()
        {

            if (!m_enabled)
                return;

            // Delay until next WD cycle if this is too close to the last start attempt

            while (_icc_ < ICCD_PERIOD)
                return;

            m_log.DebugFormat("[IRC-Connector-{0}]: Connection request for {1} on {2}:{3}", idn, m_nick, m_server, m_ircChannel);

            lock (msyncConnect)
            {

                _icc_ = 0;

                try
                {
                    if (m_connected) return;

                    m_connected = true;
                    m_pending   = true;
                    m_timeout   = L_TIMEOUT;

                    m_tcp    = new TcpClient(m_server, (int)m_port);
                    m_stream = m_tcp.GetStream();
                    m_reader = new StreamReader(m_stream);
                    m_writer = new StreamWriter(m_stream);

                    m_log.InfoFormat("[IRC-Connector-{0}]: Connected to {1}:{2}", idn, m_server, m_port); 

                    m_listener = new Thread(new ThreadStart(ListenerRun));
                    m_listener.Name = "IRCConnectorListenerThread";
                    m_listener.IsBackground = true;
                    m_listener.Start();
                    ThreadTracker.Add(m_listener);

                    // This is the message order recommended by RFC 2812
                    if (m_password != null)
                        m_writer.WriteLine(String.Format("PASS {0}", m_password));
                    m_writer.WriteLine(String.Format("NICK {0}", m_nick));
                    m_writer.Flush();
                    m_writer.WriteLine(m_user);
                    m_writer.Flush();
                    m_writer.WriteLine(String.Format("JOIN {0}", m_ircChannel));
                    m_writer.Flush();

                    m_log.InfoFormat("[IRC-Connector-{0}]: {1} has asked to join {2}", idn, m_nick, m_ircChannel);

                }
                catch (Exception e)
                {
                    m_log.ErrorFormat("[IRC-Connector-{0}] cannot connect {1} to {2}:{3}: {4}",
                                      idn, m_nick, m_server, m_port, e.Message);
                    m_connected = false;
                    m_pending   = false;
                }

            }

            return;

        }

        // Reconnect is used to force a re-cycle of the IRC connection. Should generally
        // be a transparent event

        public void Reconnect()
        {
            m_log.DebugFormat("[IRC-Connector-{0}]: Reconnect request for {1} on {2}:{3}", idn, m_nick, m_server, m_ircChannel);

            // Don't do this if a Connect is in progress...

            lock (msyncConnect)
            {

                if (m_connected)
                {
                    m_log.InfoFormat("[IRC-Connector-{0}] Resetting connector", idn);

                    // Mark as disconnected. This will allow the listener thread
                    // to exit if still in-flight.


                    // The listener thread is not aborted - it *might* actually be
                    // the thread that is running the Reconnect! Instead just close
                    // the socket and it will disappear of its own accord, once this
                    // processing is completed.

                    try { m_writer.Close(); } catch (Exception) {}
                    try { m_reader.Close(); } catch (Exception) {}
                    try { m_tcp.Close();    } catch (Exception) {}

                    m_connected = false;
                    m_pending   = false;

                }

            }

            Connect();

        }

        #endregion

        #region Outbound (to-IRC) message handlers

        public void PrivMsg(string pattern, string from, string region, string msg)
        {

            // m_log.DebugFormat("[IRC-Connector-{0}] PrivMsg to IRC from {1}: <{2}>", idn, from, 
            //     String.Format(pattern, m_ircChannel, from, region, msg));

            // One message to the IRC server

            try
            {
                m_writer.WriteLine(pattern, m_ircChannel, from, region, msg);
                m_writer.Flush();
                // m_log.DebugFormat("[IRC-Connector-{0}]: PrivMsg from {1} in {2}: {3}", idn, from, region, msg);
            }
            catch (IOException)
            {
                m_log.ErrorFormat("[IRC-Connector-{0}]: PrivMsg I/O Error: disconnected from IRC server", idn);
                Reconnect();
            }
            catch (Exception ex)
            {
                m_log.ErrorFormat("[IRC-Connector-{0}]: PrivMsg exception : {1}", idn, ex.Message);
                m_log.Debug(ex);
            }

        }

        public void Send(string msg)
        {

            // m_log.DebugFormat("[IRC-Connector-{0}] Send to IRC : <{1}>", idn,  msg);

            try
            {
                m_writer.WriteLine(msg);
                m_writer.Flush();
                // m_log.DebugFormat("[IRC-Connector-{0}] Sent command string: {1}", idn, msg);
            }
            catch (IOException)
            {
                m_log.ErrorFormat("[IRC-Connector-{0}] Disconnected from IRC server.(Send)", idn);
                Reconnect();
            }
            catch (Exception ex)
            {
                m_log.ErrorFormat("[IRC-Connector-{0}] Send exception trap: {0}", idn, ex.Message);
                m_log.Debug(ex);
            }

        }

        #endregion

        public void ListenerRun()
        {
            string inputLine;

            try
            {
                while (m_enabled && m_connected)
                {

                    if ((inputLine = m_reader.ReadLine()) == null)
                        throw new Exception("Listener input socket closed");

                    // m_log.Info("[IRCConnector]: " + inputLine);

                    if (inputLine.Contains("PRIVMSG"))
                    {

                        Dictionary<string, string> data = ExtractMsg(inputLine);

                        // Any chat ???
                        if (data != null)
                        {

                            OSChatMessage c = new OSChatMessage();
                            c.Message = data["msg"];
                            c.Type = ChatTypeEnum.Region;
                            c.Position = CenterOfRegion;
                            c.From = data["nick"];
                            c.Sender = null;
                            c.SenderUUID = UUID.Zero;

                            // Is message "\001ACTION foo bar\001"? 
                            // Then change to: "/me foo bar"

                            if ((1 == c.Message[0]) && c.Message.Substring(1).StartsWith("ACTION"))
                                c.Message = String.Format("/me {0}", c.Message.Substring(8, c.Message.Length - 9));

                            ChannelState.OSChat(this, c, false);

                        }

                    }
                    else
                    {
                        ProcessIRCCommand(inputLine);
                    }
                }
            }
            catch (Exception /*e*/)
            {
                // m_log.ErrorFormat("[IRC-Connector-{0}]: ListenerRun exception trap: {1}", idn, e.Message);
                // m_log.Debug(e);
            }

            // This is potentially circular, but harmless if so.
            // The connection is marked as not connected the first time
            // through reconnect.

            if (m_enabled) Reconnect();

        }

        private Regex RE = new Regex(@":(?<nick>[\w-]*)!(?<user>\S*) PRIVMSG (?<channel>\S+) :(?<msg>.*)", 
                                     RegexOptions.Multiline);

        private Dictionary<string, string> ExtractMsg(string input)
        {
            //examines IRC commands and extracts any private messages
            // which will then be reboadcast in the Sim

            // m_log.InfoFormat("[IRC-Connector-{0}]: ExtractMsg: {1}", idn, input);

            Dictionary<string, string> result = null;
            MatchCollection matches = RE.Matches(input);

            // Get some direct matches $1 $4 is a
            if ((matches.Count == 0) || (matches.Count != 1) || (matches[0].Groups.Count != 5))
            {
                // m_log.Info("[IRCConnector]: Number of matches: " + matches.Count);
                // if (matches.Count > 0)
                // {
                //     m_log.Info("[IRCConnector]: Number of groups: " + matches[0].Groups.Count);
                // }
                return null;
            }

            result = new Dictionary<string, string>();
            result.Add("nick", matches[0].Groups[1].Value);
            result.Add("user", matches[0].Groups[2].Value);
            result.Add("channel", matches[0].Groups[3].Value);
            result.Add("msg", matches[0].Groups[4].Value);

            return result;
        }

        public void BroadcastSim(string sender, string format, params string[] args)
        {
            try
            {
                OSChatMessage c = new OSChatMessage();
                c.From = sender;
                c.Message = String.Format(format, args);
                c.Type = ChatTypeEnum.Region; // ChatTypeEnum.Say;
                c.Position = CenterOfRegion;
                c.Sender = null;
                c.SenderUUID = UUID.Zero;

                ChannelState.OSChat(this, c, true);

            }
            catch (Exception ex) // IRC gate should not crash Sim
            {
                m_log.ErrorFormat("[IRC-Connector-{0}]: BroadcastSim Exception Trap: {1}\n{2}", idn, ex.Message, ex.StackTrace);
            }
        }

        #region IRC Command Handlers

        public void ProcessIRCCommand(string command)
        {

            string[] commArgs;
            string c_server = m_server;

            string pfx   = String.Empty;
            string cmd   = String.Empty;
            string parms = String.Empty;

            // ":" indicates that a prefix is present
            // There are NEVER more than 17 real 
            // fields. A parameter that starts with 
            // ":" indicates that the remainder of the
            // line is a single parameter value.

            commArgs = command.Split(CS_SPACE,2);

            if (commArgs[0].StartsWith(":"))
            {
                pfx = commArgs[0].Substring(1);
                commArgs = commArgs[1].Split(CS_SPACE,2);
            }

            cmd   = commArgs[0];
            parms = commArgs[1];

            // m_log.DebugFormat("[IRC-Connector-{0}] prefix = <{1}> cmd = <{2}>", idn, pfx, cmd);

            switch (cmd)
            {

                // Messages 001-004 are always sent
                // following signon.

                case "001" : // Welcome ...
                case "002" : // Server information
                case "003" : // Welcome ...
                    break;
                case "004" : // Server information
                    m_log.DebugFormat("[IRC-Connector-{0}] [{1}] parms = <{2}>", idn, cmd, parms);
                    commArgs = parms.Split(CS_SPACE);
                    c_server = commArgs[1];
                    m_server = c_server;
                    version  = commArgs[2];
                    usermod  = commArgs[3];
                    chanmod  = commArgs[4];
                    break;
                case "005" : // Server information
                    break;
                case "042" :
                case "250" :
                case "251" :
                case "252" :
                case "254" :
                case "255" :
                case "265" :
                case "266" :
                case "332" : // Subject
                case "333" : // Subject owner (?)
                case "353" : // Name list
                case "366" : // End-of-Name list marker
                case "372" : // MOTD body
                case "375" : // MOTD start
                    // m_log.InfoFormat("[IRC-Connector-{0}] [{1}] {2}", idn, cmd, parms.Split(CS_SPACE,2)[1]);
                    break;
                case "376" : // MOTD end
                    // m_log.InfoFormat("[IRC-Connector-{0}] [{1}] {2}", idn, cmd, parms.Split(CS_SPACE,2)[1]);
                    motd = true;
                    break;
                case "451" : // Not registered
                    break;
                case "433" : // Nickname in use
                    // Gen a new name
                    m_nick = m_baseNick + Util.RandomClass.Next(1, 99);
                    m_log.ErrorFormat("[IRC-Connector-{0}]: [{1}] IRC SERVER reports NicknameInUse, trying {2}", idn, cmd, m_nick);
                    // Retry
                    m_writer.WriteLine(String.Format("NICK {0}", m_nick));
                    m_writer.Flush();
                    m_writer.WriteLine(m_user);
                    m_writer.Flush();
                    m_writer.WriteLine(String.Format("JOIN {0}", m_ircChannel));
                    m_writer.Flush();
                    break;
                case "479" : // Bad channel name, etc. This will never work, so disable the connection
                    m_log.ErrorFormat("[IRC-Connector-{0}] [{1}] {2}", idn, cmd, parms.Split(CS_SPACE,2)[1]);
                    m_log.ErrorFormat("[IRC-Connector-{0}] [{1}] Connector disabled", idn, cmd);
                    m_enabled   = false;
                    m_connected = false;
                    m_pending   = false;
                    break;
                case "NOTICE" :
                    // m_log.WarnFormat("[IRC-Connector-{0}] [{1}] {2}", idn, cmd, parms.Split(CS_SPACE,2)[1]);
                    break;
                case "ERROR"  :
                    m_log.ErrorFormat("[IRC-Connector-{0}] [{1}] {2}", idn, cmd, parms.Split(CS_SPACE,2)[1]);
                    if (parms.Contains("reconnect too fast"))
                        ICCD_PERIOD++;
                    m_pending   = false;
                    Reconnect();
                    break;
                case "PING"   :
                    m_log.DebugFormat("[IRC-Connector-{0}] [{1}] parms = <{2}>", idn, cmd, parms);
                    m_writer.WriteLine(String.Format("PONG {0}", parms));
                    m_writer.Flush();
                    break;
                case "PONG"   :
                    break;
                case "JOIN":
                    if (m_pending)
                    {
                        m_log.InfoFormat("[IRC-Connector-{0}] [{1}] Connected", idn, cmd);
                        m_pending = false;
                    }
                    m_log.DebugFormat("[IRC-Connector-{0}] [{1}] parms = <{2}>", idn, cmd, parms);
                    eventIrcJoin(pfx, cmd, parms);
                    break;
                case "PART":
                    m_log.DebugFormat("[IRC-Connector-{0}] [{1}] parms = <{2}>", idn, cmd, parms);
                    eventIrcPart(pfx, cmd, parms);
                    break;
                case "MODE":
                    m_log.DebugFormat("[IRC-Connector-{0}] [{1}] parms = <{2}>", idn, cmd, parms);
                    eventIrcMode(pfx, cmd, parms);
                    break;
                case "NICK":
                    m_log.DebugFormat("[IRC-Connector-{0}] [{1}] parms = <{2}>", idn, cmd, parms);
                    eventIrcNickChange(pfx, cmd, parms);
                    break;
                case "KICK":
                    m_log.DebugFormat("[IRC-Connector-{0}] [{1}] parms = <{2}>", idn, cmd, parms);
                    eventIrcKick(pfx, cmd, parms);
                    break;
                case "QUIT":
                    m_log.DebugFormat("[IRC-Connector-{0}] [{1}] parms = <{2}>", idn, cmd, parms);
                    eventIrcQuit(pfx, cmd, parms);
                    break;
                default    :
                    m_log.DebugFormat("[IRC-Connector-{0}] Command '{1}' ignored, parms = {2}", idn, cmd, parms);
                    break;
            }

            // m_log.DebugFormat("[IRC-Connector-{0}] prefix = <{1}> cmd = <{2}> complete", idn, pfx, cmd);
  
        }

        public void eventIrcJoin(string prefix, string command, string parms)
        {
            string[]     args = parms.Split(CS_SPACE,2);
            string IrcUser    = prefix.Split('!')[0];
            string IrcChannel = args[0];

            if (IrcChannel.StartsWith(":"))
                IrcChannel = IrcChannel.Substring(1);

            m_log.DebugFormat("[IRC-Connector-{0}] Event: IRCJoin {1}:{2}", idn, m_server, m_ircChannel);
            BroadcastSim(IrcUser, "/me joins {0}", IrcChannel);
        }

        public void eventIrcPart(string prefix, string command, string parms)
        {
            string[]     args = parms.Split(CS_SPACE,2);
            string    IrcUser = prefix.Split('!')[0];
            string IrcChannel = args[0];

            m_log.DebugFormat("[IRC-Connector-{0}] Event: IRCPart {1}:{2}", idn, m_server, m_ircChannel);
            BroadcastSim(IrcUser, "/me parts {0}", IrcChannel);
        }

        public void eventIrcMode(string prefix, string command, string parms)
        {
            string[]   args = parms.Split(CS_SPACE,2);
            string UserMode = args[1];

            m_log.DebugFormat("[IRC-Connector-{0}] Event: IRCMode {1}:{2}", idn, m_server, m_ircChannel);
            if (UserMode.Substring(0, 1) == ":")
            {
                UserMode = UserMode.Remove(0, 1);
            }
        }

        public void eventIrcNickChange(string prefix, string command, string parms)
        {
            string[]      args = parms.Split(CS_SPACE,2);
            string UserOldNick = prefix.Split('!')[0];
            string UserNewNick = args[0].Remove(0, 1);

            m_log.DebugFormat("[IRC-Connector-{0}] Event: IRCNickChange {1}:{2}", idn, m_server, m_ircChannel);
            BroadcastSim(UserOldNick, "/me is now known as {0}", UserNewNick);
        }

        public void eventIrcKick(string prefix, string command, string parms)
        {
            string[]      args = parms.Split(CS_SPACE,3);
            string UserKicker  = prefix.Split('!')[0];
            string IrcChannel  = args[0];
            string UserKicked  = args[1];
            string KickMessage = args[2]; 

            m_log.DebugFormat("[IRC-Connector-{0}] Event: IRCKick {1}:{2}", idn, m_server, m_ircChannel);
            BroadcastSim(UserKicker, "/me kicks kicks {0} off {1} saying \"{2}\"", UserKicked, IrcChannel, KickMessage);

            if (UserKicked == m_nick)
            {
                BroadcastSim(m_nick, "Hey, that was me!!!");
            }

        }

        public void eventIrcQuit(string prefix, string command, string parms)
        {
            string     IrcUser = prefix.Split('!')[0];
            string QuitMessage = parms;

            m_log.DebugFormat("[IRC-Connector-{0}] Event: IRCQuit {1}:{2}", idn, m_server, m_ircChannel);
            BroadcastSim(IrcUser, "/me quits saying \"{0}\"", QuitMessage);
        }

        #endregion

        #region Connector Watch Dog

        // A single watch dog monitors extant connectors and makes sure that they
        // are re-connected as necessary. If a connector IS connected, then it is
        // pinged, but only if a PING period has elapsed.

        protected static void WatchdogHandler(Object source, ElapsedEventArgs args)
        {

            // m_log.InfoFormat("[IRC-Watchdog] Status scan");

            _pdk_ = (_pdk_+1)%PING_PERIOD;    // cycle the ping trigger
            _icc_++;    // increment the inter-consecutive-connect-delay counter

            foreach (IRCConnector connector in m_connectors)
            {
                if (connector.Enabled)
                {
                    if (!connector.Connected)
                    {
                        try
                        {
                            // m_log.DebugFormat("[IRC-Watchdog] Connecting {1}:{2}", connector.idn, connector.m_server, connector.m_ircChannel);
                            connector.Connect();
                        }
                        catch (Exception e)
                        {
                            m_log.ErrorFormat("[IRC-Watchdog] Exception on connector {0}: {1} ", connector.idn, e.Message);
                        }
                    }
                    else
                    {

                        if (connector.m_pending)
                        {
                            if (connector.m_timeout == 0)
                            {
                                m_log.ErrorFormat("[IRC-Watchdog] Login timed-out for connector {0}, reconnecting", connector.idn);
                                connector.Reconnect();
                            }
                            else
                                connector.m_timeout--;
                        }

                        if (_pdk_ == 0)
                        {
                            try
                            {
                                connector.m_writer.WriteLine(String.Format("PING :{0}", connector.m_server));
                                connector.m_writer.Flush();
                            }
                            catch (Exception /*e*/)
                            {
                                // m_log.ErrorFormat("[IRC-PingRun] Exception on connector {0}: {1} ", connector.idn, e.Message);
                                // m_log.Debug(e);
                                connector.Reconnect();
                            }
                        }

                    }
                }
            }

            // m_log.InfoFormat("[IRC-Watchdog] Status scan completed");

        }

        #endregion

    }
}