-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathItemCache.lua
1369 lines (1183 loc) · 44.2 KB
/
ItemCache.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
991
992
993
994
995
996
997
998
999
1000
local ADDON_NAME = "ItemCache"
local HOST_ADDON_NAME, Data = ...
local IsStandalone = ADDON_NAME == HOST_ADDON_NAME
local MAJOR, MINOR = ADDON_NAME, 3
local ItemCache, oldMinor = LibStub:NewLibrary(MAJOR, MINOR)
if not ItemCache and not IsStandalone then
return
end
local Addon = {}
local L
local AceConfig
local AceConfigDialog
local AceConfigRegistry
local AceDB
local AceDBOptions
local SemVer
if IsStandalone then
Addon = LibStub("AceAddon-3.0"):NewAddon(ADDON_NAME, "AceConsole-3.0") or {}
ItemCacheAddon = Addon
L = LibStub("AceLocale-3.0"):GetLocale(ADDON_NAME)
AceConfig = LibStub"AceConfig-3.0"
AceConfigDialog = LibStub"AceConfigDialog-3.0"
AceConfigRegistry = LibStub"AceConfigRegistry-3.0"
AceDB = LibStub"AceDB-3.0"
AceDBOptions = LibStub"AceDBOptions-3.0"
SemVer = LibStub"SemVer"
end
local assert = assert
local type = type
local next = next
local ipairs = ipairs
local pairs = pairs
local getmetatable = getmetatable
local setmetatable = setmetatable
local tonumber = tonumber
local format = format
local strsplit = strsplit
local wipe = wipe
local GetMouseFocus = GetMouseFocus
local DoesItemExistByID = C_Item.DoesItemExistByID
local GetItemInfo = GetItemInfo -- removes the need to bypass own hook
local GetItemInfoInstant = GetItemInfoInstant
local UnitExists = UnitExists
local UnitClass = UnitClass
local strmatch = string.match
local strfind = string.find
local strgmatch = string.gmatch
local strgsub = string.gsub
local tblinsert = table.insert
local tblremove = table.remove
local floor = math.floor
function Addon:MakeLookupTable(t, val, keepOrigVals)
local ValFunc
if val ~= nil then
if type(val) == "function" then
ValFunc = val
else
ValFunc = function() return val end
end
end
local new = {}
for k, v in next, t, nil do
if ValFunc then
new[v] = ValFunc(v, k, t)
else
new[v] = k
end
if keepOrigVals and new[k] == nil then
new[k] = v
end
end
return new
end
do
Addon.expansions = {
retail = 9,
wrath = 3,
wotlk = 3,
tbc = 2,
bcc = 2,
classic = 1,
}
Addon.expansionLevel = tonumber(GetBuildInfo():match"^(%d+)%.")
if Addon.expansionLevel >= Addon.expansions.retail then
Addon.expansionName = "retail"
elseif Addon.expansionLevel >= Addon.expansions.wrath then
Addon.expansionName = "wrath"
elseif Addon.expansionLevel == Addon.expansions.tbc then
Addon.expansionName = "tbc"
elseif Addon.expansionLevel == Addon.expansions.classic then
Addon.expansionName = "classic"
end
Addon.isRetail = Addon.expansionName == "retail"
Addon.isWrath = Addon.expansionName == "wrath"
Addon.isTBC = Addon.expansionName == "tbc"
Addon.isClassic = Addon.expansionName == "classic"
end
local MY_CLASS = select(2, UnitClassBase"player")
function Addon:GetDB()
return self.db
end
function Addon:GetDefaultDB()
return self.dbDefault
end
function Addon:GetProfile()
return self:GetDB().profile
end
function Addon:GetDefaultProfile()
return self:GetDefaultDB().profile
end
function Addon:GetGlobal()
return self:GetDB().global
end
function Addon:GetDefaultGlobal()
return self:GetDefaultDB().global
end
local function GetOption(self, db, ...)
local val = db
for _, key in ipairs{...} do
val = val[key]
end
return val
end
function Addon:GetOption(...)
return GetOption(self, self:GetProfile(), ...)
end
function Addon:GetDefaultOption(...)
return GetOption(self, self:GetDefaultProfile(), ...)
end
function Addon:GetGlobalOption(...)
return GetOption(self, self:GetGlobal(), ...)
end
function Addon:GetDefaultGlobalOption(...)
return GetOption(self, self:GetDefaultGlobal(), ...)
end
local function SetOption(self, db, val, ...)
local keys = {...}
local lastKey = tblremove(keys, #keys)
local tbl = db
for _, key in ipairs(keys) do
tbl = tbl[key]
end
tbl[lastKey] = val
end
function Addon:SetOption(val, ...)
return SetOption(self, self:GetProfile(), val, ...)
end
function Addon:ResetOption(...)
return self:SetOption(val, self:GetDefaultOption(...))
end
function Addon:SetGlobalOption(val, ...)
return SetOption(self, self:GetGlobal(), val, ...)
end
function Addon:ResetGlobalOption(...)
return self:SetOption(val, self:GetDefaultGlobalOption(...))
end
local CLASS_MAP_TO_ID = {}
for i = 1, GetNumClasses() do
local name, file, id = GetClassInfo(i)
if name then
local maleNames, femaleNames = LOCALIZED_CLASS_NAMES_MALE[file], LOCALIZED_CLASS_NAMES_FEMALE[file]
for _, v in ipairs{name, file, id, maleNames, femaleNames} do
CLASS_MAP_TO_ID[v] = id
end
end
end
local IsItemUsable, IsItemUnusable
do
-- WARRIOR, PALADIN, HUNTER, ROGUE, PRIEST, DEATHKNIGHT, SHAMAN, MAGE, WARLOCK, MONK, DRUID, DEMONHUNTER
local ID = {}
for i = 1, GetNumClasses() do
local classInfo = C_CreatureInfo.GetClassInfo(i)
if classInfo then
ID[classInfo.classFile] = classInfo.classID
end
end
local weapon = Enum.ItemClass.Weapon
local subWeapon = Enum.ItemWeaponSubclass
local armor = Enum.ItemClass.Armor
local subArmor = Enum.ItemArmorSubclass
local usableTypes = Addon:MakeLookupTable({weapon, armor}, function() return {} end)
usableTypes[weapon][subWeapon.Axe1H] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.HUNTER, ID.PALADIN, ID.ROGUE, ID.SHAMAN, ID.WARRIOR}
usableTypes[weapon][subWeapon.Axe2H] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.HUNTER, ID.PALADIN, ID.SHAMAN, ID.WARRIOR}
usableTypes[weapon][subWeapon.Bows] = Addon:MakeLookupTable{ID.HUNTER, ID.ROGUE, ID.WARRIOR}
usableTypes[weapon][subWeapon.Guns] = Addon:MakeLookupTable{ID.HUNTER, ID.ROGUE, ID.WARRIOR}
usableTypes[weapon][subWeapon.Mace1H] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.DRUID, ID.PALADIN, ID.PRIEST, ID.ROGUE, ID.SHAMAN, ID.WARRIOR}
usableTypes[weapon][subWeapon.Mace2H] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.DRUID, ID.PALADIN, ID.SHAMAN, ID.WARRIOR}
usableTypes[weapon][subWeapon.Polearm] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.DRUID, ID.HUNTER, ID.PALADIN, ID.WARRIOR}
usableTypes[weapon][subWeapon.Sword1H] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.HUNTER, ID.MAGE, ID.PALADIN, ID.ROGUE, ID.WARLOCK, ID.WARRIOR}
usableTypes[weapon][subWeapon.Sword2H] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.HUNTER, ID.PALADIN, ID.WARRIOR}
usableTypes[weapon][subWeapon.Staff] = Addon:MakeLookupTable{ID.DRUID, ID.HUNTER, ID.MAGE, ID.PRIEST, ID.SHAMAN, ID.WARLOCK, ID.WARRIOR}
usableTypes[weapon][subWeapon.Dagger] = Addon:MakeLookupTable{ID.DRUID, ID.HUNTER, ID.MAGE, ID.PRIEST, ID.ROGUE, ID.SHAMAN, ID.WARLOCK, ID.WARRIOR}
usableTypes[weapon][subWeapon.Crossbow] = Addon:MakeLookupTable{ID.HUNTER, ID.ROGUE, ID.WARRIOR}
usableTypes[weapon][subWeapon.Wand] = Addon:MakeLookupTable{ID.MAGE, ID.PRIEST, ID.WARLOCK}
usableTypes[weapon][subWeapon.Thrown] = Addon:MakeLookupTable{ID.HUNTER, ID.ROGUE, ID.WARRIOR}
usableTypes[armor][subArmor.Leather] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.DRUID, ID.HUNTER, ID.PALADIN, ID.ROGUE, ID.SHAMAN, ID.WARRIOR}
usableTypes[armor][subArmor.Mail] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.HUNTER, ID.PALADIN, ID.SHAMAN, ID.WARRIOR}
usableTypes[armor][subArmor.Plate] = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.PALADIN, ID.WARRIOR}
usableTypes[armor][subArmor.Shield] = Addon:MakeLookupTable{ID.PALADIN, ID.SHAMAN, ID.WARRIOR}
usableTypes[armor][subArmor.Libram] = Addon:MakeLookupTable{ID.PALADIN}
usableTypes[armor][subArmor.Idol] = Addon:MakeLookupTable{ID.DRUID}
usableTypes[armor][subArmor.Totem] = Addon:MakeLookupTable{ID.SHAMAN}
usableTypes[armor][subArmor.Sigil] = Addon:MakeLookupTable{ID.DEATHKNIGHT}
-- usableTypes[weapon][subWeapon.Warglaive] = Addon:MakeLookupTable{}
-- usableTypes[weapon][subWeapon.Bearclaw] = Addon:MakeLookupTable{}
-- usableTypes[weapon][subWeapon.Catclaw] = Addon:MakeLookupTable{}
-- usableTypes[weapon][subWeapon.Unarmed] = Addon:MakeLookupTable{}
-- usableTypes[weapon][subWeapon.Generic] = Addon:MakeLookupTable{}
-- usableTypes[weapon][subWeapon.Obsolete3] = Addon:MakeLookupTable{} -- Spears
-- usableTypes[weapon][subWeapon.Fishingpole] = Addon:MakeLookupTable{}
-- usableTypes[armor][subArmor.Generic] = Addon:MakeLookupTable{}
-- usableTypes[armor][subArmor.Cloth] = Addon:MakeLookupTable{}
-- usableTypes[armor][subArmor.Cosmetic] = Addon:MakeLookupTable{}
-- usableTypes[armor][subArmor.Relic] = Addon:MakeLookupTable{}
if Addon.expansionLevel <= Addon.expansions.tbc then
usableTypes[weapon][subWeapon.Axe1H][ID.ROGUE] = nil
usableTypes[weapon][subWeapon.Polearm][ID.DRUID] = nil
end
local dualWielders = Addon:MakeLookupTable{ID.DEATHKNIGHT, ID.HUNTER, ID.ROGUE, ID.SHAMAN, ID.WARRIOR}
IsItemUsable = function(item, classID)
local invType, _, itemClassID, subClassID = select(4, item:GetInfoInstant())
if usableTypes[itemClassID] and usableTypes[itemClassID][subClassID] then
local class = classID or MY_CLASS
return usableTypes[itemClassID][subClassID][class] and (invType ~= "INVTYPE_WEAPONOFFHAND" or dualWielders[class]) and true or false
end
return true
end
IsItemUnusable = function(...) return IsItemUsable(...) end
end
local ItemDB = {}
local Item = {}
local privates = setmetatable({}, {__mode = "k"})
local function private(obj)
return privates[obj]
end
local function setPrivate(obj, p)
privates[obj] = p
return private(obj)
end
local function Round(num, decimalPlaces)
local mult = 10^(tonumber(decimalPlaces) or 0)
return floor(tonumber(num) * mult + 0.5) / mult
end
local Queue = {}
local queueMeta = {
__index = function(_, k) assert(Queue[k], "Queue has no field: " .. tostring(k) .. ". Make sure ItemCache is up to date.") return Queue[k] end,
__tostring = function(self) return "Queue" end,
}
local function MakeQueue(_, vals)
local queue = vals or {}
setPrivate(queue, {head = 1, tail = #queue + 1})
setmetatable(queue, queueMeta)
return queue
end
setmetatable(Queue, {__call = MakeQueue})
function Queue:len()
local private = private(self)
return private.tail - private.head
end
function Queue:isEmpty()
return self:len() <= 0
end
function Queue:hasValues()
return self:len() > 0
end
function Queue:add(v)
local private = private(self)
self[private.tail] = v
private.tail = private.tail + 1
return self
end
function Queue:peek()
return self[private(self).head]
end
function Queue:pop()
local private = private(self)
local v = self:peek()
self[private.head] = nil
private.head = private.head + 1
return v
end
function Queue:empty()
local private = private(self)
private.head, private.tail = 1, 1
wipe(self)
return self
end
local retrieveModes = {
cache = {Retrieve = function(self) return self:Cache() end, IsRetrieved = function(self) return self:IsCached() end},
load = {Retrieve = function(self) return self:Load() end, IsRetrieved = function(self) return self:IsLoaded() end},
}
local CallbackController = {}
local callbackControllerMeta = {
__index = function(_, k) assert(CallbackController[k], "CallbackController has no field: " .. tostring(k) .. ". Make sure ItemCache is up to date.") return CallbackController[k] end,
__tostring = function(self) return "CallbackController" end,
}
local function MakeCallbackController(_, items, retrieveMode, callback, ...)
local queue = {}
for id, suffixItems in pairs(items) do
for suffix, item in pairs(suffixItems) do
tblinsert(queue, item)
end
end
local callbackControllerPrivate = {...}
callbackControllerPrivate.items = items;
callbackControllerPrivate.queue = Queue(queue);
callbackControllerPrivate.Retrieve = retrieveModes[retrieveMode].Retrieve;
callbackControllerPrivate.IsRetrieved = retrieveModes[retrieveMode].IsRetrieved;
callbackControllerPrivate.callback = callback;
callbackControllerPrivate.itemsRemaining = #queue;
callbackControllerPrivate.max = #queue;
callbackControllerPrivate.speed = 1;
callbackControllerPrivate.suspended = false;
callbackControllerPrivate.cancelled = false;
local callbackController = {}
setPrivate(callbackController, callbackControllerPrivate);
return setmetatable(callbackController, callbackControllerMeta);
end
setmetatable(CallbackController, {__call = MakeCallbackController})
function CallbackController:GetSize()
return private(self).max
end
function CallbackController:GetRemaining()
return private(self).itemsRemaining
end
function CallbackController:GetProgress(decimalPlaces)
local private = private(self)
return Round(private.max == 0 and 100 or (private.max - private.itemsRemaining) * 100/private.max, decimalPlaces or 2)
end
function CallbackController:IsComplete()
return private(self).itemsRemaining == 0
end
function CallbackController:GetSpeed()
return private(self).speed
end
function CallbackController:SetSpeed(speed)
private(self).speed = speed
return self
end
function CallbackController:IsSuspended()
return private(self).suspended
end
function CallbackController:Suspend()
private(self).suspended = true
return self
end
function CallbackController:Resume()
private(self).suspended = false
return self
end
function CallbackController:Cancel()
if not self:IsComplete() and not self.cancelled then
private(self).cancelled = true
ItemDB:UnregisterCallbackController(self)
end
return self
end
function CallbackController:IsCancelled()
return private(self).cancelled
end
local storage
local matchMeta = {}
local itemMeta = {
-- GetDebugName because of Blizzard_DebugTools\Blizzard_TableInspectorAttributeDataProvider.lua:61
__index = function(_, k) assert(k == "GetDebugName" or Item[k], "Item has no field: " .. tostring(k) .. ". Make sure ItemCache is up to date.") return Item[k] end,
__newindex = function(self, k, v) error("Item cannot be modified") end,
__metatable = matchMeta,
__eq = function(item1, item2) return item1:GetID() == item2:GetID() and item1:GetSuffix() == item2:GetSuffix() end,
__lt = function(item1, item2) return (item1:GetName() or "") < (item2:GetName() or "") end,
__le = function(item1, item2) return (item1:GetName() or "") <= (item2:GetName() or "") end,
__tostring = function(self) return "Item " .. self:GetID() .. (self:HasSuffix() and (":" .. self:GetSuffix()) or "") end,
}
function ItemCache:DoesItemExistByID(id)
if not DoesItemExistByID(id) then
return false
end
if storage[id] then
for suffix, itemPrivate in pairs(storage[id]) do
if suffix ~= 0 then
return true
elseif itemPrivate.dne then
return false
end
end
end
return true
end
local function IsItem(item)
return type(item) == "table" and getmetatable(item) == matchMeta
end
local function MakeItem(id, suffix)
if suffix == 0 then
suffix = nil
end
local facade = {id, suffix} -- this table could be used to rebuild the Item without a metatable (like after being stored in savedvars). it is NOT protected from editing, but should not be changed
local item -- this table is protected from editing, and contains the actual id and suffix used by Item
if storage[id] and storage[id][suffix or 0] then
item = storage[id][suffix or 0]
else
item = {id = id, suffix = suffix}
end
setPrivate(facade, item)
setPrivate(item, _G.Item:CreateFromItemID(id))
return setmetatable(facade, itemMeta)
end
function ItemCache:FormatSearchText(text)
return text:gsub("%W", ""):lower()
end
local function InterpretItem(arg, suffix)
if IsItem(arg) then
return arg:GetID(), arg:GetSuffix()
end
local argType = type(arg)
if argType == "table" and (arg.id or #arg > 0) then
return arg.id or arg[1], arg.suffix or arg[2]
elseif argType == "string" then -- try to decipher itemlink
local id = tonumber(arg)
if id then
return id
end
local id, suffix = strmatch(arg, "^.-item:(%d-):[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:([%-%d]*):")
id, suffix = tonumber(id or ""), tonumber(suffix or "")
if id then
return id, suffix
end
return nil -- this can happen if GetItemInfo is passed an item name or any random string
elseif argType == "number" then -- must be an itemID
return arg, suffix
else
return nil
end
end
function ItemCache:Filter(...)
return ItemDB:Filter(...)
end
function ItemCache:All()
return ItemDB:Filter(function() return true end)
end
function ItemCache:GetItemInfo(...)
return ItemCache:Item(...):GetInfo()
end
function ItemCache:Item(arg, suffix)
if IsItem(arg) then
return arg
else
local id, suffix = InterpretItem(arg, suffix)
assert(id, format("Bad Item format: %s", arg and tostring(arg) or "nil"))
return ItemDB:Get(id, suffix)
end
return nil
end
ItemCache.Get = ItemCache.Item
setmetatable(ItemCache, {__call = ItemCache.Item})
function ItemDB:Check(id, suffix)
if not self.cache[id] then
return nil
end
return self.cache[id][suffix or 0]
end
function ItemDB:Get(id, suffix)
if not self.cache[id] then
self.cache[id] = {}
end
local item = self.cache[id][suffix or 0]
if not item then
item = MakeItem(id, suffix)
self.cache[id][suffix or 0] = item
end
return item
end
-- check if an item is in storage
function ItemDB:IsStored(item)
local id, suffix = item:GetIDSuffix()
return storage[id] and storage[id][suffix or 0] and true or false
end
-- save an item into storage
function ItemDB:Store(item)
if not storage[item:GetID()] then
if not item:HasSuffix() then
storage[item:GetID()] = {[0] = private(item)}
end
elseif item:HasSuffix() and not storage[item:GetID()][item:GetSuffix()] then -- only store suffix items if the suffix matters
local noSuffixItem = self:Get(item:GetID())
if noSuffixItem and item:GetName() ~= noSuffixItem:GetName() then
storage[item:GetID()][item:GetSuffix()] = private(item)
end
end
end
function ItemDB:Filter(func)
local list = {}
for id, items in pairs(self.cache) do
for suffix, item in pairs(items) do
if self:IsStored(item) and func(item, id, suffix) then
tblinsert(list, item)
end
end
end
return list
end
function ItemDB:GetItemInfoPacked(...)
return {GetItemInfo(...)}
end
function ItemDB:AddQueryItems(callbackController)
tblinsert(self.queryCallbacks, callbackController)
end
function ItemDB:AddLoadCallback(callbackController)
tblinsert(self.loadCallbacks, callbackController)
end
function ItemDB:RunLoadCallbacks(item)
local id, suffix = item:GetID(), item:GetSuffix() or 0
for i = #self.loadCallbacks, 1, -1 do
local private = private(self.loadCallbacks[i])
local items = private.items
if items[id] and items[id][suffix] then
items[id][suffix] = nil
if not next(items[id]) then
items[id] = nil
end
private.itemsRemaining = private.itemsRemaining - 1
if private.itemsRemaining == 0 then
if private.callback then
private.callback(unpack(private))
end
tblremove(self.loadCallbacks, i)
end
end
end
end
function ItemDB:RegisterCallbackController(callbackController)
tblinsert(self.queryCallbacks, callbackController)
tblinsert(self.loadCallbacks, callbackController)
private(callbackController).registered = true
end
function ItemDB:UnregisterCallbackController(callbackController)
for _, tbl in ipairs{self.queryCallbacks, self.loadCallbacks} do
for i, v in ipairs(tbl) do
if v == callbackController then
tblremove(tbl, i)
end
end
end
private(callbackController).registered = false
end
function ItemDB:InitTooltipScanner()
self.tooltipScanner = ItemCachetooltipScanner
if not self.tooltipScanner then
self.tooltipScanner = CreateFrame("GameTooltip", "ItemCachetooltipScanner", UIParent, "GameTooltipTemplate")
self.tooltipScanner:Hide()
self.tooltipScanner.ClassesAllowed = format("^%s$" , ITEM_CLASSES_ALLOWED:gsub("%d+%$", ""):gsub("%%s", "(.+)"))
self.tooltipScanner.SkillRequired = format("^%s$" , ITEM_MIN_SKILL:gsub("%d+%$", ""):gsub("%%s ", "([%%a%%s]+) "):gsub("%(%%d%)", "%%((%%d+)%%)"))
self.tooltipScanner.Unique = format("^(%s)$", ITEM_UNIQUE:gsub("%d+%$", ""))
self.tooltipScanner.StartsQuest = format("^(%s)$", ITEM_STARTS_QUEST:gsub("%d+%$", ""))
end
end
function ItemDB:InitQueryCallbacks()
self.QueryFrame = CreateFrame("Frame", nil, UIItem)
self.QueryFrame:SetPoint("TOPLEFT", UIItem, "TOPLEFT", 0, 0)
self.QueryFrame:SetSize(0, 0)
self.QueryFrame:Show()
self.QueryFrame:SetScript("OnUpdate", function()
if #self.queryCallbacks == 0 then return end
for i = #self.queryCallbacks, 1, -1 do
local private = private(self.queryCallbacks[i])
local queue = private.queue
local yieldThreshold = private.speed
if private.itemsRemaining == 0 then
queue:empty()
tblremove(self.queryCallbacks, i)
elseif not private.suspended then
local Retrieve = private.Retrieve
local IsRetrieved = private.IsRetrieved
while queue:hasValues() do
if yieldThreshold <= 0 then
break
end
local item = queue:pop()
if not IsItem(item) then
local id, suffix = InterpretItem(item)
if not self:Check(id, suffix) then
yieldThreshold = yieldThreshold - 1
end
item = ItemCache:Item(id, suffix)
end
if IsRetrieved(item) then
self:RunLoadCallbacks(item)
else
Retrieve(item)
if IsRetrieved(item) then
self:RunLoadCallbacks(item)
else
yieldThreshold = yieldThreshold - 1
if item:Exists() then
queue:add(item)
end
end
end
end
if not queue:hasValues() then
tblremove(self.queryCallbacks, i)
end
end
end
end)
end
function ItemDB:RegisterEvents(frame)
for _, event in ipairs(frame.events or {}) do
frame:RegisterEvent(event)
end
end
function ItemDB:UnregisterEvents(frame)
for _, event in ipairs(frame.events or {}) do
frame:UnregisterEvent(event)
end
end
function ItemDB:InitItemInfoListener()
self.ItemInfoListenerFrame = CreateFrame("Frame", nil, UIItem)
self.ItemInfoListenerFrame:SetPoint("TOPLEFT", UIItem, "TOPLEFT", 0, 0)
self.ItemInfoListenerFrame:SetSize(0, 0)
self.ItemInfoListenerFrame:Show()
self.ItemInfoListenerFrame.events = {"GET_ITEM_INFO_RECEIVED", "ITEM_DATA_LOAD_RESULT"}
self:RegisterEvents(self.ItemInfoListenerFrame)
self.ItemInfoListenerFrame:SetScript("OnEvent", function(_, event, id, success)
self:Get(id)
for suffix in pairs(self.cache[id]) do
local item = self:Get(id, suffix)
if not item:IsCached() then
if success then
item:Cache()
else
private(item).dne = true
ItemDB:Store(item)
if not self.loadAttempts[id] then
self.loadAttempts[id] = 0
end
self.loadAttempts[id] = self.loadAttempts[id] + 1
if self.loadAttempts[id] >= self.MAX_LOAD_ATTEMPTS then
private(item).dne = true
else
item:Load()
end
end
end
end
end)
end
function ItemDB:InitChatListener()
self.ChatListenerFrame = CreateFrame("Frame", nil, UIItem)
self.ChatListenerFrame:SetPoint("TOPLEFT", UIItem, "TOPLEFT", 0, 0)
self.ChatListenerFrame:SetSize(0, 0)
self.ChatListenerFrame:Show()
self.ChatListenerFrame.events = {"CHAT_MSG_CHANNEL", "CHAT_MSG_ADDON", "CHAT_MSG_BN_WHISPER",
"CHAT_MSG_EMOTE", "CHAT_MSG_GUILD", "CHAT_MSG_LOOT",
"CHAT_MSG_OFFICER", "CHAT_MSG_OPENING", "CHAT_MSG_PARTY",
"CHAT_MSG_PARTY_LEADER", "CHAT_MSG_RAID", "CHAT_MSG_RAID_LEADER",
"CHAT_MSG_RAID_WARNING", "CHAT_MSG_SAY", "CHAT_MSG_TEXT_EMOTE",
"CHAT_MSG_TRADESKILLS", "CHAT_MSG_WHISPER", "CHAT_MSG_YELL"}
self:RegisterEvents(self.ChatListenerFrame)
self.ChatListenerFrame:SetScript("OnEvent", function(_, event, message)
for itemString in strgmatch(message, "item[%-?%d:]+") do
local id, suffix = InterpretItem(itemString)
if id then
local item = self:Get(id, suffix)
if item:Exists() then
item:Cache()
end
end
end
end)
end
function ItemDB:InitMouseoverHook()
self.mouseoverHook = true
GameTooltip:HookScript("OnTooltipSetItem", function(tooltip)
if not self.mouseoverHook then return end
local name, link = tooltip:GetItem()
if not link then return end
local itemString = strmatch(link, "item[%-?%d:]+")
local id, suffix = InterpretItem(itemString)
if id and id ~= 0 then
local item = self:Get(id, suffix)
if item:Exists() then
item:Cache()
end
elseif TradeSkillFrame and TradeSkillFrame:IsVisible() then
if GetMouseFocus():GetName() == "TradeSkillSkillIcon" then
local id, suffix = InterpretItem(GetTradeSkillItemLink(TradeSkillFrame.selectedSkill))
if id then
local item = self:Get(id, suffix)
if item:Exists() then
item:Cache()
end
end
else
for i = 1, 8 do
if GetMouseFocus():GetName() == "TradeSkillReagent"..i then
local id, suffix = InterpretItem(GetTradeSkillReagentItemLink(TradeSkillFrame.selectedSkill, i))
if id then
local item = self:Get(id, suffix)
if item:Exists() then
item:Cache()
end
end
break
end
end
end
end
end)
end
function ItemDB:InitGetItemInfoHook()
self.GetItemInfoHook = true
hooksecurefunc("GetItemInfo", function(...)
if not self.GetItemInfoHook then return end
local id, suffix = InterpretItem(...)
if id then
local item = self:Get(id, suffix)
if item then
item:Cache()
end
end
end)
end
function ItemDB:Destructor()
self.QueryFrame:Hide()
self:UnregisterEvents(self.ItemInfoListenerFrame)
self:UnregisterEvents(self.ChatListenerFrame)
self.GetItemInfoHook = false
self.tooltipHook = false
self.mouseoverHook = false
wipe(self.cache)
wipe(self.loadCallbacks)
wipe(self.queryCallbacks)
end
function ItemDB:Init()
if self.initialized then return end
local version, build = GetBuildInfo()
if not ItemCacheStorage then
ItemCacheStorage = {}
end
local db = ItemCacheStorage
if not db._BUILD or db._BUILD < build then
wipe(db)
db._BUILD = build
end
if IsStandalone and not Addon:GetGlobalOption"UsePersistentStorage" then
ItemCacheStorage = nil
end
local locale = GetLocale()
if not db[locale] then
db[locale] = {}
end
storage = db[locale]
self.cache = {}
self.loadCallbacks = {}
self.queryCallbacks = {}
self.loadAttempts = {}
self.MAX_LOAD_ATTEMPTS = 10
self:InitTooltipScanner()
self:InitQueryCallbacks()
self:InitItemInfoListener()
self:InitChatListener()
self:InitGetItemInfoHook()
self:InitMouseoverHook()
self.initialized = true
-- Bring all stored items into cache
for id, items in pairs(storage) do
if type(id) == "number" then
for suffix, item in pairs(items) do
self:Get(id, suffix)
end
end
end
-- Shut down if a newer version is found
local timer
timer = C_Timer.NewTicker(1, function()
local _, minor = LibStub:GetLibrary(ADDON_NAME)
if minor ~= MINOR then
timer:Cancel()
self:Destructor()
end
end)
end
local function Items_OnCacheOrLoad(items, self, retrieveMode, func, ...)
local itemsToLoad = {}
local IsRetrieved = retrieveModes[retrieveMode].IsRetrieved
for _, item in pairs(items) do
local id, suffix = InterpretItem(item)
assert(id, format("Bad Item format: %s", item and tostring(item) or "nil"))
local loadItem = true
if not ItemCache:DoesItemExistByID(id) then
loadItem = false
end
if loadItem and ItemDB:Check(id, suffix) then
item = ItemDB:Get(id, suffix)
if IsRetrieved(item) then
loadItem = false
end
end
if loadItem then
if not itemsToLoad[id] then
itemsToLoad[id] = {}
end
itemsToLoad[id][suffix or 0] = ItemDB:Check(id, suffix) and ItemDB:Get(id, suffix) or item
end
end
if next(itemsToLoad) then
local callbackController
if self then
callbackController = CallbackController(itemsToLoad, retrieveMode, func, self, ...)
else
callbackController = CallbackController(itemsToLoad, retrieveMode)
end
ItemDB:RegisterCallbackController(callbackController)
return callbackController
else
if self then
func(self, ...)
return CallbackController({}, retrieveMode, func, self, ...)
else
return CallbackController({}, retrieveMode)
end
end
end
function ItemCache:OnCache(items, ...)
return Items_OnCacheOrLoad(items, items, "cache", ...)
end
function ItemCache:OnLoad(items, ...)
return Items_OnCacheOrLoad(items, items, "load", ...)
end
function ItemCache:Cache(items)
return Items_OnCacheOrLoad(items, nil, "cache")
end
function ItemCache:Load(items)
return Items_OnCacheOrLoad(items, nil, "load")
end
function Item:OnCache(...)
return Items_OnCacheOrLoad({self}, self, "cache", ...)
end
function Item:OnLoad(...)
return Items_OnCacheOrLoad({self}, self, "load", ...)
end
function Item:GetID()
return private(self).id
end
Item.GetId = Item.GetID
function Item:GetSuffix()
return private(self).suffix
end
function Item:HasSuffix()
return private(self).suffix ~= nil
end
function Item:GetIDSuffix()
return self:GetID(), self:GetSuffix()
end
Item.GetIdSuffix = Item.GetIDSuffix
function Item:GetString()
return format("item:%d::::::%d:::::::::::", self:GetID(), self:GetSuffix() or "")
end
function Item:Exists()
return ItemCache:DoesItemExistByID(self:GetID())
end
function Item:IsLoaded()
return private(private(self)):IsItemDataCached()
end
function Item:Load()
C_Item.RequestLoadItemDataByID(self:GetID())
end
function Item:IsCached()
return private(self).info ~= nil
end
function Item:Cache()
if not self:IsCached() then
self:GetInfo()
end
return self
end
function Item:GetInfo()
if self:Exists() then