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)
28 uri = cvar_string("g_ban_sync_uri");
33 uri = strcat(uri, "?action=ban");
34 uri = strcat(uri, "&ip=", uri_escape(ip));
35 uri = strcat(uri, "&duration=", ftos(bantime));
36 uri = strcat(uri, "&why=", uri_escape(reason));
38 uri_get(uri, 0); // 0 = "discard" callback target
41 void OnlineBanList_SendUnban(string ip)
45 uri = cvar_string("g_ban_sync_uri");
50 uri = strcat(uri, "?action=unban");
51 uri = strcat(uri, "&ip=", uri_escape(ip));
53 uri_get(uri, 0); // 0 = "discard" callback target
56 string OnlineBanList_Servers;
57 float OnlineBanList_Timeout;
59 void OnlineBanList_URI_Get_Callback(float status, string data)
68 if(time > OnlineBanList_Timeout)
70 OnlineBanList_Timeout = 0;
72 syncinterval = cvar("g_ban_sync_interval");
80 print("Error receiving the online ban list.\nStatus is ", ftos(status), "\n");
84 if(substring(data, 0, 1) == "<")
86 print("Error receiving the online ban list.\nReceived HTML instead of a ban list.\n");
90 if(strstrofs(data, "\r", 0) != -1)
92 print("Error receiving the online ban list.\nReceived carriage returns.\n");
96 n = tokenizebyseparator(data, "\n");
99 print("Error receiving the online ban list.\nReceived invalid item count.\n");
103 for(i = 0; i < n; i += 4)
106 timeleft = stof(argv(i + 1));
107 reason = argv(i + 2);
108 serverip = argv(i + 3);
115 for(j = 0; j < l; ++j)
116 if(strstrofs("0123456789.", substring(ip, j, 1), 0) == -1)
118 print("Invalid character ", substring(ip, j, 1), " in IP address ", ip, ". Skipping this ban.\n");
122 if(strstrofs(strcat(":", OnlineBanList_Servers, ":"), strcat(":", serverip, ":"), 0) != -1)
125 timeleft = min(syncinterval + 15, timeleft);
126 // 15 seconds for safety
127 // the ban will be prolonged on the next sync
128 Ban_Insert(ip, timeleft, strcat("ban synced from ", serverip), 0);
129 print("Ban list syncing: accepted ban of ", ip, " by ", serverip, ": ", reason, "\n");
137 void OnlineBanList_Think()
143 uri = cvar_string("g_ban_sync_uri");
147 if(cvar("g_ban_sync_interval") == 0) // < 0 is okay, it means "sync on level start only"
149 argc = tokenize_sane(cvar_string("g_ban_sync_trusted_servers"));
153 if(OnlineBanList_Timeout == 0) // only if there is no ongoing request!
155 if(OnlineBanList_Servers)
156 strunzone(OnlineBanList_Servers);
157 OnlineBanList_Servers = argv(0);
158 for(i = 1; i < argc; ++i)
159 OnlineBanList_Servers = strcat(OnlineBanList_Servers, ":", argv(i));
160 OnlineBanList_Servers = strzone(OnlineBanList_Servers);
162 uri = strcat(uri, "?action=list");
163 uri = strcat(uri, "&servers=", uri_escape(OnlineBanList_Servers));
165 OnlineBanList_Timeout = time + 10;
166 uri_get(uri, 1); // 1 = "banlist" callback target
169 if(cvar("g_ban_sync_interval") > 0)
170 self.nextthink = time + max(60, cvar("g_ban_sync_interval") * 60);
175 string ban_ip[BAN_MAX];
176 float ban_expire[BAN_MAX];
194 for(i = 0; i < ban_count; ++i)
196 if(time > ban_expire[i])
198 out = strcat(out, " ", ban_ip[i]);
199 out = strcat(out, " ", ftos(ban_expire[i] - time));
201 if(strlen(out) <= 1) // no real entries
202 cvar_set("g_banned_list", "");
204 cvar_set("g_banned_list", out);
207 float Ban_Delete(float i)
213 if(ban_expire[i] == 0)
215 if(ban_expire[i] > 0)
217 OnlineBanList_SendUnban(ban_ip[i]);
218 strunzone(ban_ip[i]);
229 for(i = 0; i < ban_count; ++i)
233 n = tokenize_sane(cvar_string("g_banned_list"));
234 if(stof(argv(0)) == 1)
236 ban_count = (n - 1) / 2;
237 for(i = 0; i < ban_count; ++i)
239 ban_ip[i] = strzone(argv(2*i+1));
240 ban_expire[i] = time + stof(argv(2*i+2));
246 e.classname = "bansyncer";
247 e.think = OnlineBanList_Think;
248 e.nextthink = time + 1;
255 for(i = 0; i < ban_count; ++i)
257 if(time > ban_expire[i])
259 msg = strcat("#", ftos(i), ": ");
260 msg = strcat(msg, ban_ip[i], " is still banned for ");
261 msg = strcat(msg, ftos(ban_expire[i] - time), " seconds");
266 float Ban_GetClientIP(entity client)
269 n = tokenizebyseparator(client.netaddress, ".");
272 ban_ip1 = strcat1(argv(0));
273 ban_ip2 = strcat(ban_ip1, ".", argv(1));
274 ban_ip3 = strcat(ban_ip2, ".", argv(2));
275 ban_ip4 = strcat(ban_ip3, ".", argv(3));
279 float Ban_IsClientBanned(entity client, float idx)
284 if(!Ban_GetClientIP(client))
296 for(i = b; i < e; ++i)
299 if(time > ban_expire[i])
302 if(ban_ip1 == s) return TRUE;
303 if(ban_ip2 == s) return TRUE;
304 if(ban_ip3 == s) return TRUE;
305 if(ban_ip4 == s) return TRUE;
310 float Ban_MaybeEnforceBan(entity client)
312 if(Ban_IsClientBanned(client, -1))
315 s = strcat("^1NOTE:^7 banned client ", client.netaddress, " just tried to enter\n");
323 float Ban_Insert(string ip, float bantime, string reason, float dosync)
332 OnlineBanList_SendBan(ip, bantime, reason);
335 for(i = 0; i < ban_count; ++i)
339 if(time + bantime > ban_expire[i])
341 ban_expire[i] = time + bantime;
342 print(ip, "'s ban has been prolonged to ", ftos(bantime), " seconds from now\n");
347 // do we have a free slot?
348 for(i = 0; i < ban_count; ++i)
349 if(time > ban_expire[i])
351 // no free slot? Then look for the one who would get unbanned next
355 bestscore = ban_expire[i];
356 for(j = 1; j < ban_count; ++j)
358 if(ban_expire[j] < bestscore)
361 bestscore = ban_expire[i];
365 // if we replace someone, will we be banned longer than him (so long-term
366 // bans never get overridden by short-term bans)
367 if(ban_expire[i] > time + bantime)
369 // okay, insert our new victim as i
371 print(ip, " has been banned for ", ftos(bantime), " seconds\n");
372 ban_expire[i] = time + bantime;
373 ban_ip[i] = strzone(ip);
374 ban_count = max(ban_count, i + 1);
378 // Enforce our new ban
380 FOR_EACH_REALCLIENT(e)
381 if(Ban_IsClientBanned(e, i))
383 s = strcat(s, "^1NOTE:^7 banned client ", e.netname, "^7 has to go\n");
391 void Ban_KickBanClient(entity client, float bantime, float masksize, string reason)
393 if(!Ban_GetClientIP(client))
395 sprint(client, strcat("Kickbanned: ", reason, "\n"));
403 Ban_Insert(ban_ip1, bantime, reason, 1);
406 Ban_Insert(ban_ip2, bantime, reason, 1);
409 Ban_Insert(ban_ip3, bantime, reason, 1);
412 Ban_Insert(ban_ip4, bantime, reason, 1);
416 sprint(client, strcat("Kickbanned: ", reason, "\n"));
420 float GameCommand_Ban(string command)
429 argc = tokenize_sane(command);
430 if(argv(0) == "help")
432 print(" kickban # n m p - kickban player n for m seconds, using mask size p (1 to 4)\n");
433 print(" ban ip m - ban an IP or range (incomplete IP, like 1.2.3) for m seconds\n");
434 print(" bans - list all existing bans\n");
435 print(" unban n - delete the entry #n from the bans list\n");
438 if(argv(0) == "kickban")
442 entno = stof(argv(2));
443 if(entno > maxclients || entno < 1)
445 client = edict_num(entno);
447 bantime = stof(argv(3));
449 bantime = cvar("g_ban_default_bantime");
451 masksize = stof(argv(4));
453 masksize = cvar("g_ban_default_masksize");
455 reason = substring(command, argv_start_index(5), strlen(command) - argv_start_index(5));
458 Ban_KickBanClient(client, bantime, masksize, reason);
462 else if(argv(0) == "ban")
469 bantime = stof(argv(2));
471 bantime = cvar("g_ban_default_bantime");
473 reason = substring(command, argv_start_index(3), strlen(command) - argv_start_index(3));
476 Ban_Insert(ip, bantime, reason, 1);
480 else if(argv(0) == "bans")
485 else if(argv(0) == "unban")