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->ApplyLines();
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->ApplyLines();
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->ApplyLines();
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->ApplyLines();
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->AddZLine(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->AddQLine(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->AddKLine(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->AddELine(0,"<Config>",reason,host);
135 bool XLine::Matches(User *u)
140 IdentHostPair XLineManager::IdentSplit(const std::string &ident_and_host)
142 IdentHostPair n = std::make_pair<std::string,std::string>("*","*");
143 std::string::size_type x = ident_and_host.find('@');
144 if (x != std::string::npos)
146 n.second = ident_and_host.substr(x + 1,ident_and_host.length());
147 n.first = ident_and_host.substr(0, x);
148 if (!n.first.length())
150 if (!n.second.length())
151 n.second.assign("*");
155 n.second = ident_and_host;
163 bool XLineManager::AddGLine(long duration, const char* source,const char* reason,const char* hostmask)
165 IdentHostPair ih = IdentSplit(hostmask);
167 if (DelGLine(hostmask, true))
170 GLine* item = new GLine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
172 glines.push_back(item);
173 sort(glines.begin(), glines.end(),XLineManager::XSortComparison);
178 // adds an e:line (exception to bans)
180 bool XLineManager::AddELine(long duration, const char* source, const char* reason, const char* hostmask)
182 IdentHostPair ih = IdentSplit(hostmask);
184 if (DelELine(hostmask, true))
187 ELine* item = new ELine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
189 elines.push_back(item);
190 sort(elines.begin(), elines.end(),XLineManager::XSortComparison);
197 bool XLineManager::AddQLine(long duration, const char* source, const char* reason, const char* nickname)
199 if (DelQLine(nickname, true))
202 QLine* item = new QLine(ServerInstance->Time(), duration, source, reason, nickname);
204 qlines.push_back(item);
205 sort(qlines.begin(), qlines.end(),XLineManager::XSortComparison);
212 bool XLineManager::AddZLine(long duration, const char* source, const char* reason, const char* ipaddr)
214 if (strchr(ipaddr,'@'))
216 while (*ipaddr != '@')
221 if (DelZLine(ipaddr, true))
224 ZLine* item = new ZLine(ServerInstance->Time(), duration, source, reason, ipaddr);
226 zlines.push_back(item);
227 sort(zlines.begin(), zlines.end(),XLineManager::XSortComparison);
234 bool XLineManager::AddKLine(long duration, const char* source, const char* reason, const char* hostmask)
236 IdentHostPair ih = IdentSplit(hostmask);
238 if (DelKLine(hostmask, true))
241 KLine* item = new KLine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
243 klines.push_back(item);
244 sort(klines.begin(), klines.end(),XLineManager::XSortComparison);
249 // deletes a g:line, returns true if the line existed and was removed
251 bool XLineManager::DelGLine(const char* hostmask, bool simulate)
253 IdentHostPair ih = IdentSplit(hostmask);
254 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
256 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
270 // deletes a e:line, returns true if the line existed and was removed
272 bool XLineManager::DelELine(const char* hostmask, bool simulate)
274 IdentHostPair ih = IdentSplit(hostmask);
275 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
277 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
291 // deletes a q:line, returns true if the line existed and was removed
293 bool XLineManager::DelQLine(const char* nickname, bool simulate)
295 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
297 if (!strcasecmp(nickname,(*i)->nick))
311 // deletes a z:line, returns true if the line existed and was removed
313 bool XLineManager::DelZLine(const char* ipaddr, bool simulate)
315 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
317 if (!strcasecmp(ipaddr,(*i)->ipaddr))
331 // deletes a k:line, returns true if the line existed and was removed
333 bool XLineManager::DelKLine(const char* hostmask, bool simulate)
335 IdentHostPair ih = IdentSplit(hostmask);
336 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
338 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
352 // returns a pointer to the reason if a nickname matches a qline, NULL if it didnt match
354 QLine* XLineManager::matches_qline(const char* nick)
359 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
360 if ((*i)->Matches(user))
365 // returns a pointer to the reason if a host matches a gline, NULL if it didnt match
367 GLine* XLineManager::matches_gline(User* user)
372 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
374 if ((*i)->Matches(user))
381 ELine* XLineManager::matches_exception(User* user)
386 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
388 if ((*i)->Matches(user))
395 void XLineManager::gline_set_creation_time(const char* host, time_t create_time)
397 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
399 if (!strcasecmp(host,(*i)->hostmask))
401 (*i)->set_time = create_time;
402 (*i)->expiry = create_time + (*i)->duration;
410 void XLineManager::eline_set_creation_time(const char* host, time_t create_time)
412 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
414 if (!strcasecmp(host,(*i)->hostmask))
416 (*i)->set_time = create_time;
417 (*i)->expiry = create_time + (*i)->duration;
425 void XLineManager::qline_set_creation_time(const char* nick, time_t create_time)
427 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
429 if (!strcasecmp(nick,(*i)->nick))
431 (*i)->set_time = create_time;
432 (*i)->expiry = create_time + (*i)->duration;
440 void XLineManager::zline_set_creation_time(const char* ip, time_t create_time)
442 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
444 if (!strcasecmp(ip,(*i)->ipaddr))
446 (*i)->set_time = create_time;
447 (*i)->expiry = create_time + (*i)->duration;
455 // returns a pointer to the reason if an ip address matches a zline, NULL if it didnt match
457 ZLine* XLineManager::matches_zline(User *u)
462 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
463 if ((*i)->Matches(u))
468 // returns a pointer to the reason if a host matches a kline, NULL if it didnt match
470 KLine* XLineManager::matches_kline(User* user)
475 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
477 if ((*i)->Matches(user))
484 bool XLineManager::XSortComparison(const XLine *one, const XLine *two)
486 // account for permanent lines
487 if (one->expiry == 0)
491 return (one->expiry) < (two->expiry);
494 // removes lines that have expired
495 void XLineManager::expire_lines()
497 time_t current = ServerInstance->Time();
499 /* Because we now store all our XLines in sorted order using ((*i)->duration + (*i)->set_time) as a key, this
500 * means that to expire the XLines we just need to do a while, picking off the top few until there are
501 * none left at the head of the queue that are after the current time.
504 while ((glines.size()) && (current > (*glines.begin())->expiry) && ((*glines.begin())->duration != 0))
506 std::vector<GLine*>::iterator i = glines.begin();
507 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed G-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
511 while ((elines.size()) && (current > (*elines.begin())->expiry) && ((*elines.begin())->duration != 0))
513 std::vector<ELine*>::iterator i = elines.begin();
514 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed E-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
518 while ((zlines.size()) && (current > (*zlines.begin())->expiry) && ((*zlines.begin())->duration != 0))
520 std::vector<ZLine*>::iterator i = zlines.begin();
521 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Z-Line %s (set by %s %d seconds ago)",(*i)->ipaddr,(*i)->source,(*i)->duration);
525 while ((klines.size()) && (current > (*klines.begin())->expiry) && ((*klines.begin())->duration != 0))
527 std::vector<KLine*>::iterator i = klines.begin();
528 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed K-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
532 while ((qlines.size()) && (current > (*qlines.begin())->expiry) && ((*qlines.begin())->duration != 0))
534 std::vector<QLine*>::iterator i = qlines.begin();
535 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Q-Line %s (set by %s %d seconds ago)",(*i)->nick,(*i)->source,(*i)->duration);
541 // applies lines, removing clients and changing nicks etc as applicable
543 void XLineManager::ApplyLines()
545 int What = 0; // XXX remove me
549 for (std::vector<User*>::const_iterator u2 = ServerInstance->local_users.begin(); u2 != ServerInstance->local_users.end(); u2++)
551 User* u = (User*)(*u2);
555 // ignore people matching exempts
556 if (matches_exception(u))
559 if ((What & APPLY_GLINES) && (glines.size()))
561 if ((check = matches_gline(u)))
563 snprintf(reason,MAXBUF,"G-Lined: %s",check->reason);
564 if (*ServerInstance->Config->MoronBanner)
565 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
566 if (ServerInstance->Config->HideBans)
567 User::QuitUser(ServerInstance, u, "G-Lined", reason);
569 User::QuitUser(ServerInstance, u, reason);
572 if ((What & APPLY_KLINES) && (klines.size()))
574 if ((check = matches_kline(u)))
576 snprintf(reason,MAXBUF,"K-Lined: %s",check->reason);
577 if (*ServerInstance->Config->MoronBanner)
578 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
579 if (ServerInstance->Config->HideBans)
580 User::QuitUser(ServerInstance, u, "K-Lined", reason);
582 User::QuitUser(ServerInstance, u, reason);
585 if ((What & APPLY_QLINES) && (qlines.size()))
587 if ((check = matches_qline(u->nick)))
589 snprintf(reason,MAXBUF,"Q-Lined: %s",check->reason);
590 if (*ServerInstance->Config->MoronBanner)
591 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
592 if (ServerInstance->Config->HideBans)
593 User::QuitUser(ServerInstance, u, "Q-Lined", reason);
595 User::QuitUser(ServerInstance, u, reason);
598 if ((What & APPLY_ZLINES) && (zlines.size()))
600 if ((check = matches_zline(u)))
602 snprintf(reason,MAXBUF,"Z-Lined: %s", check->reason);
603 if (*ServerInstance->Config->MoronBanner)
604 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
605 if (ServerInstance->Config->HideBans)
606 User::QuitUser(ServerInstance, u, "Z-Lined", reason);
608 User::QuitUser(ServerInstance, u, reason);
614 void XLineManager::stats_k(User* user, string_list &results)
616 std::string sn = ServerInstance->Config->ServerName;
617 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
618 results.push_back(sn+" 216 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
621 void XLineManager::stats_g(User* user, string_list &results)
623 std::string sn = ServerInstance->Config->ServerName;
624 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
625 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
628 void XLineManager::stats_q(User* user, string_list &results)
630 std::string sn = ServerInstance->Config->ServerName;
631 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
632 results.push_back(sn+" 217 "+user->nick+" :"+(*i)->nick+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
635 void XLineManager::stats_z(User* user, string_list &results)
637 std::string sn = ServerInstance->Config->ServerName;
638 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
639 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->ipaddr+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
642 void XLineManager::stats_e(User* user, string_list &results)
644 std::string sn = ServerInstance->Config->ServerName;
645 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
646 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
649 XLineManager::XLineManager(InspIRCd* Instance) : ServerInstance(Instance)
655 bool KLine::Matches(User *u)
657 if ((match(u->ident, this->identmask)))
659 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
668 bool GLine::Matches(User *u)
670 if ((match(u->ident, this->identmask)))
672 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
681 bool ELine::Matches(User *u)
683 if ((match(u->ident, this->identmask)))
685 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
694 bool ZLine::Matches(User *u)
696 if (match(u->GetIPString(), this->ipaddr, true))
702 bool QLine::Matches(User *u)
704 if (match(user->nick, this->nick))