source: code/trunk/user.go@ 489

Last change on this file since 489 was 489, checked in by contact, 4 years ago

Save delivery receipts in DB

This avoids loosing history on restart for clients that don't
support chathistory.

Closes: ​https://todo.sr.ht/~emersion/soju/80
File size: 16.5 KB
Line 
1package soju
2
3import (
4 "crypto/sha256"
5 "encoding/binary"
6 "encoding/hex"
7 "fmt"
8 "time"
9
10 "gopkg.in/irc.v3"
11)
12
13type event interface{}
14
15type eventUpstreamMessage struct {
16 msg *irc.Message
17 uc *upstreamConn
18}
19
20type eventUpstreamConnectionError struct {
21 net *network
22 err error
23}
24
25type eventUpstreamConnected struct {
26 uc *upstreamConn
27}
28
29type eventUpstreamDisconnected struct {
30 uc *upstreamConn
31}
32
33type eventUpstreamError struct {
34 uc *upstreamConn
35 err error
36}
37
38type eventDownstreamMessage struct {
39 msg *irc.Message
40 dc *downstreamConn
41}
42
43type eventDownstreamConnected struct {
44 dc *downstreamConn
45}
46
47type eventDownstreamDisconnected struct {
48 dc *downstreamConn
49}
50
51type eventChannelDetach struct {
52 uc *upstreamConn
53 name string
54}
55
56type eventStop struct{}
57
58type deliveredClientMap map[string]string // client name -> msg ID
59
60type deliveredStore struct {
61 m deliveredCasemapMap
62}
63
64func newDeliveredStore() deliveredStore {
65 return deliveredStore{deliveredCasemapMap{newCasemapMap(0)}}
66}
67
68func (ds deliveredStore) HasTarget(target string) bool {
69 return ds.m.Value(target) != nil
70}
71
72func (ds deliveredStore) LoadID(target, clientName string) string {
73 clients := ds.m.Value(target)
74 if clients == nil {
75 return ""
76 }
77 return clients[clientName]
78}
79
80func (ds deliveredStore) StoreID(target, clientName, msgID string) {
81 clients := ds.m.Value(target)
82 if clients == nil {
83 clients = make(deliveredClientMap)
84 ds.m.SetValue(target, clients)
85 }
86 clients[clientName] = msgID
87}
88
89func (ds deliveredStore) ForEachTarget(f func(target string)) {
90 for _, entry := range ds.m.innerMap {
91 f(entry.originalKey)
92 }
93}
94
95func (ds deliveredStore) ForEachClient(f func(clientName string)) {
96 clients := make(map[string]struct{})
97 for _, entry := range ds.m.innerMap {
98 delivered := entry.value.(deliveredClientMap)
99 for clientName := range delivered {
100 clients[clientName] = struct{}{}
101 }
102 }
103
104 for clientName := range clients {
105 f(clientName)
106 }
107}
108
109type network struct {
110 Network
111 user *user
112 stopped chan struct{}
113
114 conn *upstreamConn
115 channels channelCasemapMap
116 delivered deliveredStore
117 lastError error
118 casemap casemapping
119}
120
121func newNetwork(user *user, record *Network, channels []Channel) *network {
122 m := channelCasemapMap{newCasemapMap(0)}
123 for _, ch := range channels {
124 ch := ch
125 m.SetValue(ch.Name, &ch)
126 }
127
128 return &network{
129 Network: *record,
130 user: user,
131 stopped: make(chan struct{}),
132 channels: m,
133 delivered: newDeliveredStore(),
134 casemap: casemapRFC1459,
135 }
136}
137
138func (net *network) forEachDownstream(f func(*downstreamConn)) {
139 net.user.forEachDownstream(func(dc *downstreamConn) {
140 if dc.network != nil && dc.network != net {
141 return
142 }
143 f(dc)
144 })
145}
146
147func (net *network) isStopped() bool {
148 select {
149 case <-net.stopped:
150 return true
151 default:
152 return false
153 }
154}
155
156func userIdent(u *User) string {
157 // The ident is a string we will send to upstream servers in clear-text.
158 // For privacy reasons, make sure it doesn't expose any meaningful user
159 // metadata. We just use the base64-encoded hashed ID, so that people don't
160 // start relying on the string being an integer or following a pattern.
161 var b [64]byte
162 binary.LittleEndian.PutUint64(b[:], uint64(u.ID))
163 h := sha256.Sum256(b[:])
164 return hex.EncodeToString(h[:16])
165}
166
167func (net *network) run() {
168 var lastTry time.Time
169 for {
170 if net.isStopped() {
171 return
172 }
173
174 if dur := time.Now().Sub(lastTry); dur < retryConnectDelay {
175 delay := retryConnectDelay - dur
176 net.user.srv.Logger.Printf("waiting %v before trying to reconnect to %q", delay.Truncate(time.Second), net.Addr)
177 time.Sleep(delay)
178 }
179 lastTry = time.Now()
180
181 uc, err := connectToUpstream(net)
182 if err != nil {
183 net.user.srv.Logger.Printf("failed to connect to upstream server %q: %v", net.Addr, err)
184 net.user.events <- eventUpstreamConnectionError{net, fmt.Errorf("failed to connect: %v", err)}
185 continue
186 }
187
188 if net.user.srv.Identd != nil {
189 net.user.srv.Identd.Store(uc.RemoteAddr().String(), uc.LocalAddr().String(), userIdent(&net.user.User))
190 }
191
192 uc.register()
193 if err := uc.runUntilRegistered(); err != nil {
194 text := err.Error()
195 if regErr, ok := err.(registrationError); ok {
196 text = string(regErr)
197 }
198 uc.logger.Printf("failed to register: %v", text)
199 net.user.events <- eventUpstreamConnectionError{net, fmt.Errorf("failed to register: %v", text)}
200 uc.Close()
201 continue
202 }
203
204 // TODO: this is racy with net.stopped. If the network is stopped
205 // before the user goroutine receives eventUpstreamConnected, the
206 // connection won't be closed.
207 net.user.events <- eventUpstreamConnected{uc}
208 if err := uc.readMessages(net.user.events); err != nil {
209 uc.logger.Printf("failed to handle messages: %v", err)
210 net.user.events <- eventUpstreamError{uc, fmt.Errorf("failed to handle messages: %v", err)}
211 }
212 uc.Close()
213 net.user.events <- eventUpstreamDisconnected{uc}
214
215 if net.user.srv.Identd != nil {
216 net.user.srv.Identd.Delete(uc.RemoteAddr().String(), uc.LocalAddr().String())
217 }
218 }
219}
220
221func (net *network) stop() {
222 if !net.isStopped() {
223 close(net.stopped)
224 }
225
226 if net.conn != nil {
227 net.conn.Close()
228 }
229}
230
231func (net *network) detach(ch *Channel) {
232 if ch.Detached {
233 return
234 }
235 ch.Detached = true
236 net.user.srv.Logger.Printf("network %q: detaching channel %q", net.GetName(), ch.Name)
237
238 if net.conn != nil {
239 uch := net.conn.channels.Value(ch.Name)
240 if uch != nil {
241 uch.updateAutoDetach(0)
242 }
243 }
244
245 net.forEachDownstream(func(dc *downstreamConn) {
246 dc.SendMessage(&irc.Message{
247 Prefix: dc.prefix(),
248 Command: "PART",
249 Params: []string{dc.marshalEntity(net, ch.Name), "Detach"},
250 })
251 })
252}
253
254func (net *network) attach(ch *Channel) {
255 if !ch.Detached {
256 return
257 }
258 ch.Detached = false
259 net.user.srv.Logger.Printf("network %q: attaching channel %q", net.GetName(), ch.Name)
260
261 var uch *upstreamChannel
262 if net.conn != nil {
263 uch = net.conn.channels.Value(ch.Name)
264
265 net.conn.updateChannelAutoDetach(ch.Name)
266 }
267
268 net.forEachDownstream(func(dc *downstreamConn) {
269 dc.SendMessage(&irc.Message{
270 Prefix: dc.prefix(),
271 Command: "JOIN",
272 Params: []string{dc.marshalEntity(net, ch.Name)},
273 })
274
275 if uch != nil {
276 forwardChannel(dc, uch)
277 }
278
279 dc.sendTargetBacklog(net, ch.Name)
280 })
281}
282
283func (net *network) deleteChannel(name string) error {
284 ch := net.channels.Value(name)
285 if ch == nil {
286 return fmt.Errorf("unknown channel %q", name)
287 }
288 if net.conn != nil {
289 uch := net.conn.channels.Value(ch.Name)
290 if uch != nil {
291 uch.updateAutoDetach(0)
292 }
293 }
294
295 if err := net.user.srv.db.DeleteChannel(ch.ID); err != nil {
296 return err
297 }
298 net.channels.Delete(name)
299 return nil
300}
301
302func (net *network) updateCasemapping(newCasemap casemapping) {
303 net.casemap = newCasemap
304 net.channels.SetCasemapping(newCasemap)
305 net.delivered.m.SetCasemapping(newCasemap)
306 if net.conn != nil {
307 net.conn.channels.SetCasemapping(newCasemap)
308 for _, entry := range net.conn.channels.innerMap {
309 uch := entry.value.(*upstreamChannel)
310 uch.Members.SetCasemapping(newCasemap)
311 }
312 }
313}
314
315func (net *network) storeClientDeliveryReceipts(clientName string) {
316 if !net.user.hasPersistentMsgStore() {
317 return
318 }
319
320 var receipts []DeliveryReceipt
321 net.delivered.ForEachTarget(func(target string) {
322 msgID := net.delivered.LoadID(target, clientName)
323 if msgID == "" {
324 return
325 }
326 receipts = append(receipts, DeliveryReceipt{
327 Target: target,
328 InternalMsgID: msgID,
329 })
330 })
331
332 if err := net.user.srv.db.StoreClientDeliveryReceipts(net.ID, clientName, receipts); err != nil {
333 net.user.srv.Logger.Printf("failed to store delivery receipts for user %q, client %q, network %q: %v", net.user.Username, clientName, net.GetName(), err)
334 }
335}
336
337type user struct {
338 User
339 srv *Server
340
341 events chan event
342 done chan struct{}
343
344 networks []*network
345 downstreamConns []*downstreamConn
346 msgStore messageStore
347
348 // LIST commands in progress
349 pendingLISTs []pendingLIST
350}
351
352type pendingLIST struct {
353 downstreamID uint64
354 // list of per-upstream LIST commands not yet sent or completed
355 pendingCommands map[int64]*irc.Message
356}
357
358func newUser(srv *Server, record *User) *user {
359 var msgStore messageStore
360 if srv.LogPath != "" {
361 msgStore = newFSMessageStore(srv.LogPath, record.Username)
362 } else {
363 msgStore = newMemoryMessageStore()
364 }
365
366 return &user{
367 User: *record,
368 srv: srv,
369 events: make(chan event, 64),
370 done: make(chan struct{}),
371 msgStore: msgStore,
372 }
373}
374
375func (u *user) forEachNetwork(f func(*network)) {
376 for _, network := range u.networks {
377 f(network)
378 }
379}
380
381func (u *user) forEachUpstream(f func(uc *upstreamConn)) {
382 for _, network := range u.networks {
383 if network.conn == nil {
384 continue
385 }
386 f(network.conn)
387 }
388}
389
390func (u *user) forEachDownstream(f func(dc *downstreamConn)) {
391 for _, dc := range u.downstreamConns {
392 f(dc)
393 }
394}
395
396func (u *user) getNetwork(name string) *network {
397 for _, network := range u.networks {
398 if network.Addr == name {
399 return network
400 }
401 if network.Name != "" && network.Name == name {
402 return network
403 }
404 }
405 return nil
406}
407
408func (u *user) getNetworkByID(id int64) *network {
409 for _, net := range u.networks {
410 if net.ID == id {
411 return net
412 }
413 }
414 return nil
415}
416
417func (u *user) run() {
418 defer func() {
419 if u.msgStore != nil {
420 if err := u.msgStore.Close(); err != nil {
421 u.srv.Logger.Printf("failed to close message store for user %q: %v", u.Username, err)
422 }
423 }
424 close(u.done)
425 }()
426
427 networks, err := u.srv.db.ListNetworks(u.ID)
428 if err != nil {
429 u.srv.Logger.Printf("failed to list networks for user %q: %v", u.Username, err)
430 return
431 }
432
433 for _, record := range networks {
434 record := record
435 channels, err := u.srv.db.ListChannels(record.ID)
436 if err != nil {
437 u.srv.Logger.Printf("failed to list channels for user %q, network %q: %v", u.Username, record.GetName(), err)
438 continue
439 }
440
441 network := newNetwork(u, &record, channels)
442 u.networks = append(u.networks, network)
443
444 if u.hasPersistentMsgStore() {
445 receipts, err := u.srv.db.ListDeliveryReceipts(record.ID)
446 if err != nil {
447 u.srv.Logger.Printf("failed to load delivery receipts for user %q, network %q: %v", u.Username, network.GetName(), err)
448 return
449 }
450
451 for _, rcpt := range receipts {
452 network.delivered.StoreID(rcpt.Target, rcpt.Client, rcpt.InternalMsgID)
453 }
454 }
455
456 go network.run()
457 }
458
459 for e := range u.events {
460 switch e := e.(type) {
461 case eventUpstreamConnected:
462 uc := e.uc
463
464 uc.network.conn = uc
465
466 uc.updateAway()
467
468 uc.forEachDownstream(func(dc *downstreamConn) {
469 dc.updateSupportedCaps()
470 sendServiceNOTICE(dc, fmt.Sprintf("connected to %s", uc.network.GetName()))
471
472 dc.updateNick()
473 })
474 uc.network.lastError = nil
475 case eventUpstreamDisconnected:
476 u.handleUpstreamDisconnected(e.uc)
477 case eventUpstreamConnectionError:
478 net := e.net
479
480 stopped := false
481 select {
482 case <-net.stopped:
483 stopped = true
484 default:
485 }
486
487 if !stopped && (net.lastError == nil || net.lastError.Error() != e.err.Error()) {
488 net.forEachDownstream(func(dc *downstreamConn) {
489 sendServiceNOTICE(dc, fmt.Sprintf("failed connecting/registering to %s: %v", net.GetName(), e.err))
490 })
491 }
492 net.lastError = e.err
493 case eventUpstreamError:
494 uc := e.uc
495
496 uc.forEachDownstream(func(dc *downstreamConn) {
497 sendServiceNOTICE(dc, fmt.Sprintf("disconnected from %s: %v", uc.network.GetName(), e.err))
498 })
499 uc.network.lastError = e.err
500 case eventUpstreamMessage:
501 msg, uc := e.msg, e.uc
502 if uc.isClosed() {
503 uc.logger.Printf("ignoring message on closed connection: %v", msg)
504 break
505 }
506 if err := uc.handleMessage(msg); err != nil {
507 uc.logger.Printf("failed to handle message %q: %v", msg, err)
508 }
509 case eventChannelDetach:
510 uc, name := e.uc, e.name
511 c := uc.network.channels.Value(name)
512 if c == nil || c.Detached {
513 continue
514 }
515 uc.network.detach(c)
516 if err := uc.srv.db.StoreChannel(uc.network.ID, c); err != nil {
517 u.srv.Logger.Printf("failed to store updated detached channel %q: %v", c.Name, err)
518 }
519 case eventDownstreamConnected:
520 dc := e.dc
521
522 if err := dc.welcome(); err != nil {
523 dc.logger.Printf("failed to handle new registered connection: %v", err)
524 break
525 }
526
527 u.downstreamConns = append(u.downstreamConns, dc)
528
529 dc.forEachNetwork(func(network *network) {
530 if network.lastError != nil {
531 sendServiceNOTICE(dc, fmt.Sprintf("disconnected from %s: %v", network.GetName(), network.lastError))
532 }
533 })
534
535 u.forEachUpstream(func(uc *upstreamConn) {
536 uc.updateAway()
537 })
538 case eventDownstreamDisconnected:
539 dc := e.dc
540
541 for i := range u.downstreamConns {
542 if u.downstreamConns[i] == dc {
543 u.downstreamConns = append(u.downstreamConns[:i], u.downstreamConns[i+1:]...)
544 break
545 }
546 }
547
548 dc.forEachNetwork(func(net *network) {
549 net.storeClientDeliveryReceipts(dc.clientName)
550 })
551
552 u.forEachUpstream(func(uc *upstreamConn) {
553 uc.updateAway()
554 })
555 case eventDownstreamMessage:
556 msg, dc := e.msg, e.dc
557 if dc.isClosed() {
558 dc.logger.Printf("ignoring message on closed connection: %v", msg)
559 break
560 }
561 err := dc.handleMessage(msg)
562 if ircErr, ok := err.(ircError); ok {
563 ircErr.Message.Prefix = dc.srv.prefix()
564 dc.SendMessage(ircErr.Message)
565 } else if err != nil {
566 dc.logger.Printf("failed to handle message %q: %v", msg, err)
567 dc.Close()
568 }
569 case eventStop:
570 u.forEachDownstream(func(dc *downstreamConn) {
571 dc.Close()
572 })
573 for _, n := range u.networks {
574 n.stop()
575
576 n.delivered.ForEachClient(func(clientName string) {
577 n.storeClientDeliveryReceipts(clientName)
578 })
579 }
580 return
581 default:
582 u.srv.Logger.Printf("received unknown event type: %T", e)
583 }
584 }
585}
586
587func (u *user) handleUpstreamDisconnected(uc *upstreamConn) {
588 uc.network.conn = nil
589
590 uc.endPendingLISTs(true)
591
592 for _, entry := range uc.channels.innerMap {
593 uch := entry.value.(*upstreamChannel)
594 uch.updateAutoDetach(0)
595 }
596
597 uc.forEachDownstream(func(dc *downstreamConn) {
598 dc.updateSupportedCaps()
599 })
600
601 if uc.network.lastError == nil {
602 uc.forEachDownstream(func(dc *downstreamConn) {
603 sendServiceNOTICE(dc, fmt.Sprintf("disconnected from %s", uc.network.GetName()))
604 })
605 }
606}
607
608func (u *user) addNetwork(network *network) {
609 u.networks = append(u.networks, network)
610 go network.run()
611}
612
613func (u *user) removeNetwork(network *network) {
614 network.stop()
615
616 u.forEachDownstream(func(dc *downstreamConn) {
617 if dc.network != nil && dc.network == network {
618 dc.Close()
619 }
620 })
621
622 for i, net := range u.networks {
623 if net == network {
624 u.networks = append(u.networks[:i], u.networks[i+1:]...)
625 return
626 }
627 }
628
629 panic("tried to remove a non-existing network")
630}
631
632func (u *user) createNetwork(record *Network) (*network, error) {
633 if record.ID != 0 {
634 panic("tried creating an already-existing network")
635 }
636
637 network := newNetwork(u, record, nil)
638 err := u.srv.db.StoreNetwork(u.ID, &network.Network)
639 if err != nil {
640 return nil, err
641 }
642
643 u.addNetwork(network)
644
645 return network, nil
646}
647
648func (u *user) updateNetwork(record *Network) (*network, error) {
649 if record.ID == 0 {
650 panic("tried updating a new network")
651 }
652
653 network := u.getNetworkByID(record.ID)
654 if network == nil {
655 panic("tried updating a non-existing network")
656 }
657
658 if err := u.srv.db.StoreNetwork(u.ID, record); err != nil {
659 return nil, err
660 }
661
662 // Most network changes require us to re-connect to the upstream server
663
664 channels := make([]Channel, 0, network.channels.Len())
665 for _, entry := range network.channels.innerMap {
666 ch := entry.value.(*Channel)
667 channels = append(channels, *ch)
668 }
669
670 updatedNetwork := newNetwork(u, record, channels)
671
672 // If we're currently connected, disconnect and perform the necessary
673 // bookkeeping
674 if network.conn != nil {
675 network.stop()
676 // Note: this will set network.conn to nil
677 u.handleUpstreamDisconnected(network.conn)
678 }
679
680 // Patch downstream connections to use our fresh updated network
681 u.forEachDownstream(func(dc *downstreamConn) {
682 if dc.network != nil && dc.network == network {
683 dc.network = updatedNetwork
684 }
685 })
686
687 // We need to remove the network after patching downstream connections,
688 // otherwise they'll get closed
689 u.removeNetwork(network)
690
691 // This will re-connect to the upstream server
692 u.addNetwork(updatedNetwork)
693
694 return updatedNetwork, nil
695}
696
697func (u *user) deleteNetwork(id int64) error {
698 network := u.getNetworkByID(id)
699 if network == nil {
700 panic("tried deleting a non-existing network")
701 }
702
703 if err := u.srv.db.DeleteNetwork(network.ID); err != nil {
704 return err
705 }
706
707 u.removeNetwork(network)
708 return nil
709}
710
711func (u *user) updatePassword(hashed string) error {
712 u.User.Password = hashed
713 return u.srv.db.StoreUser(&u.User)
714}
715
716func (u *user) stop() {
717 u.events <- eventStop{}
718 <-u.done
719}
720
721func (u *user) hasPersistentMsgStore() bool {
722 if u.msgStore == nil {
723 return false
724 }
725 _, isMem := u.msgStore.(*memoryMessageStore)
726 return !isMem
727}
Note: See TracBrowser for help on using the repository browser.