server.go 28 KB

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