-
Notifications
You must be signed in to change notification settings - Fork 1
/
MailR.lua
990 lines (876 loc) · 33.5 KB
/
MailR.lua
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
--[[
Title: MailR
Description: MailR is a supplemental addon for the ESO in-game mail system.
Version: 2.5.17
Original Author: pills
Previous Authors: calia1120, Ravalox Darkshire
]]
-- GLOBALS
MailR = {}
-------------------------------------------------
----- early helper -----
-------------------------------------------------
local function is_in(search_value, search_table)
for k, v in pairs(search_table) do
if search_value == v then return true end
if type(search_value) == "string" then
if string.find(string.lower(v), string.lower(search_value)) then return true end
end
end
return false
end
-------------------------------------------------
----- lang setup -----
-------------------------------------------------
MailR.client_lang = GetCVar("Language.2")
MailR.effective_lang = nil
MailR.supported_lang = { "de", "en", "fr", "es", }
if is_in(MailR.client_lang, MailR.supported_lang) then
MailR.effective_lang = MailR.client_lang
else
MailR.effective_lang = "en"
end
MailR.supported_lang = MailR.client_lang == MailR.effective_lang
-------------------------------------------------
----- mod -----
-------------------------------------------------
MailR.Name = "MailR"
MailR.DEFAULT_SAVE_MAIL_COLOR_STRING = "|c2dc50e"
MailR.DEFAULT_SENT_MAIL_COLOR_STRING = "|c3689ef"
MailR.DEFAULT_HEADER_COLOR_STRING = "|cd5b526"
MailR.RESET_COLOR_STRING = "|r"
-- are we in the mailbox UI
MailR.mailboxActive = false
-- max mail attachments
MailR.MAX_ATTACHMENTS = 6
-- table to store the keybind info
MailR.keybindInfo = {}
-- table for current mail inbox intem
MailR.currentMessageInfo = {}
-- table for queued message to be sent
MailR.queuedSentMessage = {}
-- table for current message being composed
MailR.currentSendMessageInfo = {}
-- Saved Mail vars --
-- what version of the saved mail table are we using
MailR.SAVED_MAIL_VERSION = "2.0"
-- default table for above version incase this the first time MailR is used
MailR.SavedMail_defaults = {
display = "all",
mailr_version = MailR.SAVED_MAIL_VERSION,
sent_count = 0,
sent_messages = {},
inbox_count = 0,
inbox_messages = {},
throttle_time = 1 --seconds (can be fractional)
}
MailR.MAX_READ_ATTACHMENTS = MailR.MAX_ATTACHMENTS + 1
MailR.defaultMailInboxFn = {}
--[[TODO Don't think this is truly needed ]]--
MailR.guildies = {}
-- saved mail
MailR.SavedMail = nil
-- Locale vars --
MailR.localeStringMap = {
["en"] = {
["Reply"] = "Reply",
["Forward"] = "Forward",
["Reply To Message"] = "Reply To Message",
["Forward Message"] = "Forward Message",
["Original Message"] = "Original Message",
["Save Mail"] = "Save Mail",
["From: "] = "From: ",
["Fwd: "] = "Fwd: ",
["Re: "] = "Re: ",
["Attachments: "] = "Attachments: ",
["To:"] = "To:",
["Received:"] = "Received:",
["Sent:"] = "Sent:",
["Attached Gold: "] = "Attached Gold: ",
["COD: "] = "COD: ",
["Postage: "] = "Postage: "
},
["de"] = {
["Reply"] = "Antworten",
["Forward"] = "Vorwärts",
["Reply To Message"] = "Antwort auf Beitrag",
["Forward Message"] = "Nachricht weiterleiten",
["Original Message"] = "Ursprüngliche Nachricht",
["Save Mail"] = "Save Mail",
["From: "] = "Von: ",
["Fwd: "] = "WG: ",
["Re: "] = "AW: ",
["Attachments: "] = "Anhänge: ",
["To:"] = "An:",
["Received:"] = "Erhalten am:",
["Sent:"] = "Gesendet:",
["Attached Gold: "] = "Angehängte Gold: ",
["COD: "] = "COD: ",
["Postage: "] = "Porto: "
},
["fr"] = {
["Reply"] = "Répondre",
["Forward"] = "Transférer",
["Reply To Message"] = "Répondre au Message",
["Forward Message"] = "Transférer le Message",
["Original Message: "] = "Message Original: ",
["Save Mail"] = "Save Mail",
["From: "] = "Von: ",
["Fwd: "] = "Tr: ",
["Re: "] = "Re: ",
["Attachments: "] = "Pièces jointes: ",
["To:"] = "A:",
["Received:"] = "Reçus:",
["Sent:"] = "Envoyé:",
["Attached Gold: "] = "Or Attaché: ",
["COD: "] = "COD: ",
["Postage: "] = "Affranchissement: "
},
["es"] = {
["Reply"] = "Responder",
["Forward"] = "Reenviar",
["Reply To Message"] = "Responder mensaje",
["Forward Message"] = "Reenviar mensaje",
["Original Message"] = "Mensaje original",
["Save Mail"] = "Guardar correo",
["From: "] = "De: ",
["Fwd: "] = "RV: ",
["Re: "] = "RE: ",
["Attachments: "] = "Adjuntos: ",
["To:"] = "Para:",
["Received:"] = "Recibido:",
["Sent:"] = "Enviar:",
["Attached Gold: "] = "Oro adjunto: ",
["COD: "] = "Contra reembolso: ",
["Postage: "] = "Gastos de envío: ",
},
}
local ShowPlayerContextMenu_Orig = CHAT_SYSTEM.ShowPlayerContextMenu
local ShowPlayerInteractMenu_Orig = ZO_PlayerToPlayer.ShowPlayerInteractMenu
-------------------------------------------------
----- logger -----
-------------------------------------------------
MailR.show_log = false
if LibDebugLogger then
local logger = LibDebugLogger.Create(MailR.Name)
MailR.logger = logger
end
local SDLV = DebugLogViewer
if SDLV then MailR.viewer = true else MailR.viewer = false end
local function create_log(log_type, log_content)
if log_type == "Debug" then
MailR.logger:Debug(log_content)
end
if log_type == "Info" then
MailR.logger:Info(log_content)
end
if log_type == "Verbose" then
MailR.logger:Verbose(log_content)
end
if log_type == "Warn" then
MailR.logger:Warn(log_content)
end
end
local function emit_message(log_type, text)
if (text == "") then
text = "[Empty String]"
end
create_log(log_type, text)
end
local function emit_table(log_type, t, indent, table_history)
indent = indent or "."
table_history = table_history or {}
for k, v in pairs(t) do
local vType = type(v)
emit_message(log_type, indent .. "(" .. vType .. "): " .. tostring(k) .. " = " .. tostring(v))
if (vType == "table") then
if (table_history[v]) then
emit_message(log_type, indent .. "Avoiding cycle on table...")
else
table_history[v] = true
emit_table(log_type, v, indent .. " ", table_history)
end
end
end
end
function MailR.dm(log_type, ...)
if not MailR.logger then return end
if not MailR.show_log then return end
for i = 1, select("#", ...) do
local value = select(i, ...)
if (type(value) == "table") then
emit_table(log_type, value)
else
emit_message(log_type, tostring(value))
end
end
end
-- temp fix for Wykyyds Mailbox
if type(WYK_MailBox) == "table" then
WYK_MailBox.ReadMail = function() return end
end
-- /GLOBALS
-- When Forward Button Clicked or Key Pressed
function MailR.CreateForward()
-- make sure we only try to create/show a reply when the mailInbox is active
MailR.dm("Debug", "CreateForward")
if not MailR.mailboxActive then return end
MailR.dm("Debug", "mailboxActive")
if SCENE_MANAGER.currentScene.name ~= "mailInbox" then return end
if MailR.currentMessageInfo["numAttachments"] == nil or MailR.currentMessageInfo["isSentMail"] == nil then return end
if MailR.currentMessageInfo["numAttachments"] > 0 and not MailR.currentMessageInfo["isSentMail"] then return end
local openMailId = MAIL_INBOX:GetOpenMailId()
if not MAIL_INBOX:GetMailData(openMailId) then return end
MailR.dm("Debug", "Creating Forward")
-- ZO_MainMenuSceneGroupBarButton2.m_object.m_buttonData:callback()
local fwdStr = MailR.localeStringMap[MailR.effective_lang]["Fwd: "]
local replyString = MailR.currentMessageInfo["subject"]:gsub("^" .. fwdStr, "")
ZO_MailSendSubjectField:SetText(fwdStr .. replyString)
local origStr = MailR.localeStringMap[MailR.effective_lang]["Original Message"]
local bodyStr = "\n***" .. MailR.DEFAULT_HEADER_COLOR_STRING .. origStr .. MailR.RESET_COLOR_STRING .. "***\n"
local senderStr = MailR.currentMessageInfo["displayName"]
if not MailR.currentMessageInfo["characterName"] == "" and not MailR.currentMessageInfo["characterName"] == nil then
senderStr = MailR.currentMessageInfo["characterName"] .. "(" .. senderStr .. ")"
end
bodyStr = bodyStr .. MailR.DEFAULT_HEADER_COLOR_STRING .. MailR.localeStringMap[MailR.effective_lang]["From: "] .. MailR.RESET_COLOR_STRING .. senderStr .. "\n"
bodyStr = bodyStr .. "\n" .. MailR.currentMessageInfo["body"] .. "\n"
bodyStr = bodyStr .. "***" .. MailR.DEFAULT_HEADER_COLOR_STRING .. "/" .. MailR.localeStringMap[MailR.effective_lang]["Original Message"] .. MailR.RESET_COLOR_STRING .. "***\n"
ZO_MailSendBodyField:SetText(bodyStr)
ZO_MailSendBodyField:TakeFocus()
end
-- Handles when a message in the inbox is selected
function MailR.InboxMessageSelected(eventCode, mailId)
MailR.dm("Debug", "InboxMessageSelected")
MailR.dm("Verbose", mailId)
MailR.dm("Verbose", { GetMailItemInfo(mailId) })
local senderDisplayName, senderCharacterName, subject, mailItemIcon, unread,
fromSystem, fromCustomerService, returned, numAttachments, attachedMoney,
codAmount, expiresInDays, secsSinceReceived = GetMailItemInfo(mailId)
--[[ TODO: Update the concept of isSentMail such that when you send mail
it is auto saved and flagged as sent. Received Mail is flagged when saved.
However, both types then indicate that it is a MailR mail and not player or
system mail.
MailR.currentMessageInfo["isSentMail"] = MailR.IsMailIdSentMail(mailId)
MailR.currentMessageInfo["isReceivedMail"] = false
6/17/2024 The list is no longer a scroll list and MailR enhanced that
scroll list so storing sent or received no longer applies because we
are not altering the new tree
]]--
MailR.currentMessageInfo["displayName"] = senderDisplayName
MailR.currentMessageInfo["recipient"] = senderDisplayName
MailR.currentMessageInfo["characterName"] = senderCharacterName
MailR.currentMessageInfo["subject"] = subject
MailR.currentMessageInfo["body"] = ZO_MailInboxMessageBody:GetText()
MailR.currentMessageInfo["numAttachments"] = numAttachments
MailR.currentMessageInfo["secsSinceReceived"] = secsSinceReceived
MailR.currentMessageInfo["timeSent"] = GetTimeStamp() - secsSinceReceived
MailR.currentMessageInfo["gold"] = 0
MailR.currentMessageInfo["cod"] = false
MailR.currentMessageInfo["postage"] = 0
MailR.currentMessageInfo["mailId"] = mailId
-- Initialize attachments table with empty tables
MailR.currentMessageInfo["attachments"] = {}
for a = 1, MailR.MAX_ATTACHMENTS do
MailR.currentMessageInfo["attachments"][a] = {}
end
--[[ we dont do anything with this information yet
if not MailR.IsMailIdSentMail(mailId) then
TODO: Make sure the attachments are saved with the mail
because previously it was checked whether or not it was
sent mail
]]--
for a = 1, numAttachments do
local textureName, stack, creatorName = GetAttachedItemInfo(mailId, a)
local link = GetAttachedItemLink(mailId, a, LINK_STYLE_DEFAULT)
local icon = GetItemLinkInfo(link)
MailR.currentMessageInfo["attachments"][a].textureName = textureName
MailR.currentMessageInfo["attachments"][a].stack = stack
MailR.currentMessageInfo["attachments"][a].creatorName = creatorName
MailR.currentMessageInfo["attachments"][a].link = link
MailR.currentMessageInfo["attachments"][a].icon = icon
end
--[[
end
TODO: Make sure the attachments are saved with the mail
because previously it was checked whether or not it was
sent mail
]]--
-- shoud we include the body of the original message? Is there a message limit?
-- this doesn't seem to return what I expect so use whats below
--if IsMailReturnable(mailId) then
-- some messages you cant reply to (e.g. system messages)
if senderDisplayName == nil or senderDisplayName == "" or fromSystem then
MailR.currentMessageInfo["returnable"] = false
else
MailR.currentMessageInfo["returnable"] = true
end
end
-- Mail UI opened
function MailR.SetMailboxActive(eventCode)
MailR.dm("Debug", "SetMailboxActive")
MailR.mailboxActive = true
end
-- Mail UI closed
function MailR.SetMailboxInactive(eventCode)
MailR.dm("Debug", "SetMailboxInactive")
MailR.mailboxActive = false
end
-- Get Keybind Layer Index by Layer Name
function MailR.GetKeybindLayerIndex(layerName)
MailR.dm("Debug", "GetKeybindLayerIndex")
local layers = GetNumActionLayers()
for layer = 1, layers do
if GetActionLayerInfo(layer) == layerName then return layer end
end
return 0
end
-- Get keybind category index by name
function MailR.GetKeybindCategoryIndex(layerIndex, categoryName)
MailR.dm("Debug", "GetKeybindCategoryIndex")
local layerName, numCategories = GetActionLayerInfo(layerIndex)
for category = 1, numCategories do
if GetActionLayerCategoryInfo(layerIndex, category) == categoryName then return category end
end
return 0
end
-- get keybind action index by name
function MailR.GetKeybindActionIndex(layerIndex, categoryIndex, actionName)
MailR.dm("Debug", "GetKeybindActionIndex")
local categoryName, numActions = GetActionLayerCategoryInfo(layerIndex, categoryIndex)
for action = 1, numActions do
if GetActionInfo(layerIndex, categoryIndex, action) == actionName then return action end
end
return 0
end
-- get only the primary keybind. Suspect there is a oneliner API func somewhere
function MailR.GetPrimaryKeybindInfo(layerName, categoryName, actionName)
MailR.dm("Debug", "GetPrimaryKeybindInfo")
local primaryBindIndex = 1
local layerIndex = MailR.GetKeybindLayerIndex(layerName)
local categoryIndex = MailR.GetKeybindCategoryIndex(layerIndex, categoryName)
local actionIndex = MailR.GetKeybindActionIndex(layerIndex, categoryIndex, actionName)
local keyCode = GetActionBindingInfo(layerIndex, categoryIndex, actionIndex, primaryBindIndex)
local keyName = GetKeyName(keyCode)
return { keyCode, keyName }
end
-- somebody updated their keybinds so we should probably update too
function MailR.UpdateKeybindInfo(eventCode)
MailR.dm("Debug", "UpdateKeybindInfo")
local forwardKeybind = MailR.GetPrimaryKeybindInfo(GetString(SI_KEYBINDINGS_LAYER_GENERAL), "MailR",
"MAIL_FORWARD")
MailR.keybindInfo["FORWARD"] = forwardKeybind
end
-- called when text in recipient field of composed message is updated
--TODO Keep: Examine why this is needed
function MailR.UpdateSendTo()
MailR.dm("Verbose", "recipient updated")
MailR.currentSendMessageInfo["recipient"] = ZO_MailSendToField:GetText()
end
-- called when text in subject field of composed message is updated
--TODO Keep: Examine why this is needed
function MailR.UpdateSendSubject()
MailR.dm("Verbose", "subject updated")
MailR.currentSendMessageInfo["subject"] = ZO_MailSendSubjectField:GetText()
end
-- called when text in body field of composed message is updated
--TODO Keep: Examine why this is needed
function MailR.UpdateSendBody()
MailR.dm("Verbose", "body updated")
MailR.currentSendMessageInfo["body"] = ZO_MailSendBodyField:GetText()
end
MailR.MAX_MAILID = 2147483647
function MailR.GenerateMailId()
return math.random(MailR.MAX_MAILID)
end
function MailR.rtrim(s)
MailR.dm("Debug", "rtrim")
local n = #s
while n > 0 and s:find("^%s", n) do n = n - 1 end
return s:sub(1, n)
end
function MailR.MailSentSuccessfully(eventCode, playerName)
MailR.dm("Debug", "MailSentSuccessfully")
if next(MailR.queuedSentMessage) == nil then return end
MailR.queuedSentMessage["timeSent"] = GetTimeStamp()
if MailR.rtrim(MailR.queuedSentMessage["subject"]) == "" then
MailR.queuedSentMessage["subject"] = "(No Subject)"
end
MailR.queuedSentMessage["isSentMail"] = true
-- MailR.dm("Debug", MailR.queuedSentMessage)
local mailId = MailR.GenerateMailId()
while MailR.SavedMail.sent_messages["MailR_" .. tostring(mailId)] ~= nil do
mailId = MailR.GenerateMailId()
end
MailR.SavedMail.sent_messages["MailR_" .. tostring(mailId)] = MailR.CopyMessage(MailR.queuedSentMessage)
MailR.SavedMail.sent_count = MailR.SavedMail.sent_count + 1
MailR.ClearCurrentSendMessage()
MailR.queuedSentMessage = {}
QueueMoneyAttachment(0) --reset per awesomebillys recommendation for known COD bug as of 2014-05-15
MAIL_INBOX:RefreshData()
end
-- clear current message table
function MailR.ClearCurrentSendMessage()
MailR.dm("Debug", "ClearCurrentSendMessage")
MailR.currentSendMessageInfo["recipient"] = ""
MailR.currentSendMessageInfo["subject"] = ""
MailR.currentSendMessageInfo["body"] = ""
MailR.currentSendMessageInfo["gold"] = 0
MailR.currentSendMessageInfo["cod"] = false
MailR.currentSendMessageInfo["postage"] = 0
MailR.currentSendMessageInfo["timeSent"] = 0
MailR.currentSendMessageInfo["attachments"] = {}
-- Initialize attachments table with empty tables
MailR.currentSendMessageInfo["attachments"] = {}
for a = 1, MailR.MAX_ATTACHMENTS do
MailR.currentSendMessageInfo["attachments"][a] = {}
end
end
-- copy message_table to a new table
function MailR.CopyMessage(messageToCopy)
MailR.dm("Debug", "CopyMessage")
local copyMessage = {}
copyMessage["recipient"] = messageToCopy["recipient"]
copyMessage["subject"] = messageToCopy["subject"]
copyMessage["body"] = messageToCopy["body"]
copyMessage["gold"] = messageToCopy["gold"]
copyMessage["cod"] = messageToCopy["cod"]
copyMessage["postage"] = messageToCopy["postage"]
copyMessage["timeSent"] = messageToCopy["timeSent"]
copyMessage["isSentMail"] = messageToCopy["isSentMail"]
copyMessage["isReceivedMail"] = messageToCopy["isReceivedMail"]
copyMessage["returnable"] = messageToCopy["returnable"]
copyMessage["attachments"] = {}
for a = 1, MailR.MAX_ATTACHMENTS do
table.insert(copyMessage["attachments"], messageToCopy["attachments"][a])
end
return copyMessage
end
-- called when attachments are added to composed mail
function MailR.AttachmentAdded(eventCode, slot)
MailR.dm("Debug", "AttachmentAdded")
local attachment = ZO_MailSendAttachments:GetChild(slot)
local bagid = attachment.bagId
local slotid = attachment.slotIndex
local stack = attachment.stackCount
local link = GetItemLink(bagid, slotid, LINK_STYLE_DEFAULT)
local icon = GetItemLinkInfo(link)
MailR.currentSendMessageInfo["attachments"][slot] = { ["stack"] = stack, ["link"] = link, ["icon"] = icon }
MailR.currentSendMessageInfo["postage"] = GetQueuedMailPostage()
end
-- called when attachments are removed from composed mail
function MailR.AttachmentRemoved(eventCode, slot)
MailR.dm("Debug", "AttachmentRemoved")
MailR.currentSendMessageInfo["attachments"][slot] = {}
MailR.currentSendMessageInfo["postage"] = GetQueuedMailPostage()
end
-- called when attached money updated
function MailR.AttachmentMoneyChanged(eventCode, gold)
MailR.dm("Debug", "AttachmentMoneyChanged")
MailR.currentSendMessageInfo["gold"] = gold
MailR.currentSendMessageInfo["postage"] = GetQueuedMailPostage()
end
-- called when changed from gold payment to COD
function MailR.CODChanged(eventCode, codAmount)
MailR.dm("Debug", "CODChanged")
if GetQueuedCOD() > 0 then
MailR.currentSendMessageInfo["cod"] = true
MailR.currentSendMessageInfo["gold"] = GetQueuedCOD()
else
MailR.currentSendMessageInfo["cod"] = false
end
MailR.currentSendMessageInfo["postage"] = GetQueuedMailPostage()
end
-- when SendMail is called do this first, otherwise currentSendMessageInfo gets cleared (by ZOS)
function MailR.QueueSentMessage()
MailR.dm("Debug", "QueueSentMessage")
MailR.queuedSentMessage = {}
MailR.queuedSentMessage = MailR.CopyMessage(MailR.currentSendMessageInfo)
end
function MailR.OnMouseUp(control, button, upInside)
MailR.dm("Debug", "OnMouseUp")
MAIL_INBOX:Row_OnMouseUp(control)
if not control then return end
local mailId = control.dataEntry.data.mailId
if button == 2 then
ClearMenu()
AddMenuItem("Save Message", MailR.SaveMail)
ShowMenu()
end
end
function MailR.SaveMail()
MailR.dm("Debug", "SaveMail")
local mail = MailR.currentMessageInfo
local savedMailId = "MailR_" .. Id64ToString(MailR.currentMessageInfo.mailId)
mail.isSentMail = false
mail.isReceivedMail = true
MailR.SavedMail.sent_messages[savedMailId] = MailR.CopyMessage(MailR.currentMessageInfo)
MailR.SavedMail.sent_count = MailR.SavedMail.sent_count + 1
KEYBIND_STRIP:UpdateKeybindButtonGroup(MAIL_INBOX.selectionKeybindStripDescriptor)
MAIL_INBOX:RefreshData()
end
function MailR.ShowPlayerContextMenu(self, playerName, rawName)
ShowPlayerContextMenu_Orig(self, playerName, rawName)
AddMenuItem('Send Mail', function()
SCENE_MANAGER:Show('mailSend')
ZO_MailSendToField:SetText(playerName)
end)
ShowMenu()
end
function MailR.ShowPlayerInteractMenu(self, isIgnored)
MailR.dm("Debug", "ShowPlayerInteractMenu")
local currentTarget = self.currentTargetCharacterName
local icons = {
enabledNormal = "EsoUI/Art/Mail/mail_tabicon_compose_up.dds",
enabledSelected = "EsoUI/Art/Mail/mail_tabicon_compose_down.dds",
disabledNormal = "EsoUI/Art/Mail/mail_tabicon_compose_up.dds",
disabledSelected = "EsoUI/Art/Mail/mail_tabicon_compose_down.dds",
}
self:AddMenuEntry("Send Mail", icons, isIgnored, function()
SCENE_MANAGER:Show('mailSend')
ZO_MailSendToField:SetText(currentTarget)
end)
ShowPlayerInteractMenu_Orig(self, isIgnored)
end
function MailR.CheckMailIdEquality(mailId1, mailId2)
MailR.dm("Debug", "CheckMailIdEquality")
return mailId1 == mailId2
end
function MailR.MailIdEquality(...)
MailR.dm("Debug", "MailIdEquality")
-- return MailR.CheckMailIdEquality(data1.mailId, data2.mailId)
return true
end
function MailR.HasAlreadyReportedSelectedMail(self)
MailR.dm("Debug", "HasAlreadyReportedSelectedMail")
return self.reportedMailIds[zo_getSafeId64Key(self.mailId)]
end
function MailR.OverloadMailInbox()
MailR.dm("Debug", "OverloadMailInbox")
--[[ 6/17/2024 The list is no longer a scroll list and MailR enhanced that
scroll list so storing sent or received no longer applies because we
are not altering the new tree
local originalIsMailReturnable = IsMailReturnable
IsMailReturnable = function(mailId)
if MailR.IsMailIdSentMail(mailId) then
MailR.dm("Debug", "MailR IsMailReturnable")
return false
else
MailR.dm("Debug", "Original IsMailReturnable")
return originalIsMailReturnable(mailId)
end
end
]]--
--[[ Many older functions were removed because it is not a ScrollList now
MAIL_INBOX.RequestReadMessage = MailR.RequestReadMessage
MAIL_INBOX.HasAlreadyReportedSelectedMail = MailR.HasAlreadyReportedSelectedMail
ZO_MailInboxRow_OnMouseUp = MailR.OnMouseUp
ZO_PlayerToPlayer.ShowPlayerInteractMenu = MailR.ShowPlayerInteractMenu
MAIL_INBOX.ConfirmDelete = MailR.ConfirmDelete
MAIL_INBOX.IsMailDeletable = MailR.IsMailDeletable
]]--
CHAT_SYSTEM.ShowPlayerContextMenu = MailR.ShowPlayerContextMenu
MAIL_INBOX.Delete = MailR.Delete
for i = 1, MailR.MAX_READ_ATTACHMENTS do
table.insert(MailR.defaultMailInboxFn,
{ MAIL_INBOX.attachmentSlots[i]:GetHandler("OnMouseEnter"), MAIL_INBOX.attachmentSlots[i]:GetHandler("OnClicked"), MAIL_INBOX.attachmentSlots[i]:GetHandler("OnMouseDoubleClicked") })
end
-- overload keybinds...I think I have effectively rewritten ESO Mail at this point
-- instead of adding on :/
MAIL_INBOX.InitializeKeybindDescriptors = MailR.InitializeInboxKeybindDescriptors
MAIL_INBOX:InitializeKeybindDescriptors()
end
function MailR.OverloadMailSend()
MailR.dm("Debug", "OverloadMailSend")
MAIL_SEND.InitializeKeybindDescriptors = MailR.InitializeSendKeybindDescriptors
MAIL_SEND:InitializeKeybindDescriptors()
end
function MailR.Guild_MouseEnter(control)
MailR.GuildControl:Row_OnMouseEnter(control)
end
function MailR.Guild_MouseExit(control)
MailR.GuildControl:Row_OnMouseExit(control)
end
function MailR.Guild_MouseUp(control, button, upInside)
MailR.dm("Debug", "Guild_MouseUp")
--[[TODO not sure what the MouseUp feature was supposed to do]]--
local name = control.data.name
local pressed_button = 1
local api_ver = GetAPIVersion()
if api_ver > 100011 then pressed_button = MOUSE_BUTTON_INDEX_LEFT end
if button == pressed_button then
MailR.GuildControl:RefreshVisible()
end
--MailR.Guild:MouseEnter(control, button, upInside)
end
function MailR.InitializeInboxKeybindDescriptors(self)
MailR.dm("Debug", "InitializeInboxKeybindDescriptors")
local function ReportAndDeleteCallback()
self:RecordSelectedMailAsReported()
self:Delete()
end
self.selectionKeybindStripDescriptor = {
alignment = KEYBIND_STRIP_ALIGN_CENTER,
--Return
{
name = GetString(SI_MAIL_READ_RETURN),
keybind = "UI_SHORTCUT_SECONDARY",
callback = function()
self:Return()
end,
visible = function()
if self.mailId then
return IsMailReturnable(self.mailId)
end
return false
end
},
--Reply
{
name = GetString(SI_MAIL_READ_REPLY),
keybind = "UI_SHORTCUT_TERTIARY",
callback = function()
self:Reply()
end,
visible = function()
if self.mailId then
local mailData = self:GetMailData(self.mailId)
return mailData and mailData.isFromPlayer or false
end
return false
end
},
-- Delete
{
name = GetString(SI_MAIL_READ_DELETE),
keybind = "UI_SHORTCUT_NEGATIVE",
callback = function()
self:Delete()
end,
visible = function()
if self.mailId then
return not IsMailReturnable(self.mailId)
end
return false
end
},
-- Take Attachments
{
name = GetString(SI_MAIL_READ_ATTACHMENTS_TAKE),
keybind = "UI_SHORTCUT_PRIMARY",
callback = function()
self:TryTakeAll()
end,
visible = function()
if self.mailId then
local numAttachments, attachedMoney, codAmount = GetMailAttachmentInfo(self.mailId)
if numAttachments > 0 or attachedMoney > 0 then
return true
end
end
return false
end
},
--Take All
{
name = function()
if self.mailId then
local mailData = self:GetMailData(self.mailId)
return GetString("SI_MAILCATEGORY_TAKEALL", mailData.category)
end
end,
keybind = "UI_SHORTCUT_QUATERNARY",
callback = function()
if self.mailId then
local mailData = self:GetMailData(self.mailId)
ZO_Dialogs_ShowPlatformDialog("MAIL_CONFIRM_TAKE_ALL", { category = mailData.category })
end
end,
visible = function()
if self.mailId then
local mailData = self:GetMailData(self.mailId)
if mailData then
local canTakeAttachments = CanTryTakeAllMailAttachmentsInCategory(mailData.category, MAIL_MANAGER:ShouldDeleteOnClaim())
return canTakeAttachments
end
end
return false
end,
},
--Report Player
{
name = GetString(SI_MAIL_READ_REPORT_PLAYER),
keybind = "UI_SHORTCUT_REPORT_PLAYER",
visible = function()
if not self:HasAlreadyReportedSelectedMail() then
local mailData = self:GetMailData(self.mailId)
return mailData and mailData.isFromPlayer
end
end,
callback = function()
if self.mailId then
local senderDisplayName = GetMailSender(self.mailId)
local function ReportCallback()
self:RecordSelectedMailAsReported()
if not IsIgnored() then
AddIgnore(senderDisplayName)
end
end
ZO_HELP_GENERIC_TICKET_SUBMISSION_MANAGER:OpenReportPlayerTicketScene(senderDisplayName, ReportCallback)
end
end,
},
--Forward Mail
{
name = MailR.localeStringMap[MailR.effective_lang]["Forward"],
keybind = "MAIL_FORWARD", --MailR.GetPrimaryKeybindInfo(GetString(SI_KEYBINDINGS_LAYER_GENERAL), "MailR", "MAIL_FORWARD")[2],
visible = function()
if (self.mailId) then
return not IsMailReturnable(self.mailId)
end
end,
callback = function()
if (self.mailId) then
MailR.CreateForward()
end
end,
},
--Save Mail
{
name = MailR.localeStringMap[MailR.effective_lang]["Save Mail"],
keybind = "MAIL_SAVE", --MailR.GetPrimaryKeybindInfo(GetString(SI_KEYBINDINGS_LAYER_GENERAL), "MailR", "MAIL_SAVE")[2],
visible = function()
if self.mailId == nil then return false end
if not MailR.SavedMail.sent_messages["MailR_" .. Id64ToString(self.mailId)] then
return true
end
end,
callback = function()
if self.mailId then
MailR.SaveMail()
end
end,
},
}
end
function MailR:InitializeSendKeybindDescriptors()
MailR.dm("Debug", "InitializeSendKeybindDescriptors")
self.staticKeybindStripDescriptor = {
alignment = KEYBIND_STRIP_ALIGN_CENTER,
-- Clear
{
name = GetString(SI_MAIL_SEND_CLEAR),
keybind = "UI_SHORTCUT_NEGATIVE",
callback = function()
ZO_Dialogs_ShowDialog("CONFIRM_CLEAR_MAIL_COMPOSE", { callback = function() self:ClearFields() end })
end,
},
-- Send
{
name = GetString(SI_MAIL_SEND_SEND),
keybind = "UI_SHORTCUT_SECONDARY",
callback = function()
MailR.QueueSentMessage()
self:Send()
end,
},
}
end
function MailR.IsMailDeletable(mailId)
local numAttachments, attachedMoney = GetMailAttachmentInfo(mailId)
local noAttachments = numAttachments == 0 and attachedMoney == 0
return noAttachments
end
function MailR.Delete()
MailR.dm("Debug", "Delete")
local mailId = MAIL_INBOX.mailId
MailR.dm("Debug", mailId)
-- original
if mailId then
if MailR.IsMailDeletable(mailId) then
if MAIL_MANAGER.savedVars.deleteOnClaim then
DeleteMail(mailId)
else
ZO_Dialogs_ShowPlatformDialog("DELETE_MAIL", { confirmationCallback = function(...)
DeleteMail(mailId)
PlaySound(SOUNDS.MAIL_ITEM_DELETED)
end, mailId = MAIL_INBOX.mailId, })
end
end
end
end
function MailR.ConvertSavedMail()
MailR.dm("Debug", "ConvertSavedMail")
-- version 1.0 to 2.0
if MailR.SavedMail.messages ~= nil then
MailR.SavedMail.inbox_messages = {}
MailR.SavedMail.inbox_count = 0
MailR.SavedMail.sent_messages = {}
for k, v in pairs(MailR.SavedMail.messages) do
MailR.SavedMail.sent_messages[k] = v
end
MailR.SavedMail.sent_count = #MailR.SavedMail.sent_messages
MailR.SavedMail.messages = nil
MailR.SavedMail.count = nil
MailR.SavedMail.mailr_version = MailR.SAVED_MAIL_VERSION
end
end
-- do all this when the addon is loaded
function MailR.Init(eventCode, addOnName)
if addOnName ~= "MailR" then return end
MailR.dm("Debug", "OnAddonLoaded, Init")
-- Event Registration
EVENT_MANAGER:RegisterForEvent("MailR_InboxMessageSelected", EVENT_MAIL_READABLE, MailR.InboxMessageSelected)
EVENT_MANAGER:RegisterForEvent("MailR_SetMailboxActive", EVENT_MAIL_OPEN_MAILBOX, MailR.SetMailboxActive)
EVENT_MANAGER:RegisterForEvent("MailR_SetMailboxInactive", EVENT_MAIL_CLOSE_MAILBOX, MailR.SetMailboxInactive)
EVENT_MANAGER:RegisterForEvent("MailR_UpdateKeybindInfo", EVENT_KEYBINDING_SET, MailR.UpdateKeybindInfo)
EVENT_MANAGER:RegisterForEvent("MailR_MailSentSuccessfully", EVENT_MAIL_SEND_SUCCESS, MailR.MailSentSuccessfully)
EVENT_MANAGER:RegisterForEvent("MailR_AttachmentAdded", EVENT_MAIL_ATTACHMENT_ADDED, MailR.AttachmentAdded)
EVENT_MANAGER:RegisterForEvent("MailR_AttachmentRemoved", EVENT_MAIL_ATTACHMENT_REMOVED, MailR.AttachmentRemoved)
EVENT_MANAGER:RegisterForEvent("MailR_CODChanged", EVENT_MAIL_COD_CHANGED, MailR.CODChanged)
EVENT_MANAGER:RegisterForEvent("MailR_AttachmentMoneyChanged", EVENT_MAIL_ATTACHED_MONEY_CHANGED, MailR.AttachmentMoneyChanged)
SLASH_COMMANDS["/mailr"] = MailR.FilterDisplay
MailR.mailboxActive = false
MailR.ClearCurrentSendMessage()
MailR.SavedMail = ZO_SavedVars:New("SV_MailR_SavedMail", 1, nil, MailR.SavedMail_defaults)
local sv = SV_MailR_SavedMail.Default[GetDisplayName()][GetUnitName("player")]
-- Clean up saved variables (from previous versions)
for key, val in pairs(sv) do
-- Delete key-value pair if the key can't also be found in the default settings (except for version)
if key ~= "version" and MailR.SavedMail_defaults[key] == nil then
sv[key] = nil
end
end
MailR.SavedMail.disableDeleteConfirmation = nil -- Removed for U42
if MailR.SavedMail.display == nil then
MailR.SavedMail.display = "all"
end
-- we have to do this because if we tell ZO_SavedVars our version changed it will delete everything
-- check for messags as well as version because of version 1.0 conflict with ZOS
if MailR.SavedMail.messages ~= nil or MailR.SavedMail.mailr_version ~= MailR.SAVED_MAIL_VERSION then
MailR.ConvertSavedMail()
end
math.randomseed(GetTimeStamp())
local forwardSettingStr = MailR.localeStringMap[MailR.effective_lang]["Forward Message"]
local mailSaveStr = MailR.localeStringMap[MailR.effective_lang]["Save Mail"]
ZO_CreateStringId("SI_BINDING_NAME_MAIL_FORWARD", forwardSettingStr)
ZO_CreateStringId("SI_BINDING_NAME_MAIL_SAVE", mailSaveStr)
local originalSendToHandler = ZO_MailSendToField:GetHandler("OnTextChanged")
ZO_MailSendToField:SetHandler("OnTextChanged", function(...)
originalSendToHandler(...)
MailR.UpdateSendTo()
end)
local originalSubjectHandler = ZO_MailSendSubjectField:GetHandler("OnTextChanged")
if originalSubjectHandler then
ZO_MailSendSubjectField:SetHandler("OnTextChanged", function(...)
originalSubjectHandler(...)
MailR.UpdateSendSubject()
end)
else
ZO_MailSendSubjectField:SetHandler("OnTextChanged", function(...) MailR.UpdateSendSubject() end)
end
ZO_MailSendBodyField:SetHandler("OnTextChanged", function(...) MailR.UpdateSendBody() end)
MailR.OverloadMailInbox()
MailR.OverloadMailSend()
MailR.UpdateKeybindInfo()
end
EVENT_MANAGER:RegisterForEvent("MailR_Init", EVENT_ADD_ON_LOADED, MailR.Init)