t0w0bi/ClubPenguinClient
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rework character disposal

Browse Source
This commit is contained in:
rootdarkarchon
2023-04-29 17:48:05 +02:00
parent 996f784c2b
commit de2cd97dbe
11 changed files with 188 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

144
MareSynchronos/PlayerData/Pairs/CachedPlayer.cs
View File

@@ -5,6 +5,7 @@ using MareSynchronos.API.Data;
using MareSynchronos.API.Dto.User;
using MareSynchronos.FileCache;
using MareSynchronos.Interop;
using MareSynchronos.MareConfiguration;
using MareSynchronos.PlayerData.Handlers;
using MareSynchronos.Services;
using MareSynchronos.Services.Mediator;
@@ -26,20 +27,21 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
private readonly Func<ObjectKind, Func<nint>, bool, GameObjectHandler> _gameObjectHandlerFactory;
private readonly IpcManager _ipcManager;
private readonly IHostApplicationLifetime _lifetime;
private readonly OptionalPluginWarning _pluginWarnings;
private CancellationTokenSource? _applicationCancellationTokenSource = new();
private Guid _applicationId;
private Task? _applicationTask;
private CharacterData _cachedData = new();
private GameObjectHandler? _charaHandler;
private CancellationTokenSource? _downloadCancellationTokenSource = new();
private int _framesSinceNotVisible = 0;
private string _lastGlamourerData = string.Empty;
private string _originalGlamourerData = string.Empty;
private CancellationTokenSource _redrawCts = new();
public CachedPlayer(ILogger<CachedPlayer> logger, OnlineUserIdentDto onlineUser,
Func<ObjectKind, Func<nint>, bool, GameObjectHandler> gameObjectHandlerFactory,
IpcManager ipcManager, FileDownloadManager transferManager,
Func<ObjectKind, Func<nint>, bool, GameObjectHandler> gameObjectHandlerFactory,
IpcManager ipcManager, FileDownloadManager transferManager, MareConfigService mareConfigService,
DalamudUtilService dalamudUtil, IHostApplicationLifetime lifetime, FileCacheManager fileDbManager, MareMediator mediator) : base(logger, mediator)
{
OnlineUser = onlineUser;
@@ -49,6 +51,14 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
_dalamudUtil = dalamudUtil;
_lifetime = lifetime;
_fileDbManager = fileDbManager;
Mediator.Subscribe<FrameworkUpdateMessage>(this, (_) => FrameworkUpdate());
_pluginWarnings ??= new()
{
ShownCustomizePlusWarning = mareConfigService.Current.DisableOptionalPluginWarnings,
ShownHeelsWarning = mareConfigService.Current.DisableOptionalPluginWarnings,
ShownPalettePlusWarning = mareConfigService.Current.DisableOptionalPluginWarnings,
ShownHonorificWarning = mareConfigService.Current.DisableOptionalPluginWarnings,
};
}
private enum PlayerChanges
@@ -56,28 +66,34 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
Heels = 1,
Customize = 2,
Palette = 3,
Mods = 4,
Honorific = 5,
Honorific = 4,
Mods = 5,
}
public bool IsVisible { get; private set; }
public OnlineUserIdentDto OnlineUser { get; private set; }
public IntPtr PlayerCharacter => _charaHandler?.Address ?? IntPtr.Zero;
public unsafe uint PlayerCharacterId => (_charaHandler?.Address ?? IntPtr.Zero) == IntPtr.Zero
? uint.MaxValue
: ((GameObject*)_charaHandler.Address)->ObjectID;
: ((GameObject*)_charaHandler!.Address)->ObjectID;
public string? PlayerName { get; private set; }
public string PlayerNameHash => OnlineUser.Ident;
private OnlineUserIdentDto OnlineUser { get; set; }
public uint? PlayerWorld { get; private set; }
public void ApplyCharacterData(CharacterData characterData, OptionalPluginWarning warning, bool forced = false)
public void ApplyCharacterData(CharacterData characterData, bool forced = false)
{
if (_charaHandler == null)
{
_cachedData = characterData;
return;
}
SetUploading(false);
Logger.LogDebug("Received data for {player}", this);
Logger.LogDebug("Hash for data is {newHash}, current cache hash is {oldHash}", characterData.DataHash.Value, _cachedData.DataHash.Value);
Logger.LogDebug("Checking for files to download for player {name}", this);
Logger.LogDebug("Hash for data is {newHash}, current cache hash is {oldHash}", characterData.DataHash.Value, _cachedData.DataHash.Value);
if (!_ipcManager.CheckPenumbraApi()) return;
if (!_ipcManager.CheckGlamourerApi()) return;
@@ -94,7 +110,7 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
if (charaDataToUpdate.TryGetValue(ObjectKind.Player, out var playerChanges))
{
NotifyForMissingPlugins(playerChanges, warning);
NotifyForMissingPlugins(playerChanges);
}
Logger.LogDebug("Downloading and applying character for {name}", this);
@@ -116,28 +132,6 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
return true;
}
public async Task Initialize(string name)
{
PlayerName = name;
_charaHandler = _gameObjectHandlerFactory(ObjectKind.Player, () => _dalamudUtil.GetPlayerCharacterFromObjectTableByName(PlayerName), false);
_originalGlamourerData = await _ipcManager.GlamourerGetCharacterCustomization(PlayerCharacter).ConfigureAwait(false);
_lastGlamourerData = _originalGlamourerData;
Mediator.Subscribe<PenumbraRedrawMessage>(this, IpcManagerOnPenumbraRedrawEvent);
Mediator.Subscribe<CharacterChangedMessage>(this, async (msg) =>
{
if (msg.GameObjectHandler == _charaHandler && (_applicationTask?.IsCompleted ?? true))
{
Logger.LogTrace("Saving new Glamourer Data for {this}", this);
_lastGlamourerData = await _ipcManager.GlamourerGetCharacterCustomization(PlayerCharacter).ConfigureAwait(false);
}
});
_downloadManager.Initialize();
Logger.LogDebug("Initializing Player {obj}", this);
}
public override string ToString()
{
return OnlineUser == null
@@ -163,6 +157,7 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
SetUploading(false);
_downloadManager.Dispose();
var name = PlayerName;
var world = PlayerWorld;
Logger.LogDebug("Disposing {name} ({user})", name, OnlineUser);
try
{
@@ -185,7 +180,7 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
{
try
{
RevertCustomizationData(item.Key, name, applicationId).GetAwaiter().GetResult();
RevertCustomizationData(item.Key, name, world ?? 0, applicationId).GetAwaiter().GetResult();
}
catch (InvalidOperationException ex)
{
@@ -414,7 +409,7 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
Logger.LogDebug("Downloading missing files for player {name}, {kind}", PlayerName, updatedData);
if (toDownloadReplacements.Any())
{
await _downloadManager.DownloadFiles(_charaHandler, toDownloadReplacements, downloadToken).ConfigureAwait(false);
await _downloadManager.DownloadFiles(_charaHandler!, toDownloadReplacements, downloadToken).ConfigureAwait(false);
_downloadManager.CancelDownload();
}
@@ -486,6 +481,61 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
}, downloadToken);
}
private void FrameworkUpdate()
{
if (string.IsNullOrEmpty(PlayerName))
{
var pc = _dalamudUtil.FindPlayerByNameHash(OnlineUser.Ident);
if (pc == null) return;
Logger.LogDebug("One-Time Initializing {this}", this);
Initialize(pc.Name.ToString(), pc.HomeWorld.Id);
Logger.LogDebug("One-Time Initialized {this}", this);
}
if (_charaHandler?.Address != IntPtr.Zero && !IsVisible)
{
IsVisible = true;
Mediator.Publish(new CachedPlayerVisibleMessage(this));
Logger.LogTrace("{this} visibility changed, now: {visi}", this, IsVisible);
_framesSinceNotVisible = 0;
_lastGlamourerData = _ipcManager.GlamourerGetCharacterCustomization(PlayerCharacter).GetAwaiter().GetResult();
if (_cachedData != null)
{
Task.Run(() => ApplyCharacterData(_cachedData, true));
}
}
else if (_charaHandler?.Address == IntPtr.Zero && IsVisible)
{
_framesSinceNotVisible++;
if (_framesSinceNotVisible > 30)
{
IsVisible = false;
Logger.LogTrace("{this} visibility changed, now: {visi}", this, IsVisible);
}
}
}
private void Initialize(string name, uint worldid)
{
PlayerName = name;
PlayerWorld = worldid;
_charaHandler = _gameObjectHandlerFactory(ObjectKind.Player, () => _dalamudUtil.GetPlayerCharacterFromObjectTableByName(PlayerName, worldid), false);
_originalGlamourerData = _ipcManager.GlamourerGetCharacterCustomization(PlayerCharacter).ConfigureAwait(false).GetAwaiter().GetResult();
_lastGlamourerData = _originalGlamourerData;
Mediator.Subscribe<PenumbraRedrawMessage>(this, IpcManagerOnPenumbraRedrawEvent);
Mediator.Subscribe<CharacterChangedMessage>(this, async (msg) =>
{
if (msg.GameObjectHandler == _charaHandler && (_applicationTask?.IsCompleted ?? true))
{
Logger.LogTrace("Saving new Glamourer Data for {this}", this);
_lastGlamourerData = await _ipcManager.GlamourerGetCharacterCustomization(PlayerCharacter).ConfigureAwait(false);
}
});
_downloadManager.Initialize();
}
private void IpcManagerOnPenumbraRedrawEvent(PenumbraRedrawMessage msg)
{
var player = _dalamudUtil.GetCharacterFromObjectTableByIndex(msg.ObjTblIdx);
@@ -505,30 +555,30 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
}, token);
}
private void NotifyForMissingPlugins(HashSet<PlayerChanges> changes, OptionalPluginWarning warning)
private void NotifyForMissingPlugins(HashSet<PlayerChanges> changes)
{
List<string> missingPluginsForData = new();
if (changes.Contains(PlayerChanges.Heels) && !warning.ShownHeelsWarning && !_ipcManager.CheckHeelsApi())
if (changes.Contains(PlayerChanges.Heels) && !_pluginWarnings.ShownHeelsWarning && !_ipcManager.CheckHeelsApi())
{
missingPluginsForData.Add("Heels");
warning.ShownHeelsWarning = true;
_pluginWarnings.ShownHeelsWarning = true;
}
if (changes.Contains(PlayerChanges.Customize) && !warning.ShownCustomizePlusWarning && !_ipcManager.CheckCustomizePlusApi())
if (changes.Contains(PlayerChanges.Customize) && !_pluginWarnings.ShownCustomizePlusWarning && !_ipcManager.CheckCustomizePlusApi())
{
missingPluginsForData.Add("Customize+");
warning.ShownCustomizePlusWarning = true;
_pluginWarnings.ShownCustomizePlusWarning = true;
}
if (changes.Contains(PlayerChanges.Palette) && !warning.ShownPalettePlusWarning && !_ipcManager.CheckPalettePlusApi())
if (changes.Contains(PlayerChanges.Palette) && !_pluginWarnings.ShownPalettePlusWarning && !_ipcManager.CheckPalettePlusApi())
{
missingPluginsForData.Add("Palette+");
warning.ShownPalettePlusWarning = true;
_pluginWarnings.ShownPalettePlusWarning = true;
}
if (changes.Contains(PlayerChanges.Honorific) && !warning.ShownHonorificWarning && !_ipcManager.CheckHonorificApi())
if (changes.Contains(PlayerChanges.Honorific) && !_pluginWarnings.ShownHonorificWarning && !_ipcManager.CheckHonorificApi())
{
missingPluginsForData.Add("Honorific");
warning.ShownHonorificWarning = true;
_pluginWarnings.ShownHonorificWarning = true;
}
if (missingPluginsForData.Any())
@@ -539,9 +589,9 @@ public sealed class CachedPlayer : DisposableMediatorSubscriberBase
}
}
private async Task RevertCustomizationData(ObjectKind objectKind, string name, Guid applicationId)
private async Task RevertCustomizationData(ObjectKind objectKind, string name, uint world, Guid applicationId)
{
nint address = _dalamudUtil.GetPlayerCharacterFromObjectTableByName(name);
nint address = _dalamudUtil.GetPlayerCharacterFromObjectTableByName(name, world);
if (address == IntPtr.Zero) return;
var cancelToken = new CancellationTokenSource();

17
MareSynchronos/PlayerData/Pairs/OnlinePlayerManager.cs
View File

@@ -13,6 +13,7 @@ public class OnlinePlayerManager : DisposableMediatorSubscriberBase
private readonly ApiController _apiController;
private readonly DalamudUtilService _dalamudUtil;
private readonly FileUploadManager _fileTransferManager;
private readonly HashSet<CachedPlayer> _newVisiblePlayers = new();
private readonly PairManager _pairManager;
private CharacterData? _lastSentData;
@@ -39,22 +40,18 @@ public class OnlinePlayerManager : DisposableMediatorSubscriberBase
Logger.LogDebug("Not sending data for {hash}", newData.DataHash.Value);
}
});
Mediator.Subscribe<CachedPlayerVisibleMessage>(this, (msg) => _newVisiblePlayers.Add(msg.Player));
}
private void FrameworkOnUpdate()
{
if (!_dalamudUtil.IsPlayerPresent || !_apiController.IsConnected) return;
var playerCharacters = _dalamudUtil.GetPlayerCharacters();
var chars = _pairManager.FindAllPairs(playerCharacters);
var newVisiblePlayers = (from pChar in chars.Where(p => p.Pair.InitializePair(p.Character.Name.ToString()))
select pChar.Pair.UserData).ToList();
if (newVisiblePlayers.Any())
{
Logger.LogTrace("Has new visible players, pushing character data");
PushCharacterData(newVisiblePlayers);
}
if (!_newVisiblePlayers.Any()) return;
var newVisiblePlayers = _newVisiblePlayers.ToList();
_newVisiblePlayers.Clear();
Logger.LogTrace("Has new visible players, pushing character data");
PushCharacterData(newVisiblePlayers.Select(c => c.OnlineUser.User).ToList());
}
private void PlayerManagerOnPlayerHasChanged()

