19 type TransactionType struct {
20 Handler func(*ClientConn, *Transaction) ([]Transaction, error) // function for handling the transaction type
21 Name string // Name of transaction as it will appear in logging
22 RequiredFields []requiredField
25 var TransactionHandlers = map[uint16]TransactionType{
31 tranNotifyChangeUser: {
32 Name: "tranNotifyChangeUser",
38 Name: "tranShowAgreement",
41 Name: "tranUserAccess",
43 tranNotifyDeleteUser: {
44 Name: "tranNotifyDeleteUser",
48 Handler: HandleTranAgreed,
52 Handler: HandleChatSend,
53 RequiredFields: []requiredField{
61 Name: "tranDelNewsArt",
62 Handler: HandleDelNewsArt,
65 Name: "tranDelNewsItem",
66 Handler: HandleDelNewsItem,
69 Name: "tranDeleteFile",
70 Handler: HandleDeleteFile,
73 Name: "tranDeleteUser",
74 Handler: HandleDeleteUser,
77 Name: "tranDisconnectUser",
78 Handler: HandleDisconnectUser,
81 Name: "tranDownloadFile",
82 Handler: HandleDownloadFile,
85 Name: "tranDownloadFldr",
86 Handler: HandleDownloadFolder,
88 tranGetClientInfoText: {
89 Name: "tranGetClientInfoText",
90 Handler: HandleGetClientInfoText,
93 Name: "tranGetFileInfo",
94 Handler: HandleGetFileInfo,
96 tranGetFileNameList: {
97 Name: "tranGetFileNameList",
98 Handler: HandleGetFileNameList,
102 Handler: HandleGetMsgs,
104 tranGetNewsArtData: {
105 Name: "tranGetNewsArtData",
106 Handler: HandleGetNewsArtData,
108 tranGetNewsArtNameList: {
109 Name: "tranGetNewsArtNameList",
110 Handler: HandleGetNewsArtNameList,
112 tranGetNewsCatNameList: {
113 Name: "tranGetNewsCatNameList",
114 Handler: HandleGetNewsCatNameList,
118 Handler: HandleGetUser,
120 tranGetUserNameList: {
121 Name: "tranHandleGetUserNameList",
122 Handler: HandleGetUserNameList,
125 Name: "tranInviteNewChat",
126 Handler: HandleInviteNewChat,
129 Name: "tranInviteToChat",
130 Handler: HandleInviteToChat,
133 Name: "tranJoinChat",
134 Handler: HandleJoinChat,
137 Name: "tranKeepAlive",
138 Handler: HandleKeepAlive,
141 Name: "tranJoinChat",
142 Handler: HandleLeaveChat,
145 Name: "tranListUsers",
146 Handler: HandleListUsers,
149 Name: "tranMoveFile",
150 Handler: HandleMoveFile,
153 Name: "tranNewFolder",
154 Handler: HandleNewFolder,
157 Name: "tranNewNewsCat",
158 Handler: HandleNewNewsCat,
161 Name: "tranNewNewsFldr",
162 Handler: HandleNewNewsFldr,
166 Handler: HandleNewUser,
169 Name: "tranUpdateUser",
170 Handler: HandleUpdateUser,
173 Name: "tranOldPostNews",
174 Handler: HandleTranOldPostNews,
177 Name: "tranPostNewsArt",
178 Handler: HandlePostNewsArt,
180 tranRejectChatInvite: {
181 Name: "tranRejectChatInvite",
182 Handler: HandleRejectChatInvite,
184 tranSendInstantMsg: {
185 Name: "tranSendInstantMsg",
186 Handler: HandleSendInstantMsg,
187 RequiredFields: []requiredField{
197 tranSetChatSubject: {
198 Name: "tranSetChatSubject",
199 Handler: HandleSetChatSubject,
202 Name: "tranMakeFileAlias",
203 Handler: HandleMakeAlias,
204 RequiredFields: []requiredField{
205 {ID: fieldFileName, minLen: 1},
206 {ID: fieldFilePath, minLen: 1},
207 {ID: fieldFileNewPath, minLen: 1},
210 tranSetClientUserInfo: {
211 Name: "tranSetClientUserInfo",
212 Handler: HandleSetClientUserInfo,
215 Name: "tranSetFileInfo",
216 Handler: HandleSetFileInfo,
220 Handler: HandleSetUser,
223 Name: "tranUploadFile",
224 Handler: HandleUploadFile,
227 Name: "tranUploadFldr",
228 Handler: HandleUploadFolder,
231 Name: "tranUserBroadcast",
232 Handler: HandleUserBroadcast,
234 tranDownloadBanner: {
235 Name: "tranDownloadBanner",
236 Handler: HandleDownloadBanner,
240 func HandleChatSend(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
241 if !authorize(cc.Account.Access, accessSendChat) {
242 res = append(res, cc.NewErrReply(t, "You are not allowed to participate in chat."))
246 // Truncate long usernames
247 trunc := fmt.Sprintf("%13s", cc.UserName)
248 formattedMsg := fmt.Sprintf("\r%.14s: %s", trunc, t.GetField(fieldData).Data)
250 // By holding the option key, Hotline chat allows users to send /me formatted messages like:
251 // *** Halcyon does stuff
252 // This is indicated by the presence of the optional field fieldChatOptions in the transaction payload
253 if t.GetField(fieldChatOptions).Data != nil {
254 formattedMsg = fmt.Sprintf("\r*** %s %s", cc.UserName, t.GetField(fieldData).Data)
257 chatID := t.GetField(fieldChatID).Data
258 // a non-nil chatID indicates the message belongs to a private chat
260 chatInt := binary.BigEndian.Uint32(chatID)
261 privChat := cc.Server.PrivateChats[chatInt]
263 clients := sortedClients(privChat.ClientConn)
265 // send the message to all connected clients of the private chat
266 for _, c := range clients {
267 res = append(res, *NewTransaction(
270 NewField(fieldChatID, chatID),
271 NewField(fieldData, []byte(formattedMsg)),
277 for _, c := range sortedClients(cc.Server.Clients) {
278 // Filter out clients that do not have the read chat permission
279 if authorize(c.Account.Access, accessReadChat) {
280 res = append(res, *NewTransaction(tranChatMsg, c.ID, NewField(fieldData, []byte(formattedMsg))))
287 // HandleSendInstantMsg sends instant message to the user on the current server.
288 // Fields used in the request:
291 // One of the following values:
292 // - User message (myOpt_UserMessage = 1)
293 // - Refuse message (myOpt_RefuseMessage = 2)
294 // - Refuse chat (myOpt_RefuseChat = 3)
295 // - Automatic response (myOpt_AutomaticResponse = 4)"
297 // 214 Quoting message Optional
299 // Fields used in the reply:
301 func HandleSendInstantMsg(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
302 if !cc.Authorize(accessSendPrivMsg) {
303 res = append(res, cc.NewErrReply(t, "You are not allowed to send private messages."))
307 msg := t.GetField(fieldData)
308 ID := t.GetField(fieldUserID)
310 reply := NewTransaction(
313 NewField(fieldData, msg.Data),
314 NewField(fieldUserName, cc.UserName),
315 NewField(fieldUserID, *cc.ID),
316 NewField(fieldOptions, []byte{0, 1}),
319 // Later versions of Hotline include the original message in the fieldQuotingMsg field so
320 // the receiving client can display both the received message and what it is in reply to
321 if t.GetField(fieldQuotingMsg).Data != nil {
322 reply.Fields = append(reply.Fields, NewField(fieldQuotingMsg, t.GetField(fieldQuotingMsg).Data))
325 res = append(res, *reply)
327 id, _ := byteToInt(ID.Data)
328 otherClient, ok := cc.Server.Clients[uint16(id)]
330 return res, errors.New("invalid client ID")
333 // Respond with auto reply if other client has it enabled
334 if len(otherClient.AutoReply) > 0 {
339 NewField(fieldData, otherClient.AutoReply),
340 NewField(fieldUserName, otherClient.UserName),
341 NewField(fieldUserID, *otherClient.ID),
342 NewField(fieldOptions, []byte{0, 1}),
347 res = append(res, cc.NewReply(t))
352 func HandleGetFileInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
353 fileName := t.GetField(fieldFileName).Data
354 filePath := t.GetField(fieldFilePath).Data
356 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
361 fw, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
366 res = append(res, cc.NewReply(t,
367 NewField(fieldFileName, []byte(fw.name)),
368 NewField(fieldFileTypeString, fw.ffo.FlatFileInformationFork.friendlyType()),
369 NewField(fieldFileCreatorString, fw.ffo.FlatFileInformationFork.friendlyCreator()),
370 NewField(fieldFileComment, fw.ffo.FlatFileInformationFork.Comment),
371 NewField(fieldFileType, fw.ffo.FlatFileInformationFork.TypeSignature),
372 NewField(fieldFileCreateDate, fw.ffo.FlatFileInformationFork.CreateDate),
373 NewField(fieldFileModifyDate, fw.ffo.FlatFileInformationFork.ModifyDate),
374 NewField(fieldFileSize, fw.totalSize()),
379 // HandleSetFileInfo updates a file or folder name and/or comment from the Get Info window
380 // Fields used in the request:
382 // * 202 File path Optional
383 // * 211 File new name Optional
384 // * 210 File comment Optional
385 // Fields used in the reply: None
386 func HandleSetFileInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
387 fileName := t.GetField(fieldFileName).Data
388 filePath := t.GetField(fieldFilePath).Data
390 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
395 fi, err := cc.Server.FS.Stat(fullFilePath)
400 hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
404 if t.GetField(fieldFileComment).Data != nil {
405 switch mode := fi.Mode(); {
407 if !authorize(cc.Account.Access, accessSetFolderComment) {
408 res = append(res, cc.NewErrReply(t, "You are not allowed to set comments for folders."))
411 case mode.IsRegular():
412 if !authorize(cc.Account.Access, accessSetFileComment) {
413 res = append(res, cc.NewErrReply(t, "You are not allowed to set comments for files."))
418 if err := hlFile.ffo.FlatFileInformationFork.setComment(t.GetField(fieldFileComment).Data); err != nil {
421 w, err := hlFile.infoForkWriter()
425 _, err = w.Write(hlFile.ffo.FlatFileInformationFork.MarshalBinary())
431 fullNewFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, t.GetField(fieldFileNewName).Data)
436 fileNewName := t.GetField(fieldFileNewName).Data
438 if fileNewName != nil {
439 switch mode := fi.Mode(); {
441 if !authorize(cc.Account.Access, accessRenameFolder) {
442 res = append(res, cc.NewErrReply(t, "You are not allowed to rename folders."))
445 err = os.Rename(fullFilePath, fullNewFilePath)
446 if os.IsNotExist(err) {
447 res = append(res, cc.NewErrReply(t, "Cannot rename folder "+string(fileName)+" because it does not exist or cannot be found."))
450 case mode.IsRegular():
451 if !authorize(cc.Account.Access, accessRenameFile) {
452 res = append(res, cc.NewErrReply(t, "You are not allowed to rename files."))
455 fileDir, err := readPath(cc.Server.Config.FileRoot, filePath, []byte{})
459 hlFile.name = string(fileNewName)
460 err = hlFile.move(fileDir)
461 if os.IsNotExist(err) {
462 res = append(res, cc.NewErrReply(t, "Cannot rename file "+string(fileName)+" because it does not exist or cannot be found."))
471 res = append(res, cc.NewReply(t))
475 // HandleDeleteFile deletes a file or folder
476 // Fields used in the request:
479 // Fields used in the reply: none
480 func HandleDeleteFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
481 fileName := t.GetField(fieldFileName).Data
482 filePath := t.GetField(fieldFilePath).Data
484 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
489 hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
494 fi, err := hlFile.dataFile()
496 res = append(res, cc.NewErrReply(t, "Cannot delete file "+string(fileName)+" because it does not exist or cannot be found."))
500 switch mode := fi.Mode(); {
502 if !authorize(cc.Account.Access, accessDeleteFolder) {
503 res = append(res, cc.NewErrReply(t, "You are not allowed to delete folders."))
506 case mode.IsRegular():
507 if !authorize(cc.Account.Access, accessDeleteFile) {
508 res = append(res, cc.NewErrReply(t, "You are not allowed to delete files."))
513 if err := hlFile.delete(); err != nil {
517 res = append(res, cc.NewReply(t))
521 // HandleMoveFile moves files or folders. Note: seemingly not documented
522 func HandleMoveFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
523 fileName := string(t.GetField(fieldFileName).Data)
525 filePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFilePath).Data, t.GetField(fieldFileName).Data)
530 fileNewPath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFileNewPath).Data, nil)
535 cc.logger.Infow("Move file", "src", filePath+"/"+fileName, "dst", fileNewPath+"/"+fileName)
537 hlFile, err := newFileWrapper(cc.Server.FS, filePath, 0)
542 fi, err := hlFile.dataFile()
544 res = append(res, cc.NewErrReply(t, "Cannot delete file "+fileName+" because it does not exist or cannot be found."))
550 switch mode := fi.Mode(); {
552 if !authorize(cc.Account.Access, accessMoveFolder) {
553 res = append(res, cc.NewErrReply(t, "You are not allowed to move folders."))
556 case mode.IsRegular():
557 if !authorize(cc.Account.Access, accessMoveFile) {
558 res = append(res, cc.NewErrReply(t, "You are not allowed to move files."))
562 if err := hlFile.move(fileNewPath); err != nil {
565 // TODO: handle other possible errors; e.g. fileWrapper delete fails due to fileWrapper permission issue
567 res = append(res, cc.NewReply(t))
571 func HandleNewFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
572 if !authorize(cc.Account.Access, accessCreateFolder) {
573 res = append(res, cc.NewErrReply(t, "You are not allowed to create folders."))
576 folderName := string(t.GetField(fieldFileName).Data)
578 folderName = path.Join("/", folderName)
582 // fieldFilePath is only present for nested paths
583 if t.GetField(fieldFilePath).Data != nil {
585 err := newFp.UnmarshalBinary(t.GetField(fieldFilePath).Data)
590 for _, pathItem := range newFp.Items {
591 subPath = filepath.Join("/", subPath, string(pathItem.Name))
594 newFolderPath := path.Join(cc.Server.Config.FileRoot, subPath, folderName)
596 // TODO: check path and folder name lengths
598 if _, err := cc.Server.FS.Stat(newFolderPath); !os.IsNotExist(err) {
599 msg := fmt.Sprintf("Cannot create folder \"%s\" because there is already a file or folder with that name.", folderName)
600 return []Transaction{cc.NewErrReply(t, msg)}, nil
603 // TODO: check for disallowed characters to maintain compatibility for original client
605 if err := cc.Server.FS.Mkdir(newFolderPath, 0777); err != nil {
606 msg := fmt.Sprintf("Cannot create folder \"%s\" because an error occurred.", folderName)
607 return []Transaction{cc.NewErrReply(t, msg)}, nil
610 res = append(res, cc.NewReply(t))
614 func HandleSetUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
615 if !authorize(cc.Account.Access, accessModifyUser) {
616 res = append(res, cc.NewErrReply(t, "You are not allowed to modify accounts."))
620 login := DecodeUserString(t.GetField(fieldUserLogin).Data)
621 userName := string(t.GetField(fieldUserName).Data)
623 newAccessLvl := t.GetField(fieldUserAccess).Data
625 account := cc.Server.Accounts[login]
626 account.Access = &newAccessLvl
627 account.Name = userName
629 // If the password field is cleared in the Hotline edit user UI, the SetUser transaction does
630 // not include fieldUserPassword
631 if t.GetField(fieldUserPassword).Data == nil {
632 account.Password = hashAndSalt([]byte(""))
634 if len(t.GetField(fieldUserPassword).Data) > 1 {
635 account.Password = hashAndSalt(t.GetField(fieldUserPassword).Data)
638 out, err := yaml.Marshal(&account)
642 if err := os.WriteFile(filepath.Join(cc.Server.ConfigDir, "Users", login+".yaml"), out, 0666); err != nil {
646 // Notify connected clients logged in as the user of the new access level
647 for _, c := range cc.Server.Clients {
648 if c.Account.Login == login {
649 // Note: comment out these two lines to test server-side deny messages
650 newT := NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, newAccessLvl))
651 res = append(res, *newT)
653 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(c.Flags)))
654 if authorize(c.Account.Access, accessDisconUser) {
655 flagBitmap.SetBit(flagBitmap, userFlagAdmin, 1)
657 flagBitmap.SetBit(flagBitmap, userFlagAdmin, 0)
659 binary.BigEndian.PutUint16(c.Flags, uint16(flagBitmap.Int64()))
661 c.Account.Access = account.Access
664 tranNotifyChangeUser,
665 NewField(fieldUserID, *c.ID),
666 NewField(fieldUserFlags, c.Flags),
667 NewField(fieldUserName, c.UserName),
668 NewField(fieldUserIconID, c.Icon),
673 res = append(res, cc.NewReply(t))
677 func HandleGetUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
678 if !authorize(cc.Account.Access, accessOpenUser) {
679 res = append(res, cc.NewErrReply(t, "You are not allowed to view accounts."))
683 account := cc.Server.Accounts[string(t.GetField(fieldUserLogin).Data)]
685 res = append(res, cc.NewErrReply(t, "Account does not exist."))
689 res = append(res, cc.NewReply(t,
690 NewField(fieldUserName, []byte(account.Name)),
691 NewField(fieldUserLogin, negateString(t.GetField(fieldUserLogin).Data)),
692 NewField(fieldUserPassword, []byte(account.Password)),
693 NewField(fieldUserAccess, *account.Access),
698 func HandleListUsers(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
699 if !authorize(cc.Account.Access, accessOpenUser) {
700 res = append(res, cc.NewErrReply(t, "You are not allowed to view accounts."))
704 var userFields []Field
705 for _, acc := range cc.Server.Accounts {
706 b := make([]byte, 0, 100)
707 n, err := acc.Read(b)
712 userFields = append(userFields, NewField(fieldData, b[:n]))
715 res = append(res, cc.NewReply(t, userFields...))
719 // HandleUpdateUser is used by the v1.5+ multi-user editor to perform account editing for multiple users at a time.
720 // An update can be a mix of these actions:
723 // * Modify user (including renaming the account login)
725 // The Transaction sent by the client includes one data field per user that was modified. This data field in turn
726 // contains another data field encoded in its payload with a varying number of sub fields depending on which action is
727 // performed. This seems to be the only place in the Hotline protocol where a data field contains another data field.
728 func HandleUpdateUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
729 for _, field := range t.Fields {
730 subFields, err := ReadFields(field.Data[0:2], field.Data[2:])
735 if len(subFields) == 1 {
736 login := DecodeUserString(getField(fieldData, &subFields).Data)
737 cc.logger.Infow("DeleteUser", "login", login)
739 if !authorize(cc.Account.Access, accessDeleteUser) {
740 res = append(res, cc.NewErrReply(t, "You are not allowed to delete accounts."))
744 if err := cc.Server.DeleteUser(login); err != nil {
750 login := DecodeUserString(getField(fieldUserLogin, &subFields).Data)
752 // check if the login dataFile; if so, we know we are updating an existing user
753 if acc, ok := cc.Server.Accounts[login]; ok {
754 cc.logger.Infow("UpdateUser", "login", login)
756 // account dataFile, so this is an update action
757 if !authorize(cc.Account.Access, accessModifyUser) {
758 res = append(res, cc.NewErrReply(t, "You are not allowed to modify accounts."))
762 if getField(fieldUserPassword, &subFields) != nil {
763 newPass := getField(fieldUserPassword, &subFields).Data
764 acc.Password = hashAndSalt(newPass)
766 acc.Password = hashAndSalt([]byte(""))
769 if getField(fieldUserAccess, &subFields) != nil {
770 acc.Access = &getField(fieldUserAccess, &subFields).Data
773 err = cc.Server.UpdateUser(
774 DecodeUserString(getField(fieldData, &subFields).Data),
775 DecodeUserString(getField(fieldUserLogin, &subFields).Data),
776 string(getField(fieldUserName, &subFields).Data),
784 cc.logger.Infow("CreateUser", "login", login)
786 if !authorize(cc.Account.Access, accessCreateUser) {
787 res = append(res, cc.NewErrReply(t, "You are not allowed to create new accounts."))
791 err := cc.Server.NewUser(
793 string(getField(fieldUserName, &subFields).Data),
794 string(getField(fieldUserPassword, &subFields).Data),
795 getField(fieldUserAccess, &subFields).Data,
798 return []Transaction{}, err
803 res = append(res, cc.NewReply(t))
807 // HandleNewUser creates a new user account
808 func HandleNewUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
809 if !authorize(cc.Account.Access, accessCreateUser) {
810 res = append(res, cc.NewErrReply(t, "You are not allowed to create new accounts."))
814 login := DecodeUserString(t.GetField(fieldUserLogin).Data)
816 // If the account already dataFile, reply with an error
817 if _, ok := cc.Server.Accounts[login]; ok {
818 res = append(res, cc.NewErrReply(t, "Cannot create account "+login+" because there is already an account with that login."))
822 if err := cc.Server.NewUser(
824 string(t.GetField(fieldUserName).Data),
825 string(t.GetField(fieldUserPassword).Data),
826 t.GetField(fieldUserAccess).Data,
828 return []Transaction{}, err
831 res = append(res, cc.NewReply(t))
835 func HandleDeleteUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
836 if !authorize(cc.Account.Access, accessDeleteUser) {
837 res = append(res, cc.NewErrReply(t, "You are not allowed to delete accounts."))
841 // TODO: Handle case where account doesn't exist; e.g. delete race condition
842 login := DecodeUserString(t.GetField(fieldUserLogin).Data)
844 if err := cc.Server.DeleteUser(login); err != nil {
848 res = append(res, cc.NewReply(t))
852 // HandleUserBroadcast sends an Administrator Message to all connected clients of the server
853 func HandleUserBroadcast(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
854 if !authorize(cc.Account.Access, accessBroadcast) {
855 res = append(res, cc.NewErrReply(t, "You are not allowed to send broadcast messages."))
861 NewField(fieldData, t.GetField(tranGetMsgs).Data),
862 NewField(fieldChatOptions, []byte{0}),
865 res = append(res, cc.NewReply(t))
869 func byteToInt(bytes []byte) (int, error) {
872 return int(binary.BigEndian.Uint16(bytes)), nil
874 return int(binary.BigEndian.Uint32(bytes)), nil
877 return 0, errors.New("unknown byte length")
880 // HandleGetClientInfoText returns user information for the specific user.
882 // Fields used in the request:
885 // Fields used in the reply:
887 // 101 Data User info text string
888 func HandleGetClientInfoText(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
889 if !authorize(cc.Account.Access, accessGetClientInfo) {
890 res = append(res, cc.NewErrReply(t, "You are not allowed to get client info."))
894 clientID, _ := byteToInt(t.GetField(fieldUserID).Data)
896 clientConn := cc.Server.Clients[uint16(clientID)]
897 if clientConn == nil {
898 return append(res, cc.NewErrReply(t, "User not found.")), err
901 res = append(res, cc.NewReply(t,
902 NewField(fieldData, []byte(clientConn.String())),
903 NewField(fieldUserName, clientConn.UserName),
908 func HandleGetUserNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
909 res = append(res, cc.NewReply(t, cc.Server.connectedUsers()...))
914 func HandleTranAgreed(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
917 if t.GetField(fieldUserName).Data != nil {
918 if cc.Authorize(accessAnyName) {
919 cc.UserName = t.GetField(fieldUserName).Data
921 cc.UserName = []byte(cc.Account.Name)
925 cc.Icon = t.GetField(fieldUserIconID).Data
927 cc.logger = cc.logger.With("name", string(cc.UserName))
928 cc.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%x", cc.Version))
930 options := t.GetField(fieldOptions).Data
931 optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
933 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(cc.Flags)))
935 // Check refuse private PM option
936 if optBitmap.Bit(refusePM) == 1 {
937 flagBitmap.SetBit(flagBitmap, userFlagRefusePM, 1)
938 binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
941 // Check refuse private chat option
942 if optBitmap.Bit(refuseChat) == 1 {
943 flagBitmap.SetBit(flagBitmap, userFLagRefusePChat, 1)
944 binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
947 // Check auto response
948 if optBitmap.Bit(autoResponse) == 1 {
949 cc.AutoReply = t.GetField(fieldAutomaticResponse).Data
951 cc.AutoReply = []byte{}
954 trans := cc.notifyOthers(
956 tranNotifyChangeUser, nil,
957 NewField(fieldUserName, cc.UserName),
958 NewField(fieldUserID, *cc.ID),
959 NewField(fieldUserIconID, cc.Icon),
960 NewField(fieldUserFlags, cc.Flags),
963 res = append(res, trans...)
965 if cc.Server.Config.BannerFile != "" {
966 res = append(res, *NewTransaction(tranServerBanner, cc.ID, NewField(fieldBannerType, []byte("JPEG"))))
969 res = append(res, cc.NewReply(t))
974 const defaultNewsDateFormat = "Jan02 15:04" // Jun23 20:49
975 // "Mon, 02 Jan 2006 15:04:05 MST"
977 const defaultNewsTemplate = `From %s (%s):
981 __________________________________________________________`
983 // HandleTranOldPostNews updates the flat news
984 // Fields used in this request:
986 func HandleTranOldPostNews(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
987 if !authorize(cc.Account.Access, accessNewsPostArt) {
988 res = append(res, cc.NewErrReply(t, "You are not allowed to post news."))
992 cc.Server.flatNewsMux.Lock()
993 defer cc.Server.flatNewsMux.Unlock()
995 newsDateTemplate := defaultNewsDateFormat
996 if cc.Server.Config.NewsDateFormat != "" {
997 newsDateTemplate = cc.Server.Config.NewsDateFormat
1000 newsTemplate := defaultNewsTemplate
1001 if cc.Server.Config.NewsDelimiter != "" {
1002 newsTemplate = cc.Server.Config.NewsDelimiter
1005 newsPost := fmt.Sprintf(newsTemplate+"\r", cc.UserName, time.Now().Format(newsDateTemplate), t.GetField(fieldData).Data)
1006 newsPost = strings.Replace(newsPost, "\n", "\r", -1)
1008 // update news in memory
1009 cc.Server.FlatNews = append([]byte(newsPost), cc.Server.FlatNews...)
1011 // update news on disk
1012 if err := ioutil.WriteFile(cc.Server.ConfigDir+"MessageBoard.txt", cc.Server.FlatNews, 0644); err != nil {
1016 // Notify all clients of updated news
1019 NewField(fieldData, []byte(newsPost)),
1022 res = append(res, cc.NewReply(t))
1026 func HandleDisconnectUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1027 if !authorize(cc.Account.Access, accessDisconUser) {
1028 res = append(res, cc.NewErrReply(t, "You are not allowed to disconnect users."))
1032 clientConn := cc.Server.Clients[binary.BigEndian.Uint16(t.GetField(fieldUserID).Data)]
1034 if authorize(clientConn.Account.Access, accessCannotBeDiscon) {
1035 res = append(res, cc.NewErrReply(t, clientConn.Account.Login+" is not allowed to be disconnected."))
1039 // If fieldOptions is set, then the client IP is banned in addition to disconnected.
1040 // 00 01 = temporary ban
1041 // 00 02 = permanent ban
1042 if t.GetField(fieldOptions).Data != nil {
1043 switch t.GetField(fieldOptions).Data[1] {
1045 // send message: "You are temporarily banned on this server"
1046 cc.logger.Infow("Disconnect & temporarily ban " + string(clientConn.UserName))
1048 res = append(res, *NewTransaction(
1051 NewField(fieldData, []byte("You are temporarily banned on this server")),
1052 NewField(fieldChatOptions, []byte{0, 0}),
1055 banUntil := time.Now().Add(tempBanDuration)
1056 cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = &banUntil
1057 cc.Server.writeBanList()
1059 // send message: "You are permanently banned on this server"
1060 cc.logger.Infow("Disconnect & ban " + string(clientConn.UserName))
1062 res = append(res, *NewTransaction(
1065 NewField(fieldData, []byte("You are permanently banned on this server")),
1066 NewField(fieldChatOptions, []byte{0, 0}),
1069 cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = nil
1070 cc.Server.writeBanList()
1074 // TODO: remove this awful hack
1076 time.Sleep(1 * time.Second)
1077 clientConn.Disconnect()
1080 return append(res, cc.NewReply(t)), err
1083 // HandleGetNewsCatNameList returns a list of news categories for a path
1084 // Fields used in the request:
1085 // 325 News path (Optional)
1086 func HandleGetNewsCatNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1087 if !authorize(cc.Account.Access, accessNewsReadArt) {
1088 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1092 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1093 cats := cc.Server.GetNewsCatByPath(pathStrs)
1095 // To store the keys in slice in sorted order
1096 keys := make([]string, len(cats))
1098 for k := range cats {
1104 var fieldData []Field
1105 for _, k := range keys {
1107 b, _ := cat.MarshalBinary()
1108 fieldData = append(fieldData, NewField(
1109 fieldNewsCatListData15,
1114 res = append(res, cc.NewReply(t, fieldData...))
1118 func HandleNewNewsCat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1119 if !authorize(cc.Account.Access, accessNewsCreateCat) {
1120 res = append(res, cc.NewErrReply(t, "You are not allowed to create news categories."))
1124 name := string(t.GetField(fieldNewsCatName).Data)
1125 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1127 cats := cc.Server.GetNewsCatByPath(pathStrs)
1128 cats[name] = NewsCategoryListData15{
1131 Articles: map[uint32]*NewsArtData{},
1132 SubCats: make(map[string]NewsCategoryListData15),
1135 if err := cc.Server.writeThreadedNews(); err != nil {
1138 res = append(res, cc.NewReply(t))
1142 // Fields used in the request:
1143 // 322 News category name
1145 func HandleNewNewsFldr(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1146 if !authorize(cc.Account.Access, accessNewsCreateFldr) {
1147 res = append(res, cc.NewErrReply(t, "You are not allowed to create news folders."))
1151 name := string(t.GetField(fieldFileName).Data)
1152 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1154 cc.logger.Infof("Creating new news folder %s", name)
1156 cats := cc.Server.GetNewsCatByPath(pathStrs)
1157 cats[name] = NewsCategoryListData15{
1160 Articles: map[uint32]*NewsArtData{},
1161 SubCats: make(map[string]NewsCategoryListData15),
1163 if err := cc.Server.writeThreadedNews(); err != nil {
1166 res = append(res, cc.NewReply(t))
1170 // Fields used in the request:
1171 // 325 News path Optional
1174 // 321 News article list data Optional
1175 func HandleGetNewsArtNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1176 if !authorize(cc.Account.Access, accessNewsReadArt) {
1177 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1180 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1182 var cat NewsCategoryListData15
1183 cats := cc.Server.ThreadedNews.Categories
1185 for _, fp := range pathStrs {
1187 cats = cats[fp].SubCats
1190 nald := cat.GetNewsArtListData()
1192 res = append(res, cc.NewReply(t, NewField(fieldNewsArtListData, nald.Payload())))
1196 func HandleGetNewsArtData(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1197 if !authorize(cc.Account.Access, accessNewsReadArt) {
1198 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1204 // 326 News article ID
1205 // 327 News article data flavor
1207 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1209 var cat NewsCategoryListData15
1210 cats := cc.Server.ThreadedNews.Categories
1212 for _, fp := range pathStrs {
1214 cats = cats[fp].SubCats
1216 newsArtID := t.GetField(fieldNewsArtID).Data
1218 convertedArtID := binary.BigEndian.Uint16(newsArtID)
1220 art := cat.Articles[uint32(convertedArtID)]
1222 res = append(res, cc.NewReply(t))
1227 // 328 News article title
1228 // 329 News article poster
1229 // 330 News article date
1230 // 331 Previous article ID
1231 // 332 Next article ID
1232 // 335 Parent article ID
1233 // 336 First child article ID
1234 // 327 News article data flavor "Should be “text/plain”
1235 // 333 News article data Optional (if data flavor is “text/plain”)
1237 res = append(res, cc.NewReply(t,
1238 NewField(fieldNewsArtTitle, []byte(art.Title)),
1239 NewField(fieldNewsArtPoster, []byte(art.Poster)),
1240 NewField(fieldNewsArtDate, art.Date),
1241 NewField(fieldNewsArtPrevArt, art.PrevArt),
1242 NewField(fieldNewsArtNextArt, art.NextArt),
1243 NewField(fieldNewsArtParentArt, art.ParentArt),
1244 NewField(fieldNewsArt1stChildArt, art.FirstChildArt),
1245 NewField(fieldNewsArtDataFlav, []byte("text/plain")),
1246 NewField(fieldNewsArtData, []byte(art.Data)),
1251 func HandleDelNewsItem(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1252 // Has multiple access flags: News Delete Folder (37) or News Delete Category (35)
1255 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1257 // TODO: determine if path is a Folder (Bundle) or Category and check for permission
1259 cc.logger.Infof("DelNewsItem %v", pathStrs)
1261 cats := cc.Server.ThreadedNews.Categories
1263 delName := pathStrs[len(pathStrs)-1]
1264 if len(pathStrs) > 1 {
1265 for _, fp := range pathStrs[0 : len(pathStrs)-1] {
1266 cats = cats[fp].SubCats
1270 delete(cats, delName)
1272 err = cc.Server.writeThreadedNews()
1277 // Reply params: none
1278 res = append(res, cc.NewReply(t))
1283 func HandleDelNewsArt(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1284 if !authorize(cc.Account.Access, accessNewsDeleteArt) {
1285 res = append(res, cc.NewErrReply(t, "You are not allowed to delete news articles."))
1291 // 326 News article ID
1292 // 337 News article – recursive delete Delete child articles (1) or not (0)
1293 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1294 ID := binary.BigEndian.Uint16(t.GetField(fieldNewsArtID).Data)
1296 // TODO: Delete recursive
1297 cats := cc.Server.GetNewsCatByPath(pathStrs[:len(pathStrs)-1])
1299 catName := pathStrs[len(pathStrs)-1]
1300 cat := cats[catName]
1302 delete(cat.Articles, uint32(ID))
1305 if err := cc.Server.writeThreadedNews(); err != nil {
1309 res = append(res, cc.NewReply(t))
1315 // 326 News article ID ID of the parent article?
1316 // 328 News article title
1317 // 334 News article flags
1318 // 327 News article data flavor Currently “text/plain”
1319 // 333 News article data
1320 func HandlePostNewsArt(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1321 if !authorize(cc.Account.Access, accessNewsPostArt) {
1322 res = append(res, cc.NewErrReply(t, "You are not allowed to post news articles."))
1326 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1327 cats := cc.Server.GetNewsCatByPath(pathStrs[:len(pathStrs)-1])
1329 catName := pathStrs[len(pathStrs)-1]
1330 cat := cats[catName]
1332 newArt := NewsArtData{
1333 Title: string(t.GetField(fieldNewsArtTitle).Data),
1334 Poster: string(cc.UserName),
1335 Date: toHotlineTime(time.Now()),
1336 PrevArt: []byte{0, 0, 0, 0},
1337 NextArt: []byte{0, 0, 0, 0},
1338 ParentArt: append([]byte{0, 0}, t.GetField(fieldNewsArtID).Data...),
1339 FirstChildArt: []byte{0, 0, 0, 0},
1340 DataFlav: []byte("text/plain"),
1341 Data: string(t.GetField(fieldNewsArtData).Data),
1345 for k := range cat.Articles {
1346 keys = append(keys, int(k))
1352 prevID := uint32(keys[len(keys)-1])
1355 binary.BigEndian.PutUint32(newArt.PrevArt, prevID)
1357 // Set next article ID
1358 binary.BigEndian.PutUint32(cat.Articles[prevID].NextArt, nextID)
1361 // Update parent article with first child reply
1362 parentID := binary.BigEndian.Uint16(t.GetField(fieldNewsArtID).Data)
1364 parentArt := cat.Articles[uint32(parentID)]
1366 if bytes.Equal(parentArt.FirstChildArt, []byte{0, 0, 0, 0}) {
1367 binary.BigEndian.PutUint32(parentArt.FirstChildArt, nextID)
1371 cat.Articles[nextID] = &newArt
1374 if err := cc.Server.writeThreadedNews(); err != nil {
1378 res = append(res, cc.NewReply(t))
1382 // HandleGetMsgs returns the flat news data
1383 func HandleGetMsgs(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1384 if !authorize(cc.Account.Access, accessNewsReadArt) {
1385 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1389 res = append(res, cc.NewReply(t, NewField(fieldData, cc.Server.FlatNews)))
1394 func HandleDownloadFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1395 if !authorize(cc.Account.Access, accessDownloadFile) {
1396 res = append(res, cc.NewErrReply(t, "You are not allowed to download files."))
1400 fileName := t.GetField(fieldFileName).Data
1401 filePath := t.GetField(fieldFilePath).Data
1402 resumeData := t.GetField(fieldFileResumeData).Data
1404 var dataOffset int64
1405 var frd FileResumeData
1406 if resumeData != nil {
1407 if err := frd.UnmarshalBinary(t.GetField(fieldFileResumeData).Data); err != nil {
1410 // TODO: handle rsrc fork offset
1411 dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:]))
1414 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1419 hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, dataOffset)
1424 xferSize := hlFile.ffo.TransferSize(0)
1426 ft := cc.newFileTransfer(FileDownload, fileName, filePath, xferSize)
1428 // TODO: refactor to remove this
1429 if resumeData != nil {
1430 var frd FileResumeData
1431 if err := frd.UnmarshalBinary(t.GetField(fieldFileResumeData).Data); err != nil {
1434 ft.fileResumeData = &frd
1437 // Optional field for when a HL v1.5+ client requests file preview
1438 // Used only for TEXT, JPEG, GIFF, BMP or PICT files
1439 // The value will always be 2
1440 if t.GetField(fieldFileTransferOptions).Data != nil {
1441 ft.options = t.GetField(fieldFileTransferOptions).Data
1442 xferSize = hlFile.ffo.FlatFileDataForkHeader.DataSize[:]
1445 res = append(res, cc.NewReply(t,
1446 NewField(fieldRefNum, ft.refNum[:]),
1447 NewField(fieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
1448 NewField(fieldTransferSize, xferSize),
1449 NewField(fieldFileSize, hlFile.ffo.FlatFileDataForkHeader.DataSize[:]),
1455 // Download all files from the specified folder and sub-folders
1456 func HandleDownloadFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1457 if !authorize(cc.Account.Access, accessDownloadFile) {
1458 res = append(res, cc.NewErrReply(t, "You are not allowed to download folders."))
1462 fullFilePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFilePath).Data, t.GetField(fieldFileName).Data)
1467 transferSize, err := CalcTotalSize(fullFilePath)
1471 itemCount, err := CalcItemCount(fullFilePath)
1476 fileTransfer := cc.newFileTransfer(FolderDownload, t.GetField(fieldFileName).Data, t.GetField(fieldFilePath).Data, transferSize)
1479 err = fp.UnmarshalBinary(t.GetField(fieldFilePath).Data)
1484 res = append(res, cc.NewReply(t,
1485 NewField(fieldRefNum, fileTransfer.ReferenceNumber),
1486 NewField(fieldTransferSize, transferSize),
1487 NewField(fieldFolderItemCount, itemCount),
1488 NewField(fieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
1493 // Upload all files from the local folder and its subfolders to the specified path on the server
1494 // Fields used in the request
1497 // 108 transfer size Total size of all items in the folder
1498 // 220 Folder item count
1499 // 204 File transfer options "Optional Currently set to 1" (TODO: ??)
1500 func HandleUploadFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1502 if t.GetField(fieldFilePath).Data != nil {
1503 if err = fp.UnmarshalBinary(t.GetField(fieldFilePath).Data); err != nil {
1508 // Handle special cases for Upload and Drop Box folders
1509 if !authorize(cc.Account.Access, accessUploadAnywhere) {
1510 if !fp.IsUploadDir() && !fp.IsDropbox() {
1511 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))))
1516 fileTransfer := cc.newFileTransfer(FolderUpload,
1517 t.GetField(fieldFileName).Data,
1518 t.GetField(fieldFilePath).Data,
1519 t.GetField(fieldTransferSize).Data,
1522 fileTransfer.FolderItemCount = t.GetField(fieldFolderItemCount).Data
1524 res = append(res, cc.NewReply(t, NewField(fieldRefNum, fileTransfer.ReferenceNumber)))
1529 // Fields used in the request:
1532 // 204 File transfer options "Optional
1533 // Used only to resume download, currently has value 2"
1534 // 108 File transfer size "Optional used if download is not resumed"
1535 func HandleUploadFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1536 if !authorize(cc.Account.Access, accessUploadFile) {
1537 res = append(res, cc.NewErrReply(t, "You are not allowed to upload files."))
1541 fileName := t.GetField(fieldFileName).Data
1542 filePath := t.GetField(fieldFilePath).Data
1543 transferOptions := t.GetField(fieldFileTransferOptions).Data
1544 transferSize := t.GetField(fieldTransferSize).Data // not sent for resume
1547 if filePath != nil {
1548 if err = fp.UnmarshalBinary(filePath); err != nil {
1553 // Handle special cases for Upload and Drop Box folders
1554 if !authorize(cc.Account.Access, accessUploadAnywhere) {
1555 if !fp.IsUploadDir() && !fp.IsDropbox() {
1556 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))))
1560 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1565 if _, err := cc.Server.FS.Stat(fullFilePath); err == nil {
1566 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))))
1570 ft := cc.newFileTransfer(FileUpload, fileName, filePath, transferSize)
1572 replyT := cc.NewReply(t, NewField(fieldRefNum, ft.ReferenceNumber))
1574 // client has requested to resume a partially transferred file
1575 if transferOptions != nil {
1577 fileInfo, err := cc.Server.FS.Stat(fullFilePath + incompleteFileSuffix)
1582 offset := make([]byte, 4)
1583 binary.BigEndian.PutUint32(offset, uint32(fileInfo.Size()))
1585 fileResumeData := NewFileResumeData([]ForkInfoList{
1586 *NewForkInfoList(offset),
1589 b, _ := fileResumeData.BinaryMarshal()
1591 ft.TransferSize = offset
1593 replyT.Fields = append(replyT.Fields, NewField(fieldFileResumeData, b))
1596 res = append(res, replyT)
1600 func HandleSetClientUserInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1601 if len(t.GetField(fieldUserIconID).Data) == 4 {
1602 cc.Icon = t.GetField(fieldUserIconID).Data[2:]
1604 cc.Icon = t.GetField(fieldUserIconID).Data
1606 if cc.Authorize(accessAnyName) {
1607 cc.UserName = t.GetField(fieldUserName).Data
1610 // the options field is only passed by the client versions > 1.2.3.
1611 options := t.GetField(fieldOptions).Data
1613 optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
1614 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(cc.Flags)))
1616 flagBitmap.SetBit(flagBitmap, userFlagRefusePM, optBitmap.Bit(refusePM))
1617 binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
1619 flagBitmap.SetBit(flagBitmap, userFLagRefusePChat, optBitmap.Bit(refuseChat))
1620 binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
1622 // Check auto response
1623 if optBitmap.Bit(autoResponse) == 1 {
1624 cc.AutoReply = t.GetField(fieldAutomaticResponse).Data
1626 cc.AutoReply = []byte{}
1630 for _, c := range sortedClients(cc.Server.Clients) {
1631 res = append(res, *NewTransaction(
1632 tranNotifyChangeUser,
1634 NewField(fieldUserID, *cc.ID),
1635 NewField(fieldUserIconID, cc.Icon),
1636 NewField(fieldUserFlags, cc.Flags),
1637 NewField(fieldUserName, cc.UserName),
1644 // HandleKeepAlive responds to keepalive transactions with an empty reply
1645 // * HL 1.9.2 Client sends keepalive msg every 3 minutes
1646 // * HL 1.2.3 Client doesn't send keepalives
1647 func HandleKeepAlive(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1648 res = append(res, cc.NewReply(t))
1653 func HandleGetFileNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1654 fullPath, err := readPath(
1655 cc.Server.Config.FileRoot,
1656 t.GetField(fieldFilePath).Data,
1664 if t.GetField(fieldFilePath).Data != nil {
1665 if err = fp.UnmarshalBinary(t.GetField(fieldFilePath).Data); err != nil {
1670 // Handle special case for drop box folders
1671 if fp.IsDropbox() && !authorize(cc.Account.Access, accessViewDropBoxes) {
1672 res = append(res, cc.NewErrReply(t, "You are not allowed to view drop boxes."))
1676 fileNames, err := getFileNameList(fullPath, cc.Server.Config.IgnoreFiles)
1681 res = append(res, cc.NewReply(t, fileNames...))
1686 // =================================
1687 // Hotline private chat flow
1688 // =================================
1689 // 1. ClientA sends tranInviteNewChat to server with user ID to invite
1690 // 2. Server creates new ChatID
1691 // 3. Server sends tranInviteToChat to invitee
1692 // 4. Server replies to ClientA with new Chat ID
1694 // A dialog box pops up in the invitee client with options to accept or decline the invitation.
1695 // If Accepted is clicked:
1696 // 1. ClientB sends tranJoinChat with fieldChatID
1698 // HandleInviteNewChat invites users to new private chat
1699 func HandleInviteNewChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1700 if !authorize(cc.Account.Access, accessOpenChat) {
1701 res = append(res, cc.NewErrReply(t, "You are not allowed to request private chat."))
1706 targetID := t.GetField(fieldUserID).Data
1707 newChatID := cc.Server.NewPrivateChat(cc)
1713 NewField(fieldChatID, newChatID),
1714 NewField(fieldUserName, cc.UserName),
1715 NewField(fieldUserID, *cc.ID),
1721 NewField(fieldChatID, newChatID),
1722 NewField(fieldUserName, cc.UserName),
1723 NewField(fieldUserID, *cc.ID),
1724 NewField(fieldUserIconID, cc.Icon),
1725 NewField(fieldUserFlags, cc.Flags),
1732 func HandleInviteToChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1733 if !authorize(cc.Account.Access, accessOpenChat) {
1734 res = append(res, cc.NewErrReply(t, "You are not allowed to request private chat."))
1739 targetID := t.GetField(fieldUserID).Data
1740 chatID := t.GetField(fieldChatID).Data
1746 NewField(fieldChatID, chatID),
1747 NewField(fieldUserName, cc.UserName),
1748 NewField(fieldUserID, *cc.ID),
1754 NewField(fieldChatID, chatID),
1755 NewField(fieldUserName, cc.UserName),
1756 NewField(fieldUserID, *cc.ID),
1757 NewField(fieldUserIconID, cc.Icon),
1758 NewField(fieldUserFlags, cc.Flags),
1765 func HandleRejectChatInvite(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1766 chatID := t.GetField(fieldChatID).Data
1767 chatInt := binary.BigEndian.Uint32(chatID)
1769 privChat := cc.Server.PrivateChats[chatInt]
1771 resMsg := append(cc.UserName, []byte(" declined invitation to chat")...)
1773 for _, c := range sortedClients(privChat.ClientConn) {
1778 NewField(fieldChatID, chatID),
1779 NewField(fieldData, resMsg),
1787 // HandleJoinChat is sent from a v1.8+ Hotline client when the joins a private chat
1788 // Fields used in the reply:
1789 // * 115 Chat subject
1790 // * 300 User name with info (Optional)
1791 // * 300 (more user names with info)
1792 func HandleJoinChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1793 chatID := t.GetField(fieldChatID).Data
1794 chatInt := binary.BigEndian.Uint32(chatID)
1796 privChat := cc.Server.PrivateChats[chatInt]
1798 // Send tranNotifyChatChangeUser to current members of the chat to inform of new user
1799 for _, c := range sortedClients(privChat.ClientConn) {
1802 tranNotifyChatChangeUser,
1804 NewField(fieldChatID, chatID),
1805 NewField(fieldUserName, cc.UserName),
1806 NewField(fieldUserID, *cc.ID),
1807 NewField(fieldUserIconID, cc.Icon),
1808 NewField(fieldUserFlags, cc.Flags),
1813 privChat.ClientConn[cc.uint16ID()] = cc
1815 replyFields := []Field{NewField(fieldChatSubject, []byte(privChat.Subject))}
1816 for _, c := range sortedClients(privChat.ClientConn) {
1821 Name: string(c.UserName),
1824 replyFields = append(replyFields, NewField(fieldUsernameWithInfo, user.Payload()))
1827 res = append(res, cc.NewReply(t, replyFields...))
1831 // HandleLeaveChat is sent from a v1.8+ Hotline client when the user exits a private chat
1832 // Fields used in the request:
1833 // * 114 fieldChatID
1834 // Reply is not expected.
1835 func HandleLeaveChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1836 chatID := t.GetField(fieldChatID).Data
1837 chatInt := binary.BigEndian.Uint32(chatID)
1839 privChat, ok := cc.Server.PrivateChats[chatInt]
1844 delete(privChat.ClientConn, cc.uint16ID())
1846 // Notify members of the private chat that the user has left
1847 for _, c := range sortedClients(privChat.ClientConn) {
1850 tranNotifyChatDeleteUser,
1852 NewField(fieldChatID, chatID),
1853 NewField(fieldUserID, *cc.ID),
1861 // HandleSetChatSubject is sent from a v1.8+ Hotline client when the user sets a private chat subject
1862 // Fields used in the request:
1864 // * 115 Chat subject Chat subject string
1865 // Reply is not expected.
1866 func HandleSetChatSubject(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1867 chatID := t.GetField(fieldChatID).Data
1868 chatInt := binary.BigEndian.Uint32(chatID)
1870 privChat := cc.Server.PrivateChats[chatInt]
1871 privChat.Subject = string(t.GetField(fieldChatSubject).Data)
1873 for _, c := range sortedClients(privChat.ClientConn) {
1876 tranNotifyChatSubject,
1878 NewField(fieldChatID, chatID),
1879 NewField(fieldChatSubject, t.GetField(fieldChatSubject).Data),
1887 // HandleMakeAlias makes a filer alias using the specified path.
1888 // Fields used in the request:
1891 // 212 File new path Destination path
1893 // Fields used in the reply:
1895 func HandleMakeAlias(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1896 if !authorize(cc.Account.Access, accessMakeAlias) {
1897 res = append(res, cc.NewErrReply(t, "You are not allowed to make aliases."))
1900 fileName := t.GetField(fieldFileName).Data
1901 filePath := t.GetField(fieldFilePath).Data
1902 fileNewPath := t.GetField(fieldFileNewPath).Data
1904 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1909 fullNewFilePath, err := readPath(cc.Server.Config.FileRoot, fileNewPath, fileName)
1914 cc.logger.Debugw("Make alias", "src", fullFilePath, "dst", fullNewFilePath)
1916 if err := cc.Server.FS.Symlink(fullFilePath, fullNewFilePath); err != nil {
1917 res = append(res, cc.NewErrReply(t, "Error creating alias"))
1921 res = append(res, cc.NewReply(t))
1925 func HandleDownloadBanner(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1926 fi, err := cc.Server.FS.Stat(filepath.Join(cc.Server.ConfigDir, cc.Server.Config.BannerFile))
1931 ft := cc.newFileTransfer(bannerDownload, []byte{}, []byte{}, make([]byte, 4))
1933 binary.BigEndian.PutUint32(ft.TransferSize, uint32(fi.Size()))
1935 res = append(res, cc.NewReply(t,
1936 NewField(fieldRefNum, ft.refNum[:]),
1937 NewField(fieldTransferSize, ft.TransferSize),