src/xline.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2009 InspIRCd Development Team
   6  * See: http://wiki.inspircd.org/Credits
   7  *
   8  * This program is free but copyrighted software; see
   9  *          the file COPYING for details.
  10  *
  11  * ---------------------------------------------------
  12  */
  13
  14 /* $Core */
  15
  16 #include "inspircd.h"
  17 #include "xline.h"
  18 #include "bancache.h"
  19
  20 /*
  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 ..
  23  *
  24  * Background:
  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.
  29  *
  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.)
  34  *
  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.
  37  *
  38  * VERSION 3:
  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).
  41  *
  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.
  45  *
  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
  49  *  bans. :)
  50  */
  51
  52 bool XLine::Matches(User *u)
  53 {
  54         return false;
  55 }
  56
  57 /*
  58  * Checks what users match a given vector of ELines and sets their ban exempt flag accordingly.
  59  */
  60 void XLineManager::CheckELines()
  61 {
  62         ContainerIter n = lookup_lines.find("E");
  63
  64         if (n == lookup_lines.end())
  65                 return;
  66
  67         XLineLookup& ELines = n->second;
  68
  69         if (ELines.empty())
  70                 return;
  71
  72         for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
  73         {
  74                 User* u = (User*)(*u2);
  75
  76                 /* This uses safe iteration to ensure that if a line expires here, it doenst trash the iterator */
  77                 LookupIter safei;
  78
  79                 for (LookupIter i = ELines.begin(); i != ELines.end(); )
  80                 {
  81                         safei = i;
  82                         safei++;
  83
  84                         XLine *e = i->second;
  85                         u->exempt = e->Matches(u);
  86
  87                         i = safei;
  88                 }
  89         }
  90 }
  91
  92
  93 XLineLookup* XLineManager::GetAll(const std::string &type)
  94 {
  95         ContainerIter n = lookup_lines.find(type);
  96
  97         if (n == lookup_lines.end())
  98                 return NULL;
  99
 100         LookupIter safei;
 101         const time_t current = ServerInstance->Time();
 102
 103         /* Expire any dead ones, before sending */
 104         for (LookupIter x = n->second.begin(); x != n->second.end(); )
 105         {
 106                 safei = x;
 107                 safei++;
 108                 if (x->second->duration && current > x->second->expiry)
 109                 {
 110                         ExpireLine(n, x);
 111                 }
 112                 x = safei;
 113         }
 114
 115         return &(n->second);
 116 }
 117
 118 void XLineManager::DelAll(const std::string &type)
 119 {
 120         ContainerIter n = lookup_lines.find(type);
 121
 122         if (n == lookup_lines.end())
 123                 return;
 124
 125         LookupIter x;
 126
 127         /* Delete all of a given type (this should probably use DelLine, but oh well) */
 128         while ((x = n->second.begin()) != n->second.end())
 129         {
 130                 ExpireLine(n, x);
 131         }
 132 }
 133
 134 std::vector<std::string> XLineManager::GetAllTypes()
 135 {
 136         std::vector<std::string> items;
 137         for (ContainerIter x = lookup_lines.begin(); x != lookup_lines.end(); ++x)
 138                 items.push_back(x->first);
 139         return items;
 140 }
 141
 142 IdentHostPair XLineManager::IdentSplit(const std::string &ident_and_host)
 143 {
 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)
 147         {
 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())
 151                         n.first.assign("*");
 152                 if (!n.second.length())
 153                         n.second.assign("*");
 154         }
 155         else
 156         {
 157                 n.first = "";
 158                 n.second = ident_and_host;
 159         }
 160
 161         return n;
 162 }
 163
 164 // adds a line
 165
 166 bool XLineManager::AddLine(XLine* line, User* user)
 167 {
 168         ServerInstance->BanCache->RemoveEntries(line->type, false); // XXX perhaps remove ELines here?
 169
 170         if (line->duration && ServerInstance->Time() > line->expiry)
 171                 return false; // Don't apply expired XLines.
 172
 173         /* Don't apply duplicate xlines */
 174         ContainerIter x = lookup_lines.find(line->type);
 175         if (x != lookup_lines.end())
 176         {
 177                 LookupIter i = x->second.find(line->Displayable());
 178                 if (i != x->second.end())
 179                 {
 180                         return false;
 181                 }
 182         }
 183
 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);
 186         if (!xlf)
 187                 return false;
 188
 189         if (xlf->AutoApplyToUserList(line))
 190                 pending_lines.push_back(line);
 191
 192         lookup_lines[line->type][line->Displayable()] = line;
 193         line->OnAdd();
 194
 195         FOREACH_MOD(I_OnAddLine,OnAddLine(user, line));
 196
 197         return true;
 198 }
 199
 200 // deletes a line, returns true if the line existed and was removed
 201
 202 bool XLineManager::DelLine(const char* hostmask, const std::string &type, User* user, bool simulate)
 203 {
 204         ContainerIter x = lookup_lines.find(type);
 205
 206         if (x == lookup_lines.end())
 207                 return false;
 208
 209         LookupIter y = x->second.find(hostmask);
 210
 211         if (y == x->second.end())
 212                 return false;
 213
 214         if (simulate)
 215                 return true;
 216
 217         ServerInstance->BanCache->RemoveEntries(y->second->type, true);
 218
 219         FOREACH_MOD(I_OnDelLine,OnDelLine(user, y->second));
 220
 221         y->second->Unset();
 222
 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);
 226
 227         delete y->second;
 228         x->second.erase(y);
 229
 230         return true;
 231 }
 232
 233
 234 void ELine::Unset()
 235 {
 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++)
 238         {
 239                 User* u = (User*)(*u2);
 240                 u->exempt = false;
 241         }
 242
 243         ServerInstance->XLines->CheckELines();
 244 }
 245
 246 // returns a pointer to the reason if a nickname matches a qline, NULL if it didnt match
 247
 248 XLine* XLineManager::MatchesLine(const std::string &type, User* user)
 249 {
 250         ContainerIter x = lookup_lines.find(type);
 251
 252         if (x == lookup_lines.end())
 253                 return NULL;
 254
 255         const time_t current = ServerInstance->Time();
 256
 257         LookupIter safei;
 258
 259         for (LookupIter i = x->second.begin(); i != x->second.end(); )
 260         {
 261                 safei = i;
 262                 safei++;
 263
 264                 if (i->second->duration && current > i->second->expiry)
 265                 {
 266                         /* Expire the line, proceed to next one */
 267                         ExpireLine(x, i);
 268                         i = safei;
 269                         continue;
 270                 }
 271
 272                 if (i->second->Matches(user))
 273                 {
 274                         return i->second;
 275                 }
 276
 277                 i = safei;
 278         }
 279         return NULL;
 280 }
 281
 282 XLine* XLineManager::MatchesLine(const std::string &type, const std::string &pattern)
 283 {
 284         ContainerIter x = lookup_lines.find(type);
 285
 286         if (x == lookup_lines.end())
 287                 return NULL;
 288
 289         const time_t current = ServerInstance->Time();
 290
 291          LookupIter safei;
 292
 293         for (LookupIter i = x->second.begin(); i != x->second.end(); )
 294         {
 295                 safei = i;
 296                 safei++;
 297
 298                 if (i->second->Matches(pattern))
 299                 {
 300                         if (i->second->duration && current > i->second->expiry)
 301                         {
 302                                 /* Expire the line, return nothing */
 303                                 ExpireLine(x, i);
 304                                 /* See above */
 305                                 i = safei;
 306                                 continue;
 307                         }
 308                         else
 309                                 return i->second;
 310                 }
 311
 312                 i = safei;
 313         }
 314         return NULL;
 315 }
 316
 317 // removes lines that have expired
 318 void XLineManager::ExpireLine(ContainerIter container, LookupIter item)
 319 {
 320         FOREACH_MOD(I_OnExpireLine, OnExpireLine(item->second));
 321
 322         item->second->DisplayExpiry();
 323         item->second->Unset();
 324
 325         /* TODO: Can we skip this loop by having a 'pending' field in the XLine class, which is set when a line
 326          * is pending, cleared when it is no longer pending, so we skip over this loop if its not pending?
 327          * -- Brain
 328          */
 329         std::vector<XLine*>::iterator pptr = std::find(pending_lines.begin(), pending_lines.end(), item->second);
 330         if (pptr != pending_lines.end())
 331                 pending_lines.erase(pptr);
 332
 333         delete item->second;
 334         container->second.erase(item);
 335 }
 336
 337
 338 // applies lines, removing clients and changing nicks etc as applicable
 339 void XLineManager::ApplyLines()
 340 {
 341         std::vector<User*>::reverse_iterator u2 = ServerInstance->Users->local_users.rbegin();
 342         while (u2 != ServerInstance->Users->local_users.rend())
 343         {
 344                 User* u = *u2++;
 345
 346                 // Don't ban people who are exempt.
 347                 if (u->exempt)
 348                         continue;
 349
 350                 for (std::vector<XLine *>::iterator i = pending_lines.begin(); i != pending_lines.end(); i++)
 351                 {
 352                         XLine *x = *i;
 353                         if (x->Matches(u))
 354                                 x->Apply(u);
 355                 }
 356         }
 357
 358         pending_lines.clear();
 359 }
 360
 361 void XLineManager::InvokeStats(const std::string &type, int numeric, User* user, string_list &results)
 362 {
 363         std::string sn = ServerInstance->Config->ServerName;
 364
 365         ContainerIter n = lookup_lines.find(type);
 366
 367         time_t current = ServerInstance->Time();
 368
 369         LookupIter safei;
 370
 371         if (n != lookup_lines.end())
 372         {
 373                 XLineLookup& list = n->second;
 374                 for (LookupIter i = list.begin(); i != list.end(); )
 375                 {
 376                         safei = i;
 377                         safei++;
 378
 379                         if (i->second->duration && current > i->second->expiry)
 380                         {
 381                                 ExpireLine(n, i);
 382                         }
 383                         else
 384                                 results.push_back(sn+" "+ConvToStr(numeric)+" "+user->nick+" :"+i->second->Displayable()+" "+
 385                                         ConvToStr(i->second->set_time)+" "+ConvToStr(i->second->duration)+" "+std::string(i->second->source)+" :"+(i->second->reason));
 386                         i = safei;
 387                 }
 388         }
 389 }
 390
 391
 392 XLineManager::XLineManager(InspIRCd* Instance) : ServerInstance(Instance)
 393 {
 394         GFact = new GLineFactory(Instance);
 395         EFact = new ELineFactory(Instance);
 396         KFact = new KLineFactory(Instance);
 397         QFact = new QLineFactory(Instance);
 398         ZFact = new ZLineFactory(Instance);
 399
 400         RegisterFactory(GFact);
 401         RegisterFactory(EFact);
 402         RegisterFactory(KFact);
 403         RegisterFactory(QFact);
 404         RegisterFactory(ZFact);
 405 }
 406
 407 XLineManager::~XLineManager()
 408 {
 409         UnregisterFactory(GFact);
 410         UnregisterFactory(EFact);
 411         UnregisterFactory(KFact);
 412         UnregisterFactory(QFact);
 413         UnregisterFactory(ZFact);
 414
 415         delete GFact;
 416         delete EFact;
 417         delete KFact;
 418         delete QFact;
 419         delete ZFact;
 420
 421         // Delete all existing XLines
 422         for (XLineContainer::iterator i = lookup_lines.begin(); i != lookup_lines.end(); i++)
 423         {
 424                 for (XLineLookup::iterator j = i->second.begin(); j != i->second.end(); j++)
 425                 {
 426                         delete j->second;
 427                 }
 428                 i->second.clear();
 429         }
 430         lookup_lines.clear();
 431
 432 }
 433
 434 void XLine::Apply(User* u)
 435 {
 436 }
 437
 438 bool XLine::IsBurstable()
 439 {
 440         return true;
 441 }
 442
 443 void XLine::DefaultApply(User* u, const std::string &line, bool bancache)
 444 {
 445         char sreason[MAXBUF];
 446         snprintf(sreason, MAXBUF, "%s-Lined: %s", line.c_str(), this->reason.c_str());
 447         if (*ServerInstance->Config->MoronBanner)
 448                 u->WriteServ("NOTICE %s :*** %s", u->nick.c_str(), ServerInstance->Config->MoronBanner);
 449
 450         if (ServerInstance->Config->HideBans)
 451                 ServerInstance->Users->QuitUser(u, line + "-Lined", sreason);
 452         else
 453                 ServerInstance->Users->QuitUser(u, sreason);
 454
 455
 456         if (bancache)
 457         {
 458                 ServerInstance->Logs->Log("BANCACHE", DEBUG, std::string("BanCache: Adding positive hit (") + line + ") for " + u->GetIPString());
 459                 if (this->duration > 0)
 460                         ServerInstance->BanCache->AddHit(u->GetIPString(), this->type, line + "-Lined: " + this->reason, this->duration);
 461                 else
 462                         ServerInstance->BanCache->AddHit(u->GetIPString(), this->type, line + "-Lined: " + this->reason);
 463         }
 464 }
 465
 466 bool KLine::Matches(User *u)
 467 {
 468         if (u->exempt)
 469                 return false;
 470
 471         if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
 472         {
 473                 if (InspIRCd::MatchCIDR(u->host, this->hostmask, ascii_case_insensitive_map) ||
 474                     InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
 475                 {
 476                         return true;
 477                 }
 478         }
 479
 480         return false;
 481 }
 482
 483 void KLine::Apply(User* u)
 484 {
 485         DefaultApply(u, "K", (this->identmask ==  "*") ? true : false);
 486 }
 487
 488 bool GLine::Matches(User *u)
 489 {
 490         if (u->exempt)
 491                 return false;
 492
 493         if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
 494         {
 495                 if (InspIRCd::MatchCIDR(u->host, this->hostmask, ascii_case_insensitive_map) ||
 496                     InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
 497                 {
 498                         return true;
 499                 }
 500         }
 501
 502         return false;
 503 }
 504
 505 void GLine::Apply(User* u)
 506 {
 507         DefaultApply(u, "G", (this->identmask == "*") ? true : false);
 508 }
 509
 510 bool ELine::Matches(User *u)
 511 {
 512         if (u->exempt)
 513                 return false;
 514
 515         if (InspIRCd::Match(u->ident, this->identmask, ascii_case_insensitive_map))
 516         {
 517                 if (InspIRCd::MatchCIDR(u->host, this->hostmask, ascii_case_insensitive_map) ||
 518                     InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask, ascii_case_insensitive_map))
 519                 {
 520                         return true;
 521                 }
 522         }
 523
 524         return false;
 525 }
 526
 527 bool ZLine::Matches(User *u)
 528 {
 529         if (u->exempt)
 530                 return false;
 531
 532         if (InspIRCd::MatchCIDR(u->GetIPString(), this->ipaddr))
 533                 return true;
 534         else
 535                 return false;
 536 }
 537
 538 void ZLine::Apply(User* u)
 539 {
 540         DefaultApply(u, "Z", true);
 541 }
 542
 543
 544 bool QLine::Matches(User *u)
 545 {
 546         if (InspIRCd::Match(u->nick, this->nick))
 547                 return true;
 548
 549         return false;
 550 }
 551
 552 void QLine::Apply(User* u)
 553 {
 554         /* Force to uuid on apply of qline, no need to disconnect any more :) */
 555         u->ForceNickChange(u->uuid.c_str());
 556 }
 557
 558
 559 bool ZLine::Matches(const std::string &str)
 560 {
 561         if (InspIRCd::MatchCIDR(str, this->ipaddr))
 562                 return true;
 563         else
 564                 return false;
 565 }
 566
 567 bool QLine::Matches(const std::string &str)
 568 {
 569         if (InspIRCd::Match(str, this->nick))
 570                 return true;
 571
 572         return false;
 573 }
 574
 575 bool ELine::Matches(const std::string &str)
 576 {
 577         return (InspIRCd::MatchCIDR(str, matchtext));
 578 }
 579
 580 bool KLine::Matches(const std::string &str)
 581 {
 582         return (InspIRCd::MatchCIDR(str.c_str(), matchtext));
 583 }
 584
 585 bool GLine::Matches(const std::string &str)
 586 {
 587         return (InspIRCd::MatchCIDR(str, matchtext));
 588 }
 589
 590 void ELine::OnAdd()
 591 {
 592         /* When adding one eline, only check the one eline */
 593         for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
 594         {
 595                 User* u = (User*)(*u2);
 596                 if (this->Matches(u))
 597                         u->exempt = true;
 598         }
 599 }
 600
 601 void ELine::DisplayExpiry()
 602 {
 603         ServerInstance->SNO->WriteToSnoMask('x',"Removing expired E-Line %s@%s (set by %s %ld seconds ago)",
 604                 identmask.c_str(),hostmask.c_str(),source.c_str(),(long)(ServerInstance->Time() - this->set_time));
 605 }
 606
 607 void QLine::DisplayExpiry()
 608 {
 609         ServerInstance->SNO->WriteToSnoMask('x',"Removing expired Q-Line %s (set by %s %ld seconds ago)",
 610                 nick.c_str(),source.c_str(),(long)(ServerInstance->Time() - this->set_time));
 611 }
 612
 613 void ZLine::DisplayExpiry()
 614 {
 615         ServerInstance->SNO->WriteToSnoMask('x',"Removing expired Z-Line %s (set by %s %ld seconds ago)",
 616                 ipaddr.c_str(),source.c_str(),(long)(ServerInstance->Time() - this->set_time));
 617 }
 618
 619 void KLine::DisplayExpiry()
 620 {
 621         ServerInstance->SNO->WriteToSnoMask('x',"Removing expired K-Line %s@%s (set by %s %ld seconds ago)",
 622                 identmask.c_str(),hostmask.c_str(),source.c_str(),(long)(ServerInstance->Time() - this->set_time));
 623 }
 624
 625 void GLine::DisplayExpiry()
 626 {
 627         ServerInstance->SNO->WriteToSnoMask('x',"Removing expired G-Line %s@%s (set by %s %ld seconds ago)",
 628                 identmask.c_str(),hostmask.c_str(),source.c_str(),(long)(ServerInstance->Time() - this->set_time));
 629 }
 630
 631 const char* ELine::Displayable()
 632 {
 633         return matchtext.c_str();
 634 }
 635
 636 const char* KLine::Displayable()
 637 {
 638         return matchtext.c_str();
 639 }
 640
 641 const char* GLine::Displayable()
 642 {
 643         return matchtext.c_str();
 644 }
 645
 646 const char* ZLine::Displayable()
 647 {
 648         return ipaddr.c_str();
 649 }
 650
 651 const char* QLine::Displayable()
 652 {
 653         return nick.c_str();
 654 }
 655
 656 bool KLine::IsBurstable()
 657 {
 658         return false;
 659 }
 660
 661 bool XLineManager::RegisterFactory(XLineFactory* xlf)
 662 {
 663         XLineFactMap::iterator n = line_factory.find(xlf->GetType());
 664
 665         if (n != line_factory.end())
 666                 return false;
 667
 668         line_factory[xlf->GetType()] = xlf;
 669
 670         return true;
 671 }
 672
 673 bool XLineManager::UnregisterFactory(XLineFactory* xlf)
 674 {
 675         XLineFactMap::iterator n = line_factory.find(xlf->GetType());
 676
 677         if (n == line_factory.end())
 678                 return false;
 679
 680         line_factory.erase(n);
 681
 682         return true;
 683 }
 684
 685 XLineFactory* XLineManager::GetFactory(const std::string &type)
 686 {
 687         XLineFactMap::iterator n = line_factory.find(type);
 688
 689         if (n == line_factory.end())
 690                 return NULL;
 691
 692         return n->second;
 693 }