server.go 26 KB

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