ModernUO/Projects/UOContent/Network/BanExemptions.cs
Kamron Batman b6c0a0bde8
docs: tighten comments to the non-obvious why
Cuts explanation that restated the code or repeated itself, and keeps the parts
a future change would otherwise undo.

The same fact was asserted in three places: BanChannel.IsExempt, BanExemptions
and LoginAllowlist each explained that an exemption withholds escalation only.
It now lives on the seam that defines it, and the other two point at it.

The seed short-read comment was eight lines arguing a decision; the load-bearing
part is that waiting costs a connection slot per one- or two-byte client, so
that is what it says now. The new test-collection markers are one line each
rather than a summary of how STArrayPool works internally.

Also drops a fully-qualified System.Func in BanExemptions in favour of a using.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-30 18:40:02 -07:00

61 lines
2.4 KiB
C#

/*************************************************************************
* ModernUO *
* Copyright 2019-2026 - ModernUO Development Team *
* Email: hi@modernuo.com *
* File: BanExemptions.cs *
* *
* This program is free software: you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation, either version 3 of the License, or *
* (at your option) any later version. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*************************************************************************/
using System;
using System.Net;
using Server.Network.Bans;
namespace Server.Network;
/// <summary>
/// Combines <see cref="FileAllowlist"/> and <see cref="LoginAllowlist"/> into the one answer
/// <see cref="BanChannel.IsExempt"/> asks for, so neither source has to know about the other.
/// </summary>
public static class BanExemptions
{
public static void Configure()
{
BanChannel.IsExempt = IsExempt;
}
public static bool IsExempt(IPAddress address, string reason) =>
IsExempt(address, reason, LoginAllowlist.IsExemptFromEscalation);
/// <summary>
/// Split for testing. <paramref name="loginAllowlist"/> is stateful — calling it spends a strike — so it
/// must not be invoked once the answer is already decided.
/// </summary>
internal static bool IsExempt(IPAddress address, string reason, Func<IPAddress, string, bool> loginAllowlist)
{
if (address == null)
{
return false;
}
// Never suppress an operator's explicit ban. Checked first so it also costs no strike.
if (!BanReasons.IsBehavioral(reason))
{
return false;
}
// Deliberate and unconditional, so it wins and must not spend the earned list's strikes.
if (FileAllowlist.Contains(address))
{
return true;
}
return loginAllowlist(address, reason);
}
}