1 /* +------------------------------------+
2 * | Inspire Internet Relay Chat Daemon |
3 * +------------------------------------+
5 * InspIRCd: (C) 2002-2008 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 * ---------------------------------------------------
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. They are stored in
40 * a map of maps (first map is line type, second map is for quick lookup on add/delete/etc).
42 * Expiry is *no longer* performed on a timer, and no longer uses a sorted list of any variety. This
43 * is now done by only checking for expiry when a line is accessed, meaning that expiry is no longer
44 * a resource intensive problem.
46 * Application no longer tries to apply every single line on every single user - instead, now only lines
47 * added since the previous application are applied. This keeps S2S ADDLINE during burst nice and fast,
48 * while at the same time not slowing things the fuck down when we try adding a ban with lots of preexisting
52 bool XLine::Matches(User *u)
58 * Checks what users match a given vector of ELines and sets their ban exempt flag accordingly.
60 void XLineManager::CheckELines()
62 ContainerIter n = lookup_lines.find("E");
64 if (n == lookup_lines.end())
67 XLineLookup& ELines = n->second;
72 for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
74 User* u = (User*)(*u2);
76 /* This uses safe iteration to ensure that if a line expires here, it doenst trash the iterator */
79 for (LookupIter i = ELines.begin(); i != ELines.end(); )
85 u->exempt = e->Matches(u);
93 XLineLookup* XLineManager::GetAll(const std::string &type)
95 ContainerIter n = lookup_lines.find(type);
97 if (n == lookup_lines.end())
101 const time_t current = ServerInstance->Time();
103 /* Expire any dead ones, before sending */
104 for (LookupIter x = n->second.begin(); x != n->second.end(); )
108 if (x->second->duration && current > x->second->expiry)
118 void XLineManager::DelAll(const std::string &type)
120 ContainerIter n = lookup_lines.find(type);
122 if (n == lookup_lines.end())
127 /* Delete all of a given type (this should probably use DelLine, but oh well) */
128 while ((x = n->second.begin()) != n->second.end())
134 std::vector<std::string> XLineManager::GetAllTypes()
136 std::vector<std::string> items;
137 for (ContainerIter x = lookup_lines.begin(); x != lookup_lines.end(); ++x)
138 items.push_back(x->first);
142 IdentHostPair XLineManager::IdentSplit(const std::string &ident_and_host)
144 IdentHostPair n = std::make_pair<std::string,std::string>("*","*");
145 std::string::size_type x = ident_and_host.find('@');
146 if (x != std::string::npos)
148 n.second = ident_and_host.substr(x + 1,ident_and_host.length());
149 n.first = ident_and_host.substr(0, x);
150 if (!n.first.length())
152 if (!n.second.length())
153 n.second.assign("*");
158 n.second = ident_and_host;
166 bool XLineManager::AddLine(XLine* line, User* user)
168 ServerInstance->BanCache->RemoveEntries(line->type, false); // XXX perhaps remove ELines here?
170 /* If the line exists, check if its an expired line */
171 ContainerIter x = lookup_lines.find(line->type);
172 if (x != lookup_lines.end())
174 LookupIter i = x->second.find(line->Displayable());
175 if (i != x->second.end())
177 if (i->second->duration && ServerInstance->Time() > i->second->expiry)
184 /*ELine* item = new ELine(ServerInstance, ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());*/
185 XLineFactory* xlf = GetFactory(line->type);
189 if (xlf->AutoApplyToUserList(line))
190 pending_lines.push_back(line);
192 lookup_lines[line->type][line->Displayable()] = line;
195 FOREACH_MOD(I_OnAddLine,OnAddLine(user, line));
200 // deletes a line, returns true if the line existed and was removed
202 bool XLineManager::DelLine(const char* hostmask, const std::string &type, User* user, bool simulate)
204 ContainerIter x = lookup_lines.find(type);
206 if (x == lookup_lines.end())
209 LookupIter y = x->second.find(hostmask);
211 if (y == x->second.end())
217 ServerInstance->BanCache->RemoveEntries(y->second->type, true);
219 FOREACH_MOD(I_OnDelLine,OnDelLine(user, y->second));
223 std::vector<XLine*>::iterator pptr = std::find(pending_lines.begin(), pending_lines.end(), y->second);
224 if (pptr != pending_lines.end())
225 pending_lines.erase(pptr);
236 /* remove exempt from everyone and force recheck after deleting eline */
237 for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
239 User* u = (User*)(*u2);
243 ServerInstance->XLines->CheckELines();
246 // returns a pointer to the reason if a nickname matches a qline, NULL if it didnt match
248 XLine* XLineManager::MatchesLine(const std::string &type, User* user)
250 ContainerIter x = lookup_lines.find(type);
252 if (x == lookup_lines.end())
255 const time_t current = ServerInstance->Time();
259 for (LookupIter i = x->second.begin(); i != x->second.end(); )
264 if (i->second->Matches(user))
266 if (i->second->duration && current > i->second->expiry)
268 /* Expire the line, return nothing */
270 /* Continue, there may be another that matches
285 XLine* XLineManager::MatchesLine(const std::string &type, const std::string &pattern)
287 ContainerIter x = lookup_lines.find(type);
289 if (x == lookup_lines.end())
292 const time_t current = ServerInstance->Time();
296 for (LookupIter i = x->second.begin(); i != x->second.end(); )
301 if (i->second->Matches(pattern))
303 if (i->second->duration && current > i->second->expiry)
305 /* Expire the line, return nothing */
320 // removes lines that have expired
321 void XLineManager::ExpireLine(ContainerIter container, LookupIter item)
323 FOREACH_MOD(I_OnExpireLine, OnExpireLine(item->second));
325 item->second->DisplayExpiry();
326 item->second->Unset();
328 /* TODO: Can we skip this loop by having a 'pending' field in the XLine class, which is set when a line
329 * is pending, cleared when it is no longer pending, so we skip over this loop if its not pending?
332 std::vector<XLine*>::iterator pptr = std::find(pending_lines.begin(), pending_lines.end(), item->second);
333 if (pptr != pending_lines.end())
334 pending_lines.erase(pptr);
337 container->second.erase(item);
341 // applies lines, removing clients and changing nicks etc as applicable
342 void XLineManager::ApplyLines()
344 for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
346 User* u = (User*)(*u2);
348 for (std::vector<XLine *>::iterator i = pending_lines.begin(); i != pending_lines.end(); i++)
356 pending_lines.clear();
359 void XLineManager::InvokeStats(const std::string &type, int numeric, User* user, string_list &results)
361 std::string sn = ServerInstance->Config->ServerName;
363 ContainerIter n = lookup_lines.find(type);
365 time_t current = ServerInstance->Time();
369 if (n != lookup_lines.end())
371 XLineLookup& list = n->second;
372 for (LookupIter i = list.begin(); i != list.end(); )
377 if (i->second->duration && current > i->second->expiry)
382 results.push_back(sn+" "+ConvToStr(numeric)+" "+user->nick+" :"+i->second->Displayable()+" "+
383 ConvToStr(i->second->set_time)+" "+ConvToStr(i->second->duration)+" "+std::string(i->second->source)+" :"+(i->second->reason));
390 XLineManager::XLineManager(InspIRCd* Instance) : ServerInstance(Instance)
392 GFact = new GLineFactory(Instance);
393 EFact = new ELineFactory(Instance);
394 KFact = new KLineFactory(Instance);
395 QFact = new QLineFactory(Instance);
396 ZFact = new ZLineFactory(Instance);
398 RegisterFactory(GFact);
399 RegisterFactory(EFact);
400 RegisterFactory(KFact);
401 RegisterFactory(QFact);
402 RegisterFactory(ZFact);
405 XLineManager::~XLineManager()
407 UnregisterFactory(GFact);
408 UnregisterFactory(EFact);
409 UnregisterFactory(KFact);
410 UnregisterFactory(QFact);
411 UnregisterFactory(ZFact);
419 // Delete all existing XLines
420 for (XLineContainer::iterator i = lookup_lines.begin(); i != lookup_lines.end(); i++)
422 for (XLineLookup::iterator j = i->second.begin(); j != i->second.end(); j++)
428 lookup_lines.clear();
432 void XLine::Apply(User* u)
436 bool XLine::IsBurstable()
441 void XLine::DefaultApply(User* u, const std::string &line, bool bancache)
443 char sreason[MAXBUF];
444 snprintf(sreason, MAXBUF, "%s-Lined: %s", line.c_str(), this->reason);
445 if (*ServerInstance->Config->MoronBanner)
446 u->WriteServ("NOTICE %s :*** %s", u->nick.c_str(), ServerInstance->Config->MoronBanner);
448 if (ServerInstance->Config->HideBans)
449 ServerInstance->Users->QuitUser(u, line + "-Lined", sreason);
451 ServerInstance->Users->QuitUser(u, sreason);
456 ServerInstance->Logs->Log("BANCACHE", DEBUG, std::string("BanCache: Adding positive hit (") + line + ") for " + u->GetIPString());
457 if (this->duration > 0)
458 ServerInstance->BanCache->AddHit(u->GetIPString(), this->type, line + "-Lined: " + this->reason, this->duration);
460 ServerInstance->BanCache->AddHit(u->GetIPString(), this->type, line + "-Lined: " + this->reason);
464 bool KLine::Matches(User *u)
469 if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
471 if (InspIRCd::MatchCIDR(u->host, this->hostmask, ascii_case_insensitive_map) ||
472 InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
481 void KLine::Apply(User* u)
483 DefaultApply(u, "K", (strcmp(this->identmask, "*") == 0) ? true : false);
486 bool GLine::Matches(User *u)
491 if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
493 if (InspIRCd::MatchCIDR(u->host, this->hostmask, ascii_case_insensitive_map) ||
494 InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
503 void GLine::Apply(User* u)
505 DefaultApply(u, "G", (strcmp(this->identmask, "*") == 0) ? true : false);
508 bool ELine::Matches(User *u)
513 if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
515 if (InspIRCd::MatchCIDR(u->host, this->hostmask, ascii_case_insensitive_map) ||
516 InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
525 bool ZLine::Matches(User *u)
530 if (InspIRCd::MatchCIDR(u->GetIPString(), this->ipaddr))
536 void ZLine::Apply(User* u)
538 DefaultApply(u, "Z", true);
542 bool QLine::Matches(User *u)
544 if (InspIRCd::Match(u->nick, this->nick))
550 void QLine::Apply(User* u)
552 /* Force to uuid on apply of qline, no need to disconnect any more :) */
553 u->ForceNickChange(u->uuid.c_str());
557 bool ZLine::Matches(const std::string &str)
559 if (InspIRCd::MatchCIDR(str, this->ipaddr))
565 bool QLine::Matches(const std::string &str)
567 if (InspIRCd::Match(str, this->nick))
573 bool ELine::Matches(const std::string &str)
575 return (InspIRCd::MatchCIDR(str, matchtext));
578 bool KLine::Matches(const std::string &str)
580 return (InspIRCd::MatchCIDR(str.c_str(), matchtext));
583 bool GLine::Matches(const std::string &str)
585 return (InspIRCd::MatchCIDR(str, matchtext));
590 /* When adding one eline, only check the one eline */
591 for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
593 User* u = (User*)(*u2);
594 if (this->Matches(u))
599 void ELine::DisplayExpiry()
601 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed E-Line %s@%s (set by %s %ld seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
604 void QLine::DisplayExpiry()
606 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Q-Line %s (set by %s %ld seconds ago)",this->nick,this->source,this->duration);
609 void ZLine::DisplayExpiry()
611 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Z-Line %s (set by %s %ld seconds ago)",this->ipaddr,this->source,this->duration);
614 void KLine::DisplayExpiry()
616 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed K-Line %s@%s (set by %s %ld seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
619 void GLine::DisplayExpiry()
621 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed G-Line %s@%s (set by %s %ld seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
624 const char* ELine::Displayable()
626 return matchtext.c_str();
629 const char* KLine::Displayable()
631 return matchtext.c_str();
634 const char* GLine::Displayable()
636 return matchtext.c_str();
639 const char* ZLine::Displayable()
644 const char* QLine::Displayable()
649 bool KLine::IsBurstable()
654 bool XLineManager::RegisterFactory(XLineFactory* xlf)
656 XLineFactMap::iterator n = line_factory.find(xlf->GetType());
658 if (n != line_factory.end())
661 line_factory[xlf->GetType()] = xlf;
666 bool XLineManager::UnregisterFactory(XLineFactory* xlf)
668 XLineFactMap::iterator n = line_factory.find(xlf->GetType());
670 if (n == line_factory.end())
673 line_factory.erase(n);
678 XLineFactory* XLineManager::GetFactory(const std::string &type)
680 XLineFactMap::iterator n = line_factory.find(type);
682 if (n == line_factory.end())