1
0

server.go 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764
  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. http.HandleFunc("/", s.handle)
  176. errChan := make(chan error)
  177. s.mu.Lock()
  178. s.closeChan = make(chan bool)
  179. s.httpServer = &http.Server{Addr: s.config.ListenHTTP}
  180. go func() {
  181. errChan <- s.httpServer.ListenAndServe()
  182. }()
  183. if s.config.ListenHTTPS != "" {
  184. s.httpsServer = &http.Server{Addr: s.config.ListenHTTP}
  185. go func() {
  186. errChan <- s.httpsServer.ListenAndServeTLS(s.config.CertFile, s.config.KeyFile)
  187. }()
  188. }
  189. s.mu.Unlock()
  190. go s.runManager()
  191. go s.runAtSender()
  192. go s.runFirebaseKeepliver()
  193. return <-errChan
  194. }
  195. // Stop stops HTTP (+HTTPS) server and all managers
  196. func (s *Server) Stop() {
  197. s.mu.Lock()
  198. defer s.mu.Unlock()
  199. if s.httpServer != nil {
  200. s.httpServer.Close()
  201. }
  202. if s.httpsServer != nil {
  203. s.httpsServer.Close()
  204. }
  205. close(s.closeChan)
  206. }
  207. func (s *Server) handle(w http.ResponseWriter, r *http.Request) {
  208. if err := s.handleInternal(w, r); err != nil {
  209. if e, ok := err.(*errHTTP); ok {
  210. s.fail(w, r, e.Code, e)
  211. } else {
  212. s.fail(w, r, http.StatusInternalServerError, err)
  213. }
  214. }
  215. }
  216. func (s *Server) handleInternal(w http.ResponseWriter, r *http.Request) error {
  217. if r.Method == http.MethodGet && r.URL.Path == "/" {
  218. return s.handleHome(w, r)
  219. } else if r.Method == http.MethodGet && r.URL.Path == "/example.html" {
  220. return s.handleExample(w, r)
  221. } else if r.Method == http.MethodHead && r.URL.Path == "/" {
  222. return s.handleEmpty(w, r)
  223. } else if r.Method == http.MethodGet && staticRegex.MatchString(r.URL.Path) {
  224. return s.handleStatic(w, r)
  225. } else if r.Method == http.MethodGet && docsRegex.MatchString(r.URL.Path) {
  226. return s.handleDocs(w, r)
  227. } else if r.Method == http.MethodOptions {
  228. return s.handleOptions(w, r)
  229. } else if r.Method == http.MethodGet && topicRegex.MatchString(r.URL.Path) {
  230. return s.handleHome(w, r)
  231. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && topicRegex.MatchString(r.URL.Path) {
  232. return s.withRateLimit(w, r, s.handlePublish)
  233. } else if r.Method == http.MethodGet && sendRegex.MatchString(r.URL.Path) {
  234. return s.withRateLimit(w, r, s.handlePublish)
  235. } else if r.Method == http.MethodGet && jsonRegex.MatchString(r.URL.Path) {
  236. return s.withRateLimit(w, r, s.handleSubscribeJSON)
  237. } else if r.Method == http.MethodGet && sseRegex.MatchString(r.URL.Path) {
  238. return s.withRateLimit(w, r, s.handleSubscribeSSE)
  239. } else if r.Method == http.MethodGet && rawRegex.MatchString(r.URL.Path) {
  240. return s.withRateLimit(w, r, s.handleSubscribeRaw)
  241. }
  242. return errHTTPNotFound
  243. }
  244. func (s *Server) handleHome(w http.ResponseWriter, r *http.Request) error {
  245. return indexTemplate.Execute(w, &indexPage{
  246. Topic: r.URL.Path[1:],
  247. CacheDuration: s.config.CacheDuration,
  248. })
  249. }
  250. func (s *Server) handleEmpty(_ http.ResponseWriter, _ *http.Request) error {
  251. return nil
  252. }
  253. func (s *Server) handleExample(w http.ResponseWriter, _ *http.Request) error {
  254. _, err := io.WriteString(w, exampleSource)
  255. return err
  256. }
  257. func (s *Server) handleStatic(w http.ResponseWriter, r *http.Request) error {
  258. http.FileServer(http.FS(webStaticFsCached)).ServeHTTP(w, r)
  259. return nil
  260. }
  261. func (s *Server) handleDocs(w http.ResponseWriter, r *http.Request) error {
  262. http.FileServer(http.FS(docsStaticCached)).ServeHTTP(w, r)
  263. return nil
  264. }
  265. func (s *Server) handlePublish(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  266. t, err := s.topicFromPath(r.URL.Path)
  267. if err != nil {
  268. return err
  269. }
  270. reader := io.LimitReader(r.Body, int64(s.config.MessageLimit))
  271. b, err := io.ReadAll(reader)
  272. if err != nil {
  273. return err
  274. }
  275. m := newDefaultMessage(t.ID, strings.TrimSpace(string(b)))
  276. cache, firebase, err := s.parseParams(r, m)
  277. if err != nil {
  278. return err
  279. }
  280. if m.Message == "" {
  281. m.Message = "triggered"
  282. }
  283. delayed := m.Time > time.Now().Unix()
  284. if !delayed {
  285. if err := t.Publish(m); err != nil {
  286. return err
  287. }
  288. }
  289. if s.firebase != nil && firebase && !delayed {
  290. go func() {
  291. if err := s.firebase(m); err != nil {
  292. log.Printf("Unable to publish to Firebase: %v", err.Error())
  293. }
  294. }()
  295. }
  296. if cache {
  297. if err := s.cache.AddMessage(m); err != nil {
  298. return err
  299. }
  300. }
  301. w.Header().Set("Content-Type", "application/json")
  302. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  303. if err := json.NewEncoder(w).Encode(m); err != nil {
  304. return err
  305. }
  306. s.inc(&s.messages)
  307. return nil
  308. }
  309. func (s *Server) parseParams(r *http.Request, m *message) (cache bool, firebase bool, err error) {
  310. cache = readParam(r, "x-cache", "cache") != "no"
  311. firebase = readParam(r, "x-firebase", "firebase") != "no"
  312. m.Title = readParam(r, "x-title", "title", "t")
  313. messageStr := readParam(r, "x-message", "message", "m")
  314. if messageStr != "" {
  315. m.Message = messageStr
  316. }
  317. m.Priority, err = util.ParsePriority(readParam(r, "x-priority", "priority", "prio", "p"))
  318. if err != nil {
  319. return false, false, errHTTPBadRequest
  320. }
  321. tagsStr := readParam(r, "x-tags", "tags", "tag", "ta")
  322. if tagsStr != "" {
  323. m.Tags = make([]string, 0)
  324. for _, s := range util.SplitNoEmpty(tagsStr, ",") {
  325. m.Tags = append(m.Tags, strings.TrimSpace(s))
  326. }
  327. }
  328. delayStr := readParam(r, "x-delay", "delay", "x-at", "at", "x-in", "in")
  329. if delayStr != "" {
  330. if !cache {
  331. return false, false, errHTTPBadRequest
  332. }
  333. delay, err := util.ParseFutureTime(delayStr, time.Now())
  334. if err != nil {
  335. return false, false, errHTTPBadRequest
  336. } else if delay.Unix() < time.Now().Add(s.config.MinDelay).Unix() {
  337. return false, false, errHTTPBadRequest
  338. } else if delay.Unix() > time.Now().Add(s.config.MaxDelay).Unix() {
  339. return false, false, errHTTPBadRequest
  340. }
  341. m.Time = delay.Unix()
  342. }
  343. return cache, firebase, nil
  344. }
  345. func readParam(r *http.Request, names ...string) string {
  346. for _, name := range names {
  347. value := r.Header.Get(name)
  348. if value != "" {
  349. return strings.TrimSpace(value)
  350. }
  351. }
  352. for _, name := range names {
  353. value := r.URL.Query().Get(strings.ToLower(name))
  354. if value != "" {
  355. return strings.TrimSpace(value)
  356. }
  357. }
  358. return ""
  359. }
  360. func (s *Server) handleSubscribeJSON(w http.ResponseWriter, r *http.Request, v *visitor) error {
  361. encoder := func(msg *message) (string, error) {
  362. var buf bytes.Buffer
  363. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  364. return "", err
  365. }
  366. return buf.String(), nil
  367. }
  368. return s.handleSubscribe(w, r, v, "json", "application/x-ndjson", encoder)
  369. }
  370. func (s *Server) handleSubscribeSSE(w http.ResponseWriter, r *http.Request, v *visitor) error {
  371. encoder := func(msg *message) (string, error) {
  372. var buf bytes.Buffer
  373. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  374. return "", err
  375. }
  376. if msg.Event != messageEvent {
  377. return fmt.Sprintf("event: %s\ndata: %s\n", msg.Event, buf.String()), nil // Browser's .onmessage() does not fire on this!
  378. }
  379. return fmt.Sprintf("data: %s\n", buf.String()), nil
  380. }
  381. return s.handleSubscribe(w, r, v, "sse", "text/event-stream", encoder)
  382. }
  383. func (s *Server) handleSubscribeRaw(w http.ResponseWriter, r *http.Request, v *visitor) error {
  384. encoder := func(msg *message) (string, error) {
  385. if msg.Event == messageEvent { // only handle default events
  386. return strings.ReplaceAll(msg.Message, "\n", " ") + "\n", nil
  387. }
  388. return "\n", nil // "keepalive" and "open" events just send an empty line
  389. }
  390. return s.handleSubscribe(w, r, v, "raw", "text/plain", encoder)
  391. }
  392. func (s *Server) handleSubscribe(w http.ResponseWriter, r *http.Request, v *visitor, format string, contentType string, encoder messageEncoder) error {
  393. if err := v.AddSubscription(); err != nil {
  394. return errHTTPTooManyRequests
  395. }
  396. defer v.RemoveSubscription()
  397. topicsStr := strings.TrimSuffix(r.URL.Path[1:], "/"+format) // Hack
  398. topicIDs := util.SplitNoEmpty(topicsStr, ",")
  399. topics, err := s.topicsFromIDs(topicIDs...)
  400. if err != nil {
  401. return err
  402. }
  403. poll := readParam(r, "x-poll", "poll", "po") == "1"
  404. scheduled := readParam(r, "x-scheduled", "scheduled", "sched") == "1"
  405. since, err := parseSince(r, poll)
  406. if err != nil {
  407. return err
  408. }
  409. messageFilter, titleFilter, priorityFilter, tagsFilter, err := parseQueryFilters(r)
  410. if err != nil {
  411. return err
  412. }
  413. var wlock sync.Mutex
  414. sub := func(msg *message) error {
  415. if !passesQueryFilter(msg, messageFilter, titleFilter, priorityFilter, tagsFilter) {
  416. return nil
  417. }
  418. m, err := encoder(msg)
  419. if err != nil {
  420. return err
  421. }
  422. wlock.Lock()
  423. defer wlock.Unlock()
  424. if _, err := w.Write([]byte(m)); err != nil {
  425. return err
  426. }
  427. if fl, ok := w.(http.Flusher); ok {
  428. fl.Flush()
  429. }
  430. return nil
  431. }
  432. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  433. w.Header().Set("Content-Type", contentType+"; charset=utf-8") // Android/Volley client needs charset!
  434. if poll {
  435. return s.sendOldMessages(topics, since, scheduled, sub)
  436. }
  437. subscriberIDs := make([]int, 0)
  438. for _, t := range topics {
  439. subscriberIDs = append(subscriberIDs, t.Subscribe(sub))
  440. }
  441. defer func() {
  442. for i, subscriberID := range subscriberIDs {
  443. topics[i].Unsubscribe(subscriberID) // Order!
  444. }
  445. }()
  446. if err := sub(newOpenMessage(topicsStr)); err != nil { // Send out open message
  447. return err
  448. }
  449. if err := s.sendOldMessages(topics, since, scheduled, sub); err != nil {
  450. return err
  451. }
  452. for {
  453. select {
  454. case <-r.Context().Done():
  455. return nil
  456. case <-time.After(s.config.KeepaliveInterval):
  457. v.Keepalive()
  458. if err := sub(newKeepaliveMessage(topicsStr)); err != nil { // Send keepalive message
  459. return err
  460. }
  461. }
  462. }
  463. }
  464. func parseQueryFilters(r *http.Request) (messageFilter string, titleFilter string, priorityFilter []int, tagsFilter []string, err error) {
  465. messageFilter = readParam(r, "x-message", "message", "m")
  466. titleFilter = readParam(r, "x-title", "title", "t")
  467. tagsFilter = util.SplitNoEmpty(readParam(r, "x-tags", "tags", "tag", "ta"), ",")
  468. priorityFilter = make([]int, 0)
  469. for _, p := range util.SplitNoEmpty(readParam(r, "x-priority", "priority", "prio", "p"), ",") {
  470. priority, err := util.ParsePriority(p)
  471. if err != nil {
  472. return "", "", nil, nil, err
  473. }
  474. priorityFilter = append(priorityFilter, priority)
  475. }
  476. return
  477. }
  478. func passesQueryFilter(msg *message, messageFilter string, titleFilter string, priorityFilter []int, tagsFilter []string) bool {
  479. if msg.Event != messageEvent {
  480. return true // filters only apply to messages
  481. }
  482. if messageFilter != "" && msg.Message != messageFilter {
  483. return false
  484. }
  485. if titleFilter != "" && msg.Title != titleFilter {
  486. return false
  487. }
  488. messagePriority := msg.Priority
  489. if messagePriority == 0 {
  490. messagePriority = 3 // For query filters, default priority (3) is the same as "not set" (0)
  491. }
  492. if len(priorityFilter) > 0 && !util.InIntList(priorityFilter, messagePriority) {
  493. return false
  494. }
  495. if len(tagsFilter) > 0 && !util.InStringListAll(msg.Tags, tagsFilter) {
  496. return false
  497. }
  498. return true
  499. }
  500. func (s *Server) sendOldMessages(topics []*topic, since sinceTime, scheduled bool, sub subscriber) error {
  501. if since.IsNone() {
  502. return nil
  503. }
  504. for _, t := range topics {
  505. messages, err := s.cache.Messages(t.ID, since, scheduled)
  506. if err != nil {
  507. return err
  508. }
  509. for _, m := range messages {
  510. if err := sub(m); err != nil {
  511. return err
  512. }
  513. }
  514. }
  515. return nil
  516. }
  517. // parseSince returns a timestamp identifying the time span from which cached messages should be received.
  518. //
  519. // Values in the "since=..." parameter can be either a unix timestamp or a duration (e.g. 12h), or
  520. // "all" for all messages.
  521. func parseSince(r *http.Request, poll bool) (sinceTime, error) {
  522. since := readParam(r, "x-since", "since", "si")
  523. if since == "" {
  524. if poll {
  525. return sinceAllMessages, nil
  526. }
  527. return sinceNoMessages, nil
  528. }
  529. if since == "all" {
  530. return sinceAllMessages, nil
  531. } else if s, err := strconv.ParseInt(since, 10, 64); err == nil {
  532. return sinceTime(time.Unix(s, 0)), nil
  533. } else if d, err := time.ParseDuration(since); err == nil {
  534. return sinceTime(time.Now().Add(-1 * d)), nil
  535. }
  536. return sinceNoMessages, errHTTPBadRequest
  537. }
  538. func (s *Server) handleOptions(w http.ResponseWriter, _ *http.Request) error {
  539. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  540. w.Header().Set("Access-Control-Allow-Methods", "GET, PUT, POST")
  541. return nil
  542. }
  543. func (s *Server) topicFromPath(path string) (*topic, error) {
  544. parts := strings.Split(path, "/")
  545. if len(parts) < 2 {
  546. return nil, errHTTPBadRequest
  547. }
  548. topics, err := s.topicsFromIDs(parts[1])
  549. if err != nil {
  550. return nil, err
  551. }
  552. return topics[0], nil
  553. }
  554. func (s *Server) topicsFromIDs(ids ...string) ([]*topic, error) {
  555. s.mu.Lock()
  556. defer s.mu.Unlock()
  557. topics := make([]*topic, 0)
  558. for _, id := range ids {
  559. if util.InStringList(disallowedTopics, id) {
  560. return nil, errHTTPBadRequest
  561. }
  562. if _, ok := s.topics[id]; !ok {
  563. if len(s.topics) >= s.config.GlobalTopicLimit {
  564. return nil, errHTTPTooManyRequests
  565. }
  566. s.topics[id] = newTopic(id)
  567. }
  568. topics = append(topics, s.topics[id])
  569. }
  570. return topics, nil
  571. }
  572. func (s *Server) updateStatsAndPrune() {
  573. s.mu.Lock()
  574. defer s.mu.Unlock()
  575. // Expire visitors from rate visitors map
  576. for ip, v := range s.visitors {
  577. if v.Stale() {
  578. delete(s.visitors, ip)
  579. }
  580. }
  581. // Prune message cache
  582. olderThan := time.Now().Add(-1 * s.config.CacheDuration)
  583. if err := s.cache.Prune(olderThan); err != nil {
  584. log.Printf("error pruning cache: %s", err.Error())
  585. }
  586. // Prune old topics, remove subscriptions without subscribers
  587. var subscribers, messages int
  588. for _, t := range s.topics {
  589. subs := t.Subscribers()
  590. msgs, err := s.cache.MessageCount(t.ID)
  591. if err != nil {
  592. log.Printf("cannot get stats for topic %s: %s", t.ID, err.Error())
  593. continue
  594. }
  595. if msgs == 0 && subs == 0 {
  596. delete(s.topics, t.ID)
  597. continue
  598. }
  599. subscribers += subs
  600. messages += msgs
  601. }
  602. // Print stats
  603. log.Printf("Stats: %d message(s) published, %d topic(s) active, %d subscriber(s), %d message(s) buffered, %d visitor(s)",
  604. s.messages, len(s.topics), subscribers, messages, len(s.visitors))
  605. }
  606. func (s *Server) runManager() {
  607. for {
  608. select {
  609. case <-time.After(s.config.ManagerInterval):
  610. s.updateStatsAndPrune()
  611. case <-s.closeChan:
  612. return
  613. }
  614. }
  615. }
  616. func (s *Server) runAtSender() {
  617. for {
  618. select {
  619. case <-time.After(s.config.AtSenderInterval):
  620. if err := s.sendDelayedMessages(); err != nil {
  621. log.Printf("error sending scheduled messages: %s", err.Error())
  622. }
  623. case <-s.closeChan:
  624. return
  625. }
  626. }
  627. }
  628. func (s *Server) runFirebaseKeepliver() {
  629. if s.firebase == nil {
  630. return
  631. }
  632. for {
  633. select {
  634. case <-time.After(s.config.FirebaseKeepaliveInterval):
  635. if err := s.firebase(newKeepaliveMessage(firebaseControlTopic)); err != nil {
  636. log.Printf("error sending Firebase keepalive message: %s", err.Error())
  637. }
  638. case <-s.closeChan:
  639. return
  640. }
  641. }
  642. }
  643. func (s *Server) sendDelayedMessages() error {
  644. s.mu.Lock()
  645. defer s.mu.Unlock()
  646. messages, err := s.cache.MessagesDue()
  647. if err != nil {
  648. return err
  649. }
  650. for _, m := range messages {
  651. t, ok := s.topics[m.Topic] // If no subscribers, just mark message as published
  652. if ok {
  653. if err := t.Publish(m); err != nil {
  654. log.Printf("unable to publish message %s to topic %s: %v", m.ID, m.Topic, err.Error())
  655. }
  656. if s.firebase != nil {
  657. if err := s.firebase(m); err != nil {
  658. log.Printf("unable to publish to Firebase: %v", err.Error())
  659. }
  660. }
  661. }
  662. if err := s.cache.MarkPublished(m); err != nil {
  663. return err
  664. }
  665. }
  666. return nil
  667. }
  668. func (s *Server) withRateLimit(w http.ResponseWriter, r *http.Request, handler func(w http.ResponseWriter, r *http.Request, v *visitor) error) error {
  669. v := s.visitor(r)
  670. if err := v.RequestAllowed(); err != nil {
  671. return err
  672. }
  673. return handler(w, r, v)
  674. }
  675. // visitor creates or retrieves a rate.Limiter for the given visitor.
  676. // This function was taken from https://www.alexedwards.net/blog/how-to-rate-limit-http-requests (MIT).
  677. func (s *Server) visitor(r *http.Request) *visitor {
  678. s.mu.Lock()
  679. defer s.mu.Unlock()
  680. remoteAddr := r.RemoteAddr
  681. ip, _, err := net.SplitHostPort(remoteAddr)
  682. if err != nil {
  683. ip = remoteAddr // This should not happen in real life; only in tests.
  684. }
  685. if s.config.BehindProxy && r.Header.Get("X-Forwarded-For") != "" {
  686. ip = r.Header.Get("X-Forwarded-For")
  687. }
  688. v, exists := s.visitors[ip]
  689. if !exists {
  690. s.visitors[ip] = newVisitor(s.config)
  691. return s.visitors[ip]
  692. }
  693. v.Keepalive()
  694. return v
  695. }
  696. func (s *Server) inc(counter *int64) {
  697. s.mu.Lock()
  698. defer s.mu.Unlock()
  699. *counter++
  700. }
  701. func (s *Server) fail(w http.ResponseWriter, r *http.Request, code int, err error) {
  702. log.Printf("[%s] %s - %d - %s", r.RemoteAddr, r.Method, code, err.Error())
  703. w.WriteHeader(code)
  704. _, _ = io.WriteString(w, fmt.Sprintf("%s\n", http.StatusText(code)))
  705. }