1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2007 InspIRCd Development Team
6 * See: http://www.inspircd.org/wiki/index.php/Credits
8 * This program is free but copyrighted software; see
9 * the file COPYING for details.
11 * ---------------------------------------------------
14 /* $Core: libIRCDxline */
21 * This is now version 3 of the XLine subsystem, let's see if we can get it as nice and
22 * efficient as we can this time so we can close this file and never ever touch it again ..
25 * Version 1 stored all line types in one list (one for g, one for z, etc). This was fine,
26 * but both version 1 and 2 suck at applying lines efficiently. That is, every time a new line
27 * was added, it iterated every existing line for every existing user. Ow. Expiry was also
28 * expensive, as the lists were NOT sorted.
30 * Version 2 moved permanent lines into a seperate list from non-permanent to help optimize
31 * matching speed, but matched in the same way.
32 * Expiry was also sped up by sorting the list by expiry (meaning just remove the items at the
33 * head of the list that are outdated.)
35 * This was fine and good, but it looked less than ideal in code, and matching was still slower
36 * than it could have been, something which we address here.
39 * All lines are (as in v1) stored together -- no seperation of perm and non-perm. Expiry will
40 * still use a sorted list, and we'll just ignore anything permanent.
42 * Application will be by a list of lines 'pending' application, meaning only the newly added lines
43 * will be gone over. Much faster.
45 * More of course is to come.
48 /* Version two, now with optimized expiry!
50 * Because the old way was horrendously slow, the new way of expiring xlines is very
51 * very efficient. I have improved the efficiency of the algorithm in two ways:
53 * (1) There are now two lists of items for each linetype. One list holds temporary
54 * items, and the other list holds permanent items (ones which will expire).
55 * Items which are on the permanent list are NEVER checked at all by the
56 * expire_lines() function.
57 * (2) The temporary xline lists are always kept in strict numerical order, keyed by
58 * current time + duration. This means that the line which is due to expire the
59 * soonest is always pointed at by vector::begin(), so a simple while loop can
60 * very efficiently, very quickly and above all SAFELY pick off the first few
61 * items in the vector which need zapping.
66 bool InitXLine(ServerConfig* conf, const char* tag)
71 bool DoneZLine(ServerConfig* conf, const char* tag)
73 // XXX we should really only call this once - after we've finished processing configuration all together
74 conf->GetInstance()->XLines->apply_lines();
78 bool DoneQLine(ServerConfig* conf, const char* tag)
80 // XXX we should really only call this once - after we've finished processing configuration all together
81 conf->GetInstance()->XLines->apply_lines();
85 bool DoneKLine(ServerConfig* conf, const char* tag)
87 // XXX we should really only call this once - after we've finished processing configuration all together
88 conf->GetInstance()->XLines->apply_lines();
92 bool DoneELine(ServerConfig* conf, const char* tag)
94 // XXX we should really only call this once - after we've finished processing configuration all together
95 conf->GetInstance()->XLines->apply_lines();
99 bool DoZLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
101 const char* reason = values[0].GetString();
102 const char* ipmask = values[1].GetString();
104 conf->GetInstance()->XLines->add_zline(0,"<Config>",reason,ipmask);
108 bool DoQLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
110 const char* reason = values[0].GetString();
111 const char* nick = values[1].GetString();
113 conf->GetInstance()->XLines->add_qline(0,"<Config>",reason,nick);
117 bool DoKLine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
119 const char* reason = values[0].GetString();
120 const char* host = values[1].GetString();
122 conf->GetInstance()->XLines->add_kline(0,"<Config>",reason,host);
126 bool DoELine(ServerConfig* conf, const char* tag, char** entries, ValueList &values, int* types)
128 const char* reason = values[0].GetString();
129 const char* host = values[1].GetString();
131 conf->GetInstance()->XLines->add_eline(0,"<Config>",reason,host);
135 IdentHostPair XLineManager::IdentSplit(const std::string &ident_and_host)
137 IdentHostPair n = std::make_pair<std::string,std::string>("*","*");
138 std::string::size_type x = ident_and_host.find('@');
139 if (x != std::string::npos)
141 n.second = ident_and_host.substr(x + 1,ident_and_host.length());
142 n.first = ident_and_host.substr(0, x);
143 if (!n.first.length())
145 if (!n.second.length())
146 n.second.assign("*");
150 n.second = ident_and_host;
158 bool XLineManager::add_gline(long duration, const char* source,const char* reason,const char* hostmask)
160 IdentHostPair ih = IdentSplit(hostmask);
162 if (del_gline(hostmask, true))
165 GLine* item = new GLine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
167 glines.push_back(item);
168 sort(glines.begin(), glines.end(),XLineManager::XSortComparison);
173 // adds an e:line (exception to bans)
175 bool XLineManager::add_eline(long duration, const char* source, const char* reason, const char* hostmask)
177 IdentHostPair ih = IdentSplit(hostmask);
179 if (del_eline(hostmask, true))
182 ELine* item = new ELine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
184 elines.push_back(item);
185 sort(elines.begin(), elines.end(),XLineManager::XSortComparison);
192 bool XLineManager::add_qline(long duration, const char* source, const char* reason, const char* nickname)
194 if (del_qline(nickname, true))
197 QLine* item = new QLine(ServerInstance->Time(), duration, source, reason, nickname);
199 qlines.push_back(item);
200 sort(qlines.begin(), qlines.end(),XLineManager::XSortComparison);
207 bool XLineManager::add_zline(long duration, const char* source, const char* reason, const char* ipaddr)
209 if (strchr(ipaddr,'@'))
211 while (*ipaddr != '@')
216 if (del_zline(ipaddr, true))
219 ZLine* item = new ZLine(ServerInstance->Time(), duration, source, reason, ipaddr);
221 zlines.push_back(item);
222 sort(zlines.begin(), zlines.end(),XLineManager::XSortComparison);
229 bool XLineManager::add_kline(long duration, const char* source, const char* reason, const char* hostmask)
231 IdentHostPair ih = IdentSplit(hostmask);
233 if (del_kline(hostmask, true))
236 KLine* item = new KLine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
238 klines.push_back(item);
239 sort(klines.begin(), klines.end(),XLineManager::XSortComparison);
244 // deletes a g:line, returns true if the line existed and was removed
246 bool XLineManager::del_gline(const char* hostmask, bool simulate)
248 IdentHostPair ih = IdentSplit(hostmask);
249 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
251 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
265 // deletes a e:line, returns true if the line existed and was removed
267 bool XLineManager::del_eline(const char* hostmask, bool simulate)
269 IdentHostPair ih = IdentSplit(hostmask);
270 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
272 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
286 // deletes a q:line, returns true if the line existed and was removed
288 bool XLineManager::del_qline(const char* nickname, bool simulate)
290 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
292 if (!strcasecmp(nickname,(*i)->nick))
306 // deletes a z:line, returns true if the line existed and was removed
308 bool XLineManager::del_zline(const char* ipaddr, bool simulate)
310 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
312 if (!strcasecmp(ipaddr,(*i)->ipaddr))
326 // deletes a k:line, returns true if the line existed and was removed
328 bool XLineManager::del_kline(const char* hostmask, bool simulate)
330 IdentHostPair ih = IdentSplit(hostmask);
331 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
333 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
347 // returns a pointer to the reason if a nickname matches a qline, NULL if it didnt match
349 QLine* XLineManager::matches_qline(const char* nick)
354 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
355 if (match(nick,(*i)->nick))
360 // returns a pointer to the reason if a host matches a gline, NULL if it didnt match
362 GLine* XLineManager::matches_gline(User* user)
367 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
369 if ((match(user->ident,(*i)->identmask)))
371 if ((match(user->host,(*i)->hostmask, true)) || (match(user->GetIPString(),(*i)->hostmask, true)))
381 ELine* XLineManager::matches_exception(User* user)
387 snprintf(host2,MAXBUF,"*@%s",user->host);
388 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
390 if ((match(user->ident,(*i)->identmask)))
392 if ((match(user->host,(*i)->hostmask, true)) || (match(user->GetIPString(),(*i)->hostmask, true)))
402 void XLineManager::gline_set_creation_time(const char* host, time_t create_time)
404 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
406 if (!strcasecmp(host,(*i)->hostmask))
408 (*i)->set_time = create_time;
409 (*i)->expiry = create_time + (*i)->duration;
417 void XLineManager::eline_set_creation_time(const char* host, time_t create_time)
419 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
421 if (!strcasecmp(host,(*i)->hostmask))
423 (*i)->set_time = create_time;
424 (*i)->expiry = create_time + (*i)->duration;
432 void XLineManager::qline_set_creation_time(const char* nick, time_t create_time)
434 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
436 if (!strcasecmp(nick,(*i)->nick))
438 (*i)->set_time = create_time;
439 (*i)->expiry = create_time + (*i)->duration;
447 void XLineManager::zline_set_creation_time(const char* ip, time_t create_time)
449 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
451 if (!strcasecmp(ip,(*i)->ipaddr))
453 (*i)->set_time = create_time;
454 (*i)->expiry = create_time + (*i)->duration;
462 // returns a pointer to the reason if an ip address matches a zline, NULL if it didnt match
464 ZLine* XLineManager::matches_zline(const char* ipaddr)
469 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
470 if (match(ipaddr,(*i)->ipaddr, true))
475 // returns a pointer to the reason if a host matches a kline, NULL if it didnt match
477 KLine* XLineManager::matches_kline(User* user)
482 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
484 if ((match(user->ident,(*i)->identmask)))
486 if ((match(user->host,(*i)->hostmask, true)) || (match(user->GetIPString(),(*i)->hostmask, true)))
496 bool XLineManager::XSortComparison(const XLine *one, const XLine *two)
498 // account for permanent lines
499 if (one->expiry == 0)
503 return (one->expiry) < (two->expiry);
506 // removes lines that have expired
507 void XLineManager::expire_lines()
509 time_t current = ServerInstance->Time();
511 /* Because we now store all our XLines in sorted order using ((*i)->duration + (*i)->set_time) as a key, this
512 * means that to expire the XLines we just need to do a while, picking off the top few until there are
513 * none left at the head of the queue that are after the current time.
516 while ((glines.size()) && (current > (*glines.begin())->expiry) && ((*glines.begin())->duration != 0))
518 std::vector<GLine*>::iterator i = glines.begin();
519 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed G-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
523 while ((elines.size()) && (current > (*elines.begin())->expiry) && ((*elines.begin())->duration != 0))
525 std::vector<ELine*>::iterator i = elines.begin();
526 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed E-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
530 while ((zlines.size()) && (current > (*zlines.begin())->expiry) && ((*zlines.begin())->duration != 0))
532 std::vector<ZLine*>::iterator i = zlines.begin();
533 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Z-Line %s (set by %s %d seconds ago)",(*i)->ipaddr,(*i)->source,(*i)->duration);
537 while ((klines.size()) && (current > (*klines.begin())->expiry) && ((*klines.begin())->duration != 0))
539 std::vector<KLine*>::iterator i = klines.begin();
540 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed K-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
544 while ((qlines.size()) && (current > (*qlines.begin())->expiry) && ((*qlines.begin())->duration != 0))
546 std::vector<QLine*>::iterator i = qlines.begin();
547 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Q-Line %s (set by %s %d seconds ago)",(*i)->nick,(*i)->source,(*i)->duration);
553 // applies lines, removing clients and changing nicks etc as applicable
555 void XLineManager::apply_lines()
557 int What = 0; // XXX remove me
561 for (std::vector<User*>::const_iterator u2 = ServerInstance->local_users.begin(); u2 != ServerInstance->local_users.end(); u2++)
563 User* u = (User*)(*u2);
567 // ignore people matching exempts
568 if (matches_exception(u))
571 if ((What & APPLY_GLINES) && (glines.size()))
573 if ((check = matches_gline(u)))
575 snprintf(reason,MAXBUF,"G-Lined: %s",check->reason);
576 if (*ServerInstance->Config->MoronBanner)
577 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
578 if (ServerInstance->Config->HideBans)
579 User::QuitUser(ServerInstance, u, "G-Lined", reason);
581 User::QuitUser(ServerInstance, u, reason);
584 if ((What & APPLY_KLINES) && (klines.size()))
586 if ((check = matches_kline(u)))
588 snprintf(reason,MAXBUF,"K-Lined: %s",check->reason);
589 if (*ServerInstance->Config->MoronBanner)
590 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
591 if (ServerInstance->Config->HideBans)
592 User::QuitUser(ServerInstance, u, "K-Lined", reason);
594 User::QuitUser(ServerInstance, u, reason);
597 if ((What & APPLY_QLINES) && (qlines.size()))
599 if ((check = matches_qline(u->nick)))
601 snprintf(reason,MAXBUF,"Q-Lined: %s",check->reason);
602 if (*ServerInstance->Config->MoronBanner)
603 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
604 if (ServerInstance->Config->HideBans)
605 User::QuitUser(ServerInstance, u, "Q-Lined", reason);
607 User::QuitUser(ServerInstance, u, reason);
610 if ((What & APPLY_ZLINES) && (zlines.size()))
612 if ((check = matches_zline(u->GetIPString())))
614 snprintf(reason,MAXBUF,"Z-Lined: %s", check->reason);
615 if (*ServerInstance->Config->MoronBanner)
616 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
617 if (ServerInstance->Config->HideBans)
618 User::QuitUser(ServerInstance, u, "Z-Lined", reason);
620 User::QuitUser(ServerInstance, u, reason);
626 void XLineManager::stats_k(User* user, string_list &results)
628 std::string sn = ServerInstance->Config->ServerName;
629 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
630 results.push_back(sn+" 216 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
633 void XLineManager::stats_g(User* user, string_list &results)
635 std::string sn = ServerInstance->Config->ServerName;
636 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
637 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
640 void XLineManager::stats_q(User* user, string_list &results)
642 std::string sn = ServerInstance->Config->ServerName;
643 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
644 results.push_back(sn+" 217 "+user->nick+" :"+(*i)->nick+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
647 void XLineManager::stats_z(User* user, string_list &results)
649 std::string sn = ServerInstance->Config->ServerName;
650 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
651 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->ipaddr+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
654 void XLineManager::stats_e(User* user, string_list &results)
656 std::string sn = ServerInstance->Config->ServerName;
657 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
658 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
661 XLineManager::XLineManager(InspIRCd* Instance) : ServerInstance(Instance)