// Copyright 2009 Thomas Jager All rights reserved. // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. /* This package provides an event based IRC client library. It allows to register callbacks for the events you need to handle. Its features include handling standard CTCP, reconnecting on errors and detecting stones servers. */ package irc import ( "bufio" "crypto/tls" "errors" "fmt" "log" "net" "os" "strings" "time" ) const ( VERSION = "go-ircevent v2.1" ) func (irc *Connection) readLoop() { br := bufio.NewReaderSize(irc.socket, 512) for { select { case <-irc.endread: irc.readerExit <- true return default: // Set a read deadline based on the combined timeout and ping frequency // We should ALWAYS have received a response from the server within the timeout // after our own pings if irc.socket != nil { irc.socket.SetReadDeadline(time.Now().Add(irc.Timeout + irc.PingFreq)) } msg, err := br.ReadString('\n') // We got past our blocking read, so bin timeout if irc.socket != nil { var zero time.Time irc.socket.SetReadDeadline(zero) } if err != nil { irc.Error <- err break } irc.lastMessage = time.Now() msg = msg[:len(msg)-2] //Remove \r\n event := &Event{Raw: msg} if msg[0] == ':' { if i := strings.Index(msg, " "); i > -1 { event.Source = msg[1:i] msg = msg[i+1 : len(msg)] } else { irc.Log.Printf("Misformed msg from server: %#s\n", msg) } if i, j := strings.Index(event.Source, "!"), strings.Index(event.Source, "@"); i > -1 && j > -1 { event.Nick = event.Source[0:i] event.User = event.Source[i+1 : j] event.Host = event.Source[j+1 : len(event.Source)] } } split := strings.SplitN(msg, " :", 2) args := strings.Split(split[0], " ") event.Code = strings.ToUpper(args[0]) event.Arguments = args[1:] if len(split) > 1 { event.Arguments = append(event.Arguments, split[1]) } /* XXX: len(args) == 0: args should be empty */ irc.RunCallbacks(event) } } irc.readerExit <- true } func (irc *Connection) writeLoop() { for { select { case <-irc.endwrite: irc.writerExit <- true return default: b, ok := <-irc.pwrite if !ok || b == "" || irc.socket == nil { irc.writerExit <- true return } if irc.Debug { irc.Log.Printf("--> %s\n", b) } // Set a write deadline based on the time out irc.socket.SetWriteDeadline(time.Now().Add(irc.Timeout)) _, err := irc.socket.Write([]byte(b)) // Past blocking write, bin timeout var zero time.Time irc.socket.SetWriteDeadline(zero) if err != nil { irc.Error <- err irc.writerExit <- true return } } } irc.writerExit <- true } //Pings the server if we have not received any messages for 5 minutes func (irc *Connection) pingLoop() { ticker := time.NewTicker(1 * time.Minute) // Tick every minute for monitoring ticker2 := time.NewTicker(irc.PingFreq) // Tick at the ping frequency. for { select { case <-ticker.C: //Ping if we haven't received anything from the server within the keep alive period if time.Since(irc.lastMessage) >= irc.KeepAlive { irc.SendRawf("PING %d", time.Now().UnixNano()) } case <-ticker2.C: //Ping at the ping frequency irc.SendRawf("PING %d", time.Now().UnixNano()) //Try to recapture nickname if it's not as configured. if irc.nick != irc.nickcurrent { irc.nickcurrent = irc.nick irc.SendRawf("NICK %s", irc.nick) } case <-irc.endping: ticker.Stop() ticker2.Stop() irc.pingerExit <- true return } } } func (irc *Connection) Loop() { for !irc.stopped { err := <-irc.Error if irc.stopped { break } irc.Log.Printf("Error: %s\n", err) irc.Disconnect() for !irc.stopped { if err = irc.Connect(irc.server); err != nil { irc.Log.Printf("Error: %s\n", err) time.Sleep(1 * time.Second) } else { break } } } } func (irc *Connection) Quit() { irc.SendRaw("QUIT") irc.stopped = true irc.Disconnect() } func (irc *Connection) Join(channel string) { irc.pwrite <- fmt.Sprintf("JOIN %s\r\n", channel) } func (irc *Connection) Part(channel string) { irc.pwrite <- fmt.Sprintf("PART %s\r\n", channel) } func (irc *Connection) Notice(target, message string) { irc.pwrite <- fmt.Sprintf("NOTICE %s :%s\r\n", target, message) } func (irc *Connection) Noticef(target, format string, a ...interface{}) { irc.Notice(target, fmt.Sprintf(format, a...)) } func (irc *Connection) Privmsg(target, message string) { irc.pwrite <- fmt.Sprintf("PRIVMSG %s :%s\r\n", target, message) } func (irc *Connection) Privmsgf(target, format string, a ...interface{}) { irc.Privmsg(target, fmt.Sprintf(format, a...)) } func (irc *Connection) SendRaw(message string) { irc.pwrite <- message + "\r\n" } func (irc *Connection) SendRawf(format string, a ...interface{}) { irc.SendRaw(fmt.Sprintf(format, a...)) } func (irc *Connection) Nick(n string) { irc.nick = n irc.SendRawf("NICK %s", n) } func (irc *Connection) GetNick() string { return irc.nickcurrent } func (irc *Connection) Whois(nick string) { irc.SendRawf("WHOIS %s", nick) } func (irc *Connection) Who(nick string) { irc.SendRawf("WHO %s", nick) } func (irc *Connection) Mode(target string, modestring ...string) { if len(modestring) > 0 { mode := strings.Join(modestring, " ") irc.SendRawf("MODE %s %s", target, mode) return } irc.SendRawf("MODE %s", target) } // Sends all buffered messages (if possible), // stops all goroutines and then closes the socket. func (irc *Connection) Disconnect() { irc.endping <- true irc.endwrite <- true irc.endread <- true close(irc.pwrite) close(irc.pread) <-irc.readerExit <-irc.writerExit <-irc.pingerExit irc.socket.Close() irc.socket = nil if irc.netsock != nil { irc.netsock.Close() irc.netsock = nil } irc.Error <- errors.New("Disconnect Called") } func (irc *Connection) Reconnect() error { return irc.Connect(irc.server) } func (irc *Connection) Connect(server string) error { irc.server = server irc.stopped = false var err error if irc.UseTLS { if irc.netsock, err = net.DialTimeout("tcp", irc.server, irc.Timeout); err == nil { irc.socket = tls.Client(irc.netsock, irc.TLSConfig) } } else { irc.socket, err = net.DialTimeout("tcp", irc.server, irc.Timeout) } if err != nil { return err } irc.Log.Printf("Connected to %s (%s)\n", irc.server, irc.socket.RemoteAddr()) irc.pread = make(chan string, 10) irc.pwrite = make(chan string, 10) irc.Error = make(chan error, 2) go irc.readLoop() go irc.writeLoop() go irc.pingLoop() if len(irc.Password) > 0 { irc.pwrite <- fmt.Sprintf("PASS %s\r\n", irc.Password) } irc.pwrite <- fmt.Sprintf("NICK %s\r\n", irc.nick) irc.pwrite <- fmt.Sprintf("USER %s 0.0.0.0 0.0.0.0 :%s\r\n", irc.user, irc.user) return nil } func IRC(nick, user string) *Connection { irc := &Connection{ nick: nick, user: user, Log: log.New(os.Stdout, "", log.LstdFlags), readerExit: make(chan bool), writerExit: make(chan bool), pingerExit: make(chan bool), endping: make(chan bool), endread: make(chan bool), endwrite: make(chan bool), Version: VERSION, KeepAlive: 4 * time.Minute, Timeout: 1 * time.Minute, PingFreq: 15 * time.Minute, } irc.setupCallbacks() return irc }