Files
2026-03-09 17:50:20 +08:00

197 lines
7.5 KiB
C#

using System;
using UnityEditor;
using UnityEngine;
namespace UnityTcp.Editor.Helpers
{
/// <summary>
/// Write protection guard for Unity Editor operations.
/// Prevents unsafe modifications during Play mode or other restricted states.
/// </summary>
public static class WriteGuard
{
/// <summary>
/// Write guard policy enum.
/// </summary>
public enum Policy
{
/// <summary>
/// Deny all writes in Play/Paused mode (default, safest)
/// </summary>
Deny,
/// <summary>
/// Allow writes but log warnings (experimental, use with caution)
/// </summary>
AllowWithWarning
}
// Current policy (default: Deny)
private static Policy _currentPolicy = Policy.Deny;
/// <summary>
/// Gets the current write guard policy.
/// </summary>
public static Policy CurrentPolicy
{
get => _currentPolicy;
set => _currentPolicy = value;
}
/// <summary>
/// Checks if write operations are allowed in current editor state.
/// Returns null if allowed, or an error response object if blocked.
/// </summary>
/// <param name="operationName">Name of the operation being attempted (for logging)</param>
/// <returns>Error response if blocked, null if allowed</returns>
public static object CheckWriteAllowed(string operationName = "write operation")
{
// Check if we're in Play or Paused mode
bool inPlayMode = EditorApplication.isPlaying || EditorApplication.isPaused;
if (!inPlayMode)
{
// Not in Play mode - writes always allowed
return null;
}
// In Play mode - check policy
switch (_currentPolicy)
{
case Policy.Deny:
// Block the write and return error
string errorMessage = $"Cannot perform {operationName} in Play/Paused mode. " +
"Stop Play mode first, or change write guard policy to 'allow_with_warning' (experimental).";
Debug.LogWarning($"[WriteGuard] {errorMessage}");
return Response.Error("write_blocked_in_play_mode", new
{
code = "write_blocked_in_play_mode",
message = errorMessage,
currentPlayMode = EditorApplication.isPlaying ? "playing" : "paused",
policy = "deny",
suggestion = "Stop Play mode or change policy to 'allow_with_warning'"
});
case Policy.AllowWithWarning:
// Allow but warn
string warningMessage = $"[EXPERIMENTAL] Performing {operationName} in Play/Paused mode. " +
"This may cause unexpected behavior or data loss!";
Debug.LogWarning($"[WriteGuard] {warningMessage}");
// Log to audit trail
LogAuditEvent(operationName, "allowed_with_warning");
// Return null to allow operation
return null;
default:
return Response.Error("Invalid write guard policy");
}
}
/// <summary>
/// Force-checks if write operations are blocked (returns true if blocked).
/// </summary>
public static bool IsWriteBlocked()
{
if (!EditorApplication.isPlaying && !EditorApplication.isPaused)
{
return false; // Not in Play mode - not blocked
}
return _currentPolicy == Policy.Deny;
}
/// <summary>
/// Sets the write guard policy.
/// </summary>
/// <param name="policy">Policy to set ("deny" or "allow_with_warning")</param>
/// <returns>Success or error response</returns>
public static object SetPolicy(string policy)
{
if (string.IsNullOrEmpty(policy))
{
return Response.Error("Policy parameter is required");
}
string lowerPolicy = policy.ToLowerInvariant();
switch (lowerPolicy)
{
case "deny":
_currentPolicy = Policy.Deny;
Debug.Log("[WriteGuard] Write guard policy set to: Deny");
return Response.Success($"Write guard policy set to 'deny'.", new { policy = "deny" });
case "allow_with_warning":
_currentPolicy = Policy.AllowWithWarning;
Debug.LogWarning("[WriteGuard] Write guard policy set to: AllowWithWarning (EXPERIMENTAL)");
return Response.Success($"Write guard policy set to 'allow_with_warning' (experimental).",
new { policy = "allow_with_warning", warning = "This is experimental and may cause issues" });
default:
return Response.Error($"Invalid policy: '{policy}'. Valid policies are: 'deny', 'allow_with_warning'");
}
}
/// <summary>
/// Gets the current policy as a string.
/// </summary>
public static string GetPolicyString()
{
return _currentPolicy == Policy.Deny ? "deny" : "allow_with_warning";
}
/// <summary>
/// Logs audit events for write operations in Play mode.
/// </summary>
private static void LogAuditEvent(string operationName, string action)
{
// In production, this could write to a file or telemetry system
var auditEntry = new
{
timestamp = DateTime.UtcNow.ToString("o"),
operation = operationName,
action = action,
playMode = EditorApplication.isPlaying ? "playing" : (EditorApplication.isPaused ? "paused" : "stopped"),
scene = UnityEngine.SceneManagement.SceneManager.GetActiveScene().name
};
Debug.Log($"[WriteGuard Audit] {Codely.Newtonsoft.Json.JsonConvert.SerializeObject(auditEntry)}");
}
/// <summary>
/// Creates a write-blocked error response with detailed information.
/// </summary>
public static object CreateBlockedResponse(string operationName, string additionalInfo = null)
{
string message = $"Write operation '{operationName}' blocked in Play/Paused mode.";
if (!string.IsNullOrEmpty(additionalInfo))
{
message += $" {additionalInfo}";
}
return Response.Error("write_blocked_in_play_mode", new
{
code = "write_blocked_in_play_mode",
operation = operationName,
currentMode = EditorApplication.isPlaying ? "playing" : "paused",
policy = GetPolicyString(),
message = message,
remediation = new
{
options = new[]
{
"Stop Play mode (recommended)",
"Change write guard policy to 'allow_with_warning' (experimental, use with caution)"
}
}
});
}
}
}