]> git.r.bdr.sh - rbdr/mobius/blame - hotline/server.go
Merge pull request #49 from jhalter/fix_1.2.3_client_no_agreement_behavior
[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
a7216f67 311 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(c.Flags)))
6988a057 312 flagBitmap.SetBit(flagBitmap, userFlagAway, 1)
a7216f67 313 binary.BigEndian.PutUint16(c.Flags, uint16(flagBitmap.Int64()))
6988a057
JH
314
315 c.sendAll(
316 tranNotifyChangeUser,
317 NewField(fieldUserID, *c.ID),
a7216f67 318 NewField(fieldUserFlags, c.Flags),
72dd37f1 319 NewField(fieldUserName, c.UserName),
a7216f67 320 NewField(fieldUserIconID, c.Icon),
6988a057
JH
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},
a7216f67
JH
366 Icon: []byte{0, 0},
367 Flags: []byte{0, 0},
72dd37f1 368 UserName: []byte{},
6988a057
JH
369 Connection: conn,
370 Server: s,
a7216f67 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,
a7216f67
JH
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
a7216f67 601 c.Version = clientLogin.GetField(fieldVersion).Data
6988a057
JH
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 623
a7216f67 624 c.logger.Infow("Login failed", "clientVersion", fmt.Sprintf("%x", c.Version))
0da28a1f
JH
625
626 return nil
6988a057
JH
627 }
628
59097464 629 if clientLogin.GetField(fieldUserIconID).Data != nil {
a7216f67 630 c.Icon = clientLogin.GetField(fieldUserIconID).Data
59097464
JH
631 }
632
633 c.Account = c.Server.Accounts[login]
634
6988a057 635 if clientLogin.GetField(fieldUserName).Data != nil {
ea5d8c51
JH
636 if c.Authorize(accessAnyName) {
637 c.UserName = clientLogin.GetField(fieldUserName).Data
638 } else {
639 c.UserName = []byte(c.Account.Name)
640 }
6988a057
JH
641 }
642
6988a057 643 if c.Authorize(accessDisconUser) {
a7216f67 644 c.Flags = []byte{0, 2}
6988a057
JH
645 }
646
6988a057
JH
647 s.outbox <- c.NewReply(clientLogin,
648 NewField(fieldVersion, []byte{0x00, 0xbe}),
9067f234 649 NewField(fieldCommunityBannerID, []byte{0, 0}),
6988a057
JH
650 NewField(fieldServerName, []byte(s.Config.Name)),
651 )
652
653 // Send user access privs so client UI knows how to behave
654 c.Server.outbox <- *NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, *c.Account.Access))
655
a322be02
JH
656 // Accounts with accessNoAgreement do not receive the server agreement on login. The behavior is different between
657 // client versions. For 1.2.3 client, we do not send tranShowAgreement. For other client versions, we send
658 // tranShowAgreement but with the NoServerAgreement field set to 1.
688c86d2 659 if c.Authorize(accessNoAgreement) {
a322be02
JH
660 // If client version is nil, then the client uses the 1.2.3 login behavior
661 if c.Version != nil {
662 c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldNoServerAgreement, []byte{1}))
663 }
688c86d2
JH
664 } else {
665 c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldData, s.Agreement))
666 }
6988a057 667
a82b93cf 668 // Used simplified hotline v1.2.3 login flow for clients that do not send login info in tranAgreed
a7216f67 669 if c.Version == nil || bytes.Equal(c.Version, nostalgiaVersion) {
bd1ce113 670 c.Agreed = true
67db911d 671 c.logger = c.logger.With("name", string(c.UserName))
a7216f67 672 c.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%x", c.Version))
67db911d 673
21581958 674 for _, t := range c.notifyOthers(
003a743e
JH
675 *NewTransaction(
676 tranNotifyChangeUser, nil,
677 NewField(fieldUserName, c.UserName),
678 NewField(fieldUserID, *c.ID),
a7216f67
JH
679 NewField(fieldUserIconID, c.Icon),
680 NewField(fieldUserFlags, c.Flags),
003a743e 681 ),
21581958
JH
682 ) {
683 c.Server.outbox <- t
684 }
6988a057 685 }
bd1ce113 686
6988a057
JH
687 c.Server.Stats.LoginCount += 1
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
3178ae58 696 t, _, err := ReadTransaction(buf)
6988a057 697 if err != nil {
3178ae58 698 panic(err)
6988a057 699 }
3178ae58 700 if err := c.handleTransaction(*t); err != nil {
0fcfa5d5 701 c.logger.Errorw("Error handling transaction", "err", err)
6988a057 702 }
6988a057 703 }
3178ae58 704 return nil
6988a057
JH
705}
706
6988a057
JH
707func (s *Server) NewPrivateChat(cc *ClientConn) []byte {
708 s.mux.Lock()
709 defer s.mux.Unlock()
710
711 randID := make([]byte, 4)
712 rand.Read(randID)
713 data := binary.BigEndian.Uint32(randID[:])
714
715 s.PrivateChats[data] = &PrivateChat{
716 Subject: "",
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
0a92e50b 747 }()
6988a057 748
0a92e50b 749 s.mux.Lock()
df1ade54 750 fileTransfer, ok := s.fileTransfers[t.ReferenceNumber]
0a92e50b
JH
751 s.mux.Unlock()
752 if !ok {
753 return errors.New("invalid transaction ID")
754 }
16a4ad70 755
df1ade54
JH
756 defer func() {
757 fileTransfer.ClientConn.transfersMU.Lock()
758 delete(fileTransfer.ClientConn.transfers[fileTransfer.Type], t.ReferenceNumber)
759 fileTransfer.ClientConn.transfersMU.Unlock()
760 }()
761
7cd900d6
JH
762 rLogger := s.Logger.With(
763 "remoteAddr", ctx.Value(contextKeyReq).(requestCtx).remoteAddr,
df1ade54
JH
764 "login", fileTransfer.ClientConn.Account.Login,
765 "name", string(fileTransfer.ClientConn.UserName),
7cd900d6
JH
766 )
767
df1ade54
JH
768 fullPath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName)
769 if err != nil {
770 return err
771 }
772
6988a057 773 switch fileTransfer.Type {
9067f234
JH
774 case bannerDownload:
775 if err := s.bannerDownload(rwc); err != nil {
df1ade54 776 panic(err)
9067f234
JH
777 return err
778 }
6988a057 779 case FileDownload:
23411fc2
JH
780 s.Stats.DownloadCounter += 1
781
16a4ad70
JH
782 var dataOffset int64
783 if fileTransfer.fileResumeData != nil {
784 dataOffset = int64(binary.BigEndian.Uint32(fileTransfer.fileResumeData.ForkInfoList[0].DataSize[:]))
785 }
786
df1ade54 787 fw, err := newFileWrapper(s.FS, fullPath, 0)
6988a057
JH
788 if err != nil {
789 return err
790 }
791
df1ade54 792 rLogger.Infow("File download started", "filePath", fullPath)
7cd900d6
JH
793
794 // if file transfer options are included, that means this is a "quick preview" request from a 1.5+ client
d1cd6664
JH
795 if fileTransfer.options == nil {
796 // Start by sending flat file object to client
df1ade54 797 if _, err := rwc.Write(fw.ffo.BinaryMarshal()); err != nil {
d1cd6664
JH
798 return err
799 }
6988a057
JH
800 }
801
7cd900d6 802 file, err := fw.dataForkReader()
6988a057
JH
803 if err != nil {
804 return err
805 }
806
df1ade54
JH
807 br := bufio.NewReader(file)
808 if _, err := br.Discard(int(dataOffset)); err != nil {
7cd900d6
JH
809 return err
810 }
811
df1ade54 812 if _, err = io.Copy(rwc, io.TeeReader(br, fileTransfer.bytesSentCounter)); err != nil {
7cd900d6
JH
813 return err
814 }
815
df1ade54 816 // if the client requested to resume transfer, do not send the resource fork header, or it will be appended into the fileWrapper data
7cd900d6 817 if fileTransfer.fileResumeData == nil {
df1ade54 818 err = binary.Write(rwc, binary.BigEndian, fw.rsrcForkHeader())
16a4ad70
JH
819 if err != nil {
820 return err
821 }
6988a057 822 }
7cd900d6
JH
823
824 rFile, err := fw.rsrcForkFile()
825 if err != nil {
826 return nil
827 }
828
df1ade54 829 if _, err = io.Copy(rwc, io.TeeReader(rFile, fileTransfer.bytesSentCounter)); err != nil {
7cd900d6
JH
830 return err
831 }
832
6988a057 833 case FileUpload:
23411fc2
JH
834 s.Stats.UploadCounter += 1
835
5c14e4c9
JH
836 var file *os.File
837
838 // A file upload has three possible cases:
839 // 1) Upload a new file
840 // 2) Resume a partially transferred file
841 // 3) Replace a fully uploaded file
7cd900d6 842 // We have to infer which case applies by inspecting what is already on the filesystem
5c14e4c9
JH
843
844 // 1) Check for existing file:
df1ade54 845 _, err = os.Stat(fullPath)
5c14e4c9 846 if err == nil {
df1ade54 847 return errors.New("existing file found at " + fullPath)
5c14e4c9 848 }
16a4ad70 849 if errors.Is(err, fs.ErrNotExist) {
7cd900d6 850 // If not found, open or create a new .incomplete file
df1ade54 851 file, err = os.OpenFile(fullPath+incompleteFileSuffix, os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
16a4ad70
JH
852 if err != nil {
853 return err
854 }
6988a057 855 }
16a4ad70 856
df1ade54 857 f, err := newFileWrapper(s.FS, fullPath, 0)
7cd900d6
JH
858 if err != nil {
859 return err
860 }
861
df1ade54 862 rLogger.Infow("File upload started", "dstFile", fullPath)
6988a057 863
7cd900d6
JH
864 rForkWriter := io.Discard
865 iForkWriter := io.Discard
866 if s.Config.PreserveResourceForks {
867 rForkWriter, err = f.rsrcForkWriter()
868 if err != nil {
869 return err
870 }
871
872 iForkWriter, err = f.infoForkWriter()
873 if err != nil {
874 return err
875 }
876 }
877
df1ade54
JH
878 if err := receiveFile(rwc, file, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
879 s.Logger.Error(err)
16a4ad70
JH
880 }
881
e00ff8fe
JH
882 if err := file.Close(); err != nil {
883 return err
884 }
67db911d 885
df1ade54 886 if err := s.FS.Rename(fullPath+".incomplete", fullPath); err != nil {
16a4ad70 887 return err
6988a057 888 }
85767504 889
df1ade54 890 rLogger.Infow("File upload complete", "dstFile", fullPath)
6988a057
JH
891 case FolderDownload:
892 // Folder Download flow:
df2735b2 893 // 1. Get filePath from the transfer
6988a057 894 // 2. Iterate over files
7cd900d6
JH
895 // 3. For each fileWrapper:
896 // Send fileWrapper header to client
6988a057
JH
897 // The client can reply in 3 ways:
898 //
7cd900d6
JH
899 // 1. If type is an odd number (unknown type?), or fileWrapper download for the current fileWrapper is completed:
900 // client sends []byte{0x00, 0x03} to tell the server to continue to the next fileWrapper
6988a057 901 //
7cd900d6 902 // 2. If download of a fileWrapper is to be resumed:
6988a057
JH
903 // client sends:
904 // []byte{0x00, 0x02} // download folder action
905 // [2]byte // Resume data size
7cd900d6 906 // []byte fileWrapper resume data (see myField_FileResumeData)
6988a057 907 //
7cd900d6 908 // 3. Otherwise, download of the fileWrapper is requested and client sends []byte{0x00, 0x01}
6988a057
JH
909 //
910 // When download is requested (case 2 or 3), server replies with:
7cd900d6 911 // [4]byte - fileWrapper size
6988a057
JH
912 // []byte - Flattened File Object
913 //
7cd900d6 914 // After every fileWrapper download, client could request next fileWrapper with:
6988a057
JH
915 // []byte{0x00, 0x03}
916 //
917 // This notifies the server to send the next item header
918
df1ade54 919 basePathLen := len(fullPath)
6988a057 920
df1ade54 921 rLogger.Infow("Start folder download", "path", fullPath)
6988a057 922
85767504 923 nextAction := make([]byte, 2)
7cd900d6 924 if _, err := io.ReadFull(rwc, nextAction); err != nil {
85767504
JH
925 return err
926 }
6988a057
JH
927
928 i := 0
df1ade54 929 err = filepath.Walk(fullPath+"/", func(path string, info os.FileInfo, err error) error {
23411fc2 930 s.Stats.DownloadCounter += 1
7cd900d6 931 i += 1
23411fc2 932
85767504
JH
933 if err != nil {
934 return err
935 }
7cd900d6
JH
936
937 // skip dot files
938 if strings.HasPrefix(info.Name(), ".") {
939 return nil
940 }
941
942 hlFile, err := newFileWrapper(s.FS, path, 0)
943 if err != nil {
944 return err
945 }
946
85767504 947 subPath := path[basePathLen+1:]
df1ade54 948 rLogger.Debugw("Sending fileheader", "i", i, "path", path, "fullFilePath", fullPath, "subPath", subPath, "IsDir", info.IsDir())
6988a057 949
6988a057
JH
950 if i == 1 {
951 return nil
952 }
953
85767504
JH
954 fileHeader := NewFileHeader(subPath, info.IsDir())
955
7cd900d6
JH
956 // Send the fileWrapper header to client
957 if _, err := rwc.Write(fileHeader.Payload()); err != nil {
6988a057
JH
958 s.Logger.Errorf("error sending file header: %v", err)
959 return err
960 }
961
962 // Read the client's Next Action request
7cd900d6 963 if _, err := io.ReadFull(rwc, nextAction); err != nil {
6988a057
JH
964 return err
965 }
966
df1ade54 967 rLogger.Debugw("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2]))
6988a057 968
16a4ad70
JH
969 var dataOffset int64
970
971 switch nextAction[1] {
972 case dlFldrActionResumeFile:
16a4ad70 973 // get size of resumeData
7cd900d6
JH
974 resumeDataByteLen := make([]byte, 2)
975 if _, err := io.ReadFull(rwc, resumeDataByteLen); err != nil {
16a4ad70
JH
976 return err
977 }
978
7cd900d6 979 resumeDataLen := binary.BigEndian.Uint16(resumeDataByteLen)
16a4ad70 980 resumeDataBytes := make([]byte, resumeDataLen)
7cd900d6 981 if _, err := io.ReadFull(rwc, resumeDataBytes); err != nil {
16a4ad70
JH
982 return err
983 }
984
7cd900d6 985 var frd FileResumeData
16a4ad70
JH
986 if err := frd.UnmarshalBinary(resumeDataBytes); err != nil {
987 return err
988 }
989 dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:]))
990 case dlFldrActionNextFile:
991 // client asked to skip this file
992 return nil
993 }
994
6988a057
JH
995 if info.IsDir() {
996 return nil
997 }
998
df1ade54 999 rLogger.Infow("File download started",
6988a057 1000 "fileName", info.Name(),
7cd900d6 1001 "TransferSize", fmt.Sprintf("%x", hlFile.ffo.TransferSize(dataOffset)),
6988a057
JH
1002 )
1003
1004 // Send file size to client
7cd900d6 1005 if _, err := rwc.Write(hlFile.ffo.TransferSize(dataOffset)); err != nil {
6988a057
JH
1006 s.Logger.Error(err)
1007 return err
1008 }
1009
85767504 1010 // Send ffo bytes to client
7cd900d6 1011 if _, err := rwc.Write(hlFile.ffo.BinaryMarshal()); err != nil {
6988a057
JH
1012 s.Logger.Error(err)
1013 return err
1014 }
1015
b196a50a 1016 file, err := s.FS.Open(path)
6988a057
JH
1017 if err != nil {
1018 return err
1019 }
1020
7cd900d6 1021 // wr := bufio.NewWriterSize(rwc, 1460)
df1ade54 1022 if _, err = io.Copy(rwc, io.TeeReader(file, fileTransfer.bytesSentCounter)); err != nil {
7cd900d6
JH
1023 return err
1024 }
1025
1026 if nextAction[1] != 2 && hlFile.ffo.FlatFileHeader.ForkCount[1] == 3 {
1027 err = binary.Write(rwc, binary.BigEndian, hlFile.rsrcForkHeader())
16a4ad70 1028 if err != nil {
7cd900d6 1029 return err
16a4ad70 1030 }
16a4ad70 1031
7cd900d6
JH
1032 rFile, err := hlFile.rsrcForkFile()
1033 if err != nil {
1034 return err
1035 }
16a4ad70 1036
df1ade54 1037 if _, err = io.Copy(rwc, io.TeeReader(rFile, fileTransfer.bytesSentCounter)); err != nil {
16a4ad70
JH
1038 return err
1039 }
85767504 1040 }
6988a057 1041
16a4ad70 1042 // Read the client's Next Action request. This is always 3, I think?
7cd900d6 1043 if _, err := io.ReadFull(rwc, nextAction); err != nil {
85767504 1044 return err
6988a057 1045 }
85767504 1046
16a4ad70 1047 return nil
6988a057
JH
1048 })
1049
67db911d
JH
1050 if err != nil {
1051 return err
1052 }
1053
6988a057 1054 case FolderUpload:
df1ade54 1055 rLogger.Infow(
6988a057 1056 "Folder upload started",
df1ade54
JH
1057 "dstPath", fullPath,
1058 "TransferSize", binary.BigEndian.Uint32(fileTransfer.TransferSize),
6988a057
JH
1059 "FolderItemCount", fileTransfer.FolderItemCount,
1060 )
1061
1062 // Check if the target folder exists. If not, create it.
df1ade54
JH
1063 if _, err := s.FS.Stat(fullPath); os.IsNotExist(err) {
1064 if err := s.FS.Mkdir(fullPath, 0777); err != nil {
16a4ad70 1065 return err
6988a057
JH
1066 }
1067 }
1068
6988a057 1069 // Begin the folder upload flow by sending the "next file action" to client
7cd900d6 1070 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
6988a057
JH
1071 return err
1072 }
1073
1074 fileSize := make([]byte, 4)
16a4ad70
JH
1075
1076 for i := 0; i < fileTransfer.ItemCount(); i++ {
ba29c43b
JH
1077 s.Stats.UploadCounter += 1
1078
1079 var fu folderUpload
7cd900d6 1080 if _, err := io.ReadFull(rwc, fu.DataSize[:]); err != nil {
ba29c43b
JH
1081 return err
1082 }
7cd900d6 1083 if _, err := io.ReadFull(rwc, fu.IsFolder[:]); err != nil {
ba29c43b
JH
1084 return err
1085 }
7cd900d6 1086 if _, err := io.ReadFull(rwc, fu.PathItemCount[:]); err != nil {
ba29c43b
JH
1087 return err
1088 }
ba29c43b 1089
7cd900d6
JH
1090 fu.FileNamePath = make([]byte, binary.BigEndian.Uint16(fu.DataSize[:])-4) // -4 to subtract the path separator bytes
1091
1092 if _, err := io.ReadFull(rwc, fu.FileNamePath); err != nil {
6988a057
JH
1093 return err
1094 }
6988a057 1095
df1ade54 1096 rLogger.Infow(
6988a057 1097 "Folder upload continued",
6988a057
JH
1098 "FormattedPath", fu.FormattedPath(),
1099 "IsFolder", fmt.Sprintf("%x", fu.IsFolder),
c5d9af5a 1100 "PathItemCount", binary.BigEndian.Uint16(fu.PathItemCount[:]),
6988a057
JH
1101 )
1102
c5d9af5a 1103 if fu.IsFolder == [2]byte{0, 1} {
df1ade54
JH
1104 if _, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath())); os.IsNotExist(err) {
1105 if err := os.Mkdir(filepath.Join(fullPath, fu.FormattedPath()), 0777); err != nil {
16a4ad70 1106 return err
6988a057
JH
1107 }
1108 }
1109
1110 // Tell client to send next file
7cd900d6 1111 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
6988a057
JH
1112 return err
1113 }
1114 } else {
16a4ad70
JH
1115 nextAction := dlFldrActionSendFile
1116
1117 // Check if we have the full file already. If so, send dlFldrAction_NextFile to client to skip.
df1ade54 1118 _, err = os.Stat(filepath.Join(fullPath, fu.FormattedPath()))
16a4ad70 1119 if err != nil && !errors.Is(err, fs.ErrNotExist) {
6988a057
JH
1120 return err
1121 }
16a4ad70
JH
1122 if err == nil {
1123 nextAction = dlFldrActionNextFile
1124 }
6988a057 1125
16a4ad70 1126 // Check if we have a partial file already. If so, send dlFldrAction_ResumeFile to client to resume upload.
df1ade54 1127 incompleteFile, err := os.Stat(filepath.Join(fullPath, fu.FormattedPath()+incompleteFileSuffix))
16a4ad70 1128 if err != nil && !errors.Is(err, fs.ErrNotExist) {
85767504 1129 return err
6988a057 1130 }
16a4ad70
JH
1131 if err == nil {
1132 nextAction = dlFldrActionResumeFile
1133 }
6988a057 1134
7cd900d6 1135 if _, err := rwc.Write([]byte{0, uint8(nextAction)}); err != nil {
85767504
JH
1136 return err
1137 }
1138
16a4ad70
JH
1139 switch nextAction {
1140 case dlFldrActionNextFile:
1141 continue
1142 case dlFldrActionResumeFile:
1143 offset := make([]byte, 4)
7cd900d6 1144 binary.BigEndian.PutUint32(offset, uint32(incompleteFile.Size()))
16a4ad70 1145
df1ade54 1146 file, err := os.OpenFile(fullPath+"/"+fu.FormattedPath()+incompleteFileSuffix, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
16a4ad70
JH
1147 if err != nil {
1148 return err
1149 }
1150
7cd900d6 1151 fileResumeData := NewFileResumeData([]ForkInfoList{*NewForkInfoList(offset)})
16a4ad70
JH
1152
1153 b, _ := fileResumeData.BinaryMarshal()
1154
1155 bs := make([]byte, 2)
1156 binary.BigEndian.PutUint16(bs, uint16(len(b)))
1157
7cd900d6 1158 if _, err := rwc.Write(append(bs, b...)); err != nil {
16a4ad70
JH
1159 return err
1160 }
1161
7cd900d6 1162 if _, err := io.ReadFull(rwc, fileSize); err != nil {
16a4ad70
JH
1163 return err
1164 }
1165
df1ade54 1166 if err := receiveFile(rwc, file, ioutil.Discard, ioutil.Discard, fileTransfer.bytesSentCounter); err != nil {
16a4ad70
JH
1167 s.Logger.Error(err)
1168 }
1169
df1ade54 1170 err = os.Rename(fullPath+"/"+fu.FormattedPath()+".incomplete", fullPath+"/"+fu.FormattedPath())
16a4ad70
JH
1171 if err != nil {
1172 return err
1173 }
1174
1175 case dlFldrActionSendFile:
7cd900d6 1176 if _, err := io.ReadFull(rwc, fileSize); err != nil {
16a4ad70
JH
1177 return err
1178 }
1179
df1ade54 1180 filePath := filepath.Join(fullPath, fu.FormattedPath())
16a4ad70 1181
7cd900d6 1182 hlFile, err := newFileWrapper(s.FS, filePath, 0)
16a4ad70
JH
1183 if err != nil {
1184 return err
1185 }
1186
df1ade54 1187 rLogger.Infow("Starting file transfer", "path", filePath, "fileNum", i+1, "fileSize", binary.BigEndian.Uint32(fileSize))
7cd900d6
JH
1188
1189 incWriter, err := hlFile.incFileWriter()
1190 if err != nil {
1191 return err
1192 }
1193
1194 rForkWriter := io.Discard
1195 iForkWriter := io.Discard
1196 if s.Config.PreserveResourceForks {
1197 iForkWriter, err = hlFile.infoForkWriter()
1198 if err != nil {
1199 return err
1200 }
1201
1202 rForkWriter, err = hlFile.rsrcForkWriter()
1203 if err != nil {
1204 return err
1205 }
16a4ad70 1206 }
df1ade54 1207 if err := receiveFile(rwc, incWriter, rForkWriter, iForkWriter, fileTransfer.bytesSentCounter); err != nil {
7cd900d6
JH
1208 return err
1209 }
df1ade54 1210
16a4ad70
JH
1211 if err := os.Rename(filePath+".incomplete", filePath); err != nil {
1212 return err
1213 }
6988a057
JH
1214 }
1215
7cd900d6
JH
1216 // Tell client to send next fileWrapper
1217 if _, err := rwc.Write([]byte{0, dlFldrActionNextFile}); err != nil {
6988a057
JH
1218 return err
1219 }
6988a057
JH
1220 }
1221 }
df1ade54 1222 rLogger.Infof("Folder upload complete")
6988a057
JH
1223 }
1224
1225 return nil
1226}