Dalamud/Dalamud/Game/Network/Internal/NetworkHandlers.cs
2025-08-04 21:11:06 -07:00

653 lines
25 KiB
C#

using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reactive.Concurrency;
using System.Reactive.Linq;
using System.Threading.Tasks;
using Dalamud.Configuration.Internal;
using Dalamud.Data;
using Dalamud.Game.Gui;
using Dalamud.Game.Network.Internal.MarketBoardUploaders;
using Dalamud.Game.Network.Internal.MarketBoardUploaders.Universalis;
using Dalamud.Game.Network.Structures;
using Dalamud.Game.Text.SeStringHandling;
using Dalamud.Hooking;
using Dalamud.Networking.Http;
using Dalamud.Utility;
using FFXIVClientStructs.FFXIV.Client.Game.Control;
using FFXIVClientStructs.FFXIV.Client.Game.InstanceContent;
using FFXIVClientStructs.FFXIV.Client.Game.UI;
using FFXIVClientStructs.FFXIV.Client.Network;
using FFXIVClientStructs.FFXIV.Client.UI.Agent;
using FFXIVClientStructs.FFXIV.Client.UI.Info;
using Lumina.Excel.Sheets;
using Serilog;
namespace Dalamud.Game.Network.Internal;
/// <summary>
/// This class handles network notifications and uploading market board data.
/// </summary>
[ServiceManager.EarlyLoadedService]
internal unsafe class NetworkHandlers : IInternalDisposableService
{
private readonly IMarketBoardUploader uploader;
private readonly IDisposable handleMarketBoardItemRequest;
private readonly IDisposable handleMarketTaxRates;
private readonly IDisposable handleMarketBoardPurchaseHandler;
private readonly NetworkHandlersAddressResolver addressResolver;
private readonly Hook<PublicContentDirector.Delegates.HandleEnterContentInfoPacket> cfPopHook;
private readonly Hook<PacketDispatcher.Delegates.HandleMarketBoardPurchasePacket> mbPurchaseHook;
private readonly Hook<InfoProxyItemSearch.Delegates.ProcessItemHistory> mbHistoryHook;
private readonly Hook<CustomTalkReceiveResponse> customTalkHook; // used for marketboard taxes
private readonly Hook<PacketDispatcher.Delegates.HandleMarketBoardItemRequestStartPacket> mbItemRequestStartHook;
private readonly Hook<InfoProxyItemSearch.Delegates.AddPage> mbOfferingsHook;
private readonly Hook<InfoProxyItemSearch.Delegates.SendPurchaseRequestPacket> mbSendPurchaseRequestHook;
[ServiceManager.ServiceDependency]
private readonly DalamudConfiguration configuration = Service<DalamudConfiguration>.Get();
private bool disposing;
[ServiceManager.ServiceConstructor]
private NetworkHandlers(
GameNetwork gameNetwork,
TargetSigScanner sigScanner,
HappyHttpClient happyHttpClient)
{
this.uploader = new UniversalisMarketBoardUploader(happyHttpClient);
this.addressResolver = new NetworkHandlersAddressResolver();
this.addressResolver.Setup(sigScanner);
this.CfPop = _ => { };
this.MbPurchaseObservable = Observable.Create<MarketBoardPurchase>(observer =>
{
this.MarketBoardPurchaseReceived += Observe;
return () => { this.MarketBoardPurchaseReceived -= Observe; };
void Observe(nint packetPtr)
{
observer.OnNext(MarketBoardPurchase.Read(packetPtr));
}
});
this.MbHistoryObservable = Observable.Create<MarketBoardHistory>(observer =>
{
this.MarketBoardHistoryReceived += Observe;
return () => { this.MarketBoardHistoryReceived -= Observe; };
void Observe(nint packetPtr)
{
observer.OnNext(MarketBoardHistory.Read(packetPtr));
}
});
this.MbTaxesObservable = Observable.Create<MarketTaxRates>(observer =>
{
this.MarketBoardTaxesReceived += Observe;
return () => { this.MarketBoardTaxesReceived -= Observe; };
void Observe(nint dataPtr)
{
// n.b. we precleared the packet information so we're sure that this is *just* tax rate info.
observer.OnNext(MarketTaxRates.ReadFromCustomTalk(dataPtr));
}
});
this.MbItemRequestObservable = Observable.Create<MarketBoardItemRequest>(observer =>
{
this.MarketBoardItemRequestStartReceived += Observe;
return () => this.MarketBoardItemRequestStartReceived -= Observe;
void Observe(nint dataPtr)
{
observer.OnNext(MarketBoardItemRequest.Read(dataPtr));
}
});
this.MbOfferingsObservable = Observable.Create<MarketBoardCurrentOfferings>(observer =>
{
this.MarketBoardOfferingsReceived += Observe;
return () => { this.MarketBoardOfferingsReceived -= Observe; };
void Observe(nint packetPtr)
{
observer.OnNext(MarketBoardCurrentOfferings.Read(packetPtr));
}
});
this.MbPurchaseSentObservable = Observable.Create<MarketBoardPurchaseHandler>(observer =>
{
this.MarketBoardPurchaseRequestSent += Observe;
return () => { this.MarketBoardPurchaseRequestSent -= Observe; };
void Observe(nint dataPtr)
{
// fortunately, this dataptr has the same structure as the sent packet.
observer.OnNext(MarketBoardPurchaseHandler.Read(dataPtr));
}
});
this.handleMarketBoardItemRequest = this.HandleMarketBoardItemRequest();
this.handleMarketTaxRates = this.HandleMarketTaxRates();
this.handleMarketBoardPurchaseHandler = this.HandleMarketBoardPurchaseHandler();
this.mbPurchaseHook =
Hook<PacketDispatcher.Delegates.HandleMarketBoardPurchasePacket>.FromAddress(
PacketDispatcher.Addresses.HandleMarketBoardPurchasePacket.Value,
this.MarketPurchasePacketDetour);
this.mbPurchaseHook.Enable();
this.mbHistoryHook =
Hook<InfoProxyItemSearch.Delegates.ProcessItemHistory>.FromAddress(
InfoProxyItemSearch.Addresses.ProcessItemHistory.Value,
this.MarketHistoryPacketDetour);
this.mbHistoryHook.Enable();
this.customTalkHook =
Hook<CustomTalkReceiveResponse>.FromAddress(
this.addressResolver.CustomTalkEventResponsePacketHandler,
this.CustomTalkReceiveResponseDetour);
this.customTalkHook.Enable();
this.mbItemRequestStartHook = Hook<PacketDispatcher.Delegates.HandleMarketBoardItemRequestStartPacket>.FromAddress(
PacketDispatcher.Addresses.HandleMarketBoardItemRequestStartPacket.Value,
this.MarketItemRequestStartDetour);
this.mbItemRequestStartHook.Enable();
this.mbOfferingsHook = Hook<InfoProxyItemSearch.Delegates.AddPage>.FromAddress(
(nint)InfoProxyItemSearch.StaticVirtualTablePointer->AddPage,
this.MarketBoardOfferingsDetour);
this.mbOfferingsHook.Enable();
this.mbSendPurchaseRequestHook = Hook<InfoProxyItemSearch.Delegates.SendPurchaseRequestPacket>.FromAddress(
InfoProxyItemSearch.Addresses.SendPurchaseRequestPacket.Value,
this.MarketBoardSendPurchaseRequestDetour);
this.mbSendPurchaseRequestHook.Enable();
this.cfPopHook = Hook<PublicContentDirector.Delegates.HandleEnterContentInfoPacket>.FromAddress(PublicContentDirector.Addresses.HandleEnterContentInfoPacket.Value, this.CfPopDetour);
this.cfPopHook.Enable();
}
private delegate nint MarketBoardPurchasePacketHandler(nint a1, nint packetRef);
private delegate nint MarketBoardHistoryPacketHandler(nint self, nint packetData, uint a3, char a4);
private delegate void CustomTalkReceiveResponse(
nuint a1, ushort eventId, byte responseId, uint* args, byte argCount);
private delegate nint MarketBoardItemRequestStartPacketHandler(nint a1, nint packetRef);
private delegate byte InfoProxyItemSearchAddPage(nint self, nint packetRef);
private delegate byte MarketBoardSendPurchaseRequestPacket(InfoProxyItemSearch* infoProxy);
/// <summary>
/// Event which gets fired when a duty is ready.
/// </summary>
public event Action<ContentFinderCondition> CfPop;
private event Action<nint>? MarketBoardPurchaseReceived;
private event Action<nint>? MarketBoardHistoryReceived;
private event Action<nint>? MarketBoardTaxesReceived;
private event Action<nint>? MarketBoardItemRequestStartReceived;
private event Action<nint>? MarketBoardOfferingsReceived;
private event Action<nint>? MarketBoardPurchaseRequestSent;
/// <summary>
/// Gets an observable to track marketboard purchase events.
/// </summary>
public IObservable<MarketBoardPurchase> MbPurchaseObservable { get; }
/// <summary>
/// Gets an observable to track marketboard history events.
/// </summary>
public IObservable<MarketBoardHistory> MbHistoryObservable { get; }
/// <summary>
/// Gets an observable to track marketboard tax events.
/// </summary>
public IObservable<MarketTaxRates> MbTaxesObservable { get; }
/// <summary>
/// Gets an observable to track marketboard item request events.
/// </summary>
public IObservable<MarketBoardItemRequest> MbItemRequestObservable { get; }
/// <summary>
/// Gets an observable to track marketboard offerings events.
/// </summary>
public IObservable<MarketBoardCurrentOfferings> MbOfferingsObservable { get; }
/// <summary>
/// Gets an observable to track marketboard purchase request events.
/// </summary>
public IObservable<MarketBoardPurchaseHandler> MbPurchaseSentObservable { get; }
/// <summary>
/// Disposes of managed and unmanaged resources.
/// </summary>
void IInternalDisposableService.DisposeService()
{
this.disposing = true;
this.Dispose(this.disposing);
}
/// <summary>
/// Disposes of managed and unmanaged resources.
/// </summary>
/// <param name="shouldDispose">Whether to execute the disposal.</param>
protected void Dispose(bool shouldDispose)
{
if (!shouldDispose)
return;
this.handleMarketBoardItemRequest.Dispose();
this.handleMarketTaxRates.Dispose();
this.handleMarketBoardPurchaseHandler.Dispose();
this.mbPurchaseHook.Dispose();
this.mbHistoryHook.Dispose();
this.customTalkHook.Dispose();
this.mbItemRequestStartHook.Dispose();
this.mbOfferingsHook.Dispose();
this.mbSendPurchaseRequestHook.Dispose();
this.cfPopHook.Dispose();
}
private static (ulong UploaderId, uint WorldId) GetUploaderInfo()
{
var agentLobby = AgentLobby.Instance();
var uploaderId = agentLobby->LobbyData.ContentId;
if (uploaderId == 0)
{
var playerState = PlayerState.Instance();
if (playerState->IsLoaded)
{
uploaderId = playerState->ContentId;
}
}
var worldId = agentLobby->LobbyData.CurrentWorldId;
if (worldId == 0)
{
var localPlayer = Control.GetLocalPlayer();
if (localPlayer != null)
{
worldId = localPlayer->CurrentWorld;
}
}
return (uploaderId, worldId);
}
private unsafe nint CfPopDetour(PublicContentDirector.EnterContentInfoPacket* packetData)
{
var result = this.cfPopHook.OriginalDisposeSafe(packetData);
try
{
using var stream = new UnmanagedMemoryStream((byte*)packetData, 64);
using var reader = new BinaryReader(stream);
var notifyType = reader.ReadByte();
stream.Position += 0x1B;
var conditionId = reader.ReadUInt16();
if (notifyType != 3)
return result;
if (this.configuration.DutyFinderTaskbarFlash)
Util.FlashWindow();
var cfCondition = LuminaUtils.CreateRef<ContentFinderCondition>(conditionId);
if (!cfCondition.IsValid)
{
Log.Error("CFC key {ConditionId} not in Lumina data", conditionId);
return result;
}
var cfcName = cfCondition.Value.Name.ToDalamudString();
if (cfcName.Payloads.Count == 0)
cfcName = "Duty Roulette";
Task.Run(() =>
{
if (this.configuration.DutyFinderChatMessage)
{
var b = new SeStringBuilder();
b.Append("Duty pop: ");
b.Append(cfcName);
Service<ChatGui>.GetNullable()?.Print(b.Build());
}
this.CfPop.InvokeSafely(cfCondition.Value);
}).ContinueWith(
task => Log.Error(task.Exception, "CfPop.Invoke failed"),
TaskContinuationOptions.OnlyOnFaulted);
}
catch (Exception ex)
{
Log.Error(ex, "CfPopDetour threw an exception");
}
return result;
}
private IObservable<List<MarketBoardCurrentOfferings.MarketBoardItemListing>> OnMarketBoardListingsBatch(
IObservable<MarketBoardItemRequest> start)
{
var offeringsObservable = this.MbOfferingsObservable.Publish().RefCount();
void LogEndObserved(MarketBoardCurrentOfferings offerings)
{
Log.Verbose(
"Observed end of request {RequestId}",
offerings.RequestId);
}
void LogOfferingsObserved(MarketBoardCurrentOfferings offerings)
{
Log.Verbose(
"Observed element of request {RequestId} with {NumListings} listings",
offerings.RequestId,
offerings.InternalItemListings.Count);
}
IObservable<MarketBoardCurrentOfferings> UntilBatchEnd(MarketBoardItemRequest request)
{
var totalPackets = Convert.ToInt32(Math.Ceiling((double)request.AmountToArrive / 10));
if (totalPackets == 0)
{
return Observable.Empty<MarketBoardCurrentOfferings>();
}
return offeringsObservable
.Where(offerings => offerings.InternalItemListings.All(l => l.CatalogId != 0))
.Skip(totalPackets - 1)
.Do(LogEndObserved);
}
// When a start packet is observed, begin observing a window of listings packets
// according to the count described by the start packet. Aggregate the listings
// packets, and then flatten them to the listings themselves.
return offeringsObservable
.Do(LogOfferingsObserved)
.Window(start, UntilBatchEnd)
.SelectMany(
o => o.Aggregate(
new List<MarketBoardCurrentOfferings.MarketBoardItemListing>(),
(agg, next) =>
{
agg.AddRange(next.InternalItemListings);
return agg;
}));
}
private IObservable<(uint CatalogId, List<MarketBoardHistory.MarketBoardHistoryListing> Sales)> OnMarketBoardSalesBatch(
IObservable<MarketBoardItemRequest> start)
{
var historyObservable = this.MbHistoryObservable.Publish().RefCount();
void LogHistoryObserved(MarketBoardHistory history)
{
Log.Verbose(
"Observed history for item {CatalogId} with {NumSales} sales",
history.CatalogId,
history.InternalHistoryListings.Count);
}
IObservable<MarketBoardHistory> UntilBatchEnd(MarketBoardItemRequest request)
{
return historyObservable
.Where(history => history.CatalogId != 0)
.Take(1);
}
// When a start packet is observed, begin observing a window of history packets.
// We should only get one packet, which the window closing function ensures.
// This packet is flattened to its sale entries and emitted.
uint catalogId = 0;
return historyObservable
.Do(LogHistoryObserved)
.Window(start, UntilBatchEnd)
.SelectMany(
o => o.Aggregate(
new List<MarketBoardHistory.MarketBoardHistoryListing>(),
(agg, next) =>
{
catalogId = next.CatalogId;
agg.AddRange(next.InternalHistoryListings);
return agg;
}))
.Select(o => (catalogId, o));
}
private IDisposable HandleMarketBoardItemRequest()
{
void LogStartObserved(MarketBoardItemRequest request)
{
Log.Verbose("Observed start of request for item with {NumListings} expected listings", request.AmountToArrive);
}
var startObservable = this.MbItemRequestObservable
.Where(request => request.Ok)
.Do(LogStartObserved)
.Publish()
.RefCount();
return Observable.When(
startObservable
.And(this.OnMarketBoardSalesBatch(startObservable))
.And(this.OnMarketBoardListingsBatch(startObservable))
.Then((request, sales, listings) => (request, sales, listings, GetUploaderInfo())))
.Where(this.ShouldUpload)
.SubscribeOn(ThreadPoolScheduler.Instance)
.Subscribe(
data =>
{
var (request, sales, listings, uploaderInfo) = data;
this.UploadMarketBoardData(request, sales, listings, uploaderInfo.UploaderId, uploaderInfo.WorldId);
},
ex => Log.Error(ex, "Failed to handle Market Board item request event"));
}
private void UploadMarketBoardData(
MarketBoardItemRequest request,
(uint CatalogId, ICollection<MarketBoardHistory.MarketBoardHistoryListing> Sales) sales,
ICollection<MarketBoardCurrentOfferings.MarketBoardItemListing> listings,
ulong uploaderId,
uint worldId)
{
var catalogId = sales.CatalogId;
if (listings.Count != request.AmountToArrive)
{
Log.Error(
"Wrong number of Market Board listings received for request: {ListingsCount} != {RequestAmountToArrive} item#{RequestCatalogId}",
listings.Count, request.AmountToArrive, catalogId);
return;
}
Log.Verbose(
"Market Board request resolved, starting upload: item#{CatalogId} listings#{ListingsObserved} sales#{SalesObserved}",
catalogId,
listings.Count,
sales.Sales.Count);
request.CatalogId = catalogId;
request.Listings.AddRange(listings);
request.History.AddRange(sales.Sales);
Task.Run(() => this.uploader.Upload(request, uploaderId, worldId))
.ContinueWith(
task => Log.Error(task.Exception, "Market Board offerings data upload failed"),
TaskContinuationOptions.OnlyOnFaulted);
}
private IDisposable HandleMarketTaxRates()
{
return this.MbTaxesObservable
.Select((taxes) => (taxes, GetUploaderInfo()))
.Where(this.ShouldUpload)
.SubscribeOn(ThreadPoolScheduler.Instance)
.Subscribe(
data =>
{
var (taxes, uploaderInfo) = data;
Log.Verbose(
"MarketTaxRates: limsa#{0} grid#{1} uldah#{2} ish#{3} kugane#{4} cr#{5} sh#{6}",
taxes.LimsaLominsaTax,
taxes.GridaniaTax,
taxes.UldahTax,
taxes.IshgardTax,
taxes.KuganeTax,
taxes.CrystariumTax,
taxes.SharlayanTax);
Task.Run(() => this.uploader.UploadTax(taxes, uploaderInfo.UploaderId, uploaderInfo.WorldId))
.ContinueWith(
task => Log.Error(task.Exception, "Market Board tax data upload failed"),
TaskContinuationOptions.OnlyOnFaulted);
},
ex => Log.Error(ex, "Failed to handle Market Board tax data event"));
}
private IDisposable HandleMarketBoardPurchaseHandler()
{
return this.MbPurchaseSentObservable
.Zip(this.MbPurchaseObservable, (handler, purchase) => (handler, purchase, GetUploaderInfo()))
.Where(this.ShouldUpload)
.SubscribeOn(ThreadPoolScheduler.Instance)
.Subscribe(
data =>
{
var (handler, purchase, uploaderInfo) = data;
var sameQty = purchase.ItemQuantity == handler.ItemQuantity;
var itemMatch = purchase.CatalogId == handler.CatalogId;
var itemMatchHq = purchase.CatalogId == handler.CatalogId + 1_000_000;
// Transaction succeeded
if (sameQty && (itemMatch || itemMatchHq))
{
Log.Verbose(
"Bought {PurchaseItemQuantity}x {HandlerCatalogId} for {HandlerPricePerUnit} gils, listing id is {HandlerListingId}",
purchase.ItemQuantity,
handler.CatalogId,
handler.PricePerUnit * purchase.ItemQuantity,
handler.ListingId);
Task.Run(() => this.uploader.UploadPurchase(handler, uploaderInfo.UploaderId, uploaderInfo.WorldId))
.ContinueWith(
task => Log.Error(task.Exception, "Market Board purchase data upload failed"),
TaskContinuationOptions.OnlyOnFaulted);
}
},
ex => Log.Error(ex, "Failed to handle Market Board purchase event"));
}
private bool ShouldUpload<T>(T any)
{
return this.configuration.IsMbCollect;
}
private void MarketPurchasePacketDetour(uint targetId, nint packetData)
{
try
{
this.MarketBoardPurchaseReceived?.InvokeSafely(packetData);
}
catch (Exception ex)
{
Log.Error(ex, "MarketPurchasePacketHandler threw an exception");
}
this.mbPurchaseHook.OriginalDisposeSafe(targetId, packetData);
}
private void MarketHistoryPacketDetour(InfoProxyItemSearch* a1, nint packetData)
{
try
{
this.MarketBoardHistoryReceived?.InvokeSafely(packetData);
}
catch (Exception ex)
{
Log.Error(ex, "MarketHistoryPacketDetour threw an exception");
}
this.mbHistoryHook.OriginalDisposeSafe(a1, packetData);
}
private void CustomTalkReceiveResponseDetour(nuint a1, ushort eventId, byte responseId, uint* args, byte argCount)
{
try
{
// Event ID 0 covers the crystarium, 7 covers all other cities
if (eventId is 7 or 0 && responseId == 8)
this.MarketBoardTaxesReceived?.InvokeSafely((nint)args);
}
catch (Exception ex)
{
Log.Error(ex, "CustomTalkReceiveResponseDetour threw an exception");
}
this.customTalkHook.OriginalDisposeSafe(a1, eventId, responseId, args, argCount);
}
private void MarketItemRequestStartDetour(uint targetId, nint packetRef)
{
try
{
this.MarketBoardItemRequestStartReceived?.InvokeSafely(packetRef);
}
catch (Exception ex)
{
Log.Error(ex, "MarketItemRequestStartDetour threw an exception");
}
this.mbItemRequestStartHook.OriginalDisposeSafe(targetId, packetRef);
}
private void MarketBoardOfferingsDetour(InfoProxyItemSearch* a1, nint packetRef)
{
try
{
this.MarketBoardOfferingsReceived?.InvokeSafely(packetRef);
}
catch (Exception ex)
{
Log.Error(ex, "MarketBoardOfferingsDetour threw an exception");
}
this.mbOfferingsHook.OriginalDisposeSafe(a1, packetRef);
}
private bool MarketBoardSendPurchaseRequestDetour(InfoProxyItemSearch* infoProxyItemSearch)
{
try
{
this.MarketBoardPurchaseRequestSent?.InvokeSafely((nint)infoProxyItemSearch + 0x5680);
}
catch (Exception ex)
{
Log.Error(ex, "MarketBoardSendPurchaseRequestDetour threw an exception");
}
return this.mbSendPurchaseRequestHook.OriginalDisposeSafe(infoProxyItemSearch);
}
}