2 goircd -- minimalistic simple Internet Relay Chat (IRC) server
3 Copyright (C) 2014 Sergey Matveev <stargrave@stargrave.org>
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
33 PingTimeout = time.Second * 180 // Max time deadline for client's unresponsiveness
34 PingThreshold = time.Second * 90 // Max idle client's time before PING are sent
35 AlivenessCheck = time.Second * 10 // Client's aliveness check period
39 RENickname = regexp.MustCompile("^[a-zA-Z0-9-]{1,9}$")
42 var passwordsRefreshLock sync.Mutex
49 clients map[*Client]bool
50 clientAliveness map[*Client]*ClientAlivenessState
51 rooms map[string]*Room
52 roomSinks map[*Room]chan ClientEvent
53 lastAlivenessCheck time.Time
54 logSink chan<- LogEvent
55 stateSink chan<- StateEvent
56 passwords map[string]string
59 func NewDaemon(version, hostname, motd string, logSink chan<- LogEvent, stateSink chan<- StateEvent) *Daemon {
60 daemon := Daemon{version: version, hostname: hostname, motd: motd}
61 daemon.clients = make(map[*Client]bool)
62 daemon.clientAliveness = make(map[*Client]*ClientAlivenessState)
63 daemon.rooms = make(map[string]*Room)
64 daemon.roomSinks = make(map[*Room]chan ClientEvent)
65 daemon.logSink = logSink
66 daemon.stateSink = stateSink
70 func (daemon *Daemon) SendLusers(client *Client) {
72 for client := range daemon.clients {
73 if client.registered {
77 client.ReplyNicknamed("251", fmt.Sprintf("There are %d users and 0 invisible on 1 servers", lusers))
80 func (daemon *Daemon) SendMotd(client *Client) {
81 if len(daemon.motd) == 0 {
82 client.ReplyNicknamed("422", "MOTD File is missing")
86 motd, err := ioutil.ReadFile(daemon.motd)
88 log.Printf("Can not read motd file %s: %v", daemon.motd, err)
89 client.ReplyNicknamed("422", "Error reading MOTD File")
93 client.ReplyNicknamed("375", "- "+daemon.hostname+" Message of the day -")
94 for _, s := range strings.Split(strings.Trim(string(motd), "\n"), "\n") {
95 client.ReplyNicknamed("372", "- "+string(s))
97 client.ReplyNicknamed("376", "End of /MOTD command")
100 func (daemon *Daemon) SendWhois(client *Client, nicknames []string) {
101 for _, nickname := range nicknames {
102 nickname = strings.ToLower(nickname)
104 for c := range daemon.clients {
105 if strings.ToLower(c.nickname) != nickname {
109 h := c.conn.RemoteAddr().String()
110 h, _, err := net.SplitHostPort(h)
112 log.Printf("Can't parse RemoteAddr %q: %v", h, err)
115 client.ReplyNicknamed("311", c.nickname, c.username, h, "*", c.realname)
116 client.ReplyNicknamed("312", c.nickname, daemon.hostname, daemon.hostname)
117 subscriptions := []string{}
118 for _, room := range daemon.rooms {
119 for subscriber := range room.members {
120 if subscriber.nickname == nickname {
121 subscriptions = append(subscriptions, room.name)
125 sort.Strings(subscriptions)
126 client.ReplyNicknamed("319", c.nickname, strings.Join(subscriptions, " "))
127 client.ReplyNicknamed("318", c.nickname, "End of /WHOIS list")
130 client.ReplyNoNickChan(nickname)
135 func (daemon *Daemon) SendList(client *Client, cols []string) {
137 if (len(cols) > 1) && (cols[1] != "") {
138 rooms = strings.Split(strings.Split(cols[1], " ")[0], ",")
141 for room := range daemon.rooms {
142 rooms = append(rooms, room)
146 for _, room := range rooms {
147 r, found := daemon.rooms[room]
149 client.ReplyNicknamed("322", room, fmt.Sprintf("%d", len(r.members)), r.topic)
152 client.ReplyNicknamed("323", "End of /LIST")
155 // Unregistered client workflow processor. Unregistered client:
157 // * only QUIT, NICK and USER commands are processed
158 // * other commands are quietly ignored
159 // When client finishes NICK/USER workflow, then MOTD and LUSERS are send to him.
160 func (daemon *Daemon) ClientRegister(client *Client, command string, cols []string) {
163 if len(cols) == 1 || len(cols[1]) < 1 {
164 client.ReplyNotEnoughParameters("PASS")
167 client.password = cols[1]
169 if len(cols) == 1 || len(cols[1]) < 1 {
170 client.ReplyParts("431", "No nickname given")
174 for existingClient := range daemon.clients {
175 if existingClient.nickname == nickname {
176 client.ReplyParts("433", "*", nickname, "Nickname is already in use")
180 if !RENickname.MatchString(nickname) {
181 client.ReplyParts("432", "*", cols[1], "Erroneous nickname")
184 client.nickname = nickname
187 client.ReplyNotEnoughParameters("USER")
190 args := strings.SplitN(cols[1], " ", 4)
192 client.ReplyNotEnoughParameters("USER")
195 client.username = args[0]
196 client.realname = strings.TrimLeft(args[3], ":")
198 if client.nickname != "*" && client.username != "" {
199 passwordsRefreshLock.Lock()
200 if daemon.passwords != nil && (client.password == "" || daemon.passwords[client.nickname] != client.password) {
201 passwordsRefreshLock.Unlock()
202 client.ReplyParts("462", "You may not register")
206 passwordsRefreshLock.Unlock()
207 client.registered = true
208 client.ReplyNicknamed("001", "Hi, welcome to IRC")
209 client.ReplyNicknamed("002", "Your host is "+daemon.hostname+", running goircd "+daemon.version)
210 client.ReplyNicknamed("003", "This server was created sometime")
211 client.ReplyNicknamed("004", daemon.hostname+" goircd o o")
212 daemon.SendLusers(client)
213 daemon.SendMotd(client)
214 log.Println(client, "logged in")
218 // Register new room in Daemon. Create an object, events sink, save pointers
219 // to corresponding daemon's places and start room's processor goroutine.
220 func (daemon *Daemon) RoomRegister(name string) (*Room, chan<- ClientEvent) {
221 roomNew := NewRoom(daemon.hostname, name, daemon.logSink, daemon.stateSink)
222 roomNew.Verbose = daemon.Verbose
223 roomSink := make(chan ClientEvent)
224 daemon.rooms[name] = roomNew
225 daemon.roomSinks[roomNew] = roomSink
226 go roomNew.Processor(roomSink)
227 return roomNew, roomSink
230 func (daemon *Daemon) HandlerJoin(client *Client, cmd string) {
231 args := strings.Split(cmd, " ")
232 rooms := strings.Split(args[0], ",")
235 keys = strings.Split(args[1], ",")
239 for n, room := range rooms {
240 if !RoomNameValid(room) {
241 client.ReplyNoChannel(room)
245 if (n < len(keys)) && (keys[n] != "") {
252 for roomExisting, roomSink := range daemon.roomSinks {
253 if room == roomExisting.name {
254 if (roomExisting.key != "") && (roomExisting.key != key) {
257 roomSink <- ClientEvent{client, EventNew, ""}
264 client.ReplyNicknamed("475", room, "Cannot join channel (+k) - bad key")
266 if denied || joined {
269 roomNew, roomSink := daemon.RoomRegister(room)
270 log.Println("Room", roomNew, "created")
275 roomSink <- ClientEvent{client, EventNew, ""}
279 func (daemon *Daemon) Processor(events <-chan ClientEvent) {
280 for event := range events {
282 client := event.client
284 // Check for clients aliveness
285 if daemon.lastAlivenessCheck.Add(AlivenessCheck).Before(now) {
286 for c := range daemon.clients {
287 aliveness, alive := daemon.clientAliveness[c]
291 if aliveness.timestamp.Add(PingTimeout).Before(now) {
292 log.Println(c, "ping timeout")
296 if !aliveness.pingSent && aliveness.timestamp.Add(PingThreshold).Before(now) {
298 c.Msg("PING :" + daemon.hostname)
299 aliveness.pingSent = true
301 log.Println(c, "ping timeout")
306 daemon.lastAlivenessCheck = now
309 switch event.eventType {
311 daemon.clients[client] = true
312 daemon.clientAliveness[client] = &ClientAlivenessState{pingSent: false, timestamp: now}
314 delete(daemon.clients, client)
315 delete(daemon.clientAliveness, client)
316 for _, roomSink := range daemon.roomSinks {
320 cols := strings.SplitN(event.text, " ", 2)
321 command := strings.ToUpper(cols[0])
323 log.Println(client, "command", command)
325 if command == "QUIT" {
326 log.Println(client, "quit")
327 delete(daemon.clients, client)
328 delete(daemon.clientAliveness, client)
332 if !client.registered {
333 daemon.ClientRegister(client, command, cols)
340 if len(cols) == 1 || len(cols[1]) < 1 {
341 client.ReplyNotEnoughParameters("JOIN")
344 daemon.HandlerJoin(client, cols[1])
346 daemon.SendList(client, cols)
348 daemon.SendLusers(client)
350 if len(cols) == 1 || len(cols[1]) < 1 {
351 client.ReplyNotEnoughParameters("MODE")
354 cols = strings.SplitN(cols[1], " ", 2)
355 if cols[0] == client.username {
357 client.Msg("221 " + client.nickname + " +")
359 client.ReplyNicknamed("501", "Unknown MODE flag")
364 r, found := daemon.rooms[room]
366 client.ReplyNoChannel(room)
370 daemon.roomSinks[r] <- ClientEvent{client, EventMode, ""}
372 daemon.roomSinks[r] <- ClientEvent{client, EventMode, cols[1]}
375 go daemon.SendMotd(client)
377 if len(cols) == 1 || len(cols[1]) < 1 {
378 client.ReplyNotEnoughParameters("PART")
381 for _, room := range strings.Split(cols[1], ",") {
382 r, found := daemon.rooms[room]
384 client.ReplyNoChannel(room)
387 daemon.roomSinks[r] <- ClientEvent{client, EventDel, ""}
391 client.ReplyNicknamed("409", "No origin specified")
394 client.Reply(fmt.Sprintf("PONG %s :%s", daemon.hostname, cols[1]))
397 case "NOTICE", "PRIVMSG":
399 client.ReplyNicknamed("411", "No recipient given ("+command+")")
402 cols = strings.SplitN(cols[1], " ", 2)
404 client.ReplyNicknamed("412", "No text to send")
408 target := strings.ToLower(cols[0])
409 for c := range daemon.clients {
410 if c.nickname == target {
411 msg = fmt.Sprintf(":%s %s %s %s", client, command, c.nickname, cols[1])
419 r, found := daemon.rooms[target]
421 client.ReplyNoNickChan(target)
423 daemon.roomSinks[r] <- ClientEvent{client, EventMsg, command + " " + strings.TrimLeft(cols[1], ":")}
426 client.ReplyNotEnoughParameters("TOPIC")
429 cols = strings.SplitN(cols[1], " ", 2)
430 r, found := daemon.rooms[cols[0]]
432 client.ReplyNoChannel(cols[0])
441 daemon.roomSinks[r] <- ClientEvent{client, EventTopic, change}
443 if len(cols) == 1 || len(cols[1]) < 1 {
444 client.ReplyNotEnoughParameters("WHO")
447 room := strings.Split(cols[1], " ")[0]
448 r, found := daemon.rooms[room]
450 client.ReplyNoChannel(room)
453 daemon.roomSinks[r] <- ClientEvent{client, EventWho, ""}
455 if len(cols) == 1 || len(cols[1]) < 1 {
456 client.ReplyNotEnoughParameters("WHOIS")
459 cols := strings.Split(cols[1], " ")
460 nicknames := strings.Split(cols[len(cols)-1], ",")
461 daemon.SendWhois(client, nicknames)
469 client.ReplyNicknamed("351", fmt.Sprintf("%s.%s %s :", daemon.version, debug, daemon.hostname))
471 client.ReplyNicknamed("421", command, "Unknown command")
474 if aliveness, alive := daemon.clientAliveness[client]; alive {
475 aliveness.timestamp = now
476 aliveness.pingSent = false
481 func (daemon *Daemon) PasswordsRefresh() {
482 contents, err := ioutil.ReadFile(*passwords)
484 log.Fatalf("Can no read passwords file %s: %s", *passwords, err)
487 processed := make(map[string]string)
488 for _, entry := range strings.Split(string(contents), "\n") {
489 loginAndPassword := strings.Split(entry, ":")
490 if len(loginAndPassword) == 2 {
491 processed[loginAndPassword[0]] = loginAndPassword[1]
494 log.Printf("Read %d passwords", len(processed))
495 passwordsRefreshLock.Lock()
496 daemon.passwords = processed
497 passwordsRefreshLock.Unlock()