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