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)
139 IdentHostPair XLineManager::IdentSplit(const std::string &ident_and_host)
141 IdentHostPair n = std::make_pair<std::string,std::string>("*","*");
142 std::string::size_type x = ident_and_host.find('@');
143 if (x != std::string::npos)
145 n.second = ident_and_host.substr(x + 1,ident_and_host.length());
146 n.first = ident_and_host.substr(0, x);
147 if (!n.first.length())
149 if (!n.second.length())
150 n.second.assign("*");
154 n.second = ident_and_host;
162 bool XLineManager::AddGLine(long duration, const char* source,const char* reason,const char* hostmask)
164 IdentHostPair ih = IdentSplit(hostmask);
166 if (DelGLine(hostmask, true))
169 GLine* item = new GLine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
171 glines.push_back(item);
172 sort(glines.begin(), glines.end(),XLineManager::XSortComparison);
177 // adds an e:line (exception to bans)
179 bool XLineManager::AddELine(long duration, const char* source, const char* reason, const char* hostmask)
181 IdentHostPair ih = IdentSplit(hostmask);
183 if (DelELine(hostmask, true))
186 ELine* item = new ELine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
188 elines.push_back(item);
189 sort(elines.begin(), elines.end(),XLineManager::XSortComparison);
196 bool XLineManager::AddQLine(long duration, const char* source, const char* reason, const char* nickname)
198 if (DelQLine(nickname, true))
201 QLine* item = new QLine(ServerInstance->Time(), duration, source, reason, nickname);
203 qlines.push_back(item);
204 sort(qlines.begin(), qlines.end(),XLineManager::XSortComparison);
211 bool XLineManager::AddZLine(long duration, const char* source, const char* reason, const char* ipaddr)
213 if (strchr(ipaddr,'@'))
215 while (*ipaddr != '@')
220 if (DelZLine(ipaddr, true))
223 ZLine* item = new ZLine(ServerInstance->Time(), duration, source, reason, ipaddr);
225 zlines.push_back(item);
226 sort(zlines.begin(), zlines.end(),XLineManager::XSortComparison);
233 bool XLineManager::AddKLine(long duration, const char* source, const char* reason, const char* hostmask)
235 IdentHostPair ih = IdentSplit(hostmask);
237 if (DelKLine(hostmask, true))
240 KLine* item = new KLine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());
242 klines.push_back(item);
243 sort(klines.begin(), klines.end(),XLineManager::XSortComparison);
248 // deletes a g:line, returns true if the line existed and was removed
250 bool XLineManager::DelGLine(const char* hostmask, bool simulate)
252 IdentHostPair ih = IdentSplit(hostmask);
253 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
255 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
269 // deletes a e:line, returns true if the line existed and was removed
271 bool XLineManager::DelELine(const char* hostmask, bool simulate)
273 IdentHostPair ih = IdentSplit(hostmask);
274 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
276 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
290 // deletes a q:line, returns true if the line existed and was removed
292 bool XLineManager::DelQLine(const char* nickname, bool simulate)
294 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
296 if (!strcasecmp(nickname,(*i)->nick))
310 // deletes a z:line, returns true if the line existed and was removed
312 bool XLineManager::DelZLine(const char* ipaddr, bool simulate)
314 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
316 if (!strcasecmp(ipaddr,(*i)->ipaddr))
330 // deletes a k:line, returns true if the line existed and was removed
332 bool XLineManager::DelKLine(const char* hostmask, bool simulate)
334 IdentHostPair ih = IdentSplit(hostmask);
335 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
337 if (!strcasecmp(ih.first.c_str(),(*i)->identmask) && !strcasecmp(ih.second.c_str(),(*i)->hostmask))
351 // returns a pointer to the reason if a nickname matches a qline, NULL if it didnt match
353 QLine* XLineManager::matches_qline(const char* nick)
358 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
359 if (match(nick,(*i)->nick))
364 // returns a pointer to the reason if a host matches a gline, NULL if it didnt match
366 GLine* XLineManager::matches_gline(User* user)
371 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
373 if ((match(user->ident,(*i)->identmask)))
375 if ((match(user->host,(*i)->hostmask, true)) || (match(user->GetIPString(),(*i)->hostmask, true)))
385 ELine* XLineManager::matches_exception(User* user)
391 snprintf(host2,MAXBUF,"*@%s",user->host);
392 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
394 if ((match(user->ident,(*i)->identmask)))
396 if ((match(user->host,(*i)->hostmask, true)) || (match(user->GetIPString(),(*i)->hostmask, true)))
406 void XLineManager::gline_set_creation_time(const char* host, time_t create_time)
408 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
410 if (!strcasecmp(host,(*i)->hostmask))
412 (*i)->set_time = create_time;
413 (*i)->expiry = create_time + (*i)->duration;
421 void XLineManager::eline_set_creation_time(const char* host, time_t create_time)
423 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
425 if (!strcasecmp(host,(*i)->hostmask))
427 (*i)->set_time = create_time;
428 (*i)->expiry = create_time + (*i)->duration;
436 void XLineManager::qline_set_creation_time(const char* nick, time_t create_time)
438 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
440 if (!strcasecmp(nick,(*i)->nick))
442 (*i)->set_time = create_time;
443 (*i)->expiry = create_time + (*i)->duration;
451 void XLineManager::zline_set_creation_time(const char* ip, time_t create_time)
453 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
455 if (!strcasecmp(ip,(*i)->ipaddr))
457 (*i)->set_time = create_time;
458 (*i)->expiry = create_time + (*i)->duration;
466 // returns a pointer to the reason if an ip address matches a zline, NULL if it didnt match
468 ZLine* XLineManager::matches_zline(const char* ipaddr)
473 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
474 if (match(ipaddr,(*i)->ipaddr, true))
479 // returns a pointer to the reason if a host matches a kline, NULL if it didnt match
481 KLine* XLineManager::matches_kline(User* user)
486 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
488 if ((match(user->ident,(*i)->identmask)))
490 if ((match(user->host,(*i)->hostmask, true)) || (match(user->GetIPString(),(*i)->hostmask, true)))
500 bool XLineManager::XSortComparison(const XLine *one, const XLine *two)
502 // account for permanent lines
503 if (one->expiry == 0)
507 return (one->expiry) < (two->expiry);
510 // removes lines that have expired
511 void XLineManager::expire_lines()
513 time_t current = ServerInstance->Time();
515 /* Because we now store all our XLines in sorted order using ((*i)->duration + (*i)->set_time) as a key, this
516 * means that to expire the XLines we just need to do a while, picking off the top few until there are
517 * none left at the head of the queue that are after the current time.
520 while ((glines.size()) && (current > (*glines.begin())->expiry) && ((*glines.begin())->duration != 0))
522 std::vector<GLine*>::iterator i = glines.begin();
523 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed G-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
527 while ((elines.size()) && (current > (*elines.begin())->expiry) && ((*elines.begin())->duration != 0))
529 std::vector<ELine*>::iterator i = elines.begin();
530 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed E-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
534 while ((zlines.size()) && (current > (*zlines.begin())->expiry) && ((*zlines.begin())->duration != 0))
536 std::vector<ZLine*>::iterator i = zlines.begin();
537 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Z-Line %s (set by %s %d seconds ago)",(*i)->ipaddr,(*i)->source,(*i)->duration);
541 while ((klines.size()) && (current > (*klines.begin())->expiry) && ((*klines.begin())->duration != 0))
543 std::vector<KLine*>::iterator i = klines.begin();
544 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed K-Line %s@%s (set by %s %d seconds ago)",(*i)->identmask,(*i)->hostmask,(*i)->source,(*i)->duration);
548 while ((qlines.size()) && (current > (*qlines.begin())->expiry) && ((*qlines.begin())->duration != 0))
550 std::vector<QLine*>::iterator i = qlines.begin();
551 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Q-Line %s (set by %s %d seconds ago)",(*i)->nick,(*i)->source,(*i)->duration);
557 // applies lines, removing clients and changing nicks etc as applicable
559 void XLineManager::ApplyLines()
561 int What = 0; // XXX remove me
565 for (std::vector<User*>::const_iterator u2 = ServerInstance->local_users.begin(); u2 != ServerInstance->local_users.end(); u2++)
567 User* u = (User*)(*u2);
571 // ignore people matching exempts
572 if (matches_exception(u))
575 if ((What & APPLY_GLINES) && (glines.size()))
577 if ((check = matches_gline(u)))
579 snprintf(reason,MAXBUF,"G-Lined: %s",check->reason);
580 if (*ServerInstance->Config->MoronBanner)
581 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
582 if (ServerInstance->Config->HideBans)
583 User::QuitUser(ServerInstance, u, "G-Lined", reason);
585 User::QuitUser(ServerInstance, u, reason);
588 if ((What & APPLY_KLINES) && (klines.size()))
590 if ((check = matches_kline(u)))
592 snprintf(reason,MAXBUF,"K-Lined: %s",check->reason);
593 if (*ServerInstance->Config->MoronBanner)
594 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
595 if (ServerInstance->Config->HideBans)
596 User::QuitUser(ServerInstance, u, "K-Lined", reason);
598 User::QuitUser(ServerInstance, u, reason);
601 if ((What & APPLY_QLINES) && (qlines.size()))
603 if ((check = matches_qline(u->nick)))
605 snprintf(reason,MAXBUF,"Q-Lined: %s",check->reason);
606 if (*ServerInstance->Config->MoronBanner)
607 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
608 if (ServerInstance->Config->HideBans)
609 User::QuitUser(ServerInstance, u, "Q-Lined", reason);
611 User::QuitUser(ServerInstance, u, reason);
614 if ((What & APPLY_ZLINES) && (zlines.size()))
616 if ((check = matches_zline(u->GetIPString())))
618 snprintf(reason,MAXBUF,"Z-Lined: %s", check->reason);
619 if (*ServerInstance->Config->MoronBanner)
620 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
621 if (ServerInstance->Config->HideBans)
622 User::QuitUser(ServerInstance, u, "Z-Lined", reason);
624 User::QuitUser(ServerInstance, u, reason);
630 void XLineManager::stats_k(User* user, string_list &results)
632 std::string sn = ServerInstance->Config->ServerName;
633 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
634 results.push_back(sn+" 216 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
637 void XLineManager::stats_g(User* user, string_list &results)
639 std::string sn = ServerInstance->Config->ServerName;
640 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
641 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
644 void XLineManager::stats_q(User* user, string_list &results)
646 std::string sn = ServerInstance->Config->ServerName;
647 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
648 results.push_back(sn+" 217 "+user->nick+" :"+(*i)->nick+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
651 void XLineManager::stats_z(User* user, string_list &results)
653 std::string sn = ServerInstance->Config->ServerName;
654 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
655 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->ipaddr+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
658 void XLineManager::stats_e(User* user, string_list &results)
660 std::string sn = ServerInstance->Config->ServerName;
661 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
662 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);
665 XLineManager::XLineManager(InspIRCd* Instance) : ServerInstance(Instance)