]> git.r.bdr.sh - rbdr/mobius/blame - hotline/server.go
Merge pull request #90 from jhalter/refactor_client_agreement_flow
[rbdr/mobius] / hotline / server.go
CommitLineData
6988a057
JH
1package hotline
2
3import (
7cd900d6 4 "bufio"
6988a057
JH
5 "context"
6 "encoding/binary"
7 "errors"
8 "fmt"
041c2df6 9 "github.com/go-playground/validator/v10"
6988a057 10 "go.uber.org/zap"
7cd900d6 11 "gopkg.in/yaml.v3"
6988a057 12 "io"
16a4ad70 13 "io/fs"
6988a057 14 "io/ioutil"
6988a057
JH
15 "math/big"
16 "math/rand"
17 "net"
18 "os"
6988a057 19 "path/filepath"
6988a057
JH
20 "strings"
21 "sync"
22 "time"
6988a057
JH
23)
24
7cd900d6
JH
25type contextKey string
26
27var contextKeyReq = contextKey("req")
28
29type requestCtx struct {
30 remoteAddr string
31 login string
32 name string
33}
34
6988a057 35type Server struct {
8eb43f95
JH
36 Port int
37 Accounts map[string]*Account
38 Agreement []byte
39 Clients map[uint16]*ClientConn
df1ade54
JH
40 fileTransfers map[[4]byte]*FileTransfer
41
c1c44744
JH
42 Config *Config
43 ConfigDir string
44 Logger *zap.SugaredLogger
45
46 PrivateChatsMu sync.Mutex
47 PrivateChats map[uint32]*PrivateChat
48
6988a057 49 NextGuestID *uint16
40414f92 50 TrackerPassID [4]byte
00913df3
JH
51
52 StatsMu sync.Mutex
53 Stats *Stats
6988a057 54
7cd900d6 55 FS FileStore // Storage backend to use for File storage
6988a057
JH
56
57 outbox chan Transaction
7cd900d6 58 mux sync.Mutex
6988a057 59
8eb43f95
JH
60 threadedNewsMux sync.Mutex
61 ThreadedNews *ThreadedNews
62
6988a057 63 flatNewsMux sync.Mutex
7cd900d6 64 FlatNews []byte
46862572
JH
65
66 banListMU sync.Mutex
67 banList map[string]*time.Time
6988a057
JH
68}
69
00913df3
JH
70func (s *Server) CurrentStats() Stats {
71 s.StatsMu.Lock()
72 defer s.StatsMu.Unlock()
73
74 stats := s.Stats
75 stats.CurrentlyConnected = len(s.Clients)
76
77 return *stats
78}
79
6988a057
JH
80type PrivateChat struct {
81 Subject string
82 ClientConn map[uint16]*ClientConn
83}
84
85func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFunc) error {
aeec1015
JH
86 s.Logger.Infow("Hotline server started",
87 "version", VERSION,
88 "API port", fmt.Sprintf(":%v", s.Port),
89 "Transfer port", fmt.Sprintf(":%v", s.Port+1),
90 )
91
6988a057
JH
92 var wg sync.WaitGroup
93
94 wg.Add(1)
8168522a
JH
95 go func() {
96 ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", "", s.Port))
97 if err != nil {
98 s.Logger.Fatal(err)
99 }
100
7cd900d6 101 s.Logger.Fatal(s.Serve(ctx, ln))
8168522a 102 }()
6988a057
JH
103
104 wg.Add(1)
8168522a
JH
105 go func() {
106 ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", "", s.Port+1))
107 if err != nil {
108 s.Logger.Fatal(err)
109
110 }
111
7cd900d6 112 s.Logger.Fatal(s.ServeFileTransfers(ctx, ln))
8168522a 113 }()
6988a057
JH
114
115 wg.Wait()
116
117 return nil
118}
119
7cd900d6 120func (s *Server) ServeFileTransfers(ctx context.Context, ln net.Listener) error {
6988a057
JH
121 for {
122 conn, err := ln.Accept()
123 if err != nil {
124 return err
125 }
126
127 go func() {
7cd900d6
JH
128 defer func() { _ = conn.Close() }()
129
130 err = s.handleFileTransfer(
131 context.WithValue(ctx, contextKeyReq, requestCtx{
132 remoteAddr: conn.RemoteAddr().String(),
133 }),
134 conn,
135 )
136
137 if err != nil {
6988a057
JH
138 s.Logger.Errorw("file transfer error", "reason", err)
139 }
140 }()
141 }
142}
143
144func (s *Server) sendTransaction(t Transaction) error {
6988a057
JH
145 clientID, err := byteToInt(*t.clientID)
146 if err != nil {
147 return err
148 }
149
150 s.mux.Lock()
151 client := s.Clients[uint16(clientID)]
75e4191b 152 s.mux.Unlock()
6988a057 153 if client == nil {
bd1ce113 154 return fmt.Errorf("invalid client id %v", *t.clientID)
6988a057 155 }
6988a057 156
72dd37f1
JH
157 b, err := t.MarshalBinary()
158 if err != nil {
159 return err
160 }
3178ae58 161
75e4191b
JH
162 _, err = client.Connection.Write(b)
163 if err != nil {
6988a057
JH
164 return err
165 }
3178ae58 166
6988a057
JH
167 return nil
168}
169
67db911d
JH
170func (s *Server) processOutbox() {
171 for {
172 t := <-s.outbox
173 go func() {
174 if err := s.sendTransaction(t); err != nil {
175 s.Logger.Errorw("error sending transaction", "err", err)
176 }
177 }()
178 }
179}
180
7cd900d6 181func (s *Server) Serve(ctx context.Context, ln net.Listener) error {
67db911d
JH
182 go s.processOutbox()
183
6988a057
JH
184 for {
185 conn, err := ln.Accept()
186 if err != nil {
187 s.Logger.Errorw("error accepting connection", "err", err)
188 }
67db911d
JH
189 connCtx := context.WithValue(ctx, contextKeyReq, requestCtx{
190 remoteAddr: conn.RemoteAddr().String(),
191 })
6988a057
JH
192
193 go func() {
0da28a1f
JH
194 s.Logger.Infow("Connection established", "RemoteAddr", conn.RemoteAddr())
195
46862572 196 defer conn.Close()
67db911d 197 if err := s.handleNewConnection(connCtx, conn, conn.RemoteAddr().String()); err != nil {
6988a057
JH
198 if err == io.EOF {
199 s.Logger.Infow("Client disconnected", "RemoteAddr", conn.RemoteAddr())
200 } else {
201 s.Logger.Errorw("error serving request", "RemoteAddr", conn.RemoteAddr(), "err", err)
202 }
203 }
204 }()
205 }
206}
207
208const (
c7e932c0 209 agreementFile = "Agreement.txt"
6988a057
JH
210)
211
212// NewServer constructs a new Server from a config dir
7cd900d6 213func NewServer(configDir string, netPort int, logger *zap.SugaredLogger, FS FileStore) (*Server, error) {
6988a057
JH
214 server := Server{
215 Port: netPort,
216 Accounts: make(map[string]*Account),
217 Config: new(Config),
218 Clients: make(map[uint16]*ClientConn),
df1ade54 219 fileTransfers: make(map[[4]byte]*FileTransfer),
6988a057
JH
220 PrivateChats: make(map[uint32]*PrivateChat),
221 ConfigDir: configDir,
222 Logger: logger,
223 NextGuestID: new(uint16),
224 outbox: make(chan Transaction),
00913df3 225 Stats: &Stats{Since: time.Now()},
6988a057 226 ThreadedNews: &ThreadedNews{},
b196a50a 227 FS: FS,
46862572 228 banList: make(map[string]*time.Time),
6988a057
JH
229 }
230
8168522a 231 var err error
6988a057
JH
232
233 // generate a new random passID for tracker registration
40414f92 234 if _, err := rand.Read(server.TrackerPassID[:]); err != nil {
6988a057
JH
235 return nil, err
236 }
237
f22acf38 238 server.Agreement, err = os.ReadFile(filepath.Join(configDir, agreementFile))
b196a50a 239 if err != nil {
6988a057
JH
240 return nil, err
241 }
242
f22acf38 243 if server.FlatNews, err = os.ReadFile(filepath.Join(configDir, "MessageBoard.txt")); err != nil {
6988a057
JH
244 return nil, err
245 }
246
46862572
JH
247 // try to load the ban list, but ignore errors as this file may not be present or may be empty
248 _ = server.loadBanList(filepath.Join(configDir, "Banlist.yaml"))
249
f22acf38 250 if err := server.loadThreadedNews(filepath.Join(configDir, "ThreadedNews.yaml")); err != nil {
6988a057
JH
251 return nil, err
252 }
253
f22acf38 254 if err := server.loadConfig(filepath.Join(configDir, "config.yaml")); err != nil {
6988a057
JH
255 return nil, err
256 }
257
f22acf38 258 if err := server.loadAccounts(filepath.Join(configDir, "Users/")); err != nil {
6988a057
JH
259 return nil, err
260 }
261
f22acf38 262 server.Config.FileRoot = filepath.Join(configDir, "Files")
6988a057
JH
263
264 *server.NextGuestID = 1
265
266 if server.Config.EnableTrackerRegistration {
e42888eb
JH
267 server.Logger.Infow(
268 "Tracker registration enabled",
269 "frequency", fmt.Sprintf("%vs", trackerUpdateFrequency),
270 "trackers", server.Config.Trackers,
271 )
272
6988a057
JH
273 go func() {
274 for {
e42888eb 275 tr := &TrackerRegistration{
6988a057 276 UserCount: server.userCount(),
40414f92 277 PassID: server.TrackerPassID[:],
6988a057
JH
278 Name: server.Config.Name,
279 Description: server.Config.Description,
280 }
40414f92 281 binary.BigEndian.PutUint16(tr.Port[:], uint16(server.Port))
6988a057 282 for _, t := range server.Config.Trackers {
6988a057
JH
283 if err := register(t, tr); err != nil {
284 server.Logger.Errorw("unable to register with tracker %v", "error", err)
285 }
78b305d6 286 server.Logger.Debugw("Sent Tracker registration", "addr", t)
6988a057
JH
287 }
288
289 time.Sleep(trackerUpdateFrequency * time.Second)
290 }
291 }()
292 }
293
294 // Start Client Keepalive go routine
295 go server.keepaliveHandler()
296
297 return &server, nil
298}
299
300func (s *Server) userCount() int {
301 s.mux.Lock()
302 defer s.mux.Unlock()
303
304 return len(s.Clients)
305}
306
307func (s *Server) keepaliveHandler() {
308 for {
309 time.Sleep(idleCheckInterval * time.Second)
310 s.mux.Lock()
311
312 for _, c := range s.Clients {
61c272e1
JH
313 c.IdleTime += idleCheckInterval
314 if c.IdleTime > userIdleSeconds && !c.Idle {
6988a057
JH
315 c.Idle = true
316
a7216f67 317 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(c.Flags)))
6988a057 318 flagBitmap.SetBit(flagBitmap, userFlagAway, 1)
a7216f67 319 binary.BigEndian.PutUint16(c.Flags, uint16(flagBitmap.Int64()))
6988a057
JH
320
321 c.sendAll(
322 tranNotifyChangeUser,
323 NewField(fieldUserID, *c.ID),
a7216f67 324 NewField(fieldUserFlags, c.Flags),
72dd37f1 325 NewField(fieldUserName, c.UserName),
a7216f67 326 NewField(fieldUserIconID, c.Icon),
6988a057
JH
327 )
328 }
329 }
330 s.mux.Unlock()
331 }
332}
333
46862572
JH
334func (s *Server) writeBanList() error {
335 s.banListMU.Lock()
336 defer s.banListMU.Unlock()
337
338 out, err := yaml.Marshal(s.banList)
339 if err != nil {
340 return err
341 }
342 err = ioutil.WriteFile(
343 filepath.Join(s.ConfigDir, "Banlist.yaml"),
344 out,
345 0666,
346 )
347 return err
348}
349
6988a057 350func (s *Server) writeThreadedNews() error {
8eb43f95
JH
351 s.threadedNewsMux.Lock()
352 defer s.threadedNewsMux.Unlock()
6988a057
JH
353
354 out, err := yaml.Marshal(s.ThreadedNews)
355 if err != nil {
356 return err
357 }
8eb43f95 358 err = s.FS.WriteFile(
f22acf38 359 filepath.Join(s.ConfigDir, "ThreadedNews.yaml"),
6988a057
JH
360 out,
361 0666,
362 )
363 return err
364}
365
67db911d 366func (s *Server) NewClientConn(conn io.ReadWriteCloser, remoteAddr string) *ClientConn {
6988a057
JH
367 s.mux.Lock()
368 defer s.mux.Unlock()
369
370 clientConn := &ClientConn{
371 ID: &[]byte{0, 0},
a7216f67
JH
372 Icon: []byte{0, 0},
373 Flags: []byte{0, 0},
72dd37f1 374 UserName: []byte{},
6988a057
JH
375 Connection: conn,
376 Server: s,
a7216f67 377 Version: []byte{},
aebc4d36 378 AutoReply: []byte{},
df1ade54 379 transfers: map[int]map[[4]byte]*FileTransfer{},
d4c152a4 380 RemoteAddr: remoteAddr,
6988a057 381 }
df1ade54
JH
382 clientConn.transfers = map[int]map[[4]byte]*FileTransfer{
383 FileDownload: {},
384 FileUpload: {},
385 FolderDownload: {},
386 FolderUpload: {},
387 bannerDownload: {},
388 }
389
6988a057
JH
390 *s.NextGuestID++
391 ID := *s.NextGuestID
392
6988a057
JH
393 binary.BigEndian.PutUint16(*clientConn.ID, ID)
394 s.Clients[ID] = clientConn
395
396 return clientConn
397}
398
399// NewUser creates a new user account entry in the server map and config file
187d6dc5 400func (s *Server) NewUser(login, name, password string, access accessBitmap) error {
6988a057
JH
401 s.mux.Lock()
402 defer s.mux.Unlock()
403
404 account := Account{
405 Login: login,
406 Name: name,
407 Password: hashAndSalt([]byte(password)),
187d6dc5 408 Access: access,
6988a057
JH
409 }
410 out, err := yaml.Marshal(&account)
411 if err != nil {
412 return err
413 }
414 s.Accounts[login] = &account
415
f22acf38 416 return s.FS.WriteFile(filepath.Join(s.ConfigDir, "Users", login+".yaml"), out, 0666)
6988a057
JH
417}
418
187d6dc5 419func (s *Server) UpdateUser(login, newLogin, name, password string, access accessBitmap) error {
d2810ae9
JH
420 s.mux.Lock()
421 defer s.mux.Unlock()
422
d2810ae9
JH
423 // update renames the user login
424 if login != newLogin {
f22acf38 425 err := os.Rename(filepath.Join(s.ConfigDir, "Users", login+".yaml"), filepath.Join(s.ConfigDir, "Users", newLogin+".yaml"))
d2810ae9
JH
426 if err != nil {
427 return err
428 }
429 s.Accounts[newLogin] = s.Accounts[login]
430 delete(s.Accounts, login)
431 }
432
433 account := s.Accounts[newLogin]
187d6dc5 434 account.Access = access
d2810ae9
JH
435 account.Name = name
436 account.Password = password
437
438 out, err := yaml.Marshal(&account)
439 if err != nil {
440 return err
441 }
f22acf38
JH
442
443 if err := os.WriteFile(filepath.Join(s.ConfigDir, "Users", newLogin+".yaml"), out, 0666); err != nil {
d2810ae9
JH
444 return err
445 }
446
447 return nil
448}
449
6988a057
JH
450// DeleteUser deletes the user account
451func (s *Server) DeleteUser(login string) error {
452 s.mux.Lock()
453 defer s.mux.Unlock()
454
455 delete(s.Accounts, login)
456
f22acf38 457 return s.FS.Remove(filepath.Join(s.ConfigDir, "Users", login+".yaml"))
6988a057
JH
458}
459
460func (s *Server) connectedUsers() []Field {
461 s.mux.Lock()
462 defer s.mux.Unlock()
463
464 var connectedUsers []Field
c7e932c0 465 for _, c := range sortedClients(s.Clients) {
6988a057
JH
466 user := User{
467 ID: *c.ID,
a7216f67
JH
468 Icon: c.Icon,
469 Flags: c.Flags,
72dd37f1 470 Name: string(c.UserName),
6988a057
JH
471 }
472 connectedUsers = append(connectedUsers, NewField(fieldUsernameWithInfo, user.Payload()))
473 }
474 return connectedUsers
475}
476
46862572
JH
477func (s *Server) loadBanList(path string) error {
478 fh, err := os.Open(path)
479 if err != nil {
480 return err
481 }
482 decoder := yaml.NewDecoder(fh)
483
484 return decoder.Decode(s.banList)
485}
486
6988a057
JH
487// loadThreadedNews loads the threaded news data from disk
488func (s *Server) loadThreadedNews(threadedNewsPath string) error {
489 fh, err := os.Open(threadedNewsPath)
490 if err != nil {
491 return err
492 }
493 decoder := yaml.NewDecoder(fh)
6988a057
JH
494
495 return decoder.Decode(s.ThreadedNews)
496}
497
498// loadAccounts loads account data from disk
499func (s *Server) loadAccounts(userDir string) error {
f22acf38 500 matches, err := filepath.Glob(filepath.Join(userDir, "*.yaml"))
6988a057
JH
501 if err != nil {
502 return err
503 }
504
505 if len(matches) == 0 {
506 return errors.New("no user accounts found in " + userDir)
507 }
508
509 for _, file := range matches {
b196a50a 510 fh, err := s.FS.Open(file)
6988a057
JH
511 if err != nil {
512 return err
513 }
514
515 account := Account{}
516 decoder := yaml.NewDecoder(fh)
6988a057
JH
517 if err := decoder.Decode(&account); err != nil {
518 return err
519 }
520
521 s.Accounts[account.Login] = &account
522 }
523 return nil
524}
525
526func (s *Server) loadConfig(path string) error {
b196a50a 527 fh, err := s.FS.Open(path)
6988a057
JH
528 if err != nil {
529 return err
530 }
531
532 decoder := yaml.NewDecoder(fh)
6988a057
JH
533 err = decoder.Decode(s.Config)
534 if err != nil {
535 return err
536 }
041c2df6
JH
537
538 validate := validator.New()
539 err = validate.Struct(s.Config)
540 if err != nil {
541 return err
542 }
6988a057
JH
543 return nil
544}
545
6988a057 546// handleNewConnection takes a new net.Conn and performs the initial login sequence
3178ae58 547func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser, remoteAddr string) error {
c4208f86
JH
548 defer dontPanic(s.Logger)
549
3178ae58 550 if err := Handshake(rwc); err != nil {
6988a057
JH
551 return err
552 }
553
3178ae58
JH
554 // Create a new scanner for parsing incoming bytes into transaction tokens
555 scanner := bufio.NewScanner(rwc)
556 scanner.Split(transactionScanner)
557
558 scanner.Scan()
6988a057 559
f4cdaddc
JH
560 // Make a new []byte slice and copy the scanner bytes to it. This is critical to avoid a data race as the
561 // scanner re-uses the buffer for subsequent scans.
562 buf := make([]byte, len(scanner.Bytes()))
563 copy(buf, scanner.Bytes())
564
854a92fc 565 var clientLogin Transaction
f4cdaddc 566 if _, err := clientLogin.Write(buf); err != nil {
854a92fc 567 return err
6988a057
JH
568 }
569
3178ae58 570 c := s.NewClientConn(rwc, remoteAddr)
46862572
JH
571
572 // check if remoteAddr is present in the ban list
573 if banUntil, ok := s.banList[strings.Split(remoteAddr, ":")[0]]; ok {
574 // permaban
575 if banUntil == nil {
576 s.outbox <- *NewTransaction(
577 tranServerMsg,
578 c.ID,
579 NewField(fieldData, []byte("You are permanently banned on this server")),
580 NewField(fieldChatOptions, []byte{0, 0}),
581 )
582 time.Sleep(1 * time.Second)
583 return nil
584 } else if time.Now().Before(*banUntil) {
585 s.outbox <- *NewTransaction(
586 tranServerMsg,
587 c.ID,
588 NewField(fieldData, []byte("You are temporarily banned on this server")),
589 NewField(fieldChatOptions, []byte{0, 0}),
590 )
591 time.Sleep(1 * time.Second)
592 return nil
593 }
594
595 }
6988a057 596 defer c.Disconnect()
6988a057
JH
597
598 encodedLogin := clientLogin.GetField(fieldUserLogin).Data
599 encodedPassword := clientLogin.GetField(fieldUserPassword).Data
a7216f67 600 c.Version = clientLogin.GetField(fieldVersion).Data
6988a057
JH
601
602 var login string
603 for _, char := range encodedLogin {
604 login += string(rune(255 - uint(char)))
605 }
606 if login == "" {
607 login = GuestAccount
608 }
609
0da28a1f
JH
610 c.logger = s.Logger.With("remoteAddr", remoteAddr, "login", login)
611
6988a057
JH
612 // If authentication fails, send error reply and close connection
613 if !c.Authenticate(login, encodedPassword) {
854a92fc 614 t := c.NewErrReply(&clientLogin, "Incorrect login.")
72dd37f1
JH
615 b, err := t.MarshalBinary()
616 if err != nil {
617 return err
618 }
3178ae58 619 if _, err := rwc.Write(b); err != nil {
6988a057
JH
620 return err
621 }
0da28a1f 622
a7216f67 623 c.logger.Infow("Login failed", "clientVersion", fmt.Sprintf("%x", c.Version))
0da28a1f
JH
624
625 return nil
6988a057
JH
626 }
627
59097464 628 if clientLogin.GetField(fieldUserIconID).Data != nil {
a7216f67 629 c.Icon = clientLogin.GetField(fieldUserIconID).Data
59097464
JH
630 }
631
632 c.Account = c.Server.Accounts[login]
633
6988a057 634 if clientLogin.GetField(fieldUserName).Data != nil {
ea5d8c51
JH
635 if c.Authorize(accessAnyName) {
636 c.UserName = clientLogin.GetField(fieldUserName).Data
637 } else {
638 c.UserName = []byte(c.Account.Name)
639 }
6988a057
JH
640 }
641
6988a057 642 if c.Authorize(accessDisconUser) {
a7216f67 643 c.Flags = []byte{0, 2}
6988a057
JH
644 }
645
854a92fc 646 s.outbox <- c.NewReply(&clientLogin,
6988a057 647 NewField(fieldVersion, []byte{0x00, 0xbe}),
9067f234 648 NewField(fieldCommunityBannerID, []byte{0, 0}),
6988a057
JH
649 NewField(fieldServerName, []byte(s.Config.Name)),
650 )
651
652 // Send user access privs so client UI knows how to behave
187d6dc5 653 c.Server.outbox <- *NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, c.Account.Access[:]))
6988a057 654
a322be02
JH
655 // Accounts with accessNoAgreement do not receive the server agreement on login. The behavior is different between
656 // client versions. For 1.2.3 client, we do not send tranShowAgreement. For other client versions, we send
657 // tranShowAgreement but with the NoServerAgreement field set to 1.
688c86d2 658 if c.Authorize(accessNoAgreement) {
a322be02
JH
659 // If client version is nil, then the client uses the 1.2.3 login behavior
660 if c.Version != nil {
661 c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldNoServerAgreement, []byte{1}))
662 }
688c86d2
JH
663 } else {
664 c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldData, s.Agreement))
665 }
6988a057 666
a82b93cf 667 // Used simplified hotline v1.2.3 login flow for clients that do not send login info in tranAgreed
fa0552fe 668 // TODO: figure out a generalized solution that doesn't require playing whack-a-mole for specific client versions
5853654f
JH
669 c.logger = c.logger.With("name", string(c.UserName))
670 c.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%v", func() int { i, _ := byteToInt(c.Version); return i }()))
671
672 for _, t := range c.notifyOthers(
673 *NewTransaction(
674 tranNotifyChangeUser, nil,
675 NewField(fieldUserName, c.UserName),
676 NewField(fieldUserID, *c.ID),
677 NewField(fieldUserIconID, c.Icon),
678 NewField(fieldUserFlags, c.Flags),
679 ),
680 ) {
681 c.Server.outbox <- t
6988a057 682 }
bd1ce113 683
00913df3
JH
684 c.Server.Stats.ConnectionCounter += 1
685 if len(s.Clients) > c.Server.Stats.ConnectionPeak {
686 c.Server.Stats.ConnectionPeak = len(s.Clients)
687 }
6988a057 688
3178ae58
JH
689 // Scan for new transactions and handle them as they come in.
690 for scanner.Scan() {
691 // Make a new []byte slice and copy the scanner bytes to it. This is critical to avoid a data race as the
692 // scanner re-uses the buffer for subsequent scans.
693 buf := make([]byte, len(scanner.Bytes()))
694 copy(buf, scanner.Bytes())
6988a057 695
854a92fc
JH
696 var t Transaction
697 if _, err := t.Write(buf); err != nil {
698 return err
6988a057 699 }
854a92fc
JH
700
701 if err := c.handleTransaction(t); err != nil {
0fcfa5d5 702 c.logger.Errorw("Error handling transaction", "err", err)
6988a057 703 }
6988a057 704 }
3178ae58 705 return nil
6988a057
JH
706}
707
6988a057 708func (s *Server) NewPrivateChat(cc *ClientConn) []byte {
c1c44744
JH
709 s.PrivateChatsMu.Lock()
710 defer s.PrivateChatsMu.Unlock()
6988a057
JH
711
712 randID := make([]byte, 4)
713 rand.Read(randID)
714 data := binary.BigEndian.Uint32(randID[:])
715
716 s.PrivateChats[data] = &PrivateChat{
6988a057
JH
717 ClientConn: make(map[uint16]*ClientConn),
718 }
719 s.PrivateChats[data].ClientConn[cc.uint16ID()] = cc
720
721 return randID
722}
723
724const dlFldrActionSendFile = 1
725const dlFldrActionResumeFile = 2
726const dlFldrActionNextFile = 3
727
85767504 728// handleFileTransfer receives a client net.Conn from the file transfer server, performs the requested transfer type, then closes the connection
7cd900d6 729func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) error {
37a954c8 730 defer dontPanic(s.Logger)
0a92e50b 731
2e7c03cf 732 txBuf := make([]byte, 16)
7cd900d6 733 if _, err := io.ReadFull(rwc, txBuf); err != nil {
6988a057
JH
734 return err
735 }
736
df2735b2 737 var t transfer
0a92e50b 738 if _, err := t.Write(txBuf); err != nil {
6988a057
JH
739 return err
740 }
741
0a92e50b
JH
742 defer func() {
743 s.mux.Lock()
df1ade54 744 delete(s.fileTransfers, t.ReferenceNumber)
0a92e50b 745 s.mux.Unlock()
df1ade54 746
94742e2f
JH
747 // Wait a few seconds before closing the connection: this is a workaround for problems
748 // observed with Windows clients where the client must initiate close of the TCP connection before
749 // the server does. This is gross and seems unnecessary. TODO: Revisit?
750 time.Sleep(3 * time.Second)
0a92e50b 751 }()
6988a057 752
0a92e50b 753 s.mux.Lock()
df1ade54 754 fileTransfer, ok := s.fileTransfers[t.ReferenceNumber]
0a92e50b
JH
755 s.mux.Unlock()
756 if !ok {
757 return errors.New("invalid transaction ID")
758 }
16a4ad70 759
df1ade54
JH
760 defer func() {
761 fileTransfer.ClientConn.transfersMU.Lock()
762 delete(fileTransfer.ClientConn.transfers[fileTransfer.Type], t.ReferenceNumber)
763 fileTransfer.ClientConn.transfersMU.Unlock()
764 }()
765
7cd900d6
JH
766 rLogger := s.Logger.With(
767 "remoteAddr", ctx.Value(contextKeyReq).(requestCtx).remoteAddr,
df1ade54
JH
768 "login", fileTransfer.ClientConn.Account.Login,
769 "name", string(fileTransfer.ClientConn.UserName),
7cd900d6
JH
770 )
771
df1ade54
JH
772 fullPath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName)
773 if err != nil {
774 return err
775 }
776
6988a057 777 switch fileTransfer.Type {
9067f234
JH
778 case bannerDownload:
779 if err := s.bannerDownload(rwc); err != nil {
780 return err
781 }
6988a057 782 case FileDownload:
23411fc2 783 s.Stats.DownloadCounter += 1
00913df3 784 s.Stats.DownloadsInProgress += 1
94742e2f
JH
785 defer func() {
786 s.Stats.DownloadsInProgress -= 1
787 }()
23411fc2 788
16a4ad70
JH
789 var dataOffset int64
790 if fileTransfer.fileResumeData != nil {
791 dataOffset = int64(binary.BigEndian.Uint32(fileTransfer.fileResumeData.ForkInfoList[0].DataSize[:]))
792 }
793
df1ade54 794 fw, err := newFileWrapper(s.FS, fullPath, 0)
6988a057
JH
795 if err != nil {
796 return err
797 }
798
df1ade54 799 rLogger.Infow("File download started", "filePath", fullPath)
7cd900d6
JH
800
801 // if file transfer options are included, that means this is a "quick preview" request from a 1.5+ client
d1cd6664
JH
802 if fileTransfer.options == nil {
803 // Start by sending flat file object to client
df1ade54 804 if _, err := rwc.Write(fw.ffo.BinaryMarshal()); err != nil {
d1cd6664
JH
805 return err
806 }
6988a057
JH
807 }
808
7cd900d6 809 file, err := fw.dataForkReader()
6988a057
JH
810 if err != nil {
811 return err
812 }
813
df1ade54
JH
814 br := bufio.NewReader(file)
815 if _, err := br.Discard(int(dataOffset)); err != nil {
7cd900d6
JH
816 return err
817 }
818
df1ade54 819 if _, err = io.Copy(rwc, io.TeeReader(br, fileTransfer.bytesSentCounter)); err != nil {
7cd900d6
JH
820 return err
821 }
822
df1ade54 823 // if the client requested to resume transfer, do not send the resource fork header, or it will be appended into the fileWrapper data
7cd900d6 824 if fileTransfer.fileResumeData == nil {
df1ade54 825 err = binary.Write(rwc, binary.BigEndian, fw.rsrcForkHeader())
16a4ad70
JH
826 if err != nil {
827 return err
828 }
6988a057 829 }
7cd900d6
JH
830
831 rFile, err := fw.rsrcForkFile()
832 if err != nil {
833 return nil
834 }
835
df1ade54 836 if _, err = io.Copy(rwc, io.TeeReader(rFile, fileTransfer.bytesSentCounter)); err != nil {
7cd900d6
JH
837 return err
838 }
839
6988a057 840 case FileUpload:
23411fc2 841 s.Stats.UploadCounter += 1
00913df3
JH
842 s.Stats.UploadsInProgress += 1
843 defer func() { s.Stats.UploadsInProgress -= 1 }()
23411fc2 844
5c14e4c9
JH
845 var file *os.File
846
847 // A file upload has three possible cases:
848 // 1) Upload a new file
849 // 2) Resume a partially transferred file
850 // 3) Replace a fully uploaded file
7cd900d6 851 // We have to infer which case applies by inspecting what is already on the filesystem
5c14e4c9
JH
852
853 // 1) Check for existing file:
df1ade54 854 _, err = os.Stat(fullPath)
5c14e4c9 855 if err == nil {
df1ade54 856 return errors.New("existing file found at " + fullPath)
5c14e4c9 857 }
16a4ad70 858 if errors.Is(err, fs.ErrNotExist) {
7cd900d6 859 // If not found, open or create a new .incomplete file
df1ade54 860 file, err = os.OpenFile(fullPath+incompleteFileSuffix, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
16a4ad70
JH
861 if err != nil {
862 return err
863 }
6988a057 864 }
16a4ad70 865
df1ade54 866 f, err := newFileWrapper(s.FS, fullPath, 0)
7cd900d6
JH
867 if err != nil {
868 return err
869 }
870
df1ade54 871 rLogger.Infow("File upload started", "dstFile", fullPath)
6988a057 872
7cd900d6
JH
873 rForkWriter := io.Discard
874 iForkWriter := io.Discard
875 if s.Config.PreserveResourceForks {
876 rForkWriter, err = f.rsrcForkWriter()
877 if err != nil {
878 return err
879 }
880
881 iForkWriter, err = f.infoForkWriter()
882 if err != nil {
883 return err
884 }
885 }
886
df1ade54
JH
887 if err := receiveFile(rwc, file, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
888 s.Logger.Error(err)
16a4ad70
JH
889 }
890
e00ff8fe
JH
891 if err := file.Close(); err != nil {
892 return err
893 }
67db911d 894
df1ade54 895 if err := s.FS.Rename(fullPath+".incomplete", fullPath); err != nil {
16a4ad70 896 return err
6988a057 897 }
85767504 898
df1ade54 899 rLogger.Infow("File upload complete", "dstFile", fullPath)
00913df3 900
6988a057 901 case FolderDownload:
00913df3
JH
902 s.Stats.DownloadCounter += 1
903 s.Stats.DownloadsInProgress += 1
904 defer func() { s.Stats.DownloadsInProgress -= 1 }()
905
6988a057 906 // Folder Download flow:
df2735b2 907 // 1. Get filePath from the transfer
6988a057 908 // 2. Iterate over files
7cd900d6
JH
909 // 3. For each fileWrapper:
910 // Send fileWrapper header to client
6988a057
JH
911 // The client can reply in 3 ways:
912 //
7cd900d6
JH
913 // 1. If type is an odd number (unknown type?), or fileWrapper download for the current fileWrapper is completed:
914 // client sends []byte{0x00, 0x03} to tell the server to continue to the next fileWrapper
6988a057 915 //
7cd900d6 916 // 2. If download of a fileWrapper is to be resumed:
6988a057
JH
917 // client sends:
918 // []byte{0x00, 0x02} // download folder action
919 // [2]byte // Resume data size
7cd900d6 920 // []byte fileWrapper resume data (see myField_FileResumeData)
6988a057 921 //
7cd900d6 922 // 3. Otherwise, download of the fileWrapper is requested and client sends []byte{0x00, 0x01}
6988a057
JH
923 //
924 // When download is requested (case 2 or 3), server replies with:
7cd900d6 925 // [4]byte - fileWrapper size
6988a057
JH
926 // []byte - Flattened File Object
927 //
7cd900d6 928 // After every fileWrapper download, client could request next fileWrapper with:
6988a057
JH
929 // []byte{0x00, 0x03}
930 //
931 // This notifies the server to send the next item header
932
df1ade54 933 basePathLen := len(fullPath)
6988a057 934
df1ade54 935 rLogger.Infow("Start folder download", "path", fullPath)
6988a057 936
85767504 937 nextAction := make([]byte, 2)
7cd900d6 938 if _, err := io.ReadFull(rwc, nextAction); err != nil {
85767504
JH
939 return err
940 }
6988a057
JH
941
942 i := 0
df1ade54 943 err = filepath.Walk(fullPath+"/", func(path string, info os.FileInfo, err error) error {
23411fc2 944 s.Stats.DownloadCounter += 1
7cd900d6 945 i += 1
23411fc2 946
85767504
JH
947 if err != nil {
948 return err
949 }
7cd900d6
JH
950
951 // skip dot files
952 if strings.HasPrefix(info.Name(), ".") {
953 return nil
954 }
955
956 hlFile, err := newFileWrapper(s.FS, path, 0)
957 if err != nil {
958 return err
959 }
960
85767504 961 subPath := path[basePathLen+1:]
df1ade54 962 rLogger.Debugw("Sending fileheader", "i", i, "path", path, "fullFilePath", fullPath, "subPath", subPath, "IsDir", info.IsDir())
6988a057 963
6988a057
JH
964 if i == 1 {
965 return nil
966 }
967
85767504
JH
968 fileHeader := NewFileHeader(subPath, info.IsDir())
969
7cd900d6
JH
970 // Send the fileWrapper header to client
971 if _, err := rwc.Write(fileHeader.Payload()); err != nil {
6988a057
JH
972 s.Logger.Errorf("error sending file header: %v", err)
973 return err
974 }
975
976 // Read the client's Next Action request
7cd900d6 977 if _, err := io.ReadFull(rwc, nextAction); err != nil {
6988a057
JH
978 return err
979 }
980
df1ade54 981 rLogger.Debugw("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2]))
6988a057 982
16a4ad70
JH
983 var dataOffset int64
984
985 switch nextAction[1] {
986 case dlFldrActionResumeFile:
16a4ad70 987 // get size of resumeData
7cd900d6
JH
988 resumeDataByteLen := make([]byte, 2)
989 if _, err := io.ReadFull(rwc, resumeDataByteLen); err != nil {
16a4ad70
JH
990 return err
991 }
992
7cd900d6 993 resumeDataLen := binary.BigEndian.Uint16(resumeDataByteLen)
16a4ad70 994 resumeDataBytes := make([]byte, resumeDataLen)
7cd900d6 995 if _, err := io.ReadFull(rwc, resumeDataBytes); err != nil {
16a4ad70
JH
996 return err
997 }
998
7cd900d6 999 var frd FileResumeData
16a4ad70
JH
1000 if err := frd.UnmarshalBinary(resumeDataBytes); err != nil {
1001 return err
1002 }
1003 dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:]))
1004 case dlFldrActionNextFile:
1005 // client asked to skip this file
1006 return nil
1007 }
1008
6988a057
JH
1009 if info.IsDir() {
1010 return nil
1011 }
1012
df1ade54 1013 rLogger.Infow("File download started",
6988a057 1014 "fileName", info.Name(),
7cd900d6 1015 "TransferSize", fmt.Sprintf("%x", hlFile.ffo.TransferSize(dataOffset)),
6988a057
JH
1016 )
1017
1018 // Send file size to client
7cd900d6 1019 if _, err := rwc.Write(hlFile.ffo.TransferSize(dataOffset)); err != nil {
6988a057
JH
1020 s.Logger.Error(err)
1021 return err
1022 }
1023
85767504 1024 // Send ffo bytes to client
7cd900d6 1025 if _, err := rwc.Write(hlFile.ffo.BinaryMarshal()); err != nil {
6988a057
JH
1026 s.Logger.Error(err)
1027 return err
1028 }
1029
b196a50a 1030 file, err := s.FS.Open(path)
6988a057
JH
1031 if err != nil {
1032 return err
1033 }
1034
7cd900d6 1035 // wr := bufio.NewWriterSize(rwc, 1460)
df1ade54 1036 if _, err = io.Copy(rwc, io.TeeReader(file, fileTransfer.bytesSentCounter)); err != nil {
7cd900d6
JH
1037 return err
1038 }
1039
1040 if nextAction[1] != 2 && hlFile.ffo.FlatFileHeader.ForkCount[1] == 3 {
1041 err = binary.Write(rwc, binary.BigEndian, hlFile.rsrcForkHeader())
16a4ad70 1042 if err != nil {
7cd900d6 1043 return err
16a4ad70 1044 }
16a4ad70 1045
7cd900d6
JH
1046 rFile, err := hlFile.rsrcForkFile()
1047 if err != nil {
1048 return err
1049 }
16a4ad70 1050
df1ade54 1051 if _, err = io.Copy(rwc, io.TeeReader(rFile, fileTransfer.bytesSentCounter)); err != nil {
16a4ad70
JH
1052 return err
1053 }
85767504 1054 }
6988a057 1055
16a4ad70 1056 // Read the client's Next Action request. This is always 3, I think?
7cd900d6 1057 if _, err := io.ReadFull(rwc, nextAction); err != nil {
85767504 1058 return err
6988a057 1059 }
85767504 1060
16a4ad70 1061 return nil
6988a057
JH
1062 })
1063
67db911d
JH
1064 if err != nil {
1065 return err
1066 }
1067
6988a057 1068 case FolderUpload:
00913df3
JH
1069 s.Stats.UploadCounter += 1
1070 s.Stats.UploadsInProgress += 1
1071 defer func() { s.Stats.UploadsInProgress -= 1 }()
df1ade54 1072 rLogger.Infow(
6988a057 1073 "Folder upload started",
df1ade54
JH
1074 "dstPath", fullPath,
1075 "TransferSize", binary.BigEndian.Uint32(fileTransfer.TransferSize),
6988a057
JH
1076 "FolderItemCount", fileTransfer.FolderItemCount,
1077 )
1078
1079 // Check if the target folder exists. If not, create it.
df1ade54
JH
1080 if _, err := s.FS.Stat(fullPath); os.IsNotExist(err) {
1081 if err := s.FS.Mkdir(fullPath, 0777); err != nil {
16a4ad70 1082 return err
6988a057
JH
1083 }
1084 }
1085
6988a057 1086 // Begin the folder upload flow by sending the "next file action" to client
7cd900d6 1087 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
6988a057
JH
1088 return err
1089 }
1090
1091 fileSize := make([]byte, 4)
16a4ad70
JH
1092
1093 for i := 0; i < fileTransfer.ItemCount(); i++ {
ba29c43b
JH
1094 s.Stats.UploadCounter += 1
1095
1096 var fu folderUpload
7cd900d6 1097 if _, err := io.ReadFull(rwc, fu.DataSize[:]); err != nil {
ba29c43b
JH
1098 return err
1099 }
7cd900d6 1100 if _, err := io.ReadFull(rwc, fu.IsFolder[:]); err != nil {
ba29c43b
JH
1101 return err
1102 }
7cd900d6 1103 if _, err := io.ReadFull(rwc, fu.PathItemCount[:]); err != nil {
ba29c43b
JH
1104 return err
1105 }
ba29c43b 1106
7cd900d6
JH
1107 fu.FileNamePath = make([]byte, binary.BigEndian.Uint16(fu.DataSize[:])-4) // -4 to subtract the path separator bytes
1108
1109 if _, err := io.ReadFull(rwc, fu.FileNamePath); err != nil {
6988a057
JH
1110 return err
1111 }
6988a057 1112
df1ade54 1113 rLogger.Infow(
6988a057 1114 "Folder upload continued",
6988a057
JH
1115 "FormattedPath", fu.FormattedPath(),
1116 "IsFolder", fmt.Sprintf("%x", fu.IsFolder),
c5d9af5a 1117 "PathItemCount", binary.BigEndian.Uint16(fu.PathItemCount[:]),
6988a057
JH
1118 )
1119
c5d9af5a 1120 if fu.IsFolder == [2]byte{0, 1} {
df1ade54
JH
1121 if _, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath())); os.IsNotExist(err) {
1122 if err := os.Mkdir(filepath.Join(fullPath, fu.FormattedPath()), 0777); err != nil {
16a4ad70 1123 return err
6988a057
JH
1124 }
1125 }
1126
1127 // Tell client to send next file
7cd900d6 1128 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
6988a057
JH
1129 return err
1130 }
1131 } else {
16a4ad70
JH
1132 nextAction := dlFldrActionSendFile
1133
1134 // Check if we have the full file already. If so, send dlFldrAction_NextFile to client to skip.
df1ade54 1135 _, err = os.Stat(filepath.Join(fullPath, fu.FormattedPath()))
16a4ad70 1136 if err != nil && !errors.Is(err, fs.ErrNotExist) {
6988a057
JH
1137 return err
1138 }
16a4ad70
JH
1139 if err == nil {
1140 nextAction = dlFldrActionNextFile
1141 }
6988a057 1142
16a4ad70 1143 // Check if we have a partial file already. If so, send dlFldrAction_ResumeFile to client to resume upload.
df1ade54 1144 incompleteFile, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath()+incompleteFileSuffix))
16a4ad70 1145 if err != nil && !errors.Is(err, fs.ErrNotExist) {
85767504 1146 return err
6988a057 1147 }
16a4ad70
JH
1148 if err == nil {
1149 nextAction = dlFldrActionResumeFile
1150 }
6988a057 1151
7cd900d6 1152 if _, err := rwc.Write([]byte{0, uint8(nextAction)}); err != nil {
85767504
JH
1153 return err
1154 }
1155
16a4ad70
JH
1156 switch nextAction {
1157 case dlFldrActionNextFile:
1158 continue
1159 case dlFldrActionResumeFile:
1160 offset := make([]byte, 4)
7cd900d6 1161 binary.BigEndian.PutUint32(offset, uint32(incompleteFile.Size()))
16a4ad70 1162
df1ade54 1163 file, err := os.OpenFile(fullPath+"/"+fu.FormattedPath()+incompleteFileSuffix, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
16a4ad70
JH
1164 if err != nil {
1165 return err
1166 }
1167
7cd900d6 1168 fileResumeData := NewFileResumeData([]ForkInfoList{*NewForkInfoList(offset)})
16a4ad70
JH
1169
1170 b, _ := fileResumeData.BinaryMarshal()
1171
1172 bs := make([]byte, 2)
1173 binary.BigEndian.PutUint16(bs, uint16(len(b)))
1174
7cd900d6 1175 if _, err := rwc.Write(append(bs, b...)); err != nil {
16a4ad70
JH
1176 return err
1177 }
1178
7cd900d6 1179 if _, err := io.ReadFull(rwc, fileSize); err != nil {
16a4ad70
JH
1180 return err
1181 }
1182
df1ade54 1183 if err := receiveFile(rwc, file, ioutil.Discard, ioutil.Discard, fileTransfer.bytesSentCounter); err != nil {
16a4ad70
JH
1184 s.Logger.Error(err)
1185 }
1186
df1ade54 1187 err = os.Rename(fullPath+"/"+fu.FormattedPath()+".incomplete", fullPath+"/"+fu.FormattedPath())
16a4ad70
JH
1188 if err != nil {
1189 return err
1190 }
1191
1192 case dlFldrActionSendFile:
7cd900d6 1193 if _, err := io.ReadFull(rwc, fileSize); err != nil {
16a4ad70
JH
1194 return err
1195 }
1196
df1ade54 1197 filePath := filepath.Join(fullPath, fu.FormattedPath())
16a4ad70 1198
7cd900d6 1199 hlFile, err := newFileWrapper(s.FS, filePath, 0)
16a4ad70
JH
1200 if err != nil {
1201 return err
1202 }
1203
df1ade54 1204 rLogger.Infow("Starting file transfer", "path", filePath, "fileNum", i+1, "fileSize", binary.BigEndian.Uint32(fileSize))
7cd900d6
JH
1205
1206 incWriter, err := hlFile.incFileWriter()
1207 if err != nil {
1208 return err
1209 }
1210
1211 rForkWriter := io.Discard
1212 iForkWriter := io.Discard
1213 if s.Config.PreserveResourceForks {
1214 iForkWriter, err = hlFile.infoForkWriter()
1215 if err != nil {
1216 return err
1217 }
1218
1219 rForkWriter, err = hlFile.rsrcForkWriter()
1220 if err != nil {
1221 return err
1222 }
16a4ad70 1223 }
df1ade54 1224 if err := receiveFile(rwc, incWriter, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
7cd900d6
JH
1225 return err
1226 }
df1ade54 1227
16a4ad70
JH
1228 if err := os.Rename(filePath+".incomplete", filePath); err != nil {
1229 return err
1230 }
6988a057
JH
1231 }
1232
7cd900d6
JH
1233 // Tell client to send next fileWrapper
1234 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
6988a057
JH
1235 return err
1236 }
6988a057
JH
1237 }
1238 }
df1ade54 1239 rLogger.Infof("Folder upload complete")
6988a057
JH
1240 }
1241
1242 return nil
1243}