99
MareSynchronos/PlayerData/Pairs/Pair.cs
View File

@@ -1,11 +1,9 @@
using Dalamud.ContextMenu;
using Dalamud.Utility;
using MareSynchronos.API.Data;
using MareSynchronos.API.Data.Comparer;
using MareSynchronos.API.Data.Extensions;
using MareSynchronos.API.Dto.Group;
using MareSynchronos.API.Dto.User;
using MareSynchronos.MareConfiguration;
using MareSynchronos.Services.Mediator;
using MareSynchronos.Services.ServerConfiguration;
using MareSynchronos.Utils;
@@ -16,20 +14,17 @@ namespace MareSynchronos.PlayerData.Pairs;
public class Pair
{
private readonly Func<OnlineUserIdentDto, CachedPlayer> _cachedPlayerFactory;
private readonly MareConfigService _configService;
private readonly ILogger<Pair> _logger;
private readonly MareMediator _mediator;
private readonly ServerConfigurationManager _serverConfigurationManager;
private OnlineUserIdentDto? _onlineUserIdentDto = null;
private OptionalPluginWarning? _pluginWarnings;
public Pair(ILogger<Pair> logger, Func<OnlineUserIdentDto, CachedPlayer> cachedPlayerFactory,
MareMediator mediator, MareConfigService configService, ServerConfigurationManager serverConfigurationManager)
MareMediator mediator, ServerConfigurationManager serverConfigurationManager)
{
_logger = logger;
_cachedPlayerFactory = cachedPlayerFactory;
_mediator = mediator;
_configService = configService;
_serverConfigurationManager = serverConfigurationManager;
}
@@ -41,7 +36,7 @@ public class Pair
public bool IsPaused => UserPair != null && UserPair.OtherPermissions.IsPaired() ? UserPair.OtherPermissions.IsPaused() || UserPair.OwnPermissions.IsPaused()
: GroupPair.All(p => p.Key.GroupUserPermissions.IsPaused() || p.Value.GroupUserPermissions.IsPaused());
public bool IsVisible => CachedPlayer?.PlayerName != null;
public bool IsVisible => CachedPlayer?.IsVisible ?? false;
public CharacterData? LastReceivedCharacterData { get; set; }
public string? PlayerName => CachedPlayer?.PlayerName ?? string.Empty;
@@ -79,8 +74,6 @@ public class Pair
{
if (CachedPlayer == null) throw new InvalidOperationException("CachedPlayer not initialized");
if (string.Equals(LastReceivedCharacterData?.DataHash.Value, data.CharaData.DataHash.Value, StringComparison.Ordinal)) return;
LastReceivedCharacterData = data.CharaData;
ApplyLastReceivedData();
@@ -91,71 +84,10 @@ public class Pair
if (CachedPlayer == null) return;
if (LastReceivedCharacterData == null) return;
_pluginWarnings ??= new()
{
ShownCustomizePlusWarning = _configService.Current.DisableOptionalPluginWarnings,
ShownHeelsWarning = _configService.Current.DisableOptionalPluginWarnings,
ShownPalettePlusWarning = _configService.Current.DisableOptionalPluginWarnings,
ShownHonorificWarning = _configService.Current.DisableOptionalPluginWarnings,
};
CachedPlayer.ApplyCharacterData(RemoveNotSyncedFiles(LastReceivedCharacterData.DeepClone())!, _pluginWarnings, forced);
CachedPlayer.ApplyCharacterData(RemoveNotSyncedFiles(LastReceivedCharacterData.DeepClone())!, forced);
}
public string? GetNote()
{
return _serverConfigurationManager.GetNoteForUid(UserData.UID);
}
public string GetPlayerNameHash()
{
try
{
return CachedPlayer?.PlayerNameHash ?? string.Empty;
}
catch (Exception ex)
{
_logger.LogWarning(ex, "Error accessing PlayerNameHash, recreating CachedPlayer");
RecreateCachedPlayer();
}
return string.Empty;
}
public bool HasAnyConnection()
{
return UserPair != null || GroupPair.Any();
}
public bool InitializePair(string name)
{
if (!PlayerName.IsNullOrEmpty()) return false;
if (CachedPlayer == null) throw new InvalidOperationException("CachedPlayer not initialized");
_pluginWarnings ??= new()
{
ShownCustomizePlusWarning = _configService.Current.DisableOptionalPluginWarnings,
ShownHeelsWarning = _configService.Current.DisableOptionalPluginWarnings,
ShownPalettePlusWarning = _configService.Current.DisableOptionalPluginWarnings,
ShownHonorificWarning = _configService.Current.DisableOptionalPluginWarnings,
};
CachedPlayer.Initialize(name).Wait();
ApplyLastReceivedData();
return true;
}
public void MarkOffline()
{
_onlineUserIdentDto = null;
LastReceivedCharacterData = null;
CachedPlayer?.Dispose();
CachedPlayer = null;
}
public void RecreateCachedPlayer(OnlineUserIdentDto? dto = null)
public void CreateCachedPlayer(OnlineUserIdentDto? dto = null)
{
if (dto == null && _onlineUserIdentDto == null)
{
@@ -172,6 +104,29 @@ public class Pair
CachedPlayer = _cachedPlayerFactory(_onlineUserIdentDto!);
}
public string? GetNote()
{
return _serverConfigurationManager.GetNoteForUid(UserData.UID);
}
public string GetPlayerNameHash()
{
return CachedPlayer?.PlayerNameHash ?? string.Empty;
}
public bool HasAnyConnection()
{
return UserPair != null || GroupPair.Any();
}
public void MarkOffline()
{
_onlineUserIdentDto = null;
LastReceivedCharacterData = null;
CachedPlayer?.Dispose();
CachedPlayer = null;
}
public void SetNote(string note)
{
_serverConfigurationManager.SetNoteForUid(UserData.UID, note);

36
MareSynchronos/PlayerData/Pairs/PairManager.cs
View File

@@ -1,7 +1,6 @@
using Dalamud.ContextMenu;
using Dalamud.Game.ClientState.Objects.SubKinds;
using Dalamud.Interface.Internal.Notifications;
using Dalamud.Utility;
using MareSynchronos.API.Data;
using MareSynchronos.API.Data.Comparer;
using MareSynchronos.API.Data.Extensions;
@@ -33,7 +32,6 @@ public sealed class PairManager : DisposableMediatorSubscriberBase
_pairFactory = pairFactory;
_configurationService = configurationService;
_dalamudContextMenu = dalamudContextMenu;
Mediator.Subscribe<ZoneSwitchStartMessage>(this, (_) => DalamudUtilOnZoneSwitched());
Mediator.Subscribe<DelayedFrameworkUpdateMessage>(this, (_) => DalamudUtilOnDelayedFrameworkUpdate());
Mediator.Subscribe<DisconnectedMessage>(this, (_) => ClearPairs());
Mediator.Subscribe<CutsceneEndMessage>(this, (_) => ReapplyPairData());
@@ -105,7 +103,7 @@ public sealed class PairManager : DisposableMediatorSubscriberBase
public List<Pair> GetOnlineUserPairs() => _allClientPairs.Where(p => !string.IsNullOrEmpty(p.Value.GetPlayerNameHash())).Select(p => p.Value).ToList();
public List<UserData> GetVisibleUsers() => _allClientPairs.Where(p => p.Value.HasCachedPlayer).Select(p => p.Key).ToList();
public List<UserData> GetVisibleUsers() => _allClientPairs.Where(p => p.Value.IsVisible).Select(p => p.Key).ToList();
public void MarkPairOffline(UserData user)
{
@@ -139,7 +137,7 @@ public sealed class PairManager : DisposableMediatorSubscriberBase
Mediator.Publish(new NotificationMessage("User online", msg, NotificationType.Info, 5000));
}
pair.RecreateCachedPlayer(dto);
pair.CreateCachedPlayer(dto);
RecreateLazy();
}
@@ -147,15 +145,7 @@ public sealed class PairManager : DisposableMediatorSubscriberBase
{
if (!_allClientPairs.ContainsKey(dto.User)) throw new InvalidOperationException("No user found for " + dto.User);
var pair = _allClientPairs[dto.User];
if (!pair.PlayerName.IsNullOrEmpty())
{
pair.ApplyData(dto);
}
else
{
_allClientPairs[dto.User].LastReceivedCharacterData = dto.CharaData;
}
_allClientPairs[dto.User].ApplyData(dto);
}
public void RemoveGroup(GroupData data)
@@ -360,32 +350,16 @@ public sealed class PairManager : DisposableMediatorSubscriberBase
if (string.IsNullOrEmpty(hash)) continue;
_indexedPairs[hash] = pair;
}
foreach (Pair pair in _allClientPairs.Select(p => p.Value).Where(p => p.HasCachedPlayer).ToList())
{
if (!pair.CachedPlayerExists)
{
pair.RecreateCachedPlayer();
}
}
}
private void DalamudUtilOnZoneSwitched()
{
DisposePairs(recreate: true);
}
private Lazy<List<Pair>> DirectPairsLazy() => new(() => _allClientPairs.Select(k => k.Value).Where(k => k.UserPair != null).ToList());
private void DisposePairs(bool recreate = false)
private void DisposePairs()
{
Logger.LogDebug("Disposing all Pairs");
Parallel.ForEach(_allClientPairs, item =>
{
if (recreate)
item.Value.RecreateCachedPlayer();
else
item.Value.MarkOffline();
item.Value.MarkOffline();
});
RecreateLazy();