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 * ---------------------------------------------------
14 /* $Core: libIRCDxline */
22 * This is now version 3 of the XLine subsystem, let's see if we can get it as nice and
23 * efficient as we can this time so we can close this file and never ever touch it again ..
26 * Version 1 stored all line types in one list (one for g, one for z, etc). This was fine,
27 * but both version 1 and 2 suck at applying lines efficiently. That is, every time a new line
28 * was added, it iterated every existing line for every existing user. Ow. Expiry was also
29 * expensive, as the lists were NOT sorted.
31 * Version 2 moved permanent lines into a seperate list from non-permanent to help optimize
32 * matching speed, but matched in the same way.
33 * Expiry was also sped up by sorting the list by expiry (meaning just remove the items at the
34 * head of the list that are outdated.)
36 * This was fine and good, but it looked less than ideal in code, and matching was still slower
37 * than it could have been, something which we address here.
40 * All lines are (as in v1) stored together -- no seperation of perm and non-perm. They are stored in
41 * a map of maps (first map is line type, second map is for quick lookup on add/delete/etc).
43 * Expiry is *no longer* performed on a timer, and no longer uses a sorted list of any variety. This
44 * is now done by only checking for expiry when a line is accessed, meaning that expiry is no longer
45 * a resource intensive problem.
47 * Application no longer tries to apply every single line on every single user - instead, now only lines
48 * added since the previous application are applied. This keeps S2S ADDLINE during burst nice and fast,
49 * while at the same time not slowing things the fuck down when we try adding a ban with lots of preexisting
53 bool XLine::Matches(User *u)
59 * Checks what users match a given vector of ELines and sets their ban exempt flag accordingly.
61 void XLineManager::CheckELines()
63 ContainerIter n = lookup_lines.find("E");
65 if (n == lookup_lines.end())
68 XLineLookup& ELines = n->second;
73 for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
75 User* u = (User*)(*u2);
77 /* This uses safe iteration to ensure that if a line expires here, it doenst trash the iterator */
80 for (LookupIter i = ELines.begin(); i != ELines.end(); )
86 u->exempt = e->Matches(u);
94 XLineLookup* XLineManager::GetAll(const std::string &type)
96 ContainerIter n = lookup_lines.find(type);
98 if (n == lookup_lines.end())
102 const time_t current = ServerInstance->Time();
104 /* Expire any dead ones, before sending */
105 for (LookupIter x = n->second.begin(); x != n->second.end(); )
109 if (x->second->duration && current > x->second->expiry)
119 std::vector<std::string> XLineManager::GetAllTypes()
121 std::vector<std::string> items;
122 for (ContainerIter x = lookup_lines.begin(); x != lookup_lines.end(); ++x)
123 items.push_back(x->first);
127 IdentHostPair XLineManager::IdentSplit(const std::string &ident_and_host)
129 IdentHostPair n = std::make_pair<std::string,std::string>("*","*");
130 std::string::size_type x = ident_and_host.find('@');
131 if (x != std::string::npos)
133 n.second = ident_and_host.substr(x + 1,ident_and_host.length());
134 n.first = ident_and_host.substr(0, x);
135 if (!n.first.length())
137 if (!n.second.length())
138 n.second.assign("*");
142 n.second = ident_and_host;
150 bool XLineManager::AddLine(XLine* line, User* user)
152 /*IdentHostPair ih = IdentSplit(hostmask);*/
154 ServerInstance->BanCache->RemoveEntries(line->type, false); // XXX perhaps remove ELines here?
156 if (DelLine(line->Displayable(), line->type, user, true))
159 /*ELine* item = new ELine(ServerInstance, ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());*/
160 pending_lines.push_back(line);
161 lookup_lines[line->type][line->Displayable()] = line;
164 FOREACH_MOD(I_OnAddLine,OnAddLine(user, line));
169 // deletes a line, returns true if the line existed and was removed
171 bool XLineManager::DelLine(const char* hostmask, const std::string &type, User* user, bool simulate)
173 ContainerIter x = lookup_lines.find(type);
175 if (x == lookup_lines.end())
178 LookupIter y = x->second.find(hostmask);
180 if (y == x->second.end())
186 ServerInstance->BanCache->RemoveEntries(y->second->type, true);
188 FOREACH_MOD(I_OnDelLine,OnDelLine(user, y->second));
192 std::vector<XLine*>::iterator pptr = std::find(pending_lines.begin(), pending_lines.end(), y->second);
193 if (pptr != pending_lines.end())
194 pending_lines.erase(pptr);
205 /* remove exempt from everyone and force recheck after deleting eline */
206 for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
208 User* u = (User*)(*u2);
212 ServerInstance->XLines->CheckELines();
215 // returns a pointer to the reason if a nickname matches a qline, NULL if it didnt match
217 XLine* XLineManager::MatchesLine(const std::string &type, User* user)
219 ContainerIter x = lookup_lines.find(type);
221 if (x == lookup_lines.end())
224 const time_t current = ServerInstance->Time();
228 for (LookupIter i = x->second.begin(); i != x->second.end(); )
233 if (i->second->Matches(user))
235 if (i->second->duration && current > i->second->expiry)
237 /* Expire the line, return nothing */
239 /* Continue, there may be another that matches
254 XLine* XLineManager::MatchesLine(const std::string &type, const std::string &pattern)
256 ContainerIter x = lookup_lines.find(type);
258 if (x == lookup_lines.end())
261 const time_t current = ServerInstance->Time();
265 for (LookupIter i = x->second.begin(); i != x->second.end(); )
270 if (i->second->Matches(pattern))
272 if (i->second->duration && current > i->second->expiry)
274 /* Expire the line, return nothing */
289 // removes lines that have expired
290 void XLineManager::ExpireLine(ContainerIter container, LookupIter item)
292 FOREACH_MOD(I_OnExpireLine, OnExpireLine(item->second));
294 item->second->DisplayExpiry();
295 item->second->Unset();
297 /* TODO: Can we skip this loop by having a 'pending' field in the XLine class, which is set when a line
298 * is pending, cleared when it is no longer pending, so we skip over this loop if its not pending?
301 std::vector<XLine*>::iterator pptr = std::find(pending_lines.begin(), pending_lines.end(), item->second);
302 if (pptr != pending_lines.end())
303 pending_lines.erase(pptr);
306 container->second.erase(item);
310 // applies lines, removing clients and changing nicks etc as applicable
311 void XLineManager::ApplyLines()
313 for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
315 User* u = (User*)(*u2);
317 for (std::vector<XLine *>::iterator i = pending_lines.begin(); i != pending_lines.end(); i++)
325 pending_lines.clear();
328 void XLineManager::InvokeStats(const std::string &type, int numeric, User* user, string_list &results)
330 std::string sn = ServerInstance->Config->ServerName;
332 ContainerIter n = lookup_lines.find(type);
334 time_t current = ServerInstance->Time();
338 if (n != lookup_lines.end())
340 XLineLookup& list = n->second;
341 for (LookupIter i = list.begin(); i != list.end(); )
346 if (i->second->duration && current > i->second->expiry)
351 results.push_back(sn+" "+ConvToStr(numeric)+" "+user->nick+" :"+i->second->Displayable()+" "+
352 ConvToStr(i->second->set_time)+" "+ConvToStr(i->second->duration)+" "+std::string(i->second->source)+" :"+(i->second->reason));
359 XLineManager::XLineManager(InspIRCd* Instance) : ServerInstance(Instance)
361 GFact = new GLineFactory(Instance);
362 EFact = new ELineFactory(Instance);
363 KFact = new KLineFactory(Instance);
364 QFact = new QLineFactory(Instance);
365 ZFact = new ZLineFactory(Instance);
367 RegisterFactory(GFact);
368 RegisterFactory(EFact);
369 RegisterFactory(KFact);
370 RegisterFactory(QFact);
371 RegisterFactory(ZFact);
374 XLineManager::~XLineManager()
376 UnregisterFactory(GFact);
377 UnregisterFactory(EFact);
378 UnregisterFactory(KFact);
379 UnregisterFactory(QFact);
380 UnregisterFactory(ZFact);
389 void XLine::Apply(User* u)
393 void XLine::DefaultApply(User* u, const std::string &line, bool bancache)
396 snprintf(reason, MAXBUF, "%s-Lined: %s", line.c_str(), this->reason);
397 if (*ServerInstance->Config->MoronBanner)
398 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
399 if (ServerInstance->Config->HideBans)
400 User::QuitUser(ServerInstance, u, line + "-Lined", reason);
402 User::QuitUser(ServerInstance, u, reason);
407 ServerInstance->Log(DEBUG, std::string("BanCache: Adding positive hit (") + line + ") for " + u->GetIPString());
408 ServerInstance->BanCache->AddHit(u->GetIPString(), this->type, line + "-Lined: " + this->reason);
412 bool KLine::Matches(User *u)
417 if ((match(u->ident, this->identmask)))
419 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
428 void KLine::Apply(User* u)
430 DefaultApply(u, "K", (strcmp(this->identmask, "*") == 0) ? true : false);
433 bool GLine::Matches(User *u)
438 if ((match(u->ident, this->identmask)))
440 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
449 void GLine::Apply(User* u)
451 DefaultApply(u, "G", (strcmp(this->identmask, "*") == 0) ? true : false);
454 bool ELine::Matches(User *u)
459 if ((match(u->ident, this->identmask)))
461 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
470 bool ZLine::Matches(User *u)
475 if (match(u->GetIPString(), this->ipaddr, true))
481 void ZLine::Apply(User* u)
483 DefaultApply(u, "Z", true);
487 bool QLine::Matches(User *u)
492 if (match(u->nick, this->nick))
498 void QLine::Apply(User* u)
500 /* Force to uuid on apply of qline, no need to disconnect any more :) */
501 u->ForceNickChange(u->uuid);
505 bool ZLine::Matches(const std::string &str)
507 if (match(str.c_str(), this->ipaddr, true))
513 bool QLine::Matches(const std::string &str)
515 if (match(str.c_str(), this->nick))
521 bool ELine::Matches(const std::string &str)
523 return ((match(str.c_str(), matchtext.c_str(), true)));
526 bool KLine::Matches(const std::string &str)
528 return ((match(str.c_str(), matchtext.c_str(), true)));
531 bool GLine::Matches(const std::string &str)
533 return ((match(str.c_str(), matchtext.c_str(), true)));
538 /* When adding one eline, only check the one eline */
539 for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
541 User* u = (User*)(*u2);
542 if (this->Matches(u))
547 void ELine::DisplayExpiry()
549 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed E-Line %s@%s (set by %s %d seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
552 void QLine::DisplayExpiry()
554 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Q-Line %s (set by %s %d seconds ago)",this->nick,this->source,this->duration);
557 void ZLine::DisplayExpiry()
559 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Z-Line %s (set by %s %d seconds ago)",this->ipaddr,this->source,this->duration);
562 void KLine::DisplayExpiry()
564 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed K-Line %s@%s (set by %s %d seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
567 void GLine::DisplayExpiry()
569 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed G-Line %s@%s (set by %s %d seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
572 const char* ELine::Displayable()
574 return matchtext.c_str();
577 const char* KLine::Displayable()
579 return matchtext.c_str();
582 const char* GLine::Displayable()
584 return matchtext.c_str();
587 const char* ZLine::Displayable()
592 const char* QLine::Displayable()
597 bool XLineManager::RegisterFactory(XLineFactory* xlf)
599 XLineFactMap::iterator n = line_factory.find(xlf->GetType());
601 if (n != line_factory.end())
604 line_factory[xlf->GetType()] = xlf;
609 bool XLineManager::UnregisterFactory(XLineFactory* xlf)
611 XLineFactMap::iterator n = line_factory.find(xlf->GetType());
613 if (n == line_factory.end())
616 line_factory.erase(n);
621 XLineFactory* XLineManager::GetFactory(const std::string &type)
623 XLineFactMap::iterator n = line_factory.find(type);
625 if (n == line_factory.end())