src/xline.cpp

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