irc

package module
Version: v2.0.0-...-3f15758 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 12, 2020 License: MIT Imports: 8 Imported by: 27

README

Go irc package

Build Status GoDoc

Features

Package irc allows your application to speak the IRC protocol.

  • Limited scope, does one thing and does it well.
  • Focus on simplicity and speed.
  • Stable API: updates shouldn't break existing software.
  • Well documented code.

This package does not manage your entire IRC connection. It only translates the protocol to easy to use Go types. It is meant as a single component in a larger IRC library, or for basic IRC bots for which a large IRC package would be overkill.

Usage

import "gopkg.in/sorcix/irc.v2"
Message

The Message and Prefix types provide translation to and from IRC message format.

// Parse the IRC-encoded data and stores the result in a new struct.
message := irc.ParseMessage(raw)

// Returns the IRC encoding of the message.
raw = message.String()
Encoder & Decoder

The Encoder and Decoder types allow working with IRC message streams.

// Create a decoder that reads from given io.Reader
dec := irc.NewDecoder(reader)

// Decode the next IRC message
message, err := dec.Decode()

// Create an encoder that writes to given io.Writer
enc := irc.NewEncoder(writer)

// Send a message to the writer.
enc.Encode(message)
Conn

The Conn type combines an Encoder and Decoder for a duplex connection.

c, err := irc.Dial("irc.server.net:6667")

// Methods from both Encoder and Decoder are available
message, err := c.Decode()

Documentation

Overview

Package irc allows your application to speak the IRC protocol.

The Message and Prefix structs provide translation to and from raw IRC messages:

// Parse the IRC-encoded data and store the result in a new struct:
message := irc.ParseMessage(raw)

// Translate back to a raw IRC message string:
raw = message.String()

Decoder and Encoder can be used to decode and encode messages in a stream:

// Create a decoder that reads from given io.Reader
dec := irc.NewDecoder(reader)

// Decode the next IRC message
message, err := dec.Decode()

// Create an encoder that writes to given io.Writer
enc := irc.NewEncoder(writer)

// Send a message to the writer.
enc.Encode(message)

The Conn type combines an Encoder and Decoder for a duplex connection.

c, err := irc.Dial("irc.server.net:6667")

// Methods from both Encoder and Decoder are available
message, err := c.Decode()

Index

Examples

Constants

View Source
const (
	Channel     = '#' // Normal channel
	Distributed = '&' // Distributed channel

	Owner        = '~' // Channel owner +q (non-standard)
	Admin        = '&' // Channel admin +a (non-standard)
	Operator     = '@' // Channel operator +o
	HalfOperator = '%' // Channel half operator +h (non-standard)
	Voice        = '+' // User has voice +v
)

Various prefixes extracted from RFC 1459.

View Source
const (
	UserModeInvisible     = 'i' // User is invisible
	UserModeServerNotices = 's' // User wants to receive server notices
	UserModeWallops       = 'w' // User wants to receive Wallops
	UserModeOperator      = 'o' // Server operator
)

User modes as defined by RFC 1459 section 4.2.3.2.

View Source
const (
	ModeOperator   = 'o' // Operator privileges
	ModeVoice      = 'v' // Ability to speak on a moderated channel
	ModePrivate    = 'p' // Private channel
	ModeSecret     = 's' // Secret channel
	ModeInviteOnly = 'i' // Users can't join without invite
	ModeTopic      = 't' // Topic can only be set by an operator
	ModeModerated  = 'm' // Only voiced users and operators can talk
	ModeLimit      = 'l' // User limit
	ModeKey        = 'k' // Channel password

	ModeOwner        = 'q' // Owner privileges (non-standard)
	ModeAdmin        = 'a' // Admin privileges (non-standard)
	ModeHalfOperator = 'h' // Half-operator privileges (non-standard)
)

Channel modes as defined by RFC 1459 section 4.2.3.1

