9 "github.com/gdamore/tcell/v2"
10 "github.com/rivo/tview"
11 "github.com/stretchr/testify/mock"
23 trackerListPage = "trackerList"
24 serverUIPage = "serverUI"
27 //go:embed banners/*.txt
28 var bannerDir embed.FS
30 type Bookmark struct {
31 Name string `yaml:"Name"`
32 Addr string `yaml:"Addr"`
33 Login string `yaml:"Login"`
34 Password string `yaml:"Password"`
37 type ClientPrefs struct {
38 Username string `yaml:"Username"`
39 IconID int `yaml:"IconID"`
40 Bookmarks []Bookmark `yaml:"Bookmarks"`
41 Tracker string `yaml:"Tracker"`
44 func (cp *ClientPrefs) IconBytes() []byte {
45 iconBytes := make([]byte, 2)
46 binary.BigEndian.PutUint16(iconBytes, uint16(cp.IconID))
50 func (cp *ClientPrefs) AddBookmark(name, addr, login, pass string) error {
51 cp.Bookmarks = append(cp.Bookmarks, Bookmark{Addr: addr, Login: login, Password: pass})
56 func readConfig(cfgPath string) (*ClientPrefs, error) {
57 fh, err := os.Open(cfgPath)
62 prefs := ClientPrefs{}
63 decoder := yaml.NewDecoder(fh)
64 decoder.SetStrict(true)
65 if err := decoder.Decode(&prefs); err != nil {
83 Logger *zap.SugaredLogger
84 activeTasks map[uint32]*Transaction
89 Handlers map[uint16]clientTHandler
93 Inbox chan *Transaction
96 func NewClient(cfgPath string, logger *zap.SugaredLogger) *Client {
100 activeTasks: make(map[uint32]*Transaction),
101 Handlers: clientHandlers,
105 prefs, err := readConfig(cfgPath)
107 fmt.Printf("unable to read config file %s", cfgPath)
115 // DebugBuffer wraps a *tview.TextView and adds a Sync() method to make it available as a Zap logger
116 type DebugBuffer struct {
117 TextView *tview.TextView
120 func (db *DebugBuffer) Write(p []byte) (int, error) {
121 return db.TextView.Write(p)
124 // Sync is a noop function that exists to satisfy the zapcore.WriteSyncer interface
125 func (db *DebugBuffer) Sync() error {
129 func randomBanner() string {
130 rand.Seed(time.Now().UnixNano())
132 bannerFiles, _ := bannerDir.ReadDir("banners")
133 file, _ := bannerDir.ReadFile("banners/" + bannerFiles[rand.Intn(len(bannerFiles))].Name())
135 return fmt.Sprintf("\n\n\nWelcome to...\n\n[red::b]%s[-:-:-]\n\n", file)
138 type clientTransaction struct {
140 Handler func(*Client, *Transaction) ([]Transaction, error)
143 func (ch clientTransaction) Handle(cc *Client, t *Transaction) ([]Transaction, error) {
144 return ch.Handler(cc, t)
147 type clientTHandler interface {
148 Handle(*Client, *Transaction) ([]Transaction, error)
151 type mockClientHandler struct {
155 func (mh *mockClientHandler) Handle(cc *Client, t *Transaction) ([]Transaction, error) {
156 args := mh.Called(cc, t)
157 return args.Get(0).([]Transaction), args.Error(1)
160 var clientHandlers = map[uint16]clientTHandler{
162 tranChatMsg: clientTransaction{
164 Handler: handleClientChatMsg,
166 tranLogin: clientTransaction{
168 Handler: handleClientTranLogin,
170 tranShowAgreement: clientTransaction{
171 Name: "tranShowAgreement",
172 Handler: handleClientTranShowAgreement,
174 tranUserAccess: clientTransaction{
175 Name: "tranUserAccess",
176 Handler: handleClientTranUserAccess,
178 tranGetUserNameList: clientTransaction{
179 Name: "tranGetUserNameList",
180 Handler: handleClientGetUserNameList,
182 tranNotifyChangeUser: clientTransaction{
183 Name: "tranNotifyChangeUser",
184 Handler: handleNotifyChangeUser,
186 tranNotifyDeleteUser: clientTransaction{
187 Name: "tranNotifyDeleteUser",
188 Handler: handleNotifyDeleteUser,
190 tranGetMsgs: clientTransaction{
191 Name: "tranNotifyDeleteUser",
192 Handler: handleGetMsgs,
194 tranGetFileNameList: clientTransaction{
195 Name: "tranGetFileNameList",
196 Handler: handleGetFileNameList,
198 tranServerMsg: clientTransaction{
199 Name: "tranServerMsg",
200 Handler: handleTranServerMsg,
202 tranKeepAlive: clientTransaction{
203 Name: "tranKeepAlive",
204 Handler: func(client *Client, transaction *Transaction) (t []Transaction, err error) {
210 func handleTranServerMsg(c *Client, t *Transaction) (res []Transaction, err error) {
211 time := time.Now().Format(time.RFC850)
213 msg := strings.ReplaceAll(string(t.GetField(fieldData).Data), "\r", "\n")
214 msg += "\n\nAt " + time
215 title := fmt.Sprintf("| Private Message From: %s |", t.GetField(fieldUserName).Data)
217 msgBox := tview.NewTextView().SetScrollable(true)
218 msgBox.SetText(msg).SetBackgroundColor(tcell.ColorDarkSlateBlue)
219 msgBox.SetTitle(title).SetBorder(true)
220 msgBox.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
222 case tcell.KeyEscape:
223 c.UI.Pages.RemovePage("serverMsgModal" + time)
228 centeredFlex := tview.NewFlex().
229 AddItem(nil, 0, 1, false).
230 AddItem(tview.NewFlex().SetDirection(tview.FlexRow).
231 AddItem(nil, 0, 1, false).
232 AddItem(msgBox, 0, 2, true).
233 AddItem(nil, 0, 1, false), 0, 2, true).
234 AddItem(nil, 0, 1, false)
236 c.UI.Pages.AddPage("serverMsgModal"+time, centeredFlex, true, true)
237 c.UI.App.Draw() // TODO: errModal doesn't render without this. wtf?
242 func handleGetFileNameList(c *Client, t *Transaction) (res []Transaction, err error) {
243 fTree := tview.NewTreeView().SetTopLevel(1)
244 root := tview.NewTreeNode("Root")
245 fTree.SetRoot(root).SetCurrentNode(root)
246 fTree.SetBorder(true).SetTitle("| Files |")
247 fTree.SetInputCapture(func(event *tcell.EventKey) *tcell.EventKey {
249 case tcell.KeyEscape:
250 c.UI.Pages.RemovePage("files")
251 c.filePath = []string{}
253 selectedNode := fTree.GetCurrentNode()
255 if selectedNode.GetText() == "<- Back" {
256 c.filePath = c.filePath[:len(c.filePath)-1]
257 f := NewField(fieldFilePath, EncodeFilePath(strings.Join(c.filePath, "/")))
259 if err := c.UI.HLClient.Send(*NewTransaction(tranGetFileNameList, nil, f)); err != nil {
260 c.UI.HLClient.Logger.Errorw("err", "err", err)
265 entry := selectedNode.GetReference().(*FileNameWithInfo)
267 if bytes.Equal(entry.Type[:], []byte("fldr")) {
268 c.Logger.Infow("get new directory listing", "name", string(entry.name))
270 c.filePath = append(c.filePath, string(entry.name))
271 f := NewField(fieldFilePath, EncodeFilePath(strings.Join(c.filePath, "/")))
273 if err := c.UI.HLClient.Send(*NewTransaction(tranGetFileNameList, nil, f)); err != nil {
274 c.UI.HLClient.Logger.Errorw("err", "err", err)
277 // TODO: initiate file download
278 c.Logger.Infow("download file", "name", string(entry.name))
285 if len(c.filePath) > 0 {
286 node := tview.NewTreeNode("<- Back")
290 for _, f := range t.Fields {
291 var fn FileNameWithInfo
292 err = fn.UnmarshalBinary(f.Data)
297 if bytes.Equal(fn.Type[:], []byte("fldr")) {
298 node := tview.NewTreeNode(fmt.Sprintf("[blue::]📁 %s[-:-:-]", fn.name))
299 node.SetReference(&fn)
302 size := binary.BigEndian.Uint32(fn.FileSize[:]) / 1024
304 node := tview.NewTreeNode(fmt.Sprintf(" %-40s %10v KB", fn.name, size))
305 node.SetReference(&fn)
311 centerFlex := tview.NewFlex().
312 AddItem(nil, 0, 1, false).
313 AddItem(tview.NewFlex().
314 SetDirection(tview.FlexRow).
315 AddItem(nil, 0, 1, false).
316 AddItem(fTree, 20, 1, true).
317 AddItem(nil, 0, 1, false), 60, 1, true).
318 AddItem(nil, 0, 1, false)
320 c.UI.Pages.AddPage("files", centerFlex, true, true)
326 func handleGetMsgs(c *Client, t *Transaction) (res []Transaction, err error) {
327 newsText := string(t.GetField(fieldData).Data)
328 newsText = strings.ReplaceAll(newsText, "\r", "\n")
330 newsTextView := tview.NewTextView().
332 SetDoneFunc(func(key tcell.Key) {
333 c.UI.Pages.SwitchToPage(serverUIPage)
334 c.UI.App.SetFocus(c.UI.chatInput)
336 newsTextView.SetBorder(true).SetTitle("News")
338 c.UI.Pages.AddPage("news", newsTextView, true, true)
339 // c.UI.Pages.SwitchToPage("news")
340 // c.UI.App.SetFocus(newsTextView)
346 func handleNotifyChangeUser(c *Client, t *Transaction) (res []Transaction, err error) {
348 ID: t.GetField(fieldUserID).Data,
349 Name: string(t.GetField(fieldUserName).Data),
350 Icon: t.GetField(fieldUserIconID).Data,
351 Flags: t.GetField(fieldUserFlags).Data,
355 // user is new to the server
356 // user is already on the server but has a new name
359 var newUserList []User
361 for _, u := range c.UserList {
362 c.Logger.Debugw("Comparing Users", "userToUpdate", newUser.ID, "myID", u.ID, "userToUpdateName", newUser.Name, "myname", u.Name)
363 if bytes.Equal(newUser.ID, u.ID) {
365 u.Name = newUser.Name
366 if u.Name != newUser.Name {
367 _, _ = fmt.Fprintf(c.UI.chatBox, " <<< "+oldName+" is now known as "+newUser.Name+" >>>\n")
371 newUserList = append(newUserList, u)
375 newUserList = append(newUserList, newUser)
378 c.UserList = newUserList
385 func handleNotifyDeleteUser(c *Client, t *Transaction) (res []Transaction, err error) {
386 exitUser := t.GetField(fieldUserID).Data
388 var newUserList []User
389 for _, u := range c.UserList {
390 if !bytes.Equal(exitUser, u.ID) {
391 newUserList = append(newUserList, u)
395 c.UserList = newUserList
402 const readBuffSize = 1024000 // 1KB - TODO: what should this be?
404 func (c *Client) ReadLoop() error {
405 tranBuff := make([]byte, 0)
407 // Infinite loop where take action on incoming client requests until the connection is closed
409 buf := make([]byte, readBuffSize)
410 tranBuff = tranBuff[tReadlen:]
412 readLen, err := c.Connection.Read(buf)
416 tranBuff = append(tranBuff, buf[:readLen]...)
418 // We may have read multiple requests worth of bytes from Connection.Read. readTransactions splits them
419 // into a slice of transactions
420 var transactions []Transaction
421 if transactions, tReadlen, err = readTransactions(tranBuff); err != nil {
422 c.Logger.Errorw("Error handling transaction", "err", err)
425 // iterate over all of the transactions that were parsed from the byte slice and handle them
426 for _, t := range transactions {
427 if err := c.HandleTransaction(&t); err != nil {
428 c.Logger.Errorw("Error handling transaction", "err", err)
434 func (c *Client) GetTransactions() error {
435 tranBuff := make([]byte, 0)
438 buf := make([]byte, readBuffSize)
439 tranBuff = tranBuff[tReadlen:]
441 readLen, err := c.Connection.Read(buf)
445 tranBuff = append(tranBuff, buf[:readLen]...)
450 func handleClientGetUserNameList(c *Client, t *Transaction) (res []Transaction, err error) {
452 for _, field := range t.Fields {
453 // The Hotline protocol docs say that ClientGetUserNameList should only return fieldUsernameWithInfo (300)
454 // fields, but shxd sneaks in fieldChatSubject (115) so it's important to filter explicitly for the expected
455 // field type. Probably a good idea to do everywhere.
456 if bytes.Equal(field.ID, []byte{0x01, 0x2c}) {
457 u, err := ReadUser(field.Data)
461 users = append(users, *u)
471 func (c *Client) renderUserList() {
472 c.UI.userList.Clear()
473 for _, u := range c.UserList {
474 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(u.Flags)))
475 if flagBitmap.Bit(userFlagAdmin) == 1 {
476 _, _ = fmt.Fprintf(c.UI.userList, "[red::b]%s[-:-:-]\n", u.Name)
478 _, _ = fmt.Fprintf(c.UI.userList, "%s\n", u.Name)
480 // TODO: fade if user is away
484 func handleClientChatMsg(c *Client, t *Transaction) (res []Transaction, err error) {
485 _, _ = fmt.Fprintf(c.UI.chatBox, "%s \n", t.GetField(fieldData).Data)
490 func handleClientTranUserAccess(c *Client, t *Transaction) (res []Transaction, err error) {
491 c.UserAccess = t.GetField(fieldUserAccess).Data
496 func handleClientTranShowAgreement(c *Client, t *Transaction) (res []Transaction, err error) {
497 agreement := string(t.GetField(fieldData).Data)
498 agreement = strings.ReplaceAll(agreement, "\r", "\n")
500 agreeModal := tview.NewModal().
502 AddButtons([]string{"Agree", "Disagree"}).
503 SetDoneFunc(func(buttonIndex int, buttonLabel string) {
504 if buttonIndex == 0 {
508 NewField(fieldUserName, []byte(c.pref.Username)),
509 NewField(fieldUserIconID, c.pref.IconBytes()),
510 NewField(fieldUserFlags, []byte{0x00, 0x00}),
511 NewField(fieldOptions, []byte{0x00, 0x00}),
514 c.UI.Pages.HidePage("agreement")
515 c.UI.App.SetFocus(c.UI.chatInput)
518 c.UI.Pages.SwitchToPage("home")
523 c.UI.Pages.AddPage("agreement", agreeModal, false, true)
528 func handleClientTranLogin(c *Client, t *Transaction) (res []Transaction, err error) {
529 if !bytes.Equal(t.ErrorCode, []byte{0, 0, 0, 0}) {
530 errMsg := string(t.GetField(fieldError).Data)
531 errModal := tview.NewModal()
532 errModal.SetText(errMsg)
533 errModal.AddButtons([]string{"Oh no"})
534 errModal.SetDoneFunc(func(buttonIndex int, buttonLabel string) {
535 c.UI.Pages.RemovePage("errModal")
537 c.UI.Pages.RemovePage("joinServer")
538 c.UI.Pages.AddPage("errModal", errModal, false, true)
540 c.UI.App.Draw() // TODO: errModal doesn't render without this. wtf?
542 c.Logger.Error(string(t.GetField(fieldError).Data))
543 return nil, errors.New("login error: " + string(t.GetField(fieldError).Data))
545 c.UI.Pages.AddAndSwitchToPage(serverUIPage, c.UI.renderServerUI(), true)
546 c.UI.App.SetFocus(c.UI.chatInput)
548 if err := c.Send(*NewTransaction(tranGetUserNameList, nil)); err != nil {
549 c.Logger.Errorw("err", "err", err)
554 // JoinServer connects to a Hotline server and completes the login flow
555 func (c *Client) JoinServer(address, login, passwd string) error {
556 // Establish TCP connection to server
557 if err := c.connect(address); err != nil {
561 // Send handshake sequence
562 if err := c.Handshake(); err != nil {
566 // Authenticate (send tranLogin 107)
567 if err := c.LogIn(login, passwd); err != nil {
571 // start keepalive go routine
572 go func() { _ = c.keepalive() }()
577 func (c *Client) keepalive() error {
579 time.Sleep(300 * time.Second)
580 _ = c.Send(*NewTransaction(tranKeepAlive, nil))
581 c.Logger.Infow("Sent keepalive ping")
585 // connect establishes a connection with a Server by sending handshake sequence
586 func (c *Client) connect(address string) error {
588 c.Connection, err = net.DialTimeout("tcp", address, 5*time.Second)
595 var ClientHandshake = []byte{
596 0x54, 0x52, 0x54, 0x50, // TRTP
597 0x48, 0x4f, 0x54, 0x4c, // HOTL
602 var ServerHandshake = []byte{
603 0x54, 0x52, 0x54, 0x50, // TRTP
604 0x00, 0x00, 0x00, 0x00, // ErrorCode
607 func (c *Client) Handshake() error {
608 // Protocol ID 4 ‘TRTP’ 0x54 52 54 50
609 // Sub-protocol ID 4 User defined
610 // Version 2 1 Currently 1
611 // Sub-version 2 User defined
612 if _, err := c.Connection.Write(ClientHandshake); err != nil {
613 return fmt.Errorf("handshake write err: %s", err)
616 replyBuf := make([]byte, 8)
617 _, err := c.Connection.Read(replyBuf)
622 if bytes.Equal(replyBuf, ServerHandshake) {
626 // In the case of an error, client and server close the connection.
627 return fmt.Errorf("handshake response err: %s", err)
630 func (c *Client) LogIn(login string, password string) error {
634 NewField(fieldUserName, []byte(c.pref.Username)),
635 NewField(fieldUserIconID, c.pref.IconBytes()),
636 NewField(fieldUserLogin, negateString([]byte(login))),
637 NewField(fieldUserPassword, negateString([]byte(password))),
638 NewField(fieldVersion, []byte{0, 2}),
643 func (c *Client) Send(t Transaction) error {
644 requestNum := binary.BigEndian.Uint16(t.Type)
645 tID := binary.BigEndian.Uint32(t.ID)
647 // handler := TransactionHandlers[requestNum]
649 // if transaction is NOT reply, add it to the list to transactions we're expecting a response for
651 c.activeTasks[tID] = &t
656 b, err := t.MarshalBinary()
660 if n, err = c.Connection.Write(b); err != nil {
663 c.Logger.Debugw("Sent Transaction",
664 "IsReply", t.IsReply,
671 func (c *Client) HandleTransaction(t *Transaction) error {
672 var origT Transaction
674 requestID := binary.BigEndian.Uint32(t.ID)
675 origT = *c.activeTasks[requestID]
679 requestNum := binary.BigEndian.Uint16(t.Type)
681 "Received Transaction",
682 "RequestType", requestNum,
685 if handler, ok := c.Handlers[requestNum]; ok {
686 outT, _ := handler.Handle(c, t)
687 for _, t := range outT {
692 "Unimplemented transaction type received",
693 "RequestID", requestNum,
694 "TransactionID", t.ID,
701 func (c *Client) Disconnect() error {
702 return c.Connection.Close()