]>
Commit | Line | Data |
---|---|---|
6988a057 JH |
1 | package hotline |
2 | ||
3 | import ( | |
6988a057 JH |
4 | "context" |
5 | "encoding/binary" | |
6 | "errors" | |
7 | "fmt" | |
8 | "go.uber.org/zap" | |
9 | "io" | |
16a4ad70 | 10 | "io/fs" |
6988a057 | 11 | "io/ioutil" |
6988a057 JH |
12 | "math/big" |
13 | "math/rand" | |
14 | "net" | |
15 | "os" | |
16 | "path" | |
17 | "path/filepath" | |
18 | "runtime/debug" | |
19 | "sort" | |
20 | "strings" | |
21 | "sync" | |
22 | "time" | |
23 | ||
0197c3f5 | 24 | "gopkg.in/yaml.v3" |
6988a057 JH |
25 | ) |
26 | ||
27 | const ( | |
28 | userIdleSeconds = 300 // time in seconds before an inactive user is marked idle | |
29 | idleCheckInterval = 10 // time in seconds to check for idle users | |
30 | trackerUpdateFrequency = 300 // time in seconds between tracker re-registration | |
31 | ) | |
32 | ||
33 | type Server struct { | |
6988a057 JH |
34 | Port int |
35 | Accounts map[string]*Account | |
36 | Agreement []byte | |
37 | Clients map[uint16]*ClientConn | |
38 | FlatNews []byte | |
39 | ThreadedNews *ThreadedNews | |
40 | FileTransfers map[uint32]*FileTransfer | |
41 | Config *Config | |
42 | ConfigDir string | |
43 | Logger *zap.SugaredLogger | |
44 | PrivateChats map[uint32]*PrivateChat | |
45 | NextGuestID *uint16 | |
46 | TrackerPassID []byte | |
47 | Stats *Stats | |
48 | ||
49 | APIListener net.Listener | |
50 | FileListener net.Listener | |
51 | ||
aebc4d36 JH |
52 | // newsReader io.Reader |
53 | // newsWriter io.WriteCloser | |
6988a057 JH |
54 | |
55 | outbox chan Transaction | |
56 | ||
57 | mux sync.Mutex | |
58 | flatNewsMux sync.Mutex | |
59 | } | |
60 | ||
61 | type PrivateChat struct { | |
62 | Subject string | |
63 | ClientConn map[uint16]*ClientConn | |
64 | } | |
65 | ||
66 | func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFunc) error { | |
67 | s.Logger.Infow("Hotline server started", "version", VERSION) | |
68 | var wg sync.WaitGroup | |
69 | ||
70 | wg.Add(1) | |
71 | go func() { s.Logger.Fatal(s.Serve(ctx, cancelRoot, s.APIListener)) }() | |
72 | ||
73 | wg.Add(1) | |
74 | go func() { s.Logger.Fatal(s.ServeFileTransfers(s.FileListener)) }() | |
75 | ||
76 | wg.Wait() | |
77 | ||
78 | return nil | |
79 | } | |
80 | ||
81 | func (s *Server) APIPort() int { | |
82 | return s.APIListener.Addr().(*net.TCPAddr).Port | |
83 | } | |
84 | ||
85 | func (s *Server) ServeFileTransfers(ln net.Listener) error { | |
86 | s.Logger.Infow("Hotline file transfer server started", "Addr", fmt.Sprintf(":%v", s.Port+1)) | |
87 | ||
88 | for { | |
89 | conn, err := ln.Accept() | |
90 | if err != nil { | |
91 | return err | |
92 | } | |
93 | ||
94 | go func() { | |
85767504 | 95 | if err := s.handleFileTransfer(conn); err != nil { |
6988a057 JH |
96 | s.Logger.Errorw("file transfer error", "reason", err) |
97 | } | |
98 | }() | |
99 | } | |
100 | } | |
101 | ||
102 | func (s *Server) sendTransaction(t Transaction) error { | |
103 | requestNum := binary.BigEndian.Uint16(t.Type) | |
104 | clientID, err := byteToInt(*t.clientID) | |
105 | if err != nil { | |
106 | return err | |
107 | } | |
108 | ||
109 | s.mux.Lock() | |
110 | client := s.Clients[uint16(clientID)] | |
111 | s.mux.Unlock() | |
112 | if client == nil { | |
bd1ce113 | 113 | return fmt.Errorf("invalid client id %v", *t.clientID) |
6988a057 | 114 | } |
72dd37f1 | 115 | userName := string(client.UserName) |
6988a057 JH |
116 | login := client.Account.Login |
117 | ||
118 | handler := TransactionHandlers[requestNum] | |
119 | ||
72dd37f1 JH |
120 | b, err := t.MarshalBinary() |
121 | if err != nil { | |
122 | return err | |
123 | } | |
6988a057 | 124 | var n int |
72dd37f1 | 125 | if n, err = client.Connection.Write(b); err != nil { |
6988a057 JH |
126 | return err |
127 | } | |
128 | s.Logger.Debugw("Sent Transaction", | |
129 | "name", userName, | |
130 | "login", login, | |
131 | "IsReply", t.IsReply, | |
132 | "type", handler.Name, | |
133 | "sentBytes", n, | |
134 | "remoteAddr", client.Connection.RemoteAddr(), | |
135 | ) | |
136 | return nil | |
137 | } | |
138 | ||
139 | func (s *Server) Serve(ctx context.Context, cancelRoot context.CancelFunc, ln net.Listener) error { | |
140 | s.Logger.Infow("Hotline server started", "Addr", fmt.Sprintf(":%v", s.Port)) | |
141 | ||
142 | for { | |
143 | conn, err := ln.Accept() | |
144 | if err != nil { | |
145 | s.Logger.Errorw("error accepting connection", "err", err) | |
146 | } | |
147 | ||
148 | go func() { | |
149 | for { | |
150 | t := <-s.outbox | |
151 | go func() { | |
152 | if err := s.sendTransaction(t); err != nil { | |
153 | s.Logger.Errorw("error sending transaction", "err", err) | |
154 | } | |
155 | }() | |
156 | } | |
157 | }() | |
158 | go func() { | |
159 | if err := s.handleNewConnection(conn); err != nil { | |
160 | if err == io.EOF { | |
161 | s.Logger.Infow("Client disconnected", "RemoteAddr", conn.RemoteAddr()) | |
162 | } else { | |
163 | s.Logger.Errorw("error serving request", "RemoteAddr", conn.RemoteAddr(), "err", err) | |
164 | } | |
165 | } | |
166 | }() | |
167 | } | |
168 | } | |
169 | ||
170 | const ( | |
c7e932c0 | 171 | agreementFile = "Agreement.txt" |
6988a057 JH |
172 | ) |
173 | ||
174 | // NewServer constructs a new Server from a config dir | |
175 | func NewServer(configDir, netInterface string, netPort int, logger *zap.SugaredLogger) (*Server, error) { | |
176 | server := Server{ | |
177 | Port: netPort, | |
178 | Accounts: make(map[string]*Account), | |
179 | Config: new(Config), | |
180 | Clients: make(map[uint16]*ClientConn), | |
181 | FileTransfers: make(map[uint32]*FileTransfer), | |
182 | PrivateChats: make(map[uint32]*PrivateChat), | |
183 | ConfigDir: configDir, | |
184 | Logger: logger, | |
185 | NextGuestID: new(uint16), | |
186 | outbox: make(chan Transaction), | |
187 | Stats: &Stats{StartTime: time.Now()}, | |
188 | ThreadedNews: &ThreadedNews{}, | |
189 | TrackerPassID: make([]byte, 4), | |
190 | } | |
191 | ||
192 | ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", netInterface, netPort)) | |
193 | if err != nil { | |
194 | return nil, err | |
195 | } | |
196 | server.APIListener = ln | |
197 | ||
198 | if netPort != 0 { | |
199 | netPort += 1 | |
200 | } | |
201 | ||
202 | ln2, err := net.Listen("tcp", fmt.Sprintf("%s:%v", netInterface, netPort)) | |
203 | server.FileListener = ln2 | |
204 | if err != nil { | |
205 | return nil, err | |
206 | } | |
207 | ||
208 | // generate a new random passID for tracker registration | |
209 | if _, err := rand.Read(server.TrackerPassID); err != nil { | |
210 | return nil, err | |
211 | } | |
212 | ||
213 | server.Logger.Debugw("Loading Agreement", "path", configDir+agreementFile) | |
214 | if server.Agreement, err = os.ReadFile(configDir + agreementFile); err != nil { | |
215 | return nil, err | |
216 | } | |
217 | ||
218 | if server.FlatNews, err = os.ReadFile(configDir + "MessageBoard.txt"); err != nil { | |
219 | return nil, err | |
220 | } | |
221 | ||
222 | if err := server.loadThreadedNews(configDir + "ThreadedNews.yaml"); err != nil { | |
223 | return nil, err | |
224 | } | |
225 | ||
226 | if err := server.loadConfig(configDir + "config.yaml"); err != nil { | |
227 | return nil, err | |
228 | } | |
229 | ||
230 | if err := server.loadAccounts(configDir + "Users/"); err != nil { | |
231 | return nil, err | |
232 | } | |
233 | ||
234 | server.Config.FileRoot = configDir + "Files/" | |
235 | ||
236 | *server.NextGuestID = 1 | |
237 | ||
238 | if server.Config.EnableTrackerRegistration { | |
239 | go func() { | |
240 | for { | |
241 | tr := TrackerRegistration{ | |
242 | Port: []byte{0x15, 0x7c}, | |
243 | UserCount: server.userCount(), | |
244 | PassID: server.TrackerPassID, | |
245 | Name: server.Config.Name, | |
246 | Description: server.Config.Description, | |
247 | } | |
248 | for _, t := range server.Config.Trackers { | |
249 | server.Logger.Infof("Registering with tracker %v", t) | |
250 | ||
251 | if err := register(t, tr); err != nil { | |
252 | server.Logger.Errorw("unable to register with tracker %v", "error", err) | |
253 | } | |
254 | } | |
255 | ||
256 | time.Sleep(trackerUpdateFrequency * time.Second) | |
257 | } | |
258 | }() | |
259 | } | |
260 | ||
261 | // Start Client Keepalive go routine | |
262 | go server.keepaliveHandler() | |
263 | ||
264 | return &server, nil | |
265 | } | |
266 | ||
267 | func (s *Server) userCount() int { | |
268 | s.mux.Lock() | |
269 | defer s.mux.Unlock() | |
270 | ||
271 | return len(s.Clients) | |
272 | } | |
273 | ||
274 | func (s *Server) keepaliveHandler() { | |
275 | for { | |
276 | time.Sleep(idleCheckInterval * time.Second) | |
277 | s.mux.Lock() | |
278 | ||
279 | for _, c := range s.Clients { | |
61c272e1 JH |
280 | c.IdleTime += idleCheckInterval |
281 | if c.IdleTime > userIdleSeconds && !c.Idle { | |
6988a057 JH |
282 | c.Idle = true |
283 | ||
284 | flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(*c.Flags))) | |
285 | flagBitmap.SetBit(flagBitmap, userFlagAway, 1) | |
286 | binary.BigEndian.PutUint16(*c.Flags, uint16(flagBitmap.Int64())) | |
287 | ||
288 | c.sendAll( | |
289 | tranNotifyChangeUser, | |
290 | NewField(fieldUserID, *c.ID), | |
291 | NewField(fieldUserFlags, *c.Flags), | |
72dd37f1 | 292 | NewField(fieldUserName, c.UserName), |
6988a057 JH |
293 | NewField(fieldUserIconID, *c.Icon), |
294 | ) | |
295 | } | |
296 | } | |
297 | s.mux.Unlock() | |
298 | } | |
299 | } | |
300 | ||
301 | func (s *Server) writeThreadedNews() error { | |
302 | s.mux.Lock() | |
303 | defer s.mux.Unlock() | |
304 | ||
305 | out, err := yaml.Marshal(s.ThreadedNews) | |
306 | if err != nil { | |
307 | return err | |
308 | } | |
309 | err = ioutil.WriteFile( | |
310 | s.ConfigDir+"ThreadedNews.yaml", | |
311 | out, | |
312 | 0666, | |
313 | ) | |
314 | return err | |
315 | } | |
316 | ||
317 | func (s *Server) NewClientConn(conn net.Conn) *ClientConn { | |
318 | s.mux.Lock() | |
319 | defer s.mux.Unlock() | |
320 | ||
321 | clientConn := &ClientConn{ | |
322 | ID: &[]byte{0, 0}, | |
323 | Icon: &[]byte{0, 0}, | |
324 | Flags: &[]byte{0, 0}, | |
72dd37f1 | 325 | UserName: []byte{}, |
6988a057 JH |
326 | Connection: conn, |
327 | Server: s, | |
328 | Version: &[]byte{}, | |
aebc4d36 | 329 | AutoReply: []byte{}, |
6988a057 | 330 | Transfers: make(map[int][]*FileTransfer), |
bd1ce113 | 331 | Agreed: false, |
6988a057 JH |
332 | } |
333 | *s.NextGuestID++ | |
334 | ID := *s.NextGuestID | |
335 | ||
6988a057 JH |
336 | binary.BigEndian.PutUint16(*clientConn.ID, ID) |
337 | s.Clients[ID] = clientConn | |
338 | ||
339 | return clientConn | |
340 | } | |
341 | ||
342 | // NewUser creates a new user account entry in the server map and config file | |
343 | func (s *Server) NewUser(login, name, password string, access []byte) error { | |
344 | s.mux.Lock() | |
345 | defer s.mux.Unlock() | |
346 | ||
347 | account := Account{ | |
348 | Login: login, | |
349 | Name: name, | |
350 | Password: hashAndSalt([]byte(password)), | |
351 | Access: &access, | |
352 | } | |
353 | out, err := yaml.Marshal(&account) | |
354 | if err != nil { | |
355 | return err | |
356 | } | |
357 | s.Accounts[login] = &account | |
358 | ||
481631f6 | 359 | return FS.WriteFile(s.ConfigDir+"Users/"+login+".yaml", out, 0666) |
6988a057 JH |
360 | } |
361 | ||
d2810ae9 JH |
362 | func (s *Server) UpdateUser(login, newLogin, name, password string, access []byte) error { |
363 | s.mux.Lock() | |
364 | defer s.mux.Unlock() | |
365 | ||
366 | fmt.Printf("login: %v, newLogin: %v: ", login, newLogin) | |
367 | ||
368 | // update renames the user login | |
369 | if login != newLogin { | |
370 | err := os.Rename(s.ConfigDir+"Users/"+login+".yaml", s.ConfigDir+"Users/"+newLogin+".yaml") | |
371 | if err != nil { | |
372 | return err | |
373 | } | |
374 | s.Accounts[newLogin] = s.Accounts[login] | |
375 | delete(s.Accounts, login) | |
376 | } | |
377 | ||
378 | account := s.Accounts[newLogin] | |
379 | account.Access = &access | |
380 | account.Name = name | |
381 | account.Password = password | |
382 | ||
383 | out, err := yaml.Marshal(&account) | |
384 | if err != nil { | |
385 | return err | |
386 | } | |
387 | if err := os.WriteFile(s.ConfigDir+"Users/"+newLogin+".yaml", out, 0666); err != nil { | |
388 | return err | |
389 | } | |
390 | ||
391 | return nil | |
392 | } | |
393 | ||
6988a057 JH |
394 | // DeleteUser deletes the user account |
395 | func (s *Server) DeleteUser(login string) error { | |
396 | s.mux.Lock() | |
397 | defer s.mux.Unlock() | |
398 | ||
399 | delete(s.Accounts, login) | |
400 | ||
003a743e | 401 | return FS.Remove(s.ConfigDir + "Users/" + login + ".yaml") |
6988a057 JH |
402 | } |
403 | ||
404 | func (s *Server) connectedUsers() []Field { | |
405 | s.mux.Lock() | |
406 | defer s.mux.Unlock() | |
407 | ||
408 | var connectedUsers []Field | |
c7e932c0 | 409 | for _, c := range sortedClients(s.Clients) { |
aebc4d36 | 410 | if !c.Agreed { |
bd1ce113 JH |
411 | continue |
412 | } | |
6988a057 JH |
413 | user := User{ |
414 | ID: *c.ID, | |
415 | Icon: *c.Icon, | |
416 | Flags: *c.Flags, | |
72dd37f1 | 417 | Name: string(c.UserName), |
6988a057 JH |
418 | } |
419 | connectedUsers = append(connectedUsers, NewField(fieldUsernameWithInfo, user.Payload())) | |
420 | } | |
421 | return connectedUsers | |
422 | } | |
423 | ||
424 | // loadThreadedNews loads the threaded news data from disk | |
425 | func (s *Server) loadThreadedNews(threadedNewsPath string) error { | |
426 | fh, err := os.Open(threadedNewsPath) | |
427 | if err != nil { | |
428 | return err | |
429 | } | |
430 | decoder := yaml.NewDecoder(fh) | |
6988a057 JH |
431 | |
432 | return decoder.Decode(s.ThreadedNews) | |
433 | } | |
434 | ||
435 | // loadAccounts loads account data from disk | |
436 | func (s *Server) loadAccounts(userDir string) error { | |
437 | matches, err := filepath.Glob(path.Join(userDir, "*.yaml")) | |
438 | if err != nil { | |
439 | return err | |
440 | } | |
441 | ||
442 | if len(matches) == 0 { | |
443 | return errors.New("no user accounts found in " + userDir) | |
444 | } | |
445 | ||
446 | for _, file := range matches { | |
d492c46d | 447 | fh, err := FS.Open(file) |
6988a057 JH |
448 | if err != nil { |
449 | return err | |
450 | } | |
451 | ||
452 | account := Account{} | |
453 | decoder := yaml.NewDecoder(fh) | |
6988a057 JH |
454 | if err := decoder.Decode(&account); err != nil { |
455 | return err | |
456 | } | |
457 | ||
458 | s.Accounts[account.Login] = &account | |
459 | } | |
460 | return nil | |
461 | } | |
462 | ||
463 | func (s *Server) loadConfig(path string) error { | |
d492c46d | 464 | fh, err := FS.Open(path) |
6988a057 JH |
465 | if err != nil { |
466 | return err | |
467 | } | |
468 | ||
469 | decoder := yaml.NewDecoder(fh) | |
6988a057 JH |
470 | err = decoder.Decode(s.Config) |
471 | if err != nil { | |
472 | return err | |
473 | } | |
474 | return nil | |
475 | } | |
476 | ||
477 | const ( | |
478 | minTransactionLen = 22 // minimum length of any transaction | |
479 | ) | |
480 | ||
481 | // handleNewConnection takes a new net.Conn and performs the initial login sequence | |
482 | func (s *Server) handleNewConnection(conn net.Conn) error { | |
483 | handshakeBuf := make([]byte, 12) // handshakes are always 12 bytes in length | |
484 | if _, err := conn.Read(handshakeBuf); err != nil { | |
485 | return err | |
486 | } | |
487 | if err := Handshake(conn, handshakeBuf[:12]); err != nil { | |
488 | return err | |
489 | } | |
490 | ||
491 | buf := make([]byte, 1024) | |
492 | readLen, err := conn.Read(buf) | |
493 | if readLen < minTransactionLen { | |
494 | return err | |
495 | } | |
496 | if err != nil { | |
497 | return err | |
498 | } | |
499 | ||
500 | clientLogin, _, err := ReadTransaction(buf[:readLen]) | |
501 | if err != nil { | |
502 | return err | |
503 | } | |
504 | ||
505 | c := s.NewClientConn(conn) | |
506 | defer c.Disconnect() | |
507 | defer func() { | |
508 | if r := recover(); r != nil { | |
509 | fmt.Println("stacktrace from panic: \n" + string(debug.Stack())) | |
510 | c.Server.Logger.Errorw("PANIC", "err", r, "trace", string(debug.Stack())) | |
511 | c.Disconnect() | |
512 | } | |
513 | }() | |
514 | ||
515 | encodedLogin := clientLogin.GetField(fieldUserLogin).Data | |
516 | encodedPassword := clientLogin.GetField(fieldUserPassword).Data | |
517 | *c.Version = clientLogin.GetField(fieldVersion).Data | |
518 | ||
519 | var login string | |
520 | for _, char := range encodedLogin { | |
521 | login += string(rune(255 - uint(char))) | |
522 | } | |
523 | if login == "" { | |
524 | login = GuestAccount | |
525 | } | |
526 | ||
527 | // If authentication fails, send error reply and close connection | |
528 | if !c.Authenticate(login, encodedPassword) { | |
72dd37f1 JH |
529 | t := c.NewErrReply(clientLogin, "Incorrect login.") |
530 | b, err := t.MarshalBinary() | |
531 | if err != nil { | |
532 | return err | |
533 | } | |
534 | if _, err := conn.Write(b); err != nil { | |
6988a057 JH |
535 | return err |
536 | } | |
537 | return fmt.Errorf("incorrect login") | |
538 | } | |
539 | ||
6988a057 | 540 | if clientLogin.GetField(fieldUserName).Data != nil { |
72dd37f1 | 541 | c.UserName = clientLogin.GetField(fieldUserName).Data |
6988a057 JH |
542 | } |
543 | ||
544 | if clientLogin.GetField(fieldUserIconID).Data != nil { | |
545 | *c.Icon = clientLogin.GetField(fieldUserIconID).Data | |
546 | } | |
547 | ||
548 | c.Account = c.Server.Accounts[login] | |
549 | ||
550 | if c.Authorize(accessDisconUser) { | |
551 | *c.Flags = []byte{0, 2} | |
552 | } | |
553 | ||
554 | s.Logger.Infow("Client connection received", "login", login, "version", *c.Version, "RemoteAddr", conn.RemoteAddr().String()) | |
555 | ||
556 | s.outbox <- c.NewReply(clientLogin, | |
557 | NewField(fieldVersion, []byte{0x00, 0xbe}), | |
558 | NewField(fieldCommunityBannerID, []byte{0x00, 0x01}), | |
559 | NewField(fieldServerName, []byte(s.Config.Name)), | |
560 | ) | |
561 | ||
562 | // Send user access privs so client UI knows how to behave | |
563 | c.Server.outbox <- *NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, *c.Account.Access)) | |
564 | ||
565 | // Show agreement to client | |
566 | c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldData, s.Agreement)) | |
567 | ||
bd1ce113 JH |
568 | // assume simplified hotline v1.2.3 login flow that does not require agreement |
569 | if *c.Version == nil { | |
570 | c.Agreed = true | |
003a743e JH |
571 | |
572 | c.notifyOthers( | |
573 | *NewTransaction( | |
574 | tranNotifyChangeUser, nil, | |
575 | NewField(fieldUserName, c.UserName), | |
576 | NewField(fieldUserID, *c.ID), | |
577 | NewField(fieldUserIconID, *c.Icon), | |
578 | NewField(fieldUserFlags, *c.Flags), | |
579 | ), | |
580 | ) | |
6988a057 | 581 | } |
bd1ce113 | 582 | |
6988a057 JH |
583 | c.Server.Stats.LoginCount += 1 |
584 | ||
585 | const readBuffSize = 1024000 // 1KB - TODO: what should this be? | |
6988a057 JH |
586 | tranBuff := make([]byte, 0) |
587 | tReadlen := 0 | |
588 | // Infinite loop where take action on incoming client requests until the connection is closed | |
589 | for { | |
590 | buf = make([]byte, readBuffSize) | |
591 | tranBuff = tranBuff[tReadlen:] | |
592 | ||
593 | readLen, err := c.Connection.Read(buf) | |
594 | if err != nil { | |
595 | return err | |
596 | } | |
597 | tranBuff = append(tranBuff, buf[:readLen]...) | |
598 | ||
599 | // We may have read multiple requests worth of bytes from Connection.Read. readTransactions splits them | |
600 | // into a slice of transactions | |
601 | var transactions []Transaction | |
602 | if transactions, tReadlen, err = readTransactions(tranBuff); err != nil { | |
603 | c.Server.Logger.Errorw("Error handling transaction", "err", err) | |
604 | } | |
605 | ||
606 | // iterate over all of the transactions that were parsed from the byte slice and handle them | |
607 | for _, t := range transactions { | |
608 | if err := c.handleTransaction(&t); err != nil { | |
609 | c.Server.Logger.Errorw("Error handling transaction", "err", err) | |
610 | } | |
611 | } | |
612 | } | |
613 | } | |
614 | ||
6988a057 JH |
615 | // NewTransactionRef generates a random ID for the file transfer. The Hotline client includes this ID |
616 | // in the file transfer request payload, and the file transfer server will use it to map the request | |
617 | // to a transfer | |
618 | func (s *Server) NewTransactionRef() []byte { | |
619 | transactionRef := make([]byte, 4) | |
620 | rand.Read(transactionRef) | |
621 | ||
622 | return transactionRef | |
623 | } | |
624 | ||
625 | func (s *Server) NewPrivateChat(cc *ClientConn) []byte { | |
626 | s.mux.Lock() | |
627 | defer s.mux.Unlock() | |
628 | ||
629 | randID := make([]byte, 4) | |
630 | rand.Read(randID) | |
631 | data := binary.BigEndian.Uint32(randID[:]) | |
632 | ||
633 | s.PrivateChats[data] = &PrivateChat{ | |
634 | Subject: "", | |
635 | ClientConn: make(map[uint16]*ClientConn), | |
636 | } | |
637 | s.PrivateChats[data].ClientConn[cc.uint16ID()] = cc | |
638 | ||
639 | return randID | |
640 | } | |
641 | ||
642 | const dlFldrActionSendFile = 1 | |
643 | const dlFldrActionResumeFile = 2 | |
644 | const dlFldrActionNextFile = 3 | |
645 | ||
85767504 JH |
646 | // handleFileTransfer receives a client net.Conn from the file transfer server, performs the requested transfer type, then closes the connection |
647 | func (s *Server) handleFileTransfer(conn io.ReadWriteCloser) error { | |
648 | defer func() { | |
0a92e50b | 649 | |
85767504 JH |
650 | if err := conn.Close(); err != nil { |
651 | s.Logger.Errorw("error closing connection", "error", err) | |
652 | } | |
653 | }() | |
6988a057 | 654 | |
0a92e50b JH |
655 | defer func() { |
656 | if r := recover(); r != nil { | |
657 | fmt.Println("stacktrace from panic: \n" + string(debug.Stack())) | |
658 | s.Logger.Errorw("PANIC", "err", r, "trace", string(debug.Stack())) | |
659 | } | |
660 | }() | |
661 | ||
2e7c03cf | 662 | txBuf := make([]byte, 16) |
0a92e50b | 663 | if _, err := io.ReadFull(conn, txBuf); err != nil { |
6988a057 JH |
664 | return err |
665 | } | |
666 | ||
df2735b2 | 667 | var t transfer |
0a92e50b | 668 | if _, err := t.Write(txBuf); err != nil { |
6988a057 JH |
669 | return err |
670 | } | |
671 | ||
672 | transferRefNum := binary.BigEndian.Uint32(t.ReferenceNumber[:]) | |
0a92e50b JH |
673 | defer func() { |
674 | s.mux.Lock() | |
675 | delete(s.FileTransfers, transferRefNum) | |
676 | s.mux.Unlock() | |
677 | }() | |
6988a057 | 678 | |
0a92e50b JH |
679 | s.mux.Lock() |
680 | fileTransfer, ok := s.FileTransfers[transferRefNum] | |
681 | s.mux.Unlock() | |
682 | if !ok { | |
683 | return errors.New("invalid transaction ID") | |
684 | } | |
16a4ad70 | 685 | |
6988a057 JH |
686 | switch fileTransfer.Type { |
687 | case FileDownload: | |
92a7e455 JH |
688 | fullFilePath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName) |
689 | if err != nil { | |
690 | return err | |
691 | } | |
6988a057 | 692 | |
16a4ad70 JH |
693 | var dataOffset int64 |
694 | if fileTransfer.fileResumeData != nil { | |
695 | dataOffset = int64(binary.BigEndian.Uint32(fileTransfer.fileResumeData.ForkInfoList[0].DataSize[:])) | |
696 | } | |
697 | ||
698 | ffo, err := NewFlattenedFileObject(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName, dataOffset) | |
6988a057 JH |
699 | if err != nil { |
700 | return err | |
701 | } | |
702 | ||
85767504 | 703 | s.Logger.Infow("File download started", "filePath", fullFilePath, "transactionRef", fileTransfer.ReferenceNumber) |
6988a057 | 704 | |
d1cd6664 JH |
705 | if fileTransfer.options == nil { |
706 | // Start by sending flat file object to client | |
707 | if _, err := conn.Write(ffo.BinaryMarshal()); err != nil { | |
708 | return err | |
709 | } | |
6988a057 JH |
710 | } |
711 | ||
92a7e455 | 712 | file, err := FS.Open(fullFilePath) |
6988a057 JH |
713 | if err != nil { |
714 | return err | |
715 | } | |
716 | ||
717 | sendBuffer := make([]byte, 1048576) | |
16a4ad70 | 718 | var totalSent int64 |
6988a057 JH |
719 | for { |
720 | var bytesRead int | |
16a4ad70 JH |
721 | if bytesRead, err = file.ReadAt(sendBuffer, dataOffset+totalSent); err == io.EOF { |
722 | if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil { | |
723 | return err | |
724 | } | |
6988a057 JH |
725 | break |
726 | } | |
16a4ad70 JH |
727 | if err != nil { |
728 | return err | |
729 | } | |
730 | totalSent += int64(bytesRead) | |
6988a057 JH |
731 | |
732 | fileTransfer.BytesSent += bytesRead | |
733 | ||
6988a057 JH |
734 | if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil { |
735 | return err | |
736 | } | |
737 | } | |
738 | case FileUpload: | |
6988a057 | 739 | destinationFile := s.Config.FileRoot + ReadFilePath(fileTransfer.FilePath) + "/" + string(fileTransfer.FileName) |
16a4ad70 JH |
740 | tmpFile := destinationFile + ".incomplete" |
741 | ||
742 | file, err := effectiveFile(destinationFile) | |
743 | if errors.Is(err, fs.ErrNotExist) { | |
744 | file, err = FS.Create(tmpFile) | |
745 | if err != nil { | |
746 | return err | |
747 | } | |
6988a057 | 748 | } |
16a4ad70 JH |
749 | |
750 | defer func() { _ = file.Close() }() | |
6988a057 | 751 | |
85767504 | 752 | s.Logger.Infow("File upload started", "transactionRef", fileTransfer.ReferenceNumber, "dstFile", destinationFile) |
6988a057 | 753 | |
16a4ad70 JH |
754 | // TODO: replace io.Discard with a real file when ready to implement storing of resource fork data |
755 | if err := receiveFile(conn, file, io.Discard); err != nil { | |
756 | return err | |
757 | } | |
758 | ||
759 | if err := os.Rename(destinationFile+".incomplete", destinationFile); err != nil { | |
760 | return err | |
6988a057 | 761 | } |
85767504 JH |
762 | |
763 | s.Logger.Infow("File upload complete", "transactionRef", fileTransfer.ReferenceNumber, "dstFile", destinationFile) | |
6988a057 JH |
764 | case FolderDownload: |
765 | // Folder Download flow: | |
df2735b2 | 766 | // 1. Get filePath from the transfer |
6988a057 JH |
767 | // 2. Iterate over files |
768 | // 3. For each file: | |
769 | // Send file header to client | |
770 | // The client can reply in 3 ways: | |
771 | // | |
772 | // 1. If type is an odd number (unknown type?), or file download for the current file is completed: | |
773 | // client sends []byte{0x00, 0x03} to tell the server to continue to the next file | |
774 | // | |
775 | // 2. If download of a file is to be resumed: | |
776 | // client sends: | |
777 | // []byte{0x00, 0x02} // download folder action | |
778 | // [2]byte // Resume data size | |
779 | // []byte file resume data (see myField_FileResumeData) | |
780 | // | |
16a4ad70 | 781 | // 3. Otherwise, download of the file is requested and client sends []byte{0x00, 0x01} |
6988a057 JH |
782 | // |
783 | // When download is requested (case 2 or 3), server replies with: | |
784 | // [4]byte - file size | |
785 | // []byte - Flattened File Object | |
786 | // | |
787 | // After every file download, client could request next file with: | |
788 | // []byte{0x00, 0x03} | |
789 | // | |
790 | // This notifies the server to send the next item header | |
791 | ||
92a7e455 JH |
792 | fullFilePath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName) |
793 | if err != nil { | |
794 | return err | |
795 | } | |
6988a057 JH |
796 | |
797 | basePathLen := len(fullFilePath) | |
798 | ||
85767504 | 799 | s.Logger.Infow("Start folder download", "path", fullFilePath, "ReferenceNumber", fileTransfer.ReferenceNumber) |
6988a057 | 800 | |
85767504 JH |
801 | nextAction := make([]byte, 2) |
802 | if _, err := conn.Read(nextAction); err != nil { | |
803 | return err | |
804 | } | |
6988a057 JH |
805 | |
806 | i := 0 | |
85767504 JH |
807 | err = filepath.Walk(fullFilePath+"/", func(path string, info os.FileInfo, err error) error { |
808 | if err != nil { | |
809 | return err | |
810 | } | |
6988a057 | 811 | i += 1 |
85767504 | 812 | subPath := path[basePathLen+1:] |
6988a057 JH |
813 | s.Logger.Infow("Sending fileheader", "i", i, "path", path, "fullFilePath", fullFilePath, "subPath", subPath, "IsDir", info.IsDir()) |
814 | ||
6988a057 JH |
815 | if i == 1 { |
816 | return nil | |
817 | } | |
818 | ||
85767504 JH |
819 | fileHeader := NewFileHeader(subPath, info.IsDir()) |
820 | ||
6988a057 JH |
821 | // Send the file header to client |
822 | if _, err := conn.Write(fileHeader.Payload()); err != nil { | |
823 | s.Logger.Errorf("error sending file header: %v", err) | |
824 | return err | |
825 | } | |
826 | ||
827 | // Read the client's Next Action request | |
85767504 | 828 | if _, err := conn.Read(nextAction); err != nil { |
6988a057 JH |
829 | return err |
830 | } | |
831 | ||
85767504 | 832 | s.Logger.Infow("Client folder download action", "action", fmt.Sprintf("%X", nextAction[0:2])) |
6988a057 | 833 | |
16a4ad70 JH |
834 | var dataOffset int64 |
835 | ||
836 | switch nextAction[1] { | |
837 | case dlFldrActionResumeFile: | |
838 | // client asked to resume this file | |
839 | var frd FileResumeData | |
840 | // get size of resumeData | |
841 | if _, err := conn.Read(nextAction); err != nil { | |
842 | return err | |
843 | } | |
844 | ||
845 | resumeDataLen := binary.BigEndian.Uint16(nextAction) | |
846 | resumeDataBytes := make([]byte, resumeDataLen) | |
847 | if _, err := conn.Read(resumeDataBytes); err != nil { | |
848 | return err | |
849 | } | |
850 | ||
851 | if err := frd.UnmarshalBinary(resumeDataBytes); err != nil { | |
852 | return err | |
853 | } | |
854 | dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:])) | |
855 | case dlFldrActionNextFile: | |
856 | // client asked to skip this file | |
857 | return nil | |
858 | } | |
859 | ||
6988a057 JH |
860 | if info.IsDir() { |
861 | return nil | |
862 | } | |
863 | ||
864 | splitPath := strings.Split(path, "/") | |
6988a057 | 865 | |
16a4ad70 | 866 | ffo, err := NewFlattenedFileObject(strings.Join(splitPath[:len(splitPath)-1], "/"), nil, []byte(info.Name()), dataOffset) |
6988a057 JH |
867 | if err != nil { |
868 | return err | |
869 | } | |
870 | s.Logger.Infow("File download started", | |
871 | "fileName", info.Name(), | |
872 | "transactionRef", fileTransfer.ReferenceNumber, | |
6988a057 JH |
873 | "TransferSize", fmt.Sprintf("%x", ffo.TransferSize()), |
874 | ) | |
875 | ||
876 | // Send file size to client | |
877 | if _, err := conn.Write(ffo.TransferSize()); err != nil { | |
878 | s.Logger.Error(err) | |
879 | return err | |
880 | } | |
881 | ||
85767504 | 882 | // Send ffo bytes to client |
c5d9af5a | 883 | if _, err := conn.Write(ffo.BinaryMarshal()); err != nil { |
6988a057 JH |
884 | s.Logger.Error(err) |
885 | return err | |
886 | } | |
887 | ||
d492c46d | 888 | file, err := FS.Open(path) |
6988a057 JH |
889 | if err != nil { |
890 | return err | |
891 | } | |
892 | ||
16a4ad70 JH |
893 | // // Copy N bytes from file to connection |
894 | // _, err = io.CopyN(conn, file, int64(binary.BigEndian.Uint32(ffo.FlatFileDataForkHeader.DataSize[:]))) | |
895 | // if err != nil { | |
896 | // return err | |
897 | // } | |
898 | // file.Close() | |
899 | sendBuffer := make([]byte, 1048576) | |
900 | var totalSent int64 | |
901 | for { | |
902 | var bytesRead int | |
903 | if bytesRead, err = file.ReadAt(sendBuffer, dataOffset+totalSent); err == io.EOF { | |
904 | if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil { | |
905 | return err | |
906 | } | |
907 | break | |
908 | } | |
909 | if err != nil { | |
910 | panic(err) | |
911 | } | |
912 | totalSent += int64(bytesRead) | |
913 | ||
914 | fileTransfer.BytesSent += bytesRead | |
915 | ||
916 | if _, err := conn.Write(sendBuffer[:bytesRead]); err != nil { | |
917 | return err | |
918 | } | |
85767504 | 919 | } |
6988a057 | 920 | |
85767504 | 921 | // TODO: optionally send resource fork header and resource fork data |
6988a057 | 922 | |
16a4ad70 | 923 | // Read the client's Next Action request. This is always 3, I think? |
85767504 JH |
924 | if _, err := conn.Read(nextAction); err != nil { |
925 | return err | |
6988a057 | 926 | } |
85767504 | 927 | |
16a4ad70 | 928 | return nil |
6988a057 JH |
929 | }) |
930 | ||
931 | case FolderUpload: | |
92a7e455 JH |
932 | dstPath, err := readPath(s.Config.FileRoot, fileTransfer.FilePath, fileTransfer.FileName) |
933 | if err != nil { | |
934 | return err | |
935 | } | |
6988a057 JH |
936 | s.Logger.Infow( |
937 | "Folder upload started", | |
938 | "transactionRef", fileTransfer.ReferenceNumber, | |
6988a057 | 939 | "dstPath", dstPath, |
92a7e455 | 940 | "TransferSize", fmt.Sprintf("%x", fileTransfer.TransferSize), |
6988a057 JH |
941 | "FolderItemCount", fileTransfer.FolderItemCount, |
942 | ) | |
943 | ||
944 | // Check if the target folder exists. If not, create it. | |
92a7e455 | 945 | if _, err := FS.Stat(dstPath); os.IsNotExist(err) { |
92a7e455 | 946 | if err := FS.Mkdir(dstPath, 0777); err != nil { |
16a4ad70 | 947 | return err |
6988a057 JH |
948 | } |
949 | } | |
950 | ||
6988a057 JH |
951 | // Begin the folder upload flow by sending the "next file action" to client |
952 | if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil { | |
953 | return err | |
954 | } | |
955 | ||
956 | fileSize := make([]byte, 4) | |
85767504 | 957 | readBuffer := make([]byte, 1024) |
16a4ad70 JH |
958 | |
959 | for i := 0; i < fileTransfer.ItemCount(); i++ { | |
960 | ||
85767504 JH |
961 | _, err := conn.Read(readBuffer) |
962 | if err != nil { | |
6988a057 JH |
963 | return err |
964 | } | |
965 | fu := readFolderUpload(readBuffer) | |
966 | ||
967 | s.Logger.Infow( | |
968 | "Folder upload continued", | |
969 | "transactionRef", fmt.Sprintf("%x", fileTransfer.ReferenceNumber), | |
6988a057 JH |
970 | "FormattedPath", fu.FormattedPath(), |
971 | "IsFolder", fmt.Sprintf("%x", fu.IsFolder), | |
c5d9af5a | 972 | "PathItemCount", binary.BigEndian.Uint16(fu.PathItemCount[:]), |
6988a057 JH |
973 | ) |
974 | ||
c5d9af5a | 975 | if fu.IsFolder == [2]byte{0, 1} { |
6988a057 | 976 | if _, err := os.Stat(dstPath + "/" + fu.FormattedPath()); os.IsNotExist(err) { |
6988a057 | 977 | if err := os.Mkdir(dstPath+"/"+fu.FormattedPath(), 0777); err != nil { |
16a4ad70 | 978 | return err |
6988a057 JH |
979 | } |
980 | } | |
981 | ||
982 | // Tell client to send next file | |
983 | if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil { | |
6988a057 JH |
984 | return err |
985 | } | |
986 | } else { | |
16a4ad70 JH |
987 | nextAction := dlFldrActionSendFile |
988 | ||
989 | // Check if we have the full file already. If so, send dlFldrAction_NextFile to client to skip. | |
990 | _, err := os.Stat(dstPath + "/" + fu.FormattedPath()) | |
991 | if err != nil && !errors.Is(err, fs.ErrNotExist) { | |
6988a057 JH |
992 | return err |
993 | } | |
16a4ad70 JH |
994 | if err == nil { |
995 | nextAction = dlFldrActionNextFile | |
996 | } | |
6988a057 | 997 | |
16a4ad70 JH |
998 | // Check if we have a partial file already. If so, send dlFldrAction_ResumeFile to client to resume upload. |
999 | inccompleteFile, err := os.Stat(dstPath + "/" + fu.FormattedPath() + incompleteFileSuffix) | |
1000 | if err != nil && !errors.Is(err, fs.ErrNotExist) { | |
85767504 | 1001 | return err |
6988a057 | 1002 | } |
16a4ad70 JH |
1003 | if err == nil { |
1004 | nextAction = dlFldrActionResumeFile | |
1005 | } | |
6988a057 | 1006 | |
16a4ad70 | 1007 | fmt.Printf("Next Action: %v\n", nextAction) |
6988a057 | 1008 | |
16a4ad70 | 1009 | if _, err := conn.Write([]byte{0, uint8(nextAction)}); err != nil { |
85767504 JH |
1010 | return err |
1011 | } | |
1012 | ||
16a4ad70 JH |
1013 | switch nextAction { |
1014 | case dlFldrActionNextFile: | |
1015 | continue | |
1016 | case dlFldrActionResumeFile: | |
1017 | offset := make([]byte, 4) | |
1018 | binary.BigEndian.PutUint32(offset, uint32(inccompleteFile.Size())) | |
1019 | ||
1020 | file, err := os.OpenFile(dstPath+"/"+fu.FormattedPath()+incompleteFileSuffix, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644) | |
1021 | if err != nil { | |
1022 | return err | |
1023 | } | |
1024 | ||
1025 | fileResumeData := NewFileResumeData([]ForkInfoList{ | |
1026 | *NewForkInfoList(offset), | |
1027 | }) | |
1028 | ||
1029 | b, _ := fileResumeData.BinaryMarshal() | |
1030 | ||
1031 | bs := make([]byte, 2) | |
1032 | binary.BigEndian.PutUint16(bs, uint16(len(b))) | |
1033 | ||
1034 | if _, err := conn.Write(append(bs, b...)); err != nil { | |
1035 | return err | |
1036 | } | |
1037 | ||
1038 | if _, err := conn.Read(fileSize); err != nil { | |
1039 | return err | |
1040 | } | |
1041 | ||
1042 | if err := receiveFile(conn, file, ioutil.Discard); err != nil { | |
1043 | s.Logger.Error(err) | |
1044 | } | |
1045 | ||
1046 | err = os.Rename(dstPath+"/"+fu.FormattedPath()+".incomplete", dstPath+"/"+fu.FormattedPath()) | |
1047 | if err != nil { | |
1048 | return err | |
1049 | } | |
1050 | ||
1051 | case dlFldrActionSendFile: | |
1052 | if _, err := conn.Read(fileSize); err != nil { | |
1053 | return err | |
1054 | } | |
1055 | ||
1056 | filePath := dstPath + "/" + fu.FormattedPath() | |
1057 | s.Logger.Infow("Starting file transfer", "path", filePath, "fileNum", i+1, "totalFiles", "zz", "fileSize", binary.BigEndian.Uint32(fileSize)) | |
1058 | ||
1059 | newFile, err := FS.Create(filePath + ".incomplete") | |
1060 | if err != nil { | |
1061 | return err | |
1062 | } | |
1063 | ||
1064 | if err := receiveFile(conn, newFile, ioutil.Discard); err != nil { | |
1065 | s.Logger.Error(err) | |
1066 | } | |
1067 | _ = newFile.Close() | |
1068 | if err := os.Rename(filePath+".incomplete", filePath); err != nil { | |
1069 | return err | |
1070 | } | |
6988a057 JH |
1071 | } |
1072 | ||
1073 | // Tell client to send next file | |
1074 | if _, err := conn.Write([]byte{0, dlFldrActionNextFile}); err != nil { | |
6988a057 JH |
1075 | return err |
1076 | } | |
6988a057 JH |
1077 | } |
1078 | } | |
1079 | s.Logger.Infof("Folder upload complete") | |
1080 | } | |
1081 | ||
1082 | return nil | |
1083 | } | |
1084 | ||
6988a057 JH |
1085 | // sortedClients is a utility function that takes a map of *ClientConn and returns a sorted slice of the values. |
1086 | // The purpose of this is to ensure that the ordering of client connections is deterministic so that test assertions work. | |
1087 | func sortedClients(unsortedClients map[uint16]*ClientConn) (clients []*ClientConn) { | |
1088 | for _, c := range unsortedClients { | |
1089 | clients = append(clients, c) | |
1090 | } | |
1091 | sort.Sort(byClientID(clients)) | |
1092 | return clients | |
1093 | } |