123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464 |
- // Copyright (c) 2012-2014 Jeremy Latt
- // Copyright (c) 2014-2015 Edmund Huber
- // Copyright (c) 2016- Daniel Oaks <daniel@danieloaks.net>
- // released under the MIT license
-
- package irc
-
- import (
- "fmt"
- "log"
- "net"
- "runtime/debug"
- "strconv"
- "time"
-
- "github.com/DanielOaks/girc-go/ircmsg"
- "github.com/DanielOaks/go-ident"
- )
-
- const (
- IDLE_TIMEOUT = time.Minute + time.Second*30 // how long before a client is considered idle
- QUIT_TIMEOUT = time.Minute // how long after idle before a client is kicked
- IdentTimeoutSeconds = 8
- )
-
- var (
- TIMEOUT_STATED_SECONDS = strconv.Itoa(int((IDLE_TIMEOUT + QUIT_TIMEOUT).Seconds()))
- )
-
- // Client is an IRC client.
- type Client struct {
- account *ClientAccount
- atime time.Time
- authorized bool
- awayMessage string
- capabilities CapabilitySet
- capState CapState
- capVersion CapVersion
- certfp string
- channels ChannelSet
- class *OperClass
- ctime time.Time
- flags map[UserMode]bool
- isDestroyed bool
- isQuitting bool
- hasQuit bool
- hops int
- hostname string
- rawHostname string
- vhost string
- idleTimer *time.Timer
- monitoring map[string]bool
- nick string
- nickCasefolded string
- nickMaskString string // cache for nickmask string since it's used with lots of replies
- nickMaskCasefolded string
- operName string
- quitTimer *time.Timer
- realname string
- registered bool
- saslInProgress bool
- saslMechanism string
- saslValue string
- server *Server
- socket *Socket
- username string
- whoisLine string
- }
-
- // NewClient returns a client with all the appropriate info setup.
- func NewClient(server *Server, conn net.Conn, isTLS bool) *Client {
- now := time.Now()
- socket := NewSocket(conn)
- client := &Client{
- atime: now,
- authorized: server.password == nil,
- capabilities: make(CapabilitySet),
- capState: CapNone,
- capVersion: Cap301,
- channels: make(ChannelSet),
- ctime: now,
- flags: make(map[UserMode]bool),
- monitoring: make(map[string]bool),
- server: server,
- socket: &socket,
- account: &NoAccount,
- nick: "*", // * is used until actual nick is given
- nickCasefolded: "*",
- nickMaskString: "*", // * is used until actual nick is given
- }
- if isTLS {
- client.flags[TLS] = true
-
- // error is not useful to us here anyways so we can ignore it
- client.certfp, _ = client.socket.CertFP()
- }
- if server.checkIdent {
- _, serverPortString, err := net.SplitHostPort(conn.LocalAddr().String())
- serverPort, _ := strconv.Atoi(serverPortString)
- if err != nil {
- log.Fatal(err)
- }
- clientHost, clientPortString, err := net.SplitHostPort(conn.RemoteAddr().String())
- clientPort, _ := strconv.Atoi(clientPortString)
- if err != nil {
- log.Fatal(err)
- }
-
- client.Notice("*** Looking up your username")
- resp, err := ident.Query(clientHost, serverPort, clientPort, IdentTimeoutSeconds)
- if err == nil {
- username := resp.Identifier
- _, err := CasefoldName(username) // ensure it's a valid username
- if err == nil {
- client.Notice("*** Found your username")
- client.username = username
- // we don't need to updateNickMask here since nickMask is not used for anything yet
- } else {
- client.Notice("*** Got a malformed username, ignoring")
- }
- } else {
- client.Notice("*** Could not find your username")
- }
- }
- client.Touch()
- go client.run()
-
- return client
- }
-
- //
- // command goroutine
- //
-
- func (client *Client) run() {
- var err error
- var isExiting bool
- var line string
- var msg ircmsg.IrcMessage
-
- // Set the hostname for this client
- client.rawHostname = AddrLookupHostname(client.socket.conn.RemoteAddr())
-
- //TODO(dan): Make this a socketreactor from ircbnc
- for {
- line, err = client.socket.Read()
- if err != nil {
- client.Quit("connection closed")
- break
- }
-
- msg, err = ircmsg.ParseLine(line)
- if err != nil {
- client.Quit("received malformed line")
- break
- }
-
- cmd, exists := Commands[msg.Command]
- if !exists {
- client.Send(nil, client.server.name, ERR_UNKNOWNCOMMAND, client.nick, msg.Command, "Unknown command")
- continue
- }
-
- isExiting = cmd.Run(client.server, client, msg)
- if isExiting || client.isQuitting {
- break
- }
- }
-
- // ensure client connection gets closed
- client.destroy()
- }
-
- //
- // quit timer goroutine
- //
-
- func (client *Client) connectionTimeout() {
- client.Quit(fmt.Sprintf("Ping timeout: %s seconds", TIMEOUT_STATED_SECONDS))
- client.isQuitting = true
- }
-
- //
- // idle timer goroutine
- //
-
- func (client *Client) connectionIdle() {
- client.server.idle <- client
- }
-
- //
- // server goroutine
- //
-
- // Active marks the client as 'active' (i.e. the user should be there).
- func (client *Client) Active() {
- client.atime = time.Now()
- }
-
- // Touch marks the client as alive.
- func (client *Client) Touch() {
- if client.quitTimer != nil {
- client.quitTimer.Stop()
- }
-
- if client.idleTimer == nil {
- client.idleTimer = time.AfterFunc(IDLE_TIMEOUT, client.connectionIdle)
- } else {
- client.idleTimer.Reset(IDLE_TIMEOUT)
- }
- }
-
- // Idle resets the timeout handlers and sends the client a PING.
- func (client *Client) Idle() {
- client.Send(nil, "", "PING", client.nick)
-
- if client.quitTimer == nil {
- client.quitTimer = time.AfterFunc(QUIT_TIMEOUT, client.connectionTimeout)
- } else {
- client.quitTimer.Reset(QUIT_TIMEOUT)
- }
- }
-
- // Register sets the client details as appropriate when entering the network.
- func (client *Client) Register() {
- if client.registered {
- return
- }
- client.registered = true
- client.Touch()
-
- client.updateNickMask()
- client.alertMonitors()
- }
-
- // IdleTime returns how long this client's been idle.
- func (client *Client) IdleTime() time.Duration {
- return time.Since(client.atime)
- }
-
- // SignonTime returns this client's signon time as a unix timestamp.
- func (client *Client) SignonTime() int64 {
- return client.ctime.Unix()
- }
-
- // IdleSeconds returns the number of seconds this client's been idle.
- func (client *Client) IdleSeconds() uint64 {
- return uint64(client.IdleTime().Seconds())
- }
-
- // HasNick returns true if the client's nickname is set (used in registration).
- func (client *Client) HasNick() bool {
- return client.nick != "" && client.nick != "*"
- }
-
- // HasNick returns true if the client's username is set (used in registration).
- func (client *Client) HasUsername() bool {
- return client.username != "" && client.username != "*"
- }
-
- // HasCapabs returns true if client has the given (role) capabilities.
- func (client *Client) HasCapabs(capabs ...string) bool {
- if client.class == nil {
- return false
- }
-
- for _, capab := range capabs {
- if !client.class.Capabilities[capab] {
- return false
- }
- }
-
- return true
- }
-
- // <mode>
- func (c *Client) ModeString() (str string) {
- str = "+"
-
- for flag := range c.flags {
- str += flag.String()
- }
-
- return
- }
-
- // Friends refers to clients that share a channel with this client.
- func (client *Client) Friends(Capabilities ...Capability) ClientSet {
- friends := make(ClientSet)
- friends.Add(client)
- for channel := range client.channels {
- for member := range channel.members {
- // make sure they have all the required caps
- for _, Cap := range Capabilities {
- if !member.capabilities[Cap] {
- continue
- }
- }
- friends.Add(member)
- }
- }
- return friends
- }
-
- // updateNick updates the casefolded nickname.
- func (client *Client) updateNick() {
- casefoldedName, err := CasefoldName(client.nick)
- if err != nil {
- log.Println(fmt.Sprintf("ERROR: Nick [%s] couldn't be casefolded... this should never happen. Printing stacktrace.", client.nick))
- debug.PrintStack()
- }
- client.nickCasefolded = casefoldedName
- }
-
- // updateNickMask updates the casefolded nickname and nickmask.
- func (client *Client) updateNickMask() {
- client.updateNick()
-
- if len(client.vhost) > 0 {
- client.hostname = client.vhost
- } else {
- client.hostname = client.rawHostname
- }
-
- client.nickMaskString = fmt.Sprintf("%s!%s@%s", client.nick, client.username, client.hostname)
-
- nickMaskCasefolded, err := Casefold(client.nickMaskString)
- if err != nil {
- log.Println(fmt.Sprintf("ERROR: Nickmask [%s] couldn't be casefolded... this should never happen. Printing stacktrace.", client.nickMaskString))
- debug.PrintStack()
- }
- client.nickMaskCasefolded = nickMaskCasefolded
- }
-
- // SetNickname sets the very first nickname for the client.
- func (client *Client) SetNickname(nickname string) {
- if client.HasNick() {
- Log.error.Printf("%s nickname already set!", client.nickMaskString)
- return
- }
- client.nick = nickname
- client.updateNick()
- client.server.clients.Add(client)
- }
-
- // ChangeNickname changes the existing nickname of the client.
- func (client *Client) ChangeNickname(nickname string) {
- origNickMask := client.nickMaskString
- client.server.clients.Remove(client)
- client.server.whoWas.Append(client)
- client.nick = nickname
- client.updateNickMask()
- client.server.clients.Add(client)
- for friend := range client.Friends() {
- friend.Send(nil, origNickMask, "NICK", nickname)
- }
- }
-
- func (client *Client) Quit(message string) {
- client.Send(nil, client.nickMaskString, "QUIT", message)
- client.Send(nil, client.nickMaskString, "ERROR", message)
- }
-
- // destroy gets rid of a client, removes them from server lists etc.
- func (client *Client) destroy() {
- if client.isDestroyed {
- return
- }
-
- client.isDestroyed = true
- client.server.whoWas.Append(client)
- friends := client.Friends()
- friends.Remove(client)
-
- // remove from connection limits
- ipaddr := net.ParseIP(IPString(client.socket.conn.RemoteAddr()))
- // this check shouldn't be required but eh
- if ipaddr != nil {
- client.server.connectionLimitsMutex.Lock()
- client.server.connectionLimits.RemoveClient(ipaddr)
- client.server.connectionLimitsMutex.Unlock()
- }
-
- // remove from opers list
- _, exists := client.server.currentOpers[client]
- if exists {
- delete(client.server.currentOpers, client)
- }
-
- // alert monitors
- for _, mClient := range client.server.monitoring[client.nickCasefolded] {
- mClient.Send(nil, client.server.name, RPL_MONOFFLINE, mClient.nick, client.nick)
- }
-
- // remove my monitors
- client.clearMonitorList()
-
- // clean up channels
- for channel := range client.channels {
- channel.Quit(client)
- }
-
- // clean up server
- client.server.clients.Remove(client)
-
- // clean up self
- if client.idleTimer != nil {
- client.idleTimer.Stop()
- }
- if client.quitTimer != nil {
- client.quitTimer.Stop()
- }
-
- client.socket.Close()
- for friend := range client.Friends() {
- //TODO(dan): store quit message in user, if exists use that instead here
- friend.Send(nil, client.nickMaskString, "QUIT", "Exited")
- }
- }
-
- // SendFromClient sends an IRC line coming from a specific client.
- // Adds account-tag to the line as well.
- func (client *Client) SendFromClient(from *Client, tags *map[string]ircmsg.TagValue, prefix string, command string, params ...string) error {
- // attach account-tag
- if client.capabilities[AccountTag] && from.account != &NoAccount {
- if tags == nil {
- tags = ircmsg.MakeTags("account", from.account.Name)
- } else {
- (*tags)["account"] = ircmsg.MakeTagValue(from.account.Name)
- }
- }
-
- return client.Send(tags, prefix, command, params...)
- }
-
- // Send sends an IRC line to the client.
- func (client *Client) Send(tags *map[string]ircmsg.TagValue, prefix string, command string, params ...string) error {
- // attach server-time
- if client.capabilities[ServerTime] {
- if tags == nil {
- tags = ircmsg.MakeTags("time", time.Now().Format("2006-01-02T15:04:05.999Z"))
- } else {
- (*tags)["time"] = ircmsg.MakeTagValue(time.Now().Format("2006-01-02T15:04:05.999Z"))
- }
- }
-
- // send out the message
- message := ircmsg.MakeMessage(tags, prefix, command, params...)
- line, err := message.Line()
- if err != nil {
- // try not to fail quietly - especially useful when running tests, as a note to dig deeper
- message = ircmsg.MakeMessage(nil, client.server.name, ERR_UNKNOWNERROR, "*", "Error assembling message for sending")
- line, _ := message.Line()
- client.socket.Write(line)
- return err
- }
- client.socket.Write(line)
- return nil
- }
-
- // Notice sends the client a notice from the server.
- func (client *Client) Notice(text string) {
- client.Send(nil, client.server.name, "NOTICE", client.nick, text)
- }
|