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