package hotline
import (
+ "bufio"
"bytes"
"encoding/binary"
"errors"
"fmt"
"gopkg.in/yaml.v3"
+ "io"
"math/big"
"os"
"path"
"time"
)
+type HandlerFunc func(*ClientConn, *Transaction) ([]Transaction, error)
+
type TransactionType struct {
- Handler func(*ClientConn, *Transaction) ([]Transaction, error) // function for handling the transaction type
- Name string // Name of transaction as it will appear in logging
+ Handler HandlerFunc // function for handling the transaction type
+ Name string // Name of transaction as it will appear in logging
RequiredFields []requiredField
}
var TransactionHandlers = map[uint16]TransactionType{
// Server initiated
- tranChatMsg: {
- Name: "tranChatMsg",
+ TranChatMsg: {
+ Name: "TranChatMsg",
},
// Server initiated
- tranNotifyChangeUser: {
- Name: "tranNotifyChangeUser",
+ TranNotifyChangeUser: {
+ Name: "TranNotifyChangeUser",
},
- tranError: {
- Name: "tranError",
+ TranError: {
+ Name: "TranError",
},
- tranShowAgreement: {
- Name: "tranShowAgreement",
+ TranShowAgreement: {
+ Name: "TranShowAgreement",
},
- tranUserAccess: {
- Name: "tranUserAccess",
+ TranUserAccess: {
+ Name: "TranUserAccess",
},
- tranNotifyDeleteUser: {
- Name: "tranNotifyDeleteUser",
+ TranNotifyDeleteUser: {
+ Name: "TranNotifyDeleteUser",
},
- tranAgreed: {
- Name: "tranAgreed",
+ TranAgreed: {
+ Name: "TranAgreed",
Handler: HandleTranAgreed,
},
- tranChatSend: {
- Name: "tranChatSend",
+ TranChatSend: {
+ Name: "TranChatSend",
Handler: HandleChatSend,
RequiredFields: []requiredField{
{
- ID: fieldData,
+ ID: FieldData,
minLen: 0,
},
},
},
- tranDelNewsArt: {
- Name: "tranDelNewsArt",
+ TranDelNewsArt: {
+ Name: "TranDelNewsArt",
Handler: HandleDelNewsArt,
},
- tranDelNewsItem: {
- Name: "tranDelNewsItem",
+ TranDelNewsItem: {
+ Name: "TranDelNewsItem",
Handler: HandleDelNewsItem,
},
- tranDeleteFile: {
- Name: "tranDeleteFile",
+ TranDeleteFile: {
+ Name: "TranDeleteFile",
Handler: HandleDeleteFile,
},
- tranDeleteUser: {
- Name: "tranDeleteUser",
+ TranDeleteUser: {
+ Name: "TranDeleteUser",
Handler: HandleDeleteUser,
},
- tranDisconnectUser: {
- Name: "tranDisconnectUser",
+ TranDisconnectUser: {
+ Name: "TranDisconnectUser",
Handler: HandleDisconnectUser,
},
- tranDownloadFile: {
- Name: "tranDownloadFile",
+ TranDownloadFile: {
+ Name: "TranDownloadFile",
Handler: HandleDownloadFile,
},
- tranDownloadFldr: {
- Name: "tranDownloadFldr",
+ TranDownloadFldr: {
+ Name: "TranDownloadFldr",
Handler: HandleDownloadFolder,
},
- tranGetClientInfoText: {
- Name: "tranGetClientInfoText",
+ TranGetClientInfoText: {
+ Name: "TranGetClientInfoText",
Handler: HandleGetClientInfoText,
},
- tranGetFileInfo: {
- Name: "tranGetFileInfo",
+ TranGetFileInfo: {
+ Name: "TranGetFileInfo",
Handler: HandleGetFileInfo,
},
- tranGetFileNameList: {
- Name: "tranGetFileNameList",
+ TranGetFileNameList: {
+ Name: "TranGetFileNameList",
Handler: HandleGetFileNameList,
},
- tranGetMsgs: {
- Name: "tranGetMsgs",
+ TranGetMsgs: {
+ Name: "TranGetMsgs",
Handler: HandleGetMsgs,
},
- tranGetNewsArtData: {
- Name: "tranGetNewsArtData",
+ TranGetNewsArtData: {
+ Name: "TranGetNewsArtData",
Handler: HandleGetNewsArtData,
},
- tranGetNewsArtNameList: {
- Name: "tranGetNewsArtNameList",
+ TranGetNewsArtNameList: {
+ Name: "TranGetNewsArtNameList",
Handler: HandleGetNewsArtNameList,
},
- tranGetNewsCatNameList: {
- Name: "tranGetNewsCatNameList",
+ TranGetNewsCatNameList: {
+ Name: "TranGetNewsCatNameList",
Handler: HandleGetNewsCatNameList,
},
- tranGetUser: {
- Name: "tranGetUser",
+ TranGetUser: {
+ Name: "TranGetUser",
Handler: HandleGetUser,
},
- tranGetUserNameList: {
+ TranGetUserNameList: {
Name: "tranHandleGetUserNameList",
Handler: HandleGetUserNameList,
},
- tranInviteNewChat: {
- Name: "tranInviteNewChat",
+ TranInviteNewChat: {
+ Name: "TranInviteNewChat",
Handler: HandleInviteNewChat,
},
- tranInviteToChat: {
- Name: "tranInviteToChat",
+ TranInviteToChat: {
+ Name: "TranInviteToChat",
Handler: HandleInviteToChat,
},
- tranJoinChat: {
- Name: "tranJoinChat",
+ TranJoinChat: {
+ Name: "TranJoinChat",
Handler: HandleJoinChat,
},
- tranKeepAlive: {
- Name: "tranKeepAlive",
+ TranKeepAlive: {
+ Name: "TranKeepAlive",
Handler: HandleKeepAlive,
},
- tranLeaveChat: {
- Name: "tranJoinChat",
+ TranLeaveChat: {
+ Name: "TranJoinChat",
Handler: HandleLeaveChat,
},
- tranListUsers: {
- Name: "tranListUsers",
+ TranListUsers: {
+ Name: "TranListUsers",
Handler: HandleListUsers,
},
- tranMoveFile: {
- Name: "tranMoveFile",
+ TranMoveFile: {
+ Name: "TranMoveFile",
Handler: HandleMoveFile,
},
- tranNewFolder: {
- Name: "tranNewFolder",
+ TranNewFolder: {
+ Name: "TranNewFolder",
Handler: HandleNewFolder,
},
- tranNewNewsCat: {
- Name: "tranNewNewsCat",
+ TranNewNewsCat: {
+ Name: "TranNewNewsCat",
Handler: HandleNewNewsCat,
},
- tranNewNewsFldr: {
- Name: "tranNewNewsFldr",
+ TranNewNewsFldr: {
+ Name: "TranNewNewsFldr",
Handler: HandleNewNewsFldr,
},
- tranNewUser: {
- Name: "tranNewUser",
+ TranNewUser: {
+ Name: "TranNewUser",
Handler: HandleNewUser,
},
- tranUpdateUser: {
- Name: "tranUpdateUser",
+ TranUpdateUser: {
+ Name: "TranUpdateUser",
Handler: HandleUpdateUser,
},
- tranOldPostNews: {
- Name: "tranOldPostNews",
+ TranOldPostNews: {
+ Name: "TranOldPostNews",
Handler: HandleTranOldPostNews,
},
- tranPostNewsArt: {
- Name: "tranPostNewsArt",
+ TranPostNewsArt: {
+ Name: "TranPostNewsArt",
Handler: HandlePostNewsArt,
},
- tranRejectChatInvite: {
- Name: "tranRejectChatInvite",
+ TranRejectChatInvite: {
+ Name: "TranRejectChatInvite",
Handler: HandleRejectChatInvite,
},
- tranSendInstantMsg: {
- Name: "tranSendInstantMsg",
+ TranSendInstantMsg: {
+ Name: "TranSendInstantMsg",
Handler: HandleSendInstantMsg,
RequiredFields: []requiredField{
{
- ID: fieldData,
+ ID: FieldData,
minLen: 0,
},
{
- ID: fieldUserID,
+ ID: FieldUserID,
},
},
},
- tranSetChatSubject: {
- Name: "tranSetChatSubject",
+ TranSetChatSubject: {
+ Name: "TranSetChatSubject",
Handler: HandleSetChatSubject,
},
- tranMakeFileAlias: {
- Name: "tranMakeFileAlias",
+ TranMakeFileAlias: {
+ Name: "TranMakeFileAlias",
Handler: HandleMakeAlias,
RequiredFields: []requiredField{
- {ID: fieldFileName, minLen: 1},
- {ID: fieldFilePath, minLen: 1},
- {ID: fieldFileNewPath, minLen: 1},
+ {ID: FieldFileName, minLen: 1},
+ {ID: FieldFilePath, minLen: 1},
+ {ID: FieldFileNewPath, minLen: 1},
},
},
- tranSetClientUserInfo: {
- Name: "tranSetClientUserInfo",
+ TranSetClientUserInfo: {
+ Name: "TranSetClientUserInfo",
Handler: HandleSetClientUserInfo,
},
- tranSetFileInfo: {
- Name: "tranSetFileInfo",
+ TranSetFileInfo: {
+ Name: "TranSetFileInfo",
Handler: HandleSetFileInfo,
},
- tranSetUser: {
- Name: "tranSetUser",
+ TranSetUser: {
+ Name: "TranSetUser",
Handler: HandleSetUser,
},
- tranUploadFile: {
- Name: "tranUploadFile",
+ TranUploadFile: {
+ Name: "TranUploadFile",
Handler: HandleUploadFile,
},
- tranUploadFldr: {
- Name: "tranUploadFldr",
+ TranUploadFldr: {
+ Name: "TranUploadFldr",
Handler: HandleUploadFolder,
},
- tranUserBroadcast: {
- Name: "tranUserBroadcast",
+ TranUserBroadcast: {
+ Name: "TranUserBroadcast",
Handler: HandleUserBroadcast,
},
- tranDownloadBanner: {
- Name: "tranDownloadBanner",
+ TranDownloadBanner: {
+ Name: "TranDownloadBanner",
Handler: HandleDownloadBanner,
},
}
// Truncate long usernames
trunc := fmt.Sprintf("%13s", cc.UserName)
- formattedMsg := fmt.Sprintf("\r%.14s: %s", trunc, t.GetField(fieldData).Data)
+ formattedMsg := fmt.Sprintf("\r%.14s: %s", trunc, t.GetField(FieldData).Data)
// By holding the option key, Hotline chat allows users to send /me formatted messages like:
// *** Halcyon does stuff
- // This is indicated by the presence of the optional field fieldChatOptions in the transaction payload
- if t.GetField(fieldChatOptions).Data != nil {
- formattedMsg = fmt.Sprintf("\r*** %s %s", cc.UserName, t.GetField(fieldData).Data)
+ // This is indicated by the presence of the optional field FieldChatOptions set to a value of 1.
+ // Most clients do not send this option for normal chat messages.
+ if t.GetField(FieldChatOptions).Data != nil && bytes.Equal(t.GetField(FieldChatOptions).Data, []byte{0, 1}) {
+ formattedMsg = fmt.Sprintf("\r*** %s %s", cc.UserName, t.GetField(FieldData).Data)
}
- chatID := t.GetField(fieldChatID).Data
- // a non-nil chatID indicates the message belongs to a private chat
- if chatID != nil {
+ // The ChatID field is used to identify messages as belonging to a private chat.
+ // All clients *except* Frogblast omit this field for public chat, but Frogblast sends a value of 00 00 00 00.
+ chatID := t.GetField(FieldChatID).Data
+ if chatID != nil && !bytes.Equal([]byte{0, 0, 0, 0}, chatID) {
chatInt := binary.BigEndian.Uint32(chatID)
privChat := cc.Server.PrivateChats[chatInt]
// send the message to all connected clients of the private chat
for _, c := range clients {
res = append(res, *NewTransaction(
- tranChatMsg,
+ TranChatMsg,
c.ID,
- NewField(fieldChatID, chatID),
- NewField(fieldData, []byte(formattedMsg)),
+ NewField(FieldChatID, chatID),
+ NewField(FieldData, []byte(formattedMsg)),
))
}
return res, err
for _, c := range sortedClients(cc.Server.Clients) {
// Filter out clients that do not have the read chat permission
if c.Authorize(accessReadChat) {
- res = append(res, *NewTransaction(tranChatMsg, c.ID, NewField(fieldData, []byte(formattedMsg))))
+ res = append(res, *NewTransaction(TranChatMsg, c.ID, NewField(FieldData, []byte(formattedMsg))))
}
}
// HandleSendInstantMsg sends instant message to the user on the current server.
// Fields used in the request:
+//
// 103 User ID
// 113 Options
// One of the following values:
func HandleSendInstantMsg(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
if !cc.Authorize(accessSendPrivMsg) {
res = append(res, cc.NewErrReply(t, "You are not allowed to send private messages."))
- return res, err
+ return res, errors.New("user is not allowed to send private messages")
}
- msg := t.GetField(fieldData)
- ID := t.GetField(fieldUserID)
+ msg := t.GetField(FieldData)
+ ID := t.GetField(FieldUserID)
reply := NewTransaction(
- tranServerMsg,
+ TranServerMsg,
&ID.Data,
- NewField(fieldData, msg.Data),
- NewField(fieldUserName, cc.UserName),
- NewField(fieldUserID, *cc.ID),
- NewField(fieldOptions, []byte{0, 1}),
+ NewField(FieldData, msg.Data),
+ NewField(FieldUserName, cc.UserName),
+ NewField(FieldUserID, *cc.ID),
+ NewField(FieldOptions, []byte{0, 1}),
)
- // Later versions of Hotline include the original message in the fieldQuotingMsg field so
+ // Later versions of Hotline include the original message in the FieldQuotingMsg field so
// the receiving client can display both the received message and what it is in reply to
- if t.GetField(fieldQuotingMsg).Data != nil {
- reply.Fields = append(reply.Fields, NewField(fieldQuotingMsg, t.GetField(fieldQuotingMsg).Data))
+ if t.GetField(FieldQuotingMsg).Data != nil {
+ reply.Fields = append(reply.Fields, NewField(FieldQuotingMsg, t.GetField(FieldQuotingMsg).Data))
}
- res = append(res, *reply)
-
- id, _ := byteToInt(ID.Data)
+ id, err := byteToInt(ID.Data)
+ if err != nil {
+ return res, errors.New("invalid client ID")
+ }
otherClient, ok := cc.Server.Clients[uint16(id)]
if !ok {
return res, errors.New("invalid client ID")
}
+ // Check if target user has "Refuse private messages" flag
+ flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(otherClient.Flags)))
+ if flagBitmap.Bit(UserFlagRefusePM) == 1 {
+ res = append(res,
+ *NewTransaction(
+ TranServerMsg,
+ cc.ID,
+ NewField(FieldData, []byte(string(otherClient.UserName)+" does not accept private messages.")),
+ NewField(FieldUserName, otherClient.UserName),
+ NewField(FieldUserID, *otherClient.ID),
+ NewField(FieldOptions, []byte{0, 2}),
+ ),
+ )
+ } else {
+ res = append(res, *reply)
+ }
+
// Respond with auto reply if other client has it enabled
if len(otherClient.AutoReply) > 0 {
res = append(res,
*NewTransaction(
- tranServerMsg,
+ TranServerMsg,
cc.ID,
- NewField(fieldData, otherClient.AutoReply),
- NewField(fieldUserName, otherClient.UserName),
- NewField(fieldUserID, *otherClient.ID),
- NewField(fieldOptions, []byte{0, 1}),
+ NewField(FieldData, otherClient.AutoReply),
+ NewField(FieldUserName, otherClient.UserName),
+ NewField(FieldUserID, *otherClient.ID),
+ NewField(FieldOptions, []byte{0, 1}),
),
)
}
}
func HandleGetFileInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- fileName := t.GetField(fieldFileName).Data
- filePath := t.GetField(fieldFilePath).Data
+ fileName := t.GetField(FieldFileName).Data
+ filePath := t.GetField(FieldFilePath).Data
fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
if err != nil {
return res, err
}
- res = append(res, cc.NewReply(t,
- NewField(fieldFileName, []byte(fw.name)),
- NewField(fieldFileTypeString, fw.ffo.FlatFileInformationFork.friendlyType()),
- NewField(fieldFileCreatorString, fw.ffo.FlatFileInformationFork.friendlyCreator()),
- NewField(fieldFileComment, fw.ffo.FlatFileInformationFork.Comment),
- NewField(fieldFileType, fw.ffo.FlatFileInformationFork.TypeSignature),
- NewField(fieldFileCreateDate, fw.ffo.FlatFileInformationFork.CreateDate),
- NewField(fieldFileModifyDate, fw.ffo.FlatFileInformationFork.ModifyDate),
- NewField(fieldFileSize, fw.totalSize()),
- ))
+ encodedName, err := txtEncoder.String(fw.name)
+ if err != nil {
+ return res, fmt.Errorf("invalid filepath encoding: %w", err)
+ }
+
+ fields := []Field{
+ NewField(FieldFileName, []byte(encodedName)),
+ NewField(FieldFileTypeString, fw.ffo.FlatFileInformationFork.friendlyType()),
+ NewField(FieldFileCreatorString, fw.ffo.FlatFileInformationFork.friendlyCreator()),
+ NewField(FieldFileType, fw.ffo.FlatFileInformationFork.TypeSignature),
+ NewField(FieldFileCreateDate, fw.ffo.FlatFileInformationFork.CreateDate),
+ NewField(FieldFileModifyDate, fw.ffo.FlatFileInformationFork.ModifyDate),
+ }
+
+ // Include the optional FileComment field if there is a comment.
+ if len(fw.ffo.FlatFileInformationFork.Comment) != 0 {
+ fields = append(fields, NewField(FieldFileComment, fw.ffo.FlatFileInformationFork.Comment))
+ }
+
+ // Include the FileSize field for files.
+ if !bytes.Equal(fw.ffo.FlatFileInformationFork.TypeSignature, []byte{0x66, 0x6c, 0x64, 0x72}) {
+ fields = append(fields, NewField(FieldFileSize, fw.totalSize()))
+ }
+
+ res = append(res, cc.NewReply(t, fields...))
return res, err
}
-// HandleSetFileInfo updates a file or folder name and/or comment from the Get Info window
+// HandleSetFileInfo updates a file or folder Name and/or comment from the Get Info window
// Fields used in the request:
-// * 201 File name
+// * 201 File Name
// * 202 File path Optional
-// * 211 File new name Optional
+// * 211 File new Name Optional
// * 210 File comment Optional
// Fields used in the reply: None
func HandleSetFileInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- fileName := t.GetField(fieldFileName).Data
- filePath := t.GetField(fieldFilePath).Data
+ fileName := t.GetField(FieldFileName).Data
+ filePath := t.GetField(FieldFilePath).Data
fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
if err != nil {
if err != nil {
return res, err
}
- if t.GetField(fieldFileComment).Data != nil {
+ if t.GetField(FieldFileComment).Data != nil {
switch mode := fi.Mode(); {
case mode.IsDir():
if !cc.Authorize(accessSetFolderComment) {
}
}
- if err := hlFile.ffo.FlatFileInformationFork.setComment(t.GetField(fieldFileComment).Data); err != nil {
+ if err := hlFile.ffo.FlatFileInformationFork.setComment(t.GetField(FieldFileComment).Data); err != nil {
return res, err
}
w, err := hlFile.infoForkWriter()
if err != nil {
return res, err
}
- _, err = w.Write(hlFile.ffo.FlatFileInformationFork.MarshalBinary())
+ _, err = io.Copy(w, &hlFile.ffo.FlatFileInformationFork)
if err != nil {
return res, err
}
}
- fullNewFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, t.GetField(fieldFileNewName).Data)
+ fullNewFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, t.GetField(FieldFileNewName).Data)
if err != nil {
return nil, err
}
- fileNewName := t.GetField(fieldFileNewName).Data
+ fileNewName := t.GetField(FieldFileNewName).Data
if fileNewName != nil {
switch mode := fi.Mode(); {
if err != nil {
return nil, err
}
- hlFile.name = string(fileNewName)
+ hlFile.name, err = txtDecoder.String(string(fileNewName))
+ if err != nil {
+ return res, fmt.Errorf("invalid filepath encoding: %w", err)
+ }
+
err = hlFile.move(fileDir)
if os.IsNotExist(err) {
res = append(res, cc.NewErrReply(t, "Cannot rename file "+string(fileName)+" because it does not exist or cannot be found."))
// HandleDeleteFile deletes a file or folder
// Fields used in the request:
-// * 201 File name
+// * 201 File Name
// * 202 File path
// Fields used in the reply: none
func HandleDeleteFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- fileName := t.GetField(fieldFileName).Data
- filePath := t.GetField(fieldFilePath).Data
+ fileName := t.GetField(FieldFileName).Data
+ filePath := t.GetField(FieldFilePath).Data
fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
if err != nil {
// HandleMoveFile moves files or folders. Note: seemingly not documented
func HandleMoveFile(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- fileName := string(t.GetField(fieldFileName).Data)
+ fileName := string(t.GetField(FieldFileName).Data)
- filePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFilePath).Data, t.GetField(fieldFileName).Data)
+ filePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(FieldFilePath).Data, t.GetField(FieldFileName).Data)
if err != nil {
return res, err
}
- fileNewPath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFileNewPath).Data, nil)
+ fileNewPath, err := readPath(cc.Server.Config.FileRoot, t.GetField(FieldFileNewPath).Data, nil)
if err != nil {
return res, err
}
- cc.logger.Infow("Move file", "src", filePath+"/"+fileName, "dst", fileNewPath+"/"+fileName)
+ cc.logger.Info("Move file", "src", filePath+"/"+fileName, "dst", fileNewPath+"/"+fileName)
hlFile, err := newFileWrapper(cc.Server.FS, filePath, 0)
if err != nil {
res = append(res, cc.NewErrReply(t, "Cannot delete file "+fileName+" because it does not exist or cannot be found."))
return res, err
}
- if err != nil {
- return res, err
- }
switch mode := fi.Mode(); {
case mode.IsDir():
if !cc.Authorize(accessMoveFolder) {
res = append(res, cc.NewErrReply(t, "You are not allowed to create folders."))
return res, err
}
- folderName := string(t.GetField(fieldFileName).Data)
+ folderName := string(t.GetField(FieldFileName).Data)
folderName = path.Join("/", folderName)
var subPath string
- // fieldFilePath is only present for nested paths
- if t.GetField(fieldFilePath).Data != nil {
+ // FieldFilePath is only present for nested paths
+ if t.GetField(FieldFilePath).Data != nil {
var newFp FilePath
- _, err := newFp.Write(t.GetField(fieldFilePath).Data)
+ _, err := newFp.Write(t.GetField(FieldFilePath).Data)
if err != nil {
return nil, err
}
}
}
newFolderPath := path.Join(cc.Server.Config.FileRoot, subPath, folderName)
+ newFolderPath, err = txtDecoder.String(newFolderPath)
+ if err != nil {
+ return res, fmt.Errorf("invalid filepath encoding: %w", err)
+ }
- // TODO: check path and folder name lengths
+ // TODO: check path and folder Name lengths
if _, err := cc.Server.FS.Stat(newFolderPath); !os.IsNotExist(err) {
- msg := fmt.Sprintf("Cannot create folder \"%s\" because there is already a file or folder with that name.", folderName)
+ msg := fmt.Sprintf("Cannot create folder \"%s\" because there is already a file or folder with that Name.", folderName)
return []Transaction{cc.NewErrReply(t, msg)}, nil
}
- // TODO: check for disallowed characters to maintain compatibility for original client
-
if err := cc.Server.FS.Mkdir(newFolderPath, 0777); err != nil {
msg := fmt.Sprintf("Cannot create folder \"%s\" because an error occurred.", folderName)
return []Transaction{cc.NewErrReply(t, msg)}, nil
return res, err
}
- login := DecodeUserString(t.GetField(fieldUserLogin).Data)
- userName := string(t.GetField(fieldUserName).Data)
+ login := string(encodeString(t.GetField(FieldUserLogin).Data))
+ userName := string(t.GetField(FieldUserName).Data)
- newAccessLvl := t.GetField(fieldUserAccess).Data
+ newAccessLvl := t.GetField(FieldUserAccess).Data
account := cc.Server.Accounts[login]
+ if account == nil {
+ return append(res, cc.NewErrReply(t, "Account not found.")), nil
+ }
account.Name = userName
copy(account.Access[:], newAccessLvl)
// If the password field is cleared in the Hotline edit user UI, the SetUser transaction does
- // not include fieldUserPassword
- if t.GetField(fieldUserPassword).Data == nil {
+ // not include FieldUserPassword
+ if t.GetField(FieldUserPassword).Data == nil {
account.Password = hashAndSalt([]byte(""))
}
- if len(t.GetField(fieldUserPassword).Data) > 1 {
- account.Password = hashAndSalt(t.GetField(fieldUserPassword).Data)
+
+ if !bytes.Equal([]byte{0}, t.GetField(FieldUserPassword).Data) {
+ account.Password = hashAndSalt(t.GetField(FieldUserPassword).Data)
}
out, err := yaml.Marshal(&account)
for _, c := range cc.Server.Clients {
if c.Account.Login == login {
// Note: comment out these two lines to test server-side deny messages
- newT := NewTransaction(tranUserAccess, c.ID, NewField(fieldUserAccess, newAccessLvl))
+ newT := NewTransaction(TranUserAccess, c.ID, NewField(FieldUserAccess, newAccessLvl))
res = append(res, *newT)
flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(c.Flags)))
if c.Authorize(accessDisconUser) {
- flagBitmap.SetBit(flagBitmap, userFlagAdmin, 1)
+ flagBitmap.SetBit(flagBitmap, UserFlagAdmin, 1)
} else {
- flagBitmap.SetBit(flagBitmap, userFlagAdmin, 0)
+ flagBitmap.SetBit(flagBitmap, UserFlagAdmin, 0)
}
binary.BigEndian.PutUint16(c.Flags, uint16(flagBitmap.Int64()))
c.Account.Access = account.Access
cc.sendAll(
- tranNotifyChangeUser,
- NewField(fieldUserID, *c.ID),
- NewField(fieldUserFlags, c.Flags),
- NewField(fieldUserName, c.UserName),
- NewField(fieldUserIconID, c.Icon),
+ TranNotifyChangeUser,
+ NewField(FieldUserID, *c.ID),
+ NewField(FieldUserFlags, c.Flags),
+ NewField(FieldUserName, c.UserName),
+ NewField(FieldUserIconID, c.Icon),
)
}
}
return res, err
}
- account := cc.Server.Accounts[string(t.GetField(fieldUserLogin).Data)]
+ account := cc.Server.Accounts[string(t.GetField(FieldUserLogin).Data)]
if account == nil {
res = append(res, cc.NewErrReply(t, "Account does not exist."))
return res, err
}
res = append(res, cc.NewReply(t,
- NewField(fieldUserName, []byte(account.Name)),
- NewField(fieldUserLogin, negateString(t.GetField(fieldUserLogin).Data)),
- NewField(fieldUserPassword, []byte(account.Password)),
- NewField(fieldUserAccess, account.Access[:]),
+ NewField(FieldUserName, []byte(account.Name)),
+ NewField(FieldUserLogin, encodeString(t.GetField(FieldUserLogin).Data)),
+ NewField(FieldUserPassword, []byte(account.Password)),
+ NewField(FieldUserAccess, account.Access[:]),
))
return res, err
}
var userFields []Field
for _, acc := range cc.Server.Accounts {
- b := make([]byte, 0, 100)
- n, err := acc.Read(b)
+ accCopy := *acc
+ b, err := io.ReadAll(&accCopy)
if err != nil {
return res, err
}
- userFields = append(userFields, NewField(fieldData, b[:n]))
+ userFields = append(userFields, NewField(FieldData, b))
}
res = append(res, cc.NewReply(t, userFields...))
// performed. This seems to be the only place in the Hotline protocol where a data field contains another data field.
func HandleUpdateUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
for _, field := range t.Fields {
- subFields, err := ReadFields(field.Data[0:2], field.Data[2:])
- if err != nil {
- return res, err
+
+ var subFields []Field
+
+ // Create a new scanner for parsing incoming bytes into transaction tokens
+ scanner := bufio.NewScanner(bytes.NewReader(field.Data[2:]))
+ scanner.Split(fieldScanner)
+
+ for i := 0; i < int(binary.BigEndian.Uint16(field.Data[0:2])); i++ {
+ scanner.Scan()
+
+ var field Field
+ if _, err := field.Write(scanner.Bytes()); err != nil {
+ return res, fmt.Errorf("error reading field: %w", err)
+ }
+ subFields = append(subFields, field)
}
+ // If there's only one subfield, that indicates this is a delete operation for the login in FieldData
if len(subFields) == 1 {
- login := DecodeUserString(getField(fieldData, &subFields).Data)
- cc.logger.Infow("DeleteUser", "login", login)
-
if !cc.Authorize(accessDeleteUser) {
res = append(res, cc.NewErrReply(t, "You are not allowed to delete accounts."))
return res, err
}
+ login := string(encodeString(getField(FieldData, &subFields).Data))
+ cc.logger.Info("DeleteUser", "login", login)
+
if err := cc.Server.DeleteUser(login); err != nil {
return res, err
}
continue
}
- login := DecodeUserString(getField(fieldUserLogin, &subFields).Data)
+ // login of the account to update
+ var accountToUpdate, loginToRename string
- // check if the login dataFile; if so, we know we are updating an existing user
- if acc, ok := cc.Server.Accounts[login]; ok {
- cc.logger.Infow("UpdateUser", "login", login)
+ // If FieldData is included, this is a rename operation where FieldData contains the login of the existing
+ // account and FieldUserLogin contains the new login.
+ if getField(FieldData, &subFields) != nil {
+ loginToRename = string(encodeString(getField(FieldData, &subFields).Data))
+ }
+ userLogin := string(encodeString(getField(FieldUserLogin, &subFields).Data))
+ if loginToRename != "" {
+ accountToUpdate = loginToRename
+ } else {
+ accountToUpdate = userLogin
+ }
- // account dataFile, so this is an update action
+ // Check if accountToUpdate has an existing account. If so, we know we are updating an existing user.
+ if acc, ok := cc.Server.Accounts[accountToUpdate]; ok {
+ if loginToRename != "" {
+ cc.logger.Info("RenameUser", "prevLogin", accountToUpdate, "newLogin", userLogin)
+ } else {
+ cc.logger.Info("UpdateUser", "login", accountToUpdate)
+ }
+
+ // account exists, so this is an update action
if !cc.Authorize(accessModifyUser) {
res = append(res, cc.NewErrReply(t, "You are not allowed to modify accounts."))
- return res, err
+ return res, nil
}
- if getField(fieldUserPassword, &subFields) != nil {
- newPass := getField(fieldUserPassword, &subFields).Data
- acc.Password = hashAndSalt(newPass)
+ // This part is a bit tricky. There are three possibilities:
+ // 1) The transaction is intended to update the password.
+ // In this case, FieldUserPassword is sent with the new password.
+ // 2) The transaction is intended to remove the password.
+ // In this case, FieldUserPassword is not sent.
+ // 3) The transaction updates the users access bits, but not the password.
+ // In this case, FieldUserPassword is sent with zero as the only byte.
+ if getField(FieldUserPassword, &subFields) != nil {
+ newPass := getField(FieldUserPassword, &subFields).Data
+ if !bytes.Equal([]byte{0}, newPass) {
+ acc.Password = hashAndSalt(newPass)
+ }
} else {
acc.Password = hashAndSalt([]byte(""))
}
- if getField(fieldUserAccess, &subFields) != nil {
- copy(acc.Access[:], getField(fieldUserAccess, &subFields).Data)
+ if getField(FieldUserAccess, &subFields) != nil {
+ copy(acc.Access[:], getField(FieldUserAccess, &subFields).Data)
}
err = cc.Server.UpdateUser(
- DecodeUserString(getField(fieldData, &subFields).Data),
- DecodeUserString(getField(fieldUserLogin, &subFields).Data),
- string(getField(fieldUserName, &subFields).Data),
+ string(encodeString(getField(FieldData, &subFields).Data)),
+ string(encodeString(getField(FieldUserLogin, &subFields).Data)),
+ string(getField(FieldUserName, &subFields).Data),
acc.Password,
acc.Access,
)
return res, err
}
} else {
- cc.logger.Infow("CreateUser", "login", login)
-
if !cc.Authorize(accessCreateUser) {
res = append(res, cc.NewErrReply(t, "You are not allowed to create new accounts."))
- return res, err
+ return res, nil
}
+ cc.logger.Info("CreateUser", "login", userLogin)
+
newAccess := accessBitmap{}
- copy(newAccess[:], getField(fieldUserAccess, &subFields).Data[:])
+ copy(newAccess[:], getField(FieldUserAccess, &subFields).Data)
+
+ // Prevent account from creating new account with greater permission
+ for i := 0; i < 64; i++ {
+ if newAccess.IsSet(i) {
+ if !cc.Authorize(i) {
+ return append(res, cc.NewErrReply(t, "Cannot create account with more access than yourself.")), nil
+ }
+ }
+ }
- err := cc.Server.NewUser(login, string(getField(fieldUserName, &subFields).Data), string(getField(fieldUserPassword, &subFields).Data), newAccess)
+ err = cc.Server.NewUser(userLogin, string(getField(FieldUserName, &subFields).Data), string(getField(FieldUserPassword, &subFields).Data), newAccess)
if err != nil {
- return []Transaction{}, err
+ return append(res, cc.NewErrReply(t, "Cannot create account because there is already an account with that login.")), nil
}
}
}
return res, err
}
- login := DecodeUserString(t.GetField(fieldUserLogin).Data)
+ login := string(encodeString(t.GetField(FieldUserLogin).Data))
// If the account already dataFile, reply with an error
if _, ok := cc.Server.Accounts[login]; ok {
}
newAccess := accessBitmap{}
- copy(newAccess[:], t.GetField(fieldUserAccess).Data[:])
+ copy(newAccess[:], t.GetField(FieldUserAccess).Data)
+
+ // Prevent account from creating new account with greater permission
+ for i := 0; i < 64; i++ {
+ if newAccess.IsSet(i) {
+ if !cc.Authorize(i) {
+ res = append(res, cc.NewErrReply(t, "Cannot create account with more access than yourself."))
+ return res, err
+ }
+ }
+ }
- if err := cc.Server.NewUser(login, string(t.GetField(fieldUserName).Data), string(t.GetField(fieldUserPassword).Data), newAccess); err != nil {
- return []Transaction{}, err
+ if err := cc.Server.NewUser(login, string(t.GetField(FieldUserName).Data), string(t.GetField(FieldUserPassword).Data), newAccess); err != nil {
+ res = append(res, cc.NewErrReply(t, "Cannot create account because there is already an account with that login."))
+ return res, err
}
res = append(res, cc.NewReply(t))
func HandleDeleteUser(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
if !cc.Authorize(accessDeleteUser) {
res = append(res, cc.NewErrReply(t, "You are not allowed to delete accounts."))
- return res, err
+ return res, nil
}
- // TODO: Handle case where account doesn't exist; e.g. delete race condition
- login := DecodeUserString(t.GetField(fieldUserLogin).Data)
+ login := string(encodeString(t.GetField(FieldUserLogin).Data))
if err := cc.Server.DeleteUser(login); err != nil {
return res, err
}
cc.sendAll(
- tranServerMsg,
- NewField(fieldData, t.GetField(tranGetMsgs).Data),
- NewField(fieldChatOptions, []byte{0}),
+ TranServerMsg,
+ NewField(FieldData, t.GetField(TranGetMsgs).Data),
+ NewField(FieldChatOptions, []byte{0}),
)
res = append(res, cc.NewReply(t))
return res, err
}
-func byteToInt(bytes []byte) (int, error) {
- switch len(bytes) {
- case 2:
- return int(binary.BigEndian.Uint16(bytes)), nil
- case 4:
- return int(binary.BigEndian.Uint32(bytes)), nil
- }
-
- return 0, errors.New("unknown byte length")
-}
-
// HandleGetClientInfoText returns user information for the specific user.
//
// Fields used in the request:
// 103 User ID
//
// Fields used in the reply:
-// 102 User name
+// 102 User Name
// 101 Data User info text string
func HandleGetClientInfoText(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
if !cc.Authorize(accessGetClientInfo) {
return res, err
}
- clientID, _ := byteToInt(t.GetField(fieldUserID).Data)
+ clientID, _ := byteToInt(t.GetField(FieldUserID).Data)
clientConn := cc.Server.Clients[uint16(clientID)]
if clientConn == nil {
}
res = append(res, cc.NewReply(t,
- NewField(fieldData, []byte(clientConn.String())),
- NewField(fieldUserName, clientConn.UserName),
+ NewField(FieldData, []byte(clientConn.String())),
+ NewField(FieldUserName, clientConn.UserName),
))
return res, err
}
}
func HandleTranAgreed(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- cc.Agreed = true
-
- if t.GetField(fieldUserName).Data != nil {
+ if t.GetField(FieldUserName).Data != nil {
if cc.Authorize(accessAnyName) {
- cc.UserName = t.GetField(fieldUserName).Data
+ cc.UserName = t.GetField(FieldUserName).Data
} else {
cc.UserName = []byte(cc.Account.Name)
}
}
- cc.Icon = t.GetField(fieldUserIconID).Data
+ cc.Icon = t.GetField(FieldUserIconID).Data
- cc.logger = cc.logger.With("name", string(cc.UserName))
- cc.logger.Infow("Login successful", "clientVersion", fmt.Sprintf("%v", func() int { i, _ := byteToInt(cc.Version); return i }()))
+ cc.logger = cc.logger.With("Name", string(cc.UserName))
+ cc.logger.Info("Login successful", "clientVersion", fmt.Sprintf("%v", func() int { i, _ := byteToInt(cc.Version); return i }()))
- options := t.GetField(fieldOptions).Data
+ options := t.GetField(FieldOptions).Data
optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(cc.Flags)))
// Check refuse private PM option
- if optBitmap.Bit(refusePM) == 1 {
- flagBitmap.SetBit(flagBitmap, userFlagRefusePM, 1)
+ if optBitmap.Bit(UserOptRefusePM) == 1 {
+ flagBitmap.SetBit(flagBitmap, UserFlagRefusePM, 1)
binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
}
// Check refuse private chat option
- if optBitmap.Bit(refuseChat) == 1 {
- flagBitmap.SetBit(flagBitmap, userFLagRefusePChat, 1)
+ if optBitmap.Bit(UserOptRefuseChat) == 1 {
+ flagBitmap.SetBit(flagBitmap, UserFlagRefusePChat, 1)
binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
}
// Check auto response
- if optBitmap.Bit(autoResponse) == 1 {
- cc.AutoReply = t.GetField(fieldAutomaticResponse).Data
+ if optBitmap.Bit(UserOptAutoResponse) == 1 {
+ cc.AutoReply = t.GetField(FieldAutomaticResponse).Data
} else {
cc.AutoReply = []byte{}
}
trans := cc.notifyOthers(
*NewTransaction(
- tranNotifyChangeUser, nil,
- NewField(fieldUserName, cc.UserName),
- NewField(fieldUserID, *cc.ID),
- NewField(fieldUserIconID, cc.Icon),
- NewField(fieldUserFlags, cc.Flags),
+ TranNotifyChangeUser, nil,
+ NewField(FieldUserName, cc.UserName),
+ NewField(FieldUserID, *cc.ID),
+ NewField(FieldUserIconID, cc.Icon),
+ NewField(FieldUserFlags, cc.Flags),
),
)
res = append(res, trans...)
if cc.Server.Config.BannerFile != "" {
- res = append(res, *NewTransaction(tranServerBanner, cc.ID, NewField(fieldBannerType, []byte("JPEG"))))
+ res = append(res, *NewTransaction(TranServerBanner, cc.ID, NewField(FieldBannerType, []byte("JPEG"))))
}
res = append(res, cc.NewReply(t))
return res, err
}
-const defaultNewsDateFormat = "Jan02 15:04" // Jun23 20:49
-// "Mon, 02 Jan 2006 15:04:05 MST"
-
-const defaultNewsTemplate = `From %s (%s):
-
-%s
-
-__________________________________________________________`
-
// HandleTranOldPostNews updates the flat news
// Fields used in this request:
// 101 Data
newsTemplate = cc.Server.Config.NewsDelimiter
}
- newsPost := fmt.Sprintf(newsTemplate+"\r", cc.UserName, time.Now().Format(newsDateTemplate), t.GetField(fieldData).Data)
- newsPost = strings.Replace(newsPost, "\n", "\r", -1)
+ newsPost := fmt.Sprintf(newsTemplate+"\r", cc.UserName, time.Now().Format(newsDateTemplate), t.GetField(FieldData).Data)
+ newsPost = strings.ReplaceAll(newsPost, "\n", "\r")
+
+ // update news in memory
+ cc.Server.FlatNews = append([]byte(newsPost), cc.Server.FlatNews...)
// update news on disk
if err := cc.Server.FS.WriteFile(filepath.Join(cc.Server.ConfigDir, "MessageBoard.txt"), cc.Server.FlatNews, 0644); err != nil {
return res, err
}
- // update news in memory
- cc.Server.FlatNews = append([]byte(newsPost), cc.Server.FlatNews...)
-
// Notify all clients of updated news
cc.sendAll(
- tranNewMsg,
- NewField(fieldData, []byte(newsPost)),
+ TranNewMsg,
+ NewField(FieldData, []byte(newsPost)),
)
res = append(res, cc.NewReply(t))
return res, err
}
- clientConn := cc.Server.Clients[binary.BigEndian.Uint16(t.GetField(fieldUserID).Data)]
+ clientConn := cc.Server.Clients[binary.BigEndian.Uint16(t.GetField(FieldUserID).Data)]
if clientConn.Authorize(accessCannotBeDiscon) {
res = append(res, cc.NewErrReply(t, clientConn.Account.Login+" is not allowed to be disconnected."))
return res, err
}
- // If fieldOptions is set, then the client IP is banned in addition to disconnected.
+ // If FieldOptions is set, then the client IP is banned in addition to disconnected.
// 00 01 = temporary ban
// 00 02 = permanent ban
- if t.GetField(fieldOptions).Data != nil {
- switch t.GetField(fieldOptions).Data[1] {
+ if t.GetField(FieldOptions).Data != nil {
+ switch t.GetField(FieldOptions).Data[1] {
case 1:
// send message: "You are temporarily banned on this server"
- cc.logger.Infow("Disconnect & temporarily ban " + string(clientConn.UserName))
+ cc.logger.Info("Disconnect & temporarily ban " + string(clientConn.UserName))
res = append(res, *NewTransaction(
- tranServerMsg,
+ TranServerMsg,
clientConn.ID,
- NewField(fieldData, []byte("You are temporarily banned on this server")),
- NewField(fieldChatOptions, []byte{0, 0}),
+ NewField(FieldData, []byte("You are temporarily banned on this server")),
+ NewField(FieldChatOptions, []byte{0, 0}),
))
banUntil := time.Now().Add(tempBanDuration)
cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = &banUntil
- cc.Server.writeBanList()
case 2:
// send message: "You are permanently banned on this server"
- cc.logger.Infow("Disconnect & ban " + string(clientConn.UserName))
+ cc.logger.Info("Disconnect & ban " + string(clientConn.UserName))
res = append(res, *NewTransaction(
- tranServerMsg,
+ TranServerMsg,
clientConn.ID,
- NewField(fieldData, []byte("You are permanently banned on this server")),
- NewField(fieldChatOptions, []byte{0, 0}),
+ NewField(FieldData, []byte("You are permanently banned on this server")),
+ NewField(FieldChatOptions, []byte{0, 0}),
))
cc.Server.banList[strings.Split(clientConn.RemoteAddr, ":")[0]] = nil
- cc.Server.writeBanList()
+ }
+
+ err := cc.Server.writeBanList()
+ if err != nil {
+ return res, err
}
}
return res, err
}
- pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
+ pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
cats := cc.Server.GetNewsCatByPath(pathStrs)
// To store the keys in slice in sorted order
cat := cats[k]
b, _ := cat.MarshalBinary()
fieldData = append(fieldData, NewField(
- fieldNewsCatListData15,
+ FieldNewsCatListData15,
b,
))
}
return res, err
}
- name := string(t.GetField(fieldNewsCatName).Data)
- pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
+ name := string(t.GetField(FieldNewsCatName).Data)
+ pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
cats := cc.Server.GetNewsCatByPath(pathStrs)
cats[name] = NewsCategoryListData15{
Name: name,
- Type: []byte{0, 3},
+ Type: [2]byte{0, 3},
Articles: map[uint32]*NewsArtData{},
SubCats: make(map[string]NewsCategoryListData15),
}
}
// Fields used in the request:
-// 322 News category name
+// 322 News category Name
// 325 News path
func HandleNewNewsFldr(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
if !cc.Authorize(accessNewsCreateFldr) {
return res, err
}
- name := string(t.GetField(fieldFileName).Data)
- pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
-
- cc.logger.Infof("Creating new news folder %s", name)
+ name := string(t.GetField(FieldFileName).Data)
+ pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
cats := cc.Server.GetNewsCatByPath(pathStrs)
cats[name] = NewsCategoryListData15{
Name: name,
- Type: []byte{0, 2},
+ Type: [2]byte{0, 2},
Articles: map[uint32]*NewsArtData{},
SubCats: make(map[string]NewsCategoryListData15),
}
return res, err
}
+// HandleGetNewsArtData gets the list of article names at the specified news path.
+
// Fields used in the request:
// 325 News path Optional
-//
-// Reply fields:
+
+// Fields used in the reply:
// 321 News article list data Optional
func HandleGetNewsArtNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
if !cc.Authorize(accessNewsReadArt) {
res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
return res, err
}
- pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
+ pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
var cat NewsCategoryListData15
cats := cc.Server.ThreadedNews.Categories
nald := cat.GetNewsArtListData()
- res = append(res, cc.NewReply(t, NewField(fieldNewsArtListData, nald.Payload())))
+ b, err := io.ReadAll(&nald)
+ if err != nil {
+
+ }
+
+ res = append(res, cc.NewReply(t, NewField(FieldNewsArtListData, b)))
return res, err
}
+// HandleGetNewsArtData requests information about the specific news article.
+// Fields used in the request:
+//
+// Request fields
+// 325 News path
+// 326 News article ID
+// 327 News article data flavor
+//
+// Fields used in the reply:
+// 328 News article title
+// 329 News article poster
+// 330 News article date
+// 331 Previous article ID
+// 332 Next article ID
+// 335 Parent article ID
+// 336 First child article ID
+// 327 News article data flavor "Should be “text/plain”
+// 333 News article data Optional (if data flavor is “text/plain”)
func HandleGetNewsArtData(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
if !cc.Authorize(accessNewsReadArt) {
res = append(res, cc.NewErrReply(t, "You are not allowed to read news."))
return res, err
}
- // Request fields
- // 325 News fp
- // 326 News article ID
- // 327 News article data flavor
-
- pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
-
var cat NewsCategoryListData15
cats := cc.Server.ThreadedNews.Categories
- for _, fp := range pathStrs {
+ for _, fp := range ReadNewsPath(t.GetField(FieldNewsPath).Data) {
cat = cats[fp]
cats = cats[fp].SubCats
}
- newsArtID := t.GetField(fieldNewsArtID).Data
- convertedArtID := binary.BigEndian.Uint16(newsArtID)
+ // The official Hotline clients will send the article ID as 2 bytes if possible, but
+ // some third party clients such as Frogblast and Heildrun will always send 4 bytes
+ convertedID, err := byteToInt(t.GetField(FieldNewsArtID).Data)
+ if err != nil {
+ return res, err
+ }
- art := cat.Articles[uint32(convertedArtID)]
+ art := cat.Articles[uint32(convertedID)]
if art == nil {
res = append(res, cc.NewReply(t))
return res, err
}
- // Reply fields
- // 328 News article title
- // 329 News article poster
- // 330 News article date
- // 331 Previous article ID
- // 332 Next article ID
- // 335 Parent article ID
- // 336 First child article ID
- // 327 News article data flavor "Should be “text/plain”
- // 333 News article data Optional (if data flavor is “text/plain”)
-
res = append(res, cc.NewReply(t,
- NewField(fieldNewsArtTitle, []byte(art.Title)),
- NewField(fieldNewsArtPoster, []byte(art.Poster)),
- NewField(fieldNewsArtDate, art.Date),
- NewField(fieldNewsArtPrevArt, art.PrevArt),
- NewField(fieldNewsArtNextArt, art.NextArt),
- NewField(fieldNewsArtParentArt, art.ParentArt),
- NewField(fieldNewsArt1stChildArt, art.FirstChildArt),
- NewField(fieldNewsArtDataFlav, []byte("text/plain")),
- NewField(fieldNewsArtData, []byte(art.Data)),
+ NewField(FieldNewsArtTitle, []byte(art.Title)),
+ NewField(FieldNewsArtPoster, []byte(art.Poster)),
+ NewField(FieldNewsArtDate, art.Date[:]),
+ NewField(FieldNewsArtPrevArt, art.PrevArt[:]),
+ NewField(FieldNewsArtNextArt, art.NextArt[:]),
+ NewField(FieldNewsArtParentArt, art.ParentArt[:]),
+ NewField(FieldNewsArt1stChildArt, art.FirstChildArt[:]),
+ NewField(FieldNewsArtDataFlav, []byte("text/plain")),
+ NewField(FieldNewsArtData, []byte(art.Data)),
))
return res, err
}
// Fields used in the reply:
// None
func HandleDelNewsItem(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
+ pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
cats := cc.Server.ThreadedNews.Categories
delName := pathStrs[len(pathStrs)-1]
}
}
- if bytes.Compare(cats[delName].Type, []byte{0, 3}) == 0 {
+ if cats[delName].Type == [2]byte{0, 3} {
if !cc.Authorize(accessNewsDeleteCat) {
return append(res, cc.NewErrReply(t, "You are not allowed to delete news categories.")), nil
}
// 325 News path
// 326 News article ID
// 337 News article – recursive delete Delete child articles (1) or not (0)
- pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
- ID := binary.BigEndian.Uint16(t.GetField(fieldNewsArtID).Data)
+ pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
+ ID, err := byteToInt(t.GetField(FieldNewsArtID).Data)
+ if err != nil {
+ return res, err
+ }
// TODO: Delete recursive
cats := cc.Server.GetNewsCatByPath(pathStrs[:len(pathStrs)-1])
return res, err
}
- pathStrs := ReadNewsPath(t.GetField(fieldNewsPath).Data)
+ pathStrs := ReadNewsPath(t.GetField(FieldNewsPath).Data)
cats := cc.Server.GetNewsCatByPath(pathStrs[:len(pathStrs)-1])
catName := pathStrs[len(pathStrs)-1]
cat := cats[catName]
+ artID, err := byteToInt(t.GetField(FieldNewsArtID).Data)
+ if err != nil {
+ return res, err
+ }
+ convertedArtID := uint32(artID)
+ bs := make([]byte, 4)
+ binary.BigEndian.PutUint32(bs, convertedArtID)
+
+ cc.Server.mux.Lock()
+ defer cc.Server.mux.Unlock()
+
newArt := NewsArtData{
- Title: string(t.GetField(fieldNewsArtTitle).Data),
+ Title: string(t.GetField(FieldNewsArtTitle).Data),
Poster: string(cc.UserName),
Date: toHotlineTime(time.Now()),
- PrevArt: []byte{0, 0, 0, 0},
- NextArt: []byte{0, 0, 0, 0},
- ParentArt: append([]byte{0, 0}, t.GetField(fieldNewsArtID).Data...),
- FirstChildArt: []byte{0, 0, 0, 0},
+ PrevArt: [4]byte{},
+ NextArt: [4]byte{},
+ ParentArt: [4]byte(bs),
+ FirstChildArt: [4]byte{},
DataFlav: []byte("text/plain"),
- Data: string(t.GetField(fieldNewsArtData).Data),
+ Data: string(t.GetField(FieldNewsArtData).Data),
}
var keys []int
prevID := uint32(keys[len(keys)-1])
nextID = prevID + 1
- binary.BigEndian.PutUint32(newArt.PrevArt, prevID)
+ binary.BigEndian.PutUint32(newArt.PrevArt[:], prevID)
// Set next article ID
- binary.BigEndian.PutUint32(cat.Articles[prevID].NextArt, nextID)
+ binary.BigEndian.PutUint32(cat.Articles[prevID].NextArt[:], nextID)
}
// Update parent article with first child reply
- parentID := binary.BigEndian.Uint16(t.GetField(fieldNewsArtID).Data)
+ parentID := convertedArtID
if parentID != 0 {
- parentArt := cat.Articles[uint32(parentID)]
+ parentArt := cat.Articles[parentID]
- if bytes.Equal(parentArt.FirstChildArt, []byte{0, 0, 0, 0}) {
- binary.BigEndian.PutUint32(parentArt.FirstChildArt, nextID)
+ if parentArt.FirstChildArt == [4]byte{0, 0, 0, 0} {
+ binary.BigEndian.PutUint32(parentArt.FirstChildArt[:], nextID)
}
}
return res, err
}
- res = append(res, cc.NewReply(t, NewField(fieldData, cc.Server.FlatNews)))
+ res = append(res, cc.NewReply(t, NewField(FieldData, cc.Server.FlatNews)))
return res, err
}
return res, err
}
- fileName := t.GetField(fieldFileName).Data
- filePath := t.GetField(fieldFilePath).Data
- resumeData := t.GetField(fieldFileResumeData).Data
+ fileName := t.GetField(FieldFileName).Data
+ filePath := t.GetField(FieldFilePath).Data
+ resumeData := t.GetField(FieldFileResumeData).Data
var dataOffset int64
var frd FileResumeData
if resumeData != nil {
- if err := frd.UnmarshalBinary(t.GetField(fieldFileResumeData).Data); err != nil {
+ if err := frd.UnmarshalBinary(t.GetField(FieldFileResumeData).Data); err != nil {
return res, err
}
// TODO: handle rsrc fork offset
// TODO: refactor to remove this
if resumeData != nil {
var frd FileResumeData
- if err := frd.UnmarshalBinary(t.GetField(fieldFileResumeData).Data); err != nil {
+ if err := frd.UnmarshalBinary(t.GetField(FieldFileResumeData).Data); err != nil {
return res, err
}
ft.fileResumeData = &frd
// Optional field for when a HL v1.5+ client requests file preview
// Used only for TEXT, JPEG, GIFF, BMP or PICT files
// The value will always be 2
- if t.GetField(fieldFileTransferOptions).Data != nil {
- ft.options = t.GetField(fieldFileTransferOptions).Data
+ if t.GetField(FieldFileTransferOptions).Data != nil {
+ ft.options = t.GetField(FieldFileTransferOptions).Data
xferSize = hlFile.ffo.FlatFileDataForkHeader.DataSize[:]
}
res = append(res, cc.NewReply(t,
- NewField(fieldRefNum, ft.refNum[:]),
- NewField(fieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
- NewField(fieldTransferSize, xferSize),
- NewField(fieldFileSize, hlFile.ffo.FlatFileDataForkHeader.DataSize[:]),
+ NewField(FieldRefNum, ft.refNum[:]),
+ NewField(FieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
+ NewField(FieldTransferSize, xferSize),
+ NewField(FieldFileSize, hlFile.ffo.FlatFileDataForkHeader.DataSize[:]),
))
return res, err
return res, err
}
- fullFilePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(fieldFilePath).Data, t.GetField(fieldFileName).Data)
+ fullFilePath, err := readPath(cc.Server.Config.FileRoot, t.GetField(FieldFilePath).Data, t.GetField(FieldFileName).Data)
if err != nil {
return res, err
}
return res, err
}
- fileTransfer := cc.newFileTransfer(FolderDownload, t.GetField(fieldFileName).Data, t.GetField(fieldFilePath).Data, transferSize)
+ fileTransfer := cc.newFileTransfer(FolderDownload, t.GetField(FieldFileName).Data, t.GetField(FieldFilePath).Data, transferSize)
var fp FilePath
- _, err = fp.Write(t.GetField(fieldFilePath).Data)
+ _, err = fp.Write(t.GetField(FieldFilePath).Data)
if err != nil {
return res, err
}
res = append(res, cc.NewReply(t,
- NewField(fieldRefNum, fileTransfer.ReferenceNumber),
- NewField(fieldTransferSize, transferSize),
- NewField(fieldFolderItemCount, itemCount),
- NewField(fieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
+ NewField(FieldRefNum, fileTransfer.ReferenceNumber),
+ NewField(FieldTransferSize, transferSize),
+ NewField(FieldFolderItemCount, itemCount),
+ NewField(FieldWaitingCount, []byte{0x00, 0x00}), // TODO: Implement waiting count
))
return res, err
}
// Upload all files from the local folder and its subfolders to the specified path on the server
// Fields used in the request
-// 201 File name
+// 201 File Name
// 202 File path
// 108 transfer size Total size of all items in the folder
// 220 Folder item count
// 204 File transfer options "Optional Currently set to 1" (TODO: ??)
func HandleUploadFolder(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
var fp FilePath
- if t.GetField(fieldFilePath).Data != nil {
- if _, err = fp.Write(t.GetField(fieldFilePath).Data); err != nil {
+ if t.GetField(FieldFilePath).Data != nil {
+ if _, err = fp.Write(t.GetField(FieldFilePath).Data); err != nil {
return res, err
}
}
// Handle special cases for Upload and Drop Box folders
if !cc.Authorize(accessUploadAnywhere) {
if !fp.IsUploadDir() && !fp.IsDropbox() {
- 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))))
+ 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))))
return res, err
}
}
fileTransfer := cc.newFileTransfer(FolderUpload,
- t.GetField(fieldFileName).Data,
- t.GetField(fieldFilePath).Data,
- t.GetField(fieldTransferSize).Data,
+ t.GetField(FieldFileName).Data,
+ t.GetField(FieldFilePath).Data,
+ t.GetField(FieldTransferSize).Data,
)
- fileTransfer.FolderItemCount = t.GetField(fieldFolderItemCount).Data
+ fileTransfer.FolderItemCount = t.GetField(FieldFolderItemCount).Data
- res = append(res, cc.NewReply(t, NewField(fieldRefNum, fileTransfer.ReferenceNumber)))
+ res = append(res, cc.NewReply(t, NewField(FieldRefNum, fileTransfer.ReferenceNumber)))
return res, err
}
// HandleUploadFile
// Fields used in the request:
-// 201 File name
+// 201 File Name
// 202 File path
// 204 File transfer options "Optional
// Used only to resume download, currently has value 2"
return res, err
}
- fileName := t.GetField(fieldFileName).Data
- filePath := t.GetField(fieldFilePath).Data
- transferOptions := t.GetField(fieldFileTransferOptions).Data
- transferSize := t.GetField(fieldTransferSize).Data // not sent for resume
+ fileName := t.GetField(FieldFileName).Data
+ filePath := t.GetField(FieldFilePath).Data
+ transferOptions := t.GetField(FieldFileTransferOptions).Data
+ transferSize := t.GetField(FieldTransferSize).Data // not sent for resume
var fp FilePath
if filePath != nil {
}
if _, err := cc.Server.FS.Stat(fullFilePath); err == nil {
- 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))))
+ 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))))
return res, err
}
ft := cc.newFileTransfer(FileUpload, fileName, filePath, transferSize)
- replyT := cc.NewReply(t, NewField(fieldRefNum, ft.ReferenceNumber))
+ replyT := cc.NewReply(t, NewField(FieldRefNum, ft.ReferenceNumber))
// client has requested to resume a partially transferred file
if transferOptions != nil {
-
fileInfo, err := cc.Server.FS.Stat(fullFilePath + incompleteFileSuffix)
if err != nil {
return res, err
ft.TransferSize = offset
- replyT.Fields = append(replyT.Fields, NewField(fieldFileResumeData, b))
+ replyT.Fields = append(replyT.Fields, NewField(FieldFileResumeData, b))
}
res = append(res, replyT)
}
func HandleSetClientUserInfo(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- if len(t.GetField(fieldUserIconID).Data) == 4 {
- cc.Icon = t.GetField(fieldUserIconID).Data[2:]
+ if len(t.GetField(FieldUserIconID).Data) == 4 {
+ cc.Icon = t.GetField(FieldUserIconID).Data[2:]
} else {
- cc.Icon = t.GetField(fieldUserIconID).Data
+ cc.Icon = t.GetField(FieldUserIconID).Data
}
if cc.Authorize(accessAnyName) {
- cc.UserName = t.GetField(fieldUserName).Data
+ cc.UserName = t.GetField(FieldUserName).Data
}
// the options field is only passed by the client versions > 1.2.3.
- options := t.GetField(fieldOptions).Data
+ options := t.GetField(FieldOptions).Data
if options != nil {
optBitmap := big.NewInt(int64(binary.BigEndian.Uint16(options)))
flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(cc.Flags)))
- flagBitmap.SetBit(flagBitmap, userFlagRefusePM, optBitmap.Bit(refusePM))
+ flagBitmap.SetBit(flagBitmap, UserFlagRefusePM, optBitmap.Bit(UserOptRefusePM))
binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
- flagBitmap.SetBit(flagBitmap, userFLagRefusePChat, optBitmap.Bit(refuseChat))
+ flagBitmap.SetBit(flagBitmap, UserFlagRefusePChat, optBitmap.Bit(UserOptRefuseChat))
binary.BigEndian.PutUint16(cc.Flags, uint16(flagBitmap.Int64()))
// Check auto response
- if optBitmap.Bit(autoResponse) == 1 {
- cc.AutoReply = t.GetField(fieldAutomaticResponse).Data
+ if optBitmap.Bit(UserOptAutoResponse) == 1 {
+ cc.AutoReply = t.GetField(FieldAutomaticResponse).Data
} else {
cc.AutoReply = []byte{}
}
for _, c := range sortedClients(cc.Server.Clients) {
res = append(res, *NewTransaction(
- tranNotifyChangeUser,
+ TranNotifyChangeUser,
c.ID,
- NewField(fieldUserID, *cc.ID),
- NewField(fieldUserIconID, cc.Icon),
- NewField(fieldUserFlags, cc.Flags),
- NewField(fieldUserName, cc.UserName),
+ NewField(FieldUserID, *cc.ID),
+ NewField(FieldUserIconID, cc.Icon),
+ NewField(FieldUserFlags, cc.Flags),
+ NewField(FieldUserName, cc.UserName),
))
}
func HandleGetFileNameList(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
fullPath, err := readPath(
cc.Server.Config.FileRoot,
- t.GetField(fieldFilePath).Data,
+ t.GetField(FieldFilePath).Data,
nil,
)
if err != nil {
}
var fp FilePath
- if t.GetField(fieldFilePath).Data != nil {
- if _, err = fp.Write(t.GetField(fieldFilePath).Data); err != nil {
+ if t.GetField(FieldFilePath).Data != nil {
+ if _, err = fp.Write(t.GetField(FieldFilePath).Data); err != nil {
return res, err
}
}
// =================================
// Hotline private chat flow
// =================================
-// 1. ClientA sends tranInviteNewChat to server with user ID to invite
+// 1. ClientA sends TranInviteNewChat to server with user ID to invite
// 2. Server creates new ChatID
-// 3. Server sends tranInviteToChat to invitee
+// 3. Server sends TranInviteToChat to invitee
// 4. Server replies to ClientA with new Chat ID
//
// A dialog box pops up in the invitee client with options to accept or decline the invitation.
// If Accepted is clicked:
-// 1. ClientB sends tranJoinChat with fieldChatID
+// 1. ClientB sends TranJoinChat with FieldChatID
// HandleInviteNewChat invites users to new private chat
func HandleInviteNewChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
}
// Client to Invite
- targetID := t.GetField(fieldUserID).Data
+ targetID := t.GetField(FieldUserID).Data
newChatID := cc.Server.NewPrivateChat(cc)
// Check if target user has "Refuse private chat" flag
targetClient := cc.Server.Clients[binary.BigEndian.Uint16(targetID)]
flagBitmap := big.NewInt(int64(binary.BigEndian.Uint16(targetClient.Flags)))
- if flagBitmap.Bit(userFLagRefusePChat) == 1 {
+ if flagBitmap.Bit(UserFlagRefusePChat) == 1 {
res = append(res,
*NewTransaction(
- tranServerMsg,
+ TranServerMsg,
cc.ID,
- NewField(fieldData, []byte(string(targetClient.UserName)+" does not accept private chats.")),
- NewField(fieldUserName, targetClient.UserName),
- NewField(fieldUserID, *targetClient.ID),
- NewField(fieldOptions, []byte{0, 2}),
+ NewField(FieldData, []byte(string(targetClient.UserName)+" does not accept private chats.")),
+ NewField(FieldUserName, targetClient.UserName),
+ NewField(FieldUserID, *targetClient.ID),
+ NewField(FieldOptions, []byte{0, 2}),
),
)
} else {
res = append(res,
*NewTransaction(
- tranInviteToChat,
+ TranInviteToChat,
&targetID,
- NewField(fieldChatID, newChatID),
- NewField(fieldUserName, cc.UserName),
- NewField(fieldUserID, *cc.ID),
+ NewField(FieldChatID, newChatID),
+ NewField(FieldUserName, cc.UserName),
+ NewField(FieldUserID, *cc.ID),
),
)
}
res = append(res,
cc.NewReply(t,
- NewField(fieldChatID, newChatID),
- NewField(fieldUserName, cc.UserName),
- NewField(fieldUserID, *cc.ID),
- NewField(fieldUserIconID, cc.Icon),
- NewField(fieldUserFlags, cc.Flags),
+ NewField(FieldChatID, newChatID),
+ NewField(FieldUserName, cc.UserName),
+ NewField(FieldUserID, *cc.ID),
+ NewField(FieldUserIconID, cc.Icon),
+ NewField(FieldUserFlags, cc.Flags),
),
)
}
// Client to Invite
- targetID := t.GetField(fieldUserID).Data
- chatID := t.GetField(fieldChatID).Data
+ targetID := t.GetField(FieldUserID).Data
+ chatID := t.GetField(FieldChatID).Data
res = append(res,
*NewTransaction(
- tranInviteToChat,
+ TranInviteToChat,
&targetID,
- NewField(fieldChatID, chatID),
- NewField(fieldUserName, cc.UserName),
- NewField(fieldUserID, *cc.ID),
+ NewField(FieldChatID, chatID),
+ NewField(FieldUserName, cc.UserName),
+ NewField(FieldUserID, *cc.ID),
),
)
res = append(res,
cc.NewReply(
t,
- NewField(fieldChatID, chatID),
- NewField(fieldUserName, cc.UserName),
- NewField(fieldUserID, *cc.ID),
- NewField(fieldUserIconID, cc.Icon),
- NewField(fieldUserFlags, cc.Flags),
+ NewField(FieldChatID, chatID),
+ NewField(FieldUserName, cc.UserName),
+ NewField(FieldUserID, *cc.ID),
+ NewField(FieldUserIconID, cc.Icon),
+ NewField(FieldUserFlags, cc.Flags),
),
)
}
func HandleRejectChatInvite(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- chatID := t.GetField(fieldChatID).Data
+ chatID := t.GetField(FieldChatID).Data
chatInt := binary.BigEndian.Uint32(chatID)
privChat := cc.Server.PrivateChats[chatInt]
for _, c := range sortedClients(privChat.ClientConn) {
res = append(res,
*NewTransaction(
- tranChatMsg,
+ TranChatMsg,
c.ID,
- NewField(fieldChatID, chatID),
- NewField(fieldData, resMsg),
+ NewField(FieldChatID, chatID),
+ NewField(FieldData, resMsg),
),
)
}
// HandleJoinChat is sent from a v1.8+ Hotline client when the joins a private chat
// Fields used in the reply:
// * 115 Chat subject
-// * 300 User name with info (Optional)
+// * 300 User Name with info (Optional)
// * 300 (more user names with info)
func HandleJoinChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- chatID := t.GetField(fieldChatID).Data
+ chatID := t.GetField(FieldChatID).Data
chatInt := binary.BigEndian.Uint32(chatID)
privChat := cc.Server.PrivateChats[chatInt]
- // Send tranNotifyChatChangeUser to current members of the chat to inform of new user
+ // Send TranNotifyChatChangeUser to current members of the chat to inform of new user
for _, c := range sortedClients(privChat.ClientConn) {
res = append(res,
*NewTransaction(
- tranNotifyChatChangeUser,
+ TranNotifyChatChangeUser,
c.ID,
- NewField(fieldChatID, chatID),
- NewField(fieldUserName, cc.UserName),
- NewField(fieldUserID, *cc.ID),
- NewField(fieldUserIconID, cc.Icon),
- NewField(fieldUserFlags, cc.Flags),
+ NewField(FieldChatID, chatID),
+ NewField(FieldUserName, cc.UserName),
+ NewField(FieldUserID, *cc.ID),
+ NewField(FieldUserIconID, cc.Icon),
+ NewField(FieldUserFlags, cc.Flags),
),
)
}
privChat.ClientConn[cc.uint16ID()] = cc
- replyFields := []Field{NewField(fieldChatSubject, []byte(privChat.Subject))}
+ replyFields := []Field{NewField(FieldChatSubject, []byte(privChat.Subject))}
for _, c := range sortedClients(privChat.ClientConn) {
- user := User{
+
+ b, err := io.ReadAll(&User{
ID: *c.ID,
Icon: c.Icon,
Flags: c.Flags,
Name: string(c.UserName),
+ })
+ if err != nil {
+ return res, nil
}
-
- replyFields = append(replyFields, NewField(fieldUsernameWithInfo, user.Payload()))
+ replyFields = append(replyFields, NewField(FieldUsernameWithInfo, b))
}
res = append(res, cc.NewReply(t, replyFields...))
// HandleLeaveChat is sent from a v1.8+ Hotline client when the user exits a private chat
// Fields used in the request:
-// * 114 fieldChatID
+// - 114 FieldChatID
+//
// Reply is not expected.
func HandleLeaveChat(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- chatID := t.GetField(fieldChatID).Data
+ chatID := t.GetField(FieldChatID).Data
chatInt := binary.BigEndian.Uint32(chatID)
privChat, ok := cc.Server.PrivateChats[chatInt]
for _, c := range sortedClients(privChat.ClientConn) {
res = append(res,
*NewTransaction(
- tranNotifyChatDeleteUser,
+ TranNotifyChatDeleteUser,
c.ID,
- NewField(fieldChatID, chatID),
- NewField(fieldUserID, *cc.ID),
+ NewField(FieldChatID, chatID),
+ NewField(FieldUserID, *cc.ID),
),
)
}
// HandleSetChatSubject is sent from a v1.8+ Hotline client when the user sets a private chat subject
// Fields used in the request:
// * 114 Chat ID
-// * 115 Chat subject Chat subject string
+// * 115 Chat subject
// Reply is not expected.
func HandleSetChatSubject(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- chatID := t.GetField(fieldChatID).Data
+ chatID := t.GetField(FieldChatID).Data
chatInt := binary.BigEndian.Uint32(chatID)
privChat := cc.Server.PrivateChats[chatInt]
- privChat.Subject = string(t.GetField(fieldChatSubject).Data)
+ privChat.Subject = string(t.GetField(FieldChatSubject).Data)
for _, c := range sortedClients(privChat.ClientConn) {
res = append(res,
*NewTransaction(
- tranNotifyChatSubject,
+ TranNotifyChatSubject,
c.ID,
- NewField(fieldChatID, chatID),
- NewField(fieldChatSubject, t.GetField(fieldChatSubject).Data),
+ NewField(FieldChatID, chatID),
+ NewField(FieldChatSubject, t.GetField(FieldChatSubject).Data),
),
)
}
return res, err
}
-// HandleMakeAlias makes a filer alias using the specified path.
+// HandleMakeAlias makes a file alias using the specified path.
// Fields used in the request:
-// 201 File name
+// 201 File Name
// 202 File path
// 212 File new path Destination path
//
res = append(res, cc.NewErrReply(t, "You are not allowed to make aliases."))
return res, err
}
- fileName := t.GetField(fieldFileName).Data
- filePath := t.GetField(fieldFilePath).Data
- fileNewPath := t.GetField(fieldFileNewPath).Data
+ fileName := t.GetField(FieldFileName).Data
+ filePath := t.GetField(FieldFilePath).Data
+ fileNewPath := t.GetField(FieldFileNewPath).Data
fullFilePath, err := readPath(cc.Server.Config.FileRoot, filePath, fileName)
if err != nil {
return res, err
}
- cc.logger.Debugw("Make alias", "src", fullFilePath, "dst", fullNewFilePath)
+ cc.logger.Debug("Make alias", "src", fullFilePath, "dst", fullNewFilePath)
if err := cc.Server.FS.Symlink(fullFilePath, fullNewFilePath); err != nil {
res = append(res, cc.NewErrReply(t, "Error creating alias"))
// Fields used in the request:
// None
// Fields used in the reply:
-// 107 fieldRefNum Used later for transfer
-// 108 fieldTransferSize Size of data to be downloaded
+// 107 FieldRefNum Used later for transfer
+// 108 FieldTransferSize Size of data to be downloaded
func HandleDownloadBanner(cc *ClientConn, t *Transaction) (res []Transaction, err error) {
- fi, err := cc.Server.FS.Stat(filepath.Join(cc.Server.ConfigDir, cc.Server.Config.BannerFile))
- if err != nil {
- return res, err
- }
-
ft := cc.newFileTransfer(bannerDownload, []byte{}, []byte{}, make([]byte, 4))
+ binary.BigEndian.PutUint32(ft.TransferSize, uint32(len(cc.Server.banner)))
- binary.BigEndian.PutUint32(ft.TransferSize, uint32(fi.Size()))
-
- res = append(res, cc.NewReply(t,
- NewField(fieldRefNum, ft.refNum[:]),
- NewField(fieldTransferSize, ft.TransferSize),
- ))
-
- return res, err
+ return append(res, cc.NewReply(t,
+ NewField(FieldRefNum, ft.refNum[:]),
+ NewField(FieldTransferSize, ft.TransferSize),
+ )), err
}