goirc/irc/commands.go

package irc

// this file contains the various commands you can
// send to the server using an Conn connection

// This could be a lot less ugly with the ability to manipulate
// the symbol table and add methods/functions on the fly
// [ CMD, FMT, FMTARGS ] etc.

// Raw() sends a raw line to the server, should really only be used for 
// debugging purposes but may well come in handy.
func (conn *Conn) Raw(rawline string) { conn.out <- rawline }

// Pass() sends a PASS command to the server
func (conn *Conn) Pass(password string) { conn.out <- "PASS "+password }

// Nick() sends a NICK command to the server
func (conn *Conn) Nick(nick string) { conn.out <- "NICK "+nick }

// User() sends a USER command to the server
func (conn *Conn) User(ident, name string) {
	conn.out <- "USER "+ident+" 12 * :"+name
}

// Join() sends a JOIN command to the server
func (conn *Conn) Join(channel string) { conn.out <- "JOIN "+channel }

// Part() sends a PART command to the server with an optional part message
func (conn *Conn) Part(channel string, message ...string) {
	msg := getStringMsg(message)
	if msg != "" {
		msg = " :" + msg
	}
	conn.out <- "PART "+channel+msg
}

// Kick() sends a KICK command to remove a nick from a channel
func (conn *Conn) Kick(channel, nick string, message ...string) {
	msg := getStringMsg(message)
	if msg != "" {
		msg = " :" + msg
	}
	conn.out <- "KICK "+channel+" "+nick+msg
}

// Quit() sends a QUIT command to the server with an optional quit message
func (conn *Conn) Quit(message ...string) {
	msg := getStringMsg(message)
	if msg == "" {
		msg = "GoBye!"
	}
	conn.out <- "QUIT :"+msg
}

// Whois() sends a WHOIS command to the server
func (conn *Conn) Whois(nick string) { conn.out <- "WHOIS "+nick }

//Who() sends a WHO command to the server
func (conn *Conn) Who(nick string) { conn.out <- "WHO "+nick }

// Privmsg() sends a PRIVMSG to the target t
func (conn *Conn) Privmsg(t, msg string) { conn.out <- "PRIVMSG "+t+" :"+msg }

// Notice() sends a NOTICE to the target t
func (conn *Conn) Notice(t, msg string) { conn.out <- "NOTICE "+t+" :"+msg }

// Ctcp() sends a (generic) CTCP message to the target t
// with an optional argument
func (conn *Conn) Ctcp(t, ctcp string, arg ...string) {
	msg := getStringMsg(arg)
	if msg != "" {
		msg = " " + msg
	}
	conn.Privmsg(t, "\001"+ctcp+msg+"\001")
}

// CtcpReply() sends a generic CTCP reply to the target t
// with an optional argument
func (conn *Conn) CtcpReply(t, ctcp string, arg ...string) {
	msg := getStringMsg(arg)
	if msg != "" {
		msg = " " + msg
	}
	conn.Notice(t, "\001"+ctcp+msg+"\001")
}

// Version() sends a CTCP "VERSION" to the target t
func (conn *Conn) Version(t string) { conn.Ctcp(t, "VERSION") }

// Action() sends a CTCP "ACTION" to the target t
func (conn *Conn) Action(t, msg string) { conn.Ctcp(t, "ACTION", msg) }

// Topic() sends a TOPIC command to the channel
//   Topic(channel) retrieves the current channel topic (see "332" handler)
//   Topic(channel, topic) sets the topic for the channel
func (conn *Conn) Topic(channel string, topic ...string) {
	t := getStringMsg(topic)
	if t != "" {
		t = " :" + t
	}
	conn.out <- "TOPIC "+channel+t
}

// Mode() sends a MODE command to the server. This one can get complicated if
// we try to be too clever, so it's deliberately simple:
//   Mode(t) retrieves the user or channel modes for target t
//   Mode(t, "modestring") sets user or channel modes for target t, where...
//     modestring == e.g. "+o <nick>" or "+ntk <key>" or "-is"
// This means you'll need to do your own mode work. It may be linked in with
// the state tracking and ChanMode/NickMode/ChanPrivs objects later...
func (conn *Conn) Mode(t string, modestring ...string) {
	mode := getStringMsg(modestring)
	if mode != "" {
		mode = " " + mode
	}
	conn.out <- "MODE "+t+mode
}

// Away() sends an AWAY command to the server
//   Away() resets away status
//   Away(message) sets away with the given message
func (conn *Conn) Away(message ...string) {
	msg := getStringMsg(message)
	if msg != "" {
		msg = " :"+msg
	}
	conn.out <- "AWAY"+msg
}

// Invite() sends an INVITE command to the server
func (conn *Conn) Invite(nick, channel string) {
	conn.out <- "INVITE "+nick+" "+channel
}

// Oper() sends an OPER command to the server
func (conn *Conn) Oper(user, pass string) {
	conn.out <- "OPER "+user+" "+pass
}

func getStringMsg(a ...string) (msg string) {
	if len(a) > 0 {
		return a[0]
	}
	return ""
}