Minor cleanup

[rbdr/mobius] / hotline / server.go

diff --git a/hotline/server.go b/hotline/server.go
index 0d66e08f1290f3adc4a54caa81b696474be8c39a..b17102e9ac5f3ebb46eb81a4ff5c96aef4e4f2e7 100644 (file)
--- a/hotline/server.go
+++ b/hotline/server.go
@@ -2,7 +2,6 @@ package hotline
 
 import (
        "bufio"
 
 import (
        "bufio"

-       "bytes"

        "context"
        "encoding/binary"
        "errors"
        "context"
        "encoding/binary"
        "errors"


@@ -18,7 +17,6 @@ import (
        "net"
        "os"
        "path/filepath"
        "net"
        "os"
        "path/filepath"

-       "runtime/debug"

        "strings"
        "sync"
        "time"
        "strings"
        "sync"
        "time"


@@ -34,36 +32,34 @@ type requestCtx struct {
        name       string
 }
 
        name       string
 }
 

-const (
-       userIdleSeconds        = 300 // time in seconds before an inactive user is marked idle
-       idleCheckInterval      = 10  // time in seconds to check for idle users
-       trackerUpdateFrequency = 300 // time in seconds between tracker re-registration
-)
-
-var nostalgiaVersion = []byte{0, 0, 2, 0x2c} // version ID used by the Nostalgia client
-

 type Server struct {
 type Server struct {

-       Port         int
-       Accounts     map[string]*Account
-       Agreement    []byte
-       Clients      map[uint16]*ClientConn
-       ThreadedNews *ThreadedNews
-
+       Port          int
+       Accounts      map[string]*Account
+       Agreement     []byte
+       Clients       map[uint16]*ClientConn

        fileTransfers map[[4]byte]*FileTransfer
 
        fileTransfers map[[4]byte]*FileTransfer
 

-       Config        *Config
-       ConfigDir     string
-       Logger        *zap.SugaredLogger
-       PrivateChats  map[uint32]*PrivateChat
+       Config    *Config
+       ConfigDir string
+       Logger    *zap.SugaredLogger
+
+       PrivateChatsMu sync.Mutex
+       PrivateChats   map[uint32]*PrivateChat
+

        NextGuestID   *uint16
        TrackerPassID [4]byte
        NextGuestID   *uint16
        TrackerPassID [4]byte

-       Stats         *Stats
+
+       StatsMu sync.Mutex
+       Stats   *Stats

 
        FS FileStore // Storage backend to use for File storage
 
        outbox chan Transaction
        mux    sync.Mutex
 
 
        FS FileStore // Storage backend to use for File storage
 
        outbox chan Transaction
        mux    sync.Mutex
 

+       threadedNewsMux sync.Mutex
+       ThreadedNews    *ThreadedNews
+

        flatNewsMux sync.Mutex
        FlatNews    []byte
 
        flatNewsMux sync.Mutex
        FlatNews    []byte
 


@@ -71,6 +67,16 @@ type Server struct {
        banList   map[string]*time.Time
 }
 
        banList   map[string]*time.Time
 }
 

+func (s *Server) CurrentStats() Stats {
+       s.StatsMu.Lock()
+       defer s.StatsMu.Unlock()
+
+       stats := s.Stats
+       stats.CurrentlyConnected = len(s.Clients)
+
+       return *stats
+}
+

 type PrivateChat struct {
        Subject    string
        ClientConn map[uint16]*ClientConn
 type PrivateChat struct {
        Subject    string
        ClientConn map[uint16]*ClientConn


@@ -143,18 +149,18 @@ func (s *Server) sendTransaction(t Transaction) error {
 
        s.mux.Lock()
        client := s.Clients[uint16(clientID)]
 
        s.mux.Lock()
        client := s.Clients[uint16(clientID)]

+       s.mux.Unlock()

        if client == nil {
                return fmt.Errorf("invalid client id %v", *t.clientID)
        }
 
        if client == nil {
                return fmt.Errorf("invalid client id %v", *t.clientID)
        }
 

-       s.mux.Unlock()
-

        b, err := t.MarshalBinary()
        if err != nil {
                return err
        }
 
        b, err := t.MarshalBinary()
        if err != nil {
                return err
        }
 

-       if _, err := client.Connection.Write(b); err != nil {
+       _, err = client.Connection.Write(b)
+       if err != nil {

                return err
        }
 
                return err
        }
 


@@ -216,7 +222,7 @@ func NewServer(configDir string, netPort int, logger *zap.SugaredLogger, FS File
                Logger:        logger,
                NextGuestID:   new(uint16),
                outbox:        make(chan Transaction),
                Logger:        logger,
                NextGuestID:   new(uint16),
                outbox:        make(chan Transaction),

-               Stats:         &Stats{StartTime: time.Now()},
+               Stats:         &Stats{Since: time.Now()},

                ThreadedNews:  &ThreadedNews{},
                FS:            FS,
                banList:       make(map[string]*time.Time),
                ThreadedNews:  &ThreadedNews{},
                FS:            FS,
                banList:       make(map[string]*time.Time),


@@ -277,7 +283,7 @@ func NewServer(configDir string, netPort int, logger *zap.SugaredLogger, FS File
                                        if err := register(t, tr); err != nil {
                                                server.Logger.Errorw("unable to register with tracker %v", "error", err)
                                        }
                                        if err := register(t, tr); err != nil {
                                                server.Logger.Errorw("unable to register with tracker %v", "error", err)
                                        }

-                                       server.Logger.Infow("Sent Tracker registration", "data", tr)
+                                       server.Logger.Debugw("Sent Tracker registration", "addr", t)

                                }
 
                                time.Sleep(trackerUpdateFrequency * time.Second)
                                }
 
                                time.Sleep(trackerUpdateFrequency * time.Second)


@@ -342,14 +348,14 @@ func (s *Server) writeBanList() error {
 }
 
 func (s *Server) writeThreadedNews() error {
 }
 
 func (s *Server) writeThreadedNews() error {

-       s.mux.Lock()
-       defer s.mux.Unlock()
+       s.threadedNewsMux.Lock()
+       defer s.threadedNewsMux.Unlock()

 
        out, err := yaml.Marshal(s.ThreadedNews)
        if err != nil {
                return err
        }
 
        out, err := yaml.Marshal(s.ThreadedNews)
        if err != nil {
                return err
        }

-       err = ioutil.WriteFile(
+       err = s.FS.WriteFile(

                filepath.Join(s.ConfigDir, "ThreadedNews.yaml"),
                out,
                0666,
                filepath.Join(s.ConfigDir, "ThreadedNews.yaml"),
                out,
                0666,


@@ -371,7 +377,6 @@ func (s *Server) NewClientConn(conn io.ReadWriteCloser, remoteAddr string) *Clie
                Version:    []byte{},
                AutoReply:  []byte{},
                transfers:  map[int]map[[4]byte]*FileTransfer{},
                Version:    []byte{},
                AutoReply:  []byte{},
                transfers:  map[int]map[[4]byte]*FileTransfer{},

-               Agreed:     false,

                RemoteAddr: remoteAddr,
        }
        clientConn.transfers = map[int]map[[4]byte]*FileTransfer{
                RemoteAddr: remoteAddr,
        }
        clientConn.transfers = map[int]map[[4]byte]*FileTransfer{


@@ -392,7 +397,7 @@ func (s *Server) NewClientConn(conn io.ReadWriteCloser, remoteAddr string) *Clie
 }
 
 // NewUser creates a new user account entry in the server map and config file
 }
 
 // NewUser creates a new user account entry in the server map and config file

-func (s *Server) NewUser(login, name, password string, access []byte) error {
+func (s *Server) NewUser(login, name, password string, access accessBitmap) error {

        s.mux.Lock()
        defer s.mux.Unlock()
 
        s.mux.Lock()
        defer s.mux.Unlock()
 


@@ -400,7 +405,7 @@ func (s *Server) NewUser(login, name, password string, access []byte) error {
                Login:    login,
                Name:     name,
                Password: hashAndSalt([]byte(password)),
                Login:    login,
                Name:     name,
                Password: hashAndSalt([]byte(password)),

-               Access:   &access,
+               Access:   access,

        }
        out, err := yaml.Marshal(&account)
        if err != nil {
        }
        out, err := yaml.Marshal(&account)
        if err != nil {


@@ -411,7 +416,7 @@ func (s *Server) NewUser(login, name, password string, access []byte) error {
        return s.FS.WriteFile(filepath.Join(s.ConfigDir, "Users", login+".yaml"), out, 0666)
 }
 
        return s.FS.WriteFile(filepath.Join(s.ConfigDir, "Users", login+".yaml"), out, 0666)
 }
 

-func (s *Server) UpdateUser(login, newLogin, name, password string, access []byte) error {
+func (s *Server) UpdateUser(login, newLogin, name, password string, access accessBitmap) error {

        s.mux.Lock()
        defer s.mux.Unlock()
 
        s.mux.Lock()
        defer s.mux.Unlock()
 


@@ -426,7 +431,7 @@ func (s *Server) UpdateUser(login, newLogin, name, password string, access []byt
        }
 
        account := s.Accounts[newLogin]
        }
 
        account := s.Accounts[newLogin]

-       account.Access = &access
+       account.Access = access

        account.Name = name
        account.Password = password
 
        account.Name = name
        account.Password = password
 


@@ -458,9 +463,6 @@ func (s *Server) connectedUsers() []Field {
 
        var connectedUsers []Field
        for _, c := range sortedClients(s.Clients) {
 
        var connectedUsers []Field
        for _, c := range sortedClients(s.Clients) {

-               if !c.Agreed {
-                       continue
-               }

                user := User{
                        ID:    *c.ID,
                        Icon:  c.Icon,
                user := User{
                        ID:    *c.ID,
                        Icon:  c.Icon,


@@ -541,14 +543,6 @@ func (s *Server) loadConfig(path string) error {
        return nil
 }
 
        return nil
 }
 

-// dontPanic logs panics instead of crashing
-func dontPanic(logger *zap.SugaredLogger) {
-       if r := recover(); r != nil {
-               fmt.Println("stacktrace from panic: \n" + string(debug.Stack()))
-               logger.Errorw("PANIC", "err", r, "trace", string(debug.Stack()))
-       }
-}
-

 // handleNewConnection takes a new net.Conn and performs the initial login sequence
 func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser, remoteAddr string) error {
        defer dontPanic(s.Logger)
 // handleNewConnection takes a new net.Conn and performs the initial login sequence
 func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser, remoteAddr string) error {
        defer dontPanic(s.Logger)


@@ -563,9 +557,14 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
 
        scanner.Scan()
 
 
        scanner.Scan()
 

-       clientLogin, _, err := ReadTransaction(scanner.Bytes())
-       if err != nil {
-               panic(err)
+       // Make a new []byte slice and copy the scanner bytes to it.  This is critical to avoid a data race as the
+       // scanner re-uses the buffer for subsequent scans.
+       buf := make([]byte, len(scanner.Bytes()))
+       copy(buf, scanner.Bytes())
+
+       var clientLogin Transaction
+       if _, err := clientLogin.Write(buf); err != nil {
+               return err

        }
 
        c := s.NewClientConn(rwc, remoteAddr)
        }
 
        c := s.NewClientConn(rwc, remoteAddr)


@@ -612,7 +611,7 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
 
        // If authentication fails, send error reply and close connection
        if !c.Authenticate(login, encodedPassword) {
 
        // If authentication fails, send error reply and close connection
        if !c.Authenticate(login, encodedPassword) {

-               t := c.NewErrReply(clientLogin, "Incorrect login.")
+               t := c.NewErrReply(&clientLogin, "Incorrect login.")

                b, err := t.MarshalBinary()
                if err != nil {
                        return err
                b, err := t.MarshalBinary()
                if err != nil {
                        return err


@@ -644,14 +643,14 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
                c.Flags = []byte{0, 2}
        }
 
                c.Flags = []byte{0, 2}
        }
 

-       s.outbox <- c.NewReply(clientLogin,
+       s.outbox <- c.NewReply(&clientLogin,

                NewField(fieldVersion, []byte{0x00, 0xbe}),
                NewField(fieldCommunityBannerID, []byte{0, 0}),
                NewField(fieldServerName, []byte(s.Config.Name)),
        )
 
        // Send user access privs so client UI knows how to behave
                NewField(fieldVersion, []byte{0x00, 0xbe}),
                NewField(fieldCommunityBannerID, []byte{0, 0}),
                NewField(fieldServerName, []byte(s.Config.Name)),
        )
 
        // Send user access privs so client UI knows how to behave

-       c.Server.outbox <- *NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, *c.Account.Access))
+       c.Server.outbox <- *NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, c.Account.Access[:]))

 
        // Accounts with accessNoAgreement do not receive the server agreement on login.  The behavior is different between
        // client versions.  For 1.2.3 client, we do not send tranShowAgreement.  For other client versions, we send
 
        // Accounts with accessNoAgreement do not receive the server agreement on login.  The behavior is different between
        // client versions.  For 1.2.3 client, we do not send tranShowAgreement.  For other client versions, we send


@@ -666,25 +665,26 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
        }
 
        // Used simplified hotline v1.2.3 login flow for clients that do not send login info in tranAgreed
        }
 
        // Used simplified hotline v1.2.3 login flow for clients that do not send login info in tranAgreed

-       if c.Version == nil || bytes.Equal(c.Version, nostalgiaVersion) {
-               c.Agreed = true
-               c.logger = c.logger.With("name", string(c.UserName))
-               c.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%x", c.Version))
-
-               for _, t := range c.notifyOthers(
-                       *NewTransaction(
-                               tranNotifyChangeUser, nil,
-                               NewField(fieldUserName, c.UserName),
-                               NewField(fieldUserID, *c.ID),
-                               NewField(fieldUserIconID, c.Icon),
-                               NewField(fieldUserFlags, c.Flags),
-                       ),
-               ) {
-                       c.Server.outbox <- t
-               }
+       // TODO: figure out a generalized solution that doesn't require playing whack-a-mole for specific client versions
+       c.logger = c.logger.With("name", string(c.UserName))
+       c.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%v", func() int { i, _ := byteToInt(c.Version); return i }()))
+
+       for _, t := range c.notifyOthers(
+               *NewTransaction(
+                       tranNotifyChangeUser, nil,
+                       NewField(fieldUserName, c.UserName),
+                       NewField(fieldUserID, *c.ID),
+                       NewField(fieldUserIconID, c.Icon),
+                       NewField(fieldUserFlags, c.Flags),
+               ),
+       ) {
+               c.Server.outbox <- t

        }
 
        }
 

-       c.Server.Stats.LoginCount += 1
+       c.Server.Stats.ConnectionCounter += 1
+       if len(s.Clients) > c.Server.Stats.ConnectionPeak {
+               c.Server.Stats.ConnectionPeak = len(s.Clients)
+       }

 
        // Scan for new transactions and handle them as they come in.
        for scanner.Scan() {
 
        // Scan for new transactions and handle them as they come in.
        for scanner.Scan() {


@@ -693,11 +693,12 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
                buf := make([]byte, len(scanner.Bytes()))
                copy(buf, scanner.Bytes())
 
                buf := make([]byte, len(scanner.Bytes()))
                copy(buf, scanner.Bytes())
 

-               t, _, err := ReadTransaction(buf)
-               if err != nil {
-                       panic(err)
+               var t Transaction
+               if _, err := t.Write(buf); err != nil {
+                       return err

                }
                }

-               if err := c.handleTransaction(*t); err != nil {
+
+               if err := c.handleTransaction(t); err != nil {

                        c.logger.Errorw("Error handling transaction", "err", err)
                }
        }
                        c.logger.Errorw("Error handling transaction", "err", err)
                }
        }


@@ -705,15 +706,14 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
 }
 
 func (s *Server) NewPrivateChat(cc *ClientConn) []byte {
 }
 
 func (s *Server) NewPrivateChat(cc *ClientConn) []byte {

-       s.mux.Lock()
-       defer s.mux.Unlock()
+       s.PrivateChatsMu.Lock()
+       defer s.PrivateChatsMu.Unlock()

 
        randID := make([]byte, 4)
        rand.Read(randID)
        data := binary.BigEndian.Uint32(randID[:])
 
        s.PrivateChats[data] = &PrivateChat{
 
        randID := make([]byte, 4)
        rand.Read(randID)
        data := binary.BigEndian.Uint32(randID[:])
 
        s.PrivateChats[data] = &PrivateChat{

-               Subject:    "",

                ClientConn: make(map[uint16]*ClientConn),
        }
        s.PrivateChats[data].ClientConn[cc.uint16ID()] = cc
                ClientConn: make(map[uint16]*ClientConn),
        }
        s.PrivateChats[data].ClientConn[cc.uint16ID()] = cc


@@ -744,6 +744,10 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
                delete(s.fileTransfers, t.ReferenceNumber)
                s.mux.Unlock()
 
                delete(s.fileTransfers, t.ReferenceNumber)
                s.mux.Unlock()
 

+               // Wait a few seconds before closing the connection: this is a workaround for problems
+               // observed with Windows clients where the client must initiate close of the TCP connection before
+               // the server does.  This is gross and seems unnecessary.  TODO: Revisit?
+               time.Sleep(3 * time.Second)

        }()
 
        s.mux.Lock()
        }()
 
        s.mux.Lock()


@@ -773,11 +777,14 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
        switch fileTransfer.Type {
        case bannerDownload:
                if err := s.bannerDownload(rwc); err != nil {
        switch fileTransfer.Type {
        case bannerDownload:
                if err := s.bannerDownload(rwc); err != nil {

-                       panic(err)

                        return err
                }
        case FileDownload:
                s.Stats.DownloadCounter += 1
                        return err
                }
        case FileDownload:
                s.Stats.DownloadCounter += 1

+               s.Stats.DownloadsInProgress += 1
+               defer func() {
+                       s.Stats.DownloadsInProgress -= 1
+               }()

 
                var dataOffset int64
                if fileTransfer.fileResumeData != nil {
 
                var dataOffset int64
                if fileTransfer.fileResumeData != nil {


@@ -832,6 +839,8 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
 
        case FileUpload:
                s.Stats.UploadCounter += 1
 
        case FileUpload:
                s.Stats.UploadCounter += 1

+               s.Stats.UploadsInProgress += 1
+               defer func() { s.Stats.UploadsInProgress -= 1 }()

 
                var file *os.File
 
 
                var file *os.File
 


@@ -888,7 +897,12 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
                }
 
                rLogger.Infow("File upload complete", "dstFile", fullPath)
                }
 
                rLogger.Infow("File upload complete", "dstFile", fullPath)

+

        case FolderDownload:
        case FolderDownload:

+               s.Stats.DownloadCounter += 1
+               s.Stats.DownloadsInProgress += 1
+               defer func() { s.Stats.DownloadsInProgress -= 1 }()
+

                // Folder Download flow:
                // 1. Get filePath from the transfer
                // 2. Iterate over files
                // Folder Download flow:
                // 1. Get filePath from the transfer
                // 2. Iterate over files


@@ -1052,6 +1066,9 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
                }
 
        case FolderUpload:
                }
 
        case FolderUpload:

+               s.Stats.UploadCounter += 1
+               s.Stats.UploadsInProgress += 1
+               defer func() { s.Stats.UploadsInProgress -= 1 }()

                rLogger.Infow(
                        "Folder upload started",
                        "dstPath", fullPath,
                rLogger.Infow(
                        "Folder upload started",
                        "dstPath", fullPath,