View Source
const (
	PASS     = "PASS"
	NICK     = "NICK"
	USER     = "USER"
	OPER     = "OPER"
	MODE     = "MODE"
	SERVICE  = "SERVICE"
	QUIT     = "QUIT"
	SQUIT    = "SQUIT"
	JOIN     = "JOIN"
	PART     = "PART"
	TOPIC    = "TOPIC"
	NAMES    = "NAMES"
	LIST     = "LIST"
	INVITE   = "INVITE"
	KICK     = "KICK"
	PRIVMSG  = "PRIVMSG"
	NOTICE   = "NOTICE"
	MOTD     = "MOTD"
	LUSERS   = "LUSERS"
	VERSION  = "VERSION"
	STATS    = "STATS"
	LINKS    = "LINKS"
	TIME     = "TIME"
	CONNECT  = "CONNECT"
	TRACE    = "TRACE"
	ADMIN    = "ADMIN"
	INFO     = "INFO"
	SERVLIST = "SERVLIST"
	SQUERY   = "SQUERY"
	WHO      = "WHO"
	WHOIS    = "WHOIS"
	WHOWAS   = "WHOWAS"
	KILL     = "KILL"
	PING     = "PING"
	PONG     = "PONG"
	ERROR    = "ERROR"
	AWAY     = "AWAY"
	REHASH   = "REHASH"
	DIE      = "DIE"
	RESTART  = "RESTART"
	SUMMON   = "SUMMON"
	USERS    = "USERS"
	WALLOPS  = "WALLOPS"
	USERHOST = "USERHOST"
	ISON     = "ISON"
	SERVER   = "SERVER"
	NJOIN    = "NJOIN"
)

IRC commands extracted from RFC 2812 section 3 and RFC 2813 section 4.

