ntfy/server/server.go

415 lines
11 KiB
Go
Raw Normal View History

2021-10-23 01:26:01 +00:00
package server
import (
"bytes"
2021-10-29 03:50:38 +00:00
"context"
2021-10-24 18:22:53 +00:00
"embed"
2021-10-23 01:26:01 +00:00
_ "embed" // required for go:embed
"encoding/json"
2021-10-29 03:50:38 +00:00
firebase "firebase.google.com/go"
"firebase.google.com/go/messaging"
2021-10-23 17:21:33 +00:00
"fmt"
2021-10-29 03:50:38 +00:00
"google.golang.org/api/option"
"heckel.io/ntfy/config"
2021-10-23 01:26:01 +00:00
"io"
"log"
2021-10-24 02:49:50 +00:00
"net"
2021-10-23 01:26:01 +00:00
"net/http"
"regexp"
2021-10-29 17:58:14 +00:00
"strconv"
2021-10-23 01:26:01 +00:00
"strings"
"sync"
"time"
)
2021-10-29 17:58:14 +00:00
// TODO add "max messages in a topic" limit
2021-11-01 20:39:40 +00:00
// TODO implement "since=<ID>"
2021-10-29 17:58:14 +00:00
2021-10-24 02:49:50 +00:00
// Server is the main server
2021-10-23 01:26:01 +00:00
type Server struct {
2021-10-24 02:49:50 +00:00
config *config.Config
topics map[string]*topic
visitors map[string]*visitor
2021-10-29 17:58:14 +00:00
firebase subscriber
messages int64
2021-11-03 01:09:49 +00:00
cache cache
2021-10-24 02:49:50 +00:00
mu sync.Mutex
2021-10-23 01:26:01 +00:00
}
2021-10-24 02:49:50 +00:00
// errHTTP is a generic HTTP error for any non-200 HTTP error
type errHTTP struct {
Code int
Status string
}
func (e errHTTP) Error() string {
return fmt.Sprintf("http: %s", e.Status)
2021-10-23 01:26:01 +00:00
}
const (
2021-11-01 19:21:38 +00:00
messageLimit = 1024
2021-10-23 01:26:01 +00:00
)
var (
2021-10-29 17:58:14 +00:00
topicRegex = regexp.MustCompile(`^/[^/]+$`)
jsonRegex = regexp.MustCompile(`^/[^/]+/json$`)
sseRegex = regexp.MustCompile(`^/[^/]+/sse$`)
rawRegex = regexp.MustCompile(`^/[^/]+/raw$`)
staticRegex = regexp.MustCompile(`^/static/.+`)
2021-10-23 01:26:01 +00:00
//go:embed "index.html"
indexSource string
2021-10-24 18:22:53 +00:00
//go:embed static
webStaticFs embed.FS
2021-10-29 17:58:14 +00:00
errHTTPBadRequest = &errHTTP{http.StatusBadRequest, http.StatusText(http.StatusBadRequest)}
2021-10-24 02:49:50 +00:00
errHTTPNotFound = &errHTTP{http.StatusNotFound, http.StatusText(http.StatusNotFound)}
errHTTPTooManyRequests = &errHTTP{http.StatusTooManyRequests, http.StatusText(http.StatusTooManyRequests)}
2021-10-23 01:26:01 +00:00
)
2021-10-29 03:50:38 +00:00
func New(conf *config.Config) (*Server, error) {
2021-10-29 17:58:14 +00:00
var firebaseSubscriber subscriber
2021-10-29 03:50:38 +00:00
if conf.FirebaseKeyFile != "" {
2021-10-29 17:58:14 +00:00
var err error
firebaseSubscriber, err = createFirebaseSubscriber(conf)
2021-10-29 03:50:38 +00:00
if err != nil {
return nil, err
}
}
2021-11-03 01:09:49 +00:00
cache, err := createCache(conf)
2021-11-02 18:08:21 +00:00
if err != nil {
return nil, err
}
2021-11-03 01:09:49 +00:00
topics, err := cache.Topics()
if err != nil {
return nil, err
2021-11-02 18:08:21 +00:00
}
2021-10-23 01:26:01 +00:00
return &Server{
2021-10-24 02:49:50 +00:00
config: conf,
2021-11-03 01:09:49 +00:00
cache: cache,
2021-10-29 17:58:14 +00:00
firebase: firebaseSubscriber,
2021-11-02 18:08:21 +00:00
topics: topics,
2021-10-24 02:49:50 +00:00
visitors: make(map[string]*visitor),
2021-10-29 03:50:38 +00:00
}, nil
2021-10-23 01:26:01 +00:00
}
2021-11-03 01:09:49 +00:00
func createCache(conf *config.Config) (cache, error) {
if conf.CacheFile != "" {
return newSqliteCache(conf.CacheFile)
2021-11-02 18:08:21 +00:00
}
2021-11-03 01:09:49 +00:00
return newMemCache(), nil
2021-11-02 18:08:21 +00:00
}
2021-10-29 17:58:14 +00:00
func createFirebaseSubscriber(conf *config.Config) (subscriber, error) {
fb, err := firebase.NewApp(context.Background(), nil, option.WithCredentialsFile(conf.FirebaseKeyFile))
if err != nil {
return nil, err
}
msg, err := fb.Messaging(context.Background())
if err != nil {
return nil, err
}
return func(m *message) error {
_, err := msg.Send(context.Background(), &messaging.Message{
2021-10-29 19:47:46 +00:00
Topic: m.Topic,
2021-10-29 17:58:14 +00:00
Data: map[string]string{
"id": m.ID,
"time": fmt.Sprintf("%d", m.Time),
2021-10-29 19:47:46 +00:00
"event": m.Event,
2021-10-29 17:58:14 +00:00
"topic": m.Topic,
"message": m.Message,
},
})
return err
}, nil
}
2021-10-23 01:26:01 +00:00
func (s *Server) Run() error {
2021-10-24 02:49:50 +00:00
go func() {
ticker := time.NewTicker(s.config.ManagerInterval)
for {
<-ticker.C
s.updateStatsAndExpire()
}
}()
2021-10-23 19:22:17 +00:00
return s.listenAndServe()
}
func (s *Server) listenAndServe() error {
log.Printf("Listening on %s", s.config.ListenHTTP)
2021-10-23 01:26:01 +00:00
http.HandleFunc("/", s.handle)
return http.ListenAndServe(s.config.ListenHTTP, nil)
2021-10-23 01:26:01 +00:00
}
func (s *Server) handle(w http.ResponseWriter, r *http.Request) {
if err := s.handleInternal(w, r); err != nil {
2021-10-24 02:49:50 +00:00
if e, ok := err.(*errHTTP); ok {
s.fail(w, r, e.Code, e)
} else {
s.fail(w, r, http.StatusInternalServerError, err)
}
2021-10-23 01:26:01 +00:00
}
}
func (s *Server) handleInternal(w http.ResponseWriter, r *http.Request) error {
2021-10-24 02:49:50 +00:00
v := s.visitor(r.RemoteAddr)
2021-11-01 19:21:38 +00:00
if err := v.RequestAllowed(); err != nil {
return err
2021-10-24 02:49:50 +00:00
}
2021-10-23 01:26:01 +00:00
if r.Method == http.MethodGet && r.URL.Path == "/" {
return s.handleHome(w, r)
2021-10-24 18:22:53 +00:00
} else if r.Method == http.MethodGet && staticRegex.MatchString(r.URL.Path) {
return s.handleStatic(w, r)
2021-10-29 17:58:14 +00:00
} else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && topicRegex.MatchString(r.URL.Path) {
2021-11-01 20:39:40 +00:00
return s.handlePublish(w, r, v)
2021-10-23 01:26:01 +00:00
} else if r.Method == http.MethodGet && jsonRegex.MatchString(r.URL.Path) {
2021-11-01 19:21:38 +00:00
return s.handleSubscribeJSON(w, r, v)
2021-10-23 17:21:33 +00:00
} else if r.Method == http.MethodGet && sseRegex.MatchString(r.URL.Path) {
2021-11-01 19:21:38 +00:00
return s.handleSubscribeSSE(w, r, v)
} else if r.Method == http.MethodGet && rawRegex.MatchString(r.URL.Path) {
2021-11-01 19:21:38 +00:00
return s.handleSubscribeRaw(w, r, v)
2021-10-24 17:34:15 +00:00
} else if r.Method == http.MethodOptions {
return s.handleOptions(w, r)
2021-10-23 01:26:01 +00:00
}
2021-10-24 02:49:50 +00:00
return errHTTPNotFound
2021-10-23 01:26:01 +00:00
}
func (s *Server) handleHome(w http.ResponseWriter, r *http.Request) error {
_, err := io.WriteString(w, indexSource)
return err
}
2021-10-29 17:58:14 +00:00
func (s *Server) handleStatic(w http.ResponseWriter, r *http.Request) error {
http.FileServer(http.FS(webStaticFs)).ServeHTTP(w, r)
return nil
}
2021-11-01 20:39:40 +00:00
func (s *Server) handlePublish(w http.ResponseWriter, r *http.Request, v *visitor) error {
t, err := s.topic(r.URL.Path[1:])
if err != nil {
return err
}
2021-10-23 01:26:01 +00:00
reader := io.LimitReader(r.Body, messageLimit)
b, err := io.ReadAll(reader)
if err != nil {
return err
}
2021-11-02 18:08:21 +00:00
m := newDefaultMessage(t.id, string(b))
if err := t.Publish(m); err != nil {
2021-10-29 03:50:38 +00:00
return err
}
2021-11-03 01:09:49 +00:00
if err := s.cache.AddMessage(m); err != nil {
return err
2021-11-02 18:08:21 +00:00
}
2021-10-24 17:34:15 +00:00
w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
2021-11-03 15:33:34 +00:00
if err := json.NewEncoder(w).Encode(m); err != nil {
return err
}
2021-10-29 17:58:14 +00:00
s.mu.Lock()
s.messages++
s.mu.Unlock()
2021-10-24 17:34:15 +00:00
return nil
2021-10-23 01:26:01 +00:00
}
2021-11-01 19:21:38 +00:00
func (s *Server) handleSubscribeJSON(w http.ResponseWriter, r *http.Request, v *visitor) error {
encoder := func(msg *message) (string, error) {
var buf bytes.Buffer
if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
return "", err
2021-10-23 01:26:01 +00:00
}
return buf.String(), nil
2021-10-23 01:26:01 +00:00
}
2021-11-01 19:21:38 +00:00
return s.handleSubscribe(w, r, v, "json", "application/stream+json", encoder)
2021-10-23 01:26:01 +00:00
}
2021-11-01 19:21:38 +00:00
func (s *Server) handleSubscribeSSE(w http.ResponseWriter, r *http.Request, v *visitor) error {
encoder := func(msg *message) (string, error) {
2021-10-23 17:21:33 +00:00
var buf bytes.Buffer
if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
return "", err
2021-10-23 17:21:33 +00:00
}
2021-10-29 12:29:27 +00:00
if msg.Event != messageEvent {
return fmt.Sprintf("event: %s\ndata: %s\n", msg.Event, buf.String()), nil // Browser's .onmessage() does not fire on this!
2021-10-23 17:21:33 +00:00
}
return fmt.Sprintf("data: %s\n", buf.String()), nil
2021-10-23 19:22:17 +00:00
}
2021-11-01 19:21:38 +00:00
return s.handleSubscribe(w, r, v, "sse", "text/event-stream", encoder)
2021-10-23 17:21:33 +00:00
}
2021-11-01 19:21:38 +00:00
func (s *Server) handleSubscribeRaw(w http.ResponseWriter, r *http.Request, v *visitor) error {
encoder := func(msg *message) (string, error) {
2021-11-02 18:10:56 +00:00
if msg.Event == messageEvent { // only handle default events
return strings.ReplaceAll(msg.Message, "\n", " ") + "\n", nil
}
return "\n", nil // "keepalive" and "open" events just send an empty line
}
2021-11-01 19:21:38 +00:00
return s.handleSubscribe(w, r, v, "raw", "text/plain", encoder)
}
2021-11-01 19:21:38 +00:00
func (s *Server) handleSubscribe(w http.ResponseWriter, r *http.Request, v *visitor, format string, contentType string, encoder messageEncoder) error {
if err := v.AddSubscription(); err != nil {
2021-11-01 20:39:40 +00:00
return errHTTPTooManyRequests
2021-11-01 19:21:38 +00:00
}
defer v.RemoveSubscription()
2021-11-01 20:39:40 +00:00
t, err := s.topic(strings.TrimSuffix(r.URL.Path[1:], "/"+format)) // Hack
if err != nil {
return err
}
2021-10-29 17:58:14 +00:00
since, err := parseSince(r)
if err != nil {
return err
}
poll := r.URL.Query().Has("poll")
sub := func(msg *message) error {
m, err := encoder(msg)
if err != nil {
return err
}
if _, err := w.Write([]byte(m)); err != nil {
return err
}
if fl, ok := w.(http.Flusher); ok {
fl.Flush()
}
return nil
}
w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
w.Header().Set("Content-Type", contentType)
2021-10-29 17:58:14 +00:00
if poll {
2021-11-03 01:09:49 +00:00
return s.sendOldMessages(t, since, sub)
2021-10-29 17:58:14 +00:00
}
subscriberID := t.Subscribe(sub)
defer t.Unsubscribe(subscriberID)
if err := sub(newOpenMessage(t.id)); err != nil { // Send out open message
return err
}
2021-11-03 01:09:49 +00:00
if err := s.sendOldMessages(t, since, sub); err != nil {
return err
}
for {
select {
case <-r.Context().Done():
return nil
case <-time.After(s.config.KeepaliveInterval):
2021-11-01 19:21:38 +00:00
v.Keepalive()
2021-10-29 17:58:14 +00:00
if err := sub(newKeepaliveMessage(t.id)); err != nil { // Send keepalive message
return err
}
}
}
}
2021-11-03 01:09:49 +00:00
func (s *Server) sendOldMessages(t *topic, since time.Time, sub subscriber) error {
2021-10-29 17:58:14 +00:00
if since.IsZero() {
return nil
}
2021-11-03 01:09:49 +00:00
messages, err := s.cache.Messages(t.id, since)
if err != nil {
return err
}
for _, m := range messages {
2021-10-29 17:58:14 +00:00
if err := sub(m); err != nil {
return err
}
}
2021-10-24 17:34:15 +00:00
return nil
}
2021-10-29 17:58:14 +00:00
func parseSince(r *http.Request) (time.Time, error) {
if !r.URL.Query().Has("since") {
return time.Time{}, nil
}
if since, err := strconv.ParseInt(r.URL.Query().Get("since"), 10, 64); err == nil {
return time.Unix(since, 0), nil
}
if d, err := time.ParseDuration(r.URL.Query().Get("since")); err == nil {
return time.Now().Add(-1 * d), nil
}
return time.Time{}, errHTTPBadRequest
}
func (s *Server) handleOptions(w http.ResponseWriter, r *http.Request) error {
w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
w.Header().Set("Access-Control-Allow-Methods", "GET, PUT, POST")
2021-10-24 18:22:53 +00:00
return nil
}
2021-11-01 20:39:40 +00:00
func (s *Server) topic(id string) (*topic, error) {
2021-10-23 01:26:01 +00:00
s.mu.Lock()
defer s.mu.Unlock()
if _, ok := s.topics[id]; !ok {
2021-11-01 20:39:40 +00:00
if len(s.topics) >= s.config.GlobalTopicLimit {
return nil, errHTTPTooManyRequests
}
2021-11-03 01:09:49 +00:00
s.topics[id] = newTopic(id, time.Now())
2021-10-29 17:58:14 +00:00
if s.firebase != nil {
s.topics[id].Subscribe(s.firebase)
}
2021-10-23 01:26:01 +00:00
}
2021-11-01 20:39:40 +00:00
return s.topics[id], nil
2021-10-23 01:26:01 +00:00
}
2021-10-29 17:58:14 +00:00
func (s *Server) updateStatsAndExpire() {
2021-10-23 01:26:01 +00:00
s.mu.Lock()
defer s.mu.Unlock()
2021-10-29 17:58:14 +00:00
// Expire visitors from rate visitors map
for ip, v := range s.visitors {
2021-11-01 19:21:38 +00:00
if v.Stale() {
2021-10-29 17:58:14 +00:00
delete(s.visitors, ip)
}
2021-10-23 01:26:01 +00:00
}
2021-11-02 18:08:21 +00:00
// Prune cache
2021-11-03 15:33:34 +00:00
if err := s.cache.Prune(s.config.CacheDuration); err != nil {
2021-11-03 01:09:49 +00:00
log.Printf("error pruning cache: %s", err.Error())
2021-11-02 18:08:21 +00:00
}
2021-11-01 19:21:38 +00:00
// Prune old messages, remove subscriptions without subscribers
2021-11-03 01:09:49 +00:00
var subscribers, messages int
2021-10-29 17:58:14 +00:00
for _, t := range s.topics {
2021-11-03 01:09:49 +00:00
subs := t.Subscribers()
msgs, err := s.cache.MessageCount(t.id)
if err != nil {
log.Printf("cannot get stats for topic %s: %s", t.id, err.Error())
continue
}
2021-11-01 20:39:40 +00:00
if msgs == 0 && (subs == 0 || (s.firebase != nil && subs == 1)) { // Firebase is a subscriber!
2021-10-29 17:58:14 +00:00
delete(s.topics, t.id)
2021-11-03 01:09:49 +00:00
continue
2021-10-29 17:58:14 +00:00
}
subscribers += subs
messages += msgs
}
2021-11-03 01:09:49 +00:00
// Print stats
2021-10-29 17:58:14 +00:00
log.Printf("Stats: %d message(s) published, %d topic(s) active, %d subscriber(s), %d message(s) buffered, %d visitor(s)",
s.messages, len(s.topics), subscribers, messages, len(s.visitors))
}
2021-10-24 02:49:50 +00:00
// visitor creates or retrieves a rate.Limiter for the given visitor.
// This function was taken from https://www.alexedwards.net/blog/how-to-rate-limit-http-requests (MIT).
func (s *Server) visitor(remoteAddr string) *visitor {
s.mu.Lock()
defer s.mu.Unlock()
ip, _, err := net.SplitHostPort(remoteAddr)
if err != nil {
ip = remoteAddr // This should not happen in real life; only in tests.
}
v, exists := s.visitors[ip]
if !exists {
2021-11-01 19:21:38 +00:00
s.visitors[ip] = newVisitor(s.config)
return s.visitors[ip]
2021-10-24 02:49:50 +00:00
}
v.seen = time.Now()
return v
}
func (s *Server) fail(w http.ResponseWriter, r *http.Request, code int, err error) {
log.Printf("[%s] %s - %d - %s", r.RemoteAddr, r.Method, code, err.Error())
w.WriteHeader(code)
io.WriteString(w, fmt.Sprintf("%s\n", http.StatusText(code)))
}