/*
goircd -- minimalistic simple Internet Relay Chat (IRC) server
-Copyright (C) 2014 Sergey Matveev <stargrave@stargrave.org>
+Copyright (C) 2014-2016 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
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"
+ "io/ioutil"
"log"
- "os"
+ "net"
"regexp"
"sort"
"strings"
+ "sync"
"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
+ // Max deadline time of client's unresponsiveness
+ PingTimeout = time.Second * 180
+ // Max idle client's time before PING are sent
+ PingThreshold = time.Second * 90
)
var (
- RE_NICKNAME = regexp.MustCompile("^[a-zA-Z0-9-]{1,9}$")
-)
+ RENickname = regexp.MustCompile("^[a-zA-Z0-9-]{1,24}$")
-type Daemon struct {
- 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
-}
+ clients map[*Client]struct{} = make(map[*Client]struct{})
+ clientsM sync.RWMutex
+ rooms map[string]*Room = make(map[string]*Room)
+ roomsM sync.RWMutex
+ roomsGroup sync.WaitGroup
+ roomSinks map[*Room]chan ClientEvent = make(map[*Room]chan ClientEvent)
+)
-func (daemon *Daemon) SendLusers(client *Client) {
+func SendLusers(client *Client) {
lusers := 0
- for client := range daemon.clients {
+ clientsM.RLock()
+ for client := range clients {
if client.registered {
lusers++
}
}
+ clientsM.RUnlock()
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)
- }
+func SendMotd(client *Client) {
+ if motd == nil {
+ client.ReplyNicknamed("422", "MOTD File is missing")
+ return
+ }
+ motdText, err := ioutil.ReadFile(*motd)
+ if err != nil {
+ log.Printf("Can not read motd file %s: %v", *motd, err)
+ client.ReplyNicknamed("422", "Error reading MOTD File")
+ return
+ }
+ client.ReplyNicknamed("375", "- "+*hostname+" Message of the day -")
+ for _, s := range strings.Split(strings.TrimSuffix(string(motdText), "\n"), "\n") {
+ client.ReplyNicknamed("372", "- "+s)
}
- client.ReplyNicknamed("422", "MOTD File is missing")
+ client.ReplyNicknamed("376", "End of /MOTD command")
}
-func (daemon *Daemon) SendWhois(client *Client, nicknames []string) {
+func SendWhois(client *Client, nicknames []string) {
+ var c *Client
+ var hostPort string
+ var err error
+ var subscriptions []string
+ var room *Room
+ var subscriber *Client
for _, nickname := range nicknames {
nickname = strings.ToLower(nickname)
- found := false
- for c := range daemon.clients {
- if c.nickname != nickname {
- continue
+ clientsM.RLock()
+ for c = range clients {
+ if strings.ToLower(*c.nickname) == nickname {
+ clientsM.RUnlock()
+ goto Found
}
- 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)
- }
+ }
+ clientsM.RUnlock()
+ client.ReplyNoNickChan(nickname)
+ continue
+ Found:
+ hostPort, _, err = net.SplitHostPort(c.conn.RemoteAddr().String())
+ if err != nil {
+ log.Printf("Can't parse RemoteAddr %q: %v", hostPort, err)
+ hostPort = "Unknown"
+ }
+ client.ReplyNicknamed("311", *c.nickname, *c.username, hostPort, "*", *c.realname)
+ client.ReplyNicknamed("312", *c.nickname, *hostname, *hostname)
+ if c.away != nil {
+ client.ReplyNicknamed("301", *c.nickname, *c.away)
+ }
+ subscriptions = make([]string, 0)
+ roomsM.RLock()
+ for _, room = range rooms {
+ for subscriber = range room.members {
+ if *subscriber.nickname == nickname {
+ subscriptions = append(subscriptions, *room.name)
}
}
- 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)
}
+ roomsM.RUnlock()
+ sort.Strings(subscriptions)
+ client.ReplyNicknamed("319", *c.nickname, strings.Join(subscriptions, " "))
+ client.ReplyNicknamed("318", *c.nickname, "End of /WHOIS list")
}
}
-func (daemon *Daemon) SendList(client *Client, cols []string) {
- var rooms []string
+func SendList(client *Client, cols []string) {
+ var rs []string
+ var r string
if (len(cols) > 1) && (cols[1] != "") {
- rooms = strings.Split(strings.Split(cols[1], " ")[0], ",")
+ rs = strings.Split(strings.Split(cols[1], " ")[0], ",")
} else {
- rooms = []string{}
- for room := range daemon.rooms {
- rooms = append(rooms, room)
+ rs = make([]string, 0)
+ roomsM.RLock()
+ for r = range rooms {
+ rs = append(rs, r)
}
+ roomsM.RUnlock()
}
- 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)
+ sort.Strings(rs)
+ var room *Room
+ var found bool
+ for _, r = range rs {
+ roomsM.RLock()
+ if room, found = rooms[r]; found {
+ client.ReplyNicknamed(
+ "322",
+ r,
+ fmt.Sprintf("%d", len(room.members)),
+ *room.topic,
+ )
}
+ roomsM.RUnlock()
}
client.ReplyNicknamed("323", "End of /LIST")
}
// * 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 {
+func ClientRegister(client *Client, cmd string, cols []string) {
+ switch cmd {
+ case "PASS":
+ if len(cols) == 1 || len(cols[1]) < 1 {
+ client.ReplyNotEnoughParameters("PASS")
+ return
+ }
+ client.password = &cols[1]
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 {
+ // Compatibility with some clients prepending colons to nickname
+ nickname = strings.TrimPrefix(nickname, ":")
+ nickname = strings.ToLower(nickname)
+ clientsM.RLock()
+ for existingClient := range clients {
+ if *existingClient.nickname == nickname {
+ clientsM.RUnlock()
client.ReplyParts("433", "*", nickname, "Nickname is already in use")
return
}
}
- if !RE_NICKNAME.MatchString(nickname) {
+ clientsM.RUnlock()
+ if !RENickname.MatchString(nickname) {
client.ReplyParts("432", "*", cols[1], "Erroneous nickname")
return
}
- client.nickname = nickname
+ client.nickname = &nickname
case "USER":
if len(cols) == 1 {
client.ReplyNotEnoughParameters("USER")
client.ReplyNotEnoughParameters("USER")
return
}
- client.username = args[0]
- client.realname = strings.TrimLeft(args[3], ":")
+ client.username = &args[0]
+ realname := strings.TrimLeft(args[3], ":")
+ client.realname = &realname
}
- if client.nickname != "*" && client.username != "" {
+ if *client.nickname != "*" && *client.username != "" {
+ if passwords != nil && *passwords != "" {
+ if client.password == nil {
+ client.ReplyParts("462", "You may not register")
+ client.Close()
+ return
+ }
+ contents, err := ioutil.ReadFile(*passwords)
+ if err != nil {
+ log.Fatalf("Can no read passwords file %s: %s", *passwords, err)
+ return
+ }
+ for _, entry := range strings.Split(string(contents), "\n") {
+ if entry == "" {
+ continue
+ }
+ if lp := strings.Split(entry, ":"); lp[0] == *client.nickname && lp[1] != *client.password {
+ client.ReplyParts("462", "You may not register")
+ client.Close()
+ return
+ }
+ }
+ }
client.registered = true
client.ReplyNicknamed("001", "Hi, welcome to IRC")
- client.ReplyNicknamed("002", "Your host is "+daemon.hostname+", running goircd")
+ client.ReplyNicknamed("002", "Your host is "+*hostname+", running goircd "+version)
client.ReplyNicknamed("003", "This server was created sometime")
- client.ReplyNicknamed("004", daemon.hostname+" goircd o o")
- daemon.SendLusers(client)
- daemon.SendMotd(client)
+ client.ReplyNicknamed("004", *hostname+" goircd o o")
+ SendLusers(client)
+ SendMotd(client)
+ log.Println(client, "logged in")
}
}
// 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_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 RoomRegister(name string) (*Room, chan ClientEvent) {
+ roomNew := NewRoom(name)
+ roomSink := make(chan ClientEvent)
+ roomsM.Lock()
+ rooms[name] = roomNew
+ roomSinks[roomNew] = roomSink
+ roomsM.Unlock()
+ go roomNew.Processor(roomSink)
+ roomsGroup.Add(1)
+ return roomNew, roomSink
}
-func (daemon *Daemon) HandlerJoin(client *Client, cmd string) {
+func HandlerJoin(client *Client, cmd string) {
args := strings.Split(cmd, " ")
- rooms := strings.Split(args[0], ",")
+ rs := strings.Split(args[0], ",")
var keys []string
if len(args) > 1 {
keys = strings.Split(args[1], ",")
} else {
- keys = []string{}
+ keys = make([]string, 0)
}
- for n, room := range rooms {
+ var roomExisting *Room
+ var roomSink chan ClientEvent
+ var roomNew *Room
+ for n, room := range rs {
if !RoomNameValid(room) {
client.ReplyNoChannel(room)
continue
} 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
+ roomsM.RLock()
+ for roomExisting, roomSink = range roomSinks {
+ if room == *roomExisting.name {
+ roomsM.RUnlock()
+ if (*roomExisting.key != "") && (*roomExisting.key != key) {
+ goto Denied
}
- break
+ roomSink <- ClientEvent{client, EventNew, ""}
+ goto Joined
}
}
- if denied {
- client.ReplyNicknamed("475", room, "Cannot join channel (+k) - bad key")
- continue
- }
- if denied || joined {
- continue
- }
- room_new, room_sink := daemon.RoomRegister(room)
+ roomsM.RUnlock()
+ roomNew, roomSink = RoomRegister(room)
+ log.Println("Room", roomNew, "created")
if key != "" {
- room_new.key = key
+ roomNew.key = &key
+ roomNew.StateSave()
}
- room_sink <- ClientEvent{client, EVENT_NEW, ""}
+ roomSink <- ClientEvent{client, EventNew, ""}
+ continue
+ Denied:
+ client.ReplyNicknamed("475", room, "Cannot join channel (+k) - bad key")
+ Joined:
}
}
-func (daemon *Daemon) Processor(events chan ClientEvent) {
+func Processor(events chan ClientEvent, finished chan struct{}) {
+ var now time.Time
+ go func() {
+ for {
+ time.Sleep(10 * time.Second)
+ events <- ClientEvent{eventType: EventTick}
+ }
+ }()
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) {
+ now = time.Now()
+ client := event.client
+ switch event.eventType {
+ case EventTick:
+ clientsM.RLock()
+ for c := range clients {
+ if c.recvTimestamp.Add(PingTimeout).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()
+ 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
+ clientsM.RUnlock()
+ roomsM.Lock()
+ for rn, r := range rooms {
+ if *statedir == "" && len(r.members) == 0 {
+ log.Println(rn, "emptied room")
+ delete(rooms, rn)
+ close(roomSinks[r])
+ delete(roomSinks, r)
+ }
+ }
+ roomsM.Unlock()
+ case EventTerm:
+ roomsM.RLock()
+ for _, sink := range roomSinks {
+ sink <- ClientEvent{eventType: EventTerm}
+ }
+ roomsM.RUnlock()
+ roomsGroup.Wait()
+ close(finished)
+ return
+ case EventNew:
+ clientsM.Lock()
+ clients[client] = struct{}{}
+ clientsM.Unlock()
+ case EventDel:
+ clientsM.Lock()
+ delete(clients, client)
+ clientsM.Unlock()
+ roomsM.RLock()
+ for _, roomSink := range roomSinks {
+ roomSink <- event
}
- case EVENT_MSG:
+ roomsM.RUnlock()
+ case EventMsg:
cols := strings.SplitN(event.text, " ", 2)
- command := strings.ToUpper(cols[0])
- log.Println(client, "command", command)
- if command == "QUIT" {
- delete(daemon.clients, client)
- client.conn.Close()
+ cmd := strings.ToUpper(cols[0])
+ if *verbose {
+ log.Println(client, "command", cmd)
+ }
+ if cmd == "QUIT" {
+ log.Println(client, "quit")
+ client.Close()
continue
}
if !client.registered {
- go daemon.ClientRegister(client, command, cols)
+ ClientRegister(client, cmd, cols)
continue
}
- switch command {
+ if client != nil {
+ client.recvTimestamp = now
+ }
+ switch cmd {
case "AWAY":
- continue
+ if len(cols) == 1 {
+ client.away = nil
+ client.ReplyNicknamed("305", "You are no longer marked as being away")
+ continue
+ }
+ msg := strings.TrimLeft(cols[1], ":")
+ client.away = &msg
+ 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])
+ HandlerJoin(client, cols[1])
case "LIST":
- daemon.SendList(client, cols)
+ SendList(client, cols)
case "LUSERS":
- go daemon.SendLusers(client)
+ SendLusers(client)
case "MODE":
if len(cols) == 1 || len(cols[1]) < 1 {
client.ReplyNotEnoughParameters("MODE")
continue
}
cols = strings.SplitN(cols[1], " ", 2)
- if cols[0] == client.username {
+ if cols[0] == *client.username {
if len(cols) == 1 {
- client.Msg("221 " + client.nickname + " +")
+ client.Msg("221 " + *client.nickname + " +")
} else {
client.ReplyNicknamed("501", "Unknown MODE flag")
}
continue
}
room := cols[0]
- r, found := daemon.rooms[room]
+ roomsM.RLock()
+ r, found := rooms[room]
if !found {
client.ReplyNoChannel(room)
+ roomsM.RUnlock()
continue
}
if len(cols) == 1 {
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_MODE, ""}
+ roomSinks[r] <- ClientEvent{client, EventMode, ""}
} else {
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_MODE, cols[1]}
+ roomSinks[r] <- ClientEvent{client, EventMode, cols[1]}
}
+ roomsM.RUnlock()
case "MOTD":
- go daemon.SendMotd(client)
+ SendMotd(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]
+ roomsM.RLock()
+ for _, room := range strings.Split(rs, ",") {
+ if r, found := rooms[room]; found {
+ roomSinks[r] <- ClientEvent{client, EventDel, ""}
+ } else {
+ roomsM.RUnlock()
client.ReplyNoChannel(room)
+ continue
}
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_DEL, ""}
}
+ roomsM.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)
}
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])
+ clientsM.RLock()
+ for c := range clients {
+ if *c.nickname == target {
+ msg = fmt.Sprintf(":%s %s %s %s", client, cmd, *c.nickname, cols[1])
c.Msg(msg)
+ if c.away != nil {
+ client.ReplyNicknamed("301", *c.nickname, *c.away)
+ }
break
}
}
+ clientsM.RUnlock()
if msg != "" {
continue
}
- r, found := daemon.rooms[target]
- if !found {
+ roomsM.RLock()
+ if r, found := rooms[target]; found {
+ roomSinks[r] <- ClientEvent{
+ client,
+ EventMsg,
+ cmd + " " + strings.TrimLeft(cols[1], ":"),
+ }
+ } else {
client.ReplyNoNickChan(target)
}
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_MSG, command + " " + strings.TrimLeft(cols[1], ":")}
+ roomsM.RUnlock()
case "TOPIC":
if len(cols) == 1 {
client.ReplyNotEnoughParameters("TOPIC")
continue
}
cols = strings.SplitN(cols[1], " ", 2)
- r, found := daemon.rooms[cols[0]]
+ roomsM.RLock()
+ r, found := rooms[cols[0]]
+ roomsM.RUnlock()
if !found {
client.ReplyNoChannel(cols[0])
+ continue
}
var change string
if len(cols) > 1 {
} else {
change = ""
}
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_TOPIC, change}
+ roomsM.RLock()
+ roomSinks[r] <- ClientEvent{client, EventTopic, change}
+ roomsM.RUnlock()
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 {
+ roomsM.RLock()
+ if r, found := rooms[room]; found {
+ roomSinks[r] <- ClientEvent{client, EventWho, ""}
+ } else {
client.ReplyNoChannel(room)
}
- daemon.room_sinks[r] <- ClientEvent{client, EVENT_WHO, ""}
+ roomsM.RUnlock()
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)
+ SendWhois(client, nicknames)
+ case "ISON":
+ if len(cols) == 1 || len(cols[1]) < 1 {
+ client.ReplyNotEnoughParameters("ISON")
+ continue
+ }
+ nicksKnown := make(map[string]struct{})
+ clientsM.RLock()
+ for c := range clients {
+ nicksKnown[*c.nickname] = struct{}{}
+ }
+ clientsM.RUnlock()
+ var nicksExists []string
+ for _, nickname := range strings.Split(cols[1], " ") {
+ if _, exists := nicksKnown[nickname]; exists {
+ nicksExists = append(nicksExists, nickname)
+ }
+ }
+ client.ReplyNicknamed("303", strings.Join(nicksExists, " "))
+ case "VERSION":
+ var debug string
+ if *verbose {
+ debug = "debug"
+ } else {
+ 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")
}
}
}