server.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765
  1. package server
  2. import (
  3. "bytes"
  4. "context"
  5. "embed" // required for go:embed
  6. "encoding/json"
  7. firebase "firebase.google.com/go"
  8. "firebase.google.com/go/messaging"
  9. "fmt"
  10. "google.golang.org/api/option"
  11. "heckel.io/ntfy/util"
  12. "html/template"
  13. "io"
  14. "log"
  15. "net"
  16. "net/http"
  17. "regexp"
  18. "strconv"
  19. "strings"
  20. "sync"
  21. "time"
  22. )
  23. // TODO add "max messages in a topic" limit
  24. // TODO implement "since=<ID>"
  25. // Server is the main server, providing the UI and API for ntfy
  26. type Server struct {
  27. config *Config
  28. httpServer *http.Server
  29. httpsServer *http.Server
  30. topics map[string]*topic
  31. visitors map[string]*visitor
  32. firebase subscriber
  33. messages int64
  34. cache cache
  35. closeChan chan bool
  36. mu sync.Mutex
  37. }
  38. // errHTTP is a generic HTTP error for any non-200 HTTP error
  39. type errHTTP struct {
  40. Code int
  41. Status string
  42. }
  43. func (e errHTTP) Error() string {
  44. return fmt.Sprintf("http: %s", e.Status)
  45. }
  46. type indexPage struct {
  47. Topic string
  48. CacheDuration time.Duration
  49. }
  50. type sinceTime time.Time
  51. func (t sinceTime) IsAll() bool {
  52. return t == sinceAllMessages
  53. }
  54. func (t sinceTime) IsNone() bool {
  55. return t == sinceNoMessages
  56. }
  57. func (t sinceTime) Time() time.Time {
  58. return time.Time(t)
  59. }
  60. var (
  61. sinceAllMessages = sinceTime(time.Unix(0, 0))
  62. sinceNoMessages = sinceTime(time.Unix(1, 0))
  63. )
  64. var (
  65. topicRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}$`) // Regex must match JS & Android app!
  66. jsonRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/json$`)
  67. sseRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/sse$`)
  68. rawRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/raw$`)
  69. sendRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/(publish|send|trigger)$`)
  70. staticRegex = regexp.MustCompile(`^/static/.+`)
  71. docsRegex = regexp.MustCompile(`^/docs(|/.*)$`)
  72. disallowedTopics = []string{"docs", "static"}
  73. templateFnMap = template.FuncMap{
  74. "durationToHuman": util.DurationToHuman,
  75. }
  76. //go:embed "index.gohtml"
  77. indexSource string
  78. indexTemplate = template.Must(template.New("index").Funcs(templateFnMap).Parse(indexSource))
  79. //go:embed "example.html"
  80. exampleSource string
  81. //go:embed static
  82. webStaticFs embed.FS
  83. webStaticFsCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: webStaticFs}
  84. //go:embed docs
  85. docsStaticFs embed.FS
  86. docsStaticCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: docsStaticFs}
  87. errHTTPBadRequest = &errHTTP{http.StatusBadRequest, http.StatusText(http.StatusBadRequest)}
  88. errHTTPNotFound = &errHTTP{http.StatusNotFound, http.StatusText(http.StatusNotFound)}
  89. errHTTPTooManyRequests = &errHTTP{http.StatusTooManyRequests, http.StatusText(http.StatusTooManyRequests)}
  90. )
  91. const (
  92. firebaseControlTopic = "~control" // See Android if changed
  93. )
  94. // New instantiates a new Server. It creates the cache and adds a Firebase
  95. // subscriber (if configured).
  96. func New(conf *Config) (*Server, error) {
  97. var firebaseSubscriber subscriber
  98. if conf.FirebaseKeyFile != "" {
  99. var err error
  100. firebaseSubscriber, err = createFirebaseSubscriber(conf)
  101. if err != nil {
  102. return nil, err
  103. }
  104. }
  105. cache, err := createCache(conf)
  106. if err != nil {
  107. return nil, err
  108. }
  109. topics, err := cache.Topics()
  110. if err != nil {
  111. return nil, err
  112. }
  113. return &Server{
  114. config: conf,
  115. cache: cache,
  116. firebase: firebaseSubscriber,
  117. topics: topics,
  118. visitors: make(map[string]*visitor),
  119. }, nil
  120. }
  121. func createCache(conf *Config) (cache, error) {
  122. if conf.CacheDuration == 0 {
  123. return newNopCache(), nil
  124. } else if conf.CacheFile != "" {
  125. return newSqliteCache(conf.CacheFile)
  126. }
  127. return newMemCache(), nil
  128. }
  129. func createFirebaseSubscriber(conf *Config) (subscriber, error) {
  130. fb, err := firebase.NewApp(context.Background(), nil, option.WithCredentialsFile(conf.FirebaseKeyFile))
  131. if err != nil {
  132. return nil, err
  133. }
  134. msg, err := fb.Messaging(context.Background())
  135. if err != nil {
  136. return nil, err
  137. }
  138. return func(m *message) error {
  139. var data map[string]string // Matches https://ntfy.sh/docs/subscribe/api/#json-message-format
  140. switch m.Event {
  141. case keepaliveEvent, openEvent:
  142. data = map[string]string{
  143. "id": m.ID,
  144. "time": fmt.Sprintf("%d", m.Time),
  145. "event": m.Event,
  146. "topic": m.Topic,
  147. }
  148. case messageEvent:
  149. data = map[string]string{
  150. "id": m.ID,
  151. "time": fmt.Sprintf("%d", m.Time),
  152. "event": m.Event,
  153. "topic": m.Topic,
  154. "priority": fmt.Sprintf("%d", m.Priority),
  155. "tags": strings.Join(m.Tags, ","),
  156. "title": m.Title,
  157. "message": m.Message,
  158. }
  159. }
  160. _, err := msg.Send(context.Background(), &messaging.Message{
  161. Topic: m.Topic,
  162. Data: data,
  163. })
  164. return err
  165. }, nil
  166. }
  167. // Run executes the main server. It listens on HTTP (+ HTTPS, if configured), and starts
  168. // a manager go routine to print stats and prune messages.
  169. func (s *Server) Run() error {
  170. listenStr := fmt.Sprintf("%s/http", s.config.ListenHTTP)
  171. if s.config.ListenHTTPS != "" {
  172. listenStr += fmt.Sprintf(" %s/https", s.config.ListenHTTPS)
  173. }
  174. log.Printf("Listening on %s", listenStr)
  175. mux := http.NewServeMux()
  176. mux.HandleFunc("/", s.handle)
  177. errChan := make(chan error)
  178. s.mu.Lock()
  179. s.closeChan = make(chan bool)
  180. s.httpServer = &http.Server{Addr: s.config.ListenHTTP, Handler: mux}
  181. go func() {
  182. errChan <- s.httpServer.ListenAndServe()
  183. }()
  184. if s.config.ListenHTTPS != "" {
  185. s.httpsServer = &http.Server{Addr: s.config.ListenHTTP, Handler: mux}
  186. go func() {
  187. errChan <- s.httpsServer.ListenAndServeTLS(s.config.CertFile, s.config.KeyFile)
  188. }()
  189. }
  190. s.mu.Unlock()
  191. go s.runManager()
  192. go s.runAtSender()
  193. go s.runFirebaseKeepliver()
  194. return <-errChan
  195. }
  196. // Stop stops HTTP (+HTTPS) server and all managers
  197. func (s *Server) Stop() {
  198. s.mu.Lock()
  199. defer s.mu.Unlock()
  200. if s.httpServer != nil {
  201. s.httpServer.Close()
  202. }
  203. if s.httpsServer != nil {
  204. s.httpsServer.Close()
  205. }
  206. close(s.closeChan)
  207. }
  208. func (s *Server) handle(w http.ResponseWriter, r *http.Request) {
  209. if err := s.handleInternal(w, r); err != nil {
  210. if e, ok := err.(*errHTTP); ok {
  211. s.fail(w, r, e.Code, e)
  212. } else {
  213. s.fail(w, r, http.StatusInternalServerError, err)
  214. }
  215. }
  216. }
  217. func (s *Server) handleInternal(w http.ResponseWriter, r *http.Request) error {
  218. if r.Method == http.MethodGet && r.URL.Path == "/" {
  219. return s.handleHome(w, r)
  220. } else if r.Method == http.MethodGet && r.URL.Path == "/example.html" {
  221. return s.handleExample(w, r)
  222. } else if r.Method == http.MethodHead && r.URL.Path == "/" {
  223. return s.handleEmpty(w, r)
  224. } else if r.Method == http.MethodGet && staticRegex.MatchString(r.URL.Path) {
  225. return s.handleStatic(w, r)
  226. } else if r.Method == http.MethodGet && docsRegex.MatchString(r.URL.Path) {
  227. return s.handleDocs(w, r)
  228. } else if r.Method == http.MethodOptions {
  229. return s.handleOptions(w, r)
  230. } else if r.Method == http.MethodGet && topicRegex.MatchString(r.URL.Path) {
  231. return s.handleHome(w, r)
  232. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && topicRegex.MatchString(r.URL.Path) {
  233. return s.withRateLimit(w, r, s.handlePublish)
  234. } else if r.Method == http.MethodGet && sendRegex.MatchString(r.URL.Path) {
  235. return s.withRateLimit(w, r, s.handlePublish)
  236. } else if r.Method == http.MethodGet && jsonRegex.MatchString(r.URL.Path) {
  237. return s.withRateLimit(w, r, s.handleSubscribeJSON)
  238. } else if r.Method == http.MethodGet && sseRegex.MatchString(r.URL.Path) {
  239. return s.withRateLimit(w, r, s.handleSubscribeSSE)
  240. } else if r.Method == http.MethodGet && rawRegex.MatchString(r.URL.Path) {
  241. return s.withRateLimit(w, r, s.handleSubscribeRaw)
  242. }
  243. return errHTTPNotFound
  244. }
  245. func (s *Server) handleHome(w http.ResponseWriter, r *http.Request) error {
  246. return indexTemplate.Execute(w, &indexPage{
  247. Topic: r.URL.Path[1:],
  248. CacheDuration: s.config.CacheDuration,
  249. })
  250. }
  251. func (s *Server) handleEmpty(_ http.ResponseWriter, _ *http.Request) error {
  252. return nil
  253. }
  254. func (s *Server) handleExample(w http.ResponseWriter, _ *http.Request) error {
  255. _, err := io.WriteString(w, exampleSource)
  256. return err
  257. }
  258. func (s *Server) handleStatic(w http.ResponseWriter, r *http.Request) error {
  259. http.FileServer(http.FS(webStaticFsCached)).ServeHTTP(w, r)
  260. return nil
  261. }
  262. func (s *Server) handleDocs(w http.ResponseWriter, r *http.Request) error {
  263. http.FileServer(http.FS(docsStaticCached)).ServeHTTP(w, r)
  264. return nil
  265. }
  266. func (s *Server) handlePublish(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  267. t, err := s.topicFromPath(r.URL.Path)
  268. if err != nil {
  269. return err
  270. }
  271. reader := io.LimitReader(r.Body, int64(s.config.MessageLimit))
  272. b, err := io.ReadAll(reader)
  273. if err != nil {
  274. return err
  275. }
  276. m := newDefaultMessage(t.ID, strings.TrimSpace(string(b)))
  277. cache, firebase, err := s.parseParams(r, m)
  278. if err != nil {
  279. return err
  280. }
  281. if m.Message == "" {
  282. m.Message = "triggered"
  283. }
  284. delayed := m.Time > time.Now().Unix()
  285. if !delayed {
  286. if err := t.Publish(m); err != nil {
  287. return err
  288. }
  289. }
  290. if s.firebase != nil && firebase && !delayed {
  291. go func() {
  292. if err := s.firebase(m); err != nil {
  293. log.Printf("Unable to publish to Firebase: %v", err.Error())
  294. }
  295. }()
  296. }
  297. if cache {
  298. if err := s.cache.AddMessage(m); err != nil {
  299. return err
  300. }
  301. }
  302. w.Header().Set("Content-Type", "application/json")
  303. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  304. if err := json.NewEncoder(w).Encode(m); err != nil {
  305. return err
  306. }
  307. s.inc(&s.messages)
  308. return nil
  309. }
  310. func (s *Server) parseParams(r *http.Request, m *message) (cache bool, firebase bool, err error) {
  311. cache = readParam(r, "x-cache", "cache") != "no"
  312. firebase = readParam(r, "x-firebase", "firebase") != "no"
  313. m.Title = readParam(r, "x-title", "title", "t")
  314. messageStr := readParam(r, "x-message", "message", "m")
  315. if messageStr != "" {
  316. m.Message = messageStr
  317. }
  318. m.Priority, err = util.ParsePriority(readParam(r, "x-priority", "priority", "prio", "p"))
  319. if err != nil {
  320. return false, false, errHTTPBadRequest
  321. }
  322. tagsStr := readParam(r, "x-tags", "tags", "tag", "ta")
  323. if tagsStr != "" {
  324. m.Tags = make([]string, 0)
  325. for _, s := range util.SplitNoEmpty(tagsStr, ",") {
  326. m.Tags = append(m.Tags, strings.TrimSpace(s))
  327. }
  328. }
  329. delayStr := readParam(r, "x-delay", "delay", "x-at", "at", "x-in", "in")
  330. if delayStr != "" {
  331. if !cache {
  332. return false, false, errHTTPBadRequest
  333. }
  334. delay, err := util.ParseFutureTime(delayStr, time.Now())
  335. if err != nil {
  336. return false, false, errHTTPBadRequest
  337. } else if delay.Unix() < time.Now().Add(s.config.MinDelay).Unix() {
  338. return false, false, errHTTPBadRequest
  339. } else if delay.Unix() > time.Now().Add(s.config.MaxDelay).Unix() {
  340. return false, false, errHTTPBadRequest
  341. }
  342. m.Time = delay.Unix()
  343. }
  344. return cache, firebase, nil
  345. }
  346. func readParam(r *http.Request, names ...string) string {
  347. for _, name := range names {
  348. value := r.Header.Get(name)
  349. if value != "" {
  350. return strings.TrimSpace(value)
  351. }
  352. }
  353. for _, name := range names {
  354. value := r.URL.Query().Get(strings.ToLower(name))
  355. if value != "" {
  356. return strings.TrimSpace(value)
  357. }
  358. }
  359. return ""
  360. }
  361. func (s *Server) handleSubscribeJSON(w http.ResponseWriter, r *http.Request, v *visitor) error {
  362. encoder := func(msg *message) (string, error) {
  363. var buf bytes.Buffer
  364. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  365. return "", err
  366. }
  367. return buf.String(), nil
  368. }
  369. return s.handleSubscribe(w, r, v, "json", "application/x-ndjson", encoder)
  370. }
  371. func (s *Server) handleSubscribeSSE(w http.ResponseWriter, r *http.Request, v *visitor) error {
  372. encoder := func(msg *message) (string, error) {
  373. var buf bytes.Buffer
  374. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  375. return "", err
  376. }
  377. if msg.Event != messageEvent {
  378. return fmt.Sprintf("event: %s\ndata: %s\n", msg.Event, buf.String()), nil // Browser's .onmessage() does not fire on this!
  379. }
  380. return fmt.Sprintf("data: %s\n", buf.String()), nil
  381. }
  382. return s.handleSubscribe(w, r, v, "sse", "text/event-stream", encoder)
  383. }
  384. func (s *Server) handleSubscribeRaw(w http.ResponseWriter, r *http.Request, v *visitor) error {
  385. encoder := func(msg *message) (string, error) {
  386. if msg.Event == messageEvent { // only handle default events
  387. return strings.ReplaceAll(msg.Message, "\n", " ") + "\n", nil
  388. }
  389. return "\n", nil // "keepalive" and "open" events just send an empty line
  390. }
  391. return s.handleSubscribe(w, r, v, "raw", "text/plain", encoder)
  392. }
  393. func (s *Server) handleSubscribe(w http.ResponseWriter, r *http.Request, v *visitor, format string, contentType string, encoder messageEncoder) error {
  394. if err := v.AddSubscription(); err != nil {
  395. return errHTTPTooManyRequests
  396. }
  397. defer v.RemoveSubscription()
  398. topicsStr := strings.TrimSuffix(r.URL.Path[1:], "/"+format) // Hack
  399. topicIDs := util.SplitNoEmpty(topicsStr, ",")
  400. topics, err := s.topicsFromIDs(topicIDs...)
  401. if err != nil {
  402. return err
  403. }
  404. poll := readParam(r, "x-poll", "poll", "po") == "1"
  405. scheduled := readParam(r, "x-scheduled", "scheduled", "sched") == "1"
  406. since, err := parseSince(r, poll)
  407. if err != nil {
  408. return err
  409. }
  410. messageFilter, titleFilter, priorityFilter, tagsFilter, err := parseQueryFilters(r)
  411. if err != nil {
  412. return err
  413. }
  414. var wlock sync.Mutex
  415. sub := func(msg *message) error {
  416. if !passesQueryFilter(msg, messageFilter, titleFilter, priorityFilter, tagsFilter) {
  417. return nil
  418. }
  419. m, err := encoder(msg)
  420. if err != nil {
  421. return err
  422. }
  423. wlock.Lock()
  424. defer wlock.Unlock()
  425. if _, err := w.Write([]byte(m)); err != nil {
  426. return err
  427. }
  428. if fl, ok := w.(http.Flusher); ok {
  429. fl.Flush()
  430. }
  431. return nil
  432. }
  433. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  434. w.Header().Set("Content-Type", contentType+"; charset=utf-8") // Android/Volley client needs charset!
  435. if poll {
  436. return s.sendOldMessages(topics, since, scheduled, sub)
  437. }
  438. subscriberIDs := make([]int, 0)
  439. for _, t := range topics {
  440. subscriberIDs = append(subscriberIDs, t.Subscribe(sub))
  441. }
  442. defer func() {
  443. for i, subscriberID := range subscriberIDs {
  444. topics[i].Unsubscribe(subscriberID) // Order!
  445. }
  446. }()
  447. if err := sub(newOpenMessage(topicsStr)); err != nil { // Send out open message
  448. return err
  449. }
  450. if err := s.sendOldMessages(topics, since, scheduled, sub); err != nil {
  451. return err
  452. }
  453. for {
  454. select {
  455. case <-r.Context().Done():
  456. return nil
  457. case <-time.After(s.config.KeepaliveInterval):
  458. v.Keepalive()
  459. if err := sub(newKeepaliveMessage(topicsStr)); err != nil { // Send keepalive message
  460. return err
  461. }
  462. }
  463. }
  464. }
  465. func parseQueryFilters(r *http.Request) (messageFilter string, titleFilter string, priorityFilter []int, tagsFilter []string, err error) {
  466. messageFilter = readParam(r, "x-message", "message", "m")
  467. titleFilter = readParam(r, "x-title", "title", "t")
  468. tagsFilter = util.SplitNoEmpty(readParam(r, "x-tags", "tags", "tag", "ta"), ",")
  469. priorityFilter = make([]int, 0)
  470. for _, p := range util.SplitNoEmpty(readParam(r, "x-priority", "priority", "prio", "p"), ",") {
  471. priority, err := util.ParsePriority(p)
  472. if err != nil {
  473. return "", "", nil, nil, err
  474. }
  475. priorityFilter = append(priorityFilter, priority)
  476. }
  477. return
  478. }
  479. func passesQueryFilter(msg *message, messageFilter string, titleFilter string, priorityFilter []int, tagsFilter []string) bool {
  480. if msg.Event != messageEvent {
  481. return true // filters only apply to messages
  482. }
  483. if messageFilter != "" && msg.Message != messageFilter {
  484. return false
  485. }
  486. if titleFilter != "" && msg.Title != titleFilter {
  487. return false
  488. }
  489. messagePriority := msg.Priority
  490. if messagePriority == 0 {
  491. messagePriority = 3 // For query filters, default priority (3) is the same as "not set" (0)
  492. }
  493. if len(priorityFilter) > 0 && !util.InIntList(priorityFilter, messagePriority) {
  494. return false
  495. }
  496. if len(tagsFilter) > 0 && !util.InStringListAll(msg.Tags, tagsFilter) {
  497. return false
  498. }
  499. return true
  500. }
  501. func (s *Server) sendOldMessages(topics []*topic, since sinceTime, scheduled bool, sub subscriber) error {
  502. if since.IsNone() {
  503. return nil
  504. }
  505. for _, t := range topics {
  506. messages, err := s.cache.Messages(t.ID, since, scheduled)
  507. if err != nil {
  508. return err
  509. }
  510. for _, m := range messages {
  511. if err := sub(m); err != nil {
  512. return err
  513. }
  514. }
  515. }
  516. return nil
  517. }
  518. // parseSince returns a timestamp identifying the time span from which cached messages should be received.
  519. //
  520. // Values in the "since=..." parameter can be either a unix timestamp or a duration (e.g. 12h), or
  521. // "all" for all messages.
  522. func parseSince(r *http.Request, poll bool) (sinceTime, error) {
  523. since := readParam(r, "x-since", "since", "si")
  524. if since == "" {
  525. if poll {
  526. return sinceAllMessages, nil
  527. }
  528. return sinceNoMessages, nil
  529. }
  530. if since == "all" {
  531. return sinceAllMessages, nil
  532. } else if s, err := strconv.ParseInt(since, 10, 64); err == nil {
  533. return sinceTime(time.Unix(s, 0)), nil
  534. } else if d, err := time.ParseDuration(since); err == nil {
  535. return sinceTime(time.Now().Add(-1 * d)), nil
  536. }
  537. return sinceNoMessages, errHTTPBadRequest
  538. }
  539. func (s *Server) handleOptions(w http.ResponseWriter, _ *http.Request) error {
  540. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  541. w.Header().Set("Access-Control-Allow-Methods", "GET, PUT, POST")
  542. return nil
  543. }
  544. func (s *Server) topicFromPath(path string) (*topic, error) {
  545. parts := strings.Split(path, "/")
  546. if len(parts) < 2 {
  547. return nil, errHTTPBadRequest
  548. }
  549. topics, err := s.topicsFromIDs(parts[1])
  550. if err != nil {
  551. return nil, err
  552. }
  553. return topics[0], nil
  554. }
  555. func (s *Server) topicsFromIDs(ids ...string) ([]*topic, error) {
  556. s.mu.Lock()
  557. defer s.mu.Unlock()
  558. topics := make([]*topic, 0)
  559. for _, id := range ids {
  560. if util.InStringList(disallowedTopics, id) {
  561. return nil, errHTTPBadRequest
  562. }
  563. if _, ok := s.topics[id]; !ok {
  564. if len(s.topics) >= s.config.GlobalTopicLimit {
  565. return nil, errHTTPTooManyRequests
  566. }
  567. s.topics[id] = newTopic(id)
  568. }
  569. topics = append(topics, s.topics[id])
  570. }
  571. return topics, nil
  572. }
  573. func (s *Server) updateStatsAndPrune() {
  574. s.mu.Lock()
  575. defer s.mu.Unlock()
  576. // Expire visitors from rate visitors map
  577. for ip, v := range s.visitors {
  578. if v.Stale() {
  579. delete(s.visitors, ip)
  580. }
  581. }
  582. // Prune message cache
  583. olderThan := time.Now().Add(-1 * s.config.CacheDuration)
  584. if err := s.cache.Prune(olderThan); err != nil {
  585. log.Printf("error pruning cache: %s", err.Error())
  586. }
  587. // Prune old topics, remove subscriptions without subscribers
  588. var subscribers, messages int
  589. for _, t := range s.topics {
  590. subs := t.Subscribers()
  591. msgs, err := s.cache.MessageCount(t.ID)
  592. if err != nil {
  593. log.Printf("cannot get stats for topic %s: %s", t.ID, err.Error())
  594. continue
  595. }
  596. if msgs == 0 && subs == 0 {
  597. delete(s.topics, t.ID)
  598. continue
  599. }
  600. subscribers += subs
  601. messages += msgs
  602. }
  603. // Print stats
  604. log.Printf("Stats: %d message(s) published, %d topic(s) active, %d subscriber(s), %d message(s) buffered, %d visitor(s)",
  605. s.messages, len(s.topics), subscribers, messages, len(s.visitors))
  606. }
  607. func (s *Server) runManager() {
  608. for {
  609. select {
  610. case <-time.After(s.config.ManagerInterval):
  611. s.updateStatsAndPrune()
  612. case <-s.closeChan:
  613. return
  614. }
  615. }
  616. }
  617. func (s *Server) runAtSender() {
  618. for {
  619. select {
  620. case <-time.After(s.config.AtSenderInterval):
  621. if err := s.sendDelayedMessages(); err != nil {
  622. log.Printf("error sending scheduled messages: %s", err.Error())
  623. }
  624. case <-s.closeChan:
  625. return
  626. }
  627. }
  628. }
  629. func (s *Server) runFirebaseKeepliver() {
  630. if s.firebase == nil {
  631. return
  632. }
  633. for {
  634. select {
  635. case <-time.After(s.config.FirebaseKeepaliveInterval):
  636. if err := s.firebase(newKeepaliveMessage(firebaseControlTopic)); err != nil {
  637. log.Printf("error sending Firebase keepalive message: %s", err.Error())
  638. }
  639. case <-s.closeChan:
  640. return
  641. }
  642. }
  643. }
  644. func (s *Server) sendDelayedMessages() error {
  645. s.mu.Lock()
  646. defer s.mu.Unlock()
  647. messages, err := s.cache.MessagesDue()
  648. if err != nil {
  649. return err
  650. }
  651. for _, m := range messages {
  652. t, ok := s.topics[m.Topic] // If no subscribers, just mark message as published
  653. if ok {
  654. if err := t.Publish(m); err != nil {
  655. log.Printf("unable to publish message %s to topic %s: %v", m.ID, m.Topic, err.Error())
  656. }
  657. if s.firebase != nil {
  658. if err := s.firebase(m); err != nil {
  659. log.Printf("unable to publish to Firebase: %v", err.Error())
  660. }
  661. }
  662. }
  663. if err := s.cache.MarkPublished(m); err != nil {
  664. return err
  665. }
  666. }
  667. return nil
  668. }
  669. func (s *Server) withRateLimit(w http.ResponseWriter, r *http.Request, handler func(w http.ResponseWriter, r *http.Request, v *visitor) error) error {
  670. v := s.visitor(r)
  671. if err := v.RequestAllowed(); err != nil {
  672. return err
  673. }
  674. return handler(w, r, v)
  675. }
  676. // visitor creates or retrieves a rate.Limiter for the given visitor.
  677. // This function was taken from https://www.alexedwards.net/blog/how-to-rate-limit-http-requests (MIT).
  678. func (s *Server) visitor(r *http.Request) *visitor {
  679. s.mu.Lock()
  680. defer s.mu.Unlock()
  681. remoteAddr := r.RemoteAddr
  682. ip, _, err := net.SplitHostPort(remoteAddr)
  683. if err != nil {
  684. ip = remoteAddr // This should not happen in real life; only in tests.
  685. }
  686. if s.config.BehindProxy && r.Header.Get("X-Forwarded-For") != "" {
  687. ip = r.Header.Get("X-Forwarded-For")
  688. }
  689. v, exists := s.visitors[ip]
  690. if !exists {
  691. s.visitors[ip] = newVisitor(s.config)
  692. return s.visitors[ip]
  693. }
  694. v.Keepalive()
  695. return v
  696. }
  697. func (s *Server) inc(counter *int64) {
  698. s.mu.Lock()
  699. defer s.mu.Unlock()
  700. *counter++
  701. }
  702. func (s *Server) fail(w http.ResponseWriter, r *http.Request, code int, err error) {
  703. log.Printf("[%s] %s - %d - %s", r.RemoteAddr, r.Method, code, err.Error())
  704. w.WriteHeader(code)
  705. _, _ = io.WriteString(w, fmt.Sprintf("%s\n", http.StatusText(code)))
  706. }