View Source
const (
	RPL_WELCOME           = "001"
	RPL_YOURHOST          = "002"
	RPL_CREATED           = "003"
	RPL_MYINFO            = "004"
	RPL_BOUNCE            = "005"
	RPL_ISUPPORT          = "005"
	RPL_USERHOST          = "302"
	RPL_ISON              = "303"
	RPL_AWAY              = "301"
	RPL_UNAWAY            = "305"
	RPL_NOWAWAY           = "306"
	RPL_WHOISUSER         = "311"
	RPL_WHOISSERVER       = "312"
	RPL_WHOISOPERATOR     = "313"
	RPL_WHOISIDLE         = "317"
	RPL_ENDOFWHOIS        = "318"
	RPL_WHOISCHANNELS     = "319"
	RPL_WHOWASUSER        = "314"
	RPL_ENDOFWHOWAS       = "369"
	RPL_LISTSTART         = "321"
	RPL_LIST              = "322"
	RPL_LISTEND           = "323"
	RPL_UNIQOPIS          = "325"
	RPL_CHANNELMODEIS     = "324"
	RPL_NOTOPIC           = "331"
	RPL_TOPIC             = "332"
	RPL_INVITING          = "341"
	RPL_SUMMONING         = "342"
	RPL_INVITELIST        = "346"
	RPL_ENDOFINVITELIST   = "347"
	RPL_EXCEPTLIST        = "348"
	RPL_ENDOFEXCEPTLIST   = "349"
	RPL_VERSION           = "351"
	RPL_WHOREPLY          = "352"
	RPL_ENDOFWHO          = "315"
	RPL_NAMREPLY          = "353"
	RPL_ENDOFNAMES        = "366"
	RPL_LINKS             = "364"
	RPL_ENDOFLINKS        = "365"
	RPL_BANLIST           = "367"
	RPL_ENDOFBANLIST      = "368"
	RPL_INFO              = "371"
	RPL_ENDOFINFO         = "374"
	RPL_MOTDSTART         = "375"
	RPL_MOTD              = "372"
	RPL_ENDOFMOTD         = "376"
	RPL_YOUREOPER         = "381"
	RPL_REHASHING         = "382"
	RPL_YOURESERVICE      = "383"
	RPL_TIME              = "391"
	RPL_USERSSTART        = "392"
	RPL_USERS             = "393"
	RPL_ENDOFUSERS        = "394"
	RPL_NOUSERS           = "395"
	RPL_TRACELINK         = "200"
	RPL_TRACECONNECTING   = "201"
	RPL_TRACEHANDSHAKE    = "202"
	RPL_TRACEUNKNOWN      = "203"
	RPL_TRACEOPERATOR     = "204"
	RPL_TRACEUSER         = "205"
	RPL_TRACESERVER       = "206"
	RPL_TRACESERVICE      = "207"
	RPL_TRACENEWTYPE      = "208"
	RPL_TRACECLASS        = "209"
	RPL_TRACERECONNECT    = "210"
	RPL_TRACELOG          = "261"
	RPL_TRACEEND          = "262"
	RPL_STATSLINKINFO     = "211"
	RPL_STATSCOMMANDS     = "212"
	RPL_ENDOFSTATS        = "219"
	RPL_STATSUPTIME       = "242"
	RPL_STATSOLINE        = "243"
	RPL_UMODEIS           = "221"
	RPL_SERVLIST          = "234"
	RPL_SERVLISTEND       = "235"
	RPL_LUSERCLIENT       = "251"
	RPL_LUSEROP           = "252"
	RPL_LUSERUNKNOWN      = "253"
	RPL_LUSERCHANNELS     = "254"
	RPL_LUSERME           = "255"
	RPL_ADMINME           = "256"
	RPL_ADMINLOC1         = "257"
	RPL_ADMINLOC2         = "258"
	RPL_ADMINEMAIL        = "259"
	RPL_TRYAGAIN          = "263"
	ERR_NOSUCHNICK        = "401"
	ERR_NOSUCHSERVER      = "402"
	ERR_NOSUCHCHANNEL     = "403"
	ERR_CANNOTSENDTOCHAN  = "404"
	ERR_TOOMANYCHANNELS   = "405"
	ERR_WASNOSUCHNICK     = "406"
	ERR_TOOMANYTARGETS    = "407"
	ERR_NOSUCHSERVICE     = "408"
	ERR_NOORIGIN          = "409"
	ERR_NORECIPIENT       = "411"
	ERR_NOTEXTTOSEND      = "412"
	ERR_NOTOPLEVEL        = "413"
	ERR_WILDTOPLEVEL      = "414"
	ERR_BADMASK           = "415"
	ERR_UNKNOWNCOMMAND    = "421"
	ERR_NOMOTD            = "422"
	ERR_NOADMININFO       = "423"
	ERR_FILEERROR         = "424"
	ERR_NONICKNAMEGIVEN   = "431"
	ERR_ERRONEUSNICKNAME  = "432"
	ERR_NICKNAMEINUSE     = "433"
	ERR_NICKCOLLISION     = "436"
	ERR_UNAVAILRESOURCE   = "437"
	ERR_USERNOTINCHANNEL  = "441"
	ERR_NOTONCHANNEL      = "442"
	ERR_USERONCHANNEL     = "443"
	ERR_NOLOGIN           = "444"
	ERR_SUMMONDISABLED    = "445"
	ERR_USERSDISABLED     = "446"
	ERR_NOTREGISTERED     = "451"
	ERR_NEEDMOREPARAMS    = "461"
	ERR_ALREADYREGISTRED  = "462"
	ERR_NOPERMFORHOST     = "463"
	ERR_PASSWDMISMATCH    = "464"
	ERR_YOUREBANNEDCREEP  = "465"
	ERR_YOUWILLBEBANNED   = "466"
	ERR_KEYSET            = "467"
	ERR_CHANNELISFULL     = "471"
	ERR_UNKNOWNMODE       = "472"
	ERR_INVITEONLYCHAN    = "473"
	ERR_BANNEDFROMCHAN    = "474"
	ERR_BADCHANNELKEY     = "475"
	ERR_BADCHANMASK       = "476"
	ERR_NOCHANMODES       = "477"
	ERR_BANLISTFULL       = "478"
	ERR_NOPRIVILEGES      = "481"
	ERR_CHANOPRIVSNEEDED  = "482"
	ERR_CANTKILLSERVER    = "483"
	ERR_RESTRICTED        = "484"
	ERR_UNIQOPPRIVSNEEDED = "485"
	ERR_NOOPERHOST        = "491"
	ERR_UMODEUNKNOWNFLAG  = "501"
	ERR_USERSDONTMATCH    = "502"
)

Numeric IRC replies extracted from RFC 2812 section 5.

View Source
const (
	CAP       = "CAP"
	CAP_LS    = "LS"    // Subcommand (param)
	CAP_LIST  = "LIST"  // Subcommand (param)
	CAP_REQ   = "REQ"   // Subcommand (param)
	CAP_ACK   = "ACK"   // Subcommand (param)
	CAP_NAK   = "NAK"   // Subcommand (param)
	CAP_CLEAR = "CLEAR" // Subcommand (param)
	CAP_END   = "END"   // Subcommand (param)

	AUTHENTICATE = "AUTHENTICATE"
)

