]> git.r.bdr.sh - rbdr/mobius/blobdiff - hotline/server.go
Add support for Mac Roman character encoding.
[rbdr/mobius] / hotline / server.go
index bd15a2ecea697b8ed88a2e34c29e870b6866e034..f4eef9bd63b646403228ed36547817e0075183c6 100644 (file)
@@ -2,17 +2,16 @@ package hotline
 
 import (
        "bufio"
-       "bytes"
        "context"
        "encoding/binary"
        "errors"
        "fmt"
        "github.com/go-playground/validator/v10"
        "go.uber.org/zap"
+       "golang.org/x/text/encoding/charmap"
        "gopkg.in/yaml.v3"
        "io"
        "io/fs"
-       "io/ioutil"
        "math/big"
        "math/rand"
        "net"
@@ -29,14 +28,16 @@ var contextKeyReq = contextKey("req")
 
 type requestCtx struct {
        remoteAddr string
-       login      string
-       name       string
 }
 
-var nostalgiaVersion = []byte{0, 0, 2, 0x2c} // version ID used by the Nostalgia client
-var frogblastVersion = []byte{0, 0, 0, 0xb9} // version ID used by the Frogblast 1.2.4 client
+// Converts bytes from Mac Roman encoding to UTF-8
+var txtDecoder = charmap.Macintosh.NewDecoder()
+
+// Converts bytes from UTF-8 to Mac Roman encoding
+var txtEncoder = charmap.Macintosh.NewEncoder()
 
 type Server struct {
+       NetInterface  string
        Port          int
        Accounts      map[string]*Account
        Agreement     []byte
@@ -89,15 +90,15 @@ type PrivateChat struct {
 func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFunc) error {
        s.Logger.Infow("Hotline server started",
                "version", VERSION,
-               "API port", fmt.Sprintf(":%v", s.Port),
-               "Transfer port", fmt.Sprintf(":%v", s.Port+1),
+               "API port", fmt.Sprintf("%s:%v", s.NetInterface, s.Port),
+               "Transfer port", fmt.Sprintf("%s:%v", s.NetInterface, s.Port+1),
        )
 
        var wg sync.WaitGroup
 
        wg.Add(1)
        go func() {
-               ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", "", s.Port))
+               ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", s.NetInterface, s.Port))
                if err != nil {
                        s.Logger.Fatal(err)
                }
@@ -107,10 +108,9 @@ func (s *Server) ListenAndServe(ctx context.Context, cancelRoot context.CancelFu
 
        wg.Add(1)
        go func() {
-               ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", "", s.Port+1))
+               ln, err := net.Listen("tcp", fmt.Sprintf("%s:%v", s.NetInterface, s.Port+1))
                if err != nil {
                        s.Logger.Fatal(err)
-
                }
 
                s.Logger.Fatal(s.ServeFileTransfers(ctx, ln))
@@ -153,18 +153,18 @@ func (s *Server) sendTransaction(t Transaction) error {
 
        s.mux.Lock()
        client := s.Clients[uint16(clientID)]
+       s.mux.Unlock()
        if client == nil {
                return fmt.Errorf("invalid client id %v", *t.clientID)
        }
 
-       s.mux.Unlock()
-
        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
        }
 
@@ -214,8 +214,9 @@ const (
 )
 
 // NewServer constructs a new Server from a config dir
-func NewServer(configDir string, netPort int, logger *zap.SugaredLogger, FS FileStore) (*Server, error) {
+func NewServer(configDir, netInterface string, netPort int, logger *zap.SugaredLogger, fs FileStore) (*Server, error) {
        server := Server{
+               NetInterface:  netInterface,
                Port:          netPort,
                Accounts:      make(map[string]*Account),
                Config:        new(Config),
@@ -228,7 +229,7 @@ func NewServer(configDir string, netPort int, logger *zap.SugaredLogger, FS File
                outbox:        make(chan Transaction),
                Stats:         &Stats{Since: time.Now()},
                ThreadedNews:  &ThreadedNews{},
-               FS:            FS,
+               FS:            fs,
                banList:       make(map[string]*time.Time),
        }
 
@@ -263,7 +264,10 @@ func NewServer(configDir string, netPort int, logger *zap.SugaredLogger, FS File
                return nil, err
        }
 
-       server.Config.FileRoot = filepath.Join(configDir, "Files")
+       // If the FileRoot is an absolute path, use it, otherwise treat as a relative path to the config dir.
+       if !filepath.IsAbs(server.Config.FileRoot) {
+               server.Config.FileRoot = filepath.Join(configDir, server.Config.FileRoot)
+       }
 
        *server.NextGuestID = 1
 
@@ -319,15 +323,15 @@ func (s *Server) keepaliveHandler() {
                                c.Idle = true
 
                                flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(c.Flags)))
-                               flagBitmap.SetBit(flagBitmap, userFlagAway, 1)
+                               flagBitmap.SetBit(flagBitmap, UserFlagAway, 1)
                                binary.BigEndian.PutUint16(c.Flags, uint16(flagBitmap.Int64()))
 
                                c.sendAll(
-                                       tranNotifyChangeUser,
-                                       NewField(fieldUserID, *c.ID),
-                                       NewField(fieldUserFlags, c.Flags),
-                                       NewField(fieldUserName, c.UserName),
-                                       NewField(fieldUserIconID, c.Icon),
+                                       TranNotifyChangeUser,
+                                       NewField(FieldUserID, *c.ID),
+                                       NewField(FieldUserFlags, c.Flags),
+                                       NewField(FieldUserName, c.UserName),
+                                       NewField(FieldUserIconID, c.Icon),
                                )
                        }
                }
@@ -343,7 +347,7 @@ func (s *Server) writeBanList() error {
        if err != nil {
                return err
        }
-       err = ioutil.WriteFile(
+       err = os.WriteFile(
                filepath.Join(s.ConfigDir, "Banlist.yaml"),
                out,
                0666,
@@ -381,7 +385,6 @@ func (s *Server) NewClientConn(conn io.ReadWriteCloser, remoteAddr string) *Clie
                Version:    []byte{},
                AutoReply:  []byte{},
                transfers:  map[int]map[[4]byte]*FileTransfer{},
-               Agreed:     false,
                RemoteAddr: remoteAddr,
        }
        clientConn.transfers = map[int]map[[4]byte]*FileTransfer{
@@ -468,16 +471,13 @@ func (s *Server) connectedUsers() []Field {
 
        var connectedUsers []Field
        for _, c := range sortedClients(s.Clients) {
-               if !c.Agreed {
-                       continue
-               }
                user := User{
                        ID:    *c.ID,
                        Icon:  c.Icon,
                        Flags: c.Flags,
                        Name:  string(c.UserName),
                }
-               connectedUsers = append(connectedUsers, NewField(fieldUsernameWithInfo, user.Payload()))
+               connectedUsers = append(connectedUsers, NewField(FieldUsernameWithInfo, user.Payload()))
        }
        return connectedUsers
 }
@@ -575,37 +575,60 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
                return err
        }
 
-       c := s.NewClientConn(rwc, remoteAddr)
-
        // check if remoteAddr is present in the ban list
        if banUntil, ok := s.banList[strings.Split(remoteAddr, ":")[0]]; ok {
                // permaban
                if banUntil == nil {
-                       s.outbox <- *NewTransaction(
-                               tranServerMsg,
-                               c.ID,
-                               NewField(fieldData, []byte("You are permanently banned on this server")),
-                               NewField(fieldChatOptions, []byte{0, 0}),
+                       t := NewTransaction(
+                               TranServerMsg,
+                               &[]byte{0, 0},
+                               NewField(FieldData, []byte("You are permanently banned on this server")),
+                               NewField(FieldChatOptions, []byte{0, 0}),
                        )
+
+                       b, err := t.MarshalBinary()
+                       if err != nil {
+                               return err
+                       }
+
+                       _, err = rwc.Write(b)
+                       if err != nil {
+                               return err
+                       }
+
                        time.Sleep(1 * time.Second)
                        return nil
-               } else if time.Now().Before(*banUntil) {
-                       s.outbox <- *NewTransaction(
-                               tranServerMsg,
-                               c.ID,
-                               NewField(fieldData, []byte("You are temporarily banned on this server")),
-                               NewField(fieldChatOptions, []byte{0, 0}),
+               }
+
+               // temporary ban
+               if time.Now().Before(*banUntil) {
+                       t := NewTransaction(
+                               TranServerMsg,
+                               &[]byte{0, 0},
+                               NewField(FieldData, []byte("You are temporarily banned on this server")),
+                               NewField(FieldChatOptions, []byte{0, 0}),
                        )
+                       b, err := t.MarshalBinary()
+                       if err != nil {
+                               return err
+                       }
+
+                       _, err = rwc.Write(b)
+                       if err != nil {
+                               return err
+                       }
+
                        time.Sleep(1 * time.Second)
                        return nil
                }
-
        }
+
+       c := s.NewClientConn(rwc, remoteAddr)
        defer c.Disconnect()
 
-       encodedLogin := clientLogin.GetField(fieldUserLogin).Data
-       encodedPassword := clientLogin.GetField(fieldUserPassword).Data
-       c.Version = clientLogin.GetField(fieldVersion).Data
+       encodedLogin := clientLogin.GetField(FieldUserLogin).Data
+       encodedPassword := clientLogin.GetField(FieldUserPassword).Data
+       c.Version = clientLogin.GetField(FieldVersion).Data
 
        var login string
        for _, char := range encodedLogin {
@@ -633,15 +656,15 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
                return nil
        }
 
-       if clientLogin.GetField(fieldUserIconID).Data != nil {
-               c.Icon = clientLogin.GetField(fieldUserIconID).Data
+       if clientLogin.GetField(FieldUserIconID).Data != nil {
+               c.Icon = clientLogin.GetField(FieldUserIconID).Data
        }
 
        c.Account = c.Server.Accounts[login]
 
-       if clientLogin.GetField(fieldUserName).Data != nil {
+       if clientLogin.GetField(FieldUserName).Data != nil {
                if c.Authorize(accessAnyName) {
-                       c.UserName = clientLogin.GetField(fieldUserName).Data
+                       c.UserName = clientLogin.GetField(FieldUserName).Data
                } else {
                        c.UserName = []byte(c.Account.Name)
                }
@@ -652,39 +675,44 @@ func (s *Server) handleNewConnection(ctx context.Context, rwc io.ReadWriteCloser
        }
 
        s.outbox <- c.NewReply(&clientLogin,
-               NewField(fieldVersion, []byte{0x00, 0xbe}),
-               NewField(fieldCommunityBannerID, []byte{0, 0}),
-               NewField(fieldServerName, []byte(s.Config.Name)),
+               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
-       // tranShowAgreement but with the NoServerAgreement field set to 1.
+       // client versions.  For 1.2.3 client, we do not send TranShowAgreement.  For other client versions, we send
+       // TranShowAgreement but with the NoServerAgreement field set to 1.
        if c.Authorize(accessNoAgreement) {
                // If client version is nil, then the client uses the 1.2.3 login behavior
                if c.Version != nil {
-                       c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldNoServerAgreement, []byte{1}))
+                       c.Server.outbox <- *NewTransaction(TranShowAgreement, c.ID, NewField(FieldNoServerAgreement, []byte{1}))
                }
        } else {
-               c.Server.outbox <- *NewTransaction(tranShowAgreement, c.ID, NewField(fieldData, s.Agreement))
+               c.Server.outbox <- *NewTransaction(TranShowAgreement, c.ID, NewField(FieldData, s.Agreement))
        }
 
-       // 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) || bytes.Equal(c.Version, frogblastVersion) {
-               c.Agreed = true
+       // If the client has provided a username as part of the login, we can infer that it is using the 1.2.3 login
+       // flow and not the 1.5+ flow.
+       if len(c.UserName) != 0 {
+               // Add the client username to the logger.  For 1.5+ clients, we don't have this information yet as it comes as
+               // part of TranAgreed
                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 }()))
 
+               c.logger.Infow("Login successful", "clientVersion", "Not sent (probably 1.2.3)")
+
+               // Notify other clients on the server that the new user has logged in.  For 1.5+ clients we don't have this
+               // information yet, so we do it in TranAgreed instead
                for _, t := range c.notifyOthers(
                        *NewTransaction(
-                               tranNotifyChangeUser, nil,
-                               NewField(fieldUserName, c.UserName),
-                               NewField(fieldUserID, *c.ID),
-                               NewField(fieldUserIconID, c.Icon),
-                               NewField(fieldUserFlags, c.Flags),
+                               TranNotifyChangeUser, nil,
+                               NewField(FieldUserName, c.UserName),
+                               NewField(FieldUserID, *c.ID),
+                               NewField(FieldUserIconID, c.Icon),
+                               NewField(FieldUserFlags, c.Flags),
                        ),
                ) {
                        c.Server.outbox <- t
@@ -721,7 +749,7 @@ func (s *Server) NewPrivateChat(cc *ClientConn) []byte {
 
        randID := make([]byte, 4)
        rand.Read(randID)
-       data := binary.BigEndian.Uint32(randID[:])
+       data := binary.BigEndian.Uint32(randID)
 
        s.PrivateChats[data] = &PrivateChat{
                ClientConn: make(map[uint16]*ClientConn),
@@ -1190,7 +1218,7 @@ func (s *Server) handleFileTransfer(ctx context.Context, rwc io.ReadWriter) erro
                                                return err
                                        }
 
-                                       if err := receiveFile(rwc, file, ioutil.Discard, ioutil.Discard, fileTransfer.bytesSentCounter); err != nil {
+                                       if err := receiveFile(rwc, file, io.Discard, io.Discard, fileTransfer.bytesSentCounter); err != nil {
                                                s.Logger.Error(err)
                                        }