package hotline
import (
+ "cmp"
"encoding/binary"
"fmt"
- "go.uber.org/zap"
"golang.org/x/crypto/bcrypt"
"io"
- "math/big"
- "sort"
+ "log/slog"
"strings"
"sync"
)
-type byClientID []*ClientConn
+var clientConnSortFunc = func(a, b *ClientConn) int {
+ return cmp.Compare(
+ binary.BigEndian.Uint16(a.ID[:]),
+ binary.BigEndian.Uint16(b.ID[:]),
+ )
+}
+
+// ClientConn represents a client connected to a Server
+type ClientConn struct {
+ Connection io.ReadWriteCloser
+ RemoteAddr string
+ ID ClientID
+ Icon []byte // TODO: make fixed size of 2
+ Version []byte // TODO: make fixed size of 2
+
+ flagsMU sync.Mutex // TODO: move into UserFlags struct
+ Flags UserFlags
+
+ UserName []byte
+ Account *Account
+ IdleTime int
+ Server *Server // TODO: consider adding methods to interact with server
+ AutoReply []byte
+
+ ClientFileTransferMgr ClientFileTransferMgr
-func (s byClientID) Len() int {
- return len(s)
+ logger *slog.Logger
+
+ mu sync.RWMutex
}
-func (s byClientID) Swap(i, j int) {
- s[i], s[j] = s[j], s[i]
+type ClientFileTransferMgr struct {
+ transfers map[FileTransferType]map[FileTransferID]*FileTransfer
+
+ mu sync.RWMutex
}
-func (s byClientID) Less(i, j int) bool {
- return s[i].uint16ID() < s[j].uint16ID()
+func NewClientFileTransferMgr() ClientFileTransferMgr {
+ return ClientFileTransferMgr{
+ transfers: map[FileTransferType]map[FileTransferID]*FileTransfer{
+ FileDownload: {},
+ FileUpload: {},
+ FolderDownload: {},
+ FolderUpload: {},
+ BannerDownload: {},
+ },
+ }
}
-// ClientConn represents a client connected to a Server
-type ClientConn struct {
- Connection io.ReadWriteCloser
- RemoteAddr string
- ID *[]byte
- Icon []byte
- Flags []byte
- UserName []byte
- Account *Account
- IdleTime int
- Server *Server
- Version []byte
- Idle bool
- AutoReply []byte
-
- transfersMU sync.Mutex
- transfers map[int]map[[4]byte]*FileTransfer
-
- logger *zap.SugaredLogger
+func (cftm *ClientFileTransferMgr) Add(ftType FileTransferType, ft *FileTransfer) {
+ cftm.mu.Lock()
+ defer cftm.mu.Unlock()
+
+ cftm.transfers[ftType][ft.refNum] = ft
}
-func (cc *ClientConn) sendAll(t int, fields ...Field) {
- for _, c := range sortedClients(cc.Server.Clients) {
- cc.Server.outbox <- *NewTransaction(t, c.ID, fields...)
+func (cftm *ClientFileTransferMgr) Get(ftType FileTransferType) []FileTransfer {
+ cftm.mu.Lock()
+ defer cftm.mu.Unlock()
+
+ fts := cftm.transfers[ftType]
+
+ var transfers []FileTransfer
+ for _, ft := range fts {
+ transfers = append(transfers, *ft)
}
+
+ return transfers
}
-func (cc *ClientConn) handleTransaction(transaction Transaction) error {
- requestNum := binary.BigEndian.Uint16(transaction.Type)
- if handler, ok := TransactionHandlers[requestNum]; ok {
- for _, reqField := range handler.RequiredFields {
- field := transaction.GetField(reqField.ID)
-
- // Validate that required field is present
- if field.ID == nil {
- cc.logger.Errorw(
- "Missing required field",
- "RequestType", handler.Name, "FieldID", reqField.ID,
- )
- return nil
- }
-
- if len(field.Data) < reqField.minLen {
- cc.logger.Infow(
- "Field does not meet minLen",
- "RequestType", handler.Name, "FieldID", reqField.ID,
- )
- return nil
- }
- }
+func (cftm *ClientFileTransferMgr) Delete(ftType FileTransferType, id FileTransferID) {
+ cftm.mu.Lock()
+ defer cftm.mu.Unlock()
+
+ delete(cftm.transfers[ftType], id)
+}
- cc.logger.Debugw("Received Transaction", "RequestType", handler.Name)
+func (cc *ClientConn) SendAll(t [2]byte, fields ...Field) {
+ for _, c := range cc.Server.ClientMgr.List() {
+ cc.Server.outbox <- NewTransaction(t, c.ID, fields...)
+ }
+}
- transactions, err := handler.Handler(cc, &transaction)
- if err != nil {
- return err
+func (cc *ClientConn) handleTransaction(transaction Transaction) {
+ if handler, ok := TransactionHandlers[transaction.Type]; ok {
+ if transaction.Type != TranKeepAlive {
+ cc.logger.Info(tranTypeNames[transaction.Type])
}
- for _, t := range transactions {
+
+ for _, t := range handler(cc, &transaction) {
cc.Server.outbox <- t
}
- } else {
- cc.logger.Errorw(
- "Unimplemented transaction type received", "RequestID", requestNum)
}
- cc.Server.mux.Lock()
- defer cc.Server.mux.Unlock()
+ if transaction.Type != TranKeepAlive {
+ cc.mu.Lock()
+ defer cc.mu.Unlock()
- 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()))
- cc.Idle = false
+ if cc.Flags.IsSet(UserFlagAway) {
+ cc.Flags.Set(UserFlagAway, 0)
- cc.sendAll(
+ cc.SendAll(
TranNotifyChangeUser,
- NewField(FieldUserID, *cc.ID),
- NewField(FieldUserFlags, cc.Flags),
+ NewField(FieldUserID, cc.ID[:]),
+ NewField(FieldUserFlags, cc.Flags[:]),
NewField(FieldUserName, cc.UserName),
NewField(FieldUserIconID, cc.Icon),
)
}
}
-
- return nil
}
func (cc *ClientConn) Authenticate(login string, password []byte) bool {
- if account, ok := cc.Server.Accounts[login]; ok {
+ if account := cc.Server.AccountManager.Get(login); account != nil {
return bcrypt.CompareHashAndPassword([]byte(account.Password), password) == nil
}
return false
}
-func (cc *ClientConn) uint16ID() uint16 {
- id, _ := byteToInt(*cc.ID)
- return uint16(id)
-}
-
// Authorize checks if the user account has the specified permission
func (cc *ClientConn) Authorize(access int) bool {
+ if cc.Account == nil {
+ return false
+ }
return cc.Account.Access.IsSet(access)
}
// Disconnect notifies other clients that a client has disconnected
func (cc *ClientConn) Disconnect() {
- cc.Server.mux.Lock()
- defer cc.Server.mux.Unlock()
-
- delete(cc.Server.Clients, binary.BigEndian.Uint16(*cc.ID))
+ cc.Server.ClientMgr.Delete(cc.ID)
- for _, t := range cc.notifyOthers(*NewTransaction(TranNotifyDeleteUser, nil, NewField(FieldUserID, *cc.ID))) {
+ for _, t := range cc.NotifyOthers(NewTransaction(TranNotifyDeleteUser, [2]byte{}, 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)
+ cc.Server.Logger.Error("error closing client connection", "RemoteAddr", cc.RemoteAddr)
}
}
-// notifyOthers sends transaction t to other clients connected to the server
-func (cc *ClientConn) notifyOthers(t Transaction) (trans []Transaction) {
- for _, c := range sortedClients(cc.Server.Clients) {
+// NotifyOthers sends transaction t to other clients connected to the server
+func (cc *ClientConn) NotifyOthers(t Transaction) (trans []Transaction) {
+ for _, c := range cc.Server.ClientMgr.List() {
if c.ID != cc.ID {
t.clientID = c.ID
trans = append(trans, t)
// NewReply returns a reply Transaction with fields for the ClientConn
func (cc *ClientConn) NewReply(t *Transaction, fields ...Field) Transaction {
- reply := Transaction{
- Flags: 0x00,
- IsReply: 0x01,
- Type: []byte{0x00, 0x00},
- ID: t.ID,
- clientID: cc.ID,
- ErrorCode: []byte{0, 0, 0, 0},
- Fields: fields,
+ return Transaction{
+ IsReply: 1,
+ ID: t.ID,
+ clientID: cc.ID,
+ Fields: fields,
}
-
- return reply
}
// NewErrReply returns an error reply Transaction with errMsg
-func (cc *ClientConn) NewErrReply(t *Transaction, errMsg string) Transaction {
- return Transaction{
- clientID: cc.ID,
- Flags: 0x00,
- IsReply: 0x01,
- Type: []byte{0, 0},
- ID: t.ID,
- ErrorCode: []byte{0, 0, 0, 1},
- Fields: []Field{
- NewField(FieldError, []byte(errMsg)),
+func (cc *ClientConn) NewErrReply(t *Transaction, errMsg string) []Transaction {
+ return []Transaction{
+ {
+ clientID: cc.ID,
+ IsReply: 1,
+ ID: t.ID,
+ ErrorCode: [4]byte{0, 0, 0, 1},
+ Fields: []Field{
+ 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
%s
`
-func formatDownloadList(fts map[[4]byte]*FileTransfer) (s string) {
+func formatDownloadList(fts []FileTransfer) (s string) {
if len(fts) == 0 {
return "None.\n"
}
}
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]),
+ formatDownloadList(cc.ClientFileTransferMgr.Get(FileDownload)),
+ formatDownloadList(cc.ClientFileTransferMgr.Get(FolderDownload)),
+ formatDownloadList(cc.ClientFileTransferMgr.Get(FileUpload)),
+ formatDownloadList(cc.ClientFileTransferMgr.Get(FolderUpload)),
"None.\n",
)
git.r.bdr.sh / rbdr / mobius / blobdiff