IRC commands extracted from the IRCv3 spec at http://www.ircv3.org/.

View Source
const (
	RPL_LOGGEDIN    = "900"
	RPL_LOGGEDOUT   = "901"
	RPL_NICKLOCKED  = "902"
	RPL_SASLSUCCESS = "903"
	ERR_SASLFAIL    = "904"
	ERR_SASLTOOLONG = "905"
	ERR_SASLABORTED = "906"
	ERR_SASLALREADY = "907"
	RPL_SASLMECHS   = "908"
)

Numeric IRC replies extracted from the IRCv3 spec.

View Source
const (
	RPL_STATSCLINE    = "213"
	RPL_STATSNLINE    = "214"
	RPL_STATSILINE    = "215"
	RPL_STATSKLINE    = "216"
	RPL_STATSQLINE    = "217"
	RPL_STATSYLINE    = "218"
	RPL_SERVICEINFO   = "231"
	RPL_ENDOFSERVICES = "232"
	RPL_SERVICE       = "233"
	RPL_STATSVLINE    = "240"
	RPL_STATSLLINE    = "241"
	RPL_STATSHLINE    = "244"
	RPL_STATSSLINE    = "245"
	RPL_STATSPING     = "246"
	RPL_STATSBLINE    = "247"
	RPL_STATSDLINE    = "250"
	RPL_NONE          = "300"
	RPL_WHOISCHANOP   = "316"
	RPL_KILLDONE      = "361"
	RPL_CLOSING       = "362"
	RPL_CLOSEEND      = "363"
	RPL_INFOSTART     = "373"
	RPL_MYPORTIS      = "384"
	ERR_NOSERVICEHOST = "492"
)

RFC 2812 section 5.3

View Source
const (
	ERR_TOOMANYMATCHES = "416" // Used on IRCNet
	RPL_TOPICWHOTIME   = "333" // From ircu, in use on Freenode
	RPL_LOCALUSERS     = "265" // From aircd, Hybrid, Hybrid, Bahamut, in use on Freenode
	RPL_GLOBALUSERS    = "266" // From aircd, Hybrid, Hybrid, Bahamut, in use on Freenode
)

Other constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Conn

type Conn struct {
	Encoder
	Decoder
	// contains filtered or unexported fields
}

A Conn represents an IRC network protocol connection. It consists of an Encoder and Decoder to manage I/O.

func Dial

func Dial(addr string) (*Conn, error)

Dial connects to the given address using net.Dial and then returns a new Conn for the connection.

Example

We use the Dial function as a simple shortcut for connecting to an IRC server using a standard TCP socket.

conn, err := Dial("irc.quakenet.org:6667")
if err != nil {
	log.Fatalln("Could not connect to IRC server")
}

conn.Close()
Output:

func DialTLS

func DialTLS(addr string, config *tls.Config) (*Conn, error)

DialTLS connects to the given address using tls.Dial and then returns a new Conn for the connection.

func NewConn

func NewConn(rwc io.ReadWriteCloser) *Conn

NewConn returns a new Conn using rwc for I/O.

Example

Use NewConn when you want to connect using something else than a standard TCP socket. This example first opens an encrypted TLS connection and then uses that to communicate with the server.

tconn, err := tls.Dial("tcp", "irc.quakenet.org:6667", &tls.Config{})
if err != nil {
	log.Fatalln("Could not connect to IRC server")
}
conn := NewConn(tconn)

conn.Close()
Output:

func (*Conn) Close

func (c *Conn) Close() error

Close closes the underlying ReadWriteCloser.

type Decoder

type Decoder struct {
	// contains filtered or unexported fields
}

A Decoder reads Message objects from an input stream.

func NewDecoder

func NewDecoder(r io.Reader) *Decoder

NewDecoder returns a new Decoder that reads from r.

func (*Decoder) Decode

func (dec *Decoder) Decode() (m *Message, err error)

Decode attempts to read a single Message from the stream.

Returns a non-nil error if the read failed.

type Encoder

type Encoder struct {
	// contains filtered or unexported fields
}

An Encoder writes Message objects to an output stream.

func NewEncoder

func NewEncoder(w io.Writer) *Encoder

NewEncoder returns a new Encoder that writes to w.

func (*Encoder) Encode

func (enc *Encoder) Encode(m *Message) (err error)

