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