server.go 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574
  1. package server
  2. import (
  3. "bytes"
  4. "context"
  5. "crypto/sha256"
  6. "embed"
  7. "encoding/base64"
  8. "encoding/json"
  9. "errors"
  10. "fmt"
  11. "heckel.io/ntfy/user"
  12. "io"
  13. "net"
  14. "net/http"
  15. "net/netip"
  16. "net/url"
  17. "os"
  18. "path"
  19. "path/filepath"
  20. "regexp"
  21. "sort"
  22. "strconv"
  23. "strings"
  24. "sync"
  25. "time"
  26. "unicode/utf8"
  27. "heckel.io/ntfy/log"
  28. "github.com/emersion/go-smtp"
  29. "github.com/gorilla/websocket"
  30. "golang.org/x/sync/errgroup"
  31. "heckel.io/ntfy/util"
  32. )
  33. /*
  34. TODO
  35. database migration
  36. reserve topics
  37. purge accounts that were not logged into in X
  38. reset daily limits for users
  39. "user list" shows * twice
  40. "ntfy access everyone user4topic <bla>" twice -> UNIQUE constraint error
  41. Account usage not updated "in real time"
  42. Sync:
  43. - "mute" setting
  44. - figure out what settings are "web" or "phone"
  45. UI:
  46. - Subscription dotmenu dropdown: Move to nav bar, or make same as profile dropdown
  47. - "Logout and delete local storage" option
  48. Pages:
  49. - Home
  50. - Password reset
  51. - Pricing
  52. - change email
  53. -
  54. Polishing:
  55. aria-label for everything
  56. Tests:
  57. - APIs
  58. - CRUD tokens
  59. - Expire tokens
  60. -
  61. */
  62. // Server is the main server, providing the UI and API for ntfy
  63. type Server struct {
  64. config *Config
  65. httpServer *http.Server
  66. httpsServer *http.Server
  67. unixListener net.Listener
  68. smtpServer *smtp.Server
  69. smtpServerBackend *smtpBackend
  70. smtpSender mailer
  71. topics map[string]*topic
  72. visitors map[string]*visitor // ip:<ip> or user:<user>
  73. firebaseClient *firebaseClient
  74. messages int64
  75. userManager user.Manager
  76. messageCache *messageCache
  77. fileCache *fileCache
  78. closeChan chan bool
  79. mu sync.Mutex
  80. }
  81. // handleFunc extends the normal http.HandlerFunc to be able to easily return errors
  82. type handleFunc func(http.ResponseWriter, *http.Request, *visitor) error
  83. var (
  84. // If changed, don't forget to update Android App and auth_sqlite.go
  85. topicRegex = regexp.MustCompile(`^[-_A-Za-z0-9]{1,64}$`) // No /!
  86. topicPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}$`) // Regex must match JS & Android app!
  87. externalTopicPathRegex = regexp.MustCompile(`^/[^/]+\.[^/]+/[-_A-Za-z0-9]{1,64}$`) // Extended topic path, for web-app, e.g. /example.com/mytopic
  88. jsonPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/json$`)
  89. ssePathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/sse$`)
  90. rawPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/raw$`)
  91. wsPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/ws$`)
  92. authPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}(,[-_A-Za-z0-9]{1,64})*/auth$`)
  93. publishPathRegex = regexp.MustCompile(`^/[-_A-Za-z0-9]{1,64}/(publish|send|trigger)$`)
  94. webConfigPath = "/config.js"
  95. healthPath = "/v1/health"
  96. accountPath = "/v1/account"
  97. accountTokenPath = "/v1/account/token"
  98. accountPasswordPath = "/v1/account/password"
  99. accountSettingsPath = "/v1/account/settings"
  100. accountSubscriptionPath = "/v1/account/subscription"
  101. accountSubscriptionSingleRegex = regexp.MustCompile(`^/v1/account/subscription/([-_A-Za-z0-9]{16})$`)
  102. matrixPushPath = "/_matrix/push/v1/notify"
  103. staticRegex = regexp.MustCompile(`^/static/.+`)
  104. docsRegex = regexp.MustCompile(`^/docs(|/.*)$`)
  105. fileRegex = regexp.MustCompile(`^/file/([-_A-Za-z0-9]{1,64})(?:\.[A-Za-z0-9]{1,16})?$`)
  106. disallowedTopics = []string{"docs", "static", "file", "app", "account", "settings", "pricing", "signup", "login", "reset-password"} // If updated, also update in Android and web app
  107. urlRegex = regexp.MustCompile(`^https?://`)
  108. //go:embed site
  109. webFs embed.FS
  110. webFsCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: webFs}
  111. webSiteDir = "/site"
  112. webHomeIndex = "/home.html" // Landing page, only if "web-root: home"
  113. webAppIndex = "/app.html" // React app
  114. //go:embed docs
  115. docsStaticFs embed.FS
  116. docsStaticCached = &util.CachingEmbedFS{ModTime: time.Now(), FS: docsStaticFs}
  117. )
  118. const (
  119. firebaseControlTopic = "~control" // See Android if changed
  120. firebasePollTopic = "~poll" // See iOS if changed
  121. emptyMessageBody = "triggered" // Used if message body is empty
  122. newMessageBody = "New message" // Used in poll requests as generic message
  123. defaultAttachmentMessage = "You received a file: %s" // Used if message body is empty, and there is an attachment
  124. encodingBase64 = "base64"
  125. )
  126. // WebSocket constants
  127. const (
  128. wsWriteWait = 2 * time.Second
  129. wsBufferSize = 1024
  130. wsReadLimit = 64 // We only ever receive PINGs
  131. wsPongWait = 15 * time.Second
  132. )
  133. // New instantiates a new Server. It creates the cache and adds a Firebase
  134. // subscriber (if configured).
  135. func New(conf *Config) (*Server, error) {
  136. var mailer mailer
  137. if conf.SMTPSenderAddr != "" {
  138. mailer = &smtpSender{config: conf}
  139. }
  140. messageCache, err := createMessageCache(conf)
  141. if err != nil {
  142. return nil, err
  143. }
  144. topics, err := messageCache.Topics()
  145. if err != nil {
  146. return nil, err
  147. }
  148. var fileCache *fileCache
  149. if conf.AttachmentCacheDir != "" {
  150. fileCache, err = newFileCache(conf.AttachmentCacheDir, conf.AttachmentTotalSizeLimit)
  151. if err != nil {
  152. return nil, err
  153. }
  154. }
  155. var auther user.Manager
  156. if conf.AuthFile != "" {
  157. auther, err = user.NewSQLiteAuthManager(conf.AuthFile, conf.AuthDefaultRead, conf.AuthDefaultWrite)
  158. if err != nil {
  159. return nil, err
  160. }
  161. }
  162. var firebaseClient *firebaseClient
  163. if conf.FirebaseKeyFile != "" {
  164. sender, err := newFirebaseSender(conf.FirebaseKeyFile)
  165. if err != nil {
  166. return nil, err
  167. }
  168. firebaseClient = newFirebaseClient(sender, auther)
  169. }
  170. return &Server{
  171. config: conf,
  172. messageCache: messageCache,
  173. fileCache: fileCache,
  174. firebaseClient: firebaseClient,
  175. smtpSender: mailer,
  176. topics: topics,
  177. userManager: auther,
  178. visitors: make(map[string]*visitor),
  179. }, nil
  180. }
  181. func createMessageCache(conf *Config) (*messageCache, error) {
  182. if conf.CacheDuration == 0 {
  183. return newNopCache()
  184. } else if conf.CacheFile != "" {
  185. return newSqliteCache(conf.CacheFile, conf.CacheStartupQueries, conf.CacheBatchSize, conf.CacheBatchTimeout, false)
  186. }
  187. return newMemCache()
  188. }
  189. // Run executes the main server. It listens on HTTP (+ HTTPS, if configured), and starts
  190. // a manager go routine to print stats and prune messages.
  191. func (s *Server) Run() error {
  192. var listenStr string
  193. if s.config.ListenHTTP != "" {
  194. listenStr += fmt.Sprintf(" %s[http]", s.config.ListenHTTP)
  195. }
  196. if s.config.ListenHTTPS != "" {
  197. listenStr += fmt.Sprintf(" %s[https]", s.config.ListenHTTPS)
  198. }
  199. if s.config.ListenUnix != "" {
  200. listenStr += fmt.Sprintf(" %s[unix]", s.config.ListenUnix)
  201. }
  202. if s.config.SMTPServerListen != "" {
  203. listenStr += fmt.Sprintf(" %s[smtp]", s.config.SMTPServerListen)
  204. }
  205. log.Info("Listening on%s, ntfy %s, log level is %s", listenStr, s.config.Version, log.CurrentLevel().String())
  206. mux := http.NewServeMux()
  207. mux.HandleFunc("/", s.handle)
  208. errChan := make(chan error)
  209. s.mu.Lock()
  210. s.closeChan = make(chan bool)
  211. if s.config.ListenHTTP != "" {
  212. s.httpServer = &http.Server{Addr: s.config.ListenHTTP, Handler: mux}
  213. go func() {
  214. errChan <- s.httpServer.ListenAndServe()
  215. }()
  216. }
  217. if s.config.ListenHTTPS != "" {
  218. s.httpsServer = &http.Server{Addr: s.config.ListenHTTPS, Handler: mux}
  219. go func() {
  220. errChan <- s.httpsServer.ListenAndServeTLS(s.config.CertFile, s.config.KeyFile)
  221. }()
  222. }
  223. if s.config.ListenUnix != "" {
  224. go func() {
  225. var err error
  226. s.mu.Lock()
  227. os.Remove(s.config.ListenUnix)
  228. s.unixListener, err = net.Listen("unix", s.config.ListenUnix)
  229. if err != nil {
  230. s.mu.Unlock()
  231. errChan <- err
  232. return
  233. }
  234. defer s.unixListener.Close()
  235. if s.config.ListenUnixMode > 0 {
  236. if err := os.Chmod(s.config.ListenUnix, s.config.ListenUnixMode); err != nil {
  237. s.mu.Unlock()
  238. errChan <- err
  239. return
  240. }
  241. }
  242. s.mu.Unlock()
  243. httpServer := &http.Server{Handler: mux}
  244. errChan <- httpServer.Serve(s.unixListener)
  245. }()
  246. }
  247. if s.config.SMTPServerListen != "" {
  248. go func() {
  249. errChan <- s.runSMTPServer()
  250. }()
  251. }
  252. s.mu.Unlock()
  253. go s.runManager()
  254. go s.runDelayedSender()
  255. go s.runFirebaseKeepaliver()
  256. return <-errChan
  257. }
  258. // Stop stops HTTP (+HTTPS) server and all managers
  259. func (s *Server) Stop() {
  260. s.mu.Lock()
  261. defer s.mu.Unlock()
  262. if s.httpServer != nil {
  263. s.httpServer.Close()
  264. }
  265. if s.httpsServer != nil {
  266. s.httpsServer.Close()
  267. }
  268. if s.unixListener != nil {
  269. s.unixListener.Close()
  270. }
  271. if s.smtpServer != nil {
  272. s.smtpServer.Close()
  273. }
  274. close(s.closeChan)
  275. }
  276. func (s *Server) handle(w http.ResponseWriter, r *http.Request) {
  277. v, err := s.visitor(r) // Note: Always returns v, even when error is returned
  278. if err == nil {
  279. log.Debug("%s Dispatching request", logHTTPPrefix(v, r))
  280. if log.IsTrace() {
  281. log.Trace("%s Entire request (headers and body):\n%s", logHTTPPrefix(v, r), renderHTTPRequest(r))
  282. }
  283. err = s.handleInternal(w, r, v)
  284. }
  285. if err != nil {
  286. if websocket.IsWebSocketUpgrade(r) {
  287. isNormalError := strings.Contains(err.Error(), "i/o timeout")
  288. if isNormalError {
  289. log.Debug("%s WebSocket error (this error is okay, it happens a lot): %s", logHTTPPrefix(v, r), err.Error())
  290. } else {
  291. log.Info("%s WebSocket error: %s", logHTTPPrefix(v, r), err.Error())
  292. }
  293. return // Do not attempt to write to upgraded connection
  294. }
  295. if matrixErr, ok := err.(*errMatrix); ok {
  296. writeMatrixError(w, r, v, matrixErr)
  297. return
  298. }
  299. httpErr, ok := err.(*errHTTP)
  300. if !ok {
  301. httpErr = errHTTPInternalError
  302. }
  303. isNormalError := httpErr.HTTPCode == http.StatusNotFound || httpErr.HTTPCode == http.StatusBadRequest
  304. if isNormalError {
  305. log.Debug("%s Connection closed with HTTP %d (ntfy error %d): %s", logHTTPPrefix(v, r), httpErr.HTTPCode, httpErr.Code, err.Error())
  306. } else {
  307. log.Info("%s Connection closed with HTTP %d (ntfy error %d): %s", logHTTPPrefix(v, r), httpErr.HTTPCode, httpErr.Code, err.Error())
  308. }
  309. w.Header().Set("Content-Type", "application/json")
  310. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  311. w.WriteHeader(httpErr.HTTPCode)
  312. io.WriteString(w, httpErr.JSON()+"\n")
  313. }
  314. }
  315. func (s *Server) handleInternal(w http.ResponseWriter, r *http.Request, v *visitor) error {
  316. if r.Method == http.MethodGet && r.URL.Path == "/" {
  317. return s.ensureWebEnabled(s.handleHome)(w, r, v)
  318. } else if r.Method == http.MethodHead && r.URL.Path == "/" {
  319. return s.ensureWebEnabled(s.handleEmpty)(w, r, v)
  320. } else if r.Method == http.MethodGet && r.URL.Path == healthPath {
  321. return s.handleHealth(w, r, v)
  322. } else if r.Method == http.MethodGet && r.URL.Path == webConfigPath {
  323. return s.ensureWebEnabled(s.handleWebConfig)(w, r, v)
  324. } else if r.Method == http.MethodPost && r.URL.Path == accountPath {
  325. return s.handleAccountCreate(w, r, v)
  326. } else if r.Method == http.MethodGet && r.URL.Path == accountPath {
  327. return s.handleAccountGet(w, r, v)
  328. } else if r.Method == http.MethodDelete && r.URL.Path == accountPath {
  329. return s.handleAccountDelete(w, r, v)
  330. } else if r.Method == http.MethodPost && r.URL.Path == accountPasswordPath {
  331. return s.handleAccountPasswordChange(w, r, v)
  332. } else if r.Method == http.MethodPost && r.URL.Path == accountTokenPath {
  333. return s.handleAccountTokenIssue(w, r, v)
  334. } else if r.Method == http.MethodPatch && r.URL.Path == accountTokenPath {
  335. return s.handleAccountTokenExtend(w, r, v)
  336. } else if r.Method == http.MethodDelete && r.URL.Path == accountTokenPath {
  337. return s.handleAccountTokenDelete(w, r, v)
  338. } else if r.Method == http.MethodPatch && r.URL.Path == accountSettingsPath {
  339. return s.handleAccountSettingsChange(w, r, v)
  340. } else if r.Method == http.MethodPost && r.URL.Path == accountSubscriptionPath {
  341. return s.handleAccountSubscriptionAdd(w, r, v)
  342. } else if r.Method == http.MethodPatch && accountSubscriptionSingleRegex.MatchString(r.URL.Path) {
  343. return s.handleAccountSubscriptionChange(w, r, v)
  344. } else if r.Method == http.MethodDelete && accountSubscriptionSingleRegex.MatchString(r.URL.Path) {
  345. return s.handleAccountSubscriptionDelete(w, r, v)
  346. } else if r.Method == http.MethodGet && r.URL.Path == matrixPushPath {
  347. return s.handleMatrixDiscovery(w)
  348. } else if r.Method == http.MethodGet && staticRegex.MatchString(r.URL.Path) {
  349. return s.ensureWebEnabled(s.handleStatic)(w, r, v)
  350. } else if r.Method == http.MethodGet && docsRegex.MatchString(r.URL.Path) {
  351. return s.ensureWebEnabled(s.handleDocs)(w, r, v)
  352. } else if (r.Method == http.MethodGet || r.Method == http.MethodHead) && fileRegex.MatchString(r.URL.Path) && s.config.AttachmentCacheDir != "" {
  353. return s.limitRequests(s.handleFile)(w, r, v)
  354. } else if r.Method == http.MethodOptions {
  355. return s.ensureWebEnabled(s.handleOptions)(w, r, v)
  356. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && r.URL.Path == "/" {
  357. return s.limitRequests(s.transformBodyJSON(s.authorizeTopicWrite(s.handlePublish)))(w, r, v)
  358. } else if r.Method == http.MethodPost && r.URL.Path == matrixPushPath {
  359. return s.limitRequests(s.transformMatrixJSON(s.authorizeTopicWrite(s.handlePublishMatrix)))(w, r, v)
  360. } else if (r.Method == http.MethodPut || r.Method == http.MethodPost) && topicPathRegex.MatchString(r.URL.Path) {
  361. return s.limitRequests(s.authorizeTopicWrite(s.handlePublish))(w, r, v)
  362. } else if r.Method == http.MethodGet && publishPathRegex.MatchString(r.URL.Path) {
  363. return s.limitRequests(s.authorizeTopicWrite(s.handlePublish))(w, r, v)
  364. } else if r.Method == http.MethodGet && jsonPathRegex.MatchString(r.URL.Path) {
  365. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeJSON))(w, r, v)
  366. } else if r.Method == http.MethodGet && ssePathRegex.MatchString(r.URL.Path) {
  367. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeSSE))(w, r, v)
  368. } else if r.Method == http.MethodGet && rawPathRegex.MatchString(r.URL.Path) {
  369. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeRaw))(w, r, v)
  370. } else if r.Method == http.MethodGet && wsPathRegex.MatchString(r.URL.Path) {
  371. return s.limitRequests(s.authorizeTopicRead(s.handleSubscribeWS))(w, r, v)
  372. } else if r.Method == http.MethodGet && authPathRegex.MatchString(r.URL.Path) {
  373. return s.limitRequests(s.authorizeTopicRead(s.handleTopicAuth))(w, r, v)
  374. } else if r.Method == http.MethodGet && (topicPathRegex.MatchString(r.URL.Path) || externalTopicPathRegex.MatchString(r.URL.Path)) {
  375. return s.ensureWebEnabled(s.handleTopic)(w, r, v)
  376. }
  377. return errHTTPNotFound
  378. }
  379. func (s *Server) handleHome(w http.ResponseWriter, r *http.Request, v *visitor) error {
  380. if s.config.WebRootIsApp {
  381. r.URL.Path = webAppIndex
  382. } else {
  383. r.URL.Path = webHomeIndex
  384. }
  385. return s.handleStatic(w, r, v)
  386. }
  387. func (s *Server) handleTopic(w http.ResponseWriter, r *http.Request, v *visitor) error {
  388. unifiedpush := readBoolParam(r, false, "x-unifiedpush", "unifiedpush", "up") // see PUT/POST too!
  389. if unifiedpush {
  390. w.Header().Set("Content-Type", "application/json")
  391. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  392. _, err := io.WriteString(w, `{"unifiedpush":{"version":1}}`+"\n")
  393. return err
  394. }
  395. r.URL.Path = webAppIndex
  396. return s.handleStatic(w, r, v)
  397. }
  398. func (s *Server) handleEmpty(_ http.ResponseWriter, _ *http.Request, _ *visitor) error {
  399. return nil
  400. }
  401. func (s *Server) handleTopicAuth(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  402. w.Header().Set("Content-Type", "application/json")
  403. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  404. _, err := io.WriteString(w, `{"success":true}`+"\n")
  405. return err
  406. }
  407. func (s *Server) handleHealth(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  408. response := &apiHealthResponse{
  409. Healthy: true,
  410. }
  411. w.Header().Set("Content-Type", "text/json")
  412. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  413. if err := json.NewEncoder(w).Encode(response); err != nil {
  414. return err
  415. }
  416. return nil
  417. }
  418. func (s *Server) handleWebConfig(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  419. appRoot := "/"
  420. if !s.config.WebRootIsApp {
  421. appRoot = "/app"
  422. }
  423. disallowedTopicsStr := `"` + strings.Join(disallowedTopics, `", "`) + `"`
  424. w.Header().Set("Content-Type", "text/javascript")
  425. _, err := io.WriteString(w, fmt.Sprintf(`// Generated server configuration
  426. var config = {
  427. baseUrl: window.location.origin,
  428. appRoot: "%s",
  429. enableLogin: %t,
  430. enableSignup: %t,
  431. enableResetPassword: %t,
  432. disallowedTopics: [%s],
  433. };`, appRoot, s.config.EnableLogin, s.config.EnableSignup, s.config.EnableResetPassword, disallowedTopicsStr))
  434. return err
  435. }
  436. func (s *Server) handleStatic(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  437. r.URL.Path = webSiteDir + r.URL.Path
  438. util.Gzip(http.FileServer(http.FS(webFsCached))).ServeHTTP(w, r)
  439. return nil
  440. }
  441. func (s *Server) handleDocs(w http.ResponseWriter, r *http.Request, _ *visitor) error {
  442. util.Gzip(http.FileServer(http.FS(docsStaticCached))).ServeHTTP(w, r)
  443. return nil
  444. }
  445. func (s *Server) handleFile(w http.ResponseWriter, r *http.Request, v *visitor) error {
  446. if s.config.AttachmentCacheDir == "" {
  447. return errHTTPInternalError
  448. }
  449. matches := fileRegex.FindStringSubmatch(r.URL.Path)
  450. if len(matches) != 2 {
  451. return errHTTPInternalErrorInvalidFilePath
  452. }
  453. messageID := matches[1]
  454. file := filepath.Join(s.config.AttachmentCacheDir, messageID)
  455. stat, err := os.Stat(file)
  456. if err != nil {
  457. return errHTTPNotFound
  458. }
  459. if r.Method == http.MethodGet {
  460. if err := v.BandwidthLimiter().Allow(stat.Size()); err != nil {
  461. return errHTTPTooManyRequestsAttachmentBandwidthLimit
  462. }
  463. }
  464. w.Header().Set("Content-Length", fmt.Sprintf("%d", stat.Size()))
  465. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  466. if r.Method == http.MethodGet {
  467. f, err := os.Open(file)
  468. if err != nil {
  469. return err
  470. }
  471. defer f.Close()
  472. _, err = io.Copy(util.NewContentTypeWriter(w, r.URL.Path), f)
  473. return err
  474. }
  475. return nil
  476. }
  477. func (s *Server) handleMatrixDiscovery(w http.ResponseWriter) error {
  478. if s.config.BaseURL == "" {
  479. return errHTTPInternalErrorMissingBaseURL
  480. }
  481. return writeMatrixDiscoveryResponse(w)
  482. }
  483. func (s *Server) handlePublishWithoutResponse(r *http.Request, v *visitor) (*message, error) {
  484. t, err := s.topicFromPath(r.URL.Path)
  485. if err != nil {
  486. return nil, err
  487. }
  488. body, err := util.Peek(r.Body, s.config.MessageLimit)
  489. if err != nil {
  490. return nil, err
  491. }
  492. m := newDefaultMessage(t.ID, "")
  493. cache, firebase, email, unifiedpush, err := s.parsePublishParams(r, v, m)
  494. if err != nil {
  495. return nil, err
  496. }
  497. if m.PollID != "" {
  498. m = newPollRequestMessage(t.ID, m.PollID)
  499. }
  500. if v.user != nil {
  501. m.User = v.user.Name
  502. }
  503. if err := s.handlePublishBody(r, v, m, body, unifiedpush); err != nil {
  504. return nil, err
  505. }
  506. if m.Message == "" {
  507. m.Message = emptyMessageBody
  508. }
  509. delayed := m.Time > time.Now().Unix()
  510. log.Debug("%s Received message: event=%s, user=%s, body=%d byte(s), delayed=%t, firebase=%t, cache=%t, up=%t, email=%s",
  511. logMessagePrefix(v, m), m.Event, m.User, len(m.Message), delayed, firebase, cache, unifiedpush, email)
  512. if log.IsTrace() {
  513. log.Trace("%s Message body: %s", logMessagePrefix(v, m), util.MaybeMarshalJSON(m))
  514. }
  515. if !delayed {
  516. if err := t.Publish(v, m); err != nil {
  517. return nil, err
  518. }
  519. if s.firebaseClient != nil && firebase {
  520. go s.sendToFirebase(v, m)
  521. }
  522. if s.smtpSender != nil && email != "" {
  523. v.IncrEmails()
  524. go s.sendEmail(v, m, email)
  525. }
  526. if s.config.UpstreamBaseURL != "" {
  527. go s.forwardPollRequest(v, m)
  528. }
  529. } else {
  530. log.Debug("%s Message delayed, will process later", logMessagePrefix(v, m))
  531. }
  532. if cache {
  533. log.Debug("%s Adding message to cache", logMessagePrefix(v, m))
  534. if err := s.messageCache.AddMessage(m); err != nil {
  535. return nil, err
  536. }
  537. }
  538. v.IncrMessages()
  539. if v.user != nil {
  540. s.userManager.EnqueueStats(v.user)
  541. }
  542. s.mu.Lock()
  543. s.messages++
  544. s.mu.Unlock()
  545. return m, nil
  546. }
  547. func (s *Server) handlePublish(w http.ResponseWriter, r *http.Request, v *visitor) error {
  548. m, err := s.handlePublishWithoutResponse(r, v)
  549. if err != nil {
  550. return err
  551. }
  552. w.Header().Set("Content-Type", "application/json")
  553. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  554. if err := json.NewEncoder(w).Encode(m); err != nil {
  555. return err
  556. }
  557. return nil
  558. }
  559. func (s *Server) handlePublishMatrix(w http.ResponseWriter, r *http.Request, v *visitor) error {
  560. _, err := s.handlePublishWithoutResponse(r, v)
  561. if err != nil {
  562. return &errMatrix{pushKey: r.Header.Get(matrixPushKeyHeader), err: err}
  563. }
  564. return writeMatrixSuccess(w)
  565. }
  566. func (s *Server) sendToFirebase(v *visitor, m *message) {
  567. log.Debug("%s Publishing to Firebase", logMessagePrefix(v, m))
  568. if err := s.firebaseClient.Send(v, m); err != nil {
  569. if err == errFirebaseTemporarilyBanned {
  570. log.Debug("%s Unable to publish to Firebase: %v", logMessagePrefix(v, m), err.Error())
  571. } else {
  572. log.Warn("%s Unable to publish to Firebase: %v", logMessagePrefix(v, m), err.Error())
  573. }
  574. }
  575. }
  576. func (s *Server) sendEmail(v *visitor, m *message, email string) {
  577. log.Debug("%s Sending email to %s", logMessagePrefix(v, m), email)
  578. if err := s.smtpSender.Send(v, m, email); err != nil {
  579. log.Warn("%s Unable to send email to %s: %v", logMessagePrefix(v, m), email, err.Error())
  580. }
  581. }
  582. func (s *Server) forwardPollRequest(v *visitor, m *message) {
  583. topicURL := fmt.Sprintf("%s/%s", s.config.BaseURL, m.Topic)
  584. topicHash := fmt.Sprintf("%x", sha256.Sum256([]byte(topicURL)))
  585. forwardURL := fmt.Sprintf("%s/%s", s.config.UpstreamBaseURL, topicHash)
  586. log.Debug("%s Publishing poll request to %s", logMessagePrefix(v, m), forwardURL)
  587. req, err := http.NewRequest("POST", forwardURL, strings.NewReader(""))
  588. if err != nil {
  589. log.Warn("%s Unable to publish poll request: %v", logMessagePrefix(v, m), err.Error())
  590. return
  591. }
  592. req.Header.Set("X-Poll-ID", m.ID)
  593. var httpClient = &http.Client{
  594. Timeout: time.Second * 10,
  595. }
  596. response, err := httpClient.Do(req)
  597. if err != nil {
  598. log.Warn("%s Unable to publish poll request: %v", logMessagePrefix(v, m), err.Error())
  599. return
  600. } else if response.StatusCode != http.StatusOK {
  601. log.Warn("%s Unable to publish poll request, unexpected HTTP status: %d", logMessagePrefix(v, m), response.StatusCode)
  602. return
  603. }
  604. }
  605. func (s *Server) parsePublishParams(r *http.Request, v *visitor, m *message) (cache bool, firebase bool, email string, unifiedpush bool, err error) {
  606. cache = readBoolParam(r, true, "x-cache", "cache")
  607. firebase = readBoolParam(r, true, "x-firebase", "firebase")
  608. m.Title = readParam(r, "x-title", "title", "t")
  609. m.Click = readParam(r, "x-click", "click")
  610. icon := readParam(r, "x-icon", "icon")
  611. filename := readParam(r, "x-filename", "filename", "file", "f")
  612. attach := readParam(r, "x-attach", "attach", "a")
  613. if attach != "" || filename != "" {
  614. m.Attachment = &attachment{}
  615. }
  616. if filename != "" {
  617. m.Attachment.Name = filename
  618. }
  619. if attach != "" {
  620. if !urlRegex.MatchString(attach) {
  621. return false, false, "", false, errHTTPBadRequestAttachmentURLInvalid
  622. }
  623. m.Attachment.URL = attach
  624. if m.Attachment.Name == "" {
  625. u, err := url.Parse(m.Attachment.URL)
  626. if err == nil {
  627. m.Attachment.Name = path.Base(u.Path)
  628. if m.Attachment.Name == "." || m.Attachment.Name == "/" {
  629. m.Attachment.Name = ""
  630. }
  631. }
  632. }
  633. if m.Attachment.Name == "" {
  634. m.Attachment.Name = "attachment"
  635. }
  636. }
  637. if icon != "" {
  638. if !urlRegex.MatchString(icon) {
  639. return false, false, "", false, errHTTPBadRequestIconURLInvalid
  640. }
  641. m.Icon = icon
  642. }
  643. email = readParam(r, "x-email", "x-e-mail", "email", "e-mail", "mail", "e")
  644. if email != "" {
  645. if err := v.EmailAllowed(); err != nil {
  646. return false, false, "", false, errHTTPTooManyRequestsLimitEmails
  647. }
  648. }
  649. if s.smtpSender == nil && email != "" {
  650. return false, false, "", false, errHTTPBadRequestEmailDisabled
  651. }
  652. messageStr := strings.ReplaceAll(readParam(r, "x-message", "message", "m"), "\\n", "\n")
  653. if messageStr != "" {
  654. m.Message = messageStr
  655. }
  656. m.Priority, err = util.ParsePriority(readParam(r, "x-priority", "priority", "prio", "p"))
  657. if err != nil {
  658. return false, false, "", false, errHTTPBadRequestPriorityInvalid
  659. }
  660. tagsStr := readParam(r, "x-tags", "tags", "tag", "ta")
  661. if tagsStr != "" {
  662. m.Tags = make([]string, 0)
  663. for _, s := range util.SplitNoEmpty(tagsStr, ",") {
  664. m.Tags = append(m.Tags, strings.TrimSpace(s))
  665. }
  666. }
  667. delayStr := readParam(r, "x-delay", "delay", "x-at", "at", "x-in", "in")
  668. if delayStr != "" {
  669. if !cache {
  670. return false, false, "", false, errHTTPBadRequestDelayNoCache
  671. }
  672. if email != "" {
  673. return false, false, "", false, errHTTPBadRequestDelayNoEmail // we cannot store the email address (yet)
  674. }
  675. delay, err := util.ParseFutureTime(delayStr, time.Now())
  676. if err != nil {
  677. return false, false, "", false, errHTTPBadRequestDelayCannotParse
  678. } else if delay.Unix() < time.Now().Add(s.config.MinDelay).Unix() {
  679. return false, false, "", false, errHTTPBadRequestDelayTooSmall
  680. } else if delay.Unix() > time.Now().Add(s.config.MaxDelay).Unix() {
  681. return false, false, "", false, errHTTPBadRequestDelayTooLarge
  682. }
  683. m.Time = delay.Unix()
  684. m.Sender = v.ip // Important for rate limiting
  685. }
  686. actionsStr := readParam(r, "x-actions", "actions", "action")
  687. if actionsStr != "" {
  688. m.Actions, err = parseActions(actionsStr)
  689. if err != nil {
  690. return false, false, "", false, wrapErrHTTP(errHTTPBadRequestActionsInvalid, err.Error())
  691. }
  692. }
  693. unifiedpush = readBoolParam(r, false, "x-unifiedpush", "unifiedpush", "up") // see GET too!
  694. if unifiedpush {
  695. firebase = false
  696. unifiedpush = true
  697. }
  698. m.PollID = readParam(r, "x-poll-id", "poll-id")
  699. if m.PollID != "" {
  700. unifiedpush = false
  701. cache = false
  702. email = ""
  703. }
  704. return cache, firebase, email, unifiedpush, nil
  705. }
  706. // handlePublishBody consumes the PUT/POST body and decides whether the body is an attachment or the message.
  707. //
  708. // 1. curl -X POST -H "Poll: 1234" ntfy.sh/...
  709. // If a message is flagged as poll request, the body does not matter and is discarded
  710. // 2. curl -T somebinarydata.bin "ntfy.sh/mytopic?up=1"
  711. // If body is binary, encode as base64, if not do not encode
  712. // 3. curl -H "Attach: http://example.com/file.jpg" ntfy.sh/mytopic
  713. // Body must be a message, because we attached an external URL
  714. // 4. curl -T short.txt -H "Filename: short.txt" ntfy.sh/mytopic
  715. // Body must be attachment, because we passed a filename
  716. // 5. curl -T file.txt ntfy.sh/mytopic
  717. // If file.txt is <= 4096 (message limit) and valid UTF-8, treat it as a message
  718. // 6. curl -T file.txt ntfy.sh/mytopic
  719. // If file.txt is > message limit, treat it as an attachment
  720. func (s *Server) handlePublishBody(r *http.Request, v *visitor, m *message, body *util.PeekedReadCloser, unifiedpush bool) error {
  721. if m.Event == pollRequestEvent { // Case 1
  722. return s.handleBodyDiscard(body)
  723. } else if unifiedpush {
  724. return s.handleBodyAsMessageAutoDetect(m, body) // Case 2
  725. } else if m.Attachment != nil && m.Attachment.URL != "" {
  726. return s.handleBodyAsTextMessage(m, body) // Case 3
  727. } else if m.Attachment != nil && m.Attachment.Name != "" {
  728. return s.handleBodyAsAttachment(r, v, m, body) // Case 4
  729. } else if !body.LimitReached && utf8.Valid(body.PeekedBytes) {
  730. return s.handleBodyAsTextMessage(m, body) // Case 5
  731. }
  732. return s.handleBodyAsAttachment(r, v, m, body) // Case 6
  733. }
  734. func (s *Server) handleBodyDiscard(body *util.PeekedReadCloser) error {
  735. _, err := io.Copy(io.Discard, body)
  736. _ = body.Close()
  737. return err
  738. }
  739. func (s *Server) handleBodyAsMessageAutoDetect(m *message, body *util.PeekedReadCloser) error {
  740. if utf8.Valid(body.PeekedBytes) {
  741. m.Message = string(body.PeekedBytes) // Do not trim
  742. } else {
  743. m.Message = base64.StdEncoding.EncodeToString(body.PeekedBytes)
  744. m.Encoding = encodingBase64
  745. }
  746. return nil
  747. }
  748. func (s *Server) handleBodyAsTextMessage(m *message, body *util.PeekedReadCloser) error {
  749. if !utf8.Valid(body.PeekedBytes) {
  750. return errHTTPBadRequestMessageNotUTF8
  751. }
  752. if len(body.PeekedBytes) > 0 { // Empty body should not override message (publish via GET!)
  753. m.Message = strings.TrimSpace(string(body.PeekedBytes)) // Truncates the message to the peek limit if required
  754. }
  755. if m.Attachment != nil && m.Attachment.Name != "" && m.Message == "" {
  756. m.Message = fmt.Sprintf(defaultAttachmentMessage, m.Attachment.Name)
  757. }
  758. return nil
  759. }
  760. func (s *Server) handleBodyAsAttachment(r *http.Request, v *visitor, m *message, body *util.PeekedReadCloser) error {
  761. if s.fileCache == nil || s.config.BaseURL == "" || s.config.AttachmentCacheDir == "" {
  762. return errHTTPBadRequestAttachmentsDisallowed
  763. } else if m.Time > time.Now().Add(s.config.AttachmentExpiryDuration).Unix() {
  764. return errHTTPBadRequestAttachmentsExpiryBeforeDelivery
  765. }
  766. stats, err := v.Stats()
  767. if err != nil {
  768. return err
  769. }
  770. contentLengthStr := r.Header.Get("Content-Length")
  771. if contentLengthStr != "" { // Early "do-not-trust" check, hard limit see below
  772. contentLength, err := strconv.ParseInt(contentLengthStr, 10, 64)
  773. if err == nil && (contentLength > stats.AttachmentTotalSizeRemaining || contentLength > stats.AttachmentFileSizeLimit) {
  774. return errHTTPEntityTooLargeAttachmentTooLarge
  775. }
  776. }
  777. if m.Attachment == nil {
  778. m.Attachment = &attachment{}
  779. }
  780. var ext string
  781. m.Sender = v.ip // Important for attachment rate limiting
  782. m.Attachment.Expires = time.Now().Add(s.config.AttachmentExpiryDuration).Unix()
  783. m.Attachment.Type, ext = util.DetectContentType(body.PeekedBytes, m.Attachment.Name)
  784. m.Attachment.URL = fmt.Sprintf("%s/file/%s%s", s.config.BaseURL, m.ID, ext)
  785. if m.Attachment.Name == "" {
  786. m.Attachment.Name = fmt.Sprintf("attachment%s", ext)
  787. }
  788. if m.Message == "" {
  789. m.Message = fmt.Sprintf(defaultAttachmentMessage, m.Attachment.Name)
  790. }
  791. limiters := []util.Limiter{
  792. v.BandwidthLimiter(),
  793. util.NewFixedLimiter(stats.AttachmentFileSizeLimit),
  794. util.NewFixedLimiter(stats.AttachmentTotalSizeRemaining),
  795. }
  796. m.Attachment.Size, err = s.fileCache.Write(m.ID, body, limiters...)
  797. if err == util.ErrLimitReached {
  798. return errHTTPEntityTooLargeAttachmentTooLarge
  799. } else if err != nil {
  800. return err
  801. }
  802. return nil
  803. }
  804. func (s *Server) handleSubscribeJSON(w http.ResponseWriter, r *http.Request, v *visitor) error {
  805. encoder := func(msg *message) (string, error) {
  806. var buf bytes.Buffer
  807. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  808. return "", err
  809. }
  810. return buf.String(), nil
  811. }
  812. return s.handleSubscribeHTTP(w, r, v, "application/x-ndjson", encoder)
  813. }
  814. func (s *Server) handleSubscribeSSE(w http.ResponseWriter, r *http.Request, v *visitor) error {
  815. encoder := func(msg *message) (string, error) {
  816. var buf bytes.Buffer
  817. if err := json.NewEncoder(&buf).Encode(&msg); err != nil {
  818. return "", err
  819. }
  820. if msg.Event != messageEvent {
  821. return fmt.Sprintf("event: %s\ndata: %s\n", msg.Event, buf.String()), nil // Browser's .onmessage() does not fire on this!
  822. }
  823. return fmt.Sprintf("data: %s\n", buf.String()), nil
  824. }
  825. return s.handleSubscribeHTTP(w, r, v, "text/event-stream", encoder)
  826. }
  827. func (s *Server) handleSubscribeRaw(w http.ResponseWriter, r *http.Request, v *visitor) error {
  828. encoder := func(msg *message) (string, error) {
  829. if msg.Event == messageEvent { // only handle default events
  830. return strings.ReplaceAll(msg.Message, "\n", " ") + "\n", nil
  831. }
  832. return "\n", nil // "keepalive" and "open" events just send an empty line
  833. }
  834. return s.handleSubscribeHTTP(w, r, v, "text/plain", encoder)
  835. }
  836. func (s *Server) handleSubscribeHTTP(w http.ResponseWriter, r *http.Request, v *visitor, contentType string, encoder messageEncoder) error {
  837. log.Debug("%s HTTP stream connection opened", logHTTPPrefix(v, r))
  838. defer log.Debug("%s HTTP stream connection closed", logHTTPPrefix(v, r))
  839. if err := v.SubscriptionAllowed(); err != nil {
  840. return errHTTPTooManyRequestsLimitSubscriptions
  841. }
  842. defer v.RemoveSubscription()
  843. topics, topicsStr, err := s.topicsFromPath(r.URL.Path)
  844. if err != nil {
  845. return err
  846. }
  847. poll, since, scheduled, filters, err := parseSubscribeParams(r)
  848. if err != nil {
  849. return err
  850. }
  851. var wlock sync.Mutex
  852. defer func() {
  853. // Hack: This is the fix for a horrible data race that I have not been able to figure out in quite some time.
  854. // It appears to be happening when the Go HTTP code reads from the socket when closing the request (i.e. AFTER
  855. // this function returns), and causes a data race with the ResponseWriter. Locking wlock here silences the
  856. // data race detector. See https://github.com/binwiederhier/ntfy/issues/338#issuecomment-1163425889.
  857. wlock.TryLock()
  858. }()
  859. sub := func(v *visitor, msg *message) error {
  860. if !filters.Pass(msg) {
  861. return nil
  862. }
  863. m, err := encoder(msg)
  864. if err != nil {
  865. return err
  866. }
  867. wlock.Lock()
  868. defer wlock.Unlock()
  869. if _, err := w.Write([]byte(m)); err != nil {
  870. return err
  871. }
  872. if fl, ok := w.(http.Flusher); ok {
  873. fl.Flush()
  874. }
  875. return nil
  876. }
  877. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  878. w.Header().Set("Content-Type", contentType+"; charset=utf-8") // Android/Volley client needs charset!
  879. if poll {
  880. return s.sendOldMessages(topics, since, scheduled, v, sub)
  881. }
  882. subscriberIDs := make([]int, 0)
  883. for _, t := range topics {
  884. subscriberIDs = append(subscriberIDs, t.Subscribe(sub))
  885. }
  886. defer func() {
  887. for i, subscriberID := range subscriberIDs {
  888. topics[i].Unsubscribe(subscriberID) // Order!
  889. }
  890. }()
  891. if err := sub(v, newOpenMessage(topicsStr)); err != nil { // Send out open message
  892. return err
  893. }
  894. if err := s.sendOldMessages(topics, since, scheduled, v, sub); err != nil {
  895. return err
  896. }
  897. for {
  898. select {
  899. case <-r.Context().Done():
  900. return nil
  901. case <-time.After(s.config.KeepaliveInterval):
  902. log.Trace("%s Sending keepalive message", logHTTPPrefix(v, r))
  903. v.Keepalive()
  904. if err := sub(v, newKeepaliveMessage(topicsStr)); err != nil { // Send keepalive message
  905. return err
  906. }
  907. }
  908. }
  909. }
  910. func (s *Server) handleSubscribeWS(w http.ResponseWriter, r *http.Request, v *visitor) error {
  911. if strings.ToLower(r.Header.Get("Upgrade")) != "websocket" {
  912. return errHTTPBadRequestWebSocketsUpgradeHeaderMissing
  913. }
  914. if err := v.SubscriptionAllowed(); err != nil {
  915. return errHTTPTooManyRequestsLimitSubscriptions
  916. }
  917. defer v.RemoveSubscription()
  918. log.Debug("%s WebSocket connection opened", logHTTPPrefix(v, r))
  919. defer log.Debug("%s WebSocket connection closed", logHTTPPrefix(v, r))
  920. topics, topicsStr, err := s.topicsFromPath(r.URL.Path)
  921. if err != nil {
  922. return err
  923. }
  924. poll, since, scheduled, filters, err := parseSubscribeParams(r)
  925. if err != nil {
  926. return err
  927. }
  928. upgrader := &websocket.Upgrader{
  929. ReadBufferSize: wsBufferSize,
  930. WriteBufferSize: wsBufferSize,
  931. CheckOrigin: func(r *http.Request) bool {
  932. return true // We're open for business!
  933. },
  934. }
  935. conn, err := upgrader.Upgrade(w, r, nil)
  936. if err != nil {
  937. return err
  938. }
  939. defer conn.Close()
  940. var wlock sync.Mutex
  941. g, ctx := errgroup.WithContext(context.Background())
  942. g.Go(func() error {
  943. pongWait := s.config.KeepaliveInterval + wsPongWait
  944. conn.SetReadLimit(wsReadLimit)
  945. if err := conn.SetReadDeadline(time.Now().Add(pongWait)); err != nil {
  946. return err
  947. }
  948. conn.SetPongHandler(func(appData string) error {
  949. log.Trace("%s Received WebSocket pong", logHTTPPrefix(v, r))
  950. return conn.SetReadDeadline(time.Now().Add(pongWait))
  951. })
  952. for {
  953. _, _, err := conn.NextReader()
  954. if err != nil {
  955. return err
  956. }
  957. }
  958. })
  959. g.Go(func() error {
  960. ping := func() error {
  961. wlock.Lock()
  962. defer wlock.Unlock()
  963. if err := conn.SetWriteDeadline(time.Now().Add(wsWriteWait)); err != nil {
  964. return err
  965. }
  966. log.Trace("%s Sending WebSocket ping", logHTTPPrefix(v, r))
  967. return conn.WriteMessage(websocket.PingMessage, nil)
  968. }
  969. for {
  970. select {
  971. case <-ctx.Done():
  972. return nil
  973. case <-time.After(s.config.KeepaliveInterval):
  974. v.Keepalive()
  975. if err := ping(); err != nil {
  976. return err
  977. }
  978. }
  979. }
  980. })
  981. sub := func(v *visitor, msg *message) error {
  982. if !filters.Pass(msg) {
  983. return nil
  984. }
  985. wlock.Lock()
  986. defer wlock.Unlock()
  987. if err := conn.SetWriteDeadline(time.Now().Add(wsWriteWait)); err != nil {
  988. return err
  989. }
  990. return conn.WriteJSON(msg)
  991. }
  992. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  993. if poll {
  994. return s.sendOldMessages(topics, since, scheduled, v, sub)
  995. }
  996. subscriberIDs := make([]int, 0)
  997. for _, t := range topics {
  998. subscriberIDs = append(subscriberIDs, t.Subscribe(sub))
  999. }
  1000. defer func() {
  1001. for i, subscriberID := range subscriberIDs {
  1002. topics[i].Unsubscribe(subscriberID) // Order!
  1003. }
  1004. }()
  1005. if err := sub(v, newOpenMessage(topicsStr)); err != nil { // Send out open message
  1006. return err
  1007. }
  1008. if err := s.sendOldMessages(topics, since, scheduled, v, sub); err != nil {
  1009. return err
  1010. }
  1011. err = g.Wait()
  1012. if err != nil && websocket.IsCloseError(err, websocket.CloseNormalClosure, websocket.CloseGoingAway, websocket.CloseAbnormalClosure) {
  1013. log.Trace("%s WebSocket connection closed: %s", logHTTPPrefix(v, r), err.Error())
  1014. return nil // Normal closures are not errors; note: "1006 (abnormal closure)" is treated as normal, because people disconnect a lot
  1015. }
  1016. return err
  1017. }
  1018. func parseSubscribeParams(r *http.Request) (poll bool, since sinceMarker, scheduled bool, filters *queryFilter, err error) {
  1019. poll = readBoolParam(r, false, "x-poll", "poll", "po")
  1020. scheduled = readBoolParam(r, false, "x-scheduled", "scheduled", "sched")
  1021. since, err = parseSince(r, poll)
  1022. if err != nil {
  1023. return
  1024. }
  1025. filters, err = parseQueryFilters(r)
  1026. if err != nil {
  1027. return
  1028. }
  1029. return
  1030. }
  1031. // sendOldMessages selects old messages from the messageCache and calls sub for each of them. It uses since as the
  1032. // marker, returning only messages that are newer than the marker.
  1033. func (s *Server) sendOldMessages(topics []*topic, since sinceMarker, scheduled bool, v *visitor, sub subscriber) error {
  1034. if since.IsNone() {
  1035. return nil
  1036. }
  1037. messages := make([]*message, 0)
  1038. for _, t := range topics {
  1039. topicMessages, err := s.messageCache.Messages(t.ID, since, scheduled)
  1040. if err != nil {
  1041. return err
  1042. }
  1043. messages = append(messages, topicMessages...)
  1044. }
  1045. sort.Slice(messages, func(i, j int) bool {
  1046. return messages[i].Time < messages[j].Time
  1047. })
  1048. for _, m := range messages {
  1049. if err := sub(v, m); err != nil {
  1050. return err
  1051. }
  1052. }
  1053. return nil
  1054. }
  1055. // parseSince returns a timestamp identifying the time span from which cached messages should be received.
  1056. //
  1057. // Values in the "since=..." parameter can be either a unix timestamp or a duration (e.g. 12h), or
  1058. // "all" for all messages.
  1059. func parseSince(r *http.Request, poll bool) (sinceMarker, error) {
  1060. since := readParam(r, "x-since", "since", "si")
  1061. // Easy cases (empty, all, none)
  1062. if since == "" {
  1063. if poll {
  1064. return sinceAllMessages, nil
  1065. }
  1066. return sinceNoMessages, nil
  1067. } else if since == "all" {
  1068. return sinceAllMessages, nil
  1069. } else if since == "none" {
  1070. return sinceNoMessages, nil
  1071. }
  1072. // ID, timestamp, duration
  1073. if validMessageID(since) {
  1074. return newSinceID(since), nil
  1075. } else if s, err := strconv.ParseInt(since, 10, 64); err == nil {
  1076. return newSinceTime(s), nil
  1077. } else if d, err := time.ParseDuration(since); err == nil {
  1078. return newSinceTime(time.Now().Add(-1 * d).Unix()), nil
  1079. }
  1080. return sinceNoMessages, errHTTPBadRequestSinceInvalid
  1081. }
  1082. func (s *Server) handleOptions(w http.ResponseWriter, _ *http.Request, _ *visitor) error {
  1083. w.Header().Set("Access-Control-Allow-Methods", "GET, PUT, POST, PATCH, DELETE")
  1084. w.Header().Set("Access-Control-Allow-Origin", "*") // CORS, allow cross-origin requests
  1085. w.Header().Set("Access-Control-Allow-Headers", "*") // CORS, allow auth via JS // FIXME is this terrible?
  1086. return nil
  1087. }
  1088. func (s *Server) topicFromPath(path string) (*topic, error) {
  1089. parts := strings.Split(path, "/")
  1090. if len(parts) < 2 {
  1091. return nil, errHTTPBadRequestTopicInvalid
  1092. }
  1093. topics, err := s.topicsFromIDs(parts[1])
  1094. if err != nil {
  1095. return nil, err
  1096. }
  1097. return topics[0], nil
  1098. }
  1099. func (s *Server) topicsFromPath(path string) ([]*topic, string, error) {
  1100. parts := strings.Split(path, "/")
  1101. if len(parts) < 2 {
  1102. return nil, "", errHTTPBadRequestTopicInvalid
  1103. }
  1104. topicIDs := util.SplitNoEmpty(parts[1], ",")
  1105. topics, err := s.topicsFromIDs(topicIDs...)
  1106. if err != nil {
  1107. return nil, "", errHTTPBadRequestTopicInvalid
  1108. }
  1109. return topics, parts[1], nil
  1110. }
  1111. func (s *Server) topicsFromIDs(ids ...string) ([]*topic, error) {
  1112. s.mu.Lock()
  1113. defer s.mu.Unlock()
  1114. topics := make([]*topic, 0)
  1115. for _, id := range ids {
  1116. if util.Contains(disallowedTopics, id) {
  1117. return nil, errHTTPBadRequestTopicDisallowed
  1118. }
  1119. if _, ok := s.topics[id]; !ok {
  1120. if len(s.topics) >= s.config.TotalTopicLimit {
  1121. return nil, errHTTPTooManyRequestsLimitTotalTopics
  1122. }
  1123. s.topics[id] = newTopic(id)
  1124. }
  1125. topics = append(topics, s.topics[id])
  1126. }
  1127. return topics, nil
  1128. }
  1129. func (s *Server) updateStatsAndPrune() {
  1130. log.Debug("Manager: Starting")
  1131. defer log.Debug("Manager: Finished")
  1132. // WARNING: Make sure to only selectively lock with the mutex, and be aware that this
  1133. // there is no mutex for the entire function.
  1134. // Expire visitors from rate visitors map
  1135. s.mu.Lock()
  1136. staleVisitors := 0
  1137. for ip, v := range s.visitors {
  1138. if v.Stale() {
  1139. log.Trace("Deleting stale visitor %s", v.ip)
  1140. delete(s.visitors, ip)
  1141. staleVisitors++
  1142. }
  1143. }
  1144. s.mu.Unlock()
  1145. log.Debug("Manager: Deleted %d stale visitor(s)", staleVisitors)
  1146. // Delete expired user tokens
  1147. if err := s.userManager.RemoveExpiredTokens(); err != nil {
  1148. log.Warn("Error expiring user tokens: %s", err.Error())
  1149. }
  1150. // Delete expired attachments
  1151. if s.fileCache != nil && s.config.AttachmentExpiryDuration > 0 {
  1152. olderThan := time.Now().Add(-1 * s.config.AttachmentExpiryDuration)
  1153. ids, err := s.fileCache.Expired(olderThan)
  1154. if err != nil {
  1155. log.Warn("Error retrieving expired attachments: %s", err.Error())
  1156. } else if len(ids) > 0 {
  1157. log.Debug("Manager: Deleting expired attachments: %v", ids)
  1158. if err := s.fileCache.Remove(ids...); err != nil {
  1159. log.Warn("Error deleting attachments: %s", err.Error())
  1160. }
  1161. } else {
  1162. log.Debug("Manager: No expired attachments to delete")
  1163. }
  1164. }
  1165. // Prune message cache
  1166. olderThan := time.Now().Add(-1 * s.config.CacheDuration)
  1167. log.Debug("Manager: Pruning messages older than %s", olderThan.Format("2006-01-02 15:04:05"))
  1168. if err := s.messageCache.Prune(olderThan); err != nil {
  1169. log.Warn("Manager: Error pruning cache: %s", err.Error())
  1170. }
  1171. // Message count per topic
  1172. var messages int
  1173. messageCounts, err := s.messageCache.MessageCounts()
  1174. if err != nil {
  1175. log.Warn("Manager: Cannot get message counts: %s", err.Error())
  1176. messageCounts = make(map[string]int) // Empty, so we can continue
  1177. }
  1178. for _, count := range messageCounts {
  1179. messages += count
  1180. }
  1181. // Remove subscriptions without subscribers
  1182. s.mu.Lock()
  1183. var subscribers int
  1184. for _, t := range s.topics {
  1185. subs := t.SubscribersCount()
  1186. msgs, exists := messageCounts[t.ID]
  1187. if subs == 0 && (!exists || msgs == 0) {
  1188. log.Trace("Deleting empty topic %s", t.ID)
  1189. delete(s.topics, t.ID)
  1190. continue
  1191. }
  1192. subscribers += subs
  1193. }
  1194. s.mu.Unlock()
  1195. // Mail stats
  1196. var receivedMailTotal, receivedMailSuccess, receivedMailFailure int64
  1197. if s.smtpServerBackend != nil {
  1198. receivedMailTotal, receivedMailSuccess, receivedMailFailure = s.smtpServerBackend.Counts()
  1199. }
  1200. var sentMailTotal, sentMailSuccess, sentMailFailure int64
  1201. if s.smtpSender != nil {
  1202. sentMailTotal, sentMailSuccess, sentMailFailure = s.smtpSender.Counts()
  1203. }
  1204. // Print stats
  1205. s.mu.Lock()
  1206. messagesCount, topicsCount, visitorsCount := s.messages, len(s.topics), len(s.visitors)
  1207. s.mu.Unlock()
  1208. log.Info("Stats: %d messages published, %d in cache, %d topic(s) active, %d subscriber(s), %d visitor(s), %d mails received (%d successful, %d failed), %d mails sent (%d successful, %d failed)",
  1209. messagesCount, messages, topicsCount, subscribers, visitorsCount,
  1210. receivedMailTotal, receivedMailSuccess, receivedMailFailure,
  1211. sentMailTotal, sentMailSuccess, sentMailFailure)
  1212. }
  1213. func (s *Server) runSMTPServer() error {
  1214. s.smtpServerBackend = newMailBackend(s.config, s.handle)
  1215. s.smtpServer = smtp.NewServer(s.smtpServerBackend)
  1216. s.smtpServer.Addr = s.config.SMTPServerListen
  1217. s.smtpServer.Domain = s.config.SMTPServerDomain
  1218. s.smtpServer.ReadTimeout = 10 * time.Second
  1219. s.smtpServer.WriteTimeout = 10 * time.Second
  1220. s.smtpServer.MaxMessageBytes = 1024 * 1024 // Must be much larger than message size (headers, multipart, etc.)
  1221. s.smtpServer.MaxRecipients = 1
  1222. s.smtpServer.AllowInsecureAuth = true
  1223. return s.smtpServer.ListenAndServe()
  1224. }
  1225. func (s *Server) runManager() {
  1226. for {
  1227. select {
  1228. case <-time.After(s.config.ManagerInterval):
  1229. s.updateStatsAndPrune()
  1230. case <-s.closeChan:
  1231. return
  1232. }
  1233. }
  1234. }
  1235. func (s *Server) runFirebaseKeepaliver() {
  1236. if s.firebaseClient == nil {
  1237. return
  1238. }
  1239. v := newVisitor(s.config, s.messageCache, netip.IPv4Unspecified(), nil) // Background process, not a real visitor, uses IP 0.0.0.0
  1240. for {
  1241. select {
  1242. case <-time.After(s.config.FirebaseKeepaliveInterval):
  1243. s.sendToFirebase(v, newKeepaliveMessage(firebaseControlTopic))
  1244. case <-time.After(s.config.FirebasePollInterval):
  1245. s.sendToFirebase(v, newKeepaliveMessage(firebasePollTopic))
  1246. case <-s.closeChan:
  1247. return
  1248. }
  1249. }
  1250. }
  1251. func (s *Server) runDelayedSender() {
  1252. for {
  1253. select {
  1254. case <-time.After(s.config.DelayedSenderInterval):
  1255. if err := s.sendDelayedMessages(); err != nil {
  1256. log.Warn("Error sending delayed messages: %s", err.Error())
  1257. }
  1258. case <-s.closeChan:
  1259. return
  1260. }
  1261. }
  1262. }
  1263. func (s *Server) sendDelayedMessages() error {
  1264. messages, err := s.messageCache.MessagesDue()
  1265. if err != nil {
  1266. return err
  1267. }
  1268. for _, m := range messages {
  1269. var v *visitor
  1270. if m.User != "" {
  1271. user, err := s.userManager.User(m.User)
  1272. if err != nil {
  1273. log.Warn("%s Error sending delayed message: %s", logMessagePrefix(v, m), err.Error())
  1274. continue
  1275. }
  1276. v = s.visitorFromUser(user, m.Sender)
  1277. } else {
  1278. v = s.visitorFromIP(m.Sender)
  1279. }
  1280. if err := s.sendDelayedMessage(v, m); err != nil {
  1281. log.Warn("%s Error sending delayed message: %s", logMessagePrefix(v, m), err.Error())
  1282. }
  1283. }
  1284. return nil
  1285. }
  1286. func (s *Server) sendDelayedMessage(v *visitor, m *message) error {
  1287. log.Debug("%s Sending delayed message", logMessagePrefix(v, m))
  1288. s.mu.Lock()
  1289. t, ok := s.topics[m.Topic] // If no subscribers, just mark message as published
  1290. s.mu.Unlock()
  1291. if ok {
  1292. go func() {
  1293. // We do not rate-limit messages here, since we've rate limited them in the PUT/POST handler
  1294. if err := t.Publish(v, m); err != nil {
  1295. log.Warn("%s Unable to publish message: %v", logMessagePrefix(v, m), err.Error())
  1296. }
  1297. }()
  1298. }
  1299. if s.firebaseClient != nil { // Firebase subscribers may not show up in topics map
  1300. go s.sendToFirebase(v, m)
  1301. }
  1302. if s.config.UpstreamBaseURL != "" {
  1303. go s.forwardPollRequest(v, m)
  1304. }
  1305. if err := s.messageCache.MarkPublished(m); err != nil {
  1306. return err
  1307. }
  1308. return nil
  1309. }
  1310. func (s *Server) limitRequests(next handleFunc) handleFunc {
  1311. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1312. if util.ContainsIP(s.config.VisitorRequestExemptIPAddrs, v.ip) {
  1313. return next(w, r, v)
  1314. } else if err := v.RequestAllowed(); err != nil {
  1315. return errHTTPTooManyRequestsLimitRequests
  1316. }
  1317. return next(w, r, v)
  1318. }
  1319. }
  1320. func (s *Server) ensureWebEnabled(next handleFunc) handleFunc {
  1321. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1322. if !s.config.EnableWeb {
  1323. return errHTTPNotFound
  1324. }
  1325. return next(w, r, v)
  1326. }
  1327. }
  1328. // transformBodyJSON peeks the request body, reads the JSON, and converts it to headers
  1329. // before passing it on to the next handler. This is meant to be used in combination with handlePublish.
  1330. func (s *Server) transformBodyJSON(next handleFunc) handleFunc {
  1331. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1332. body, err := util.Peek(r.Body, s.config.MessageLimit)
  1333. if err != nil {
  1334. return err
  1335. }
  1336. defer r.Body.Close()
  1337. var m publishMessage
  1338. if err := json.NewDecoder(body).Decode(&m); err != nil {
  1339. return errHTTPBadRequestJSONInvalid
  1340. }
  1341. if !topicRegex.MatchString(m.Topic) {
  1342. return errHTTPBadRequestTopicInvalid
  1343. }
  1344. if m.Message == "" {
  1345. m.Message = emptyMessageBody
  1346. }
  1347. r.URL.Path = "/" + m.Topic
  1348. r.Body = io.NopCloser(strings.NewReader(m.Message))
  1349. if m.Title != "" {
  1350. r.Header.Set("X-Title", m.Title)
  1351. }
  1352. if m.Priority != 0 {
  1353. r.Header.Set("X-Priority", fmt.Sprintf("%d", m.Priority))
  1354. }
  1355. if m.Tags != nil && len(m.Tags) > 0 {
  1356. r.Header.Set("X-Tags", strings.Join(m.Tags, ","))
  1357. }
  1358. if m.Attach != "" {
  1359. r.Header.Set("X-Attach", m.Attach)
  1360. }
  1361. if m.Filename != "" {
  1362. r.Header.Set("X-Filename", m.Filename)
  1363. }
  1364. if m.Click != "" {
  1365. r.Header.Set("X-Click", m.Click)
  1366. }
  1367. if m.Icon != "" {
  1368. r.Header.Set("X-Icon", m.Icon)
  1369. }
  1370. if len(m.Actions) > 0 {
  1371. actionsStr, err := json.Marshal(m.Actions)
  1372. if err != nil {
  1373. return errHTTPBadRequestJSONInvalid
  1374. }
  1375. r.Header.Set("X-Actions", string(actionsStr))
  1376. }
  1377. if m.Email != "" {
  1378. r.Header.Set("X-Email", m.Email)
  1379. }
  1380. if m.Delay != "" {
  1381. r.Header.Set("X-Delay", m.Delay)
  1382. }
  1383. return next(w, r, v)
  1384. }
  1385. }
  1386. func (s *Server) transformMatrixJSON(next handleFunc) handleFunc {
  1387. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1388. newRequest, err := newRequestFromMatrixJSON(r, s.config.BaseURL, s.config.MessageLimit)
  1389. if err != nil {
  1390. return err
  1391. }
  1392. if err := next(w, newRequest, v); err != nil {
  1393. return &errMatrix{pushKey: newRequest.Header.Get(matrixPushKeyHeader), err: err}
  1394. }
  1395. return nil
  1396. }
  1397. }
  1398. func (s *Server) authorizeTopicWrite(next handleFunc) handleFunc {
  1399. return s.autorizeTopic(next, user.PermissionWrite)
  1400. }
  1401. func (s *Server) authorizeTopicRead(next handleFunc) handleFunc {
  1402. return s.autorizeTopic(next, user.PermissionRead)
  1403. }
  1404. func (s *Server) autorizeTopic(next handleFunc, perm user.Permission) handleFunc {
  1405. return func(w http.ResponseWriter, r *http.Request, v *visitor) error {
  1406. if s.userManager == nil {
  1407. return next(w, r, v)
  1408. }
  1409. topics, _, err := s.topicsFromPath(r.URL.Path)
  1410. if err != nil {
  1411. return err
  1412. }
  1413. for _, t := range topics {
  1414. if err := s.userManager.Authorize(v.user, t.ID, perm); err != nil {
  1415. log.Info("unauthorized: %s", err.Error())
  1416. return errHTTPForbidden
  1417. }
  1418. }
  1419. return next(w, r, v)
  1420. }
  1421. }
  1422. // visitor creates or retrieves a rate.Limiter for the given visitor.
  1423. // Note that this function will always return a visitor, even if an error occurs.
  1424. func (s *Server) visitor(r *http.Request) (v *visitor, err error) {
  1425. ip := extractIPAddress(r, s.config.BehindProxy)
  1426. var user *user.User // may stay nil if no auth header!
  1427. if user, err = s.authenticate(r); err != nil {
  1428. log.Debug("authentication failed: %s", err.Error())
  1429. err = errHTTPUnauthorized // Always return visitor, even when error occurs!
  1430. }
  1431. if user != nil {
  1432. v = s.visitorFromUser(user, ip)
  1433. } else {
  1434. v = s.visitorFromIP(ip)
  1435. }
  1436. v.user = user // Update user -- FIXME race?
  1437. return v, err // Always return visitor, even when error occurs!
  1438. }
  1439. // authenticate a user based on basic auth username/password (Authorization: Basic ...), or token auth (Authorization: Bearer ...).
  1440. // The Authorization header can be passed as a header or the ?auth=... query param. The latter is required only to
  1441. // support the WebSocket JavaScript class, which does not support passing headers during the initial request. The auth
  1442. // query param is effectively double base64 encoded. Its format is base64(Basic base64(user:pass)).
  1443. func (s *Server) authenticate(r *http.Request) (user *user.User, err error) {
  1444. value := r.Header.Get("Authorization")
  1445. queryParam := readQueryParam(r, "authorization", "auth")
  1446. if queryParam != "" {
  1447. a, err := base64.RawURLEncoding.DecodeString(queryParam)
  1448. if err != nil {
  1449. return nil, err
  1450. }
  1451. value = string(a)
  1452. }
  1453. if value == "" {
  1454. return nil, nil
  1455. }
  1456. if strings.HasPrefix(value, "Bearer") {
  1457. return s.authenticateBearerAuth(value)
  1458. }
  1459. return s.authenticateBasicAuth(r, value)
  1460. }
  1461. func (s *Server) authenticateBasicAuth(r *http.Request, value string) (user *user.User, err error) {
  1462. r.Header.Set("Authorization", value)
  1463. username, password, ok := r.BasicAuth()
  1464. if !ok {
  1465. return nil, errors.New("invalid basic auth")
  1466. }
  1467. return s.userManager.Authenticate(username, password)
  1468. }
  1469. func (s *Server) authenticateBearerAuth(value string) (user *user.User, err error) {
  1470. token := strings.TrimSpace(strings.TrimPrefix(value, "Bearer"))
  1471. return s.userManager.AuthenticateToken(token)
  1472. }
  1473. func (s *Server) visitorFromID(visitorID string, ip netip.Addr, user *user.User) *visitor {
  1474. s.mu.Lock()
  1475. defer s.mu.Unlock()
  1476. v, exists := s.visitors[visitorID]
  1477. if !exists {
  1478. s.visitors[visitorID] = newVisitor(s.config, s.messageCache, ip, user)
  1479. return s.visitors[visitorID]
  1480. }
  1481. v.Keepalive()
  1482. return v
  1483. }
  1484. func (s *Server) visitorFromIP(ip netip.Addr) *visitor {
  1485. return s.visitorFromID(fmt.Sprintf("ip:%s", ip.String()), ip, nil)
  1486. }
  1487. func (s *Server) visitorFromUser(user *user.User, ip netip.Addr) *visitor {
  1488. return s.visitorFromID(fmt.Sprintf("user:%s", user.Name), ip, user)
  1489. }