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