server.go 22 KB

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