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