Mapping autosaves (#10966)
This commit is contained in:
Kara
GitHub
134
Content.Server/Mapping/MappingCommand.cs
Normal file
134
Content.Server/Mapping/MappingCommand.cs
Normal file
@@ -0,0 +1,134 @@
|
||||
// ReSharper disable once RedundantUsingDirective
|
||||
// Used to warn the player in big red letters in debug mode
|
||||
|
||||
using System.Linq;
|
||||
using Content.Server.Administration;
|
||||
using Content.Shared.Administration;
|
||||
using Content.Shared.CCVar;
|
||||
using Robust.Server.Player;
|
||||
using Robust.Shared.Configuration;
|
||||
using Robust.Shared.Console;
|
||||
using Robust.Shared.ContentPack;
|
||||
using Robust.Shared.Map;
|
||||
using Robust.Shared.Utility;
|
||||
|
||||
namespace Content.Server.Mapping
|
||||
{
|
||||
[AdminCommand(AdminFlags.Server | AdminFlags.Mapping)]
|
||||
sealed class MappingCommand : IConsoleCommand
|
||||
{
|
||||
[Dependency] private readonly IEntityManager _entities = default!;
|
||||
|
||||
public string Command => "mapping";
|
||||
public string Description => Loc.GetString("cmd-mapping-desc");
|
||||
public string Help => Loc.GetString("cmd-mapping-help");
|
||||
|
||||
public CompletionResult GetCompletion(IConsoleShell shell, string[] args)
|
||||
{
|
||||
switch (args.Length)
|
||||
{
|
||||
case 1:
|
||||
return CompletionResult.FromHint(Loc.GetString("cmd-hint-mapping-id"));
|
||||
case 2:
|
||||
var res = IoCManager.Resolve<IResourceManager>();
|
||||
var opts = CompletionHelper.UserFilePath(args[1], res.UserData)
|
||||
.Concat(CompletionHelper.ContentFilePath(args[1], res));
|
||||
return CompletionResult.FromHintOptions(opts, Loc.GetString("cmd-hint-mapping-path"));
|
||||
}
|
||||
return CompletionResult.Empty;
|
||||
}
|
||||
|
||||
public void Execute(IConsoleShell shell, string argStr, string[] args)
|
||||
{
|
||||
if (shell.Player is not IPlayerSession player)
|
||||
{
|
||||
shell.WriteError(Loc.GetString("cmd-savemap-server"));
|
||||
return;
|
||||
}
|
||||
|
||||
if (args.Length > 2)
|
||||
{
|
||||
shell.WriteLine(Help);
|
||||
return;
|
||||
}
|
||||
|
||||
#if DEBUG
|
||||
shell.WriteError(Loc.GetString("cmd-mapping-warning"));
|
||||
#endif
|
||||
|
||||
var mapManager = IoCManager.Resolve<IMapManager>();
|
||||
MapId mapId;
|
||||
|
||||
// Get the map ID to use
|
||||
if (args.Length is 1 or 2)
|
||||
{
|
||||
|
||||
if (!int.TryParse(args[0], out var intMapId))
|
||||
{
|
||||
shell.WriteError(Loc.GetString("cmd-mapping-failure-integer", ("arg", args[0])));
|
||||
return;
|
||||
}
|
||||
|
||||
mapId = new MapId(intMapId);
|
||||
|
||||
// no loading null space
|
||||
if (mapId == MapId.Nullspace)
|
||||
{
|
||||
shell.WriteError(Loc.GetString("cmd-mapping-nullspace"));
|
||||
return;
|
||||
}
|
||||
|
||||
if (mapManager.MapExists(mapId))
|
||||
{
|
||||
shell.WriteError(Loc.GetString("cmd-mapping-exists", ("mapId", mapId)));
|
||||
return;
|
||||
}
|
||||
|
||||
}
|
||||
else
|
||||
{
|
||||
mapId = mapManager.NextMapId();
|
||||
}
|
||||
|
||||
string? toLoad = null;
|
||||
// either load a map or create a new one.
|
||||
if (args.Length <= 1)
|
||||
{
|
||||
shell.ExecuteCommand($"addmap {mapId} false");
|
||||
}
|
||||
else
|
||||
{
|
||||
toLoad = CommandParsing.Escape(args[1]);
|
||||
shell.ExecuteCommand($"loadmap {mapId} \"{toLoad}\" 0 0 0 true");
|
||||
}
|
||||
|
||||
// was the map actually created?
|
||||
if (!mapManager.MapExists(mapId))
|
||||
{
|
||||
shell.WriteError(Loc.GetString("cmd-mapping-error"));
|
||||
return;
|
||||
}
|
||||
|
||||
// map successfully created. run misc helpful mapping commands
|
||||
if (player.AttachedEntity is { Valid: true } playerEntity &&
|
||||
_entities.GetComponent<MetaDataComponent>(playerEntity).EntityPrototype?.ID != "AdminObserver")
|
||||
{
|
||||
shell.ExecuteCommand("aghost");
|
||||
}
|
||||
|
||||
var cfg = IoCManager.Resolve<IConfigurationManager>();
|
||||
|
||||
shell.ExecuteCommand("sudo cvar events.enabled false");
|
||||
if (cfg.GetCVar(CCVars.AutosaveEnabled))
|
||||
shell.ExecuteCommand($"toggleautosave {mapId} {toLoad ?? "NEWMAP"}");
|
||||
shell.ExecuteCommand($"tp 0 0 {mapId}");
|
||||
shell.RemoteExecuteCommand("mappingclientsidesetup");
|
||||
mapManager.SetMapPaused(mapId, true);
|
||||
|
||||
if (args.Length == 2)
|
||||
shell.WriteLine(Loc.GetString("cmd-mapping-success-load",("mapId",mapId),("path", args[1])));
|
||||
else
|
||||
shell.WriteLine(Loc.GetString("cmd-mapping-success", ("mapId", mapId)));
|
||||
}
|
||||
}
|
||||
}
|
||||
158
Content.Server/Mapping/MappingSystem.cs
Normal file
158
Content.Server/Mapping/MappingSystem.cs
Normal file
@@ -0,0 +1,158 @@
|
||||
using System.IO;
|
||||
using Content.Server.Administration;
|
||||
using Content.Shared.Administration;
|
||||
using Content.Shared.CCVar;
|
||||
using Robust.Server.Maps;
|
||||
using Robust.Shared.Configuration;
|
||||
using Robust.Shared.Console;
|
||||
using Robust.Shared.ContentPack;
|
||||
using Robust.Shared.Map;
|
||||
using Robust.Shared.Timing;
|
||||
using Robust.Shared.Utility;
|
||||
|
||||
namespace Content.Server.Mapping;
|
||||
|
||||
/// <summary>
|
||||
/// Handles autosaving maps.
|
||||
/// </summary>
|
||||
public sealed class MappingSystem : EntitySystem
|
||||
{
|
||||
[Dependency] private readonly IConsoleHost _conHost = default!;
|
||||
[Dependency] private readonly IGameTiming _timing = default!;
|
||||
[Dependency] private readonly IConfigurationManager _cfg = default!;
|
||||
[Dependency] private readonly IMapLoader _mapLoader = default!;
|
||||
[Dependency] private readonly IMapManager _mapManager = default!;
|
||||
[Dependency] private readonly IResourceManager _resMan = default!;
|
||||
|
||||
// Not a comp because I don't want to deal with this getting saved onto maps ever
|
||||
/// <summary>
|
||||
/// map id -> next autosave timespan & original filename.
|
||||
/// </summary>
|
||||
/// <returns></returns>
|
||||
private Dictionary<MapId, (TimeSpan next, string fileName)> _currentlyAutosaving = new();
|
||||
|
||||
private ISawmill _sawmill = default!;
|
||||
private bool _autosaveEnabled;
|
||||
|
||||
public override void Initialize()
|
||||
{
|
||||
base.Initialize();
|
||||
|
||||
_conHost.RegisterCommand("toggleautosave",
|
||||
"Toggles autosaving for a map.",
|
||||
"autosave <map> <path if enabling>",
|
||||
ToggleAutosaveCommand);
|
||||
|
||||
_sawmill = Logger.GetSawmill("autosave");
|
||||
_cfg.OnValueChanged(CCVars.AutosaveEnabled, SetAutosaveEnabled, true);
|
||||
}
|
||||
|
||||
public override void Shutdown()
|
||||
{
|
||||
base.Shutdown();
|
||||
|
||||
_cfg.UnsubValueChanged(CCVars.AutosaveEnabled, SetAutosaveEnabled);
|
||||
}
|
||||
|
||||
private void SetAutosaveEnabled(bool b)
|
||||
{
|
||||
if (!b)
|
||||
_currentlyAutosaving.Clear();
|
||||
_autosaveEnabled = b;
|
||||
}
|
||||
|
||||
public override void Update(float frameTime)
|
||||
{
|
||||
base.Update(frameTime);
|
||||
|
||||
if (!_autosaveEnabled)
|
||||
return;
|
||||
|
||||
foreach (var (map, (time, name))in _currentlyAutosaving.ToArray())
|
||||
{
|
||||
if (_timing.RealTime <= time)
|
||||
continue;
|
||||
|
||||
if (!_mapManager.MapExists(map) || _mapManager.IsMapInitialized(map))
|
||||
{
|
||||
_sawmill.Warning($"Can't autosave map {map}; it doesn't exist, or is initialized. Removing from autosave.");
|
||||
_currentlyAutosaving.Remove(map);
|
||||
return;
|
||||
}
|
||||
|
||||
var saveDir = Path.Combine(_cfg.GetCVar(CCVars.AutosaveDirectory), name);
|
||||
_resMan.UserData.CreateDir(new ResourcePath(saveDir).ToRootedPath());
|
||||
|
||||
var path = Path.Combine(saveDir, $"{DateTime.Now.ToString("yyyy-M-dd_HH.mm.ss")}-AUTO.yml");
|
||||
_currentlyAutosaving[map] = (CalculateNextTime(), name);
|
||||
_sawmill.Info($"Autosaving map {name} ({map}) to {path}. Next save in {ReadableTimeLeft(map)} seconds.");
|
||||
_mapLoader.SaveMap(map, path);
|
||||
}
|
||||
}
|
||||
|
||||
private TimeSpan CalculateNextTime()
|
||||
{
|
||||
return _timing.RealTime + TimeSpan.FromSeconds(_cfg.GetCVar(CCVars.AutosaveInterval));
|
||||
}
|
||||
|
||||
private double ReadableTimeLeft(MapId map)
|
||||
{
|
||||
return Math.Round(_currentlyAutosaving[map].next.TotalSeconds - _timing.RealTime.TotalSeconds);
|
||||
}
|
||||
|
||||
#region Public API
|
||||
|
||||
public void ToggleAutosave(MapId map, string? path=null)
|
||||
{
|
||||
if (!_autosaveEnabled)
|
||||
return;
|
||||
|
||||
if (path != null && _currentlyAutosaving.TryAdd(map, (CalculateNextTime(), Path.GetFileName(path))))
|
||||
{
|
||||
if (!_mapManager.MapExists(map) || _mapManager.IsMapInitialized(map))
|
||||
{
|
||||
_sawmill.Warning("Tried to enable autosaving on non-existant or already initialized map!");
|
||||
_currentlyAutosaving.Remove(map);
|
||||
return;
|
||||
}
|
||||
|
||||
_sawmill.Info($"Started autosaving map {path} ({map}). Next save in {ReadableTimeLeft(map)} seconds.");
|
||||
}
|
||||
else
|
||||
{
|
||||
_currentlyAutosaving.Remove(map);
|
||||
_sawmill.Info($"Stopped autosaving on map {map}");
|
||||
}
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
#region Commands
|
||||
|
||||
[AdminCommand(AdminFlags.Server | AdminFlags.Mapping)]
|
||||
private void ToggleAutosaveCommand(IConsoleShell shell, string argstr, string[] args)
|
||||
{
|
||||
if (args.Length != 1 && args.Length != 2)
|
||||
{
|
||||
shell.WriteError(Loc.GetString("shell-wrong-arguments-number"));
|
||||
return;
|
||||
}
|
||||
|
||||
if (!int.TryParse(args[0], out var intMapId))
|
||||
{
|
||||
shell.WriteError(Loc.GetString("cmd-mapping-failure-integer", ("arg", args[0])));
|
||||
return;
|
||||
}
|
||||
|
||||
string? path = null;
|
||||
if (args.Length == 2)
|
||||
{
|
||||
path = args[1];
|
||||
}
|
||||
|
||||
var mapId = new MapId(intMapId);
|
||||
ToggleAutosave(mapId, path);
|
||||
}
|
||||
|
||||
#endregion
|
||||
}
|
||||
Reference in New Issue
Block a user