2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
5 * Copyright (C) 2005-2009 Robin Burchell <robin+git@viroteck.net>
6 * Copyright (C) 2004-2008 Craig Edwards <craigedwards@brainbox.cc>
7 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
8 * Copyright (C) 2007 John Brooks <john.brooks@dereferenced.net>
10 * This file is part of InspIRCd. InspIRCd is free software: you can
11 * redistribute it and/or modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation, version 2.
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
16 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
19 * You should have received a copy of the GNU General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #include "modules/stats.h"
28 /** An XLineFactory specialized to generate GLine* pointers
30 class GLineFactory : public XLineFactory
33 GLineFactory() : XLineFactory("G") { }
37 XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) CXX11_OVERRIDE
39 IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
40 return new GLine(set_time, duration, source, reason, ih.first, ih.second);
44 /** An XLineFactory specialized to generate ELine* pointers
46 class ELineFactory : public XLineFactory
49 ELineFactory() : XLineFactory("E") { }
53 XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) CXX11_OVERRIDE
55 IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
56 return new ELine(set_time, duration, source, reason, ih.first, ih.second);
60 /** An XLineFactory specialized to generate KLine* pointers
62 class KLineFactory : public XLineFactory
65 KLineFactory() : XLineFactory("K") { }
69 XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) CXX11_OVERRIDE
71 IdentHostPair ih = ServerInstance->XLines->IdentSplit(xline_specific_mask);
72 return new KLine(set_time, duration, source, reason, ih.first, ih.second);
76 /** An XLineFactory specialized to generate QLine* pointers
78 class QLineFactory : public XLineFactory
81 QLineFactory() : XLineFactory("Q") { }
85 XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) CXX11_OVERRIDE
87 return new QLine(set_time, duration, source, reason, xline_specific_mask);
91 /** An XLineFactory specialized to generate ZLine* pointers
93 class ZLineFactory : public XLineFactory
96 ZLineFactory() : XLineFactory("Z") { }
100 XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) CXX11_OVERRIDE
102 return new ZLine(set_time, duration, source, reason, xline_specific_mask);
108 * This is now version 3 of the XLine subsystem, let's see if we can get it as nice and
109 * efficient as we can this time so we can close this file and never ever touch it again ..
112 * Version 1 stored all line types in one list (one for g, one for z, etc). This was fine,
113 * but both version 1 and 2 suck at applying lines efficiently. That is, every time a new line
114 * was added, it iterated every existing line for every existing user. Ow. Expiry was also
115 * expensive, as the lists were NOT sorted.
117 * Version 2 moved permanent lines into a seperate list from non-permanent to help optimize
118 * matching speed, but matched in the same way.
119 * Expiry was also sped up by sorting the list by expiry (meaning just remove the items at the
120 * head of the list that are outdated.)
122 * This was fine and good, but it looked less than ideal in code, and matching was still slower
123 * than it could have been, something which we address here.
126 * All lines are (as in v1) stored together -- no seperation of perm and non-perm. They are stored in
127 * a map of maps (first map is line type, second map is for quick lookup on add/delete/etc).
129 * Expiry is *no longer* performed on a timer, and no longer uses a sorted list of any variety. This
130 * is now done by only checking for expiry when a line is accessed, meaning that expiry is no longer
131 * a resource intensive problem.
133 * Application no longer tries to apply every single line on every single user - instead, now only lines
134 * added since the previous application are applied. This keeps S2S ADDLINE during burst nice and fast,
135 * while at the same time not slowing things the fuck down when we try adding a ban with lots of preexisting
139 bool XLine::Matches(User *u)
145 * Checks what users match a given vector of ELines and sets their ban exempt flag accordingly.
147 void XLineManager::CheckELines()
149 ContainerIter n = lookup_lines.find("E");
151 if (n == lookup_lines.end())
154 XLineLookup& ELines = n->second;
159 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
160 for (UserManager::LocalList::const_iterator u2 = list.begin(); u2 != list.end(); u2++)
165 /* This uses safe iteration to ensure that if a line expires here, it doenst trash the iterator */
168 for (LookupIter i = ELines.begin(); i != ELines.end(); )
173 XLine *e = i->second;
174 if ((!e->duration || ServerInstance->Time() < e->expiry) && e->Matches(u))
183 XLineLookup* XLineManager::GetAll(const std::string &type)
185 ContainerIter n = lookup_lines.find(type);
187 if (n == lookup_lines.end())
191 const time_t current = ServerInstance->Time();
193 /* Expire any dead ones, before sending */
194 for (LookupIter x = n->second.begin(); x != n->second.end(); )
198 if (x->second->duration && current > x->second->expiry)
208 void XLineManager::DelAll(const std::string &type)
210 ContainerIter n = lookup_lines.find(type);
212 if (n == lookup_lines.end())
217 /* Delete all of a given type (this should probably use DelLine, but oh well) */
218 while ((x = n->second.begin()) != n->second.end())
224 std::vector<std::string> XLineManager::GetAllTypes()
226 std::vector<std::string> items;
227 for (ContainerIter x = lookup_lines.begin(); x != lookup_lines.end(); ++x)
228 items.push_back(x->first);
232 IdentHostPair XLineManager::IdentSplit(const std::string &ident_and_host)
234 IdentHostPair n = std::make_pair<std::string,std::string>("*","*");
235 std::string::size_type x = ident_and_host.find('@');
236 if (x != std::string::npos)
238 n.second = ident_and_host.substr(x + 1,ident_and_host.length());
239 n.first = ident_and_host.substr(0, x);
240 if (!n.first.length())
242 if (!n.second.length())
243 n.second.assign("*");
248 n.second = ident_and_host;
256 bool XLineManager::AddLine(XLine* line, User* user)
258 if (line->duration && ServerInstance->Time() > line->expiry)
259 return false; // Don't apply expired XLines.
261 /* Don't apply duplicate xlines */
262 ContainerIter x = lookup_lines.find(line->type);
263 if (x != lookup_lines.end())
265 LookupIter i = x->second.find(line->Displayable());
266 if (i != x->second.end())
268 // XLine propagation bug was here, if the line to be added already exists and
269 // it's expired then expire it and add the new one instead of returning false
270 if ((!i->second->duration) || (ServerInstance->Time() < i->second->expiry))
277 /*ELine* item = new ELine(ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());*/
278 XLineFactory* xlf = GetFactory(line->type);
282 ServerInstance->BanCache.RemoveEntries(line->type, false); // XXX perhaps remove ELines here?
284 if (xlf->AutoApplyToUserList(line))
285 pending_lines.push_back(line);
287 lookup_lines[line->type][line->Displayable()] = line;
290 FOREACH_MOD(OnAddLine, (user, line));
295 // deletes a line, returns true if the line existed and was removed
297 bool XLineManager::DelLine(const char* hostmask, const std::string& type, std::string& reason, User* user, bool simulate)
299 ContainerIter x = lookup_lines.find(type);
301 if (x == lookup_lines.end())
304 LookupIter y = x->second.find(hostmask);
306 if (y == x->second.end())
309 reason.assign(y->second->reason);
314 ServerInstance->BanCache.RemoveEntries(y->second->type, true);
316 FOREACH_MOD(OnDelLine, (user, y->second));
320 stdalgo::erase(pending_lines, y->second);
331 ServerInstance->XLines->CheckELines();
334 // returns a pointer to the reason if a nickname matches a Q-line, NULL if it didn't match
336 XLine* XLineManager::MatchesLine(const std::string &type, User* user)
338 ContainerIter x = lookup_lines.find(type);
340 if (x == lookup_lines.end())
343 const time_t current = ServerInstance->Time();
347 for (LookupIter i = x->second.begin(); i != x->second.end(); )
352 if (i->second->duration && current > i->second->expiry)
354 /* Expire the line, proceed to next one */
360 if (i->second->Matches(user))
370 XLine* XLineManager::MatchesLine(const std::string &type, const std::string &pattern)
372 ContainerIter x = lookup_lines.find(type);
374 if (x == lookup_lines.end())
377 const time_t current = ServerInstance->Time();
381 for (LookupIter i = x->second.begin(); i != x->second.end(); )
386 if (i->second->Matches(pattern))
388 if (i->second->duration && current > i->second->expiry)
390 /* Expire the line, return nothing */
405 // removes lines that have expired
406 void XLineManager::ExpireLine(ContainerIter container, LookupIter item)
408 FOREACH_MOD(OnExpireLine, (item->second));
410 item->second->DisplayExpiry();
411 item->second->Unset();
413 /* TODO: Can we skip this loop by having a 'pending' field in the XLine class, which is set when a line
414 * is pending, cleared when it is no longer pending, so we skip over this loop if its not pending?
417 stdalgo::erase(pending_lines, item->second);
420 container->second.erase(item);
424 // applies lines, removing clients and changing nicks etc as applicable
425 void XLineManager::ApplyLines()
427 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
428 for (UserManager::LocalList::const_iterator j = list.begin(); j != list.end(); ++j)
432 // Don't ban people who are exempt.
436 for (std::vector<XLine *>::iterator i = pending_lines.begin(); i != pending_lines.end(); i++)
444 pending_lines.clear();
447 void XLineManager::InvokeStats(const std::string& type, unsigned int numeric, Stats::Context& stats)
449 ContainerIter n = lookup_lines.find(type);
451 time_t current = ServerInstance->Time();
455 if (n != lookup_lines.end())
457 XLineLookup& list = n->second;
458 for (LookupIter i = list.begin(); i != list.end(); )
463 if (i->second->duration && current > i->second->expiry)
468 stats.AddRow(numeric, i->second->Displayable()+" "+
469 ConvToStr(i->second->set_time)+" "+ConvToStr(i->second->duration)+" "+i->second->source+" :"+i->second->reason);
476 XLineManager::XLineManager()
485 GFact = new GLineFactory;
486 EFact = new ELineFactory;
487 KFact = new KLineFactory;
488 QFact = new QLineFactory;
489 ZFact = new ZLineFactory;
491 RegisterFactory(GFact);
492 RegisterFactory(EFact);
493 RegisterFactory(KFact);
494 RegisterFactory(QFact);
495 RegisterFactory(ZFact);
498 XLineManager::~XLineManager()
500 const char gekqz[] = "GEKQZ";
501 for(unsigned int i=0; i < sizeof(gekqz); i++)
503 XLineFactory* xlf = GetFactory(std::string(1, gekqz[i]));
507 // Delete all existing XLines
508 for (XLineContainer::iterator i = lookup_lines.begin(); i != lookup_lines.end(); i++)
510 for (XLineLookup::iterator j = i->second.begin(); j != i->second.end(); j++)
517 void XLine::Apply(User* u)
521 bool XLine::IsBurstable()
526 void XLine::DefaultApply(User* u, const std::string &line, bool bancache)
528 const std::string banReason = line + "-lined: " + reason;
530 if (!ServerInstance->Config->XLineMessage.empty())
531 u->WriteNumeric(ERR_YOUREBANNEDCREEP, ServerInstance->Config->XLineMessage);
533 if (ServerInstance->Config->HideBans)
534 ServerInstance->Users->QuitUser(u, line + "-lined", &banReason);
536 ServerInstance->Users->QuitUser(u, banReason);
541 ServerInstance->Logs->Log("BANCACHE", LOG_DEBUG, "BanCache: Adding positive hit (" + line + ") for " + u->GetIPString());
542 ServerInstance->BanCache.AddHit(u->GetIPString(), this->type, banReason, this->duration);
546 bool KLine::Matches(User *u)
548 LocalUser* lu = IS_LOCAL(u);
549 if (lu && lu->exempt)
552 if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
554 if (InspIRCd::MatchCIDR(u->GetRealHost(), this->hostmask, ascii_case_insensitive_map) ||
555 InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
564 void KLine::Apply(User* u)
566 DefaultApply(u, "K", (this->identmask == "*") ? true : false);
569 bool GLine::Matches(User *u)
571 LocalUser* lu = IS_LOCAL(u);
572 if (lu && lu->exempt)
575 if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
577 if (InspIRCd::MatchCIDR(u->GetRealHost(), this->hostmask, ascii_case_insensitive_map) ||
578 InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
587 void GLine::Apply(User* u)
589 DefaultApply(u, "G", (this->identmask == "*") ? true : false);
592 bool ELine::Matches(User *u)
594 if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
596 if (InspIRCd::MatchCIDR(u->GetRealHost(), this->hostmask, ascii_case_insensitive_map) ||
597 InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
606 bool ZLine::Matches(User *u)
608 LocalUser* lu = IS_LOCAL(u);
609 if (lu && lu->exempt)
612 if (InspIRCd::MatchCIDR(u->GetIPString(), this->ipaddr))
618 void ZLine::Apply(User* u)
620 DefaultApply(u, "Z", true);
624 bool QLine::Matches(User *u)
626 if (InspIRCd::Match(u->nick, this->nick))
632 void QLine::Apply(User* u)
634 /* Force to uuid on apply of Q-line, no need to disconnect anymore :) */
635 u->ChangeNick(u->uuid);
639 bool ZLine::Matches(const std::string &str)
641 if (InspIRCd::MatchCIDR(str, this->ipaddr))
647 bool QLine::Matches(const std::string &str)
649 if (InspIRCd::Match(str, this->nick))
655 bool ELine::Matches(const std::string &str)
657 return (InspIRCd::MatchCIDR(str, matchtext));
660 bool KLine::Matches(const std::string &str)
662 return (InspIRCd::MatchCIDR(str.c_str(), matchtext));
665 bool GLine::Matches(const std::string &str)
667 return (InspIRCd::MatchCIDR(str, matchtext));
672 /* When adding one E-line, only check the one E-line */
673 const UserManager::LocalList& list = ServerInstance->Users.GetLocalUsers();
674 for (UserManager::LocalList::const_iterator u2 = list.begin(); u2 != list.end(); u2++)
677 if (this->Matches(u))
682 void XLine::DisplayExpiry()
684 bool onechar = (type.length() == 1);
685 ServerInstance->SNO->WriteToSnoMask('x', "Removing expired %s%s %s (set by %s %ld seconds ago): %s",
686 type.c_str(), (onechar ? "-line" : ""), Displayable().c_str(), source.c_str(), (long)(ServerInstance->Time() - set_time), reason.c_str());
689 const std::string& ELine::Displayable()
694 const std::string& KLine::Displayable()
699 const std::string& GLine::Displayable()
704 const std::string& ZLine::Displayable()
709 const std::string& QLine::Displayable()
714 bool KLine::IsBurstable()
719 bool XLineManager::RegisterFactory(XLineFactory* xlf)
721 XLineFactMap::iterator n = line_factory.find(xlf->GetType());
723 if (n != line_factory.end())
726 line_factory[xlf->GetType()] = xlf;
731 bool XLineManager::UnregisterFactory(XLineFactory* xlf)
733 XLineFactMap::iterator n = line_factory.find(xlf->GetType());
735 if (n == line_factory.end())
738 line_factory.erase(n);
743 XLineFactory* XLineManager::GetFactory(const std::string &type)
745 XLineFactMap::iterator n = line_factory.find(type);
747 if (n == line_factory.end())
753 void XLineManager::ClearConfigLines()
756 if (lookup_lines.empty())
759 ServerInstance->SNO->WriteToSnoMask('x', "Server rehashing; expiring lines defined in the server config ...");
760 for (ContainerIter type = lookup_lines.begin(); type != lookup_lines.end(); ++type)
762 for (LookupIter xline = type->second.begin(); xline != type->second.end(); )
764 // We cache this to avoid iterator invalidation.
765 LookupIter cachedxline = xline++;
766 if (cachedxline->second->from_config)
768 ExpireLine(type, cachedxline);