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
  50 CoreExport extern InspIRCd* ServerInstance;
  51
  52 #include "config.h"
  53 #include "dynref.h"
  54 #include "consolecolors.h"
  55 #include "caller.h"
  56 #include "cull_list.h"
  57 #include "extensible.h"
  58 #include "fileutils.h"
  59 #include "numerics.h"
  60 #include "uid.h"
  61 #include "server.h"
  62 #include "users.h"
  63 #include "channels.h"
  64 #include "timer.h"
  65 #include "hashcomp.h"
  66 #include "logger.h"
  67 #include "usermanager.h"
  68 #include "socket.h"
  69 #include "ctables.h"
  70 #include "command_parse.h"
  71 #include "mode.h"
  72 #include "socketengine.h"
  73 #include "snomasks.h"
  74 #include "filelogger.h"
  75 #include "modules.h"
  76 #include "threadengine.h"
  77 #include "configreader.h"
  78 #include "inspstring.h"
  79 #include "protocol.h"
  80
  81 /** Returned by some functions to indicate failure.
  82  */
  83 #define ERROR -1
  84
  85 /** Template function to convert any input type to std::string
  86  */
  87 template<typename T> inline std::string ConvNumeric(const T &in)
  88 {
  89         if (in == 0)
  90                 return "0";
  91         T quotient = in;
  92         std::string out;
  93         while (quotient)
  94         {
  95                 out += "0123456789"[ std::abs( (long)quotient % 10 ) ];
  96                 quotient /= 10;
  97         }
  98         if (in < 0)
  99                 out += '-';
 100         std::reverse(out.begin(), out.end());
 101         return out;
 102 }
 103
 104 /** Template function to convert any input type to std::string
 105  */
 106 inline std::string ConvToStr(const int in)
 107 {
 108         return ConvNumeric(in);
 109 }
 110
 111 /** Template function to convert any input type to std::string
 112  */
 113 inline std::string ConvToStr(const long in)
 114 {
 115         return ConvNumeric(in);
 116 }
 117
 118 /** Template function to convert any input type to std::string
 119  */
 120 inline std::string ConvToStr(const char* in)
 121 {
 122         return in;
 123 }
 124
 125 /** Template function to convert any input type to std::string
 126  */
 127 inline std::string ConvToStr(const bool in)
 128 {
 129         return (in ? "1" : "0");
 130 }
 131
 132 /** Template function to convert any input type to std::string
 133  */
 134 inline std::string ConvToStr(char in)
 135 {
 136         return std::string(1, in);
 137 }
 138
 139 /** Template function to convert any input type to std::string
 140  */
 141 template <class T> inline std::string ConvToStr(const T &in)
 142 {
 143         std::stringstream tmp;
 144         if (!(tmp << in)) return std::string();
 145         return tmp.str();
 146 }
 147
 148 /** Template function to convert any input type to any other type
 149  * (usually an integer or numeric type)
 150  */
 151 template<typename T> inline long ConvToInt(const T &in)
 152 {
 153         std::stringstream tmp;
 154         if (!(tmp << in)) return 0;
 155         return atol(tmp.str().c_str());
 156 }
 157
 158 /** This class contains various STATS counters
 159  * It is used by the InspIRCd class, which internally
 160  * has an instance of it.
 161  */
 162 class serverstats
 163 {
 164   public:
 165         /** Number of accepted connections
 166          */
 167         unsigned long statsAccept;
 168         /** Number of failed accepts
 169          */
 170         unsigned long statsRefused;
 171         /** Number of unknown commands seen
 172          */
 173         unsigned long statsUnknown;
 174         /** Number of nickname collisions handled
 175          */
 176         unsigned long statsCollisions;
 177         /** Number of DNS queries sent out
 178          */
 179         unsigned long statsDns;
 180         /** Number of good DNS replies received
 181          * NOTE: This may not tally to the number sent out,
 182          * due to timeouts and other latency issues.
 183          */
 184         unsigned long statsDnsGood;
 185         /** Number of bad (negative) DNS replies received
 186          * NOTE: This may not tally to the number sent out,
 187          * due to timeouts and other latency issues.
 188          */
 189         unsigned long statsDnsBad;
 190         /** Number of inbound connections seen
 191          */
 192         unsigned long statsConnects;
 193         /** Total bytes of data transmitted
 194          */
 195         unsigned long statsSent;
 196         /** Total bytes of data received
 197          */
 198         unsigned long statsRecv;
 199 #ifdef _WIN32
 200         /** Cpu usage at last sample
 201         */
 202         FILETIME LastCPU;
 203         /** Time QP sample was read
 204         */
 205         LARGE_INTEGER LastSampled;
 206         /** QP frequency
 207         */
 208         LARGE_INTEGER QPFrequency;
 209 #else
 210         /** Cpu usage at last sample
 211          */
 212         timeval LastCPU;
 213         /** Time last sample was read
 214          */
 215         timespec LastSampled;
 216 #endif
 217         /** The constructor initializes all the counts to zero
 218          */
 219         serverstats()
 220                 : statsAccept(0), statsRefused(0), statsUnknown(0), statsCollisions(0), statsDns(0),
 221                 statsDnsGood(0), statsDnsBad(0), statsConnects(0), statsSent(0), statsRecv(0)
 222         {
 223         }
 224 };
 225
 226 /** This class manages the generation and transmission of ISUPPORT. */
 227 class CoreExport ISupportManager
 228 {
 229 private:
 230         /** The generated lines which are sent to clients. */
 231         std::vector<std::string> Lines;
 232
 233 public:
 234         /** (Re)build the ISUPPORT vector. */
 235         void Build();
 236
 237         /** Returns the std::vector of ISUPPORT lines. */
 238         const std::vector<std::string>& GetLines()
 239         {
 240                 return this->Lines;
 241         }
 242
 243         /** Send the 005 numerics (ISUPPORT) to a user. */
 244         void SendTo(LocalUser* user);
 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         /** Socket engine, handles socket activity events
 338          */
 339         SocketEngine* SE;
 340
 341         /** Thread engine, Handles threading where required
 342          */
 343         ThreadEngine* Threads;
 344
 345         /** The thread/class used to read config files in REHASH and on startup
 346          */
 347         ConfigReaderThread* ConfigThread;
 348
 349         /** LogManager handles logging.
 350          */
 351         LogManager *Logs;
 352
 353         /** ModuleManager contains everything related to loading/unloading
 354          * modules.
 355          */
 356         ModuleManager* Modules;
 357
 358         /** BanCacheManager is used to speed up checking of restrictions on connection
 359          * to the IRCd.
 360          */
 361         BanCacheManager *BanCache;
 362
 363         /** Stats class, holds miscellaneous stats counters
 364          */
 365         serverstats* stats;
 366
 367         /**  Server Config class, holds configuration file data
 368          */
 369         ServerConfig* Config;
 370
 371         /** Snomask manager - handles routing of snomask messages
 372          * to opers.
 373          */
 374         SnomaskManager* SNO;
 375
 376         /** Timer manager class, triggers Timer timer events
 377          */
 378         TimerManager* Timers;
 379
 380         /** X-Line manager. Handles G/K/Q/E line setting, removal and matching
 381          */
 382         XLineManager* XLines;
 383
 384         /** User manager. Various methods and data associated with users.
 385          */
 386         UserManager *Users;
 387
 388         /** Channel list, a hash_map containing all channels XXX move to channel manager class
 389          */
 390         chan_hash* chanlist;
 391
 392         /** List of the open ports
 393          */
 394         std::vector<ListenSocket*> ports;
 395
 396         /** Set to the current signal recieved
 397          */
 398         static sig_atomic_t s_signal;
 399
 400         /** Protocol interface, overridden by server protocol modules
 401          */
 402         ProtocolInterface* PI;
 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         /** Binds a socket on an already open file descriptor
 442          * @param sockfd A valid file descriptor of an open socket
 443          * @param port The port number to bind to
 444          * @param addr The address to bind to (IP only)
 445          * @param dolisten Should this port be listened on?
 446          * @return True if the port was bound successfully
 447          */
 448         bool BindSocket(int sockfd, int port, const char* addr, bool dolisten = true);
 449
 450         /** Find a user in the nick hash.
 451          * If the user cant be found in the nick hash check the uuid hash
 452          * @param nick The nickname to find
 453          * @return A pointer to the user, or NULL if the user does not exist
 454          */
 455         User* FindNick(const std::string &nick);
 456
 457         /** Find a user in the nick hash ONLY
 458          */
 459         User* FindNickOnly(const std::string &nick);
 460
 461         /** Find a channel in the channels hash
 462          * @param chan The channel to find
 463          * @return A pointer to the channel, or NULL if the channel does not exist
 464          */
 465         Channel* FindChan(const std::string &chan);
 466
 467         /** Return true if a channel name is valid
 468          * @param chname A channel name to verify
 469          * @return True if the name is valid
 470          */
 471         caller1<bool, const std::string&> IsChannel;
 472
 473         /** Return true if str looks like a server ID
 474          * @param sid string to check against
 475          */
 476         static bool IsSID(const std::string& sid);
 477
 478         /** Handles incoming signals after being set
 479          * @param signal the signal recieved
 480          */
 481         void SignalHandler(int signal);
 482
 483         /** Sets the signal recieved
 484          * @param signal the signal recieved
 485          */
 486         static void SetSignal(int signal);
 487
 488         /** Causes the server to exit after unloading modules and
 489          * closing all open file descriptors.
 490          *
 491          * @param status The exit code to give to the operating system
 492          * (See the ExitStatus enum for valid values)
 493          */
 494         void Exit(int status);
 495
 496         /** Causes the server to exit immediately with exit code 0.
 497          * The status code is required for signal handlers, and ignored.
 498          */
 499         static void QuickExit(int status);
 500
 501         /** Formats the input string with the specified arguments.
 502         * @param formatString The string to format
 503         * @param ... A variable number of format arguments.
 504         * @return The formatted string
 505         */
 506         static const char* Format(const char* formatString, ...) CUSTOM_PRINTF(1, 2);
 507         static const char* Format(va_list &vaList, const char* formatString) CUSTOM_PRINTF(2, 0);
 508
 509         /** Return a count of channels on the network
 510          * @return The number of channels
 511          */
 512         long ChannelCount() const { return chanlist->size(); }
 513
 514         /** Send an error notice to all local users, opered and unopered
 515          * @param s The error string to send
 516          */
 517         void SendError(const std::string &s);
 518
 519         /** Return true if a nickname is valid
 520          * @param n A nickname to verify
 521          * @return True if the nick is valid
 522          */
 523         caller1<bool, const std::string&> IsNick;
 524
 525         /** Return true if an ident is valid
 526          * @param An ident to verify
 527          * @return True if the ident is valid
 528          */
 529         caller1<bool, const std::string&> IsIdent;
 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          * @param str The literal string to match against
 534          * @param mask The glob pattern to match against.
 535          * @param map The character map to use when matching.
 536          */
 537         static bool Match(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
 538         static bool Match(const char* str, const char* mask, unsigned const char* map = NULL);
 539
 540         /** Match two strings using pattern matching, optionally, with a map
 541          * to check case against (may be NULL). If map is null, match will be case insensitive.
 542          * Supports CIDR patterns as well as globs.
 543          * @param str The literal string to match against
 544          * @param mask The glob or CIDR pattern to match against.
 545          * @param map The character map to use when matching.
 546          */
 547         static bool MatchCIDR(const std::string& str, const std::string& mask, unsigned const char* map = NULL);
 548         static bool MatchCIDR(const char* str, const char* mask, unsigned const char* map = NULL);
 549
 550         /** Matches a hostname and IP against a space delimited list of hostmasks.
 551          * @param masks The space delimited masks to match against.
 552          * @param hostname The hostname to try and match.
 553          * @param ipaddr The IP address to try and match.
 554          */
 555         static bool MatchMask(const std::string& masks, const std::string& hostname, const std::string& ipaddr);
 556
 557         /** Return true if the given parameter is a valid nick!user\@host mask
 558          * @param mask A nick!user\@host masak to match against
 559          * @return True i the mask is valid
 560          */
 561         static bool IsValidMask(const std::string& mask);
 562
 563         /** Strips all color codes from the given string
 564          * @param sentence The string to strip from
 565          */
 566         static void StripColor(std::string &sentence);
 567
 568         /** Parses color codes from string values to actual color codes
 569          * @param input The data to process
 570          */
 571         static void ProcessColors(file_cache& input);
 572
 573         /** Rehash the local server
 574          * @param uuid The uuid of the user who started the rehash, can be empty
 575          */
 576         void Rehash(const std::string& uuid = "");
 577
 578         /** Check if the given nickmask matches too many users, send errors to the given user
 579          * @param nick A nickmask to match against
 580          * @param user A user to send error text to
 581          * @return True if the nick matches too many users
 582          */
 583         bool NickMatchesEveryone(const std::string &nick, User* user);
 584
 585         /** Check if the given IP mask matches too many users, send errors to the given user
 586          * @param ip An ipmask to match against
 587          * @param user A user to send error text to
 588          * @return True if the ip matches too many users
 589          */
 590         bool IPMatchesEveryone(const std::string &ip, User* user);
 591
 592         /** Check if the given hostmask matches too many users, send errors to the given user
 593          * @param mask A hostmask to match against
 594          * @param user A user to send error text to
 595          * @return True if the host matches too many users
 596          */
 597         bool HostMatchesEveryone(const std::string &mask, User* user);
 598
 599         /** Calculate a duration in seconds from a string in the form 1y2w3d4h6m5s
 600          * @param str A string containing a time in the form 1y2w3d4h6m5s
 601          * (one year, two weeks, three days, four hours, six minutes and five seconds)
 602          * @return The total number of seconds
 603          */
 604         static unsigned long Duration(const std::string& str);
 605
 606         /** Attempt to compare a password to a string from the config file.
 607          * This will be passed to handling modules which will compare the data
 608          * against possible hashed equivalents in the input string.
 609          * @param ex The object (user, server, whatever) causing the comparison.
 610          * @param data The data from the config file
 611          * @param input The data input by the oper
 612          * @param hashtype The hash from the config file
 613          * @return True if the strings match, false if they do not
 614          */
 615         bool PassCompare(Extensible* ex, const std::string& data, const std::string& input, const std::string& hashtype);
 616
 617         /** Returns the full version string of this ircd
 618          * @return The version string
 619          */
 620         std::string GetVersionString(bool getFullVersion = false);
 621
 622         /** Attempt to write the process id to a given file
 623          * @param filename The PID file to attempt to write to
 624          * @return This function may bail if the file cannot be written
 625          */
 626         void WritePID(const std::string &filename);
 627
 628         /** This constructor initialises all the subsystems and reads the config file.
 629          * @param argc The argument count passed to main()
 630          * @param argv The argument list passed to main()
 631          * @throw <anything> If anything is thrown from here and makes it to
 632          * you, you should probably just give up and go home. Yes, really.
 633          * It's that bad. Higher level classes should catch any non-fatal exceptions.
 634          */
 635         InspIRCd(int argc, char** argv);
 636
 637         /** Send a line of WHOIS data to a user.
 638          * @param user user to send the line to
 639          * @param dest user being WHOISed
 640          * @param numeric Numeric to send
 641          * @param text Text of the numeric
 642          */
 643         void SendWhoisLine(User* user, User* dest, int numeric, const std::string &text);
 644
 645         /** Send a line of WHOIS data to a user.
 646          * @param user user to send the line to
 647          * @param dest user being WHOISed
 648          * @param numeric Numeric to send
 649          * @param format Format string for the numeric
 650          * @param ... Parameters for the format string
 651          */
 652         void SendWhoisLine(User* user, User* dest, int numeric, const char* format, ...) CUSTOM_PRINTF(5, 6);
 653
 654         /** Called to check whether a channel restriction mode applies to a user
 655          * @param User that is attempting some action
 656          * @param Channel that the action is being performed on
 657          * @param Action name
 658          */
 659         caller3<ModResult, User*, Channel*, const std::string&> OnCheckExemption;
 660
 661         /** Prepare the ircd for restart or shutdown.
 662          * This function unloads all modules which can be unloaded,
 663          * closes all open sockets, and closes the logfile.
 664          */
 665         void Cleanup();
 666
 667         /** Return a time_t as a human-readable string.
 668          */
 669         static std::string TimeString(time_t curtime);
 670
 671         /** Begin execution of the server.
 672          * NOTE: this function NEVER returns. Internally,
 673          * it will repeatedly loop.
 674          */
 675         void Run();
 676
 677         char* GetReadBuffer()
 678         {
 679                 return this->ReadBuffer;
 680         }
 681 };
 682
 683 ENTRYPOINT;
 684
 685 template<class Cmd>
 686 class CommandModule : public Module
 687 {
 688         Cmd cmd;
 689  public:
 690         CommandModule() : cmd(this)
 691         {
 692         }
 693
 694         Version GetVersion()
 695         {
 696                 return Version(cmd.name, VF_VENDOR|VF_CORE);
 697         }
 698 };