sneak/go-ircevent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style fixes

Browse Source
This commit is contained in:
tpltnt 2014-02-16 14:20:13 +01:00
parent 6e0280dae6
commit f073b9b25c
2 changed files with 17 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
irc.go
View File

@ -35,7 +35,6 @@ const (
VERSION = "go-ircevent v2.1" VERSION = "go-ircevent v2.1"
) )
// Read data from a connection. To be used as a goroutine. // Read data from a connection. To be used as a goroutine.
func (irc *Connection) readLoop() { func (irc *Connection) readLoop() {
br := bufio.NewReaderSize(irc.socket, 512) br := bufio.NewReaderSize(irc.socket, 512)
@ -102,7 +101,6 @@ func (irc *Connection) readLoop() {
irc.readerExit <- true irc.readerExit <- true
} }
// Loop to write to a connection. To be used as a goroutine. // Loop to write to a connection. To be used as a goroutine.
func (irc *Connection) writeLoop() { func (irc *Connection) writeLoop() {
for { for {
@ -140,7 +138,6 @@ func (irc *Connection) writeLoop() {
irc.writerExit <- true irc.writerExit <- true
} }
// Pings the server if we have not received any messages for 5 minutes // Pings the server if we have not received any messages for 5 minutes
// to keep the connection alive. To be used as a goroutine. // to keep the connection alive. To be used as a goroutine.
func (irc *Connection) pingLoop() { func (irc *Connection) pingLoop() {
@ -170,7 +167,6 @@ func (irc *Connection) pingLoop() {
} }
} }
// Main loop to control the connection. // Main loop to control the connection.
func (irc *Connection) Loop() { func (irc *Connection) Loop() {
for !irc.stopped { for !irc.stopped {
@ -191,7 +187,6 @@ func (irc *Connection) Loop() {
} }
} }
// Quit the current connection and disconnect from the server // Quit the current connection and disconnect from the server
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.1.6 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.1.6
func (irc *Connection) Quit() { func (irc *Connection) Quit() {
@ -200,60 +195,51 @@ func (irc *Connection) Quit() {
irc.Disconnect() irc.Disconnect()
} }
// Use the connection to join a given channel. // Use the connection to join a given channel.
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.2.1 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.2.1
func (irc *Connection) Join(channel string) { func (irc *Connection) Join(channel string) {
irc.pwrite <- fmt.Sprintf("JOIN %s\r\n", channel) irc.pwrite <- fmt.Sprintf("JOIN %s\r\n", channel)
} }
// Leave a given channel. // Leave a given channel.
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.2.2 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.2.2
func (irc *Connection) Part(channel string) { func (irc *Connection) Part(channel string) {
irc.pwrite <- fmt.Sprintf("PART %s\r\n", channel) irc.pwrite <- fmt.Sprintf("PART %s\r\n", channel)
} }
// Send a notification to a nickname. This is similar to Privmsg but must not receive replies. // Send a notification to a nickname. This is similar to Privmsg but must not receive replies.
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.4.2 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.4.2
func (irc *Connection) Notice(target, message string) { func (irc *Connection) Notice(target, message string) {
irc.pwrite <- fmt.Sprintf("NOTICE %s :%s\r\n", target, message) irc.pwrite <- fmt.Sprintf("NOTICE %s :%s\r\n", target, message)
} }
// Send a formated notification to a nickname. // Send a formated notification to a nickname.
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.4.2 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.4.2
func (irc *Connection) Noticef(target, format string, a ...interface{}) { func (irc *Connection) Noticef(target, format string, a ...interface{}) {
irc.Notice(target, fmt.Sprintf(format, a...)) irc.Notice(target, fmt.Sprintf(format, a...))
} }
// Send (private) message to a target (channel or nickname). // Send (private) message to a target (channel or nickname).
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.4.1 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.4.1
func (irc *Connection) Privmsg(target, message string) { func (irc *Connection) Privmsg(target, message string) {
irc.pwrite <- fmt.Sprintf("PRIVMSG %s :%s\r\n", target, message) irc.pwrite <- fmt.Sprintf("PRIVMSG %s :%s\r\n", target, message)
} }
// Send formated string to specified target (channel or nickname). // Send formated string to specified target (channel or nickname).
func (irc *Connection) Privmsgf(target, format string, a ...interface{}) { func (irc *Connection) Privmsgf(target, format string, a ...interface{}) {
irc.Privmsg(target, fmt.Sprintf(format, a...)) irc.Privmsg(target, fmt.Sprintf(format, a...))
} }
// Send raw string. // Send raw string.
func (irc *Connection) SendRaw(message string) { func (irc *Connection) SendRaw(message string) {
irc.pwrite <- message + "\r\n" irc.pwrite <- message + "\r\n"
} }
// Send raw formated string. // Send raw formated string.
func (irc *Connection) SendRawf(format string, a ...interface{}) { func (irc *Connection) SendRawf(format string, a ...interface{}) {
irc.SendRaw(fmt.Sprintf(format, a...)) irc.SendRaw(fmt.Sprintf(format, a...))
} }
// Set (new) nickname. // Set (new) nickname.
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.1.2 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.1.2
func (irc *Connection) Nick(n string) { func (irc *Connection) Nick(n string) {
@ -261,27 +247,23 @@ func (irc *Connection) Nick(n string) {
irc.SendRawf("NICK %s", n) irc.SendRawf("NICK %s", n)
} }
// Determine nick currently used with the connection. // Determine nick currently used with the connection.
func (irc *Connection) GetNick() string { func (irc *Connection) GetNick() string {
return irc.nickcurrent return irc.nickcurrent
} }
// Query information about a particular nickname. // Query information about a particular nickname.
// RFC 1459: https://tools.ietf.org/html/rfc1459#section-4.5.2 // RFC 1459: https://tools.ietf.org/html/rfc1459#section-4.5.2
func (irc *Connection) Whois(nick string) { func (irc *Connection) Whois(nick string) {
irc.SendRawf("WHOIS %s", nick) irc.SendRawf("WHOIS %s", nick)
} }
// Query information about a given nickname in the server. // Query information about a given nickname in the server.
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.5.1 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.5.1
func (irc *Connection) Who(nick string) { func (irc *Connection) Who(nick string) {
irc.SendRawf("WHO %s", nick) irc.SendRawf("WHO %s", nick)
} }
// Set different modes for a target (channel or nickname). // Set different modes for a target (channel or nickname).
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.2.3 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.2.3
func (irc *Connection) Mode(target string, modestring ...string) { func (irc *Connection) Mode(target string, modestring ...string) {
@ -293,7 +275,6 @@ func (irc *Connection) Mode(target string, modestring ...string) {
irc.SendRawf("MODE %s", target) irc.SendRawf("MODE %s", target)
} }
// A disconnect sends all buffered messages (if possible), // A disconnect sends all buffered messages (if possible),
// stops all goroutines and then closes the socket. // stops all goroutines and then closes the socket.
func (irc *Connection) Disconnect() { func (irc *Connection) Disconnect() {
@ -315,13 +296,11 @@ func (irc *Connection) Disconnect() {
irc.Error <- errors.New("Disconnect Called") irc.Error <- errors.New("Disconnect Called")
} }
// Reconnect to a server using the current connection. // Reconnect to a server using the current connection.
func (irc *Connection) Reconnect() error { func (irc *Connection) Reconnect() error {
return irc.Connect(irc.server) return irc.Connect(irc.server)
} }
// Connect to a given server using the current connection configuration. // Connect to a given server using the current connection configuration.
// This function also takes care of identification if a password is provided. // This function also takes care of identification if a password is provided.
// RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.1 // RFC 1459 details: https://tools.ietf.org/html/rfc1459#section-4.1
@ -330,38 +309,37 @@ func (irc *Connection) Connect(server string) error {
irc.stopped = false irc.stopped = false
// make sure everything is ready for connection // make sure everything is ready for connection
if 0 == len(irc.server) { if len(irc.server) == 0 {
return errors.New("empty 'server'") return errors.New("empty 'server'")
} }
if 1 != strings.Count(irc.server, ":") { if strings.Count(irc.server, ":") != 1 {
return errors.New("wrong number of ':' in address") return errors.New("wrong number of ':' in address")
} }
if 0 == strings.Index(irc.server, ":") { if strings.Index(irc.server, ":") == 0 {
return errors.New("hostname is missing") return errors.New("hostname is missing")
} }
if (len(irc.server) - 1) == strings.Index(irc.server, ":") { if strings.Index(irc.server, ":") == len(irc.server)-1 {
return errors.New("port missing") return errors.New("port missing")
} }
// check for valid range // check for valid range
ports := strings.Split(irc.server, ":")[1] ports := strings.Split(irc.server, ":")[1]
port, err := strconv.Atoi(ports) port, err := strconv.Atoi(ports)
if nil != err { if err != nil {
return errors.New("extracting port failed") return errors.New("extracting port failed")
} }
if !((port >= 0) && (port <= 65535)) { if !((port >= 0) && (port <= 65535)) {
return errors.New("port number outside valid range") return errors.New("port number outside valid range")
} }
if nil == irc.Log { if irc.Log == nil {
return errors.New("'Log' points to nil") return errors.New("'Log' points to nil")
} }
if 0 == len(irc.nick) { if len(irc.nick) == 0 {
return errors.New("empty 'user'") return errors.New("empty 'user'")
} }
if 0 == len(irc.user) { if len(irc.user) == 0 {
return errors.New("empty 'user'") return errors.New("empty 'user'")
} }
// var err error
if irc.UseTLS { if irc.UseTLS {
if irc.netsock, err = net.DialTimeout("tcp", irc.server, irc.Timeout); err == nil { if irc.netsock, err = net.DialTimeout("tcp", irc.server, irc.Timeout); err == nil {
irc.socket = tls.Client(irc.netsock, irc.TLSConfig) irc.socket = tls.Client(irc.netsock, irc.TLSConfig)
@ -390,16 +368,15 @@ func (irc *Connection) Connect(server string) error {
return nil return nil
} }
// Create a connection with the (publicly visible) nickname and username. // Create a connection with the (publicly visible) nickname and username.
// The nickname is later used to address the user. Returns nil if nick // The nickname is later used to address the user. Returns nil if nick
// or user are empty. // or user are empty.
func IRC(nick, user string) *Connection { func IRC(nick, user string) *Connection {
// catch invalid values // catch invalid values
if 0 == len(nick) { if len(nick) == 0 {
return nil return nil
} }
if 0 == len(user) { if len(user) == 0 {
return nil return nil
} }
@ -421,4 +398,3 @@ func IRC(nick, user string) *Connection {
irc.setupCallbacks() irc.setupCallbacks()
return irc return irc
} }

4
irc_test.go
View File

@ -210,7 +210,7 @@ func TestClearCallback(t *testing.T) {
func TestIRCemptyNick(t *testing.T) { func TestIRCemptyNick(t *testing.T) {
irccon := IRC("", "go-eventirc") irccon := IRC("", "go-eventirc")
irccon = nil irccon = nil
if nil != irccon { if irccon != nil {
t.Error("empty nick didn't result in error") t.Error("empty nick didn't result in error")
t.Fail() t.Fail()
} }
@ -218,7 +218,7 @@ func TestIRCemptyNick(t *testing.T) {
func TestIRCemptyUser(t *testing.T) { func TestIRCemptyUser(t *testing.T) {
irccon := IRC("go-eventirc", "") irccon := IRC("go-eventirc", "")
if nil != irccon { if irccon != nil {
t.Error("empty user didn't result in error") t.Error("empty user didn't result in error")
} }
} }