/// <summary> Bans given IP address and all accounts on that IP. All players from IP are kicked.
/// Throws PlayerOpException on problems. </summary>
/// <param name="targetAddress"> IP address that is being banned. </param>
/// <param name="player"> Player who is banning. </param>
/// <param name="reason"> Reason for ban. May be empty, if permitted by server configuration. </param>
/// <param name="announce"> Whether ban should be publicly announced on the server. </param>
/// <param name="raiseEvents"> Whether AddingIPBan, AddedIPBan, BanChanging, and BanChanged events should be raised. </param>
public static void BanAll([NotNull] this IPAddress targetAddress, [NotNull] Player player, [CanBeNull] string reason,
bool announce, bool raiseEvents)
{
if (targetAddress == null)
{
throw new ArgumentNullException("targetAddress");
}
if (player == null)
{
throw new ArgumentNullException("player");
}
if (reason != null && reason.Trim().Length == 0)
{
reason = null;
}
if (!player.Can(Permission.Ban, Permission.BanIP, Permission.BanAll))
{
PlayerOpException.ThrowPermissionMissing(player, null, "ban-all",
Permission.Ban, Permission.BanIP, Permission.BanAll);
}
// Check if player is trying to ban self
if (targetAddress.Equals(player.IP) && !player.Info.IsSuper)
{
PlayerOpException.ThrowCannotTargetSelf(player, null, "ban-all");
}
// Check if a non-bannable address was given (0.0.0.0 or 255.255.255.255)
if (targetAddress.Equals(IPAddress.None) || targetAddress.Equals(IPAddress.Any))
{
PlayerOpException.ThrowInvalidIP(player, null, targetAddress);
}
// Check if any high-ranked players use this address
var allPlayersOnIP = PlayerDB.FindByIP(targetAddress).ToArray();
PlayerInfo infoWhomPlayerCantBan = allPlayersOnIP.FirstOrDefault(info => !player.Can(Permission.Ban, info.Rank));
if (infoWhomPlayerCantBan != null)
{
PlayerOpException.ThrowPermissionLimitIP(player, infoWhomPlayerCantBan, targetAddress);
}
PlayerOpException.CheckBanReason(reason, player, null, false);
bool somethingGotBanned = false;
// Ban the IP
if (!Contains(targetAddress))
{
IPBanInfo banInfo = new IPBanInfo(targetAddress, null, player.Name, reason);
if (Add(banInfo, raiseEvents))
{
Logger.Log(LogType.UserActivity,
"{0} banned {1} (BanAll {1}). Reason: {2}",
player.Name, targetAddress, reason ?? "");
// Announce ban on the server
if (announce)
{
var can = Server.Players.Can(Permission.ViewPlayerIPs);
can.Message("&W{0} was banned by {1}", targetAddress, player.ClassyName);
var cant = Server.Players.Cant(Permission.ViewPlayerIPs);
cant.Message("&WAn IP was banned by {0}", player.ClassyName);
}
somethingGotBanned = true;
}
}
// Ban individual players
foreach (PlayerInfo targetAlt in allPlayersOnIP)
{
if (targetAlt.BanStatus != BanStatus.NotBanned)
{
continue;
}
bool announceThisOne = announce;
// Raise PlayerInfo.BanChanging event
var e = new PlayerInfoBanChangingEventArgs(targetAlt, player, false, reason, announce);
if (raiseEvents)
{
PlayerInfo.RaiseBanChangingEvent(e);
if (e.Cancel)
{
continue;
}
reason = e.Reason;
announceThisOne = e.Announce;
}
// Do the ban
if (targetAlt.ProcessBan(player, player.Name, reason))
{
if (raiseEvents)
{
PlayerInfo.RaiseBanChangedEvent(e);
}
// Log and announce ban
Logger.Log(LogType.UserActivity,
"{0} banned {1} (BanAll {2}). Reason: {3}",
player.Name, targetAlt.Name, targetAddress, reason ?? "");
if (announceThisOne)
{
Server.Message("&WPlayer {0}&W was banned by {1}&W (BanAll)",
targetAlt.ClassyName, player.ClassyName);
}
somethingGotBanned = true;
}
}
// If no one ended up getting banned, quit here
if (!somethingGotBanned)
{
PlayerOpException.ThrowNoOneToBan(player, null, targetAddress);
}
// Announce BanAll reason towards the end of all bans
if (announce && ConfigKey.AnnounceKickAndBanReasons.Enabled() && reason != null)
{
Server.Message("&WBanAll reason: {0}", reason);
}
// Kick all players from IP
Player[] targetsOnline = Server.Players.FromIP(targetAddress).ToArray();
if (targetsOnline.Length > 0)
{
string kickReason;
if (reason != null)
{
kickReason = String.Format("Banned by {0}: {1}", player.Name, reason);
}
else
{
kickReason = String.Format("Banned by {0}", player.Name);
}
for (int i = 0; i < targetsOnline.Length; i++)
{
targetsOnline[i].Kick(kickReason, LeaveReason.BanAll);
}
}
}
/// <summary> Unbans given IP address and all accounts on that IP. Throws PlayerOpException on problems. </summary>
/// <param name="targetAddress"> IP address that is being unbanned. </param>
/// <param name="player"> Player who is unbanning. </param>
/// <param name="reason"> Reason for unban. May be null or empty, if permitted by server configuration. </param>
/// <param name="announce"> Whether unban should be publicly announced on the server. </param>
/// <param name="raiseEvents"> Whether RemovingIPBan, RemovedIPBan, BanChanging, and BanChanged events should be raised. </param>
public static void UnbanAll([NotNull] this IPAddress targetAddress, [NotNull] Player player, [CanBeNull] string reason,
bool announce, bool raiseEvents)
{
if (targetAddress == null)
{
throw new ArgumentNullException("targetAddress");
}
if (player == null)
{
throw new ArgumentNullException("player");
}
if (reason != null && reason.Trim().Length == 0)
{
reason = null;
}
if (!player.Can(Permission.Ban, Permission.BanIP, Permission.BanAll))
{
PlayerOpException.ThrowPermissionMissing(player, null, "unban-all",
Permission.Ban, Permission.BanIP, Permission.BanAll);
}
// Check if player is trying to unban self
if (targetAddress.Equals(player.IP) && !player.Info.IsSuper)
{
PlayerOpException.ThrowCannotTargetSelf(player, null, "unban-all");
}
// Check if a non-bannable address was given (0.0.0.0 or 255.255.255.255)
if (targetAddress.Equals(IPAddress.None) || targetAddress.Equals(IPAddress.Any))
{
PlayerOpException.ThrowInvalidIP(player, null, targetAddress);
}
PlayerOpException.CheckBanReason(reason, player, null, true);
bool somethingGotUnbanned = false;
// Unban the IP
if (Contains(targetAddress))
{
if (Remove(targetAddress, raiseEvents))
{
Logger.Log(LogType.UserActivity,
"{0} unbanned {1} (UnbanAll {1}). Reason: {2}",
player.Name, targetAddress, reason ?? "");
// Announce unban on the server
if (announce)
{
var can = Server.Players.Can(Permission.ViewPlayerIPs);
can.Message("&W{0} was unbanned by {1}", targetAddress, player.ClassyName);
var cant = Server.Players.Cant(Permission.ViewPlayerIPs);
cant.Message("&WAn IP was unbanned by {0}", player.ClassyName);
}
somethingGotUnbanned = true;
}
}
// Unban individual players
var allPlayersOnIP = PlayerDB.FindByIP(targetAddress);
foreach (PlayerInfo targetAlt in allPlayersOnIP)
{
if (targetAlt.BanStatus != BanStatus.Banned)
{
continue;
}
bool announceThisOne = announce;
// Raise PlayerInfo.BanChanging event
var e = new PlayerInfoBanChangingEventArgs(targetAlt, player, true, reason, announce);
if (raiseEvents)
{
PlayerInfo.RaiseBanChangingEvent(e);
if (e.Cancel)
{
continue;
}
reason = e.Reason;
announceThisOne = e.Announce;
}
// Do the ban
if (targetAlt.ProcessUnban(player.Name, reason))
{
if (raiseEvents)
{
PlayerInfo.RaiseBanChangedEvent(e);
}
// Log and announce ban
Logger.Log(LogType.UserActivity,
"{0} unbanned {1} (UnbanAll {2}). Reason: {3}",
player.Name, targetAlt.Name, targetAddress, reason ?? "");
if (announceThisOne)
{
Server.Message("&WPlayer {0}&W was unbanned by {1}&W (UnbanAll)",
targetAlt.ClassyName, player.ClassyName);
}
somethingGotUnbanned = true;
}
}
// If no one ended up getting unbanned, quit here
if (!somethingGotUnbanned)
{
PlayerOpException.ThrowNoOneToUnban(player, null, targetAddress);
}
// Announce UnbanAll reason towards the end of all unbans
if (announce && ConfigKey.AnnounceKickAndBanReasons.Enabled() && reason != null)
{
Server.Message("&WUnbanAll reason: {0}", reason);
}
}
/// <summary> Bans given IP address. All players from IP are kicked. If an associated PlayerInfo is known,
/// use a different overload of this method instead. Throws PlayerOpException on problems. </summary>
/// <param name="targetAddress"> IP address that is being banned. </param>
/// <param name="player"> Player who is banning. </param>
/// <param name="reason"> Reason for ban. May be empty, if permitted by server configuration. </param>
/// <param name="announce"> Whether ban should be publicly announced on the server. </param>
/// <param name="raiseEvents"> Whether AddingIPBan and AddedIPBan events should be raised. </param>
public static void BanIP([NotNull] this IPAddress targetAddress, [NotNull] Player player, [CanBeNull] string reason,
bool announce, bool raiseEvents)
{
if (targetAddress == null)
{
throw new ArgumentNullException("targetAddress");
}
if (player == null)
{
throw new ArgumentNullException("player");
}
if (reason != null && reason.Trim().Length == 0)
{
reason = null;
}
// Check if player can ban IPs in general
if (!player.Can(Permission.Ban, Permission.BanIP))
{
PlayerOpException.ThrowPermissionMissing(player, null, "IP-ban", Permission.Ban, Permission.BanIP);
}
// Check if a non-bannable address was given (0.0.0.0 or 255.255.255.255)
if (targetAddress.Equals(IPAddress.None) || targetAddress.Equals(IPAddress.Any))
{
PlayerOpException.ThrowInvalidIP(player, null, targetAddress);
}
// Check if player is trying to ban self
if (targetAddress.Equals(player.IP) && !player.Info.IsSuper)
{
PlayerOpException.ThrowCannotTargetSelf(player, null, "IP-ban");
}
// Check if target is already banned
IPBanInfo existingBan = Get(targetAddress);
if (existingBan != null)
{
string msg;
if (player.Can(Permission.ViewPlayerIPs))
{
msg = String.Format("IP address {0} is already banned.", targetAddress);
}
else
{
msg = String.Format("Given IP address is already banned.");
}
string colorMsg = "&S" + msg;
throw new PlayerOpException(player, null, PlayerOpExceptionCode.NoActionNeeded, msg, colorMsg);
}
// Check if any high-ranked players use this address
PlayerInfo infoWhomPlayerCantBan = PlayerDB.FindByIP(targetAddress)
.FirstOrDefault(info => !player.Can(Permission.Ban, info.Rank));
if (infoWhomPlayerCantBan != null)
{
PlayerOpException.ThrowPermissionLimitIP(player, infoWhomPlayerCantBan, targetAddress);
}
PlayerOpException.CheckBanReason(reason, player, null, false);
// Actually ban
IPBanInfo banInfo = new IPBanInfo(targetAddress, null, player.Name, reason);
bool result = Add(banInfo, raiseEvents);
if (result)
{
Logger.Log(LogType.UserActivity,
"{0} banned {1} (BanIP {1}). Reason: {2}",
player.Name, targetAddress, reason ?? "");
if (announce)
{
// Announce ban on the server
var can = Server.Players.Can(Permission.ViewPlayerIPs);
can.Message("&W{0} was banned by {1}", targetAddress, player.ClassyName);
var cant = Server.Players.Cant(Permission.ViewPlayerIPs);
cant.Message("&WAn IP was banned by {0}", player.ClassyName);
if (ConfigKey.AnnounceKickAndBanReasons.Enabled() && reason != null)
{
Server.Message("&WBanIP reason: {0}", reason);
}
}
// Kick all players connected from address
string kickReason;
if (reason != null)
{
kickReason = String.Format("IP-Banned by {0}: {1}", player.Name, reason);
}
else
{
kickReason = String.Format("IP-Banned by {0}", player.Name);
}
foreach (Player other in Server.Players.FromIP(targetAddress))
{
if (other.Info.BanStatus != BanStatus.BanExempt)
{
other.Kick(kickReason, LeaveReason.BanIP); // TODO: check side effects of not using DoKick
}
}
}
else
{
// address is already banned
string msg;
if (player.Can(Permission.ViewPlayerIPs))
{
msg = String.Format("{0} is already banned.", targetAddress);
}
else
{
msg = "Given IP address is already banned.";
}
string colorMsg = "&S" + msg;
throw new PlayerOpException(player, null, PlayerOpExceptionCode.NoActionNeeded, msg, colorMsg);
}
}
