X-Git-Url: https://git.r.bdr.sh/rbdr/mobius/blobdiff_plain/d4c152a4dba0eec7c8ecd13732900909f51b1c97..b51f0536ad15f8a197d41fab60c3b00bd63ee381:/hotline/client_conn.go diff --git a/hotline/client_conn.go b/hotline/client_conn.go index c1ae4e3..48a6947 100644 --- a/hotline/client_conn.go +++ b/hotline/client_conn.go @@ -2,9 +2,14 @@ package hotline import ( "encoding/binary" + "fmt" + "go.uber.org/zap" "golang.org/x/crypto/bcrypt" "io" "math/big" + "sort" + "strings" + "sync" ) type byClientID []*ClientConn @@ -21,49 +26,25 @@ func (s byClientID) Less(i, j int) bool { return s[i].uint16ID() < s[j].uint16ID() } -const template = `Nickname: %s -Name: %s -Account: %s -Address: %s - --------- File Downloads --------- - -%s - -------- Folder Downloads -------- - -None. - ---------- File Uploads ---------- - -None. - --------- Folder Uploads --------- - -None. - -------- Waiting Downloads ------- - -None. - - ` - // ClientConn represents a client connected to a Server type ClientConn struct { Connection io.ReadWriteCloser RemoteAddr string ID *[]byte - Icon *[]byte - Flags *[]byte + Icon []byte + Flags []byte UserName []byte Account *Account IdleTime int Server *Server - Version *[]byte + Version []byte Idle bool AutoReply []byte - Transfers map[int][]*FileTransfer - Agreed bool + + transfersMU sync.Mutex + transfers map[int]map[[4]byte]*FileTransfer + + logger *zap.SugaredLogger } func (cc *ClientConn) sendAll(t int, fields ...Field) { @@ -72,7 +53,7 @@ func (cc *ClientConn) sendAll(t int, fields ...Field) { } } -func (cc *ClientConn) handleTransaction(transaction *Transaction) error { +func (cc *ClientConn) handleTransaction(transaction Transaction) error { requestNum := binary.BigEndian.Uint16(transaction.Type) if handler, ok := TransactionHandlers[requestNum]; ok { for _, reqField := range handler.RequiredFields { @@ -80,30 +61,25 @@ func (cc *ClientConn) handleTransaction(transaction *Transaction) error { // Validate that required field is present if field.ID == nil { - cc.Server.Logger.Errorw( + cc.logger.Errorw( "Missing required field", - "Account", cc.Account.Login, "UserName", string(cc.UserName), "RequestType", handler.Name, "FieldID", reqField.ID, + "RequestType", handler.Name, "FieldID", reqField.ID, ) return nil } if len(field.Data) < reqField.minLen { - cc.Server.Logger.Infow( + cc.logger.Infow( "Field does not meet minLen", - "Account", cc.Account.Login, "UserName", string(cc.UserName), "RequestType", handler.Name, "FieldID", reqField.ID, + "RequestType", handler.Name, "FieldID", reqField.ID, ) return nil } } - cc.Server.Logger.Infow( - "Received Transaction", - "login", cc.Account.Login, - "name", string(cc.UserName), - "RequestType", handler.Name, - ) + cc.logger.Debugw("Received Transaction", "RequestType", handler.Name) - transactions, err := handler.Handler(cc, transaction) + transactions, err := handler.Handler(cc, &transaction) if err != nil { return err } @@ -111,33 +87,31 @@ func (cc *ClientConn) handleTransaction(transaction *Transaction) error { cc.Server.outbox <- t } } else { - cc.Server.Logger.Errorw( - "Unimplemented transaction type received", - "UserName", string(cc.UserName), "RequestID", requestNum, - ) + cc.logger.Errorw( + "Unimplemented transaction type received", "RequestID", requestNum) } cc.Server.mux.Lock() defer cc.Server.mux.Unlock() - if requestNum != tranKeepAlive { + if requestNum != TranKeepAlive { // reset the user idle timer cc.IdleTime = 0 // if user was previously idle, mark as not idle and notify other connected clients that // the user is no longer away if cc.Idle { - flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(*cc.Flags))) - flagBitmap.SetBit(flagBitmap, userFlagAway, 0) - binary.BigEndian.PutUint16(*cc.Flags, uint16(flagBitmap.Int64())) + flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(cc.Flags))) + flagBitmap.SetBit(flagBitmap, UserFlagAway, 0) + binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64())) cc.Idle = false cc.sendAll( - tranNotifyChangeUser, - NewField(fieldUserID, *cc.ID), - NewField(fieldUserFlags, *cc.Flags), - NewField(fieldUserName, cc.UserName), - NewField(fieldUserIconID, *cc.Icon), + TranNotifyChangeUser, + NewField(FieldUserID, *cc.ID), + NewField(FieldUserFlags, cc.Flags), + NewField(FieldUserName, cc.UserName), + NewField(FieldUserIconID, cc.Icon), ) } } @@ -160,13 +134,7 @@ func (cc *ClientConn) uint16ID() uint16 { // Authorize checks if the user account has the specified permission func (cc *ClientConn) Authorize(access int) bool { - if access == 0 { - return true - } - - accessBitmap := big.NewInt(int64(binary.BigEndian.Uint64(*cc.Account.Access))) - - return accessBitmap.Bit(63-access) == 1 + return cc.Account.Access.IsSet(access) } // Disconnect notifies other clients that a client has disconnected @@ -176,7 +144,9 @@ func (cc *ClientConn) Disconnect() { delete(cc.Server.Clients, binary.BigEndian.Uint16(*cc.ID)) - cc.notifyOthers(*NewTransaction(tranNotifyDeleteUser, nil, NewField(fieldUserID, *cc.ID))) + for _, t := range cc.notifyOthers(*NewTransaction(TranNotifyDeleteUser, nil, NewField(FieldUserID, *cc.ID))) { + cc.Server.outbox <- t + } if err := cc.Connection.Close(); err != nil { cc.Server.Logger.Errorw("error closing client connection", "RemoteAddr", cc.RemoteAddr) @@ -184,13 +154,14 @@ func (cc *ClientConn) Disconnect() { } // notifyOthers sends transaction t to other clients connected to the server -func (cc *ClientConn) notifyOthers(t Transaction) { +func (cc *ClientConn) notifyOthers(t Transaction) (trans []Transaction) { for _, c := range sortedClients(cc.Server.Clients) { - if c.ID != cc.ID && c.Agreed { + if c.ID != cc.ID { t.clientID = c.ID - cc.Server.outbox <- t + trans = append(trans, t) } } + return trans } // NewReply returns a reply Transaction with fields for the ClientConn @@ -198,7 +169,7 @@ func (cc *ClientConn) NewReply(t *Transaction, fields ...Field) Transaction { reply := Transaction{ Flags: 0x00, IsReply: 0x01, - Type: t.Type, + Type: []byte{0x00, 0x00}, ID: t.ID, clientID: cc.ID, ErrorCode: []byte{0, 0, 0, 0}, @@ -218,7 +189,70 @@ func (cc *ClientConn) NewErrReply(t *Transaction, errMsg string) Transaction { ID: t.ID, ErrorCode: []byte{0, 0, 0, 1}, Fields: []Field{ - NewField(fieldError, []byte(errMsg)), + NewField(FieldError, []byte(errMsg)), }, } } + +// sortedClients is a utility function that takes a map of *ClientConn and returns a sorted slice of the values. +// The purpose of this is to ensure that the ordering of client connections is deterministic so that test assertions work. +func sortedClients(unsortedClients map[uint16]*ClientConn) (clients []*ClientConn) { + for _, c := range unsortedClients { + clients = append(clients, c) + } + sort.Sort(byClientID(clients)) + return clients +} + +const userInfoTemplate = `Nickname: %s +Name: %s +Account: %s +Address: %s + +-------- File Downloads --------- + +%s +------- Folder Downloads -------- + +%s +--------- File Uploads ---------- + +%s +-------- Folder Uploads --------- + +%s +------- Waiting Downloads ------- + +%s +` + +func formatDownloadList(fts map[[4]byte]*FileTransfer) (s string) { + if len(fts) == 0 { + return "None.\n" + } + + for _, dl := range fts { + s += dl.String() + } + + return s +} + +func (cc *ClientConn) String() string { + cc.transfersMU.Lock() + defer cc.transfersMU.Unlock() + template := fmt.Sprintf( + userInfoTemplate, + cc.UserName, + cc.Account.Name, + cc.Account.Login, + cc.RemoteAddr, + formatDownloadList(cc.transfers[FileDownload]), + formatDownloadList(cc.transfers[FolderDownload]), + formatDownloadList(cc.transfers[FileUpload]), + formatDownloadList(cc.transfers[FolderUpload]), + "None.\n", + ) + + return strings.ReplaceAll(template, "\n", "\r") +}