Encode writes the IRC encoding of m to the stream.

This method may be used from multiple goroutines.

Returns an non-nil error if the write to the underlying stream stopped early.

func (*Encoder) Write

func (enc *Encoder) Write(p []byte) (n int, err error)

Write writes len(p) bytes from p followed by CR+LF.

This method can be used simultaneously from multiple goroutines, it guarantees to serialize access. However, writing a single IRC message using multiple Write calls will cause corruption.

type Message

type Message struct {
	*Prefix
	Command string
	Params  []string
}

Message represents an IRC protocol message. See RFC1459 section 2.3.1.

<message>  ::= [':' <prefix> <SPACE> ] <command> <params> <crlf>
<prefix>   ::= <servername> | <nick> [ '!' <user> ] [ '@' <host> ]
<command>  ::= <letter> { <letter> } | <number> <number> <number>
<SPACE>    ::= ' ' { ' ' }
<params>   ::= <SPACE> [ ':' <trailing> | <middle> <params> ]

<middle>   ::= <Any *non-empty* sequence of octets not including SPACE
               or NUL or CR or LF, the first of which may not be ':'>
<trailing> ::= <Any, possibly *empty*, sequence of octets not including
               NUL or CR or LF>

<crlf>     ::= CR LF

func ParseMessage

func ParseMessage(raw string) (m *Message)

ParseMessage takes a string and attempts to create a Message struct. Returns nil if the Message is invalid.

Example
message := ParseMessage("JOIN #help")

fmt.Println(message.Params[0])
Output:

#help

func (*Message) Bytes

func (m *Message) Bytes() []byte

Bytes returns a []byte representation of this message.

As noted in rfc2812 section 2.3, messages should not exceed 512 characters in length. This method forces that limit by discarding any characters exceeding the length limit.

func (*Message) Len

func (m *Message) Len() (length int)

Len calculates the length of the string representation of this message.

func (*Message) Param

func (m *Message) Param(i int) string

Param returns the i'th parameter. Returns the empty string if the requested parameter does not exist.

func (*Message) String

func (m *Message) String() string

String returns a string representation of this message.

As noted in rfc2812 section 2.3, messages should not exceed 512 characters in length. This method forces that limit by discarding any characters exceeding the length limit.

Example
message := &Message{
	Prefix: &Prefix{
		Name: "sorcix",
		User: "sorcix",
		Host: "myhostname",
	},
	Command: "PRIVMSG",
	Params:  []string{"This is an example!"},
}

fmt.Println(message.String())
Output:

:sorcix!sorcix@myhostname PRIVMSG :This is an example!

func (*Message) Trailing

func (m *Message) Trailing() string

Trailing returns the last parameter. Returns the empty string if there are no parameters.

type Prefix

type Prefix struct {
	Name string // Nick- or servername
	User string // Username
	Host string // Hostname
}

Prefix represents the prefix (sender) of an IRC message. See RFC1459 section 2.3.1.

<servername> | <nick> [ '!' <user> ] [ '@' <host> ]

func ParsePrefix

func ParsePrefix(raw string) (p *Prefix)

ParsePrefix takes a string and attempts to create a Prefix struct.

func (*Prefix) Bytes

func (p *Prefix) Bytes() []byte

Bytes returns a []byte representation of this prefix.

func (*Prefix) IsHostmask

func (p *Prefix) IsHostmask() bool

IsHostmask returns true if this prefix looks like a user hostmask.

func (*Prefix) IsServer

func (p *Prefix) IsServer() bool

IsServer returns true if this prefix looks like a server name.

func (*Prefix) Len

func (p *Prefix) Len() (length int)

Len calculates the length of the string representation of this prefix.

func (*Prefix) String

func (p *Prefix) String() (s string)

String returns a string representation of this prefix.

type Sender

type Sender interface {
	Send(*Message) error
}

Sender represents objects that are able to send messages to an IRC server.

As there might be a message queue, it is possible that Send returns a nil error, but the message is not sent (yet). The error value is only used when it is certain that sending the message is impossible.

This interface is not used inside this package, and shouldn't have been defined here in the first place. For backwards compatibility only.

Directories

Path Synopsis
Package ctcp implements partial support for the Client-to-Client Protocol.
Package ctcp implements partial support for the Client-to-Client Protocol.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL