ntfy/server/topic.go

136 lines
3.7 KiB
Go
Raw Normal View History

2021-10-23 03:26:01 +02:00
package server
import (
"math/rand"
"sync"
2023-02-14 20:58:13 +01:00
"time"
"heckel.io/ntfy/log"
2021-10-23 03:26:01 +02:00
)
2021-10-24 04:49:50 +02:00
// topic represents a channel to which subscribers can subscribe, and publishers
// can publish a message
2021-10-23 03:26:01 +02:00
type topic struct {
2023-02-14 20:58:13 +01:00
ID string
subscribers map[int]*topicSubscriber
lastVisitor *visitor
lastVisitorExpires time.Time
mu sync.Mutex
2021-10-23 03:26:01 +02:00
}
type topicSubscriber struct {
subscriber subscriber
visitor *visitor // User ID associated with this subscription, may be empty
cancel func()
}
2021-10-24 04:49:50 +02:00
// subscriber is a function that is called for every new message on a topic
2022-06-01 02:38:56 +02:00
type subscriber func(v *visitor, msg *message) error
2021-10-23 03:26:01 +02:00
// newTopic creates a new topic
2021-12-09 04:57:31 +01:00
func newTopic(id string) *topic {
2021-10-23 03:26:01 +02:00
return &topic{
2021-12-09 04:57:31 +01:00
ID: id,
subscribers: make(map[int]*topicSubscriber),
2021-10-23 03:26:01 +02:00
}
}
2021-11-09 20:48:25 +01:00
// Subscribe subscribes to this topic
func (t *topic) Subscribe(s subscriber, visitor *visitor, cancel func()) int {
2021-10-23 03:26:01 +02:00
t.mu.Lock()
defer t.mu.Unlock()
subscriberID := rand.Int()
t.subscribers[subscriberID] = &topicSubscriber{
visitor: visitor, // May be empty
subscriber: s,
cancel: cancel,
}
2021-10-23 03:26:01 +02:00
return subscriberID
}
2023-02-14 20:58:13 +01:00
func (t *topic) Stale() bool {
return t.getBillee() == nil
}
func (t *topic) getBillee() *visitor {
for _, this_subscriber := range t.subscribers {
return this_subscriber.visitor
}
if t.lastVisitor != nil && t.lastVisitorExpires.After(time.Now()) {
t.lastVisitor = nil
}
return t.lastVisitor
}
2021-11-09 20:48:25 +01:00
// Unsubscribe removes the subscription from the list of subscribers
2021-10-29 19:58:14 +02:00
func (t *topic) Unsubscribe(id int) {
2021-10-23 03:26:01 +02:00
t.mu.Lock()
defer t.mu.Unlock()
2023-02-14 20:58:13 +01:00
if len(t.subscribers) == 1 {
t.lastVisitor = t.subscribers[id].visitor
t.lastVisitorExpires = time.Now().Add(subscriberBilledValidity)
}
2021-10-23 03:26:01 +02:00
delete(t.subscribers, id)
}
2021-11-09 20:48:25 +01:00
// Publish asynchronously publishes to all subscribers
2022-06-01 02:38:56 +02:00
func (t *topic) Publish(v *visitor, m *message) error {
2021-11-09 20:48:25 +01:00
go func() {
// We want to lock the topic as short as possible, so we make a shallow copy of the
// subscribers map here. Actually sending out the messages then doesn't have to lock.
subscribers := t.subscribersCopy()
if len(subscribers) > 0 {
2023-02-04 04:21:50 +01:00
logvm(v, m).Tag(tagPublish).Debug("Forwarding to %d subscriber(s)", len(subscribers))
for _, s := range subscribers {
// We call the subscriber functions in their own Go routines because they are blocking, and
// we don't want individual slow subscribers to be able to block others.
go func(s subscriber) {
if err := s(v, m); err != nil {
2023-02-04 04:21:50 +01:00
logvm(v, m).Tag(tagPublish).Err(err).Warn("Error forwarding to subscriber")
}
}(s.subscriber)
2021-11-09 20:48:25 +01:00
}
2022-06-01 22:57:35 +02:00
} else {
2023-02-04 04:21:50 +01:00
logvm(v, m).Tag(tagPublish).Trace("No stream or WebSocket subscribers, not forwarding")
2021-10-23 03:26:01 +02:00
}
2021-11-09 20:48:25 +01:00
}()
2021-10-23 03:26:01 +02:00
return nil
}
// SubscribersCount returns the number of subscribers to this topic
func (t *topic) SubscribersCount() int {
2021-10-29 19:58:14 +02:00
t.mu.Lock()
defer t.mu.Unlock()
2021-11-03 02:09:49 +01:00
return len(t.subscribers)
2021-10-23 03:26:01 +02:00
}
// CancelSubscribers calls the cancel function for all subscribers, forcing
func (t *topic) CancelSubscribers(exceptUserID string) {
t.mu.Lock()
defer t.mu.Unlock()
for _, s := range t.subscribers {
if s.visitor.MaybeUserID() != exceptUserID {
// TODO: Shouldn't this log the IP for anonymous visitors? It was s.userID before my change.
log.Tag(tagSubscribe).Field("topic", t.ID).Debug("Canceling subscriber %s", s.visitor.MaybeUserID())
s.cancel()
}
}
}
// subscribersCopy returns a shallow copy of the subscribers map
func (t *topic) subscribersCopy() map[int]*topicSubscriber {
t.mu.Lock()
defer t.mu.Unlock()
subscribers := make(map[int]*topicSubscriber)
for k, sub := range t.subscribers {
subscribers[k] = &topicSubscriber{
visitor: sub.visitor,
subscriber: sub.subscriber,
cancel: sub.cancel,
}
}
return subscribers
}