git.r.bdr.sh - rbdr/mobius/blob - hotline/transaction_handlers.go

   1 package hotline
   2
   3 import (
   4         "bytes"
   5         "encoding/binary"
   6         "errors"
   7         "fmt"
   8         "gopkg.in/yaml.v3"
   9         "math/big"
  10         "os"
  11         "path"
  12         "path/filepath"
  13         "sort"
  14         "strings"
  15         "time"
  16 )
  17
  18 type HandlerFunc func(*ClientConn, *Transaction) ([]Transaction, error)
  19
  20 type TransactionType struct {
  21         Handler        HandlerFunc // function for handling the transaction type
  22         Name           string      // Name of transaction as it will appear in logging
  23         RequiredFields []requiredField
  24 }
  25
  26 var TransactionHandlers = map[uint16]TransactionType{
  27         // Server initiated
  28         TranChatMsg: {
  29                 Name: "TranChatMsg",
  30         },
  31         // Server initiated
  32         TranNotifyChangeUser: {
  33                 Name: "TranNotifyChangeUser",
  34         },
  35         TranError: {
  36                 Name: "TranError",
  37         },
  38         TranShowAgreement: {
  39                 Name: "TranShowAgreement",
  40         },
  41         TranUserAccess: {
  42                 Name: "TranUserAccess",
  43         },
  44         TranNotifyDeleteUser: {
  45                 Name: "TranNotifyDeleteUser",
  46         },
  47         TranAgreed: {
  48                 Name:    "TranAgreed",
  49                 Handler: HandleTranAgreed,
  50         },
  51         TranChatSend: {
  52                 Name:    "TranChatSend",
  53                 Handler: HandleChatSend,
  54                 RequiredFields: []requiredField{
  55                         {
  56                                 ID:     FieldData,
  57                                 minLen: 0,
  58                         },
  59                 },
  60         },
  61         TranDelNewsArt: {
  62                 Name:    "TranDelNewsArt",
  63                 Handler: HandleDelNewsArt,
  64         },
  65         TranDelNewsItem: {
  66                 Name:    "TranDelNewsItem",
  67                 Handler: HandleDelNewsItem,
  68         },
  69         TranDeleteFile: {
  70                 Name:    "TranDeleteFile",
  71                 Handler: HandleDeleteFile,
  72         },
  73         TranDeleteUser: {
  74                 Name:    "TranDeleteUser",
  75                 Handler: HandleDeleteUser,
  76         },
  77         TranDisconnectUser: {
  78                 Name:    "TranDisconnectUser",
  79                 Handler: HandleDisconnectUser,
  80         },
  81         TranDownloadFile: {
  82                 Name:    "TranDownloadFile",
  83                 Handler: HandleDownloadFile,
  84         },
  85         TranDownloadFldr: {
  86                 Name:    "TranDownloadFldr",
  87                 Handler: HandleDownloadFolder,
  88         },
  89         TranGetClientInfoText: {
  90                 Name:    "TranGetClientInfoText",
  91                 Handler: HandleGetClientInfoText,
  92         },
  93         TranGetFileInfo: {
  94                 Name:    "TranGetFileInfo",
  95                 Handler: HandleGetFileInfo,
  96         },
  97         TranGetFileNameList: {
  98                 Name:    "TranGetFileNameList",
  99                 Handler: HandleGetFileNameList,
 100         },
 101         TranGetMsgs: {
 102                 Name:    "TranGetMsgs",
 103                 Handler: HandleGetMsgs,
 104         },
 105         TranGetNewsArtData: {
 106                 Name:    "TranGetNewsArtData",
 107                 Handler: HandleGetNewsArtData,
 108         },
 109         TranGetNewsArtNameList: {
 110                 Name:    "TranGetNewsArtNameList",
 111                 Handler: HandleGetNewsArtNameList,
 112         },
 113         TranGetNewsCatNameList: {
 114                 Name:    "TranGetNewsCatNameList",
 115                 Handler: HandleGetNewsCatNameList,
 116         },
 117         TranGetUser: {
 118                 Name:    "TranGetUser",
 119                 Handler: HandleGetUser,
 120         },
 121         TranGetUserNameList: {
 122                 Name:    "tranHandleGetUserNameList",
 123                 Handler: HandleGetUserNameList,
 124         },
 125         TranInviteNewChat: {
 126                 Name:    "TranInviteNewChat",
 127                 Handler: HandleInviteNewChat,
 128         },
 129         TranInviteToChat: {
 130                 Name:    "TranInviteToChat",
 131                 Handler: HandleInviteToChat,
 132         },
 133         TranJoinChat: {
 134                 Name:    "TranJoinChat",
 135                 Handler: HandleJoinChat,
 136         },
 137         TranKeepAlive: {
 138                 Name:    "TranKeepAlive",
 139                 Handler: HandleKeepAlive,
 140         },
 141         TranLeaveChat: {
 142                 Name:    "TranJoinChat",
 143                 Handler: HandleLeaveChat,
 144         },
 145         TranListUsers: {
 146                 Name:    "TranListUsers",
 147                 Handler: HandleListUsers,
 148         },
 149         TranMoveFile: {
 150                 Name:    "TranMoveFile",
 151                 Handler: HandleMoveFile,
 152         },
 153         TranNewFolder: {
 154                 Name:    "TranNewFolder",
 155                 Handler: HandleNewFolder,
 156         },
 157         TranNewNewsCat: {
 158                 Name:    "TranNewNewsCat",
 159                 Handler: HandleNewNewsCat,
 160         },
 161         TranNewNewsFldr: {
 162                 Name:    "TranNewNewsFldr",
 163                 Handler: HandleNewNewsFldr,
 164         },
 165         TranNewUser: {
 166                 Name:    "TranNewUser",
 167                 Handler: HandleNewUser,
 168         },
 169         TranUpdateUser: {
 170                 Name:    "TranUpdateUser",
 171                 Handler: HandleUpdateUser,
 172         },
 173         TranOldPostNews: {
 174                 Name:    "TranOldPostNews",
 175                 Handler: HandleTranOldPostNews,
 176         },
 177         TranPostNewsArt: {
 178                 Name:    "TranPostNewsArt",
 179                 Handler: HandlePostNewsArt,
 180         },
 181         TranRejectChatInvite: {
 182                 Name:    "TranRejectChatInvite",
 183                 Handler: HandleRejectChatInvite,
 184         },
 185         TranSendInstantMsg: {
 186                 Name:    "TranSendInstantMsg",
 187                 Handler: HandleSendInstantMsg,
 188                 RequiredFields: []requiredField{
 189                         {
 190                                 ID:     FieldData,
 191                                 minLen: 0,
 192                         },
 193                         {
 194                                 ID: FieldUserID,
 195                         },
 196                 },
 197         },
 198         TranSetChatSubject: {
 199                 Name:    "TranSetChatSubject",
 200                 Handler: HandleSetChatSubject,
 201         },
 202         TranMakeFileAlias: {
 203                 Name:    "TranMakeFileAlias",
 204                 Handler: HandleMakeAlias,
 205                 RequiredFields: []requiredField{
 206                         {ID: FieldFileName, minLen: 1},
 207                         {ID: FieldFilePath, minLen: 1},
 208                         {ID: FieldFileNewPath, minLen: 1},
 209                 },
 210         },
 211         TranSetClientUserInfo: {
 212                 Name:    "TranSetClientUserInfo",
 213                 Handler: HandleSetClientUserInfo,
 214         },
 215         TranSetFileInfo: {
 216                 Name:    "TranSetFileInfo",
 217                 Handler: HandleSetFileInfo,
 218         },
 219         TranSetUser: {
 220                 Name:    "TranSetUser",
 221                 Handler: HandleSetUser,
 222         },
 223         TranUploadFile: {
 224                 Name:    "TranUploadFile",
 225                 Handler: HandleUploadFile,
 226         },
 227         TranUploadFldr: {
 228                 Name:    "TranUploadFldr",
 229                 Handler: HandleUploadFolder,
 230         },
 231         TranUserBroadcast: {
 232                 Name:    "TranUserBroadcast",
 233                 Handler: HandleUserBroadcast,
 234         },
 235         TranDownloadBanner: {
 236                 Name:    "TranDownloadBanner",
 237                 Handler: HandleDownloadBanner,
 238         },
 239 }
 240
 241 func HandleChatSend(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 242         if !cc.Authorize(accessSendChat) {
 243                 res = append(res, cc.NewErrReply(t, "You are not allowed to participate in chat."))
 244                 return res, err
 245         }
 246
 247         // Truncate long usernames
 248         trunc := fmt.Sprintf("%13s", cc.UserName)
 249         formattedMsg := fmt.Sprintf("\r%.14s:  %s", trunc, t.GetField(FieldData).Data)
 250
 251         // By holding the option key, Hotline chat allows users to send /me formatted messages like:
 252         // *** Halcyon does stuff
 253         // This is indicated by the presence of the optional field FieldChatOptions set to a value of 1.
 254         // Most clients do not send this option for normal chat messages.
 255         if t.GetField(FieldChatOptions).Data != nil && bytes.Equal(t.GetField(FieldChatOptions).Data, []byte{0, 1}) {
 256                 formattedMsg = fmt.Sprintf("\r*** %s %s", cc.UserName, t.GetField(FieldData).Data)
 257         }
 258
 259         // The ChatID field is used to identify messages as belonging to a private chat.
 260         // All clients *except* Frogblast omit this field for public chat, but Frogblast sends a value of 00 00 00 00.
 261         chatID := t.GetField(FieldChatID).Data
 262         if chatID != nil && !bytes.Equal([]byte{0, 0, 0, 0}, chatID) {
 263                 chatInt := binary.BigEndian.Uint32(chatID)
 264                 privChat := cc.Server.PrivateChats[chatInt]
 265
 266                 clients := sortedClients(privChat.ClientConn)
 267
 268                 // send the message to all connected clients of the private chat
 269                 for _, c := range clients {
 270                         res = append(res, *NewTransaction(
 271                                 TranChatMsg,
 272                                 c.ID,
 273                                 NewField(FieldChatID, chatID),
 274                                 NewField(FieldData, []byte(formattedMsg)),
 275                         ))
 276                 }
 277                 return res, err
 278         }
 279
 280         for _, c := range sortedClients(cc.Server.Clients) {
 281                 // Filter out clients that do not have the read chat permission
 282                 if c.Authorize(accessReadChat) {
 283                         res = append(res, *NewTransaction(TranChatMsg, c.ID, NewField(FieldData, []byte(formattedMsg))))
 284                 }
 285         }
 286
 287         return res, err
 288 }
 289
 290 // HandleSendInstantMsg sends instant message to the user on the current server.
 291 // Fields used in the request:
 292 //
 293 //      103     User ID
 294 //      113     Options
 295 //              One of the following values:
 296 //              - User message (myOpt_UserMessage = 1)
 297 //              - Refuse message (myOpt_RefuseMessage = 2)
 298 //              - Refuse chat (myOpt_RefuseChat  = 3)
 299 //              - Automatic response (myOpt_AutomaticResponse = 4)"
 300 //      101     Data    Optional
 301 //      214     Quoting message Optional
 302 //
 303 // Fields used in the reply:
 304 // None
 305 func HandleSendInstantMsg(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 306         if !cc.Authorize(accessSendPrivMsg) {
 307                 res = append(res, cc.NewErrReply(t, "You are not allowed to send private messages."))
 308                 return res, err
 309         }
 310
 311         msg := t.GetField(FieldData)
 312         ID := t.GetField(FieldUserID)
 313
 314         reply := NewTransaction(
 315                 TranServerMsg,
 316                 &ID.Data,
 317                 NewField(FieldData, msg.Data),
 318                 NewField(FieldUserName, cc.UserName),
 319                 NewField(FieldUserID, *cc.ID),
 320                 NewField(FieldOptions, []byte{0, 1}),
 321         )
 322
 323         // Later versions of Hotline include the original message in the FieldQuotingMsg field so
 324         //  the receiving client can display both the received message and what it is in reply to
 325         if t.GetField(FieldQuotingMsg).Data != nil {
 326                 reply.Fields = append(reply.Fields, NewField(FieldQuotingMsg, t.GetField(FieldQuotingMsg).Data))
 327         }
 328
 329         id, _ := byteToInt(ID.Data)
 330         otherClient, ok := cc.Server.Clients[uint16(id)]
 331         if !ok {
 332                 return res, errors.New("invalid client ID")
 333         }
 334
 335         // Check if target user has "Refuse private messages" flag
 336         flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(otherClient.Flags)))
 337         if flagBitmap.Bit(userFLagRefusePChat) == 1 {
 338                 res = append(res,
 339                         *NewTransaction(
 340                                 TranServerMsg,
 341                                 cc.ID,
 342                                 NewField(FieldData, []byte(string(otherClient.UserName)+" does not accept private messages.")),
 343                                 NewField(FieldUserName, otherClient.UserName),
 344                                 NewField(FieldUserID, *otherClient.ID),
 345                                 NewField(FieldOptions, []byte{0, 2}),
 346                         ),
 347                 )
 348         } else {
 349                 res = append(res, *reply)
 350         }
 351
 352         // Respond with auto reply if other client has it enabled
 353         if len(otherClient.AutoReply) > 0 {
 354                 res = append(res,
 355                         *NewTransaction(
 356                                 TranServerMsg,
 357                                 cc.ID,
 358                                 NewField(FieldData, otherClient.AutoReply),
 359                                 NewField(FieldUserName, otherClient.UserName),
 360                                 NewField(FieldUserID, *otherClient.ID),
 361                                 NewField(FieldOptions, []byte{0, 1}),
 362                         ),
 363                 )
 364         }
 365
 366         res = append(res, cc.NewReply(t))
 367
 368         return res, err
 369 }
 370
 371 func HandleGetFileInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 372         fileName := t.GetField(FieldFileName).Data
 373         filePath := t.GetField(FieldFilePath).Data
 374
 375         fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
 376         if err != nil {
 377                 return res, err
 378         }
 379
 380         fw, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
 381         if err != nil {
 382                 return res, err
 383         }
 384
 385         res = append(res, cc.NewReply(t,
 386                 NewField(FieldFileName, []byte(fw.name)),
 387                 NewField(FieldFileTypeString, fw.ffo.FlatFileInformationFork.friendlyType()),
 388                 NewField(FieldFileCreatorString, fw.ffo.FlatFileInformationFork.friendlyCreator()),
 389                 NewField(FieldFileComment, fw.ffo.FlatFileInformationFork.Comment),
 390                 NewField(FieldFileType, fw.ffo.FlatFileInformationFork.TypeSignature),
 391                 NewField(FieldFileCreateDate, fw.ffo.FlatFileInformationFork.CreateDate),
 392                 NewField(FieldFileModifyDate, fw.ffo.FlatFileInformationFork.ModifyDate),
 393                 NewField(FieldFileSize, fw.totalSize()),
 394         ))
 395         return res, err
 396 }
 397
 398 // HandleSetFileInfo updates a file or folder name and/or comment from the Get Info window
 399 // Fields used in the request:
 400 // * 201        File name
 401 // * 202        File path       Optional
 402 // * 211        File new name   Optional
 403 // * 210        File comment    Optional
 404 // Fields used in the reply:    None
 405 func HandleSetFileInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 406         fileName := t.GetField(FieldFileName).Data
 407         filePath := t.GetField(FieldFilePath).Data
 408
 409         fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
 410         if err != nil {
 411                 return res, err
 412         }
 413
 414         fi, err := cc.Server.FS.Stat(fullFilePath)
 415         if err != nil {
 416                 return res, err
 417         }
 418
 419         hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
 420         if err != nil {
 421                 return res, err
 422         }
 423         if t.GetField(FieldFileComment).Data != nil {
 424                 switch mode := fi.Mode(); {
 425                 case mode.IsDir():
 426                         if !cc.Authorize(accessSetFolderComment) {
 427                                 res = append(res, cc.NewErrReply(t, "You are not allowed to set comments for folders."))
 428                                 return res, err
 429                         }
 430                 case mode.IsRegular():
 431                         if !cc.Authorize(accessSetFileComment) {
 432                                 res = append(res, cc.NewErrReply(t, "You are not allowed to set comments for files."))
 433                                 return res, err
 434                         }
 435                 }
 436
 437                 if err := hlFile.ffo.FlatFileInformationFork.setComment(t.GetField(FieldFileComment).Data); err != nil {
 438                         return res, err
 439                 }
 440                 w, err := hlFile.infoForkWriter()
 441                 if err != nil {
 442                         return res, err
 443                 }
 444                 _, err = w.Write(hlFile.ffo.FlatFileInformationFork.MarshalBinary())
 445                 if err != nil {
 446                         return res, err
 447                 }
 448         }
 449
 450         fullNewFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, t.GetField(FieldFileNewName).Data)
 451         if err != nil {
 452                 return nil, err
 453         }
 454
 455         fileNewName := t.GetField(FieldFileNewName).Data
 456
 457         if fileNewName != nil {
 458                 switch mode := fi.Mode(); {
 459                 case mode.IsDir():
 460                         if !cc.Authorize(accessRenameFolder) {
 461                                 res = append(res, cc.NewErrReply(t, "You are not allowed to rename folders."))
 462                                 return res, err
 463                         }
 464                         err = os.Rename(fullFilePath, fullNewFilePath)
 465                         if os.IsNotExist(err) {
 466                                 res = append(res, cc.NewErrReply(t, "Cannot rename folder "+string(fileName)+" because it does not exist or cannot be found."))
 467                                 return res, err
 468                         }
 469                 case mode.IsRegular():
 470                         if !cc.Authorize(accessRenameFile) {
 471                                 res = append(res, cc.NewErrReply(t, "You are not allowed to rename files."))
 472                                 return res, err
 473                         }
 474                         fileDir, err := readPath(cc.Server.Config.FileRoot, filePath, []byte{})
 475                         if err != nil {
 476                                 return nil, err
 477                         }
 478                         hlFile.name = string(fileNewName)
 479                         err = hlFile.move(fileDir)
 480                         if os.IsNotExist(err) {
 481                                 res = append(res, cc.NewErrReply(t, "Cannot rename file "+string(fileName)+" because it does not exist or cannot be found."))
 482                                 return res, err
 483                         }
 484                         if err != nil {
 485                                 return res, err
 486                         }
 487                 }
 488         }
 489
 490         res = append(res, cc.NewReply(t))
 491         return res, err
 492 }
 493
 494 // HandleDeleteFile deletes a file or folder
 495 // Fields used in the request:
 496 // * 201        File name
 497 // * 202        File path
 498 // Fields used in the reply: none
 499 func HandleDeleteFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 500         fileName := t.GetField(FieldFileName).Data
 501         filePath := t.GetField(FieldFilePath).Data
 502
 503         fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
 504         if err != nil {
 505                 return res, err
 506         }
 507
 508         hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
 509         if err != nil {
 510                 return res, err
 511         }
 512
 513         fi, err := hlFile.dataFile()
 514         if err != nil {
 515                 res = append(res, cc.NewErrReply(t, "Cannot delete file "+string(fileName)+" because it does not exist or cannot be found."))
 516                 return res, nil
 517         }
 518
 519         switch mode := fi.Mode(); {
 520         case mode.IsDir():
 521                 if !cc.Authorize(accessDeleteFolder) {
 522                         res = append(res, cc.NewErrReply(t, "You are not allowed to delete folders."))
 523                         return res, err
 524                 }
 525         case mode.IsRegular():
 526                 if !cc.Authorize(accessDeleteFile) {
 527                         res = append(res, cc.NewErrReply(t, "You are not allowed to delete files."))
 528                         return res, err
 529                 }
 530         }
 531
 532         if err := hlFile.delete(); err != nil {
 533                 return res, err
 534         }
 535
 536         res = append(res, cc.NewReply(t))
 537         return res, err
 538 }
 539
 540 // HandleMoveFile moves files or folders. Note: seemingly not documented
 541 func HandleMoveFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 542         fileName := string(t.GetField(FieldFileName).Data)
 543
 544         filePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(FieldFilePath).Data, t.GetField(FieldFileName).Data)
 545         if err != nil {
 546                 return res, err
 547         }
 548
 549         fileNewPath, err := readPath(cc.Server.Config.FileRoot, t.GetField(FieldFileNewPath).Data, nil)
 550         if err != nil {
 551                 return res, err
 552         }
 553
 554         cc.logger.Infow("Move file", "src", filePath+"/"+fileName, "dst", fileNewPath+"/"+fileName)
 555
 556         hlFile, err := newFileWrapper(cc.Server.FS, filePath, 0)
 557         if err != nil {
 558                 return res, err
 559         }
 560
 561         fi, err := hlFile.dataFile()
 562         if err != nil {
 563                 res = append(res, cc.NewErrReply(t, "Cannot delete file "+fileName+" because it does not exist or cannot be found."))
 564                 return res, err
 565         }
 566         if err != nil {
 567                 return res, err
 568         }
 569         switch mode := fi.Mode(); {
 570         case mode.IsDir():
 571                 if !cc.Authorize(accessMoveFolder) {
 572                         res = append(res, cc.NewErrReply(t, "You are not allowed to move folders."))
 573                         return res, err
 574                 }
 575         case mode.IsRegular():
 576                 if !cc.Authorize(accessMoveFile) {
 577                         res = append(res, cc.NewErrReply(t, "You are not allowed to move files."))
 578                         return res, err
 579                 }
 580         }
 581         if err := hlFile.move(fileNewPath); err != nil {
 582                 return res, err
 583         }
 584         // TODO: handle other possible errors; e.g. fileWrapper delete fails due to fileWrapper permission issue
 585
 586         res = append(res, cc.NewReply(t))
 587         return res, err
 588 }
 589
 590 func HandleNewFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 591         if !cc.Authorize(accessCreateFolder) {
 592                 res = append(res, cc.NewErrReply(t, "You are not allowed to create folders."))
 593                 return res, err
 594         }
 595         folderName := string(t.GetField(FieldFileName).Data)
 596
 597         folderName = path.Join("/", folderName)
 598
 599         var subPath string
 600
 601         // FieldFilePath is only present for nested paths
 602         if t.GetField(FieldFilePath).Data != nil {
 603                 var newFp FilePath
 604                 _, err := newFp.Write(t.GetField(FieldFilePath).Data)
 605                 if err != nil {
 606                         return nil, err
 607                 }
 608
 609                 for _, pathItem := range newFp.Items {
 610                         subPath = filepath.Join("/", subPath, string(pathItem.Name))
 611                 }
 612         }
 613         newFolderPath := path.Join(cc.Server.Config.FileRoot, subPath, folderName)
 614
 615         // TODO: check path and folder name lengths
 616
 617         if _, err := cc.Server.FS.Stat(newFolderPath); !os.IsNotExist(err) {
 618                 msg := fmt.Sprintf("Cannot create folder \"%s\" because there is already a file or folder with that name.", folderName)
 619                 return []Transaction{cc.NewErrReply(t, msg)}, nil
 620         }
 621
 622         // TODO: check for disallowed characters to maintain compatibility for original client
 623
 624         if err := cc.Server.FS.Mkdir(newFolderPath, 0777); err != nil {
 625                 msg := fmt.Sprintf("Cannot create folder \"%s\" because an error occurred.", folderName)
 626                 return []Transaction{cc.NewErrReply(t, msg)}, nil
 627         }
 628
 629         res = append(res, cc.NewReply(t))
 630         return res, err
 631 }
 632
 633 func HandleSetUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 634         if !cc.Authorize(accessModifyUser) {
 635                 res = append(res, cc.NewErrReply(t, "You are not allowed to modify accounts."))
 636                 return res, err
 637         }
 638
 639         login := DecodeUserString(t.GetField(FieldUserLogin).Data)
 640         userName := string(t.GetField(FieldUserName).Data)
 641
 642         newAccessLvl := t.GetField(FieldUserAccess).Data
 643
 644         account := cc.Server.Accounts[login]
 645         account.Name = userName
 646         copy(account.Access[:], newAccessLvl)
 647
 648         // If the password field is cleared in the Hotline edit user UI, the SetUser transaction does
 649         // not include FieldUserPassword
 650         if t.GetField(FieldUserPassword).Data == nil {
 651                 account.Password = hashAndSalt([]byte(""))
 652         }
 653         if len(t.GetField(FieldUserPassword).Data) > 1 {
 654                 account.Password = hashAndSalt(t.GetField(FieldUserPassword).Data)
 655         }
 656
 657         out, err := yaml.Marshal(&account)
 658         if err != nil {
 659                 return res, err
 660         }
 661         if err := os.WriteFile(filepath.Join(cc.Server.ConfigDir, "Users", login+".yaml"), out, 0666); err != nil {
 662                 return res, err
 663         }
 664
 665         // Notify connected clients logged in as the user of the new access level
 666         for _, c := range cc.Server.Clients {
 667                 if c.Account.Login == login {
 668                         // Note: comment out these two lines to test server-side deny messages
 669                         newT := NewTransaction(TranUserAccess, c.ID, NewField(FieldUserAccess, newAccessLvl))
 670                         res = append(res, *newT)
 671
 672                         flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(c.Flags)))
 673                         if c.Authorize(accessDisconUser) {
 674                                 flagBitmap.SetBit(flagBitmap, userFlagAdmin, 1)
 675                         } else {
 676                                 flagBitmap.SetBit(flagBitmap, userFlagAdmin, 0)
 677                         }
 678                         binary.BigEndian.PutUint16(c.Flags, uint16(flagBitmap.Int64()))
 679
 680                         c.Account.Access = account.Access
 681
 682                         cc.sendAll(
 683                                 TranNotifyChangeUser,
 684                                 NewField(FieldUserID, *c.ID),
 685                                 NewField(FieldUserFlags, c.Flags),
 686                                 NewField(FieldUserName, c.UserName),
 687                                 NewField(FieldUserIconID, c.Icon),
 688                         )
 689                 }
 690         }
 691
 692         res = append(res, cc.NewReply(t))
 693         return res, err
 694 }
 695
 696 func HandleGetUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 697         if !cc.Authorize(accessOpenUser) {
 698                 res = append(res, cc.NewErrReply(t, "You are not allowed to view accounts."))
 699                 return res, err
 700         }
 701
 702         account := cc.Server.Accounts[string(t.GetField(FieldUserLogin).Data)]
 703         if account == nil {
 704                 res = append(res, cc.NewErrReply(t, "Account does not exist."))
 705                 return res, err
 706         }
 707
 708         res = append(res, cc.NewReply(t,
 709                 NewField(FieldUserName, []byte(account.Name)),
 710                 NewField(FieldUserLogin, negateString(t.GetField(FieldUserLogin).Data)),
 711                 NewField(FieldUserPassword, []byte(account.Password)),
 712                 NewField(FieldUserAccess, account.Access[:]),
 713         ))
 714         return res, err
 715 }
 716
 717 func HandleListUsers(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 718         if !cc.Authorize(accessOpenUser) {
 719                 res = append(res, cc.NewErrReply(t, "You are not allowed to view accounts."))
 720                 return res, err
 721         }
 722
 723         var userFields []Field
 724         for _, acc := range cc.Server.Accounts {
 725                 b := make([]byte, 0, 100)
 726                 n, err := acc.Read(b)
 727                 if err != nil {
 728                         return res, err
 729                 }
 730
 731                 userFields = append(userFields, NewField(FieldData, b[:n]))
 732         }
 733
 734         res = append(res, cc.NewReply(t, userFields...))
 735         return res, err
 736 }
 737
 738 // HandleUpdateUser is used by the v1.5+ multi-user editor to perform account editing for multiple users at a time.
 739 // An update can be a mix of these actions:
 740 // * Create user
 741 // * Delete user
 742 // * Modify user (including renaming the account login)
 743 //
 744 // The Transaction sent by the client includes one data field per user that was modified.  This data field in turn
 745 // contains another data field encoded in its payload with a varying number of sub fields depending on which action is
 746 // performed.  This seems to be the only place in the Hotline protocol where a data field contains another data field.
 747 func HandleUpdateUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 748         for _, field := range t.Fields {
 749                 subFields, err := ReadFields(field.Data[0:2], field.Data[2:])
 750                 if err != nil {
 751                         return res, err
 752                 }
 753
 754                 if len(subFields) == 1 {
 755                         login := DecodeUserString(getField(FieldData, &subFields).Data)
 756                         cc.logger.Infow("DeleteUser", "login", login)
 757
 758                         if !cc.Authorize(accessDeleteUser) {
 759                                 res = append(res, cc.NewErrReply(t, "You are not allowed to delete accounts."))
 760                                 return res, err
 761                         }
 762
 763                         if err := cc.Server.DeleteUser(login); err != nil {
 764                                 return res, err
 765                         }
 766                         continue
 767                 }
 768
 769                 login := DecodeUserString(getField(FieldUserLogin, &subFields).Data)
 770
 771                 // check if the login dataFile; if so, we know we are updating an existing user
 772                 if acc, ok := cc.Server.Accounts[login]; ok {
 773                         cc.logger.Infow("UpdateUser", "login", login)
 774
 775                         // account dataFile, so this is an update action
 776                         if !cc.Authorize(accessModifyUser) {
 777                                 res = append(res, cc.NewErrReply(t, "You are not allowed to modify accounts."))
 778                                 return res, err
 779                         }
 780
 781                         if getField(FieldUserPassword, &subFields) != nil {
 782                                 newPass := getField(FieldUserPassword, &subFields).Data
 783                                 acc.Password = hashAndSalt(newPass)
 784                         } else {
 785                                 acc.Password = hashAndSalt([]byte(""))
 786                         }
 787
 788                         if getField(FieldUserAccess, &subFields) != nil {
 789                                 copy(acc.Access[:], getField(FieldUserAccess, &subFields).Data)
 790                         }
 791
 792                         err = cc.Server.UpdateUser(
 793                                 DecodeUserString(getField(FieldData, &subFields).Data),
 794                                 DecodeUserString(getField(FieldUserLogin, &subFields).Data),
 795                                 string(getField(FieldUserName, &subFields).Data),
 796                                 acc.Password,
 797                                 acc.Access,
 798                         )
 799                         if err != nil {
 800                                 return res, err
 801                         }
 802                 } else {
 803                         cc.logger.Infow("CreateUser", "login", login)
 804
 805                         if !cc.Authorize(accessCreateUser) {
 806                                 res = append(res, cc.NewErrReply(t, "You are not allowed to create new accounts."))
 807                                 return res, err
 808                         }
 809
 810                         newAccess := accessBitmap{}
 811                         copy(newAccess[:], getField(FieldUserAccess, &subFields).Data)
 812
 813                         // Prevent account from creating new account with greater permission
 814                         for i := 0; i < 64; i++ {
 815                                 if newAccess.IsSet(i) {
 816                                         if !cc.Authorize(i) {
 817                                                 return append(res, cc.NewErrReply(t, "Cannot create account with more access than yourself.")), err
 818                                         }
 819                                 }
 820                         }
 821
 822                         err := cc.Server.NewUser(login, string(getField(FieldUserName, &subFields).Data), string(getField(FieldUserPassword, &subFields).Data), newAccess)
 823                         if err != nil {
 824                                 return []Transaction{}, err
 825                         }
 826                 }
 827         }
 828
 829         res = append(res, cc.NewReply(t))
 830         return res, err
 831 }
 832
 833 // HandleNewUser creates a new user account
 834 func HandleNewUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 835         if !cc.Authorize(accessCreateUser) {
 836                 res = append(res, cc.NewErrReply(t, "You are not allowed to create new accounts."))
 837                 return res, err
 838         }
 839
 840         login := DecodeUserString(t.GetField(FieldUserLogin).Data)
 841
 842         // If the account already dataFile, reply with an error
 843         if _, ok := cc.Server.Accounts[login]; ok {
 844                 res = append(res, cc.NewErrReply(t, "Cannot create account "+login+" because there is already an account with that login."))
 845                 return res, err
 846         }
 847
 848         newAccess := accessBitmap{}
 849         copy(newAccess[:], t.GetField(FieldUserAccess).Data)
 850
 851         // Prevent account from creating new account with greater permission
 852         for i := 0; i < 64; i++ {
 853                 if newAccess.IsSet(i) {
 854                         if !cc.Authorize(i) {
 855                                 res = append(res, cc.NewErrReply(t, "Cannot create account with more access than yourself."))
 856                                 return res, err
 857                         }
 858                 }
 859         }
 860
 861         if err := cc.Server.NewUser(login, string(t.GetField(FieldUserName).Data), string(t.GetField(FieldUserPassword).Data), newAccess); err != nil {
 862                 return []Transaction{}, err
 863         }
 864
 865         res = append(res, cc.NewReply(t))
 866         return res, err
 867 }
 868
 869 func HandleDeleteUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 870         if !cc.Authorize(accessDeleteUser) {
 871                 res = append(res, cc.NewErrReply(t, "You are not allowed to delete accounts."))
 872                 return res, err
 873         }
 874
 875         // TODO: Handle case where account doesn't exist; e.g. delete race condition
 876         login := DecodeUserString(t.GetField(FieldUserLogin).Data)
 877
 878         if err := cc.Server.DeleteUser(login); err != nil {
 879                 return res, err
 880         }
 881
 882         res = append(res, cc.NewReply(t))
 883         return res, err
 884 }
 885
 886 // HandleUserBroadcast sends an Administrator Message to all connected clients of the server
 887 func HandleUserBroadcast(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 888         if !cc.Authorize(accessBroadcast) {
 889                 res = append(res, cc.NewErrReply(t, "You are not allowed to send broadcast messages."))
 890                 return res, err
 891         }
 892
 893         cc.sendAll(
 894                 TranServerMsg,
 895                 NewField(FieldData, t.GetField(TranGetMsgs).Data),
 896                 NewField(FieldChatOptions, []byte{0}),
 897         )
 898
 899         res = append(res, cc.NewReply(t))
 900         return res, err
 901 }
 902
 903 // HandleGetClientInfoText returns user information for the specific user.
 904 //
 905 // Fields used in the request:
 906 // 103  User ID
 907 //
 908 // Fields used in the reply:
 909 // 102  User name
 910 // 101  Data            User info text string
 911 func HandleGetClientInfoText(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 912         if !cc.Authorize(accessGetClientInfo) {
 913                 res = append(res, cc.NewErrReply(t, "You are not allowed to get client info."))
 914                 return res, err
 915         }
 916
 917         clientID, _ := byteToInt(t.GetField(FieldUserID).Data)
 918
 919         clientConn := cc.Server.Clients[uint16(clientID)]
 920         if clientConn == nil {
 921                 return append(res, cc.NewErrReply(t, "User not found.")), err
 922         }
 923
 924         res = append(res, cc.NewReply(t,
 925                 NewField(FieldData, []byte(clientConn.String())),
 926                 NewField(FieldUserName, clientConn.UserName),
 927         ))
 928         return res, err
 929 }
 930
 931 func HandleGetUserNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 932         res = append(res, cc.NewReply(t, cc.Server.connectedUsers()...))
 933
 934         return res, err
 935 }
 936
 937 func HandleTranAgreed(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 938         if t.GetField(FieldUserName).Data != nil {
 939                 if cc.Authorize(accessAnyName) {
 940                         cc.UserName = t.GetField(FieldUserName).Data
 941                 } else {
 942                         cc.UserName = []byte(cc.Account.Name)
 943                 }
 944         }
 945
 946         cc.Icon = t.GetField(FieldUserIconID).Data
 947
 948         cc.logger = cc.logger.With("name", string(cc.UserName))
 949         cc.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%v", func() int { i, _ := byteToInt(cc.Version); return i }()))
 950
 951         options := t.GetField(FieldOptions).Data
 952         optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
 953
 954         flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(cc.Flags)))
 955
 956         // Check refuse private PM option
 957         if optBitmap.Bit(refusePM) == 1 {
 958                 flagBitmap.SetBit(flagBitmap, userFlagRefusePM, 1)
 959                 binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
 960         }
 961
 962         // Check refuse private chat option
 963         if optBitmap.Bit(refuseChat) == 1 {
 964                 flagBitmap.SetBit(flagBitmap, userFLagRefusePChat, 1)
 965                 binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
 966         }
 967
 968         // Check auto response
 969         if optBitmap.Bit(autoResponse) == 1 {
 970                 cc.AutoReply = t.GetField(FieldAutomaticResponse).Data
 971         } else {
 972                 cc.AutoReply = []byte{}
 973         }
 974
 975         trans := cc.notifyOthers(
 976                 *NewTransaction(
 977                         TranNotifyChangeUser, nil,
 978                         NewField(FieldUserName, cc.UserName),
 979                         NewField(FieldUserID, *cc.ID),
 980                         NewField(FieldUserIconID, cc.Icon),
 981                         NewField(FieldUserFlags, cc.Flags),
 982                 ),
 983         )
 984         res = append(res, trans...)
 985
 986         if cc.Server.Config.BannerFile != "" {
 987                 res = append(res, *NewTransaction(TranServerBanner, cc.ID, NewField(FieldBannerType, []byte("JPEG"))))
 988         }
 989
 990         res = append(res, cc.NewReply(t))
 991
 992         return res, err
 993 }
 994
 995 // HandleTranOldPostNews updates the flat news
 996 // Fields used in this request:
 997 // 101  Data
 998 func HandleTranOldPostNews(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
 999         if !cc.Authorize(accessNewsPostArt) {
1000                 res = append(res, cc.NewErrReply(t, "You are not allowed to post news."))
1001                 return res, err
1002         }
1003
1004         cc.Server.flatNewsMux.Lock()
1005         defer cc.Server.flatNewsMux.Unlock()
1006
1007         newsDateTemplate := defaultNewsDateFormat
1008         if cc.Server.Config.NewsDateFormat != "" {
1009                 newsDateTemplate = cc.Server.Config.NewsDateFormat
1010         }
1011
1012         newsTemplate := defaultNewsTemplate
1013         if cc.Server.Config.NewsDelimiter != "" {
1014                 newsTemplate = cc.Server.Config.NewsDelimiter
1015         }
1016
1017         newsPost := fmt.Sprintf(newsTemplate+"\r", cc.UserName, time.Now().Format(newsDateTemplate), t.GetField(FieldData).Data)
1018         newsPost = strings.ReplaceAll(newsPost, "\n", "\r")
1019
1020         // update news in memory
1021         cc.Server.FlatNews = append([]byte(newsPost), cc.Server.FlatNews...)
1022
1023         // update news on disk
1024         if err := cc.Server.FS.WriteFile(filepath.Join(cc.Server.ConfigDir, "MessageBoard.txt"), cc.Server.FlatNews, 0644); err != nil {
1025                 return res, err
1026         }
1027
1028         // Notify all clients of updated news
1029         cc.sendAll(
1030                 TranNewMsg,
1031                 NewField(FieldData, []byte(newsPost)),
1032         )
1033
1034         res = append(res, cc.NewReply(t))
1035         return res, err
1036 }
1037
1038 func HandleDisconnectUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1039         if !cc.Authorize(accessDisconUser) {
1040                 res = append(res, cc.NewErrReply(t, "You are not allowed to disconnect users."))
1041                 return res, err
1042         }
1043
1044         clientConn := cc.Server.Clients[binary.BigEndian.Uint16(t.GetField(FieldUserID).Data)]
1045
1046         if clientConn.Authorize(accessCannotBeDiscon) {
1047                 res = append(res, cc.NewErrReply(t, clientConn.Account.Login+" is not allowed to be disconnected."))
1048                 return res, err
1049         }
1050
1051         // If FieldOptions is set, then the client IP is banned in addition to disconnected.
1052         // 00 01 = temporary ban
1053         // 00 02 = permanent ban
1054         if t.GetField(FieldOptions).Data != nil {
1055                 switch t.GetField(FieldOptions).Data[1] {
1056                 case 1:
1057                         // send message: "You are temporarily banned on this server"
1058                         cc.logger.Infow("Disconnect & temporarily ban " + string(clientConn.UserName))
1059
1060                         res = append(res, *NewTransaction(
1061                                 TranServerMsg,
1062                                 clientConn.ID,
1063                                 NewField(FieldData, []byte("You are temporarily banned on this server")),
1064                                 NewField(FieldChatOptions, []byte{0, 0}),
1065                         ))
1066
1067                         banUntil := time.Now().Add(tempBanDuration)
1068                         cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = &banUntil
1069                         cc.Server.writeBanList()
1070                 case 2:
1071                         // send message: "You are permanently banned on this server"
1072                         cc.logger.Infow("Disconnect & ban " + string(clientConn.UserName))
1073
1074                         res = append(res, *NewTransaction(
1075                                 TranServerMsg,
1076                                 clientConn.ID,
1077                                 NewField(FieldData, []byte("You are permanently banned on this server")),
1078                                 NewField(FieldChatOptions, []byte{0, 0}),
1079                         ))
1080
1081                         cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = nil
1082                         cc.Server.writeBanList()
1083                 }
1084         }
1085
1086         // TODO: remove this awful hack
1087         go func() {
1088                 time.Sleep(1 * time.Second)
1089                 clientConn.Disconnect()
1090         }()
1091
1092         return append(res, cc.NewReply(t)), err
1093 }
1094
1095 // HandleGetNewsCatNameList returns a list of news categories for a path
1096 // Fields used in the request:
1097 // 325  News path       (Optional)
1098 func HandleGetNewsCatNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1099         if !cc.Authorize(accessNewsReadArt) {
1100                 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1101                 return res, err
1102         }
1103
1104         pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
1105         cats := cc.Server.GetNewsCatByPath(pathStrs)
1106
1107         // To store the keys in slice in sorted order
1108         keys := make([]string, len(cats))
1109         i := 0
1110         for k := range cats {
1111                 keys[i] = k
1112                 i++
1113         }
1114         sort.Strings(keys)
1115
1116         var fieldData []Field
1117         for _, k := range keys {
1118                 cat := cats[k]
1119                 b, _ := cat.MarshalBinary()
1120                 fieldData = append(fieldData, NewField(
1121                         FieldNewsCatListData15,
1122                         b,
1123                 ))
1124         }
1125
1126         res = append(res, cc.NewReply(t, fieldData...))
1127         return res, err
1128 }
1129
1130 func HandleNewNewsCat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1131         if !cc.Authorize(accessNewsCreateCat) {
1132                 res = append(res, cc.NewErrReply(t, "You are not allowed to create news categories."))
1133                 return res, err
1134         }
1135
1136         name := string(t.GetField(FieldNewsCatName).Data)
1137         pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
1138
1139         cats := cc.Server.GetNewsCatByPath(pathStrs)
1140         cats[name] = NewsCategoryListData15{
1141                 Name:     name,
1142                 Type:     []byte{0, 3},
1143                 Articles: map[uint32]*NewsArtData{},
1144                 SubCats:  make(map[string]NewsCategoryListData15),
1145         }
1146
1147         if err := cc.Server.writeThreadedNews(); err != nil {
1148                 return res, err
1149         }
1150         res = append(res, cc.NewReply(t))
1151         return res, err
1152 }
1153
1154 // Fields used in the request:
1155 // 322  News category name
1156 // 325  News path
1157 func HandleNewNewsFldr(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1158         if !cc.Authorize(accessNewsCreateFldr) {
1159                 res = append(res, cc.NewErrReply(t, "You are not allowed to create news folders."))
1160                 return res, err
1161         }
1162
1163         name := string(t.GetField(FieldFileName).Data)
1164         pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
1165
1166         cc.logger.Infof("Creating new news folder %s", name)
1167
1168         cats := cc.Server.GetNewsCatByPath(pathStrs)
1169         cats[name] = NewsCategoryListData15{
1170                 Name:     name,
1171                 Type:     []byte{0, 2},
1172                 Articles: map[uint32]*NewsArtData{},
1173                 SubCats:  make(map[string]NewsCategoryListData15),
1174         }
1175         if err := cc.Server.writeThreadedNews(); err != nil {
1176                 return res, err
1177         }
1178         res = append(res, cc.NewReply(t))
1179         return res, err
1180 }
1181
1182 // HandleGetNewsArtData gets the list of article names at the specified news path.
1183
1184 // Fields used in the request:
1185 // 325  News path       Optional
1186
1187 // Fields used in the reply:
1188 // 321  News article list data  Optional
1189 func HandleGetNewsArtNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1190         if !cc.Authorize(accessNewsReadArt) {
1191                 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1192                 return res, err
1193         }
1194         pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
1195
1196         var cat NewsCategoryListData15
1197         cats := cc.Server.ThreadedNews.Categories
1198
1199         for _, fp := range pathStrs {
1200                 cat = cats[fp]
1201                 cats = cats[fp].SubCats
1202         }
1203
1204         nald := cat.GetNewsArtListData()
1205
1206         res = append(res, cc.NewReply(t, NewField(FieldNewsArtListData, nald.Payload())))
1207         return res, err
1208 }
1209
1210 // HandleGetNewsArtData requests information about the specific news article.
1211 // Fields used in the request:
1212 //
1213 // Request fields
1214 // 325  News path
1215 // 326  News article ID
1216 // 327  News article data flavor
1217 //
1218 // Fields used in the reply:
1219 // 328  News article title
1220 // 329  News article poster
1221 // 330  News article date
1222 // 331  Previous article ID
1223 // 332  Next article ID
1224 // 335  Parent article ID
1225 // 336  First child article ID
1226 // 327  News article data flavor        "Should be “text/plain”
1227 // 333  News article data       Optional (if data flavor is “text/plain”)
1228 func HandleGetNewsArtData(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1229         if !cc.Authorize(accessNewsReadArt) {
1230                 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1231                 return res, err
1232         }
1233
1234         var cat NewsCategoryListData15
1235         cats := cc.Server.ThreadedNews.Categories
1236
1237         for _, fp := range ReadNewsPath(t.GetField(FieldNewsPath).Data) {
1238                 cat = cats[fp]
1239                 cats = cats[fp].SubCats
1240         }
1241
1242         // The official Hotline clients will send the article ID as 2 bytes if possible, but
1243         // some third party clients such as Frogblast and Heildrun will always send 4 bytes
1244         convertedID, err := byteToInt(t.GetField(FieldNewsArtID).Data)
1245         if err != nil {
1246                 return res, err
1247         }
1248
1249         art := cat.Articles[uint32(convertedID)]
1250         if art == nil {
1251                 res = append(res, cc.NewReply(t))
1252                 return res, err
1253         }
1254
1255         res = append(res, cc.NewReply(t,
1256                 NewField(FieldNewsArtTitle, []byte(art.Title)),
1257                 NewField(FieldNewsArtPoster, []byte(art.Poster)),
1258                 NewField(FieldNewsArtDate, art.Date),
1259                 NewField(FieldNewsArtPrevArt, art.PrevArt),
1260                 NewField(FieldNewsArtNextArt, art.NextArt),
1261                 NewField(FieldNewsArtParentArt, art.ParentArt),
1262                 NewField(FieldNewsArt1stChildArt, art.FirstChildArt),
1263                 NewField(FieldNewsArtDataFlav, []byte("text/plain")),
1264                 NewField(FieldNewsArtData, []byte(art.Data)),
1265         ))
1266         return res, err
1267 }
1268
1269 // HandleDelNewsItem deletes an existing threaded news folder or category from the server.
1270 // Fields used in the request:
1271 // 325  News path
1272 // Fields used in the reply:
1273 // None
1274 func HandleDelNewsItem(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1275         pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
1276
1277         cats := cc.Server.ThreadedNews.Categories
1278         delName := pathStrs[len(pathStrs)-1]
1279         if len(pathStrs) > 1 {
1280                 for _, fp := range pathStrs[0 : len(pathStrs)-1] {
1281                         cats = cats[fp].SubCats
1282                 }
1283         }
1284
1285         if bytes.Equal(cats[delName].Type, []byte{0, 3}) {
1286                 if !cc.Authorize(accessNewsDeleteCat) {
1287                         return append(res, cc.NewErrReply(t, "You are not allowed to delete news categories.")), nil
1288                 }
1289         } else {
1290                 if !cc.Authorize(accessNewsDeleteFldr) {
1291                         return append(res, cc.NewErrReply(t, "You are not allowed to delete news folders.")), nil
1292                 }
1293         }
1294
1295         delete(cats, delName)
1296
1297         if err := cc.Server.writeThreadedNews(); err != nil {
1298                 return res, err
1299         }
1300
1301         return append(res, cc.NewReply(t)), nil
1302 }
1303
1304 func HandleDelNewsArt(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1305         if !cc.Authorize(accessNewsDeleteArt) {
1306                 res = append(res, cc.NewErrReply(t, "You are not allowed to delete news articles."))
1307                 return res, err
1308         }
1309
1310         // Request Fields
1311         // 325  News path
1312         // 326  News article ID
1313         // 337  News article – recursive delete       Delete child articles (1) or not (0)
1314         pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
1315         ID, err := byteToInt(t.GetField(FieldNewsArtID).Data)
1316         if err != nil {
1317                 return res, err
1318         }
1319
1320         // TODO: Delete recursive
1321         cats := cc.Server.GetNewsCatByPath(pathStrs[:len(pathStrs)-1])
1322
1323         catName := pathStrs[len(pathStrs)-1]
1324         cat := cats[catName]
1325
1326         delete(cat.Articles, uint32(ID))
1327
1328         cats[catName] = cat
1329         if err := cc.Server.writeThreadedNews(); err != nil {
1330                 return res, err
1331         }
1332
1333         res = append(res, cc.NewReply(t))
1334         return res, err
1335 }
1336
1337 // Request fields
1338 // 325  News path
1339 // 326  News article ID                                                 ID of the parent article?
1340 // 328  News article title
1341 // 334  News article flags
1342 // 327  News article data flavor                Currently “text/plain”
1343 // 333  News article data
1344 func HandlePostNewsArt(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1345         if !cc.Authorize(accessNewsPostArt) {
1346                 res = append(res, cc.NewErrReply(t, "You are not allowed to post news articles."))
1347                 return res, err
1348         }
1349
1350         pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
1351         cats := cc.Server.GetNewsCatByPath(pathStrs[:len(pathStrs)-1])
1352
1353         catName := pathStrs[len(pathStrs)-1]
1354         cat := cats[catName]
1355
1356         artID, err := byteToInt(t.GetField(FieldNewsArtID).Data)
1357         if err != nil {
1358                 return res, err
1359         }
1360         convertedArtID := uint32(artID)
1361         bs := make([]byte, 4)
1362         binary.BigEndian.PutUint32(bs, convertedArtID)
1363
1364         newArt := NewsArtData{
1365                 Title:         string(t.GetField(FieldNewsArtTitle).Data),
1366                 Poster:        string(cc.UserName),
1367                 Date:          toHotlineTime(time.Now()),
1368                 PrevArt:       []byte{0, 0, 0, 0},
1369                 NextArt:       []byte{0, 0, 0, 0},
1370                 ParentArt:     bs,
1371                 FirstChildArt: []byte{0, 0, 0, 0},
1372                 DataFlav:      []byte("text/plain"),
1373                 Data:          string(t.GetField(FieldNewsArtData).Data),
1374         }
1375
1376         var keys []int
1377         for k := range cat.Articles {
1378                 keys = append(keys, int(k))
1379         }
1380
1381         nextID := uint32(1)
1382         if len(keys) > 0 {
1383                 sort.Ints(keys)
1384                 prevID := uint32(keys[len(keys)-1])
1385                 nextID = prevID + 1
1386
1387                 binary.BigEndian.PutUint32(newArt.PrevArt, prevID)
1388
1389                 // Set next article ID
1390                 binary.BigEndian.PutUint32(cat.Articles[prevID].NextArt, nextID)
1391         }
1392
1393         // Update parent article with first child reply
1394         parentID := convertedArtID
1395         if parentID != 0 {
1396                 parentArt := cat.Articles[parentID]
1397
1398                 if bytes.Equal(parentArt.FirstChildArt, []byte{0, 0, 0, 0}) {
1399                         binary.BigEndian.PutUint32(parentArt.FirstChildArt, nextID)
1400                 }
1401         }
1402
1403         cat.Articles[nextID] = &newArt
1404
1405         cats[catName] = cat
1406         if err := cc.Server.writeThreadedNews(); err != nil {
1407                 return res, err
1408         }
1409
1410         res = append(res, cc.NewReply(t))
1411         return res, err
1412 }
1413
1414 // HandleGetMsgs returns the flat news data
1415 func HandleGetMsgs(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1416         if !cc.Authorize(accessNewsReadArt) {
1417                 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1418                 return res, err
1419         }
1420
1421         res = append(res, cc.NewReply(t, NewField(FieldData, cc.Server.FlatNews)))
1422
1423         return res, err
1424 }
1425
1426 func HandleDownloadFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1427         if !cc.Authorize(accessDownloadFile) {
1428                 res = append(res, cc.NewErrReply(t, "You are not allowed to download files."))
1429                 return res, err
1430         }
1431
1432         fileName := t.GetField(FieldFileName).Data
1433         filePath := t.GetField(FieldFilePath).Data
1434         resumeData := t.GetField(FieldFileResumeData).Data
1435
1436         var dataOffset int64
1437         var frd FileResumeData
1438         if resumeData != nil {
1439                 if err := frd.UnmarshalBinary(t.GetField(FieldFileResumeData).Data); err != nil {
1440                         return res, err
1441                 }
1442                 // TODO: handle rsrc fork offset
1443                 dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:]))
1444         }
1445
1446         fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1447         if err != nil {
1448                 return res, err
1449         }
1450
1451         hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, dataOffset)
1452         if err != nil {
1453                 return res, err
1454         }
1455
1456         xferSize := hlFile.ffo.TransferSize(0)
1457
1458         ft := cc.newFileTransfer(FileDownload, fileName, filePath, xferSize)
1459
1460         // TODO: refactor to remove this
1461         if resumeData != nil {
1462                 var frd FileResumeData
1463                 if err := frd.UnmarshalBinary(t.GetField(FieldFileResumeData).Data); err != nil {
1464                         return res, err
1465                 }
1466                 ft.fileResumeData = &frd
1467         }
1468
1469         // Optional field for when a HL v1.5+ client requests file preview
1470         // Used only for TEXT, JPEG, GIFF, BMP or PICT files
1471         // The value will always be 2
1472         if t.GetField(FieldFileTransferOptions).Data != nil {
1473                 ft.options = t.GetField(FieldFileTransferOptions).Data
1474                 xferSize = hlFile.ffo.FlatFileDataForkHeader.DataSize[:]
1475         }
1476
1477         res = append(res, cc.NewReply(t,
1478                 NewField(FieldRefNum, ft.refNum[:]),
1479                 NewField(FieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
1480                 NewField(FieldTransferSize, xferSize),
1481                 NewField(FieldFileSize, hlFile.ffo.FlatFileDataForkHeader.DataSize[:]),
1482         ))
1483
1484         return res, err
1485 }
1486
1487 // Download all files from the specified folder and sub-folders
1488 func HandleDownloadFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1489         if !cc.Authorize(accessDownloadFile) {
1490                 res = append(res, cc.NewErrReply(t, "You are not allowed to download folders."))
1491                 return res, err
1492         }
1493
1494         fullFilePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(FieldFilePath).Data, t.GetField(FieldFileName).Data)
1495         if err != nil {
1496                 return res, err
1497         }
1498
1499         transferSize, err := CalcTotalSize(fullFilePath)
1500         if err != nil {
1501                 return res, err
1502         }
1503         itemCount, err := CalcItemCount(fullFilePath)
1504         if err != nil {
1505                 return res, err
1506         }
1507
1508         fileTransfer := cc.newFileTransfer(FolderDownload, t.GetField(FieldFileName).Data, t.GetField(FieldFilePath).Data, transferSize)
1509
1510         var fp FilePath
1511         _, err = fp.Write(t.GetField(FieldFilePath).Data)
1512         if err != nil {
1513                 return res, err
1514         }
1515
1516         res = append(res, cc.NewReply(t,
1517                 NewField(FieldRefNum, fileTransfer.ReferenceNumber),
1518                 NewField(FieldTransferSize, transferSize),
1519                 NewField(FieldFolderItemCount, itemCount),
1520                 NewField(FieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
1521         ))
1522         return res, err
1523 }
1524
1525 // Upload all files from the local folder and its subfolders to the specified path on the server
1526 // Fields used in the request
1527 // 201  File name
1528 // 202  File path
1529 // 108  transfer size   Total size of all items in the folder
1530 // 220  Folder item count
1531 // 204  File transfer options   "Optional Currently set to 1" (TODO: ??)
1532 func HandleUploadFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1533         var fp FilePath
1534         if t.GetField(FieldFilePath).Data != nil {
1535                 if _, err = fp.Write(t.GetField(FieldFilePath).Data); err != nil {
1536                         return res, err
1537                 }
1538         }
1539
1540         // Handle special cases for Upload and Drop Box folders
1541         if !cc.Authorize(accessUploadAnywhere) {
1542                 if !fp.IsUploadDir() && !fp.IsDropbox() {
1543                         res = append(res, cc.NewErrReply(t, fmt.Sprintf("Cannot accept upload of the folder \"%v\" because you are only allowed to upload to the \"Uploads\" folder.", string(t.GetField(FieldFileName).Data))))
1544                         return res, err
1545                 }
1546         }
1547
1548         fileTransfer := cc.newFileTransfer(FolderUpload,
1549                 t.GetField(FieldFileName).Data,
1550                 t.GetField(FieldFilePath).Data,
1551                 t.GetField(FieldTransferSize).Data,
1552         )
1553
1554         fileTransfer.FolderItemCount = t.GetField(FieldFolderItemCount).Data
1555
1556         res = append(res, cc.NewReply(t, NewField(FieldRefNum, fileTransfer.ReferenceNumber)))
1557         return res, err
1558 }
1559
1560 // HandleUploadFile
1561 // Fields used in the request:
1562 // 201  File name
1563 // 202  File path
1564 // 204  File transfer options   "Optional
1565 // Used only to resume download, currently has value 2"
1566 // 108  File transfer size      "Optional used if download is not resumed"
1567 func HandleUploadFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1568         if !cc.Authorize(accessUploadFile) {
1569                 res = append(res, cc.NewErrReply(t, "You are not allowed to upload files."))
1570                 return res, err
1571         }
1572
1573         fileName := t.GetField(FieldFileName).Data
1574         filePath := t.GetField(FieldFilePath).Data
1575         transferOptions := t.GetField(FieldFileTransferOptions).Data
1576         transferSize := t.GetField(FieldTransferSize).Data // not sent for resume
1577
1578         var fp FilePath
1579         if filePath != nil {
1580                 if _, err = fp.Write(filePath); err != nil {
1581                         return res, err
1582                 }
1583         }
1584
1585         // Handle special cases for Upload and Drop Box folders
1586         if !cc.Authorize(accessUploadAnywhere) {
1587                 if !fp.IsUploadDir() && !fp.IsDropbox() {
1588                         res = append(res, cc.NewErrReply(t, fmt.Sprintf("Cannot accept upload of the file \"%v\" because you are only allowed to upload to the \"Uploads\" folder.", string(fileName))))
1589                         return res, err
1590                 }
1591         }
1592         fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1593         if err != nil {
1594                 return res, err
1595         }
1596
1597         if _, err := cc.Server.FS.Stat(fullFilePath); err == nil {
1598                 res = append(res, cc.NewErrReply(t, fmt.Sprintf("Cannot accept upload because there is already a file named \"%v\".  Try choosing a different name.", string(fileName))))
1599                 return res, err
1600         }
1601
1602         ft := cc.newFileTransfer(FileUpload, fileName, filePath, transferSize)
1603
1604         replyT := cc.NewReply(t, NewField(FieldRefNum, ft.ReferenceNumber))
1605
1606         // client has requested to resume a partially transferred file
1607         if transferOptions != nil {
1608                 fileInfo, err := cc.Server.FS.Stat(fullFilePath + incompleteFileSuffix)
1609                 if err != nil {
1610                         return res, err
1611                 }
1612
1613                 offset := make([]byte, 4)
1614                 binary.BigEndian.PutUint32(offset, uint32(fileInfo.Size()))
1615
1616                 fileResumeData := NewFileResumeData([]ForkInfoList{
1617                         *NewForkInfoList(offset),
1618                 })
1619
1620                 b, _ := fileResumeData.BinaryMarshal()
1621
1622                 ft.TransferSize = offset
1623
1624                 replyT.Fields = append(replyT.Fields, NewField(FieldFileResumeData, b))
1625         }
1626
1627         res = append(res, replyT)
1628         return res, err
1629 }
1630
1631 func HandleSetClientUserInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1632         if len(t.GetField(FieldUserIconID).Data) == 4 {
1633                 cc.Icon = t.GetField(FieldUserIconID).Data[2:]
1634         } else {
1635                 cc.Icon = t.GetField(FieldUserIconID).Data
1636         }
1637         if cc.Authorize(accessAnyName) {
1638                 cc.UserName = t.GetField(FieldUserName).Data
1639         }
1640
1641         // the options field is only passed by the client versions > 1.2.3.
1642         options := t.GetField(FieldOptions).Data
1643         if options != nil {
1644                 optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
1645                 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(cc.Flags)))
1646
1647                 flagBitmap.SetBit(flagBitmap, userFlagRefusePM, optBitmap.Bit(refusePM))
1648                 binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
1649
1650                 flagBitmap.SetBit(flagBitmap, userFLagRefusePChat, optBitmap.Bit(refuseChat))
1651                 binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
1652
1653                 // Check auto response
1654                 if optBitmap.Bit(autoResponse) == 1 {
1655                         cc.AutoReply = t.GetField(FieldAutomaticResponse).Data
1656                 } else {
1657                         cc.AutoReply = []byte{}
1658                 }
1659         }
1660
1661         for _, c := range sortedClients(cc.Server.Clients) {
1662                 res = append(res, *NewTransaction(
1663                         TranNotifyChangeUser,
1664                         c.ID,
1665                         NewField(FieldUserID, *cc.ID),
1666                         NewField(FieldUserIconID, cc.Icon),
1667                         NewField(FieldUserFlags, cc.Flags),
1668                         NewField(FieldUserName, cc.UserName),
1669                 ))
1670         }
1671
1672         return res, err
1673 }
1674
1675 // HandleKeepAlive responds to keepalive transactions with an empty reply
1676 // * HL 1.9.2 Client sends keepalive msg every 3 minutes
1677 // * HL 1.2.3 Client doesn't send keepalives
1678 func HandleKeepAlive(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1679         res = append(res, cc.NewReply(t))
1680
1681         return res, err
1682 }
1683
1684 func HandleGetFileNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1685         fullPath, err := readPath(
1686                 cc.Server.Config.FileRoot,
1687                 t.GetField(FieldFilePath).Data,
1688                 nil,
1689         )
1690         if err != nil {
1691                 return res, err
1692         }
1693
1694         var fp FilePath
1695         if t.GetField(FieldFilePath).Data != nil {
1696                 if _, err = fp.Write(t.GetField(FieldFilePath).Data); err != nil {
1697                         return res, err
1698                 }
1699         }
1700
1701         // Handle special case for drop box folders
1702         if fp.IsDropbox() && !cc.Authorize(accessViewDropBoxes) {
1703                 res = append(res, cc.NewErrReply(t, "You are not allowed to view drop boxes."))
1704                 return res, err
1705         }
1706
1707         fileNames, err := getFileNameList(fullPath, cc.Server.Config.IgnoreFiles)
1708         if err != nil {
1709                 return res, err
1710         }
1711
1712         res = append(res, cc.NewReply(t, fileNames...))
1713
1714         return res, err
1715 }
1716
1717 // =================================
1718 //     Hotline private chat flow
1719 // =================================
1720 // 1. ClientA sends TranInviteNewChat to server with user ID to invite
1721 // 2. Server creates new ChatID
1722 // 3. Server sends TranInviteToChat to invitee
1723 // 4. Server replies to ClientA with new Chat ID
1724 //
1725 // A dialog box pops up in the invitee client with options to accept or decline the invitation.
1726 // If Accepted is clicked:
1727 // 1. ClientB sends TranJoinChat with FieldChatID
1728
1729 // HandleInviteNewChat invites users to new private chat
1730 func HandleInviteNewChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1731         if !cc.Authorize(accessOpenChat) {
1732                 res = append(res, cc.NewErrReply(t, "You are not allowed to request private chat."))
1733                 return res, err
1734         }
1735
1736         // Client to Invite
1737         targetID := t.GetField(FieldUserID).Data
1738         newChatID := cc.Server.NewPrivateChat(cc)
1739
1740         // Check if target user has "Refuse private chat" flag
1741         binary.BigEndian.Uint16(targetID)
1742         targetClient := cc.Server.Clients[binary.BigEndian.Uint16(targetID)]
1743
1744         flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(targetClient.Flags)))
1745         if flagBitmap.Bit(userFLagRefusePChat) == 1 {
1746                 res = append(res,
1747                         *NewTransaction(
1748                                 TranServerMsg,
1749                                 cc.ID,
1750                                 NewField(FieldData, []byte(string(targetClient.UserName)+" does not accept private chats.")),
1751                                 NewField(FieldUserName, targetClient.UserName),
1752                                 NewField(FieldUserID, *targetClient.ID),
1753                                 NewField(FieldOptions, []byte{0, 2}),
1754                         ),
1755                 )
1756         } else {
1757                 res = append(res,
1758                         *NewTransaction(
1759                                 TranInviteToChat,
1760                                 &targetID,
1761                                 NewField(FieldChatID, newChatID),
1762                                 NewField(FieldUserName, cc.UserName),
1763                                 NewField(FieldUserID, *cc.ID),
1764                         ),
1765                 )
1766         }
1767
1768         res = append(res,
1769                 cc.NewReply(t,
1770                         NewField(FieldChatID, newChatID),
1771                         NewField(FieldUserName, cc.UserName),
1772                         NewField(FieldUserID, *cc.ID),
1773                         NewField(FieldUserIconID, cc.Icon),
1774                         NewField(FieldUserFlags, cc.Flags),
1775                 ),
1776         )
1777
1778         return res, err
1779 }
1780
1781 func HandleInviteToChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1782         if !cc.Authorize(accessOpenChat) {
1783                 res = append(res, cc.NewErrReply(t, "You are not allowed to request private chat."))
1784                 return res, err
1785         }
1786
1787         // Client to Invite
1788         targetID := t.GetField(FieldUserID).Data
1789         chatID := t.GetField(FieldChatID).Data
1790
1791         res = append(res,
1792                 *NewTransaction(
1793                         TranInviteToChat,
1794                         &targetID,
1795                         NewField(FieldChatID, chatID),
1796                         NewField(FieldUserName, cc.UserName),
1797                         NewField(FieldUserID, *cc.ID),
1798                 ),
1799         )
1800         res = append(res,
1801                 cc.NewReply(
1802                         t,
1803                         NewField(FieldChatID, chatID),
1804                         NewField(FieldUserName, cc.UserName),
1805                         NewField(FieldUserID, *cc.ID),
1806                         NewField(FieldUserIconID, cc.Icon),
1807                         NewField(FieldUserFlags, cc.Flags),
1808                 ),
1809         )
1810
1811         return res, err
1812 }
1813
1814 func HandleRejectChatInvite(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1815         chatID := t.GetField(FieldChatID).Data
1816         chatInt := binary.BigEndian.Uint32(chatID)
1817
1818         privChat := cc.Server.PrivateChats[chatInt]
1819
1820         resMsg := append(cc.UserName, []byte(" declined invitation to chat")...)
1821
1822         for _, c := range sortedClients(privChat.ClientConn) {
1823                 res = append(res,
1824                         *NewTransaction(
1825                                 TranChatMsg,
1826                                 c.ID,
1827                                 NewField(FieldChatID, chatID),
1828                                 NewField(FieldData, resMsg),
1829                         ),
1830                 )
1831         }
1832
1833         return res, err
1834 }
1835
1836 // HandleJoinChat is sent from a v1.8+ Hotline client when the joins a private chat
1837 // Fields used in the reply:
1838 // * 115        Chat subject
1839 // * 300        User name with info (Optional)
1840 // * 300        (more user names with info)
1841 func HandleJoinChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1842         chatID := t.GetField(FieldChatID).Data
1843         chatInt := binary.BigEndian.Uint32(chatID)
1844
1845         privChat := cc.Server.PrivateChats[chatInt]
1846
1847         // Send TranNotifyChatChangeUser to current members of the chat to inform of new user
1848         for _, c := range sortedClients(privChat.ClientConn) {
1849                 res = append(res,
1850                         *NewTransaction(
1851                                 TranNotifyChatChangeUser,
1852                                 c.ID,
1853                                 NewField(FieldChatID, chatID),
1854                                 NewField(FieldUserName, cc.UserName),
1855                                 NewField(FieldUserID, *cc.ID),
1856                                 NewField(FieldUserIconID, cc.Icon),
1857                                 NewField(FieldUserFlags, cc.Flags),
1858                         ),
1859                 )
1860         }
1861
1862         privChat.ClientConn[cc.uint16ID()] = cc
1863
1864         replyFields := []Field{NewField(FieldChatSubject, []byte(privChat.Subject))}
1865         for _, c := range sortedClients(privChat.ClientConn) {
1866                 user := User{
1867                         ID:    *c.ID,
1868                         Icon:  c.Icon,
1869                         Flags: c.Flags,
1870                         Name:  string(c.UserName),
1871                 }
1872
1873                 replyFields = append(replyFields, NewField(FieldUsernameWithInfo, user.Payload()))
1874         }
1875
1876         res = append(res, cc.NewReply(t, replyFields...))
1877         return res, err
1878 }
1879
1880 // HandleLeaveChat is sent from a v1.8+ Hotline client when the user exits a private chat
1881 // Fields used in the request:
1882 //   - 114      FieldChatID
1883 //
1884 // Reply is not expected.
1885 func HandleLeaveChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1886         chatID := t.GetField(FieldChatID).Data
1887         chatInt := binary.BigEndian.Uint32(chatID)
1888
1889         privChat, ok := cc.Server.PrivateChats[chatInt]
1890         if !ok {
1891                 return res, nil
1892         }
1893
1894         delete(privChat.ClientConn, cc.uint16ID())
1895
1896         // Notify members of the private chat that the user has left
1897         for _, c := range sortedClients(privChat.ClientConn) {
1898                 res = append(res,
1899                         *NewTransaction(
1900                                 TranNotifyChatDeleteUser,
1901                                 c.ID,
1902                                 NewField(FieldChatID, chatID),
1903                                 NewField(FieldUserID, *cc.ID),
1904                         ),
1905                 )
1906         }
1907
1908         return res, err
1909 }
1910
1911 // HandleSetChatSubject is sent from a v1.8+ Hotline client when the user sets a private chat subject
1912 // Fields used in the request:
1913 // * 114        Chat ID
1914 // * 115        Chat subject
1915 // Reply is not expected.
1916 func HandleSetChatSubject(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1917         chatID := t.GetField(FieldChatID).Data
1918         chatInt := binary.BigEndian.Uint32(chatID)
1919
1920         privChat := cc.Server.PrivateChats[chatInt]
1921         privChat.Subject = string(t.GetField(FieldChatSubject).Data)
1922
1923         for _, c := range sortedClients(privChat.ClientConn) {
1924                 res = append(res,
1925                         *NewTransaction(
1926                                 TranNotifyChatSubject,
1927                                 c.ID,
1928                                 NewField(FieldChatID, chatID),
1929                                 NewField(FieldChatSubject, t.GetField(FieldChatSubject).Data),
1930                         ),
1931                 )
1932         }
1933
1934         return res, err
1935 }
1936
1937 // HandleMakeAlias makes a file alias using the specified path.
1938 // Fields used in the request:
1939 // 201  File name
1940 // 202  File path
1941 // 212  File new path   Destination path
1942 //
1943 // Fields used in the reply:
1944 // None
1945 func HandleMakeAlias(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1946         if !cc.Authorize(accessMakeAlias) {
1947                 res = append(res, cc.NewErrReply(t, "You are not allowed to make aliases."))
1948                 return res, err
1949         }
1950         fileName := t.GetField(FieldFileName).Data
1951         filePath := t.GetField(FieldFilePath).Data
1952         fileNewPath := t.GetField(FieldFileNewPath).Data
1953
1954         fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1955         if err != nil {
1956                 return res, err
1957         }
1958
1959         fullNewFilePath, err := readPath(cc.Server.Config.FileRoot, fileNewPath, fileName)
1960         if err != nil {
1961                 return res, err
1962         }
1963
1964         cc.logger.Debugw("Make alias", "src", fullFilePath, "dst", fullNewFilePath)
1965
1966         if err := cc.Server.FS.Symlink(fullFilePath, fullNewFilePath); err != nil {
1967                 res = append(res, cc.NewErrReply(t, "Error creating alias"))
1968                 return res, nil
1969         }
1970
1971         res = append(res, cc.NewReply(t))
1972         return res, err
1973 }
1974
1975 // HandleDownloadBanner handles requests for a new banner from the server
1976 // Fields used in the request:
1977 // None
1978 // Fields used in the reply:
1979 // 107  FieldRefNum                     Used later for transfer
1980 // 108  FieldTransferSize       Size of data to be downloaded
1981 func HandleDownloadBanner(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1982         fi, err := cc.Server.FS.Stat(filepath.Join(cc.Server.ConfigDir, cc.Server.Config.BannerFile))
1983         if err != nil {
1984                 return res, err
1985         }
1986
1987         ft := cc.newFileTransfer(bannerDownload, []byte{}, []byte{}, make([]byte, 4))
1988
1989         binary.BigEndian.PutUint32(ft.TransferSize, uint32(fi.Size()))
1990
1991         res = append(res, cc.NewReply(t,
1992                 NewField(FieldRefNum, ft.refNum[:]),
1993                 NewField(FieldTransferSize, ft.TransferSize),
1994         ))
1995
1996         return res, err
1997 }