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 msg := t.GetField(fieldData)
303 ID := t.GetField(fieldUserID)
305 reply := NewTransaction(
308 NewField(fieldData, msg.Data),
309 NewField(fieldUserName, cc.UserName),
310 NewField(fieldUserID, *cc.ID),
311 NewField(fieldOptions, []byte{0, 1}),
314 // Later versions of Hotline include the original message in the fieldQuotingMsg field so
315 // the receiving client can display both the received message and what it is in reply to
316 if t.GetField(fieldQuotingMsg).Data != nil {
317 reply.Fields = append(reply.Fields, NewField(fieldQuotingMsg, t.GetField(fieldQuotingMsg).Data))
320 res = append(res, *reply)
322 id, _ := byteToInt(ID.Data)
323 otherClient, ok := cc.Server.Clients[uint16(id)]
325 return res, errors.New("invalid client ID")
328 // Respond with auto reply if other client has it enabled
329 if len(otherClient.AutoReply) > 0 {
334 NewField(fieldData, otherClient.AutoReply),
335 NewField(fieldUserName, otherClient.UserName),
336 NewField(fieldUserID, *otherClient.ID),
337 NewField(fieldOptions, []byte{0, 1}),
342 res = append(res, cc.NewReply(t))
347 func HandleGetFileInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
348 fileName := t.GetField(fieldFileName).Data
349 filePath := t.GetField(fieldFilePath).Data
351 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
356 fw, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
361 res = append(res, cc.NewReply(t,
362 NewField(fieldFileName, []byte(fw.name)),
363 NewField(fieldFileTypeString, fw.ffo.FlatFileInformationFork.friendlyType()),
364 NewField(fieldFileCreatorString, fw.ffo.FlatFileInformationFork.friendlyCreator()),
365 NewField(fieldFileComment, fw.ffo.FlatFileInformationFork.Comment),
366 NewField(fieldFileType, fw.ffo.FlatFileInformationFork.TypeSignature),
367 NewField(fieldFileCreateDate, fw.ffo.FlatFileInformationFork.CreateDate),
368 NewField(fieldFileModifyDate, fw.ffo.FlatFileInformationFork.ModifyDate),
369 NewField(fieldFileSize, fw.totalSize()),
374 // HandleSetFileInfo updates a file or folder name and/or comment from the Get Info window
375 // Fields used in the request:
377 // * 202 File path Optional
378 // * 211 File new name Optional
379 // * 210 File comment Optional
380 // Fields used in the reply: None
381 func HandleSetFileInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
382 fileName := t.GetField(fieldFileName).Data
383 filePath := t.GetField(fieldFilePath).Data
385 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
390 fi, err := cc.Server.FS.Stat(fullFilePath)
395 hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
399 if t.GetField(fieldFileComment).Data != nil {
400 switch mode := fi.Mode(); {
402 if !authorize(cc.Account.Access, accessSetFolderComment) {
403 res = append(res, cc.NewErrReply(t, "You are not allowed to set comments for folders."))
406 case mode.IsRegular():
407 if !authorize(cc.Account.Access, accessSetFileComment) {
408 res = append(res, cc.NewErrReply(t, "You are not allowed to set comments for files."))
413 if err := hlFile.ffo.FlatFileInformationFork.setComment(t.GetField(fieldFileComment).Data); err != nil {
416 w, err := hlFile.infoForkWriter()
420 _, err = w.Write(hlFile.ffo.FlatFileInformationFork.MarshalBinary())
426 fullNewFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, t.GetField(fieldFileNewName).Data)
431 fileNewName := t.GetField(fieldFileNewName).Data
433 if fileNewName != nil {
434 switch mode := fi.Mode(); {
436 if !authorize(cc.Account.Access, accessRenameFolder) {
437 res = append(res, cc.NewErrReply(t, "You are not allowed to rename folders."))
440 err = os.Rename(fullFilePath, fullNewFilePath)
441 if os.IsNotExist(err) {
442 res = append(res, cc.NewErrReply(t, "Cannot rename folder "+string(fileName)+" because it does not exist or cannot be found."))
445 case mode.IsRegular():
446 if !authorize(cc.Account.Access, accessRenameFile) {
447 res = append(res, cc.NewErrReply(t, "You are not allowed to rename files."))
450 fileDir, err := readPath(cc.Server.Config.FileRoot, filePath, []byte{})
454 hlFile.name = string(fileNewName)
455 err = hlFile.move(fileDir)
456 if os.IsNotExist(err) {
457 res = append(res, cc.NewErrReply(t, "Cannot rename file "+string(fileName)+" because it does not exist or cannot be found."))
466 res = append(res, cc.NewReply(t))
470 // HandleDeleteFile deletes a file or folder
471 // Fields used in the request:
474 // Fields used in the reply: none
475 func HandleDeleteFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
476 fileName := t.GetField(fieldFileName).Data
477 filePath := t.GetField(fieldFilePath).Data
479 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
484 hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, 0)
489 fi, err := hlFile.dataFile()
491 res = append(res, cc.NewErrReply(t, "Cannot delete file "+string(fileName)+" because it does not exist or cannot be found."))
495 switch mode := fi.Mode(); {
497 if !authorize(cc.Account.Access, accessDeleteFolder) {
498 res = append(res, cc.NewErrReply(t, "You are not allowed to delete folders."))
501 case mode.IsRegular():
502 if !authorize(cc.Account.Access, accessDeleteFile) {
503 res = append(res, cc.NewErrReply(t, "You are not allowed to delete files."))
508 if err := hlFile.delete(); err != nil {
512 res = append(res, cc.NewReply(t))
516 // HandleMoveFile moves files or folders. Note: seemingly not documented
517 func HandleMoveFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
518 fileName := string(t.GetField(fieldFileName).Data)
520 filePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFilePath).Data, t.GetField(fieldFileName).Data)
525 fileNewPath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFileNewPath).Data, nil)
530 cc.logger.Infow("Move file", "src", filePath+"/"+fileName, "dst", fileNewPath+"/"+fileName)
532 hlFile, err := newFileWrapper(cc.Server.FS, filePath, 0)
537 fi, err := hlFile.dataFile()
539 res = append(res, cc.NewErrReply(t, "Cannot delete file "+fileName+" because it does not exist or cannot be found."))
545 switch mode := fi.Mode(); {
547 if !authorize(cc.Account.Access, accessMoveFolder) {
548 res = append(res, cc.NewErrReply(t, "You are not allowed to move folders."))
551 case mode.IsRegular():
552 if !authorize(cc.Account.Access, accessMoveFile) {
553 res = append(res, cc.NewErrReply(t, "You are not allowed to move files."))
557 if err := hlFile.move(fileNewPath); err != nil {
560 // TODO: handle other possible errors; e.g. fileWrapper delete fails due to fileWrapper permission issue
562 res = append(res, cc.NewReply(t))
566 func HandleNewFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
567 if !authorize(cc.Account.Access, accessCreateFolder) {
568 res = append(res, cc.NewErrReply(t, "You are not allowed to create folders."))
571 folderName := string(t.GetField(fieldFileName).Data)
573 folderName = path.Join("/", folderName)
577 // fieldFilePath is only present for nested paths
578 if t.GetField(fieldFilePath).Data != nil {
580 err := newFp.UnmarshalBinary(t.GetField(fieldFilePath).Data)
585 for _, pathItem := range newFp.Items {
586 subPath = filepath.Join("/", subPath, string(pathItem.Name))
589 newFolderPath := path.Join(cc.Server.Config.FileRoot, subPath, folderName)
591 // TODO: check path and folder name lengths
593 if _, err := cc.Server.FS.Stat(newFolderPath); !os.IsNotExist(err) {
594 msg := fmt.Sprintf("Cannot create folder \"%s\" because there is already a file or folder with that name.", folderName)
595 return []Transaction{cc.NewErrReply(t, msg)}, nil
598 // TODO: check for disallowed characters to maintain compatibility for original client
600 if err := cc.Server.FS.Mkdir(newFolderPath, 0777); err != nil {
601 msg := fmt.Sprintf("Cannot create folder \"%s\" because an error occurred.", folderName)
602 return []Transaction{cc.NewErrReply(t, msg)}, nil
605 res = append(res, cc.NewReply(t))
609 func HandleSetUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
610 if !authorize(cc.Account.Access, accessModifyUser) {
611 res = append(res, cc.NewErrReply(t, "You are not allowed to modify accounts."))
615 login := DecodeUserString(t.GetField(fieldUserLogin).Data)
616 userName := string(t.GetField(fieldUserName).Data)
618 newAccessLvl := t.GetField(fieldUserAccess).Data
620 account := cc.Server.Accounts[login]
621 account.Access = &newAccessLvl
622 account.Name = userName
624 // If the password field is cleared in the Hotline edit user UI, the SetUser transaction does
625 // not include fieldUserPassword
626 if t.GetField(fieldUserPassword).Data == nil {
627 account.Password = hashAndSalt([]byte(""))
629 if len(t.GetField(fieldUserPassword).Data) > 1 {
630 account.Password = hashAndSalt(t.GetField(fieldUserPassword).Data)
633 out, err := yaml.Marshal(&account)
637 if err := os.WriteFile(filepath.Join(cc.Server.ConfigDir, "Users", login+".yaml"), out, 0666); err != nil {
641 // Notify connected clients logged in as the user of the new access level
642 for _, c := range cc.Server.Clients {
643 if c.Account.Login == login {
644 // Note: comment out these two lines to test server-side deny messages
645 newT := NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, newAccessLvl))
646 res = append(res, *newT)
648 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(*c.Flags)))
649 if authorize(c.Account.Access, accessDisconUser) {
650 flagBitmap.SetBit(flagBitmap, userFlagAdmin, 1)
652 flagBitmap.SetBit(flagBitmap, userFlagAdmin, 0)
654 binary.BigEndian.PutUint16(*c.Flags, uint16(flagBitmap.Int64()))
656 c.Account.Access = account.Access
659 tranNotifyChangeUser,
660 NewField(fieldUserID, *c.ID),
661 NewField(fieldUserFlags, *c.Flags),
662 NewField(fieldUserName, c.UserName),
663 NewField(fieldUserIconID, *c.Icon),
668 res = append(res, cc.NewReply(t))
672 func HandleGetUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
673 if !authorize(cc.Account.Access, accessOpenUser) {
674 res = append(res, cc.NewErrReply(t, "You are not allowed to view accounts."))
678 account := cc.Server.Accounts[string(t.GetField(fieldUserLogin).Data)]
680 res = append(res, cc.NewErrReply(t, "Account does not exist."))
684 res = append(res, cc.NewReply(t,
685 NewField(fieldUserName, []byte(account.Name)),
686 NewField(fieldUserLogin, negateString(t.GetField(fieldUserLogin).Data)),
687 NewField(fieldUserPassword, []byte(account.Password)),
688 NewField(fieldUserAccess, *account.Access),
693 func HandleListUsers(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
694 if !authorize(cc.Account.Access, accessOpenUser) {
695 res = append(res, cc.NewErrReply(t, "You are not allowed to view accounts."))
699 var userFields []Field
700 for _, acc := range cc.Server.Accounts {
701 b := make([]byte, 0, 100)
702 n, err := acc.Read(b)
707 userFields = append(userFields, NewField(fieldData, b[:n]))
710 res = append(res, cc.NewReply(t, userFields...))
714 // HandleUpdateUser is used by the v1.5+ multi-user editor to perform account editing for multiple users at a time.
715 // An update can be a mix of these actions:
718 // * Modify user (including renaming the account login)
720 // The Transaction sent by the client includes one data field per user that was modified. This data field in turn
721 // contains another data field encoded in its payload with a varying number of sub fields depending on which action is
722 // performed. This seems to be the only place in the Hotline protocol where a data field contains another data field.
723 func HandleUpdateUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
724 for _, field := range t.Fields {
725 subFields, err := ReadFields(field.Data[0:2], field.Data[2:])
730 if len(subFields) == 1 {
731 login := DecodeUserString(getField(fieldData, &subFields).Data)
732 cc.logger.Infow("DeleteUser", "login", login)
734 if !authorize(cc.Account.Access, accessDeleteUser) {
735 res = append(res, cc.NewErrReply(t, "You are not allowed to delete accounts."))
739 if err := cc.Server.DeleteUser(login); err != nil {
745 login := DecodeUserString(getField(fieldUserLogin, &subFields).Data)
747 // check if the login dataFile; if so, we know we are updating an existing user
748 if acc, ok := cc.Server.Accounts[login]; ok {
749 cc.logger.Infow("UpdateUser", "login", login)
751 // account dataFile, so this is an update action
752 if !authorize(cc.Account.Access, accessModifyUser) {
753 res = append(res, cc.NewErrReply(t, "You are not allowed to modify accounts."))
757 if getField(fieldUserPassword, &subFields) != nil {
758 newPass := getField(fieldUserPassword, &subFields).Data
759 acc.Password = hashAndSalt(newPass)
761 acc.Password = hashAndSalt([]byte(""))
764 if getField(fieldUserAccess, &subFields) != nil {
765 acc.Access = &getField(fieldUserAccess, &subFields).Data
768 err = cc.Server.UpdateUser(
769 DecodeUserString(getField(fieldData, &subFields).Data),
770 DecodeUserString(getField(fieldUserLogin, &subFields).Data),
771 string(getField(fieldUserName, &subFields).Data),
779 cc.logger.Infow("CreateUser", "login", login)
781 if !authorize(cc.Account.Access, accessCreateUser) {
782 res = append(res, cc.NewErrReply(t, "You are not allowed to create new accounts."))
786 err := cc.Server.NewUser(
788 string(getField(fieldUserName, &subFields).Data),
789 string(getField(fieldUserPassword, &subFields).Data),
790 getField(fieldUserAccess, &subFields).Data,
793 return []Transaction{}, err
798 res = append(res, cc.NewReply(t))
802 // HandleNewUser creates a new user account
803 func HandleNewUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
804 if !authorize(cc.Account.Access, accessCreateUser) {
805 res = append(res, cc.NewErrReply(t, "You are not allowed to create new accounts."))
809 login := DecodeUserString(t.GetField(fieldUserLogin).Data)
811 // If the account already dataFile, reply with an error
812 if _, ok := cc.Server.Accounts[login]; ok {
813 res = append(res, cc.NewErrReply(t, "Cannot create account "+login+" because there is already an account with that login."))
817 if err := cc.Server.NewUser(
819 string(t.GetField(fieldUserName).Data),
820 string(t.GetField(fieldUserPassword).Data),
821 t.GetField(fieldUserAccess).Data,
823 return []Transaction{}, err
826 res = append(res, cc.NewReply(t))
830 func HandleDeleteUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
831 if !authorize(cc.Account.Access, accessDeleteUser) {
832 res = append(res, cc.NewErrReply(t, "You are not allowed to delete accounts."))
836 // TODO: Handle case where account doesn't exist; e.g. delete race condition
837 login := DecodeUserString(t.GetField(fieldUserLogin).Data)
839 if err := cc.Server.DeleteUser(login); err != nil {
843 res = append(res, cc.NewReply(t))
847 // HandleUserBroadcast sends an Administrator Message to all connected clients of the server
848 func HandleUserBroadcast(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
849 if !authorize(cc.Account.Access, accessBroadcast) {
850 res = append(res, cc.NewErrReply(t, "You are not allowed to send broadcast messages."))
856 NewField(fieldData, t.GetField(tranGetMsgs).Data),
857 NewField(fieldChatOptions, []byte{0}),
860 res = append(res, cc.NewReply(t))
864 func byteToInt(bytes []byte) (int, error) {
867 return int(binary.BigEndian.Uint16(bytes)), nil
869 return int(binary.BigEndian.Uint32(bytes)), nil
872 return 0, errors.New("unknown byte length")
875 // HandleGetClientInfoText returns user information for the specific user.
877 // Fields used in the request:
880 // Fields used in the reply:
882 // 101 Data User info text string
883 func HandleGetClientInfoText(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
884 if !authorize(cc.Account.Access, accessGetClientInfo) {
885 res = append(res, cc.NewErrReply(t, "You are not allowed to get client info."))
889 clientID, _ := byteToInt(t.GetField(fieldUserID).Data)
891 clientConn := cc.Server.Clients[uint16(clientID)]
892 if clientConn == nil {
893 return append(res, cc.NewErrReply(t, "User not found.")), err
896 res = append(res, cc.NewReply(t,
897 NewField(fieldData, []byte(clientConn.String())),
898 NewField(fieldUserName, clientConn.UserName),
903 func HandleGetUserNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
904 res = append(res, cc.NewReply(t, cc.Server.connectedUsers()...))
909 func HandleTranAgreed(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
911 cc.UserName = t.GetField(fieldUserName).Data
912 *cc.Icon = t.GetField(fieldUserIconID).Data
914 cc.logger = cc.logger.With("name", string(cc.UserName))
915 cc.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%x", *cc.Version))
917 options := t.GetField(fieldOptions).Data
918 optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
920 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(*cc.Flags)))
922 // Check refuse private PM option
923 if optBitmap.Bit(refusePM) == 1 {
924 flagBitmap.SetBit(flagBitmap, userFlagRefusePM, 1)
925 binary.BigEndian.PutUint16(*cc.Flags, uint16(flagBitmap.Int64()))
928 // Check refuse private chat option
929 if optBitmap.Bit(refuseChat) == 1 {
930 flagBitmap.SetBit(flagBitmap, userFLagRefusePChat, 1)
931 binary.BigEndian.PutUint16(*cc.Flags, uint16(flagBitmap.Int64()))
934 // Check auto response
935 if optBitmap.Bit(autoResponse) == 1 {
936 cc.AutoReply = t.GetField(fieldAutomaticResponse).Data
938 cc.AutoReply = []byte{}
941 for _, t := range cc.notifyOthers(
943 tranNotifyChangeUser, nil,
944 NewField(fieldUserName, cc.UserName),
945 NewField(fieldUserID, *cc.ID),
946 NewField(fieldUserIconID, *cc.Icon),
947 NewField(fieldUserFlags, *cc.Flags),
950 cc.Server.outbox <- t
953 if cc.Server.Config.BannerFile != "" {
954 cc.Server.outbox <- *NewTransaction(tranServerBanner, cc.ID, NewField(fieldBannerType, []byte("JPEG")))
957 res = append(res, cc.NewReply(t))
962 const defaultNewsDateFormat = "Jan02 15:04" // Jun23 20:49
963 // "Mon, 02 Jan 2006 15:04:05 MST"
965 const defaultNewsTemplate = `From %s (%s):
969 __________________________________________________________`
971 // HandleTranOldPostNews updates the flat news
972 // Fields used in this request:
974 func HandleTranOldPostNews(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
975 if !authorize(cc.Account.Access, accessNewsPostArt) {
976 res = append(res, cc.NewErrReply(t, "You are not allowed to post news."))
980 cc.Server.flatNewsMux.Lock()
981 defer cc.Server.flatNewsMux.Unlock()
983 newsDateTemplate := defaultNewsDateFormat
984 if cc.Server.Config.NewsDateFormat != "" {
985 newsDateTemplate = cc.Server.Config.NewsDateFormat
988 newsTemplate := defaultNewsTemplate
989 if cc.Server.Config.NewsDelimiter != "" {
990 newsTemplate = cc.Server.Config.NewsDelimiter
993 newsPost := fmt.Sprintf(newsTemplate+"\r", cc.UserName, time.Now().Format(newsDateTemplate), t.GetField(fieldData).Data)
994 newsPost = strings.Replace(newsPost, "\n", "\r", -1)
996 // update news in memory
997 cc.Server.FlatNews = append([]byte(newsPost), cc.Server.FlatNews...)
999 // update news on disk
1000 if err := ioutil.WriteFile(cc.Server.ConfigDir+"MessageBoard.txt", cc.Server.FlatNews, 0644); err != nil {
1004 // Notify all clients of updated news
1007 NewField(fieldData, []byte(newsPost)),
1010 res = append(res, cc.NewReply(t))
1014 func HandleDisconnectUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1015 if !authorize(cc.Account.Access, accessDisconUser) {
1016 res = append(res, cc.NewErrReply(t, "You are not allowed to disconnect users."))
1020 clientConn := cc.Server.Clients[binary.BigEndian.Uint16(t.GetField(fieldUserID).Data)]
1022 if authorize(clientConn.Account.Access, accessCannotBeDiscon) {
1023 res = append(res, cc.NewErrReply(t, clientConn.Account.Login+" is not allowed to be disconnected."))
1027 // If fieldOptions is set, then the client IP is banned in addition to disconnected.
1028 // 00 01 = temporary ban
1029 // 00 02 = permanent ban
1030 if t.GetField(fieldOptions).Data != nil {
1031 switch t.GetField(fieldOptions).Data[1] {
1033 // send message: "You are temporarily banned on this server"
1034 cc.logger.Infow("Disconnect & temporarily ban " + string(clientConn.UserName))
1036 res = append(res, *NewTransaction(
1039 NewField(fieldData, []byte("You are temporarily banned on this server")),
1040 NewField(fieldChatOptions, []byte{0, 0}),
1043 banUntil := time.Now().Add(tempBanDuration)
1044 cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = &banUntil
1045 cc.Server.writeBanList()
1047 // send message: "You are permanently banned on this server"
1048 cc.logger.Infow("Disconnect & ban " + string(clientConn.UserName))
1050 res = append(res, *NewTransaction(
1053 NewField(fieldData, []byte("You are permanently banned on this server")),
1054 NewField(fieldChatOptions, []byte{0, 0}),
1057 cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = nil
1058 cc.Server.writeBanList()
1062 // TODO: remove this awful hack
1064 time.Sleep(1 * time.Second)
1065 clientConn.Disconnect()
1068 return append(res, cc.NewReply(t)), err
1071 // HandleGetNewsCatNameList returns a list of news categories for a path
1072 // Fields used in the request:
1073 // 325 News path (Optional)
1074 func HandleGetNewsCatNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1075 if !authorize(cc.Account.Access, accessNewsReadArt) {
1076 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1080 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1081 cats := cc.Server.GetNewsCatByPath(pathStrs)
1083 // To store the keys in slice in sorted order
1084 keys := make([]string, len(cats))
1086 for k := range cats {
1092 var fieldData []Field
1093 for _, k := range keys {
1095 b, _ := cat.MarshalBinary()
1096 fieldData = append(fieldData, NewField(
1097 fieldNewsCatListData15,
1102 res = append(res, cc.NewReply(t, fieldData...))
1106 func HandleNewNewsCat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1107 if !authorize(cc.Account.Access, accessNewsCreateCat) {
1108 res = append(res, cc.NewErrReply(t, "You are not allowed to create news categories."))
1112 name := string(t.GetField(fieldNewsCatName).Data)
1113 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1115 cats := cc.Server.GetNewsCatByPath(pathStrs)
1116 cats[name] = NewsCategoryListData15{
1119 Articles: map[uint32]*NewsArtData{},
1120 SubCats: make(map[string]NewsCategoryListData15),
1123 if err := cc.Server.writeThreadedNews(); err != nil {
1126 res = append(res, cc.NewReply(t))
1130 // Fields used in the request:
1131 // 322 News category name
1133 func HandleNewNewsFldr(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1134 if !authorize(cc.Account.Access, accessNewsCreateFldr) {
1135 res = append(res, cc.NewErrReply(t, "You are not allowed to create news folders."))
1139 name := string(t.GetField(fieldFileName).Data)
1140 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1142 cc.logger.Infof("Creating new news folder %s", name)
1144 cats := cc.Server.GetNewsCatByPath(pathStrs)
1145 cats[name] = NewsCategoryListData15{
1148 Articles: map[uint32]*NewsArtData{},
1149 SubCats: make(map[string]NewsCategoryListData15),
1151 if err := cc.Server.writeThreadedNews(); err != nil {
1154 res = append(res, cc.NewReply(t))
1158 // Fields used in the request:
1159 // 325 News path Optional
1162 // 321 News article list data Optional
1163 func HandleGetNewsArtNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1164 if !authorize(cc.Account.Access, accessNewsReadArt) {
1165 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1168 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1170 var cat NewsCategoryListData15
1171 cats := cc.Server.ThreadedNews.Categories
1173 for _, fp := range pathStrs {
1175 cats = cats[fp].SubCats
1178 nald := cat.GetNewsArtListData()
1180 res = append(res, cc.NewReply(t, NewField(fieldNewsArtListData, nald.Payload())))
1184 func HandleGetNewsArtData(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1185 if !authorize(cc.Account.Access, accessNewsReadArt) {
1186 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1192 // 326 News article ID
1193 // 327 News article data flavor
1195 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1197 var cat NewsCategoryListData15
1198 cats := cc.Server.ThreadedNews.Categories
1200 for _, fp := range pathStrs {
1202 cats = cats[fp].SubCats
1204 newsArtID := t.GetField(fieldNewsArtID).Data
1206 convertedArtID := binary.BigEndian.Uint16(newsArtID)
1208 art := cat.Articles[uint32(convertedArtID)]
1210 res = append(res, cc.NewReply(t))
1215 // 328 News article title
1216 // 329 News article poster
1217 // 330 News article date
1218 // 331 Previous article ID
1219 // 332 Next article ID
1220 // 335 Parent article ID
1221 // 336 First child article ID
1222 // 327 News article data flavor "Should be “text/plain”
1223 // 333 News article data Optional (if data flavor is “text/plain”)
1225 res = append(res, cc.NewReply(t,
1226 NewField(fieldNewsArtTitle, []byte(art.Title)),
1227 NewField(fieldNewsArtPoster, []byte(art.Poster)),
1228 NewField(fieldNewsArtDate, art.Date),
1229 NewField(fieldNewsArtPrevArt, art.PrevArt),
1230 NewField(fieldNewsArtNextArt, art.NextArt),
1231 NewField(fieldNewsArtParentArt, art.ParentArt),
1232 NewField(fieldNewsArt1stChildArt, art.FirstChildArt),
1233 NewField(fieldNewsArtDataFlav, []byte("text/plain")),
1234 NewField(fieldNewsArtData, []byte(art.Data)),
1239 func HandleDelNewsItem(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1240 // Has multiple access flags: News Delete Folder (37) or News Delete Category (35)
1243 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1245 // TODO: determine if path is a Folder (Bundle) or Category and check for permission
1247 cc.logger.Infof("DelNewsItem %v", pathStrs)
1249 cats := cc.Server.ThreadedNews.Categories
1251 delName := pathStrs[len(pathStrs)-1]
1252 if len(pathStrs) > 1 {
1253 for _, fp := range pathStrs[0 : len(pathStrs)-1] {
1254 cats = cats[fp].SubCats
1258 delete(cats, delName)
1260 err = cc.Server.writeThreadedNews()
1265 // Reply params: none
1266 res = append(res, cc.NewReply(t))
1271 func HandleDelNewsArt(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1272 if !authorize(cc.Account.Access, accessNewsDeleteArt) {
1273 res = append(res, cc.NewErrReply(t, "You are not allowed to delete news articles."))
1279 // 326 News article ID
1280 // 337 News article – recursive delete Delete child articles (1) or not (0)
1281 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1282 ID := binary.BigEndian.Uint16(t.GetField(fieldNewsArtID).Data)
1284 // TODO: Delete recursive
1285 cats := cc.Server.GetNewsCatByPath(pathStrs[:len(pathStrs)-1])
1287 catName := pathStrs[len(pathStrs)-1]
1288 cat := cats[catName]
1290 delete(cat.Articles, uint32(ID))
1293 if err := cc.Server.writeThreadedNews(); err != nil {
1297 res = append(res, cc.NewReply(t))
1303 // 326 News article ID ID of the parent article?
1304 // 328 News article title
1305 // 334 News article flags
1306 // 327 News article data flavor Currently “text/plain”
1307 // 333 News article data
1308 func HandlePostNewsArt(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1309 if !authorize(cc.Account.Access, accessNewsPostArt) {
1310 res = append(res, cc.NewErrReply(t, "You are not allowed to post news articles."))
1314 pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
1315 cats := cc.Server.GetNewsCatByPath(pathStrs[:len(pathStrs)-1])
1317 catName := pathStrs[len(pathStrs)-1]
1318 cat := cats[catName]
1320 newArt := NewsArtData{
1321 Title: string(t.GetField(fieldNewsArtTitle).Data),
1322 Poster: string(cc.UserName),
1323 Date: toHotlineTime(time.Now()),
1324 PrevArt: []byte{0, 0, 0, 0},
1325 NextArt: []byte{0, 0, 0, 0},
1326 ParentArt: append([]byte{0, 0}, t.GetField(fieldNewsArtID).Data...),
1327 FirstChildArt: []byte{0, 0, 0, 0},
1328 DataFlav: []byte("text/plain"),
1329 Data: string(t.GetField(fieldNewsArtData).Data),
1333 for k := range cat.Articles {
1334 keys = append(keys, int(k))
1340 prevID := uint32(keys[len(keys)-1])
1343 binary.BigEndian.PutUint32(newArt.PrevArt, prevID)
1345 // Set next article ID
1346 binary.BigEndian.PutUint32(cat.Articles[prevID].NextArt, nextID)
1349 // Update parent article with first child reply
1350 parentID := binary.BigEndian.Uint16(t.GetField(fieldNewsArtID).Data)
1352 parentArt := cat.Articles[uint32(parentID)]
1354 if bytes.Equal(parentArt.FirstChildArt, []byte{0, 0, 0, 0}) {
1355 binary.BigEndian.PutUint32(parentArt.FirstChildArt, nextID)
1359 cat.Articles[nextID] = &newArt
1362 if err := cc.Server.writeThreadedNews(); err != nil {
1366 res = append(res, cc.NewReply(t))
1370 // HandleGetMsgs returns the flat news data
1371 func HandleGetMsgs(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1372 if !authorize(cc.Account.Access, accessNewsReadArt) {
1373 res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
1377 res = append(res, cc.NewReply(t, NewField(fieldData, cc.Server.FlatNews)))
1382 func HandleDownloadFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1383 if !authorize(cc.Account.Access, accessDownloadFile) {
1384 res = append(res, cc.NewErrReply(t, "You are not allowed to download files."))
1388 fileName := t.GetField(fieldFileName).Data
1389 filePath := t.GetField(fieldFilePath).Data
1390 resumeData := t.GetField(fieldFileResumeData).Data
1392 var dataOffset int64
1393 var frd FileResumeData
1394 if resumeData != nil {
1395 if err := frd.UnmarshalBinary(t.GetField(fieldFileResumeData).Data); err != nil {
1398 // TODO: handle rsrc fork offset
1399 dataOffset = int64(binary.BigEndian.Uint32(frd.ForkInfoList[0].DataSize[:]))
1402 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1407 hlFile, err := newFileWrapper(cc.Server.FS, fullFilePath, dataOffset)
1412 xferSize := hlFile.ffo.TransferSize(0)
1414 ft := cc.newFileTransfer(FileDownload, fileName, filePath, xferSize)
1416 // TODO: refactor to remove this
1417 if resumeData != nil {
1418 var frd FileResumeData
1419 if err := frd.UnmarshalBinary(t.GetField(fieldFileResumeData).Data); err != nil {
1422 ft.fileResumeData = &frd
1425 // Optional field for when a HL v1.5+ client requests file preview
1426 // Used only for TEXT, JPEG, GIFF, BMP or PICT files
1427 // The value will always be 2
1428 if t.GetField(fieldFileTransferOptions).Data != nil {
1429 ft.options = t.GetField(fieldFileTransferOptions).Data
1430 xferSize = hlFile.ffo.FlatFileDataForkHeader.DataSize[:]
1433 res = append(res, cc.NewReply(t,
1434 NewField(fieldRefNum, ft.refNum[:]),
1435 NewField(fieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
1436 NewField(fieldTransferSize, xferSize),
1437 NewField(fieldFileSize, hlFile.ffo.FlatFileDataForkHeader.DataSize[:]),
1443 // Download all files from the specified folder and sub-folders
1444 func HandleDownloadFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1445 if !authorize(cc.Account.Access, accessDownloadFile) {
1446 res = append(res, cc.NewErrReply(t, "You are not allowed to download folders."))
1450 fullFilePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFilePath).Data, t.GetField(fieldFileName).Data)
1455 transferSize, err := CalcTotalSize(fullFilePath)
1459 itemCount, err := CalcItemCount(fullFilePath)
1464 fileTransfer := cc.newFileTransfer(FolderDownload, t.GetField(fieldFileName).Data, t.GetField(fieldFilePath).Data, transferSize)
1467 err = fp.UnmarshalBinary(t.GetField(fieldFilePath).Data)
1472 res = append(res, cc.NewReply(t,
1473 NewField(fieldRefNum, fileTransfer.ReferenceNumber),
1474 NewField(fieldTransferSize, transferSize),
1475 NewField(fieldFolderItemCount, itemCount),
1476 NewField(fieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
1481 // Upload all files from the local folder and its subfolders to the specified path on the server
1482 // Fields used in the request
1485 // 108 transfer size Total size of all items in the folder
1486 // 220 Folder item count
1487 // 204 File transfer options "Optional Currently set to 1" (TODO: ??)
1488 func HandleUploadFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1490 if t.GetField(fieldFilePath).Data != nil {
1491 if err = fp.UnmarshalBinary(t.GetField(fieldFilePath).Data); err != nil {
1496 // Handle special cases for Upload and Drop Box folders
1497 if !authorize(cc.Account.Access, accessUploadAnywhere) {
1498 if !fp.IsUploadDir() && !fp.IsDropbox() {
1499 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))))
1504 fileTransfer := cc.newFileTransfer(FolderUpload,
1505 t.GetField(fieldFileName).Data,
1506 t.GetField(fieldFilePath).Data,
1507 t.GetField(fieldTransferSize).Data,
1510 fileTransfer.FolderItemCount = t.GetField(fieldFolderItemCount).Data
1512 res = append(res, cc.NewReply(t, NewField(fieldRefNum, fileTransfer.ReferenceNumber)))
1517 // Fields used in the request:
1520 // 204 File transfer options "Optional
1521 // Used only to resume download, currently has value 2"
1522 // 108 File transfer size "Optional used if download is not resumed"
1523 func HandleUploadFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1524 if !authorize(cc.Account.Access, accessUploadFile) {
1525 res = append(res, cc.NewErrReply(t, "You are not allowed to upload files."))
1529 fileName := t.GetField(fieldFileName).Data
1530 filePath := t.GetField(fieldFilePath).Data
1531 transferOptions := t.GetField(fieldFileTransferOptions).Data
1532 transferSize := t.GetField(fieldTransferSize).Data // not sent for resume
1535 if filePath != nil {
1536 if err = fp.UnmarshalBinary(filePath); err != nil {
1541 // Handle special cases for Upload and Drop Box folders
1542 if !authorize(cc.Account.Access, accessUploadAnywhere) {
1543 if !fp.IsUploadDir() && !fp.IsDropbox() {
1544 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))))
1548 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1553 if _, err := cc.Server.FS.Stat(fullFilePath); err == nil {
1554 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))))
1558 ft := cc.newFileTransfer(FileUpload, fileName, filePath, transferSize)
1560 replyT := cc.NewReply(t, NewField(fieldRefNum, ft.ReferenceNumber))
1562 // client has requested to resume a partially transferred file
1563 if transferOptions != nil {
1565 fileInfo, err := cc.Server.FS.Stat(fullFilePath + incompleteFileSuffix)
1570 offset := make([]byte, 4)
1571 binary.BigEndian.PutUint32(offset, uint32(fileInfo.Size()))
1573 fileResumeData := NewFileResumeData([]ForkInfoList{
1574 *NewForkInfoList(offset),
1577 b, _ := fileResumeData.BinaryMarshal()
1579 ft.TransferSize = offset
1581 replyT.Fields = append(replyT.Fields, NewField(fieldFileResumeData, b))
1584 res = append(res, replyT)
1588 func HandleSetClientUserInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1590 if len(t.GetField(fieldUserIconID).Data) == 4 {
1591 icon = t.GetField(fieldUserIconID).Data[2:]
1593 icon = t.GetField(fieldUserIconID).Data
1596 cc.UserName = t.GetField(fieldUserName).Data
1598 // the options field is only passed by the client versions > 1.2.3.
1599 options := t.GetField(fieldOptions).Data
1602 optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
1603 flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(*cc.Flags)))
1605 flagBitmap.SetBit(flagBitmap, userFlagRefusePM, optBitmap.Bit(refusePM))
1606 binary.BigEndian.PutUint16(*cc.Flags, uint16(flagBitmap.Int64()))
1608 flagBitmap.SetBit(flagBitmap, userFLagRefusePChat, optBitmap.Bit(refuseChat))
1609 binary.BigEndian.PutUint16(*cc.Flags, uint16(flagBitmap.Int64()))
1611 // Check auto response
1612 if optBitmap.Bit(autoResponse) == 1 {
1613 cc.AutoReply = t.GetField(fieldAutomaticResponse).Data
1615 cc.AutoReply = []byte{}
1619 // Notify all clients of updated user info
1621 tranNotifyChangeUser,
1622 NewField(fieldUserID, *cc.ID),
1623 NewField(fieldUserIconID, *cc.Icon),
1624 NewField(fieldUserFlags, *cc.Flags),
1625 NewField(fieldUserName, cc.UserName),
1631 // HandleKeepAlive responds to keepalive transactions with an empty reply
1632 // * HL 1.9.2 Client sends keepalive msg every 3 minutes
1633 // * HL 1.2.3 Client doesn't send keepalives
1634 func HandleKeepAlive(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1635 res = append(res, cc.NewReply(t))
1640 func HandleGetFileNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1641 fullPath, err := readPath(
1642 cc.Server.Config.FileRoot,
1643 t.GetField(fieldFilePath).Data,
1651 if t.GetField(fieldFilePath).Data != nil {
1652 if err = fp.UnmarshalBinary(t.GetField(fieldFilePath).Data); err != nil {
1657 // Handle special case for drop box folders
1658 if fp.IsDropbox() && !authorize(cc.Account.Access, accessViewDropBoxes) {
1659 res = append(res, cc.NewErrReply(t, "You are not allowed to view drop boxes."))
1663 fileNames, err := getFileNameList(fullPath)
1668 res = append(res, cc.NewReply(t, fileNames...))
1673 // =================================
1674 // Hotline private chat flow
1675 // =================================
1676 // 1. ClientA sends tranInviteNewChat to server with user ID to invite
1677 // 2. Server creates new ChatID
1678 // 3. Server sends tranInviteToChat to invitee
1679 // 4. Server replies to ClientA with new Chat ID
1681 // A dialog box pops up in the invitee client with options to accept or decline the invitation.
1682 // If Accepted is clicked:
1683 // 1. ClientB sends tranJoinChat with fieldChatID
1685 // HandleInviteNewChat invites users to new private chat
1686 func HandleInviteNewChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1687 if !authorize(cc.Account.Access, accessOpenChat) {
1688 res = append(res, cc.NewErrReply(t, "You are not allowed to request private chat."))
1693 targetID := t.GetField(fieldUserID).Data
1694 newChatID := cc.Server.NewPrivateChat(cc)
1700 NewField(fieldChatID, newChatID),
1701 NewField(fieldUserName, cc.UserName),
1702 NewField(fieldUserID, *cc.ID),
1708 NewField(fieldChatID, newChatID),
1709 NewField(fieldUserName, cc.UserName),
1710 NewField(fieldUserID, *cc.ID),
1711 NewField(fieldUserIconID, *cc.Icon),
1712 NewField(fieldUserFlags, *cc.Flags),
1719 func HandleInviteToChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1720 if !authorize(cc.Account.Access, accessOpenChat) {
1721 res = append(res, cc.NewErrReply(t, "You are not allowed to request private chat."))
1726 targetID := t.GetField(fieldUserID).Data
1727 chatID := t.GetField(fieldChatID).Data
1733 NewField(fieldChatID, chatID),
1734 NewField(fieldUserName, cc.UserName),
1735 NewField(fieldUserID, *cc.ID),
1741 NewField(fieldChatID, chatID),
1742 NewField(fieldUserName, cc.UserName),
1743 NewField(fieldUserID, *cc.ID),
1744 NewField(fieldUserIconID, *cc.Icon),
1745 NewField(fieldUserFlags, *cc.Flags),
1752 func HandleRejectChatInvite(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1753 chatID := t.GetField(fieldChatID).Data
1754 chatInt := binary.BigEndian.Uint32(chatID)
1756 privChat := cc.Server.PrivateChats[chatInt]
1758 resMsg := append(cc.UserName, []byte(" declined invitation to chat")...)
1760 for _, c := range sortedClients(privChat.ClientConn) {
1765 NewField(fieldChatID, chatID),
1766 NewField(fieldData, resMsg),
1774 // HandleJoinChat is sent from a v1.8+ Hotline client when the joins a private chat
1775 // Fields used in the reply:
1776 // * 115 Chat subject
1777 // * 300 User name with info (Optional)
1778 // * 300 (more user names with info)
1779 func HandleJoinChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1780 chatID := t.GetField(fieldChatID).Data
1781 chatInt := binary.BigEndian.Uint32(chatID)
1783 privChat := cc.Server.PrivateChats[chatInt]
1785 // Send tranNotifyChatChangeUser to current members of the chat to inform of new user
1786 for _, c := range sortedClients(privChat.ClientConn) {
1789 tranNotifyChatChangeUser,
1791 NewField(fieldChatID, chatID),
1792 NewField(fieldUserName, cc.UserName),
1793 NewField(fieldUserID, *cc.ID),
1794 NewField(fieldUserIconID, *cc.Icon),
1795 NewField(fieldUserFlags, *cc.Flags),
1800 privChat.ClientConn[cc.uint16ID()] = cc
1802 replyFields := []Field{NewField(fieldChatSubject, []byte(privChat.Subject))}
1803 for _, c := range sortedClients(privChat.ClientConn) {
1808 Name: string(c.UserName),
1811 replyFields = append(replyFields, NewField(fieldUsernameWithInfo, user.Payload()))
1814 res = append(res, cc.NewReply(t, replyFields...))
1818 // HandleLeaveChat is sent from a v1.8+ Hotline client when the user exits a private chat
1819 // Fields used in the request:
1820 // * 114 fieldChatID
1821 // Reply is not expected.
1822 func HandleLeaveChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1823 chatID := t.GetField(fieldChatID).Data
1824 chatInt := binary.BigEndian.Uint32(chatID)
1826 privChat, ok := cc.Server.PrivateChats[chatInt]
1831 delete(privChat.ClientConn, cc.uint16ID())
1833 // Notify members of the private chat that the user has left
1834 for _, c := range sortedClients(privChat.ClientConn) {
1837 tranNotifyChatDeleteUser,
1839 NewField(fieldChatID, chatID),
1840 NewField(fieldUserID, *cc.ID),
1848 // HandleSetChatSubject is sent from a v1.8+ Hotline client when the user sets a private chat subject
1849 // Fields used in the request:
1851 // * 115 Chat subject Chat subject string
1852 // Reply is not expected.
1853 func HandleSetChatSubject(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1854 chatID := t.GetField(fieldChatID).Data
1855 chatInt := binary.BigEndian.Uint32(chatID)
1857 privChat := cc.Server.PrivateChats[chatInt]
1858 privChat.Subject = string(t.GetField(fieldChatSubject).Data)
1860 for _, c := range sortedClients(privChat.ClientConn) {
1863 tranNotifyChatSubject,
1865 NewField(fieldChatID, chatID),
1866 NewField(fieldChatSubject, t.GetField(fieldChatSubject).Data),
1874 // HandleMakeAlias makes a filer alias using the specified path.
1875 // Fields used in the request:
1878 // 212 File new path Destination path
1880 // Fields used in the reply:
1882 func HandleMakeAlias(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1883 if !authorize(cc.Account.Access, accessMakeAlias) {
1884 res = append(res, cc.NewErrReply(t, "You are not allowed to make aliases."))
1887 fileName := t.GetField(fieldFileName).Data
1888 filePath := t.GetField(fieldFilePath).Data
1889 fileNewPath := t.GetField(fieldFileNewPath).Data
1891 fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
1896 fullNewFilePath, err := readPath(cc.Server.Config.FileRoot, fileNewPath, fileName)
1901 cc.logger.Debugw("Make alias", "src", fullFilePath, "dst", fullNewFilePath)
1903 if err := cc.Server.FS.Symlink(fullFilePath, fullNewFilePath); err != nil {
1904 res = append(res, cc.NewErrReply(t, "Error creating alias"))
1908 res = append(res, cc.NewReply(t))
1912 func HandleDownloadBanner(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
1913 fi, err := cc.Server.FS.Stat(filepath.Join(cc.Server.ConfigDir, cc.Server.Config.BannerFile))
1918 ft := cc.newFileTransfer(bannerDownload, []byte{}, []byte{}, make([]byte, 4))
1920 binary.BigEndian.PutUint32(ft.TransferSize, uint32(fi.Size()))
1922 res = append(res, cc.NewReply(t,
1923 NewField(fieldRefNum, ft.refNum[:]),
1924 NewField(fieldTransferSize, ft.TransferSize),