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 XLine::Matches(User *u)
72 * Checks what users match a given vector of ELines and sets their ban exempt flag accordingly.
74 void XLineManager::CheckELines(std::map<std::string, XLine *> &ELines)
79 for (std::vector<User*>::const_iterator u2 = ServerInstance->local_users.begin(); u2 != ServerInstance->local_users.end(); u2++)
81 User* u = (User*)(*u2);
83 for (std::map<std::string, XLine *>::iterator i = ELines.begin(); i != ELines.end(); i++)
86 u->exempt = e->Matches(u);
91 // this should probably be moved to configreader, but atm it relies on CheckELines above.
92 bool DoneELine(ServerConfig* conf, const char* tag)
94 for (std::vector<User*>::const_iterator u2 = conf->GetInstance()->local_users.begin(); u2 != conf->GetInstance()->local_users.end(); u2++)
96 User* u = (User*)(*u2);
100 conf->GetInstance()->XLines->CheckELines(conf->GetInstance()->XLines->lookup_lines['E']);
105 IdentHostPair XLineManager::IdentSplit(const std::string &ident_and_host)
107 IdentHostPair n = std::make_pair<std::string,std::string>("*","*");
108 std::string::size_type x = ident_and_host.find('@');
109 if (x != std::string::npos)
111 n.second = ident_and_host.substr(x + 1,ident_and_host.length());
112 n.first = ident_and_host.substr(0, x);
113 if (!n.first.length())
115 if (!n.second.length())
116 n.second.assign("*");
120 n.second = ident_and_host;
128 /*bool XLineManager::AddELine(long duration, const char* source, const char* reason, const char* hostmask)*/
129 bool XLineManager::AddLine(XLine* line, User* user)
131 /*IdentHostPair ih = IdentSplit(hostmask);*/
133 if (DelLine(line->Displayable(), line->type, user, true))
136 /*ELine* item = new ELine(ServerInstance, ServerInstance->Time(), duration, source, reason, ih.first.c_str(), ih.second.c_str());*/
138 active_lines.push_back(line);
139 sort(active_lines.begin(), active_lines.end(), XLineManager::XSortComparison);
140 pending_lines.push_back(line);
141 lookup_lines[line->type][line->Displayable()] = line;
144 FOREACH_MOD(I_OnAddLine,OnAddLine(user, line));
149 /*bool XLineManager::AddZLine(long duration, const char* source, const char* reason, const char* ipaddr)
151 if (strchr(ipaddr,'@'))
153 while (*ipaddr != '@')
158 // deletes a g:line, returns true if the line existed and was removed
160 bool XLineManager::DelLine(const char* hostmask, char type, User* user, bool simulate)
162 IdentHostPair ih = IdentSplit(hostmask);
163 for (std::vector<XLine*>::iterator i = active_lines.begin(); i != active_lines.end(); i++)
165 if ((*i)->type == type)
167 if ((*i)->MatchesLiteral(hostmask))
173 active_lines.erase(i);
174 if (lookup_lines.find(type) != lookup_lines.end())
175 lookup_lines[type].erase(hostmask);
177 FOREACH_MOD(I_OnDelLine,OnDelLine(user, *i));
179 std::vector<XLine*>::iterator pptr = std::find(pending_lines.begin(), pending_lines.end(), *i);
180 if (pptr != pending_lines.end())
181 pending_lines.erase(pptr);
194 /* remove exempt from everyone and force recheck after deleting eline */
195 for (std::vector<User*>::const_iterator u2 = ServerInstance->local_users.begin(); u2 != ServerInstance->local_users.end(); u2++)
197 User* u = (User*)(*u2);
201 if (ServerInstance->XLines->lookup_lines.find('E') != ServerInstance->XLines->lookup_lines.end())
202 ServerInstance->XLines->CheckELines(ServerInstance->XLines->lookup_lines['E']);
205 // returns a pointer to the reason if a nickname matches a qline, NULL if it didnt match
207 QLine* XLineManager::matches_qline(const char* nick)
209 if (lookup_lines.find('Q') == lookup_lines.end())
212 if (lookup_lines.find('Q') != lookup_lines.end() && lookup_lines['Q'].empty())
215 for (std::vector<XLine*>::iterator i = active_lines.begin(); i != active_lines.end(); i++)
216 if ((*i)->type == 'Q' && (*i)->Matches(nick))
221 // returns a pointer to the reason if a host matches a gline, NULL if it didnt match
223 GLine* XLineManager::matches_gline(User* user)
225 if (lookup_lines.find('G') == lookup_lines.end())
228 if (lookup_lines.find('G') != lookup_lines.end() && lookup_lines['G'].empty())
231 for (std::vector<XLine*>::iterator i = active_lines.begin(); i != active_lines.end(); i++)
232 if ((*i)->type == 'G' && (*i)->Matches(user))
238 ELine* XLineManager::matches_exception(User* user)
240 if (lookup_lines.find('E') == lookup_lines.end())
243 if (lookup_lines.find('E') != lookup_lines.end() && lookup_lines['E'].empty())
246 for (std::vector<XLine*>::iterator i = active_lines.begin(); i != active_lines.end(); i++)
248 if ((*i)->type == 'E' && (*i)->Matches(user))
255 void XLineManager::gline_set_creation_time(const char* host, time_t create_time)
257 /*for (std::vector<XLine*>::iterator i = glines.begin(); i != glines.end(); i++)
259 if (!strcasecmp(host,(*i)->hostmask))
261 (*i)->set_time = create_time;
262 (*i)->expiry = create_time + (*i)->duration;
270 void XLineManager::eline_set_creation_time(const char* host, time_t create_time)
272 /*for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
274 if (!strcasecmp(host,(*i)->hostmask))
276 (*i)->set_time = create_time;
277 (*i)->expiry = create_time + (*i)->duration;
285 void XLineManager::qline_set_creation_time(const char* nick, time_t create_time)
287 /*for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
289 if (!strcasecmp(nick,(*i)->nick))
291 (*i)->set_time = create_time;
292 (*i)->expiry = create_time + (*i)->duration;
300 void XLineManager::zline_set_creation_time(const char* ip, time_t create_time)
302 /*for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
304 if (!strcasecmp(ip,(*i)->ipaddr))
306 (*i)->set_time = create_time;
307 (*i)->expiry = create_time + (*i)->duration;
315 // returns a pointer to the reason if an ip address matches a zline, NULL if it didnt match
317 ZLine* XLineManager::matches_zline(User *u)
319 if (lookup_lines.find('Z') == lookup_lines.end())
322 if (lookup_lines.find('Z') != lookup_lines.end() && lookup_lines['Z'].empty())
325 for (std::vector<XLine*>::iterator i = active_lines.begin(); i != active_lines.end(); i++)
326 if ((*i)->type == 'Z' && (*i)->Matches(u))
331 // returns a pointer to the reason if a host matches a kline, NULL if it didnt match
333 KLine* XLineManager::matches_kline(User* user)
335 if (lookup_lines.find('K') == lookup_lines.end())
338 if (lookup_lines.find('K') != lookup_lines.end() && lookup_lines['K'].empty())
341 for (std::vector<XLine*>::iterator i = active_lines.begin(); i != active_lines.end(); i++)
342 if ((*i)->Matches(user))
348 bool XLineManager::XSortComparison(const XLine *one, const XLine *two)
350 // account for permanent lines
351 if (one->expiry == 0)
355 return (one->expiry) < (two->expiry);
358 // removes lines that have expired
359 void XLineManager::expire_lines()
361 time_t current = ServerInstance->Time();
363 /* Because we now store all our XLines in sorted order using ((*i)->duration + (*i)->set_time) as a key, this
364 * means that to expire the XLines we just need to do a while, picking off the top few until there are
365 * none left at the head of the queue that are after the current time.
368 while ((active_lines.size()) && (current > (*active_lines.begin())->expiry) && ((*active_lines.begin())->duration != 0))
370 std::vector<XLine*>::iterator i = active_lines.begin();
371 (*i)->DisplayExpiry();
373 active_lines.erase(i);
378 // applies lines, removing clients and changing nicks etc as applicable
379 void XLineManager::ApplyLines()
381 for (std::vector<User*>::const_iterator u2 = ServerInstance->local_users.begin(); u2 != ServerInstance->local_users.end(); u2++)
383 User* u = (User*)(*u2);
385 for (std::vector<XLine *>::iterator i = pending_lines.begin(); i != pending_lines.end(); i++)
393 pending_lines.clear();
396 void XLineManager::stats_k(User* user, string_list &results)
398 /*std::string sn = ServerInstance->Config->ServerName;
399 for (std::vector<KLine*>::iterator i = klines.begin(); i != klines.end(); i++)
400 results.push_back(sn+" 216 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);*/
403 void XLineManager::stats_g(User* user, string_list &results)
405 /*std::string sn = ServerInstance->Config->ServerName;
406 for (std::vector<GLine*>::iterator i = glines.begin(); i != glines.end(); i++)
407 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);*/
410 void XLineManager::stats_q(User* user, string_list &results)
412 /*std::string sn = ServerInstance->Config->ServerName;
413 for (std::vector<QLine*>::iterator i = qlines.begin(); i != qlines.end(); i++)
414 results.push_back(sn+" 217 "+user->nick+" :"+(*i)->nick+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);*/
417 void XLineManager::stats_z(User* user, string_list &results)
419 /*std::string sn = ServerInstance->Config->ServerName;
420 for (std::vector<ZLine*>::iterator i = zlines.begin(); i != zlines.end(); i++)
421 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->ipaddr+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);*/
424 void XLineManager::stats_e(User* user, string_list &results)
426 /*std::string sn = ServerInstance->Config->ServerName;
427 for (std::vector<ELine*>::iterator i = elines.begin(); i != elines.end(); i++)
428 results.push_back(sn+" 223 "+user->nick+" :"+(*i)->identmask+"@"+(*i)->hostmask+" "+ConvToStr((*i)->set_time)+" "+ConvToStr((*i)->duration)+" "+(*i)->source+" :"+(*i)->reason);*/
431 XLineManager::XLineManager(InspIRCd* Instance) : ServerInstance(Instance)
433 GFact = new GLineFactory(Instance);
434 EFact = new ELineFactory(Instance);
435 KFact = new KLineFactory(Instance);
436 QFact = new QLineFactory(Instance);
437 ZFact = new ZLineFactory(Instance);
439 RegisterFactory(GFact);
440 RegisterFactory(EFact);
441 RegisterFactory(KFact);
442 RegisterFactory(QFact);
443 RegisterFactory(ZFact);
446 XLineManager::~XLineManager()
448 UnregisterFactory(GFact);
449 UnregisterFactory(EFact);
450 UnregisterFactory(KFact);
451 UnregisterFactory(QFact);
452 UnregisterFactory(ZFact);
461 void XLine::Apply(User* u)
465 void XLine::DefaultApply(User* u, char line)
468 snprintf(reason, MAXBUF, "%c-Lined: %s", line, this->reason);
469 if (*ServerInstance->Config->MoronBanner)
470 u->WriteServ("NOTICE %s :*** %s", u->nick, ServerInstance->Config->MoronBanner);
471 if (ServerInstance->Config->HideBans)
472 User::QuitUser(ServerInstance, u, line + std::string("-Lined"), reason);
474 User::QuitUser(ServerInstance, u, reason);
477 bool KLine::Matches(User *u)
482 if ((match(u->ident, this->identmask)))
484 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
493 void KLine::Apply(User* u)
495 DefaultApply(u, 'K');
498 bool GLine::Matches(User *u)
503 if ((match(u->ident, this->identmask)))
505 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
514 void GLine::Apply(User* u)
516 DefaultApply(u, 'G');
519 bool ELine::Matches(User *u)
524 if ((match(u->ident, this->identmask)))
526 if ((match(u->host, this->hostmask, true)) || (match(u->GetIPString(), this->hostmask, true)))
535 bool ZLine::Matches(User *u)
540 if (match(u->GetIPString(), this->ipaddr, true))
546 void ZLine::Apply(User* u)
548 DefaultApply(u, 'Z');
552 bool QLine::Matches(User *u)
557 if (match(u->nick, this->nick))
563 void QLine::Apply(User* u)
565 /* Can we force the user to their uid here instead? */
566 DefaultApply(u, 'Q');
570 bool ZLine::Matches(const std::string &str)
572 if (match(str.c_str(), this->ipaddr, true))
578 bool QLine::Matches(const std::string &str)
580 if (match(str.c_str(), this->nick))
586 bool ELine::Matches(const std::string &str)
588 return ((match(str.c_str(), matchtext.c_str(), true)));
591 bool KLine::Matches(const std::string &str)
593 return ((match(str.c_str(), matchtext.c_str(), true)));
596 bool GLine::Matches(const std::string &str)
598 return ((match(str.c_str(), matchtext.c_str(), true)));
601 bool ELine::MatchesLiteral(const std::string &str)
603 return (assign(str) == matchtext);
606 bool ZLine::MatchesLiteral(const std::string &str)
608 return (assign(str) == this->ipaddr);
611 bool GLine::MatchesLiteral(const std::string &str)
613 return (assign(str) == matchtext);
616 bool KLine::MatchesLiteral(const std::string &str)
618 return (assign(str) == matchtext);
621 bool QLine::MatchesLiteral(const std::string &str)
623 return (assign(str) == this->nick);
628 /* When adding one eline, only check the one eline */
629 for (std::vector<User*>::const_iterator u2 = ServerInstance->local_users.begin(); u2 != ServerInstance->local_users.end(); u2++)
631 User* u = (User*)(*u2);
632 if (this->Matches(u))
637 void ELine::DisplayExpiry()
639 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed E-Line %s@%s (set by %s %d seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
642 void QLine::DisplayExpiry()
644 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Q-Line %s (set by %s %d seconds ago)",this->nick,this->source,this->duration);
647 void ZLine::DisplayExpiry()
649 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Z-Line %s (set by %s %d seconds ago)",this->ipaddr,this->source,this->duration);
652 void KLine::DisplayExpiry()
654 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed K-Line %s@%s (set by %s %d seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
657 void GLine::DisplayExpiry()
659 ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed G-Line %s@%s (set by %s %d seconds ago)",this->identmask,this->hostmask,this->source,this->duration);
662 const char* ELine::Displayable()
664 return matchtext.c_str();
667 const char* KLine::Displayable()
669 return matchtext.c_str();
672 const char* GLine::Displayable()
674 return matchtext.c_str();
677 const char* ZLine::Displayable()
682 const char* QLine::Displayable()
687 bool XLineManager::RegisterFactory(XLineFactory* xlf)
689 std::map<char, XLineFactory*>::iterator n = line_factory.find(xlf->GetType());
691 if (n != line_factory.end())
694 line_factory[xlf->GetType()] = xlf;
699 bool XLineManager::UnregisterFactory(XLineFactory* xlf)
701 std::map<char, XLineFactory*>::iterator n = line_factory.find(xlf->GetType());
703 if (n == line_factory.end())
706 line_factory.erase(n);
711 XLineFactory* XLineManager::GetFactory(const char type)
713 std::map<char, XLineFactory*>::iterator n = line_factory.find(type);
715 if (n != line_factory.end())