include/inspircd.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
   7  *   Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
   9  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  10  *   Copyright (C) 2003 randomdan <???@???>
  11  *
  12  * This file is part of InspIRCd.  InspIRCd is free software: you can
  13  * redistribute it and/or modify it under the terms of the GNU General Public
  14  * License as published by the Free Software Foundation, version 2.
  15  *
  16  * This program is distributed in the hope that it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  19  * details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24
  25
  26 #pragma once
  27
  28 #include <climits>
  29 #include <cmath>
  30 #include <csignal>
  31 #include <cstdarg>
  32 #include <cstdio>
  33 #include <cstring>
  34 #include <ctime>
  35
  36 #include <algorithm>
  37 #include <bitset>
  38 #include <deque>
  39 #include <list>
  40 #include <map>
  41 #include <set>
  42 #include <sstream>
  43 #include <string>
  44 #include <vector>
  45
  46 #include "intrusive_list.h"
  47 #include "flat_map.h"
  48 #include "compat.h"
  49 #include "aligned_storage.h"
  50 #include "typedefs.h"
  51 #include "stdalgo.h"
  52
  53 CoreExport extern InspIRCd* ServerInstance;
  54
  55 /** Base class for manager classes that are still accessed using -> but are no longer pointers
  56  */
  57 template <typename T>
  58 struct fakederef
  59 {
  60         T* operator->()
  61         {
  62                 return static_cast<T*>(this);
  63         }
  64 };
  65
  66 #include "config.h"
  67 #include "dynref.h"
  68 #include "consolecolors.h"
  69 #include "caller.h"
  70 #include "cull_list.h"
  71 #include "extensible.h"
  72 #include "fileutils.h"
  73 #include "numerics.h"
  74 #include "uid.h"
  75 #include "server.h"
  76 #include "users.h"
  77 #include "channels.h"
  78 #include "timer.h"
  79 #include "hashcomp.h"
  80 #include "logger.h"
  81 #include "usermanager.h"
  82 #include "socket.h"
  83 #include "ctables.h"
  84 #include "command_parse.h"
  85 #include "mode.h"
  86 #include "socketengine.h"
  87 #include "snomasks.h"
  88 #include "filelogger.h"
  89 #include "modules.h"
  90 #include "threadengine.h"
  91 #include "configreader.h"
  92 #include "inspstring.h"
  93 #include "protocol.h"
  94 #include "bancache.h"
  95 #include "isupportmanager.h"
  96
  97 /** Template function to convert any input type to std::string
  98  */
  99 template<typename T> inline std::string ConvNumeric(const T &in)
 100 {
 101         if (in == 0)
 102                 return "0";
 103         T quotient = in;
 104         std::string out;
 105         while (quotient)
 106         {
 107                 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
 108                 quotient /= 10;
 109         }
 110         if (in < 0)
 111                 out += '-';
 112         std::reverse(out.begin(), out.end());
 113         return out;
 114 }
 115
 116 /** Template function to convert any input type to std::string
 117  */
 118 inline std::string ConvToStr(const int in)
 119 {
 120         return ConvNumeric(in);
 121 }
 122
 123 /** Template function to convert any input type to std::string
 124  */
 125 inline std::string ConvToStr(const long in)
 126 {
 127         return ConvNumeric(in);
 128 }
 129
 130 /** Template function to convert any input type to std::string
 131  */
 132 inline std::string ConvToStr(const char* in)
 133 {
 134         return in;
 135 }
 136
 137 /** Template function to convert any input type to std::string
 138  */
 139 inline std::string ConvToStr(const bool in)
 140 {
 141         return (in ? "1" : "0");
 142 }
 143
 144 /** Template function to convert any input type to std::string
 145  */
 146 inline std::string ConvToStr(char in)
 147 {
 148         return std::string(1, in);
 149 }
 150
 151 /** Template function to convert any input type to std::string
 152  */
 153 template <class T> inline std::string ConvToStr(const T &in)
 154 {
 155         std::stringstream tmp;
 156         if (!(tmp << in)) return std::string();
 157         return tmp.str();
 158 }
 159
 160 /** Template function to convert any input type to any other type
 161  * (usually an integer or numeric type)
 162  */
 163 template<typename T> inline long ConvToInt(const T &in)
 164 {
 165         std::stringstream tmp;
 166         if (!(tmp << in)) return 0;
 167         return atol(tmp.str().c_str());
 168 }
 169
 170 inline uint64_t ConvToUInt64(const std::string& in)
 171 {
 172         uint64_t ret;
 173         std::istringstream tmp(in);
 174         if (!(tmp >> ret))
 175                 return 0;
 176         return ret;
 177 }
 178
 179 /** This class contains various STATS counters
 180  * It is used by the InspIRCd class, which internally
 181  * has an instance of it.
 182  */
 183 class serverstats
 184 {
 185   public:
 186         /** Number of accepted connections
 187          */
 188         unsigned long Accept;
 189         /** Number of failed accepts
 190          */
 191         unsigned long Refused;
 192         /** Number of unknown commands seen
 193          */
 194         unsigned long Unknown;
 195         /** Number of nickname collisions handled
 196          */
 197         unsigned long Collisions;
 198         /** Number of DNS queries sent out
 199          */
 200         unsigned long Dns;
 201         /** Number of good DNS replies received
 202          * NOTE: This may not tally to the number sent out,
 203          * due to timeouts and other latency issues.
 204          */
 205         unsigned long DnsGood;
 206         /** Number of bad (negative) DNS replies received
 207          * NOTE: This may not tally to the number sent out,
 208          * due to timeouts and other latency issues.
 209          */
 210         unsigned long DnsBad;
 211         /** Number of inbound connections seen
 212          */
 213         unsigned long Connects;
 214         /** Total bytes of data transmitted
 215          */
 216         unsigned long Sent;
 217         /** Total bytes of data received
 218          */
 219         unsigned long Recv;
 220 #ifdef _WIN32
 221         /** Cpu usage at last sample
 222         */
 223         FILETIME LastCPU;
 224         /** Time QP sample was read
 225         */
 226         LARGE_INTEGER LastSampled;
 227         /** QP frequency
 228         */
 229         LARGE_INTEGER QPFrequency;
 230 #else
 231         /** Cpu usage at last sample
 232          */
 233         timeval LastCPU;
 234         /** Time last sample was read
 235          */
 236         timespec LastSampled;
 237 #endif
 238         /** The constructor initializes all the counts to zero
 239          */
 240         serverstats()
 241                 : Accept(0), Refused(0), Unknown(0), Collisions(0), Dns(0),
 242                 DnsGood(0), DnsBad(0), Connects(0), Sent(0), Recv(0)
 243         {
 244         }
 245 };
 246
 247 DEFINE_HANDLER1(IsNickHandler, bool, const std::string&);
 248 DEFINE_HANDLER2(GenRandomHandler, void, char*, size_t);
 249 DEFINE_HANDLER1(IsIdentHandler, bool, const std::string&);
 250 DEFINE_HANDLER1(IsChannelHandler, bool, const std::string&);
 251 DEFINE_HANDLER3(OnCheckExemptionHandler, ModResult, User*, Channel*, const std::string&);
 252
 253 /** The main class of the irc server.
 254  * This class contains instances of all the other classes in this software.
 255  * Amongst other things, it contains a ModeParser, a DNS object, a CommandParser
 256  * object, and a list of active Module objects, and facilities for Module
 257  * objects to interact with the core system it implements.
 258  */
 259 class CoreExport InspIRCd
 260 {
 261  private:
 262         /** Set up the signal handlers
 263          */
 264         void SetSignals();
 265
 266         /** Daemonize the ircd and close standard input/output streams
 267          * @return True if the program daemonized succesfully
 268          */
 269         bool DaemonSeed();
 270
 271         /** The current time, updated in the mainloop
 272          */
 273         struct timespec TIME;
 274
 275         /** A 64k buffer used to read socket data into
 276          * NOTE: update ValidateNetBufferSize if you change this
 277          */
 278         char ReadBuffer[65535];
 279
 280         /** Check we aren't running as root, and exit if we are
 281          * with exit code EXIT_STATUS_ROOT.
 282          */
 283         void CheckRoot();
 284
 285  public:
 286
 287         UIDGenerator UIDGen;
 288
 289         /** Global cull list, will be processed on next iteration
 290          */
 291         CullList GlobalCulls;
 292         /** Actions that must happen outside of the current call stack */
 293         ActionList AtomicActions;
 294
 295         /**** Functors ****/
 296
 297         IsNickHandler HandleIsNick;
 298         IsIdentHandler HandleIsIdent;
 299         OnCheckExemptionHandler HandleOnCheckExemption;
 300         IsChannelHandler HandleIsChannel;
 301         GenRandomHandler HandleGenRandom;
 302
 303         /** Globally accessible fake user record. This is used to force mode changes etc across s2s, etc.. bit ugly, but.. better than how this was done in 1.1
 304          * Reason for it:
 305          * kludge alert!
 306          * SendMode expects a User* to send the numeric replies
 307          * back to, so we create it a fake user that isnt in the user
 308          * hash and set its descriptor to FD_MAGIC_NUMBER so the data
 309          * falls into the abyss :p
 310          */
 311         FakeUser* FakeClient;
 312
 313         /** Find a user in the UUID hash
 314          * @param uid The UUID to find
 315          * @return A pointer to the user, or NULL if the user does not exist
 316          */
 317         User* FindUUID(const std::string &uid);
 318
 319         /** Time this ircd was booted
 320          */
 321         time_t startup_time;
 322
 323         /** Config file pathname specified on the commandline or via ./configure
 324          */
 325         std::string ConfigFileName;
 326
 327         ExtensionManager Extensions;
 328
 329         /** Mode handler, handles mode setting and removal
 330          */
 331         ModeParser Modes;
 332
 333         /** Command parser, handles client to server commands
 334          */
 335         CommandParser Parser;
 336
 337         /** Thread engine, Handles threading where required
 338          */
 339         ThreadEngine Threads;
 340
 341         /** The thread/class used to read config files in REHASH and on startup
 342          */
 343         ConfigReaderThread* ConfigThread;
 344
 345         /** LogManager handles logging.
 346          */
 347         LogManager Logs;
 348
 349         /** ModuleManager contains everything related to loading/unloading
 350          * modules.
 351          */
 352         ModuleManager Modules;
 353
 354         /** BanCacheManager is used to speed up checking of restrictions on connection
 355          * to the IRCd.
 356          */
 357         BanCacheManager BanCache;
 358
 359         /** Stats class, holds miscellaneous stats counters
 360          */
 361         serverstats stats;
 362
 363         /**  Server Config class, holds configuration file data
 364          */
 365         ServerConfig* Config;
 366
 367         /** Snomask manager - handles routing of snomask messages
 368          * to opers.
 369          */
 370         SnomaskManager SNO;
 371
 372         /** Timer manager class, triggers Timer timer events
 373          */
 374         TimerManager Timers;
 375
 376         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 377          */
 378         XLineManager* XLines;
 379
 380         /** User manager. Various methods and data associated with users.
 381          */
 382         UserManager Users;
 383
 384         /** Channel list, a hash_map containing all channels XXX move to channel manager class
 385          */
 386         chan_hash chanlist;
 387
 388         /** List of the open ports
 389          */
 390         std::vector<ListenSocket*> ports;
 391
 392         /** Set to the current signal recieved
 393          */
 394         static sig_atomic_t s_signal;
 395
 396         /** Protocol interface, overridden by server protocol modules
 397          */
 398         ProtocolInterface* PI;
 399
 400         /** Default implementation of the ProtocolInterface, does nothing
 401          */
 402         ProtocolInterface DefaultProtocolInterface;
 403
 404         /** Holds extensible for user operquit
 405          */
 406         StringExtItem OperQuit;
 407
 408         /** Manages the generation and transmission of ISUPPORT. */
 409         ISupportManager ISupport;
 410
 411         /** Get the current time
 412          * Because this only calls time() once every time around the mainloop,
 413          * it is much faster than calling time() directly.
 414          * @return The current time as an epoch value (time_t)
 415          */
 416         inline time_t Time() { return TIME.tv_sec; }
 417         /** The fractional time at the start of this mainloop iteration (nanoseconds) */
 418         inline long Time_ns() { return TIME.tv_nsec; }
 419         /** Update the current time. Don't call this unless you have reason to do so. */
 420         void UpdateTime();
 421
 422         /** Generate a random string with the given length
 423          * @param length The length in bytes
 424          * @param printable if false, the string will use characters 0-255; otherwise,
 425          * it will be limited to 0x30-0x7E ('0'-'~', nonspace printable characters)
 426          */
 427         std::string GenRandomStr(int length, bool printable = true);
 428         /** Generate a random integer.
 429          * This is generally more secure than rand()
 430          */
 431         unsigned long GenRandomInt(unsigned long max);
 432
 433         /** Fill a buffer with random bits */
 434         caller2<void, char*, size_t> GenRandom;
 435
 436         /** Bind all ports specified in the configuration file.
 437          * @return The number of ports bound without error
 438          */
 439         int BindPorts(FailedPortList &failed_ports);
 440
 441         /** Find a user in the nick hash.
 442          * If the user cant be found in the nick hash check the uuid hash
 443          * @param nick The nickname to find
 444          * @return A pointer to the user, or NULL if the user does not exist
 445          */
 446         User* FindNick(const std::string &nick);
 447
 448         /** Find a user in the nick hash ONLY
 449          */
 450         User* FindNickOnly(const std::string &nick);
 451
 452         /** Find a channel in the channels hash
 453          * @param chan The channel to find
 454          * @return A pointer to the channel, or NULL if the channel does not exist
 455          */
 456         Channel* FindChan(const std::string &chan);
 457
 458         /** Get a hash map containing all channels, keyed by their name
 459          * @return A hash map mapping channel names to Channel pointers
 460          */
 461         chan_hash& GetChans() { return chanlist; }
 462
 463         /** Return true if a channel name is valid
 464          * @param chname A channel name to verify
 465          * @return True if the name is valid
 466          */
 467         caller1<bool, const std::string&> IsChannel;
 468
 469         /** Return true if str looks like a server ID
 470          * @param sid string to check against
 471          */
 472         static bool IsSID(const std::string& sid);
 473
 474         /** Handles incoming signals after being set
 475          * @param signal the signal recieved
 476          */
 477         void SignalHandler(int signal);
 478
 479         /** Sets the signal recieved
 480          * @param signal the signal recieved
 481          */
 482         static void SetSignal(int signal);
 483
 484         /** Causes the server to exit after unloading modules and
 485          * closing all open file descriptors.
 486          *
 487          * @param status The exit code to give to the operating system
 488          * (See the ExitStatus enum for valid values)
 489          */
 490         void Exit(int status);
 491
 492         /** Causes the server to exit immediately with exit code 0.
 493          * The status code is required for signal handlers, and ignored.
 494          */
 495         static void QuickExit(int status);
 496
 497         /** Formats the input string with the specified arguments.
 498         * @param formatString The string to format
 499         * @param ... A variable number of format arguments.
 500         * @return The formatted string
 501         */
 502         static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
 503         static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
 504
 505         /** Send an error notice to all local users, opered and unopered
 506          * @param s The error string to send
 507          */
 508         void SendError(const std::string &s);
 509
 510         /** Return true if a nickname is valid
 511          * @param n A nickname to verify
 512          * @return True if the nick is valid
 513          */
 514         caller1<bool, const std::string&> IsNick;
 515
 516         /** Return true if an ident is valid
 517          * @param An ident to verify
 518          * @return True if the ident is valid
 519          */
 520         caller1<bool, const std::string&> IsIdent;
 521
 522         /** Match two strings using pattern matching, optionally, with a map
 523          * to check case against (may be NULL). If map is null, match will be case insensitive.
 524          * @param str The literal string to match against
 525          * @param mask The glob pattern to match against.
 526          * @param map The character map to use when matching.
 527          */
 528         static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
 529         static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
 530
 531         /** Match two strings using pattern matching, optionally, with a map
 532          * to check case against (may be NULL). If map is null, match will be case insensitive.
 533          * Supports CIDR patterns as well as globs.
 534          * @param str The literal string to match against
 535          * @param mask The glob or CIDR pattern to match against.
 536          * @param map The character map to use when matching.
 537          */
 538         static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
 539         static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
 540
 541         /** Matches a hostname and IP against a space delimited list of hostmasks.
 542          * @param masks The space delimited masks to match against.
 543          * @param hostname The hostname to try and match.
 544          * @param ipaddr The IP address to try and match.
 545          */
 546         static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
 547
 548         /** Return true if the given parameter is a valid nick!user\@host mask
 549          * @param mask A nick!user\@host masak to match against
 550          * @return True i the mask is valid
 551          */
 552         static bool IsValidMask(const std::string& mask);
 553
 554         /** Strips all color codes from the given string
 555          * @param sentence The string to strip from
 556          */
 557         static void StripColor(std::string &sentence);
 558
 559         /** Parses color codes from string values to actual color codes
 560          * @param input The data to process
 561          */
 562         static void ProcessColors(file_cache& input);
 563
 564         /** Rehash the local server
 565          * @param uuid The uuid of the user who started the rehash, can be empty
 566          */
 567         void Rehash(const std::string& uuid = "");
 568
 569         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 570          * @param str A string containing a time in the form 1y2w3d4h6m5s
 571          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 572          * @return The total number of seconds
 573          */
 574         static unsigned long Duration(const std::string& str);
 575
 576         /** Attempt to compare a password to a string from the config file.
 577          * This will be passed to handling modules which will compare the data
 578          * against possible hashed equivalents in the input string.
 579          * @param ex The object (user, server, whatever) causing the comparison.
 580          * @param data The data from the config file
 581          * @param input The data input by the oper
 582          * @param hashtype The hash from the config file
 583          * @return True if the strings match, false if they do not
 584          */
 585         bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
 586
 587         /** Returns the full version string of this ircd
 588          * @return The version string
 589          */
 590         std::string GetVersionString(bool getFullVersion = false);
 591
 592         /** Attempt to write the process id to a given file
 593          * @param filename The PID file to attempt to write to
 594          * @return This function may bail if the file cannot be written
 595          */
 596         void WritePID(const std::string &filename);
 597
 598         /** This constructor initialises all the subsystems and reads the config file.
 599          * @param argc The argument count passed to main()
 600          * @param argv The argument list passed to main()
 601          * @throw <anything> If anything is thrown from here and makes it to
 602          * you, you should probably just give up and go home. Yes, really.
 603          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 604          */
 605         InspIRCd(int argc, char** argv);
 606
 607         /** Send a line of WHOIS data to a user.
 608          * @param user user to send the line to
 609          * @param dest user being WHOISed
 610          * @param numeric Numeric to send
 611          * @param text Text of the numeric
 612          */
 613         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 614
 615         /** Send a line of WHOIS data to a user.
 616          * @param user user to send the line to
 617          * @param dest user being WHOISed
 618          * @param numeric Numeric to send
 619          * @param format Format string for the numeric
 620          * @param ... Parameters for the format string
 621          */
 622         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 623
 624         /** Called to check whether a channel restriction mode applies to a user
 625          * @param User that is attempting some action
 626          * @param Channel that the action is being performed on
 627          * @param Action name
 628          */
 629         caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 630
 631         /** Prepare the ircd for restart or shutdown.
 632          * This function unloads all modules which can be unloaded,
 633          * closes all open sockets, and closes the logfile.
 634          */
 635         void Cleanup();
 636
 637         /** Return a time_t as a human-readable string.
 638          * @param format The format to retrieve the date/time in. See `man 3 strftime`
 639          * for more information. If NULL, "%a %b %d %T %Y" is assumed.
 640          * @param utc True to convert the time to string as-is, false to convert it to local time first.
 641          * @return A string representing the given date/time.
 642          */
 643         static std::string TimeString(time_t curtime, const char* format = NULL, bool utc = false);
 644
 645         /** Compare two strings in a timing-safe way. If the lengths of the strings differ, the function
 646          * returns false immediately (leaking information about the length), otherwise it compares each
 647          * character and only returns after all characters have been compared.
 648          * @param one First string
 649          * @param two Second string
 650          * @return True if the strings match, false if they don't
 651          */
 652         static bool TimingSafeCompare(const std::string& one, const std::string& two);
 653
 654         /** Begin execution of the server.
 655          * NOTE: this function NEVER returns. Internally,
 656          * it will repeatedly loop.
 657          */
 658         void Run();
 659
 660         char* GetReadBuffer()
 661         {
 662                 return this->ReadBuffer;
 663         }
 664 };
 665
 666 ENTRYPOINT;
 667
 668 template<class Cmd>
 669 class CommandModule : public Module
 670 {
 671         Cmd cmd;
 672  public:
 673         CommandModule() : cmd(this)
 674         {
 675         }
 676
 677         Version GetVersion()
 678         {
 679                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 680         }
 681 };
 682
 683 inline void stdalgo::culldeleter::operator()(classbase* item)
 684 {
 685         if (item)
 686                 ServerInstance->GlobalCulls.AddItem(item);
 687 }