package hotline
import (
+ "bufio"
"bytes"
"embed"
"encoding/binary"
"fmt"
"github.com/gdamore/tcell/v2"
"github.com/rivo/tview"
- "github.com/stretchr/testify/mock"
"go.uber.org/zap"
"gopkg.in/yaml.v3"
"math/big"
}
type ClientPrefs struct {
- Username string `yaml:"Username"`
- IconID int `yaml:"IconID"`
- Bookmarks []Bookmark `yaml:"Bookmarks"`
- Tracker string `yaml:"Tracker"`
+ Username string `yaml:"Username"`
+ IconID int `yaml:"IconID"`
+ Bookmarks []Bookmark `yaml:"Bookmarks"`
+ Tracker string `yaml:"Tracker"`
+ EnableBell bool `yaml:"EnableBell"`
}
func (cp *ClientPrefs) IconBytes() []byte {
return iconBytes
}
-func (cp *ClientPrefs) AddBookmark(name, addr, login, pass string) error {
+func (cp *ClientPrefs) AddBookmark(name, addr, login, pass string) {
cp.Bookmarks = append(cp.Bookmarks, Bookmark{Addr: addr, Login: login, Password: pass})
-
- return nil
}
func readConfig(cfgPath string) (*ClientPrefs, error) {
cfgPath string
DebugBuf *DebugBuffer
Connection net.Conn
- Login *[]byte
- Password *[]byte
- Flags *[]byte
- ID *[]byte
- Version []byte
UserAccess []byte
filePath []string
UserList []User
activeTasks map[uint32]*Transaction
serverName string
- pref *ClientPrefs
+ Pref *ClientPrefs
- Handlers map[uint16]clientTHandler
+ Handlers map[uint16]ClientHandler
UI *UI
Inbox chan *Transaction
}
-func NewClient(cfgPath string, logger *zap.SugaredLogger) *Client {
+type ClientHandler func(*Client, *Transaction) ([]Transaction, error)
+
+func (c *Client) HandleFunc(transactionID uint16, handler ClientHandler) {
+ c.Handlers[transactionID] = handler
+}
+
+func NewClient(username string, logger *zap.SugaredLogger) *Client {
+ c := &Client{
+ Logger: logger,
+ activeTasks: make(map[uint32]*Transaction),
+ Handlers: make(map[uint16]ClientHandler),
+ }
+ c.Pref = &ClientPrefs{Username: username}
+
+ return c
+}
+
+func NewUIClient(cfgPath string, logger *zap.SugaredLogger) *Client {
c := &Client{
cfgPath: cfgPath,
Logger: logger,
if err != nil {
logger.Fatal(fmt.Sprintf("unable to read config file %s\n", cfgPath))
}
- c.pref = prefs
+ c.Pref = prefs
return c
}
return db.TextView.Write(p)
}
-// Sync is a noop function that exists to satisfy the zapcore.WriteSyncer interface
+// Sync is a noop function that dataFile to satisfy the zapcore.WriteSyncer interface
func (db *DebugBuffer) Sync() error {
return nil
}
return fmt.Sprintf("\n\n\nWelcome to...\n\n[red::b]%s[-:-:-]\n\n", file)
}
-type clientTransaction struct {
+type ClientTransaction struct {
Name string
Handler func(*Client, *Transaction) ([]Transaction, error)
}
-func (ch clientTransaction) Handle(cc *Client, t *Transaction) ([]Transaction, error) {
+func (ch ClientTransaction) Handle(cc *Client, t *Transaction) ([]Transaction, error) {
return ch.Handler(cc, t)
}
-type clientTHandler interface {
+type ClientTHandler interface {
Handle(*Client, *Transaction) ([]Transaction, error)
}
-type mockClientHandler struct {
- mock.Mock
-}
-
-func (mh *mockClientHandler) Handle(cc *Client, t *Transaction) ([]Transaction, error) {
- args := mh.Called(cc, t)
- return args.Get(0).([]Transaction), args.Error(1)
-}
-
-var clientHandlers = map[uint16]clientTHandler{
- // Server initiated
- tranChatMsg: clientTransaction{
- Name: "tranChatMsg",
- Handler: handleClientChatMsg,
- },
- tranLogin: clientTransaction{
- Name: "tranLogin",
- Handler: handleClientTranLogin,
- },
- tranShowAgreement: clientTransaction{
- Name: "tranShowAgreement",
- Handler: handleClientTranShowAgreement,
- },
- tranUserAccess: clientTransaction{
- Name: "tranUserAccess",
- Handler: handleClientTranUserAccess,
- },
- tranGetUserNameList: clientTransaction{
- Name: "tranGetUserNameList",
- Handler: handleClientGetUserNameList,
- },
- tranNotifyChangeUser: clientTransaction{
- Name: "tranNotifyChangeUser",
- Handler: handleNotifyChangeUser,
- },
- tranNotifyDeleteUser: clientTransaction{
- Name: "tranNotifyDeleteUser",
- Handler: handleNotifyDeleteUser,
- },
- tranGetMsgs: clientTransaction{
- Name: "tranNotifyDeleteUser",
- Handler: handleGetMsgs,
- },
- tranGetFileNameList: clientTransaction{
- Name: "tranGetFileNameList",
- Handler: handleGetFileNameList,
- },
- tranServerMsg: clientTransaction{
- Name: "tranServerMsg",
- Handler: handleTranServerMsg,
- },
- tranKeepAlive: clientTransaction{
- Name: "tranKeepAlive",
- Handler: func(client *Client, transaction *Transaction) (t []Transaction, err error) {
- return t, err
- },
+var clientHandlers = map[uint16]ClientHandler{
+ TranChatMsg: handleClientChatMsg,
+ TranLogin: handleClientTranLogin,
+ TranShowAgreement: handleClientTranShowAgreement,
+ TranUserAccess: handleClientTranUserAccess,
+ TranGetUserNameList: handleClientGetUserNameList,
+ TranNotifyChangeUser: handleNotifyChangeUser,
+ TranNotifyDeleteUser: handleNotifyDeleteUser,
+ TranGetMsgs: handleGetMsgs,
+ TranGetFileNameList: handleGetFileNameList,
+ TranServerMsg: handleTranServerMsg,
+ TranKeepAlive: func(client *Client, transaction *Transaction) (t []Transaction, err error) {
+ return t, err
},
}
func handleTranServerMsg(c *Client, t *Transaction) (res []Transaction, err error) {
- time := time.Now().Format(time.RFC850)
+ now := time.Now().Format(time.RFC850)
- msg := strings.ReplaceAll(string(t.GetField(fieldData).Data), "\r", "\n")
- msg += "\n\nAt " + time
- title := fmt.Sprintf("| Private Message From: %s |", t.GetField(fieldUserName).Data)
+ msg := strings.ReplaceAll(string(t.GetField(FieldData).Data), "\r", "\n")
+ msg += "\n\nAt " + now
+ title := fmt.Sprintf("| Private Message From: %s |", t.GetField(FieldUserName).Data)
msgBox := tview.NewTextView().SetScrollable(true)
msgBox.SetText(msg).SetBackgroundColor(tcell.ColorDarkSlateBlue)
msgBox.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
switch event.Key() {
case tcell.KeyEscape:
- c.UI.Pages.RemovePage("serverMsgModal" + time)
+ c.UI.Pages.RemovePage("serverMsgModal" + now)
}
return event
})
AddItem(nil, 0, 1, false), 0, 2, true).
AddItem(nil, 0, 1, false)
- c.UI.Pages.AddPage("serverMsgModal"+time, centeredFlex, true, true)
+ c.UI.Pages.AddPage("serverMsgModal"+now, centeredFlex, true, true)
c.UI.App.Draw() // TODO: errModal doesn't render without this. wtf?
return res, err
}
+func (c *Client) showErrMsg(msg string) {
+ t := time.Now().Format(time.RFC850)
+
+ title := "| Error |"
+
+ msgBox := tview.NewTextView().SetScrollable(true)
+ msgBox.SetText(msg).SetBackgroundColor(tcell.ColorDarkRed)
+ msgBox.SetTitle(title).SetBorder(true)
+ msgBox.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
+ switch event.Key() {
+ case tcell.KeyEscape:
+ c.UI.Pages.RemovePage("serverMsgModal" + t)
+ }
+ return event
+ })
+
+ centeredFlex := tview.NewFlex().
+ AddItem(nil, 0, 1, false).
+ AddItem(tview.NewFlex().SetDirection(tview.FlexRow).
+ AddItem(nil, 0, 1, false).
+ AddItem(msgBox, 0, 2, true).
+ AddItem(nil, 0, 1, false), 0, 2, true).
+ AddItem(nil, 0, 1, false)
+
+ c.UI.Pages.AddPage("serverMsgModal"+t, centeredFlex, true, true)
+ c.UI.App.Draw() // TODO: errModal doesn't render without this. wtf?
+}
+
func handleGetFileNameList(c *Client, t *Transaction) (res []Transaction, err error) {
+ if t.IsError() {
+ c.showErrMsg(string(t.GetField(FieldError).Data))
+ c.Logger.Infof("Error: %s", t.GetField(FieldError).Data)
+ return res, err
+ }
+
fTree := tview.NewTreeView().SetTopLevel(1)
root := tview.NewTreeNode("Root")
fTree.SetRoot(root).SetCurrentNode(root)
if selectedNode.GetText() == "<- Back" {
c.filePath = c.filePath[:len(c.filePath)-1]
- f := NewField(fieldFilePath, EncodeFilePath(strings.Join(c.filePath, "/")))
+ f := NewField(FieldFilePath, EncodeFilePath(strings.Join(c.filePath, "/")))
- if err := c.UI.HLClient.Send(*NewTransaction(tranGetFileNameList, nil, f)); err != nil {
+ if err := c.UI.HLClient.Send(*NewTransaction(TranGetFileNameList, nil, f)); err != nil {
c.UI.HLClient.Logger.Errorw("err", "err", err)
}
return event
c.Logger.Infow("get new directory listing", "name", string(entry.name))
c.filePath = append(c.filePath, string(entry.name))
- f := NewField(fieldFilePath, EncodeFilePath(strings.Join(c.filePath, "/")))
+ f := NewField(FieldFilePath, EncodeFilePath(strings.Join(c.filePath, "/")))
- if err := c.UI.HLClient.Send(*NewTransaction(tranGetFileNameList, nil, f)); err != nil {
+ if err := c.UI.HLClient.Send(*NewTransaction(TranGetFileNameList, nil, f)); err != nil {
c.UI.HLClient.Logger.Errorw("err", "err", err)
}
} else {
node.SetReference(&fn)
root.AddChild(node)
}
-
}
centerFlex := tview.NewFlex().
}
func handleGetMsgs(c *Client, t *Transaction) (res []Transaction, err error) {
- newsText := string(t.GetField(fieldData).Data)
+ newsText := string(t.GetField(FieldData).Data)
newsText = strings.ReplaceAll(newsText, "\r", "\n")
newsTextView := tview.NewTextView().
func handleNotifyChangeUser(c *Client, t *Transaction) (res []Transaction, err error) {
newUser := User{
- ID: t.GetField(fieldUserID).Data,
- Name: string(t.GetField(fieldUserName).Data),
- Icon: t.GetField(fieldUserIconID).Data,
- Flags: t.GetField(fieldUserFlags).Data,
+ ID: t.GetField(FieldUserID).Data,
+ Name: string(t.GetField(FieldUserName).Data),
+ Icon: t.GetField(FieldUserIconID).Data,
+ Flags: t.GetField(FieldUserFlags).Data,
}
// Possible cases:
}
func handleNotifyDeleteUser(c *Client, t *Transaction) (res []Transaction, err error) {
- exitUser := t.GetField(fieldUserID).Data
+ exitUser := t.GetField(FieldUserID).Data
var newUserList []User
for _, u := range c.UserList {
return res, err
}
-const readBuffSize = 1024000 // 1KB - TODO: what should this be?
-
-func (c *Client) ReadLoop() error {
- tranBuff := make([]byte, 0)
- tReadlen := 0
- // Infinite loop where take action on incoming client requests until the connection is closed
- for {
- buf := make([]byte, readBuffSize)
- tranBuff = tranBuff[tReadlen:]
-
- readLen, err := c.Connection.Read(buf)
- if err != nil {
- return err
- }
- tranBuff = append(tranBuff, buf[:readLen]...)
-
- // We may have read multiple requests worth of bytes from Connection.Read. readTransactions splits them
- // into a slice of transactions
- var transactions []Transaction
- if transactions, tReadlen, err = readTransactions(tranBuff); err != nil {
- c.Logger.Errorw("Error handling transaction", "err", err)
- }
-
- // iterate over all of the transactions that were parsed from the byte slice and handle them
- for _, t := range transactions {
- if err := c.HandleTransaction(&t); err != nil {
- c.Logger.Errorw("Error handling transaction", "err", err)
- }
- }
- }
-}
-
-func (c *Client) GetTransactions() error {
- tranBuff := make([]byte, 0)
- tReadlen := 0
-
- buf := make([]byte, readBuffSize)
- tranBuff = tranBuff[tReadlen:]
-
- readLen, err := c.Connection.Read(buf)
- if err != nil {
- return err
- }
- tranBuff = append(tranBuff, buf[:readLen]...)
-
- return nil
-}
-
func handleClientGetUserNameList(c *Client, t *Transaction) (res []Transaction, err error) {
var users []User
for _, field := range t.Fields {
- // The Hotline protocol docs say that ClientGetUserNameList should only return fieldUsernameWithInfo (300)
- // fields, but shxd sneaks in fieldChatSubject (115) so it's important to filter explicitly for the expected
+ // The Hotline protocol docs say that ClientGetUserNameList should only return FieldUsernameWithInfo (300)
+ // fields, but shxd sneaks in FieldChatSubject (115) so it's important to filter explicitly for the expected
// field type. Probably a good idea to do everywhere.
if bytes.Equal(field.ID, []byte{0x01, 0x2c}) {
u, err := ReadUser(field.Data)
c.UI.userList.Clear()
for _, u := range c.UserList {
flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(u.Flags)))
- if flagBitmap.Bit(userFlagAdmin) == 1 {
+ if flagBitmap.Bit(UserFlagAdmin) == 1 {
_, _ = fmt.Fprintf(c.UI.userList, "[red::b]%s[-:-:-]\n", u.Name)
} else {
_, _ = fmt.Fprintf(c.UI.userList, "%s\n", u.Name)
}
func handleClientChatMsg(c *Client, t *Transaction) (res []Transaction, err error) {
- _, _ = fmt.Fprintf(c.UI.chatBox, "%s \n", t.GetField(fieldData).Data)
+ if c.Pref.EnableBell {
+ fmt.Println("\a")
+ }
+
+ _, _ = fmt.Fprintf(c.UI.chatBox, "%s \n", t.GetField(FieldData).Data)
return res, err
}
func handleClientTranUserAccess(c *Client, t *Transaction) (res []Transaction, err error) {
- c.UserAccess = t.GetField(fieldUserAccess).Data
+ c.UserAccess = t.GetField(FieldUserAccess).Data
return res, err
}
func handleClientTranShowAgreement(c *Client, t *Transaction) (res []Transaction, err error) {
- agreement := string(t.GetField(fieldData).Data)
+ agreement := string(t.GetField(FieldData).Data)
agreement = strings.ReplaceAll(agreement, "\r", "\n")
agreeModal := tview.NewModal().
if buttonIndex == 0 {
res = append(res,
*NewTransaction(
- tranAgreed, nil,
- NewField(fieldUserName, []byte(c.pref.Username)),
- NewField(fieldUserIconID, c.pref.IconBytes()),
- NewField(fieldUserFlags, []byte{0x00, 0x00}),
- NewField(fieldOptions, []byte{0x00, 0x00}),
+ TranAgreed, nil,
+ NewField(FieldUserName, []byte(c.Pref.Username)),
+ NewField(FieldUserIconID, c.Pref.IconBytes()),
+ NewField(FieldUserFlags, []byte{0x00, 0x00}),
+ NewField(FieldOptions, []byte{0x00, 0x00}),
),
)
c.UI.Pages.HidePage("agreement")
func handleClientTranLogin(c *Client, t *Transaction) (res []Transaction, err error) {
if !bytes.Equal(t.ErrorCode, []byte{0, 0, 0, 0}) {
- errMsg := string(t.GetField(fieldError).Data)
+ errMsg := string(t.GetField(FieldError).Data)
errModal := tview.NewModal()
errModal.SetText(errMsg)
errModal.AddButtons([]string{"Oh no"})
c.UI.App.Draw() // TODO: errModal doesn't render without this. wtf?
- c.Logger.Error(string(t.GetField(fieldError).Data))
- return nil, errors.New("login error: " + string(t.GetField(fieldError).Data))
+ c.Logger.Error(string(t.GetField(FieldError).Data))
+ return nil, errors.New("login error: " + string(t.GetField(FieldError).Data))
}
c.UI.Pages.AddAndSwitchToPage(serverUIPage, c.UI.renderServerUI(), true)
c.UI.App.SetFocus(c.UI.chatInput)
- if err := c.Send(*NewTransaction(tranGetUserNameList, nil)); err != nil {
+ if err := c.Send(*NewTransaction(TranGetUserNameList, nil)); err != nil {
c.Logger.Errorw("err", "err", err)
}
return res, err
}
// JoinServer connects to a Hotline server and completes the login flow
-func (c *Client) JoinServer(address, login, passwd string) error {
+func (c *Client) Connect(address, login, passwd string) (err error) {
// Establish TCP connection to server
- if err := c.connect(address); err != nil {
+ c.Connection, err = net.DialTimeout("tcp", address, 5*time.Second)
+ if err != nil {
return err
}
return err
}
- // Authenticate (send tranLogin 107)
+ // Authenticate (send TranLogin 107)
if err := c.LogIn(login, passwd); err != nil {
return err
}
return nil
}
+const keepaliveInterval = 300 * time.Second
+
func (c *Client) keepalive() error {
for {
- time.Sleep(300 * time.Second)
- _ = c.Send(*NewTransaction(tranKeepAlive, nil))
- c.Logger.Infow("Sent keepalive ping")
+ time.Sleep(keepaliveInterval)
+ _ = c.Send(*NewTransaction(TranKeepAlive, nil))
+ c.Logger.Debugw("Sent keepalive ping")
}
}
-// connect establishes a connection with a Server by sending handshake sequence
-func (c *Client) connect(address string) error {
- var err error
- c.Connection, err = net.DialTimeout("tcp", address, 5*time.Second)
- if err != nil {
- return err
- }
- return nil
-}
-
var ClientHandshake = []byte{
0x54, 0x52, 0x54, 0x50, // TRTP
0x48, 0x4f, 0x54, 0x4c, // HOTL
func (c *Client) LogIn(login string, password string) error {
return c.Send(
*NewTransaction(
- tranLogin, nil,
- NewField(fieldUserName, []byte(c.pref.Username)),
- NewField(fieldUserIconID, c.pref.IconBytes()),
- NewField(fieldUserLogin, negateString([]byte(login))),
- NewField(fieldUserPassword, negateString([]byte(password))),
- NewField(fieldVersion, []byte{0, 2}),
+ TranLogin, nil,
+ NewField(FieldUserName, []byte(c.Pref.Username)),
+ NewField(FieldUserIconID, c.Pref.IconBytes()),
+ NewField(FieldUserLogin, negateString([]byte(login))),
+ NewField(FieldUserPassword, negateString([]byte(password))),
),
)
}
func (c *Client) Send(t Transaction) error {
requestNum := binary.BigEndian.Uint16(t.Type)
- tID := binary.BigEndian.Uint32(t.ID)
-
- // handler := TransactionHandlers[requestNum]
// if transaction is NOT reply, add it to the list to transactions we're expecting a response for
if t.IsReply == 0 {
- c.activeTasks[tID] = &t
+ c.activeTasks[binary.BigEndian.Uint32(t.ID)] = &t
}
- var n int
- var err error
b, err := t.MarshalBinary()
if err != nil {
return err
}
+
+ var n int
if n, err = c.Connection.Write(b); err != nil {
return err
}
t.Type = origT.Type
}
- requestNum := binary.BigEndian.Uint16(t.Type)
- c.Logger.Infow(
- "Received Transaction",
- "RequestType", requestNum,
- )
-
- if handler, ok := c.Handlers[requestNum]; ok {
- outT, _ := handler.Handle(c, t)
+ if handler, ok := c.Handlers[binary.BigEndian.Uint16(t.Type)]; ok {
+ outT, _ := handler(c, t)
for _, t := range outT {
- c.Send(t)
+ if err := c.Send(t); err != nil {
+ return err
+ }
}
} else {
- c.Logger.Errorw(
+ c.Logger.Debugw(
"Unimplemented transaction type received",
- "RequestID", requestNum,
+ "RequestID", t.Type,
"TransactionID", t.ID,
)
}
func (c *Client) Disconnect() error {
return c.Connection.Close()
}
+
+func (c *Client) HandleTransactions() error {
+ // Create a new scanner for parsing incoming bytes into transaction tokens
+ scanner := bufio.NewScanner(c.Connection)
+ scanner.Split(transactionScanner)
+
+ // Scan for new transactions and handle them as they come in.
+ for scanner.Scan() {
+ // 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 t Transaction
+ _, err := t.Write(buf)
+ if err != nil {
+ break
+ }
+ if err := c.HandleTransaction(&t); err != nil {
+ c.Logger.Errorw("Error handling transaction", "err", err)
+ }
+ }
+
+ if scanner.Err() == nil {
+ return scanner.Err()
+ }
+ return nil
+}
git.r.bdr.sh / rbdr / mobius / blobdiff