2 * Protocol of online ban list:
5 * GET g_ban_sync_uri?action=ban&ip=xxx.xxx.xxx&duration=nnnn&why=...................
6 * (IP 1, 2, 3, or 4 octets, 3 octets for example is a /24 mask)
8 * GET g_ban_sync_uri?action=unban&ip=xxx.xxx.xxx
9 * - Querying the ban list
10 * GET g_ban_sync_uri?action=list&servers=xxx.xxx.xxx.xxx:xxx.xxx.xxx.xxx:...
12 * shows the bans from the listed servers, and possibly others.
13 * Format of a ban is ASCII plain text, four lines per ban, delimited by
14 * newline ONLY (no carriage return):
16 * IP address (also 1, 2, 3, or 4 octets, delimited by dot)
17 * time left in seconds
19 * server IP that registered the ban
22 float Ban_Insert(string ip, float bantime, string reason, float dosync);
24 void OnlineBanList_SendBan(string ip, float bantime, string reason)
29 uri = strcat( "?action=ban&ip=", uri_escape(ip));
30 uri = strcat(uri, "&duration=", ftos(bantime));
31 uri = strcat(uri, "&why=", uri_escape(reason));
33 n = tokenize_sane(cvar_string("g_ban_sync_uri"));
34 for(i = 0; i < n; ++i)
35 uri_get(strcat(argv(i), uri), 0); // 0 = "discard" callback target
38 void OnlineBanList_SendUnban(string ip)
43 uri = strcat( "?action=unban&ip=", uri_escape(ip));
45 n = tokenize_sane(cvar_string("g_ban_sync_uri"));
46 for(i = 0; i < n; ++i)
47 uri_get(strcat(argv(i), uri), 0); // 0 = "discard" callback target
50 string OnlineBanList_Servers;
51 float OnlineBanList_Timeout;
52 float OnlineBanList_Requests;
54 void OnlineBanList_URI_Get_Callback(float status, string data)
63 if(OnlineBanList_Requests <= 0)
66 --OnlineBanList_Requests;
68 if(time > OnlineBanList_Timeout)
71 syncinterval = cvar("g_ban_sync_interval");
79 print("Error receiving the online ban list: Status is ", ftos(status), "\n");
83 if(substring(data, 0, 1) == "<")
85 print("Error receiving the online ban list: Received HTML instead of a ban list: ");
89 if(strstrofs(data, "\r", 0) != -1)
91 print("Error receiving the online ban list: Received carriage returns: ");
95 n = tokenizebyseparator(data, "\n");
98 print("Error receiving the online ban list: Received invalid item count: ");
102 for(i = 0; i < n; i += 4)
105 timeleft = stof(argv(i + 1));
106 reason = argv(i + 2);
107 serverip = argv(i + 3);
114 for(j = 0; j < l; ++j)
115 if(strstrofs("0123456789.", substring(ip, j, 1), 0) == -1)
117 print("Invalid character ", substring(ip, j, 1), " in IP address ", ip, ". Skipping this ban.\n");
121 if(strstrofs(strcat(":", OnlineBanList_Servers, ":"), strcat(":", serverip, ":"), 0) != -1)
124 timeleft = min(syncinterval + 15, timeleft);
125 // 15 seconds for safety
126 // the ban will be prolonged on the next sync
127 Ban_Insert(ip, timeleft, strcat("ban synced from ", serverip), 0);
128 print("Ban list syncing: accepted ban of ", ip, " by ", serverip, ": ", reason, "\n");
136 void OnlineBanList_Think()
142 if(cvar_string("g_ban_sync_uri") == "")
144 if(cvar("g_ban_sync_interval") == 0) // < 0 is okay, it means "sync on level start only"
146 argc = tokenize_sane(cvar_string("g_ban_sync_trusted_servers"));
150 if(OnlineBanList_Requests == 0) // only if there is no ongoing request!
152 if(OnlineBanList_Servers)
153 strunzone(OnlineBanList_Servers);
154 OnlineBanList_Servers = argv(0);
155 for(i = 1; i < argc; ++i)
156 OnlineBanList_Servers = strcat(OnlineBanList_Servers, ":", argv(i));
157 OnlineBanList_Servers = strzone(OnlineBanList_Servers);
159 uri = strcat( "?action=list&servers=", uri_escape(OnlineBanList_Servers));
161 OnlineBanList_Timeout = time + 10;
163 n = tokenize_sane(cvar_string("g_ban_sync_uri"));
164 for(i = 0; i < n; ++i)
166 ++OnlineBanList_Requests;
167 uri_get(strcat(argv(i), uri), 1); // 1 = "banlist" callback target
171 if(cvar("g_ban_sync_interval") > 0)
172 self.nextthink = time + max(60, cvar("g_ban_sync_interval") * 60);
177 string ban_ip[BAN_MAX];
178 float ban_expire[BAN_MAX];
196 for(i = 0; i < ban_count; ++i)
198 if(time > ban_expire[i])
200 out = strcat(out, " ", ban_ip[i]);
201 out = strcat(out, " ", ftos(ban_expire[i] - time));
203 if(strlen(out) <= 1) // no real entries
204 cvar_set("g_banned_list", "");
206 cvar_set("g_banned_list", out);
209 float Ban_Delete(float i)
215 if(ban_expire[i] == 0)
217 if(ban_expire[i] > 0)
219 OnlineBanList_SendUnban(ban_ip[i]);
220 strunzone(ban_ip[i]);
231 for(i = 0; i < ban_count; ++i)
235 n = tokenize_sane(cvar_string("g_banned_list"));
236 if(stof(argv(0)) == 1)
238 ban_count = (n - 1) / 2;
239 for(i = 0; i < ban_count; ++i)
241 ban_ip[i] = strzone(argv(2*i+1));
242 ban_expire[i] = time + stof(argv(2*i+2));
248 e.classname = "bansyncer";
249 e.think = OnlineBanList_Think;
250 e.nextthink = time + 1;
257 for(i = 0; i < ban_count; ++i)
259 if(time > ban_expire[i])
261 msg = strcat("#", ftos(i), ": ");
262 msg = strcat(msg, ban_ip[i], " is still banned for ");
263 msg = strcat(msg, ftos(ban_expire[i] - time), " seconds");
268 float Ban_GetClientIP(entity client)
271 n = tokenizebyseparator(client.netaddress, ".");
274 ban_ip1 = strcat1(argv(0));
275 ban_ip2 = strcat(ban_ip1, ".", argv(1));
276 ban_ip3 = strcat(ban_ip2, ".", argv(2));
277 ban_ip4 = strcat(ban_ip3, ".", argv(3));
281 float Ban_IsClientBanned(entity client, float idx)
286 if(!Ban_GetClientIP(client))
298 for(i = b; i < e; ++i)
301 if(time > ban_expire[i])
304 if(ban_ip1 == s) return TRUE;
305 if(ban_ip2 == s) return TRUE;
306 if(ban_ip3 == s) return TRUE;
307 if(ban_ip4 == s) return TRUE;
312 float Ban_MaybeEnforceBan(entity client)
314 if(Ban_IsClientBanned(client, -1))
317 s = strcat("^1NOTE:^7 banned client ", client.netaddress, " just tried to enter\n");
325 float Ban_Insert(string ip, float bantime, string reason, float dosync)
335 if(substring(reason, 0, 1) != "~") // like IRC: unauthenticated banner
336 OnlineBanList_SendBan(ip, bantime, reason);
339 for(i = 0; i < ban_count; ++i)
343 if(time + bantime > ban_expire[i])
345 ban_expire[i] = time + bantime;
346 print(ip, "'s ban has been prolonged to ", ftos(bantime), " seconds from now\n");
351 // do we have a free slot?
352 for(i = 0; i < ban_count; ++i)
353 if(time > ban_expire[i])
355 // no free slot? Then look for the one who would get unbanned next
359 bestscore = ban_expire[i];
360 for(j = 1; j < ban_count; ++j)
362 if(ban_expire[j] < bestscore)
365 bestscore = ban_expire[i];
369 // if we replace someone, will we be banned longer than him (so long-term
370 // bans never get overridden by short-term bans)
371 if(ban_expire[i] > time + bantime)
373 // okay, insert our new victim as i
375 print(ip, " has been banned for ", ftos(bantime), " seconds\n");
376 ban_expire[i] = time + bantime;
377 ban_ip[i] = strzone(ip);
378 ban_count = max(ban_count, i + 1);
382 // Enforce our new ban
384 FOR_EACH_REALCLIENT(e)
385 if(Ban_IsClientBanned(e, i))
387 s = strcat(s, "^1NOTE:^7 banned client ", e.netname, "^7 has to go\n");
395 void Ban_KickBanClient(entity client, float bantime, float masksize, string reason)
397 if(!Ban_GetClientIP(client))
399 sprint(client, strcat("Kickbanned: ", reason, "\n"));
407 Ban_Insert(ban_ip1, bantime, reason, 1);
410 Ban_Insert(ban_ip2, bantime, reason, 1);
413 Ban_Insert(ban_ip3, bantime, reason, 1);
416 Ban_Insert(ban_ip4, bantime, reason, 1);
420 sprint(client, strcat("Kickbanned: ", reason, "\n"));
424 float GameCommand_Ban(string command)
433 argc = tokenize_sane(command);
434 if(argv(0) == "help")
436 print(" kickban # n m p - kickban player n for m seconds, using mask size p (1 to 4)\n");
437 print(" ban ip m - ban an IP or range (incomplete IP, like 1.2.3) for m seconds\n");
438 print(" bans - list all existing bans\n");
439 print(" unban n - delete the entry #n from the bans list\n");
442 if(argv(0) == "kickban")
446 entno = stof(argv(2));
447 if(entno > maxclients || entno < 1)
449 client = edict_num(entno);
451 bantime = stof(argv(3));
453 bantime = cvar("g_ban_default_bantime");
455 masksize = stof(argv(4));
457 masksize = cvar("g_ban_default_masksize");
459 reason = substring(command, argv_start_index(5), strlen(command) - argv_start_index(5));
462 Ban_KickBanClient(client, bantime, masksize, reason);
466 else if(argv(0) == "ban")
473 bantime = stof(argv(2));
475 bantime = cvar("g_ban_default_bantime");
477 reason = substring(command, argv_start_index(3), strlen(command) - argv_start_index(3));
480 Ban_Insert(ip, bantime, reason, 1);
484 else if(argv(0) == "bans")
489 else if(argv(0) == "unban")