/*
goircd -- minimalistic simple Internet Relay Chat (IRC) server
-Copyright (C) 2014 Sergey Matveev <stargrave@stargrave.org>
+Copyright (C) 2014-2020 Sergey Matveev <stargrave@stargrave.org>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+the Free Software Foundation, version 3 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+
package main
import (
- "bytes"
"fmt"
- "io"
"log"
- "os"
- "regexp"
- "sort"
"strings"
"time"
)
const (
- PING_TIMEOUT = time.Second * 180 // Max time deadline for client's unresponsiveness
- PING_THRESHOLD = time.Second * 90 // Max idle client's time before PING are sent
- ALIVENESS_CHECK = time.Second * 10 // Client's aliveness check period
-)
-
-var (
- RE_NICKNAME = regexp.MustCompile("^[a-zA-Z0-9-]{1,9}$")
+ // Max deadline time of client's unresponsiveness
+ PingTimeout = time.Second * 180
+ // Max idle client's time before PING are sent
+ PingThreshold = time.Second * 90
)
-type Daemon struct {
- Verbose bool
- hostname string
- motd string
- clients map[*Client]bool
- rooms map[string]*Room
- room_sinks map[*Room]chan ClientEvent
- last_aliveness_check time.Time
- log_sink chan<- LogEvent
- state_sink chan<- StateEvent
-}
-
-func NewDaemon(hostname, motd string, log_sink chan<- LogEvent, state_sink chan<- StateEvent) *Daemon {
- daemon := Daemon{hostname: hostname, motd: motd}
- daemon.clients = make(map[*Client]bool)
- daemon.rooms = make(map[string]*Room)
- daemon.room_sinks = make(map[*Room]chan ClientEvent)
- daemon.log_sink = log_sink
- daemon.state_sink = state_sink
- return &daemon
-}
-
-func (daemon *Daemon) SendLusers(client *Client) {
- lusers := 0
- for client := range daemon.clients {
- if client.registered {
- lusers++
+func Processor(events chan ClientEvent, finished chan struct{}) {
+ var now time.Time
+ ticker := time.NewTicker(10 * time.Second)
+ go func() {
+ for range ticker.C {
+ events <- ClientEvent{eventType: EventTick}
}
- }
- client.ReplyNicknamed("251", fmt.Sprintf("There are %d users and 0 invisible on 1 servers", lusers))
-}
-
-func (daemon *Daemon) SendMotd(client *Client) {
- if daemon.motd != "" {
- fd, err := os.Open(daemon.motd)
- if err == nil {
- defer fd.Close()
- motd := []byte{}
- var err error
- for err != io.EOF {
- buf := make([]byte, 1024)
- _, err = fd.Read(buf)
- motd = append(motd, bytes.TrimRight(buf, "\x00")...)
- }
-
- client.ReplyNicknamed("375", "- "+daemon.hostname+" Message of the day -")
- for _, s := range bytes.Split(bytes.TrimRight(motd, "\n"), []byte("\n")) {
- client.ReplyNicknamed("372", "- "+string(s))
- }
- client.ReplyNicknamed("376", "End of /MOTD command")
- return
- } else {
- log.Println("Can not open motd file", daemon.motd, err)
- }
- }
- client.ReplyNicknamed("422", "MOTD File is missing")
-}
-
-func (daemon *Daemon) SendWhois(client *Client, nicknames []string) {
- for _, nickname := range nicknames {
- nickname = strings.ToLower(nickname)
- found := false
- for c := range daemon.clients {
- if strings.ToLower(c.nickname) != nickname {
- continue
- }
- found = true
- client.ReplyNicknamed("311", c.nickname, c.username, c.conn.RemoteAddr().String(), "*", c.realname)
- client.ReplyNicknamed("312", c.nickname, daemon.hostname, daemon.hostname)
- subscriptions := []string{}
- for _, room := range daemon.rooms {
- for subscriber := range room.members {
- if subscriber.nickname == nickname {
- subscriptions = append(subscriptions, room.name)
+ }()
+EventsCycle:
+ for e := range events {
+ now = time.Now()
+ client := e.client
+ switch e.eventType {
+ case EventTick:
+ clientsLock.RLock()
+ for c := range clients {
+ if c.recvTimestamp.Add(PingTimeout).Before(now) {
+ if *verbose {
+ log.Println(c, "ping timeout")
}
- }
- }
- sort.Strings(subscriptions)
- client.ReplyNicknamed("319", c.nickname, strings.Join(subscriptions, " "))
- client.ReplyNicknamed("318", c.nickname, "End of /WHOIS list")
- }
- if !found {
- client.ReplyNoNickChan(nickname)
- }
- }
-}
-
-func (daemon *Daemon) SendList(client *Client, cols []string) {
- var rooms []string
- if (len(cols) > 1) && (cols[1] != "") {
- rooms = strings.Split(strings.Split(cols[1], " ")[0], ",")
- } else {
- rooms = []string{}
- for room := range daemon.rooms {
- rooms = append(rooms, room)
- }
- }
- sort.Strings(rooms)
- for _, room := range rooms {
- r, found := daemon.rooms[room]
- if found {
- client.ReplyNicknamed("322", room, fmt.Sprintf("%d", len(r.members)), r.topic)
- }
- }
- client.ReplyNicknamed("323", "End of /LIST")
-}
-
-// Unregistered client workflow processor. Unregistered client:
-// * is not PINGed
-// * only QUIT, NICK and USER commands are processed
-// * other commands are quietly ignored
-// When client finishes NICK/USER workflow, then MOTD and LUSERS are send to him.
-func (daemon *Daemon) ClientRegister(client *Client, command string, cols []string) {
- switch command {
- case "NICK":
- if len(cols) == 1 || len(cols[1]) < 1 {
- client.ReplyParts("431", "No nickname given")
- return
- }
- nickname := cols[1]
- for client := range daemon.clients {
- if client.nickname == nickname {
- client.ReplyParts("433", "*", nickname, "Nickname is already in use")
- return
- }
- }
- if !RE_NICKNAME.MatchString(nickname) {
- client.ReplyParts("432", "*", cols[1], "Erroneous nickname")
- return
- }
- client.nickname = nickname
- case "USER":
- if len(cols) == 1 {
- client.ReplyNotEnoughParameters("USER")
- return
- }
- args := strings.SplitN(cols[1], " ", 4)
- if len(args) < 4 {
- client.ReplyNotEnoughParameters("USER")
- return
- }
- client.username = args[0]
- client.realname = strings.TrimLeft(args[3], ":")
- }
- if client.nickname != "*" && client.username != "" {
- client.registered = true
- client.ReplyNicknamed("001", "Hi, welcome to IRC")
- client.ReplyNicknamed("002", "Your host is "+daemon.hostname+", running goircd")
- client.ReplyNicknamed("003", "This server was created sometime")
- client.ReplyNicknamed("004", daemon.hostname+" goircd o o")
- daemon.SendLusers(client)
- daemon.SendMotd(client)
- }
-}
-
-// Register new room in Daemon. Create an object, events sink, save pointers
-// to corresponding daemon's places and start room's processor goroutine.
-func (daemon *Daemon) RoomRegister(name string) (*Room, chan<- ClientEvent) {
- room_new := NewRoom(daemon.hostname, name, daemon.log_sink, daemon.state_sink)
- room_new.Verbose = daemon.Verbose
- room_sink := make(chan ClientEvent)
- daemon.rooms[name] = room_new
- daemon.room_sinks[room_new] = room_sink
- go room_new.Processor(room_sink)
- return room_new, room_sink
-}
-
-func (daemon *Daemon) HandlerJoin(client *Client, cmd string) {
- args := strings.Split(cmd, " ")
- rooms := strings.Split(args[0], ",")
- var keys []string
- if len(args) > 1 {
- keys = strings.Split(args[1], ",")
- } else {
- keys = []string{}
- }
- for n, room := range rooms {
- if !RoomNameValid(room) {
- client.ReplyNoChannel(room)
- continue
- }
- var key string
- if (n < len(keys)) && (keys[n] != "") {
- key = keys[n]
- } else {
- key = ""
- }
- denied := false
- joined := false
- for room_existing, room_sink := range daemon.room_sinks {
- if room == room_existing.name {
- if (room_existing.key != "") && (room_existing.key != key) {
- denied = true
- } else {
- room_sink <- ClientEvent{client, EVENT_NEW, ""}
- joined = true
- }
- break
- }
- }
- if denied {
- client.ReplyNicknamed("475", room, "Cannot join channel (+k) - bad key")
- }
- if denied || joined {
- continue
- }
- room_new, room_sink := daemon.RoomRegister(room)
- if key != "" {
- room_new.key = key
- room_new.StateSave()
- }
- room_sink <- ClientEvent{client, EVENT_NEW, ""}
- }
-}
-
-func (daemon *Daemon) Processor(events <-chan ClientEvent) {
- for event := range events {
-
- // Check for clients aliveness
- now := time.Now()
- if daemon.last_aliveness_check.Add(ALIVENESS_CHECK).Before(now) {
- for c := range daemon.clients {
- if c.timestamp.Add(PING_TIMEOUT).Before(now) {
- log.Println(c, "ping timeout")
- c.conn.Close()
+ c.Close()
continue
}
- if !c.ping_sent && c.timestamp.Add(PING_THRESHOLD).Before(now) {
+ if c.sendTimestamp.Add(PingThreshold).Before(now) {
if c.registered {
- c.Msg("PING :" + daemon.hostname)
- c.ping_sent = true
+ c.Msg("PING :" + *hostname)
+ c.sendTimestamp = time.Now()
} else {
- log.Println(c, "ping timeout")
- c.conn.Close()
+ if *verbose {
+ log.Println(c, "ping timeout")
+ }
+ c.Close()
}
}
}
- daemon.last_aliveness_check = now
- }
-
- client := event.client
- switch event.event_type {
- case EVENT_NEW:
- daemon.clients[client] = true
- case EVENT_DEL:
- delete(daemon.clients, client)
- for _, room_sink := range daemon.room_sinks {
- room_sink <- event
+ clientsLock.RUnlock()
+ roomsLock.Lock()
+ for rn, r := range rooms {
+ if *statedir == "" && len(r.members) == 0 {
+ if *verbose {
+ log.Println(rn, "emptied room")
+ }
+ delete(rooms, rn)
+ close(r.events)
+ }
}
- case EVENT_MSG:
- cols := strings.SplitN(event.text, " ", 2)
- command := strings.ToUpper(cols[0])
- if daemon.Verbose {
- log.Println(client, "command", command)
+ roomsLock.Unlock()
+ case EventTerm:
+ break EventsCycle
+ case EventNew:
+ clientsLock.Lock()
+ clients[client] = struct{}{}
+ clientsLock.Unlock()
+ case EventDel:
+ clientsLock.Lock()
+ delete(clients, client)
+ clientsLock.Unlock()
+ roomsLock.RLock()
+ for _, r := range rooms {
+ r.events <- e
}
- if command == "QUIT" {
- delete(daemon.clients, client)
- client.conn.Close()
+ roomsLock.RUnlock()
+ case EventMsg:
+ cols := strings.SplitN(e.text, " ", 2)
+ cmd := strings.ToUpper(cols[0])
+ if *verbose {
+ log.Println(client, "command", cmd)
+ }
+ if cmd == "QUIT" {
+ client.Close()
+ if *verbose {
+ log.Println(client, "quit")
+ }
continue
}
if !client.registered {
- go daemon.ClientRegister(client, command, cols)
+ client.Register(cmd, cols)
continue
}
- switch command {
+ if client != nil {
+ client.recvTimestamp = now
+ }
+ switch cmd {
case "AWAY":
- continue
+ if len(cols) == 1 {
+ client.away = ""
+ client.ReplyNicknamed("305", "You are no longer marked as being away")
+ continue
+ }
+ client.away = strings.TrimLeft(cols[1], ":")
+ client.ReplyNicknamed("306", "You have been marked as being away")
case "JOIN":
if len(cols) == 1 || len(cols[1]) < 1 {
client.ReplyNotEnoughParameters("JOIN")
continue
}
- go daemon.HandlerJoin(client, cols[1])
+ client.Join(cols[1])
case "LIST":
- daemon.SendList(client, cols)
+ client.SendList(cols)
case "LUSERS":
- go daemon.SendLusers(client)
+ client.SendLusers()
case "MODE":
if len(cols) == 1 || len(cols[1]) < 1 {
client.ReplyNotEnoughParameters("MODE")
}
cols = strings.SplitN(cols[1], " ", 2)
if cols[0] == client.username {
- if len(cols) == 1 {
- client.Msg("221 " + client.nickname + " +")
- } else {
- client.ReplyNicknamed("501", "Unknown MODE flag")
- }
+ client.Msg("221 " + client.nickname + " +w")
+ // client.ReplyNicknamed("501", "Unknown MODE flag")
continue
}
room := cols[0]
- r, found := daemon.rooms[room]
+ r, found := rooms[room]
if !found {
client.ReplyNoChannel(room)
continue
}
if len(cols) == 1 {
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_MODE, ""}
+ r.events <- ClientEvent{client, EventMode, ""}
} else {
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_MODE, cols[1]}
+ r.events <- ClientEvent{client, EventMode, cols[1]}
}
case "MOTD":
- go daemon.SendMotd(client)
+ client.SendMotd()
+ case "NAMES":
+ rs := make([]*Room, len(cols))
+ roomsLock.RLock()
+ if len(cols) == 0 {
+ for _, r := range rooms {
+ rs = append(rs, r)
+ }
+ } else {
+ needed := make(map[string]struct{}, len(rs))
+ for _, r := range cols {
+ needed[r] = struct{}{}
+ }
+ for rn, r := range rooms {
+ if _, found := needed[rn]; found {
+ rs = append(rs, r)
+ }
+ }
+ }
+ roomsLock.RUnlock()
+ for _, r := range rs {
+ r.SendNames(client)
+ }
case "PART":
if len(cols) == 1 || len(cols[1]) < 1 {
client.ReplyNotEnoughParameters("PART")
continue
}
- for _, room := range strings.Split(cols[1], ",") {
- r, found := daemon.rooms[room]
- if !found {
+ rs := strings.Split(cols[1], " ")[0]
+ roomsLock.RLock()
+ for _, room := range strings.Split(rs, ",") {
+ if r, found := rooms[room]; found {
+ r.events <- ClientEvent{client, EventDel, ""}
+ } else {
client.ReplyNoChannel(room)
- continue
}
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_DEL, ""}
}
+ roomsLock.RUnlock()
case "PING":
if len(cols) == 1 {
client.ReplyNicknamed("409", "No origin specified")
continue
}
- client.Reply(fmt.Sprintf("PONG %s :%s", daemon.hostname, cols[1]))
+ client.Reply(fmt.Sprintf("PONG %s :%s", *hostname, cols[1]))
case "PONG":
continue
case "NOTICE", "PRIVMSG":
if len(cols) == 1 {
- client.ReplyNicknamed("411", "No recipient given ("+command+")")
+ client.ReplyNicknamed("411", "No recipient given ("+cmd+")")
continue
}
cols = strings.SplitN(cols[1], " ", 2)
client.ReplyNicknamed("412", "No text to send")
continue
}
- msg := ""
target := strings.ToLower(cols[0])
- for c := range daemon.clients {
- if c.nickname == target {
- msg = fmt.Sprintf(":%s %s %s :%s", client, command, c.nickname, cols[1])
- c.Msg(msg)
- break
+ roomsLock.RLock()
+ if r, found := rooms[target]; found {
+ r.events <- ClientEvent{
+ client,
+ EventMsg,
+ cmd + " " + strings.TrimLeft(cols[1], ":"),
}
+ roomsLock.RUnlock()
+ continue
}
+ roomsLock.RUnlock()
+ var msg string
+ clientsLock.RLock()
+ for c := range clients {
+ if c.nickname != target {
+ continue
+ }
+ msg = fmt.Sprintf(":%s %s %s %s", client, cmd, c.nickname, cols[1])
+ c.Msg(msg)
+ if c.away != "" {
+ client.ReplyNicknamed("301", c.nickname, c.away)
+ }
+ break
+ }
+ clientsLock.RUnlock()
if msg != "" {
continue
}
- r, found := daemon.rooms[target]
- if !found {
- client.ReplyNoNickChan(target)
- }
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_MSG, command + " " + strings.TrimLeft(cols[1], ":")}
+ client.ReplyNoNickChan(target)
case "TOPIC":
if len(cols) == 1 {
client.ReplyNotEnoughParameters("TOPIC")
continue
}
cols = strings.SplitN(cols[1], " ", 2)
- r, found := daemon.rooms[cols[0]]
+ r, found := rooms[cols[0]]
if !found {
client.ReplyNoChannel(cols[0])
continue
var change string
if len(cols) > 1 {
change = cols[1]
- } else {
- change = ""
}
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_TOPIC, change}
+ r.events <- ClientEvent{client, EventTopic, change}
case "WHO":
if len(cols) == 1 || len(cols[1]) < 1 {
client.ReplyNotEnoughParameters("WHO")
continue
}
room := strings.Split(cols[1], " ")[0]
- r, found := daemon.rooms[room]
- if !found {
+ r, found := rooms[room]
+ if found {
+ r.events <- ClientEvent{client, EventWho, ""}
+ } else {
client.ReplyNoChannel(room)
- continue
}
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_WHO, ""}
case "WHOIS":
if len(cols) == 1 || len(cols[1]) < 1 {
client.ReplyNotEnoughParameters("WHOIS")
}
cols := strings.Split(cols[1], " ")
nicknames := strings.Split(cols[len(cols)-1], ",")
- go daemon.SendWhois(client, nicknames)
+ client.SendWhois(nicknames)
+ case "ISON":
+ if len(cols) == 1 || len(cols[1]) < 1 {
+ client.ReplyNotEnoughParameters("ISON")
+ continue
+ }
+ nicknamesList := strings.Split(cols[1], " ")
+ nicknames := make(map[string]bool, len(nicknamesList))
+ for _, nickname := range nicknamesList {
+ nicknames[nickname] = false
+ }
+ clientsLock.RLock()
+ for c := range clients {
+ if _, exists := nicknames[c.nickname]; exists {
+ nicknames[c.nickname] = true
+ }
+ }
+ clientsLock.RUnlock()
+ nicknamesList = nicknamesList[:0]
+ for n, exists := range nicknames {
+ if exists {
+ nicknamesList = append(nicknamesList, n)
+ }
+ }
+ client.ReplyNicknamed("303", strings.Join(nicknamesList, " "))
+ case "WALLOPS":
+ if len(cols) == 1 {
+ client.ReplyNotEnoughParameters("WALLOPS")
+ continue
+ }
+ cs := make([]*Client, 0, len(clients))
+ clientsLock.RLock()
+ for c := range clients {
+ if c != client {
+ cs = append(cs, c)
+ }
+ }
+ clientsLock.RUnlock()
+ for _, c := range cs {
+ c.Msg(fmt.Sprintf(":%s NOTICE %s %s", client, c.nickname, cols[1]))
+ }
+ case "VERSION":
+ var debug string
+ if *verbose {
+ debug = "debug"
+ }
+ client.ReplyNicknamed("351", fmt.Sprintf("%s.%s %s :", Version, debug, *hostname))
default:
- client.ReplyNicknamed("421", command, "Unknown command")
+ client.ReplyNicknamed("421", cmd, "Unknown command")
}
}
}
+ ticker.Stop()
+
+ // Notify all clients about shutdown
+ clientsLock.RLock()
+ for c := range clients {
+ c.Msg(fmt.Sprintf(
+ ":%s NOTICE %s %s", *hostname, c.nickname,
+ ":Server is shutting down",
+ ))
+ c.Close()
+ }
+ clientsLock.RUnlock()
+
+ // Read their EventDel
+ go func() {
+ for range events {
+ }
+ }()
+
+ // Stop room processors
+ roomsLock.RLock()
+ for _, r := range rooms {
+ r.events <- ClientEvent{eventType: EventTerm}
+ }
+ roomsLock.RUnlock()
+ roomsWG.Wait()
+
+ // Wait for either 5sec or all clients quitting
+ t := time.NewTimer(5 * time.Second)
+ clientsDone := make(chan struct{})
+ go func() {
+ clientsWG.Wait()
+ close(clientsDone)
+ }()
+ select {
+ case <-t.C:
+ case <-clientsDone:
+ }
+ if !t.Stop() {
+ <-t.C
+ }
+ close(events)
+ close(finished)
}