src/xline.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd: (C) 2002-2008 InspIRCd Development Team
   6  * See: http://www.inspircd.org/wiki/index.php/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 the line exists, check if its an expired line */
 171         ContainerIter x = lookup_lines.find(line->type);
 172         if (x != lookup_lines.end())
 173         {
 174                 LookupIter i = x->second.find(line->Displayable());
 175                 if (i != x->second.end())
 176                 {
 177                         if (i->second->duration && ServerInstance->Time() > i->second->expiry)
 178                                 ExpireLine(x, i);
 179                         else
 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->Matches(user))
 265                 {
 266                         if (i->second->duration && current > i->second->expiry)
 267                         {
 268                                 /* Expire the line, return nothing */
 269                                 ExpireLine(x, i);
 270                                 /* Continue, there may be another that matches
 271                                  * (thanks aquanight)
 272                                  */
 273                                 i = safei;
 274                                 continue;
 275                         }
 276                         else
 277                                 return i->second;
 278                 }
 279
 280                 i = safei;
 281         }
 282         return NULL;
 283 }
 284
 285 XLine* XLineManager::MatchesLine(const std::string &type, const std::string &pattern)
 286 {
 287         ContainerIter x = lookup_lines.find(type);
 288
 289         if (x == lookup_lines.end())
 290                 return NULL;
 291
 292         const time_t current = ServerInstance->Time();
 293
 294          LookupIter safei;
 295
 296         for (LookupIter i = x->second.begin(); i != x->second.end(); )
 297         {
 298                 safei = i;
 299                 safei++;
 300
 301                 if (i->second->Matches(pattern))
 302                 {
 303                         if (i->second->duration && current > i->second->expiry)
 304                         {
 305                                 /* Expire the line, return nothing */
 306                                 ExpireLine(x, i);
 307                                 /* See above */
 308                                 i = safei;
 309                                 continue;
 310                         }
 311                         else
 312                                 return i->second;
 313                 }
 314
 315                 i = safei;
 316         }
 317         return NULL;
 318 }
 319
 320 // removes lines that have expired
 321 void XLineManager::ExpireLine(ContainerIter container, LookupIter item)
 322 {
 323         FOREACH_MOD(I_OnExpireLine, OnExpireLine(item->second));
 324
 325         item->second->DisplayExpiry();
 326         item->second->Unset();
 327
 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?
 330          * -- Brain
 331          */
 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);
 335
 336         delete item->second;
 337         container->second.erase(item);
 338 }
 339
 340
 341 // applies lines, removing clients and changing nicks etc as applicable
 342 void XLineManager::ApplyLines()
 343 {
 344         for (std::vector<User*>::const_iterator u2 = ServerInstance->Users->local_users.begin(); u2 != ServerInstance->Users->local_users.end(); u2++)
 345         {
 346                 User* u = (User*)(*u2);
 347
 348                 for (std::vector<XLine *>::iterator i = pending_lines.begin(); i != pending_lines.end(); i++)
 349                 {
 350                         XLine *x = *i;
 351                         if (x->Matches(u))
 352                                 x->Apply(u);
 353                 }
 354         }
 355
 356         pending_lines.clear();
 357 }
 358
 359 void XLineManager::InvokeStats(const std::string &type, int numeric, User* user, string_list &results)
 360 {
 361         std::string sn = ServerInstance->Config->ServerName;
 362
 363         ContainerIter n = lookup_lines.find(type);
 364
 365         time_t current = ServerInstance->Time();
 366
 367         LookupIter safei;
 368
 369         if (n != lookup_lines.end())
 370         {
 371                 XLineLookup& list = n->second;
 372                 for (LookupIter i = list.begin(); i != list.end(); )
 373                 {
 374                         safei = i;
 375                         safei++;
 376
 377                         if (i->second->duration && current > i->second->expiry)
 378                         {
 379                                 ExpireLine(n, i);
 380                         }
 381                         else
 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));
 384                         i = safei;
 385                 }
 386         }
 387 }
 388
 389
 390 XLineManager::XLineManager(InspIRCd* Instance) : ServerInstance(Instance)
 391 {
 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);
 397
 398         RegisterFactory(GFact);
 399         RegisterFactory(EFact);
 400         RegisterFactory(KFact);
 401         RegisterFactory(QFact);
 402         RegisterFactory(ZFact);
 403 }
 404
 405 XLineManager::~XLineManager()
 406 {
 407         UnregisterFactory(GFact);
 408         UnregisterFactory(EFact);
 409         UnregisterFactory(KFact);
 410         UnregisterFactory(QFact);
 411         UnregisterFactory(ZFact);
 412
 413         delete GFact;
 414         delete EFact;
 415         delete KFact;
 416         delete QFact;
 417         delete ZFact;
 418
 419         // Delete all existing XLines
 420         for (XLineContainer::iterator i = lookup_lines.begin(); i != lookup_lines.end(); i++)
 421         {
 422                 for (XLineLookup::iterator j = i->second.begin(); j != i->second.end(); j++)
 423                 {
 424                         delete j->second;
 425                 }
 426                 i->second.clear();
 427         }
 428         lookup_lines.clear();
 429
 430 }
 431
 432 void XLine::Apply(User* u)
 433 {
 434 }
 435
 436 bool XLine::IsBurstable()
 437 {
 438         return true;
 439 }
 440
 441 void XLine::DefaultApply(User* u, const std::string &line, bool bancache)
 442 {
 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);
 447
 448         if (ServerInstance->Config->HideBans)
 449                 ServerInstance->Users->QuitUser(u, line + "-Lined", sreason);
 450         else
 451                 ServerInstance->Users->QuitUser(u, sreason);
 452
 453
 454         if (bancache)
 455         {
 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);
 459                 else
 460                         ServerInstance->BanCache->AddHit(u->GetIPString(), this->type, line + "-Lined: " + this->reason);
 461         }
 462 }
 463
 464 bool KLine::Matches(User *u)
 465 {
 466         if (u->exempt)
 467                 return false;
 468
 469         if (InspIRCd::Match(u->ident, this->identmask))
 470         {
 471                 if (InspIRCd::MatchCIDR(u->host, this->hostmask) ||
 472                     InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask))
 473                 {
 474                         return true;
 475                 }
 476         }
 477
 478         return false;
 479 }
 480
 481 void KLine::Apply(User* u)
 482 {
 483         DefaultApply(u, "K", (strcmp(this->identmask, "*") == 0) ? true : false);
 484 }
 485
 486 bool GLine::Matches(User *u)
 487 {
 488         if (u->exempt)
 489                 return false;
 490
 491         if (InspIRCd::Match(u->ident, this->identmask))
 492         {
 493                 if (InspIRCd::MatchCIDR(u->host, this->hostmask) ||
 494                     InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask))
 495                 {
 496                         return true;
 497                 }
 498         }
 499
 500         return false;
 501 }
 502
 503 void GLine::Apply(User* u)
 504 {
 505         DefaultApply(u, "G", (strcmp(this->identmask, "*") == 0) ? true : false);
 506 }
 507
 508 bool ELine::Matches(User *u)
 509 {
 510         if (u->exempt)
 511                 return false;
 512
 513         if (InspIRCd::Match(u->ident, this->identmask))
 514         {
 515                 if (InspIRCd::MatchCIDR(u->host, this->hostmask) ||
 516                     InspIRCd::MatchCIDR(u->GetIPString(), this->hostmask))
 517                 {
 518                         return true;
 519                 }
 520         }
 521
 522         return false;
 523 }
 524
 525 bool ZLine::Matches(User *u)
 526 {
 527         if (u->exempt)
 528                 return false;
 529
 530         if (InspIRCd::MatchCIDR(u->GetIPString(), this->ipaddr))
 531                 return true;
 532         else
 533                 return false;
 534 }
 535
 536 void ZLine::Apply(User* u)
 537 {
 538         DefaultApply(u, "Z", true);
 539 }
 540
 541
 542 bool QLine::Matches(User *u)
 543 {
 544         if (InspIRCd::Match(u->nick, this->nick))
 545                 return true;
 546
 547         return false;
 548 }
 549
 550 void QLine::Apply(User* u)
 551 {
 552         /* Force to uuid on apply of qline, no need to disconnect any more :) */
 553         u->ForceNickChange(u->uuid.c_str());
 554 }
 555
 556
 557 bool ZLine::Matches(const std::string &str)
 558 {
 559         if (InspIRCd::MatchCIDR(str, this->ipaddr))
 560                 return true;
 561         else
 562                 return false;
 563 }
 564
 565 bool QLine::Matches(const std::string &str)
 566 {
 567         if (InspIRCd::Match(str, this->nick))
 568                 return true;
 569
 570         return false;
 571 }
 572
 573 bool ELine::Matches(const std::string &str)
 574 {
 575         return (InspIRCd::MatchCIDR(str, matchtext));
 576 }
 577
 578 bool KLine::Matches(const std::string &str)
 579 {
 580         return (InspIRCd::MatchCIDR(str.c_str(), matchtext));
 581 }
 582
 583 bool GLine::Matches(const std::string &str)
 584 {
 585         return (InspIRCd::MatchCIDR(str, matchtext));
 586 }
 587
 588 void ELine::OnAdd()
 589 {
 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++)
 592         {
 593                 User* u = (User*)(*u2);
 594                 if (this->Matches(u))
 595                         u->exempt = true;
 596         }
 597 }
 598
 599 void ELine::DisplayExpiry()
 600 {
 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);
 602 }
 603
 604 void QLine::DisplayExpiry()
 605 {
 606         ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Q-Line %s (set by %s %ld seconds ago)",this->nick,this->source,this->duration);
 607 }
 608
 609 void ZLine::DisplayExpiry()
 610 {
 611         ServerInstance->SNO->WriteToSnoMask('x',"Expiring timed Z-Line %s (set by %s %ld seconds ago)",this->ipaddr,this->source,this->duration);
 612 }
 613
 614 void KLine::DisplayExpiry()
 615 {
 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);
 617 }
 618
 619 void GLine::DisplayExpiry()
 620 {
 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);
 622 }
 623
 624 const char* ELine::Displayable()
 625 {
 626         return matchtext.c_str();
 627 }
 628
 629 const char* KLine::Displayable()
 630 {
 631         return matchtext.c_str();
 632 }
 633
 634 const char* GLine::Displayable()
 635 {
 636         return matchtext.c_str();
 637 }
 638
 639 const char* ZLine::Displayable()
 640 {
 641         return ipaddr;
 642 }
 643
 644 const char* QLine::Displayable()
 645 {
 646         return nick;
 647 }
 648
 649 bool KLine::IsBurstable()
 650 {
 651         return false;
 652 }
 653
 654 bool XLineManager::RegisterFactory(XLineFactory* xlf)
 655 {
 656         XLineFactMap::iterator n = line_factory.find(xlf->GetType());
 657
 658         if (n != line_factory.end())
 659                 return false;
 660
 661         line_factory[xlf->GetType()] = xlf;
 662
 663         return true;
 664 }
 665
 666 bool XLineManager::UnregisterFactory(XLineFactory* xlf)
 667 {
 668         XLineFactMap::iterator n = line_factory.find(xlf->GetType());
 669
 670         if (n == line_factory.end())
 671                 return false;
 672
 673         line_factory.erase(n);
 674
 675         return true;
 676 }
 677
 678 XLineFactory* XLineManager::GetFactory(const std::string &type)
 679 {
 680         XLineFactMap::iterator n = line_factory.find(type);
 681
 682         if (n == line_factory.end())
 683                 return NULL;
 684
 685         return n->second;
 686 }
 687