source: code/trunk/downstream.go@ 428

Last change on this file since 428 was 428, checked in by contact, 5 years ago

Implement delivery receipts via PING messages

This patch implements basic message delivery receipts via PING and PONG.

When a PRIVMSG or NOTICE message is sent, a PING message with a token is
also sent. The history cursor isn't immediately advanced, instead the
bouncer will wait for a PONG message before doing so.

Self-messages trigger a PING for simplicity's sake. We can't immediately
advance the history cursor in this case, because a prior message might
still have an outstanding PING.

Future work may include optimizations such as removing the need to send
a PING after a self-message, or groupping multiple PING messages
together.

Closes: ​https://todo.sr.ht/~emersion/soju/11
File size: 44.1 KB
Line 
1package soju
2
3import (
4 "crypto/tls"
5 "encoding/base64"
6 "fmt"
7 "io"
8 "net"
9 "strconv"
10 "strings"
11 "time"
12
13 "github.com/emersion/go-sasl"
14 "golang.org/x/crypto/bcrypt"
15 "gopkg.in/irc.v3"
16)
17
18type ircError struct {
19 Message *irc.Message
20}
21
22func (err ircError) Error() string {
23 return err.Message.String()
24}
25
26func newUnknownCommandError(cmd string) ircError {
27 return ircError{&irc.Message{
28 Command: irc.ERR_UNKNOWNCOMMAND,
29 Params: []string{
30 "*",
31 cmd,
32 "Unknown command",
33 },
34 }}
35}
36
37func newNeedMoreParamsError(cmd string) ircError {
38 return ircError{&irc.Message{
39 Command: irc.ERR_NEEDMOREPARAMS,
40 Params: []string{
41 "*",
42 cmd,
43 "Not enough parameters",
44 },
45 }}
46}
47
48func newChatHistoryError(subcommand string, target string) ircError {
49 return ircError{&irc.Message{
50 Command: "FAIL",
51 Params: []string{"CHATHISTORY", "MESSAGE_ERROR", subcommand, target, "Messages could not be retrieved"},
52 }}
53}
54
55var errAuthFailed = ircError{&irc.Message{
56 Command: irc.ERR_PASSWDMISMATCH,
57 Params: []string{"*", "Invalid username or password"},
58}}
59
60// ' ' and ':' break the IRC message wire format, '@' and '!' break prefixes,
61// '*' and '?' break masks
62const illegalNickChars = " :@!*?"
63
64// permanentDownstreamCaps is the list of always-supported downstream
65// capabilities.
66var permanentDownstreamCaps = map[string]string{
67 "batch": "",
68 "cap-notify": "",
69 "echo-message": "",
70 "message-tags": "",
71 "sasl": "PLAIN",
72 "server-time": "",
73}
74
75// needAllDownstreamCaps is the list of downstream capabilities that
76// require support from all upstreams to be enabled
77var needAllDownstreamCaps = map[string]string{
78 "away-notify": "",
79 "extended-join": "",
80 "multi-prefix": "",
81}
82
83type downstreamConn struct {
84 conn
85
86 id uint64
87
88 registered bool
89 user *user
90 nick string
91 rawUsername string
92 networkName string
93 clientName string
94 realname string
95 hostname string
96 password string // empty after authentication
97 network *network // can be nil
98
99 negociatingCaps bool
100 capVersion int
101 supportedCaps map[string]string
102 caps map[string]bool
103
104 saslServer sasl.Server
105}
106
107func newDownstreamConn(srv *Server, ic ircConn, id uint64) *downstreamConn {
108 remoteAddr := ic.RemoteAddr().String()
109 logger := &prefixLogger{srv.Logger, fmt.Sprintf("downstream %q: ", remoteAddr)}
110 options := connOptions{Logger: logger}
111 dc := &downstreamConn{
112 conn: *newConn(srv, ic, &options),
113 id: id,
114 supportedCaps: make(map[string]string),
115 caps: make(map[string]bool),
116 }
117 dc.hostname = remoteAddr
118 if host, _, err := net.SplitHostPort(dc.hostname); err == nil {
119 dc.hostname = host
120 }
121 for k, v := range permanentDownstreamCaps {
122 dc.supportedCaps[k] = v
123 }
124 if srv.LogPath != "" {
125 dc.supportedCaps["draft/chathistory"] = ""
126 }
127 return dc
128}
129
130func (dc *downstreamConn) prefix() *irc.Prefix {
131 return &irc.Prefix{
132 Name: dc.nick,
133 User: dc.user.Username,
134 Host: dc.hostname,
135 }
136}
137
138func (dc *downstreamConn) forEachNetwork(f func(*network)) {
139 if dc.network != nil {
140 f(dc.network)
141 } else {
142 dc.user.forEachNetwork(f)
143 }
144}
145
146func (dc *downstreamConn) forEachUpstream(f func(*upstreamConn)) {
147 dc.user.forEachUpstream(func(uc *upstreamConn) {
148 if dc.network != nil && uc.network != dc.network {
149 return
150 }
151 f(uc)
152 })
153}
154
155// upstream returns the upstream connection, if any. If there are zero or if
156// there are multiple upstream connections, it returns nil.
157func (dc *downstreamConn) upstream() *upstreamConn {
158 if dc.network == nil {
159 return nil
160 }
161 return dc.network.conn
162}
163
164func isOurNick(net *network, nick string) bool {
165 // TODO: this doesn't account for nick changes
166 if net.conn != nil {
167 return nick == net.conn.nick
168 }
169 // We're not currently connected to the upstream connection, so we don't
170 // know whether this name is our nickname. Best-effort: use the network's
171 // configured nickname and hope it was the one being used when we were
172 // connected.
173 return nick == net.Nick
174}
175
176// marshalEntity converts an upstream entity name (ie. channel or nick) into a
177// downstream entity name.
178//
179// This involves adding a "/<network>" suffix if the entity isn't the current
180// user.
181func (dc *downstreamConn) marshalEntity(net *network, name string) string {
182 if isOurNick(net, name) {
183 return dc.nick
184 }
185 if dc.network != nil {
186 if dc.network != net {
187 panic("soju: tried to marshal an entity for another network")
188 }
189 return name
190 }
191 return name + "/" + net.GetName()
192}
193
194func (dc *downstreamConn) marshalUserPrefix(net *network, prefix *irc.Prefix) *irc.Prefix {
195 if isOurNick(net, prefix.Name) {
196 return dc.prefix()
197 }
198 if dc.network != nil {
199 if dc.network != net {
200 panic("soju: tried to marshal a user prefix for another network")
201 }
202 return prefix
203 }
204 return &irc.Prefix{
205 Name: prefix.Name + "/" + net.GetName(),
206 User: prefix.User,
207 Host: prefix.Host,
208 }
209}
210
211// unmarshalEntity converts a downstream entity name (ie. channel or nick) into
212// an upstream entity name.
213//
214// This involves removing the "/<network>" suffix.
215func (dc *downstreamConn) unmarshalEntity(name string) (*upstreamConn, string, error) {
216 if uc := dc.upstream(); uc != nil {
217 return uc, name, nil
218 }
219
220 var conn *upstreamConn
221 if i := strings.LastIndexByte(name, '/'); i >= 0 {
222 network := name[i+1:]
223 name = name[:i]
224
225 dc.forEachUpstream(func(uc *upstreamConn) {
226 if network != uc.network.GetName() {
227 return
228 }
229 conn = uc
230 })
231 }
232
233 if conn == nil {
234 return nil, "", ircError{&irc.Message{
235 Command: irc.ERR_NOSUCHCHANNEL,
236 Params: []string{name, "No such channel"},
237 }}
238 }
239 return conn, name, nil
240}
241
242func (dc *downstreamConn) unmarshalText(uc *upstreamConn, text string) string {
243 if dc.upstream() != nil {
244 return text
245 }
246 // TODO: smarter parsing that ignores URLs
247 return strings.ReplaceAll(text, "/"+uc.network.GetName(), "")
248}
249
250func (dc *downstreamConn) readMessages(ch chan<- event) error {
251 for {
252 msg, err := dc.ReadMessage()
253 if err == io.EOF {
254 break
255 } else if err != nil {
256 return fmt.Errorf("failed to read IRC command: %v", err)
257 }
258
259 ch <- eventDownstreamMessage{msg, dc}
260 }
261
262 return nil
263}
264
265// SendMessage sends an outgoing message.
266//
267// This can only called from the user goroutine.
268func (dc *downstreamConn) SendMessage(msg *irc.Message) {
269 if !dc.caps["message-tags"] {
270 if msg.Command == "TAGMSG" {
271 return
272 }
273 msg = msg.Copy()
274 for name := range msg.Tags {
275 supported := false
276 switch name {
277 case "time":
278 supported = dc.caps["server-time"]
279 }
280 if !supported {
281 delete(msg.Tags, name)
282 }
283 }
284 }
285 if msg.Command == "JOIN" && !dc.caps["extended-join"] {
286 msg.Params = msg.Params[:1]
287 }
288
289 dc.conn.SendMessage(msg)
290}
291
292// sendMessageWithID sends an outgoing message with the specified internal ID.
293func (dc *downstreamConn) sendMessageWithID(msg *irc.Message, id string) {
294 dc.SendMessage(msg)
295
296 if id == "" || !dc.messageSupportsHistory(msg) {
297 return
298 }
299
300 dc.sendPing(id)
301}
302
303// advanceMessageWithID advances history to the specified message ID without
304// sending a message. This is useful e.g. for self-messages when echo-message
305// isn't enabled.
306func (dc *downstreamConn) advanceMessageWithID(msg *irc.Message, id string) {
307 if id == "" || !dc.messageSupportsHistory(msg) {
308 return
309 }
310
311 dc.sendPing(id)
312}
313
314// ackMsgID acknowledges that a message has been received.
315func (dc *downstreamConn) ackMsgID(id string) {
316 netName, entity, _, _, err := parseMsgID(id)
317 if err != nil {
318 dc.logger.Printf("failed to ACK message ID %q: %v", id, err)
319 return
320 }
321
322 network := dc.user.getNetwork(netName)
323 if network == nil {
324 return
325 }
326
327 history, ok := network.history[entity]
328 if !ok {
329 return
330 }
331
332 history.clients[dc.clientName] = id
333}
334
335func (dc *downstreamConn) sendPing(msgID string) {
336 token := "soju-msgid-" + base64.RawURLEncoding.EncodeToString([]byte(msgID))
337 dc.SendMessage(&irc.Message{
338 Command: "PING",
339 Params: []string{token},
340 })
341}
342
343func (dc *downstreamConn) handlePong(token string) {
344 if !strings.HasPrefix(token, "soju-msgid-") {
345 dc.logger.Printf("received unrecognized PONG token %q", token)
346 return
347 }
348 token = strings.TrimPrefix(token, "soju-msgid-")
349 b, err := base64.RawURLEncoding.DecodeString(token)
350 if err != nil {
351 dc.logger.Printf("received malformed PONG token: %v", err)
352 return
353 }
354 msgID := string(b)
355
356 dc.ackMsgID(msgID)
357}
358
359// marshalMessage re-formats a message coming from an upstream connection so
360// that it's suitable for being sent on this downstream connection. Only
361// messages that may appear in logs are supported, except MODE.
362func (dc *downstreamConn) marshalMessage(msg *irc.Message, net *network) *irc.Message {
363 msg = msg.Copy()
364 msg.Prefix = dc.marshalUserPrefix(net, msg.Prefix)
365
366 switch msg.Command {
367 case "PRIVMSG", "NOTICE", "TAGMSG":
368 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
369 case "NICK":
370 // Nick change for another user
371 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
372 case "JOIN", "PART":
373 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
374 case "KICK":
375 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
376 msg.Params[1] = dc.marshalEntity(net, msg.Params[1])
377 case "TOPIC":
378 msg.Params[0] = dc.marshalEntity(net, msg.Params[0])
379 case "QUIT":
380 // This space is intentionally left blank
381 default:
382 panic(fmt.Sprintf("unexpected %q message", msg.Command))
383 }
384
385 return msg
386}
387
388func (dc *downstreamConn) handleMessage(msg *irc.Message) error {
389 switch msg.Command {
390 case "QUIT":
391 return dc.Close()
392 default:
393 if dc.registered {
394 return dc.handleMessageRegistered(msg)
395 } else {
396 return dc.handleMessageUnregistered(msg)
397 }
398 }
399}
400
401func (dc *downstreamConn) handleMessageUnregistered(msg *irc.Message) error {
402 switch msg.Command {
403 case "NICK":
404 var nick string
405 if err := parseMessageParams(msg, &nick); err != nil {
406 return err
407 }
408 if strings.ContainsAny(nick, illegalNickChars) {
409 return ircError{&irc.Message{
410 Command: irc.ERR_ERRONEUSNICKNAME,
411 Params: []string{dc.nick, nick, "contains illegal characters"},
412 }}
413 }
414 if nick == serviceNick {
415 return ircError{&irc.Message{
416 Command: irc.ERR_NICKNAMEINUSE,
417 Params: []string{dc.nick, nick, "Nickname reserved for bouncer service"},
418 }}
419 }
420 dc.nick = nick
421 case "USER":
422 if err := parseMessageParams(msg, &dc.rawUsername, nil, nil, &dc.realname); err != nil {
423 return err
424 }
425 case "PASS":
426 if err := parseMessageParams(msg, &dc.password); err != nil {
427 return err
428 }
429 case "CAP":
430 var subCmd string
431 if err := parseMessageParams(msg, &subCmd); err != nil {
432 return err
433 }
434 if err := dc.handleCapCommand(subCmd, msg.Params[1:]); err != nil {
435 return err
436 }
437 case "AUTHENTICATE":
438 if !dc.caps["sasl"] {
439 return ircError{&irc.Message{
440 Command: irc.ERR_SASLFAIL,
441 Params: []string{"*", "AUTHENTICATE requires the \"sasl\" capability to be enabled"},
442 }}
443 }
444 if len(msg.Params) == 0 {
445 return ircError{&irc.Message{
446 Command: irc.ERR_SASLFAIL,
447 Params: []string{"*", "Missing AUTHENTICATE argument"},
448 }}
449 }
450 if dc.nick == "" {
451 return ircError{&irc.Message{
452 Command: irc.ERR_SASLFAIL,
453 Params: []string{"*", "Expected NICK command before AUTHENTICATE"},
454 }}
455 }
456
457 var resp []byte
458 if dc.saslServer == nil {
459 mech := strings.ToUpper(msg.Params[0])
460 switch mech {
461 case "PLAIN":
462 dc.saslServer = sasl.NewPlainServer(sasl.PlainAuthenticator(func(identity, username, password string) error {
463 return dc.authenticate(username, password)
464 }))
465 default:
466 return ircError{&irc.Message{
467 Command: irc.ERR_SASLFAIL,
468 Params: []string{"*", fmt.Sprintf("Unsupported SASL mechanism %q", mech)},
469 }}
470 }
471 } else if msg.Params[0] == "*" {
472 dc.saslServer = nil
473 return ircError{&irc.Message{
474 Command: irc.ERR_SASLABORTED,
475 Params: []string{"*", "SASL authentication aborted"},
476 }}
477 } else if msg.Params[0] == "+" {
478 resp = nil
479 } else {
480 // TODO: multi-line messages
481 var err error
482 resp, err = base64.StdEncoding.DecodeString(msg.Params[0])
483 if err != nil {
484 dc.saslServer = nil
485 return ircError{&irc.Message{
486 Command: irc.ERR_SASLFAIL,
487 Params: []string{"*", "Invalid base64-encoded response"},
488 }}
489 }
490 }
491
492 challenge, done, err := dc.saslServer.Next(resp)
493 if err != nil {
494 dc.saslServer = nil
495 if ircErr, ok := err.(ircError); ok && ircErr.Message.Command == irc.ERR_PASSWDMISMATCH {
496 return ircError{&irc.Message{
497 Command: irc.ERR_SASLFAIL,
498 Params: []string{"*", ircErr.Message.Params[1]},
499 }}
500 }
501 dc.SendMessage(&irc.Message{
502 Prefix: dc.srv.prefix(),
503 Command: irc.ERR_SASLFAIL,
504 Params: []string{"*", "SASL error"},
505 })
506 return fmt.Errorf("SASL authentication failed: %v", err)
507 } else if done {
508 dc.saslServer = nil
509 dc.SendMessage(&irc.Message{
510 Prefix: dc.srv.prefix(),
511 Command: irc.RPL_LOGGEDIN,
512 Params: []string{dc.nick, dc.prefix().String(), dc.user.Username, "You are now logged in"},
513 })
514 dc.SendMessage(&irc.Message{
515 Prefix: dc.srv.prefix(),
516 Command: irc.RPL_SASLSUCCESS,
517 Params: []string{dc.nick, "SASL authentication successful"},
518 })
519 } else {
520 challengeStr := "+"
521 if len(challenge) > 0 {
522 challengeStr = base64.StdEncoding.EncodeToString(challenge)
523 }
524
525 // TODO: multi-line messages
526 dc.SendMessage(&irc.Message{
527 Prefix: dc.srv.prefix(),
528 Command: "AUTHENTICATE",
529 Params: []string{challengeStr},
530 })
531 }
532 default:
533 dc.logger.Printf("unhandled message: %v", msg)
534 return newUnknownCommandError(msg.Command)
535 }
536 if dc.rawUsername != "" && dc.nick != "" && !dc.negociatingCaps {
537 return dc.register()
538 }
539 return nil
540}
541
542func (dc *downstreamConn) handleCapCommand(cmd string, args []string) error {
543 cmd = strings.ToUpper(cmd)
544
545 replyTo := dc.nick
546 if !dc.registered {
547 replyTo = "*"
548 }
549
550 switch cmd {
551 case "LS":
552 if len(args) > 0 {
553 var err error
554 if dc.capVersion, err = strconv.Atoi(args[0]); err != nil {
555 return err
556 }
557 }
558
559 caps := make([]string, 0, len(dc.supportedCaps))
560 for k, v := range dc.supportedCaps {
561 if dc.capVersion >= 302 && v != "" {
562 caps = append(caps, k+"="+v)
563 } else {
564 caps = append(caps, k)
565 }
566 }
567
568 // TODO: multi-line replies
569 dc.SendMessage(&irc.Message{
570 Prefix: dc.srv.prefix(),
571 Command: "CAP",
572 Params: []string{replyTo, "LS", strings.Join(caps, " ")},
573 })
574
575 if dc.capVersion >= 302 {
576 // CAP version 302 implicitly enables cap-notify
577 dc.caps["cap-notify"] = true
578 }
579
580 if !dc.registered {
581 dc.negociatingCaps = true
582 }
583 case "LIST":
584 var caps []string
585 for name := range dc.caps {
586 caps = append(caps, name)
587 }
588
589 // TODO: multi-line replies
590 dc.SendMessage(&irc.Message{
591 Prefix: dc.srv.prefix(),
592 Command: "CAP",
593 Params: []string{replyTo, "LIST", strings.Join(caps, " ")},
594 })
595 case "REQ":
596 if len(args) == 0 {
597 return ircError{&irc.Message{
598 Command: err_invalidcapcmd,
599 Params: []string{replyTo, cmd, "Missing argument in CAP REQ command"},
600 }}
601 }
602
603 // TODO: atomically ack/nak the whole capability set
604 caps := strings.Fields(args[0])
605 ack := true
606 for _, name := range caps {
607 name = strings.ToLower(name)
608 enable := !strings.HasPrefix(name, "-")
609 if !enable {
610 name = strings.TrimPrefix(name, "-")
611 }
612
613 if enable == dc.caps[name] {
614 continue
615 }
616
617 _, ok := dc.supportedCaps[name]
618 if !ok {
619 ack = false
620 break
621 }
622
623 if name == "cap-notify" && dc.capVersion >= 302 && !enable {
624 // cap-notify cannot be disabled with CAP version 302
625 ack = false
626 break
627 }
628
629 dc.caps[name] = enable
630 }
631
632 reply := "NAK"
633 if ack {
634 reply = "ACK"
635 }
636 dc.SendMessage(&irc.Message{
637 Prefix: dc.srv.prefix(),
638 Command: "CAP",
639 Params: []string{replyTo, reply, args[0]},
640 })
641 case "END":
642 dc.negociatingCaps = false
643 default:
644 return ircError{&irc.Message{
645 Command: err_invalidcapcmd,
646 Params: []string{replyTo, cmd, "Unknown CAP command"},
647 }}
648 }
649 return nil
650}
651
652func (dc *downstreamConn) setSupportedCap(name, value string) {
653 prevValue, hasPrev := dc.supportedCaps[name]
654 changed := !hasPrev || prevValue != value
655 dc.supportedCaps[name] = value
656
657 if !dc.caps["cap-notify"] || !changed {
658 return
659 }
660
661 replyTo := dc.nick
662 if !dc.registered {
663 replyTo = "*"
664 }
665
666 cap := name
667 if value != "" && dc.capVersion >= 302 {
668 cap = name + "=" + value
669 }
670
671 dc.SendMessage(&irc.Message{
672 Prefix: dc.srv.prefix(),
673 Command: "CAP",
674 Params: []string{replyTo, "NEW", cap},
675 })
676}
677
678func (dc *downstreamConn) unsetSupportedCap(name string) {
679 _, hasPrev := dc.supportedCaps[name]
680 delete(dc.supportedCaps, name)
681 delete(dc.caps, name)
682
683 if !dc.caps["cap-notify"] || !hasPrev {
684 return
685 }
686
687 replyTo := dc.nick
688 if !dc.registered {
689 replyTo = "*"
690 }
691
692 dc.SendMessage(&irc.Message{
693 Prefix: dc.srv.prefix(),
694 Command: "CAP",
695 Params: []string{replyTo, "DEL", name},
696 })
697}
698
699func (dc *downstreamConn) updateSupportedCaps() {
700 supportedCaps := make(map[string]bool)
701 for cap := range needAllDownstreamCaps {
702 supportedCaps[cap] = true
703 }
704 dc.forEachUpstream(func(uc *upstreamConn) {
705 for cap, supported := range supportedCaps {
706 supportedCaps[cap] = supported && uc.caps[cap]
707 }
708 })
709
710 for cap, supported := range supportedCaps {
711 if supported {
712 dc.setSupportedCap(cap, needAllDownstreamCaps[cap])
713 } else {
714 dc.unsetSupportedCap(cap)
715 }
716 }
717}
718
719func (dc *downstreamConn) updateNick() {
720 if uc := dc.upstream(); uc != nil && uc.nick != dc.nick {
721 dc.SendMessage(&irc.Message{
722 Prefix: dc.prefix(),
723 Command: "NICK",
724 Params: []string{uc.nick},
725 })
726 dc.nick = uc.nick
727 }
728}
729
730func sanityCheckServer(addr string) error {
731 dialer := net.Dialer{Timeout: 30 * time.Second}
732 conn, err := tls.DialWithDialer(&dialer, "tcp", addr, nil)
733 if err != nil {
734 return err
735 }
736 return conn.Close()
737}
738
739func unmarshalUsername(rawUsername string) (username, client, network string) {
740 username = rawUsername
741
742 i := strings.IndexAny(username, "/@")
743 j := strings.LastIndexAny(username, "/@")
744 if i >= 0 {
745 username = rawUsername[:i]
746 }
747 if j >= 0 {
748 if rawUsername[j] == '@' {
749 client = rawUsername[j+1:]
750 } else {
751 network = rawUsername[j+1:]
752 }
753 }
754 if i >= 0 && j >= 0 && i < j {
755 if rawUsername[i] == '@' {
756 client = rawUsername[i+1 : j]
757 } else {
758 network = rawUsername[i+1 : j]
759 }
760 }
761
762 return username, client, network
763}
764
765func (dc *downstreamConn) authenticate(username, password string) error {
766 username, clientName, networkName := unmarshalUsername(username)
767
768 u, err := dc.srv.db.GetUser(username)
769 if err != nil {
770 dc.logger.Printf("failed authentication for %q: %v", username, err)
771 return errAuthFailed
772 }
773
774 // Password auth disabled
775 if u.Password == "" {
776 return errAuthFailed
777 }
778
779 err = bcrypt.CompareHashAndPassword([]byte(u.Password), []byte(password))
780 if err != nil {
781 dc.logger.Printf("failed authentication for %q: %v", username, err)
782 return errAuthFailed
783 }
784
785 dc.user = dc.srv.getUser(username)
786 if dc.user == nil {
787 dc.logger.Printf("failed authentication for %q: user not active", username)
788 return errAuthFailed
789 }
790 dc.clientName = clientName
791 dc.networkName = networkName
792 return nil
793}
794
795func (dc *downstreamConn) register() error {
796 if dc.registered {
797 return fmt.Errorf("tried to register twice")
798 }
799
800 password := dc.password
801 dc.password = ""
802 if dc.user == nil {
803 if err := dc.authenticate(dc.rawUsername, password); err != nil {
804 return err
805 }
806 }
807
808 if dc.clientName == "" && dc.networkName == "" {
809 _, dc.clientName, dc.networkName = unmarshalUsername(dc.rawUsername)
810 }
811
812 dc.registered = true
813 dc.logger.Printf("registration complete for user %q", dc.user.Username)
814 return nil
815}
816
817func (dc *downstreamConn) loadNetwork() error {
818 if dc.networkName == "" {
819 return nil
820 }
821
822 network := dc.user.getNetwork(dc.networkName)
823 if network == nil {
824 addr := dc.networkName
825 if !strings.ContainsRune(addr, ':') {
826 addr = addr + ":6697"
827 }
828
829 dc.logger.Printf("trying to connect to new network %q", addr)
830 if err := sanityCheckServer(addr); err != nil {
831 dc.logger.Printf("failed to connect to %q: %v", addr, err)
832 return ircError{&irc.Message{
833 Command: irc.ERR_PASSWDMISMATCH,
834 Params: []string{"*", fmt.Sprintf("Failed to connect to %q", dc.networkName)},
835 }}
836 }
837
838 // Some clients only allow specifying the nickname (and use the
839 // nickname as a username too). Strip the network name from the
840 // nickname when auto-saving networks.
841 nick, _, _ := unmarshalUsername(dc.nick)
842
843 dc.logger.Printf("auto-saving network %q", dc.networkName)
844 var err error
845 network, err = dc.user.createNetwork(&Network{
846 Addr: dc.networkName,
847 Nick: nick,
848 })
849 if err != nil {
850 return err
851 }
852 }
853
854 dc.network = network
855 return nil
856}
857
858func (dc *downstreamConn) welcome() error {
859 if dc.user == nil || !dc.registered {
860 panic("tried to welcome an unregistered connection")
861 }
862
863 // TODO: doing this might take some time. We should do it in dc.register
864 // instead, but we'll potentially be adding a new network and this must be
865 // done in the user goroutine.
866 if err := dc.loadNetwork(); err != nil {
867 return err
868 }
869
870 dc.SendMessage(&irc.Message{
871 Prefix: dc.srv.prefix(),
872 Command: irc.RPL_WELCOME,
873 Params: []string{dc.nick, "Welcome to soju, " + dc.nick},
874 })
875 dc.SendMessage(&irc.Message{
876 Prefix: dc.srv.prefix(),
877 Command: irc.RPL_YOURHOST,
878 Params: []string{dc.nick, "Your host is " + dc.srv.Hostname},
879 })
880 dc.SendMessage(&irc.Message{
881 Prefix: dc.srv.prefix(),
882 Command: irc.RPL_CREATED,
883 Params: []string{dc.nick, "Who cares when the server was created?"},
884 })
885 dc.SendMessage(&irc.Message{
886 Prefix: dc.srv.prefix(),
887 Command: irc.RPL_MYINFO,
888 Params: []string{dc.nick, dc.srv.Hostname, "soju", "aiwroO", "OovaimnqpsrtklbeI"},
889 })
890 // TODO: RPL_ISUPPORT
891 // TODO: send CHATHISTORY in RPL_ISUPPORT when implemented
892 dc.SendMessage(&irc.Message{
893 Prefix: dc.srv.prefix(),
894 Command: irc.ERR_NOMOTD,
895 Params: []string{dc.nick, "No MOTD"},
896 })
897
898 dc.updateNick()
899
900 dc.forEachUpstream(func(uc *upstreamConn) {
901 for _, ch := range uc.channels {
902 if !ch.complete {
903 continue
904 }
905 if record, ok := uc.network.channels[ch.Name]; ok && record.Detached {
906 continue
907 }
908
909 dc.SendMessage(&irc.Message{
910 Prefix: dc.prefix(),
911 Command: "JOIN",
912 Params: []string{dc.marshalEntity(ch.conn.network, ch.Name)},
913 })
914
915 forwardChannel(dc, ch)
916 }
917 })
918
919 dc.forEachNetwork(func(net *network) {
920 // Only send history if we're the first connected client with that name
921 // for the network
922 if _, ok := net.offlineClients[dc.clientName]; ok {
923 dc.sendNetworkHistory(net)
924 delete(net.offlineClients, dc.clientName)
925 }
926
927 // Fast-forward history to last message
928 for target, history := range net.history {
929 if ch, ok := net.channels[target]; ok && ch.Detached {
930 continue
931 }
932
933 lastID, err := dc.user.msgStore.LastMsgID(net, target, time.Now())
934 if err != nil {
935 dc.logger.Printf("failed to get last message ID: %v", err)
936 continue
937 }
938 history.clients[dc.clientName] = lastID
939 }
940 })
941
942 return nil
943}
944
945// messageSupportsHistory checks whether the provided message can be sent as
946// part of an history batch.
947func (dc *downstreamConn) messageSupportsHistory(msg *irc.Message) bool {
948 // Don't replay all messages, because that would mess up client
949 // state. For instance we just sent the list of users, sending
950 // PART messages for one of these users would be incorrect.
951 // TODO: add support for draft/event-playback
952 switch msg.Command {
953 case "PRIVMSG", "NOTICE":
954 return true
955 }
956 return false
957}
958
959func (dc *downstreamConn) sendNetworkHistory(net *network) {
960 if dc.caps["draft/chathistory"] || dc.user.msgStore == nil {
961 return
962 }
963 for target, history := range net.history {
964 if ch, ok := net.channels[target]; ok && ch.Detached {
965 continue
966 }
967
968 lastDelivered, ok := history.clients[dc.clientName]
969 if !ok {
970 continue
971 }
972
973 limit := 4000
974 history, err := dc.user.msgStore.LoadLatestID(net, target, lastDelivered, limit)
975 if err != nil {
976 dc.logger.Printf("failed to send implicit history for %q: %v", target, err)
977 continue
978 }
979
980 batchRef := "history"
981 if dc.caps["batch"] {
982 dc.SendMessage(&irc.Message{
983 Prefix: dc.srv.prefix(),
984 Command: "BATCH",
985 Params: []string{"+" + batchRef, "chathistory", dc.marshalEntity(net, target)},
986 })
987 }
988
989 for _, msg := range history {
990 if !dc.messageSupportsHistory(msg) {
991 continue
992 }
993
994 if dc.caps["batch"] {
995 msg.Tags["batch"] = irc.TagValue(batchRef)
996 }
997 dc.SendMessage(dc.marshalMessage(msg, net))
998 }
999
1000 if dc.caps["batch"] {
1001 dc.SendMessage(&irc.Message{
1002 Prefix: dc.srv.prefix(),
1003 Command: "BATCH",
1004 Params: []string{"-" + batchRef},
1005 })
1006 }
1007 }
1008}
1009
1010func (dc *downstreamConn) runUntilRegistered() error {
1011 for !dc.registered {
1012 msg, err := dc.ReadMessage()
1013 if err != nil {
1014 return fmt.Errorf("failed to read IRC command: %v", err)
1015 }
1016
1017 err = dc.handleMessage(msg)
1018 if ircErr, ok := err.(ircError); ok {
1019 ircErr.Message.Prefix = dc.srv.prefix()
1020 dc.SendMessage(ircErr.Message)
1021 } else if err != nil {
1022 return fmt.Errorf("failed to handle IRC command %q: %v", msg, err)
1023 }
1024 }
1025
1026 return nil
1027}
1028
1029func (dc *downstreamConn) handleMessageRegistered(msg *irc.Message) error {
1030 switch msg.Command {
1031 case "CAP":
1032 var subCmd string
1033 if err := parseMessageParams(msg, &subCmd); err != nil {
1034 return err
1035 }
1036 if err := dc.handleCapCommand(subCmd, msg.Params[1:]); err != nil {
1037 return err
1038 }
1039 case "PING":
1040 var source, destination string
1041 if err := parseMessageParams(msg, &source); err != nil {
1042 return err
1043 }
1044 if len(msg.Params) > 1 {
1045 destination = msg.Params[1]
1046 }
1047 if destination != "" && destination != dc.srv.Hostname {
1048 return ircError{&irc.Message{
1049 Command: irc.ERR_NOSUCHSERVER,
1050 Params: []string{dc.nick, destination, "No such server"},
1051 }}
1052 }
1053 dc.SendMessage(&irc.Message{
1054 Prefix: dc.srv.prefix(),
1055 Command: "PONG",
1056 Params: []string{dc.srv.Hostname, source},
1057 })
1058 return nil
1059 case "PONG":
1060 if len(msg.Params) == 0 {
1061 return newNeedMoreParamsError(msg.Command)
1062 }
1063 token := msg.Params[len(msg.Params)-1]
1064 dc.handlePong(token)
1065 case "USER":
1066 return ircError{&irc.Message{
1067 Command: irc.ERR_ALREADYREGISTERED,
1068 Params: []string{dc.nick, "You may not reregister"},
1069 }}
1070 case "NICK":
1071 var nick string
1072 if err := parseMessageParams(msg, &nick); err != nil {
1073 return err
1074 }
1075
1076 var upstream *upstreamConn
1077 if dc.upstream() == nil {
1078 uc, unmarshaledNick, err := dc.unmarshalEntity(nick)
1079 if err == nil { // NICK nick/network: NICK only on a specific upstream
1080 upstream = uc
1081 nick = unmarshaledNick
1082 }
1083 }
1084
1085 if strings.ContainsAny(nick, illegalNickChars) {
1086 return ircError{&irc.Message{
1087 Command: irc.ERR_ERRONEUSNICKNAME,
1088 Params: []string{dc.nick, nick, "contains illegal characters"},
1089 }}
1090 }
1091
1092 var err error
1093 dc.forEachNetwork(func(n *network) {
1094 if err != nil || (upstream != nil && upstream.network != n) {
1095 return
1096 }
1097 n.Nick = nick
1098 err = dc.srv.db.StoreNetwork(dc.user.ID, &n.Network)
1099 })
1100 if err != nil {
1101 return err
1102 }
1103
1104 dc.forEachUpstream(func(uc *upstreamConn) {
1105 if upstream != nil && upstream != uc {
1106 return
1107 }
1108 uc.SendMessageLabeled(dc.id, &irc.Message{
1109 Command: "NICK",
1110 Params: []string{nick},
1111 })
1112 })
1113
1114 if dc.upstream() == nil && dc.nick != nick {
1115 dc.SendMessage(&irc.Message{
1116 Prefix: dc.prefix(),
1117 Command: "NICK",
1118 Params: []string{nick},
1119 })
1120 dc.nick = nick
1121 }
1122 case "JOIN":
1123 var namesStr string
1124 if err := parseMessageParams(msg, &namesStr); err != nil {
1125 return err
1126 }
1127
1128 var keys []string
1129 if len(msg.Params) > 1 {
1130 keys = strings.Split(msg.Params[1], ",")
1131 }
1132
1133 for i, name := range strings.Split(namesStr, ",") {
1134 uc, upstreamName, err := dc.unmarshalEntity(name)
1135 if err != nil {
1136 return err
1137 }
1138
1139 var key string
1140 if len(keys) > i {
1141 key = keys[i]
1142 }
1143
1144 params := []string{upstreamName}
1145 if key != "" {
1146 params = append(params, key)
1147 }
1148 uc.SendMessageLabeled(dc.id, &irc.Message{
1149 Command: "JOIN",
1150 Params: params,
1151 })
1152
1153 ch := &Channel{Name: upstreamName, Key: key, Detached: false}
1154 if current, ok := uc.network.channels[ch.Name]; ok && key == "" {
1155 // Don't clear the channel key if there's one set
1156 // TODO: add a way to unset the channel key
1157 ch.Key = current.Key
1158 }
1159 if err := uc.network.createUpdateChannel(ch); err != nil {
1160 dc.logger.Printf("failed to create or update channel %q: %v", upstreamName, err)
1161 }
1162 }
1163 case "PART":
1164 var namesStr string
1165 if err := parseMessageParams(msg, &namesStr); err != nil {
1166 return err
1167 }
1168
1169 var reason string
1170 if len(msg.Params) > 1 {
1171 reason = msg.Params[1]
1172 }
1173
1174 for _, name := range strings.Split(namesStr, ",") {
1175 uc, upstreamName, err := dc.unmarshalEntity(name)
1176 if err != nil {
1177 return err
1178 }
1179
1180 if strings.EqualFold(reason, "detach") {
1181 ch := &Channel{Name: upstreamName, Detached: true}
1182 if err := uc.network.createUpdateChannel(ch); err != nil {
1183 dc.logger.Printf("failed to detach channel %q: %v", upstreamName, err)
1184 }
1185 } else {
1186 params := []string{upstreamName}
1187 if reason != "" {
1188 params = append(params, reason)
1189 }
1190 uc.SendMessageLabeled(dc.id, &irc.Message{
1191 Command: "PART",
1192 Params: params,
1193 })
1194
1195 if err := uc.network.deleteChannel(upstreamName); err != nil {
1196 dc.logger.Printf("failed to delete channel %q: %v", upstreamName, err)
1197 }
1198 }
1199 }
1200 case "KICK":
1201 var channelStr, userStr string
1202 if err := parseMessageParams(msg, &channelStr, &userStr); err != nil {
1203 return err
1204 }
1205
1206 channels := strings.Split(channelStr, ",")
1207 users := strings.Split(userStr, ",")
1208
1209 var reason string
1210 if len(msg.Params) > 2 {
1211 reason = msg.Params[2]
1212 }
1213
1214 if len(channels) != 1 && len(channels) != len(users) {
1215 return ircError{&irc.Message{
1216 Command: irc.ERR_BADCHANMASK,
1217 Params: []string{dc.nick, channelStr, "Bad channel mask"},
1218 }}
1219 }
1220
1221 for i, user := range users {
1222 var channel string
1223 if len(channels) == 1 {
1224 channel = channels[0]
1225 } else {
1226 channel = channels[i]
1227 }
1228
1229 ucChannel, upstreamChannel, err := dc.unmarshalEntity(channel)
1230 if err != nil {
1231 return err
1232 }
1233
1234 ucUser, upstreamUser, err := dc.unmarshalEntity(user)
1235 if err != nil {
1236 return err
1237 }
1238
1239 if ucChannel != ucUser {
1240 return ircError{&irc.Message{
1241 Command: irc.ERR_USERNOTINCHANNEL,
1242 Params: []string{dc.nick, user, channel, "They are on another network"},
1243 }}
1244 }
1245 uc := ucChannel
1246
1247 params := []string{upstreamChannel, upstreamUser}
1248 if reason != "" {
1249 params = append(params, reason)
1250 }
1251 uc.SendMessageLabeled(dc.id, &irc.Message{
1252 Command: "KICK",
1253 Params: params,
1254 })
1255 }
1256 case "MODE":
1257 var name string
1258 if err := parseMessageParams(msg, &name); err != nil {
1259 return err
1260 }
1261
1262 var modeStr string
1263 if len(msg.Params) > 1 {
1264 modeStr = msg.Params[1]
1265 }
1266
1267 if name == dc.nick {
1268 if modeStr != "" {
1269 dc.forEachUpstream(func(uc *upstreamConn) {
1270 uc.SendMessageLabeled(dc.id, &irc.Message{
1271 Command: "MODE",
1272 Params: []string{uc.nick, modeStr},
1273 })
1274 })
1275 } else {
1276 dc.SendMessage(&irc.Message{
1277 Prefix: dc.srv.prefix(),
1278 Command: irc.RPL_UMODEIS,
1279 Params: []string{dc.nick, ""}, // TODO
1280 })
1281 }
1282 return nil
1283 }
1284
1285 uc, upstreamName, err := dc.unmarshalEntity(name)
1286 if err != nil {
1287 return err
1288 }
1289
1290 if !uc.isChannel(upstreamName) {
1291 return ircError{&irc.Message{
1292 Command: irc.ERR_USERSDONTMATCH,
1293 Params: []string{dc.nick, "Cannot change mode for other users"},
1294 }}
1295 }
1296
1297 if modeStr != "" {
1298 params := []string{upstreamName, modeStr}
1299 params = append(params, msg.Params[2:]...)
1300 uc.SendMessageLabeled(dc.id, &irc.Message{
1301 Command: "MODE",
1302 Params: params,
1303 })
1304 } else {
1305 ch, ok := uc.channels[upstreamName]
1306 if !ok {
1307 return ircError{&irc.Message{
1308 Command: irc.ERR_NOSUCHCHANNEL,
1309 Params: []string{dc.nick, name, "No such channel"},
1310 }}
1311 }
1312
1313 if ch.modes == nil {
1314 // we haven't received the initial RPL_CHANNELMODEIS yet
1315 // ignore the request, we will broadcast the modes later when we receive RPL_CHANNELMODEIS
1316 return nil
1317 }
1318
1319 modeStr, modeParams := ch.modes.Format()
1320 params := []string{dc.nick, name, modeStr}
1321 params = append(params, modeParams...)
1322
1323 dc.SendMessage(&irc.Message{
1324 Prefix: dc.srv.prefix(),
1325 Command: irc.RPL_CHANNELMODEIS,
1326 Params: params,
1327 })
1328 if ch.creationTime != "" {
1329 dc.SendMessage(&irc.Message{
1330 Prefix: dc.srv.prefix(),
1331 Command: rpl_creationtime,
1332 Params: []string{dc.nick, name, ch.creationTime},
1333 })
1334 }
1335 }
1336 case "TOPIC":
1337 var channel string
1338 if err := parseMessageParams(msg, &channel); err != nil {
1339 return err
1340 }
1341
1342 uc, upstreamChannel, err := dc.unmarshalEntity(channel)
1343 if err != nil {
1344 return err
1345 }
1346
1347 if len(msg.Params) > 1 { // setting topic
1348 topic := msg.Params[1]
1349 uc.SendMessageLabeled(dc.id, &irc.Message{
1350 Command: "TOPIC",
1351 Params: []string{upstreamChannel, topic},
1352 })
1353 } else { // getting topic
1354 ch, ok := uc.channels[upstreamChannel]
1355 if !ok {
1356 return ircError{&irc.Message{
1357 Command: irc.ERR_NOSUCHCHANNEL,
1358 Params: []string{dc.nick, upstreamChannel, "No such channel"},
1359 }}
1360 }
1361 sendTopic(dc, ch)
1362 }
1363 case "LIST":
1364 // TODO: support ELIST when supported by all upstreams
1365
1366 pl := pendingLIST{
1367 downstreamID: dc.id,
1368 pendingCommands: make(map[int64]*irc.Message),
1369 }
1370 var upstream *upstreamConn
1371 var upstreamChannels map[int64][]string
1372 if len(msg.Params) > 0 {
1373 uc, upstreamMask, err := dc.unmarshalEntity(msg.Params[0])
1374 if err == nil && upstreamMask == "*" { // LIST */network: send LIST only to one network
1375 upstream = uc
1376 } else {
1377 upstreamChannels = make(map[int64][]string)
1378 channels := strings.Split(msg.Params[0], ",")
1379 for _, channel := range channels {
1380 uc, upstreamChannel, err := dc.unmarshalEntity(channel)
1381 if err != nil {
1382 return err
1383 }
1384 upstreamChannels[uc.network.ID] = append(upstreamChannels[uc.network.ID], upstreamChannel)
1385 }
1386 }
1387 }
1388
1389 dc.user.pendingLISTs = append(dc.user.pendingLISTs, pl)
1390 dc.forEachUpstream(func(uc *upstreamConn) {
1391 if upstream != nil && upstream != uc {
1392 return
1393 }
1394 var params []string
1395 if upstreamChannels != nil {
1396 if channels, ok := upstreamChannels[uc.network.ID]; ok {
1397 params = []string{strings.Join(channels, ",")}
1398 } else {
1399 return
1400 }
1401 }
1402 pl.pendingCommands[uc.network.ID] = &irc.Message{
1403 Command: "LIST",
1404 Params: params,
1405 }
1406 uc.trySendLIST(dc.id)
1407 })
1408 case "NAMES":
1409 if len(msg.Params) == 0 {
1410 dc.SendMessage(&irc.Message{
1411 Prefix: dc.srv.prefix(),
1412 Command: irc.RPL_ENDOFNAMES,
1413 Params: []string{dc.nick, "*", "End of /NAMES list"},
1414 })
1415 return nil
1416 }
1417
1418 channels := strings.Split(msg.Params[0], ",")
1419 for _, channel := range channels {
1420 uc, upstreamChannel, err := dc.unmarshalEntity(channel)
1421 if err != nil {
1422 return err
1423 }
1424
1425 ch, ok := uc.channels[upstreamChannel]
1426 if ok {
1427 sendNames(dc, ch)
1428 } else {
1429 // NAMES on a channel we have not joined, ask upstream
1430 uc.SendMessageLabeled(dc.id, &irc.Message{
1431 Command: "NAMES",
1432 Params: []string{upstreamChannel},
1433 })
1434 }
1435 }
1436 case "WHO":
1437 if len(msg.Params) == 0 {
1438 // TODO: support WHO without parameters
1439 dc.SendMessage(&irc.Message{
1440 Prefix: dc.srv.prefix(),
1441 Command: irc.RPL_ENDOFWHO,
1442 Params: []string{dc.nick, "*", "End of /WHO list"},
1443 })
1444 return nil
1445 }
1446
1447 // TODO: support WHO masks
1448 entity := msg.Params[0]
1449
1450 if entity == dc.nick {
1451 // TODO: support AWAY (H/G) in self WHO reply
1452 dc.SendMessage(&irc.Message{
1453 Prefix: dc.srv.prefix(),
1454 Command: irc.RPL_WHOREPLY,
1455 Params: []string{dc.nick, "*", dc.user.Username, dc.hostname, dc.srv.Hostname, dc.nick, "H", "0 " + dc.realname},
1456 })
1457 dc.SendMessage(&irc.Message{
1458 Prefix: dc.srv.prefix(),
1459 Command: irc.RPL_ENDOFWHO,
1460 Params: []string{dc.nick, dc.nick, "End of /WHO list"},
1461 })
1462 return nil
1463 }
1464 if entity == serviceNick {
1465 dc.SendMessage(&irc.Message{
1466 Prefix: dc.srv.prefix(),
1467 Command: irc.RPL_WHOREPLY,
1468 Params: []string{serviceNick, "*", servicePrefix.User, servicePrefix.Host, dc.srv.Hostname, serviceNick, "H", "0 " + serviceRealname},
1469 })
1470 dc.SendMessage(&irc.Message{
1471 Prefix: dc.srv.prefix(),
1472 Command: irc.RPL_ENDOFWHO,
1473 Params: []string{dc.nick, serviceNick, "End of /WHO list"},
1474 })
1475 return nil
1476 }
1477
1478 uc, upstreamName, err := dc.unmarshalEntity(entity)
1479 if err != nil {
1480 return err
1481 }
1482
1483 var params []string
1484 if len(msg.Params) == 2 {
1485 params = []string{upstreamName, msg.Params[1]}
1486 } else {
1487 params = []string{upstreamName}
1488 }
1489
1490 uc.SendMessageLabeled(dc.id, &irc.Message{
1491 Command: "WHO",
1492 Params: params,
1493 })
1494 case "WHOIS":
1495 if len(msg.Params) == 0 {
1496 return ircError{&irc.Message{
1497 Command: irc.ERR_NONICKNAMEGIVEN,
1498 Params: []string{dc.nick, "No nickname given"},
1499 }}
1500 }
1501
1502 var target, mask string
1503 if len(msg.Params) == 1 {
1504 target = ""
1505 mask = msg.Params[0]
1506 } else {
1507 target = msg.Params[0]
1508 mask = msg.Params[1]
1509 }
1510 // TODO: support multiple WHOIS users
1511 if i := strings.IndexByte(mask, ','); i >= 0 {
1512 mask = mask[:i]
1513 }
1514
1515 if mask == dc.nick {
1516 dc.SendMessage(&irc.Message{
1517 Prefix: dc.srv.prefix(),
1518 Command: irc.RPL_WHOISUSER,
1519 Params: []string{dc.nick, dc.nick, dc.user.Username, dc.hostname, "*", dc.realname},
1520 })
1521 dc.SendMessage(&irc.Message{
1522 Prefix: dc.srv.prefix(),
1523 Command: irc.RPL_WHOISSERVER,
1524 Params: []string{dc.nick, dc.nick, dc.srv.Hostname, "soju"},
1525 })
1526 dc.SendMessage(&irc.Message{
1527 Prefix: dc.srv.prefix(),
1528 Command: irc.RPL_ENDOFWHOIS,
1529 Params: []string{dc.nick, dc.nick, "End of /WHOIS list"},
1530 })
1531 return nil
1532 }
1533
1534 // TODO: support WHOIS masks
1535 uc, upstreamNick, err := dc.unmarshalEntity(mask)
1536 if err != nil {
1537 return err
1538 }
1539
1540 var params []string
1541 if target != "" {
1542 if target == mask { // WHOIS nick nick
1543 params = []string{upstreamNick, upstreamNick}
1544 } else {
1545 params = []string{target, upstreamNick}
1546 }
1547 } else {
1548 params = []string{upstreamNick}
1549 }
1550
1551 uc.SendMessageLabeled(dc.id, &irc.Message{
1552 Command: "WHOIS",
1553 Params: params,
1554 })
1555 case "PRIVMSG":
1556 var targetsStr, text string
1557 if err := parseMessageParams(msg, &targetsStr, &text); err != nil {
1558 return err
1559 }
1560 tags := copyClientTags(msg.Tags)
1561
1562 for _, name := range strings.Split(targetsStr, ",") {
1563 if name == serviceNick {
1564 handleServicePRIVMSG(dc, text)
1565 continue
1566 }
1567
1568 uc, upstreamName, err := dc.unmarshalEntity(name)
1569 if err != nil {
1570 return err
1571 }
1572
1573 if upstreamName == "NickServ" {
1574 dc.handleNickServPRIVMSG(uc, text)
1575 }
1576
1577 unmarshaledText := text
1578 if uc.isChannel(upstreamName) {
1579 unmarshaledText = dc.unmarshalText(uc, text)
1580 }
1581 uc.SendMessageLabeled(dc.id, &irc.Message{
1582 Tags: tags,
1583 Command: "PRIVMSG",
1584 Params: []string{upstreamName, unmarshaledText},
1585 })
1586
1587 echoTags := tags.Copy()
1588 echoTags["time"] = irc.TagValue(time.Now().UTC().Format(serverTimeLayout))
1589 echoMsg := &irc.Message{
1590 Tags: echoTags,
1591 Prefix: &irc.Prefix{
1592 Name: uc.nick,
1593 User: uc.username,
1594 },
1595 Command: "PRIVMSG",
1596 Params: []string{upstreamName, text},
1597 }
1598 uc.produce(upstreamName, echoMsg, dc)
1599 }
1600 case "NOTICE":
1601 var targetsStr, text string
1602 if err := parseMessageParams(msg, &targetsStr, &text); err != nil {
1603 return err
1604 }
1605 tags := copyClientTags(msg.Tags)
1606
1607 for _, name := range strings.Split(targetsStr, ",") {
1608 uc, upstreamName, err := dc.unmarshalEntity(name)
1609 if err != nil {
1610 return err
1611 }
1612
1613 unmarshaledText := text
1614 if uc.isChannel(upstreamName) {
1615 unmarshaledText = dc.unmarshalText(uc, text)
1616 }
1617 uc.SendMessageLabeled(dc.id, &irc.Message{
1618 Tags: tags,
1619 Command: "NOTICE",
1620 Params: []string{upstreamName, unmarshaledText},
1621 })
1622 }
1623 case "TAGMSG":
1624 var targetsStr string
1625 if err := parseMessageParams(msg, &targetsStr); err != nil {
1626 return err
1627 }
1628 tags := copyClientTags(msg.Tags)
1629
1630 for _, name := range strings.Split(targetsStr, ",") {
1631 uc, upstreamName, err := dc.unmarshalEntity(name)
1632 if err != nil {
1633 return err
1634 }
1635 if _, ok := uc.caps["message-tags"]; !ok {
1636 continue
1637 }
1638
1639 uc.SendMessageLabeled(dc.id, &irc.Message{
1640 Tags: tags,
1641 Command: "TAGMSG",
1642 Params: []string{upstreamName},
1643 })
1644 }
1645 case "INVITE":
1646 var user, channel string
1647 if err := parseMessageParams(msg, &user, &channel); err != nil {
1648 return err
1649 }
1650
1651 ucChannel, upstreamChannel, err := dc.unmarshalEntity(channel)
1652 if err != nil {
1653 return err
1654 }
1655
1656 ucUser, upstreamUser, err := dc.unmarshalEntity(user)
1657 if err != nil {
1658 return err
1659 }
1660
1661 if ucChannel != ucUser {
1662 return ircError{&irc.Message{
1663 Command: irc.ERR_USERNOTINCHANNEL,
1664 Params: []string{dc.nick, user, channel, "They are on another network"},
1665 }}
1666 }
1667 uc := ucChannel
1668
1669 uc.SendMessageLabeled(dc.id, &irc.Message{
1670 Command: "INVITE",
1671 Params: []string{upstreamUser, upstreamChannel},
1672 })
1673 case "CHATHISTORY":
1674 var subcommand string
1675 if err := parseMessageParams(msg, &subcommand); err != nil {
1676 return err
1677 }
1678 var target, criteria, limitStr string
1679 if err := parseMessageParams(msg, nil, &target, &criteria, &limitStr); err != nil {
1680 return ircError{&irc.Message{
1681 Command: "FAIL",
1682 Params: []string{"CHATHISTORY", "NEED_MORE_PARAMS", subcommand, "Missing parameters"},
1683 }}
1684 }
1685
1686 if dc.user.msgStore == nil {
1687 return ircError{&irc.Message{
1688 Command: irc.ERR_UNKNOWNCOMMAND,
1689 Params: []string{dc.nick, subcommand, "Unknown command"},
1690 }}
1691 }
1692
1693 uc, entity, err := dc.unmarshalEntity(target)
1694 if err != nil {
1695 return err
1696 }
1697
1698 // TODO: support msgid criteria
1699 criteriaParts := strings.SplitN(criteria, "=", 2)
1700 if len(criteriaParts) != 2 || criteriaParts[0] != "timestamp" {
1701 return ircError{&irc.Message{
1702 Command: "FAIL",
1703 Params: []string{"CHATHISTORY", "UNKNOWN_CRITERIA", criteria, "Unknown criteria"},
1704 }}
1705 }
1706
1707 timestamp, err := time.Parse(serverTimeLayout, criteriaParts[1])
1708 if err != nil {
1709 return ircError{&irc.Message{
1710 Command: "FAIL",
1711 Params: []string{"CHATHISTORY", "INVALID_CRITERIA", criteria, "Invalid criteria"},
1712 }}
1713 }
1714
1715 limit, err := strconv.Atoi(limitStr)
1716 if err != nil || limit < 0 || limit > dc.srv.HistoryLimit {
1717 return ircError{&irc.Message{
1718 Command: "FAIL",
1719 Params: []string{"CHATHISTORY", "INVALID_LIMIT", limitStr, "Invalid limit"},
1720 }}
1721 }
1722
1723 var history []*irc.Message
1724 switch subcommand {
1725 case "BEFORE":
1726 history, err = dc.user.msgStore.LoadBeforeTime(uc.network, entity, timestamp, limit)
1727 case "AFTER":
1728 history, err = dc.user.msgStore.LoadAfterTime(uc.network, entity, timestamp, limit)
1729 default:
1730 // TODO: support LATEST, BETWEEN
1731 return ircError{&irc.Message{
1732 Command: "FAIL",
1733 Params: []string{"CHATHISTORY", "UNKNOWN_COMMAND", subcommand, "Unknown command"},
1734 }}
1735 }
1736 if err != nil {
1737 dc.logger.Printf("failed parsing log messages for chathistory: %v", err)
1738 return newChatHistoryError(subcommand, target)
1739 }
1740
1741 batchRef := "history"
1742 dc.SendMessage(&irc.Message{
1743 Prefix: dc.srv.prefix(),
1744 Command: "BATCH",
1745 Params: []string{"+" + batchRef, "chathistory", target},
1746 })
1747
1748 for _, msg := range history {
1749 msg.Tags["batch"] = irc.TagValue(batchRef)
1750 dc.SendMessage(dc.marshalMessage(msg, uc.network))
1751 }
1752
1753 dc.SendMessage(&irc.Message{
1754 Prefix: dc.srv.prefix(),
1755 Command: "BATCH",
1756 Params: []string{"-" + batchRef},
1757 })
1758 default:
1759 dc.logger.Printf("unhandled message: %v", msg)
1760 return newUnknownCommandError(msg.Command)
1761 }
1762 return nil
1763}
1764
1765func (dc *downstreamConn) handleNickServPRIVMSG(uc *upstreamConn, text string) {
1766 username, password, ok := parseNickServCredentials(text, uc.nick)
1767 if !ok {
1768 return
1769 }
1770
1771 // User may have e.g. EXTERNAL mechanism configured. We do not want to
1772 // automatically erase the key pair or any other credentials.
1773 if uc.network.SASL.Mechanism != "" && uc.network.SASL.Mechanism != "PLAIN" {
1774 return
1775 }
1776
1777 dc.logger.Printf("auto-saving NickServ credentials with username %q", username)
1778 n := uc.network
1779 n.SASL.Mechanism = "PLAIN"
1780 n.SASL.Plain.Username = username
1781 n.SASL.Plain.Password = password
1782 if err := dc.srv.db.StoreNetwork(dc.user.ID, &n.Network); err != nil {
1783 dc.logger.Printf("failed to save NickServ credentials: %v", err)
1784 }
1785}
1786
1787func parseNickServCredentials(text, nick string) (username, password string, ok bool) {
1788 fields := strings.Fields(text)
1789 if len(fields) < 2 {
1790 return "", "", false
1791 }
1792 cmd := strings.ToUpper(fields[0])
1793 params := fields[1:]
1794 switch cmd {
1795 case "REGISTER":
1796 username = nick
1797 password = params[0]
1798 case "IDENTIFY":
1799 if len(params) == 1 {
1800 username = nick
1801 password = params[0]
1802 } else {
1803 username = params[0]
1804 password = params[1]
1805 }
1806 case "SET":
1807 if len(params) == 2 && strings.EqualFold(params[0], "PASSWORD") {
1808 username = nick
1809 password = params[1]
1810 }
1811 default:
1812 return "", "", false
1813 }
1814 return username, password, true
1815}
Note: See TracBrowser for help on using the repository browser.